[Workspace] Consume workspace id in saved object client #6014

SuZhou-Joe · 2024-03-04T08:07:04Z

Description

This PR adds a new private property in saved objects client to make the client be aware of current workspace. Furthermore when user tries to do Create/Update/Find operations on saved objects, the property will take effect if set and append itself to request payload to indicate it is doing the operation under the specific workspace.

Issues Resolved

closes #6027

Screenshot

Testing the changes

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

codecov · 2024-03-04T08:22:48Z

Codecov Report

Attention: Patch coverage is 88.88889% with 2 lines in your changes missing coverage. Please review.

Project coverage is 67.08%. Comparing base (58fb588) to head (c553a36).
Report is 614 commits behind head on main.

Files with missing lines	Patch %	Lines
src/plugins/workspace/public/plugin.ts	71.42%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6014      +/-   ##
==========================================
- Coverage   67.12%   67.08%   -0.04%     
==========================================
  Files        3323     3324       +1     
  Lines       64291    64309      +18     
  Branches    10336    10341       +5     
==========================================
- Hits        43153    43144       -9     
- Misses      18615    18686      +71     
+ Partials     2523     2479      -44

Flag	Coverage Δ
Linux_1	`31.67% <27.77%> (+<0.01%)`	⬆️
Linux_2	`?`
Linux_3	`44.71% <0.00%> (-0.01%)`	⬇️
Linux_4	`35.09% <0.00%> (-0.01%)`	⬇️
Windows_1	`31.69% <27.77%> (+<0.01%)`	⬆️
Windows_2	`55.19% <100.00%> (+0.01%)`	⬆️
Windows_3	`44.72% <0.00%> (-0.02%)`	⬇️
Windows_4	`35.09% <0.00%> (-0.01%)`	⬇️

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.

BionIT

left some comments

src/plugins/saved_objects_management/public/lib/import_file.ts

src/plugins/saved_objects_management/public/lib/resolve_import_errors.test.ts

...ins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx

BionIT · 2024-03-05T03:24:22Z

src/core/public/saved_objects/saved_objects_client.ts

@@ -227,6 +234,11 @@ export class SavedObjectsClient {
    this.batchQueue = [];
  }

+  public setCurrentWorkspace(workspaceId: string): boolean {


why do we need to have a separate set workspace id when using saved object client? Can workspaces field be within the options? If each workspace should have one saved object client instance, we can add workspace id in the constructor

This method is used in workspace.start lifeCycle, which indicates current workspace id. We support workspaces field within options, but it is import that we add a internal currentWorkspaceId because we want to make workspaces totally transparent to other plugins so that no matter which plugin calls savedObjectsClient methods, the client will append workspaces fields when doing the real request automatically.

What do you mean to make the workspaces transparent? this is to set the workspace id not get, right? plus, why would plugins need to get current workspace id from the saved objects client. Can we have the workspace id in the global context instead of setting it specific for saved object client, is it the only place where it needs to know the current workspace?

The setCurrentWorkspace will only be called by workspace plugin when setup, and once the currentWorkspaceId is set, the workspaces field will be automatically append into the final request payload accordingly.

BionIT · 2024-03-05T03:26:00Z

src/core/public/saved_objects/saved_objects_client.ts

+    if (options.hasOwnProperty('workspaces')) {
+      finalWorkspaces = options.workspaces;
+    } else if (typeof currentWorkspaceId === 'string') {
+      finalWorkspaces = [currentWorkspaceId];


what's the difference of the currentworkspace id vs the one from the payload/options?

The workspaces fields inside payload/options has a higher priority than currentWorkspaceId. Most of the cases there will not be workspaces fields in options, except some plugins want to overwrite the workspaces explicitly.

Can't we just set workspace id into options when using the saved object client?

There are 2 sources of workspaces:

workspaces inside options.

currentWorkspaceId in the instance.

the workspaces inside options has higher priority than the current workspaceId, if somewhere calls a method by specifying workspaces inside options, we will honor that and use exactly what they pass to the request payload.

We add currentWorkspaceId in the instance because actually there is few case that plugins want to overwrite the workspaces inside options, by using the currentWorkspaceId in the instance, dashboards page / visualizations page / data source management page will support workspace automatically without a single line of code changes because currentWorkspaceId is already set by workspace plugin when they call any CRUD operations through saved objects client.

BionIT · 2024-03-05T03:27:28Z

src/core/server/saved_objects/import/resolve_import_errors.ts

@@ -131,6 +131,7 @@ export async function resolveSavedObjectsImportErrors({
    retries,
    createNewCopies,
    dataSourceId,
+    workspaces,
  };
  const checkConflictsResult = await checkConflicts(checkConflictsParams);


how would workspaces checked in checkConflicts?

checkConflicts logic: https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/workspace/server/saved_objects/saved_objects_wrapper_for_check_workspace_conflict.ts#L219

BionIT · 2024-03-05T03:30:00Z

src/plugins/workspace/public/plugin.ts

+  public start(core: CoreStart) {
+    this.coreStart = core;
+
+    this.currentWorkspaceSubscription = this._changeSavedObjectCurrentWorkspace();


how is this currentWorkspaceSubscription used? should it be observable instead?

The currentWorkspaceSubscription is used for stopping the subscription in stop lifeCycle.

okay, how is this observable currentWorkspaceId$ initialized?

The currentWorkspaceId$ will be initialized by a workspace client. You can find the usage here: #6094

src/plugins/workspace/public/plugin.ts

SuZhou-Joe · 2024-03-05T07:04:42Z

@BionIT As the PR will contain more than 30 files changes if including both saved objects client changes and saved objects management page changes. So I will reply to your comment on saved objects management page in #6026 .

CHANGELOG.md

BionIT · 2024-03-07T03:37:58Z

src/core/public/saved_objects/saved_objects_client.ts

@@ -227,6 +234,11 @@ export class SavedObjectsClient {
    this.batchQueue = [];
  }

+  public setCurrentWorkspace(workspaceId: string): boolean {


What do you mean to make the workspaces transparent? this is to set the workspace id not get, right? plus, why would plugins need to get current workspace id from the saved objects client. Can we have the workspace id in the global context instead of setting it specific for saved object client, is it the only place where it needs to know the current workspace?

BionIT · 2024-03-07T03:48:31Z

src/plugins/workspace/public/plugin.ts

+  public start(core: CoreStart) {
+    this.coreStart = core;
+
+    this.currentWorkspaceSubscription = this._changeSavedObjectCurrentWorkspace();


okay, how is this observable currentWorkspaceId$ initialized?

BionIT · 2024-03-07T03:52:46Z

src/core/public/saved_objects/saved_objects_client.ts

+    if (options.hasOwnProperty('workspaces')) {
+      finalWorkspaces = options.workspaces;
+    } else if (typeof currentWorkspaceId === 'string') {
+      finalWorkspaces = [currentWorkspaceId];


Can't we just set workspace id into options when using the saved object client?

src/core/public/saved_objects/saved_objects_client.ts

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

…roject#6014) * feat: consume current workspace in saved objects management and saved objects client Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add unit test for each change Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: update snapshot of unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update snapshot Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * revert: saved object management changes Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add CHANGELOG Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address some comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: remove useless return Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: bootstrap error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update CHANGELOG Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update CHANGELOG Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: optimize code Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

…roject#6014) (#290) * feat: consume current workspace in saved objects management and saved objects client * feat: add unit test * feat: add unit test for each change * fix: update snapshot of unit test * fix: unit test * fix: unit test * fix: unit test * feat: update snapshot * revert: saved object management changes * feat: add CHANGELOG * feat: address some comment * feat: address comment * feat: remove useless return * fix: bootstrap error * feat: update CHANGELOG * feat: update CHANGELOG * feat: optimize code * feat: update comment --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: consume current workspace in saved objects management and saved objects client Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add unit test for each change Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: update snapshot of unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update snapshot Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * revert: saved object management changes Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add CHANGELOG Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address some comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: remove useless return Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: bootstrap error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update CHANGELOG Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update CHANGELOG Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: optimize code Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com> (cherry picked from commit 8f0885d) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

* feat: consume current workspace in saved objects management and saved objects client Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add unit test for each change Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: update snapshot of unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update snapshot Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * revert: saved object management changes Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add CHANGELOG Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address some comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: remove useless return Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: bootstrap error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update CHANGELOG Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update CHANGELOG Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: optimize code Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com> (cherry picked from commit 8f0885d) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

github-actions bot added the valued-contributor label Mar 4, 2024

SuZhou-Joe force-pushed the current-workspace-in-saved-objects-client-official branch from 86b2934 to 23f5907 Compare March 4, 2024 08:22

SuZhou-Joe added workspace v2.13.0 labels Mar 4, 2024

SuZhou-Joe changed the title ~~[Workspace] Consume workspace id in saved object client and saved object management page~~ [Workspace] Consume workspace id in saved object client Mar 5, 2024

SuZhou-Joe force-pushed the current-workspace-in-saved-objects-client-official branch 2 times, most recently from d801828 to 645d605 Compare March 5, 2024 02:30

BionIT reviewed Mar 5, 2024

View reviewed changes

SuZhou-Joe force-pushed the current-workspace-in-saved-objects-client-official branch from 645d605 to 811eb0c Compare March 6, 2024 10:25

SuZhou-Joe marked this pull request as ready for review March 6, 2024 10:27

SuZhou-Joe requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, kristenTian, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, BSFishy, curq, bandinib-amzn and ruanyl as code owners March 6, 2024 10:27

BionIT reviewed Mar 7, 2024

View reviewed changes

ruanyl reviewed Mar 7, 2024

View reviewed changes

SuZhou-Joe added 15 commits March 9, 2024 09:12

fix: update snapshot of unit test

79fb563

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

fix: unit test

31ae62d

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

fix: unit test

5487187

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

fix: unit test

041468b

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

feat: update snapshot

07d1db5

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

revert: saved object management changes

dbca9e7

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

feat: add CHANGELOG

dfd4899

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

feat: address some comment

732f36d

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

feat: address comment

58d31b2

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

feat: remove useless return

4ff89e8

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

fix: bootstrap error

2ef13f8

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

feat: update CHANGELOG

ee508ad

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

feat: update CHANGELOG

e202085

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

feat: optimize code

9685b71

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

feat: update comment

c553a36

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

SuZhou-Joe dismissed ruanyl’s stale review via c553a36 March 9, 2024 01:13

SuZhou-Joe force-pushed the current-workspace-in-saved-objects-client-official branch from 75f5530 to c553a36 Compare March 9, 2024 01:13

SuZhou-Joe removed the v2.13.0 label Mar 9, 2024

BionIT approved these changes Mar 9, 2024

View reviewed changes

ruanyl approved these changes Mar 9, 2024

View reviewed changes

SuZhou-Joe merged commit 8f0885d into opensearch-project:main Mar 9, 2024
58 of 59 checks passed

SuZhou-Joe added backport 2.x v2.14.0 labels Apr 11, 2024

opensearch-trigger-bot bot mentioned this pull request Apr 11, 2024

[Backport 2.x] [Workspace] Consume workspace id in saved object client #6406

Merged

AMoo-Miki added the in-next label Sep 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workspace] Consume workspace id in saved object client #6014

[Workspace] Consume workspace id in saved object client #6014

SuZhou-Joe commented Mar 4, 2024 •

edited

Loading

codecov bot commented Mar 4, 2024 •

edited

Loading

BionIT left a comment

BionIT Mar 5, 2024

SuZhou-Joe Mar 5, 2024 •

edited

Loading

BionIT Mar 7, 2024

SuZhou-Joe Mar 8, 2024

BionIT Mar 5, 2024

SuZhou-Joe Mar 5, 2024 •

edited

Loading

BionIT Mar 7, 2024

SuZhou-Joe Mar 8, 2024

BionIT Mar 5, 2024

SuZhou-Joe Mar 5, 2024

BionIT Mar 5, 2024

SuZhou-Joe Mar 5, 2024

BionIT Mar 7, 2024

SuZhou-Joe Mar 8, 2024

SuZhou-Joe commented Mar 5, 2024

BionIT Mar 7, 2024

BionIT Mar 7, 2024

BionIT Mar 7, 2024

[Workspace] Consume workspace id in saved object client #6014

[Workspace] Consume workspace id in saved object client #6014

Conversation

SuZhou-Joe commented Mar 4, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Check List

codecov bot commented Mar 4, 2024 • edited Loading

Codecov Report

BionIT left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SuZhou-Joe Mar 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SuZhou-Joe Mar 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SuZhou-Joe commented Mar 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SuZhou-Joe commented Mar 4, 2024 •

edited

Loading

codecov bot commented Mar 4, 2024 •

edited

Loading

SuZhou-Joe Mar 5, 2024 •

edited

Loading

SuZhou-Joe Mar 5, 2024 •

edited

Loading