[Workspace] Support workspace in saved objects client in server side.

[SuZhou-Joe]

Description

Support workspace in saved objects client in server side to unified the way to append workspace id in request payload.

Issues Resolved

closes #6130

Screenshot

Testing the changes

• Using the branch to bootstrap
• enabled workspace.enabled to true
• Start OSD by using yarn start --no-base-path to make sure no random base path will be appended
• Navigate to devTools
• Insert test workspaces by calling

PUT .kibana/_doc/workspace:foo
{
  "type": "workspace",
  "workspace": {
    "name": "foo"
  }
}

PUT .kibana/_doc/workspace:bar
{
  "type": "workspace",
  "workspace": {
    "name": "bar"
  }
}

• Visit the saved objects management page: http://localhost:5601/w/foo/app/management/opensearch-dashboards/objects
• You will find nothing can be found in this workspace.
• Import by using the file, download the file and extract that to find the import file.
• You will find some dashboards and visualizations are imported in the workspace.
• Switch to bar workspace by using the workspace selector in left navigation
• You will find the objects you imported in foo workspace can not be found in bar workspace.

Check List

• All tests pass
  • yarn test:jest
  • yarn test:jest_integration
• New functionality includes testing.
• New functionality has been documented.
• Update CHANGELOG.md
• Commits are signed per the DCO using --signoff

[BionIT]

what does this -2 do? can we give it more meaningful var name? https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md#avoid-magic-numbersstrings

[SuZhou-Joe]

Sure, let me assign it to a const and add some comment on that.

[BionIT]

what is the intent to remove this field?

[SuZhou-Joe]

As there is already a workspaces in SavedObjectsBaseOptions and we can delete this duplicate one.

[BionIT]

if workspaces param is not needed, why do we set it here?

[SuZhou-Joe]

We set workspaces as null explicitly to make sure the workspace_id_consumer wrapper won't append workspaces into the query.

[BionIT]

what is the difference of workspace inside options.workspaces vs get from request? do they co-exist?

[SuZhou-Joe]

There are cases that they may co-exist. Using data source for example, in 2.14 all the data sources will be created globally(which means no workspaces info will be stored within data source object), and we will set options.workspaces as null to declare that we want to retrieve all the global data sources instead of the data sources within the request.workspaceId.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 34.96%. Comparing base (85df662) to head (60ba1bb).
Report is 10 commits behind head on main.

❗ Current head 60ba1bb differs from pull request most recent head e38031f. Consider uploading reports for the commit e38031f to get more accurate results

Files	Patch %	Lines
...ore/server/saved_objects/import/check_conflicts.ts	0.00%	1 Missing ⚠️
...erver/saved_objects/import/create_saved_objects.ts	0.00%	1 Missing ⚠️
...rc/core/server/saved_objects/routes/bulk_create.ts	0.00%	1 Missing ⚠️
src/core/server/saved_objects/routes/create.ts	0.00%	1 Missing ⚠️
src/core/server/saved_objects/routes/export.ts	0.00%	1 Missing ⚠️
src/core/server/saved_objects/routes/find.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #6365       +/-   ##
===========================================
- Coverage   55.58%   34.96%   -20.63%     
===========================================
  Files        1199     1909      +710     
  Lines       24259    36928    +12669     
  Branches     4087     6775     +2688     
===========================================
- Hits        13485    12911      -574     
- Misses      10133    23160    +13027     
- Partials      641      857      +216     

Flag	Coverage Δ
Windows_2	?
Windows_4	34.96% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ruanyl]

Just for the context: the first round of the PR review for this change was here ruanyl#293

I have no more concerns now, thanks :)