Support workspace in saved objects client in server side. #293

SuZhou-Joe · 2024-03-13T09:34:34Z

Description

Support workspace in saved objects client in server side to unified the way to append workspace id in request payload. Some key points need to check:

Add a plugin state inside request to bypass workspace id.

Issues Resolved

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-commenter · 2024-03-13T10:17:31Z

Codecov Report

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

Project coverage is 66.94%. Comparing base (0f34d69) to head (d5ccfad).

Files	Patch %	Lines
...ore/server/saved_objects/import/check_conflicts.ts	0.00%	0 Missing and 1 partial ⚠️
...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                    @@
##           workspace-pr-integr     #293       +/-   ##
========================================================
+ Coverage                35.17%   66.94%   +31.77%     
========================================================
  Files                     1885     2603      +718     
  Lines                    36421    49239    +12818     
  Branches                  6672     8898     +2226     
========================================================
+ Hits                     12810    32964    +20154     
+ Misses                   22761    14106     -8655     
- Partials                   850     2169     +1319

Flag	Coverage Δ
_2	`55.35% <0.00%> (?)`
_3	`43.48% <0.00%> (?)`
_4	`35.16% <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.

wanglam · 2024-03-22T07:13:23Z

@SuZhou-Joe It seems the CI was failed. Could you fix them first?

src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.ts

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

src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.ts

src/plugins/workspace/server/plugin.ts

src/plugins/workspace/server/saved_objects/workspace_id_consumer_wrapper.test.ts

src/plugins/workspace/server/saved_objects/workspace_id_consumer_wrapper.ts

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

src/core/server/saved_objects/service/saved_objects_client.ts

src/core/types/saved_objects.ts

…server-side

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

…opensearch-project#6365) * Support workspace in saved objects client in server side. (#293) * feat: POC implementation Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add some comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: revert dependency Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address one TODO Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address TODO Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: some special logic on specific operation Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add integration test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: declare workspaces as empty array for advanced settings Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: unified workspaces parameters when parsing from router Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: improve code coverage Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: declare workspaces as null Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: use unified types Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: remove null Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address comments Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: use request app to store request workspace id Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: use app state to store request workspace id Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * refact: update types declaration Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: unit test error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: import error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add integration test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update CHANGELOG Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: use consts and add comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: change the priority value Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update Signed-off-by: SuZhou-Joe <suzhou@amazon.com> --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

…objects client in server side (opensearch-project#6365) (#327) * [Workspace] Support workspace in saved objects client in server side. (opensearch-project#6365) * Support workspace in saved objects client in server side. (#293) * feat: POC implementation Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add some comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: revert dependency Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address one TODO Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address TODO Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: some special logic on specific operation Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add integration test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: declare workspaces as empty array for advanced settings Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: unified workspaces parameters when parsing from router Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: improve code coverage Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: declare workspaces as null Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: use unified types Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: remove null Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address comments Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: use request app to store request workspace id Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: use app state to store request workspace id Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * refact: update types declaration Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: unit test error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: import error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add integration test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update CHANGELOG Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: use consts and add comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: change the priority value Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update Signed-off-by: SuZhou-Joe <suzhou@amazon.com> --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: remove useless code Signed-off-by: SuZhou-Joe <suzhou@amazon.com> --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

…opensearch-project#6365) (opensearch-project#6573) * Support workspace in saved objects client in server side. (#293) * feat: POC implementation Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add some comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: revert dependency Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address one TODO Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address TODO Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: some special logic on specific operation Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add integration test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: declare workspaces as empty array for advanced settings Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: unified workspaces parameters when parsing from router Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: improve code coverage Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: declare workspaces as null Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: use unified types Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: remove null Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: address comments Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: use request app to store request workspace id Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: use app state to store request workspace id Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * refact: update types declaration Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: unit test error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: import error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add integration test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update CHANGELOG Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: use consts and add comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: change the priority value Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update Signed-off-by: SuZhou-Joe <suzhou@amazon.com> --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com> (cherry picked from commit 3b03fa9) 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 distinguished-contributor label Mar 13, 2024

Hailong-am reviewed Mar 27, 2024

View reviewed changes

src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.ts Outdated Show resolved Hide resolved

SuZhou-Joe force-pushed the feature/current-workspace-in-server-side branch 3 times, most recently from 78286c2 to 357efa8 Compare March 28, 2024 02:21

SuZhou-Joe added 16 commits April 1, 2024 17:13

feat: POC implementation

66d6096

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

feat: add some comment

d275f61

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

feat: revert dependency

65f6be3

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

feat: update comment

9c5d2d9

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

feat: address one TODO

d5638ff

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

feat: address TODO

45589cf

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

feat: add unit test

5d990c8

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

feat: some special logic on specific operation

08dc9e2

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

feat: add integration test

d3cccb8

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

feat: declare workspaces as empty array for advanced settings

298c2cb

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

feat: unified workspaces parameters when parsing from router

85c522d

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

feat: improve code coverage

cdbe9a8

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

feat: declare workspaces as null

cb7ebd9

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

feat: use unified types

294d2c5

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

feat: update comment

42e0e05

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

feat: remove null

1b32316

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

SuZhou-Joe force-pushed the feature/current-workspace-in-server-side branch from 1690013 to 1b32316 Compare April 1, 2024 09:14

wanglam reviewed Apr 2, 2024

View reviewed changes

SuZhou-Joe added 5 commits April 2, 2024 15:37

feat: address comments

b7a6cb7

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

feat: use request app to store request workspace id

dd6cebf

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

feat: use app state to store request workspace id

7fd5160

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

feat: merge workspace-pr-integr

a5b8c70

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

feat: merge

d5ccfad

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

ruanyl reviewed Apr 7, 2024

View reviewed changes

src/core/server/saved_objects/service/saved_objects_client.ts Show resolved Hide resolved

src/core/types/saved_objects.ts Outdated Show resolved Hide resolved

SuZhou-Joe added 3 commits April 8, 2024 09:53

Merge branch 'workspace-pr-integr' into feature/current-workspace-in-…

431aa38

…server-side

refact: update types declaration

742ec22

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

fix: unit test error

ab0486e

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

ruanyl approved these changes Apr 8, 2024

View reviewed changes

SuZhou-Joe merged commit 4fc9e70 into ruanyl:workspace-pr-integr Apr 8, 2024
43 checks passed

ruanyl mentioned this pull request Apr 12, 2024

[Workspace] Support workspace in saved objects client in server side. opensearch-project/OpenSearch-Dashboards#6365

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support workspace in saved objects client in server side. #293

Support workspace in saved objects client in server side. #293

SuZhou-Joe commented Mar 13, 2024 •

edited

Loading

codecov-commenter commented Mar 13, 2024 •

edited

Loading

wanglam commented Mar 22, 2024

Support workspace in saved objects client in server side. #293

Support workspace in saved objects client in server side. #293

Conversation

SuZhou-Joe commented Mar 13, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Check List

codecov-commenter commented Mar 13, 2024 • edited Loading

Codecov Report

wanglam commented Mar 22, 2024

SuZhou-Joe commented Mar 13, 2024 •

edited

Loading

codecov-commenter commented Mar 13, 2024 •

edited

Loading