[Workspace] Delete saved objects by workspace #6013

Hailong-am · 2024-03-04T07:12:47Z

Description

Add delete saved objects by workspace functionality. When delete workspace we need delete all saved objects under this workspace.

Issues Resolved

Partial of #4944
Closes #6016

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

* Delete saved objects by workspace Signed-off-by: Hailong Cui <ihailong@amazon.com> fix osd boostrap Signed-off-by: Hailong Cui <ihailong@amazon.com> * add unit test Signed-off-by: Hailong Cui <ihailong@amazon.com> * fix can't delete workspace due to invalid permission Signed-off-by: Hailong Cui <ihailong@amazon.com> --------- Signed-off-by: Hailong Cui <ihailong@amazon.com>

Signed-off-by: Hailong Cui <ihailong@amazon.com>

codecov · 2024-03-04T07:28:05Z

Codecov Report

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

Project coverage is 67.12%. Comparing base (8f0885d) to head (2f3418c).

Files	Patch %	Lines
...rver/saved_objects/service/saved_objects_client.ts	66.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6013      +/-   ##
==========================================
- Coverage   67.14%   67.12%   -0.02%     
==========================================
  Files        3324     3324              
  Lines       64309    64318       +9     
  Branches    10341    10344       +3     
==========================================
- Hits        43182    43176       -6     
- Misses      18604    18618      +14     
- Partials     2523     2524       +1

Flag	Coverage Δ
Linux_1	`31.66% <0.00%> (-0.01%)`	⬇️
Linux_2	`55.23% <88.88%> (+0.01%)`	⬆️
Linux_3	`44.70% <0.00%> (-0.01%)`	⬇️
Linux_4	`35.08% <11.11%> (-0.01%)`	⬇️
Windows_1	`31.68% <0.00%> (-0.04%)`	⬇️
Windows_2	`55.20% <88.88%> (+0.01%)`	⬆️
Windows_3	`44.70% <0.00%> (-0.02%)`	⬇️
Windows_4	`35.08% <11.11%> (-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.

SuZhou-Joe · 2024-03-04T09:07:00Z

A quick question that it seems all the changes are happening on server side, will we add a new public method like deleteByWorkspace in public/workspace.client?

Hailong-am · 2024-03-04T09:27:04Z

A quick question that it seems all the changes are happening on server side, will we add a new public method like deleteByWorkspace in public/workspace.client?

No, this's part of delete workspace logic at server side. There will have a public method delete in public/workspaceClient which will call delete method at server side.

src/core/server/saved_objects/service/lib/repository.ts

ZilongX · 2024-03-06T19:05:05Z

src/core/server/saved_objects/service/lib/repository.ts

+   * @returns {promise} - { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures }
+   */
+  async deleteByWorkspace(
+    workspace: string,


Is it taking the workspace name or id as the param ?

if it's actually taking the id maybe let's try to name like workspaceId or add the detail in the comment

make sense. As we are using workspace everywhere to reference as its id, to make the name consistent, let me add this to parameter comment.

Signed-off-by: Hailong Cui <ihailong@amazon.com>

Hailong-am · 2024-03-11T02:50:03Z

link check failed due to http://fakenews.co/opensearch-dashboards-test/v6.8.2.json is not reachable in this file src/plugins/newsfeed/public/lib/api.test.ts

Errors in src/plugins/newsfeed/public/lib/api.test.ts
+ echo
+ echo ::set-output name=exit_code::2
✗ http://fakenews.co/opensearch-dashboards-test/v6.8.2.json (error sending request for url (http://fakenews.co/opensearch-dashboards-test/v6.8.2.json): connection closed before message completed)
Warning: The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/```

SuZhou-Joe · 2024-03-11T05:13:35Z

CHANGELOG.md

@@ -30,6 +30,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [Multiple Datasource] Add Vega support to MDS by specifying a data source name in the Vega spec ([#5975](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5975))
 - [Workspace] Consume workspace id in saved object client ([#6014](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6014))



Nit: useless empty line

opensearch-trigger-bot · 2024-04-12T03:51:58Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-6013-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 735424bcaabfc752453c4d514ddd5d4b4f1b6d6d
# Push it to GitHub
git push --set-upstream origin backport/backport-6013-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-6013-to-2.x.

* [API] Delete saved objects by workspace (opensearch-project#216) * Delete saved objects by workspace Signed-off-by: Hailong Cui <ihailong@amazon.com> fix osd boostrap Signed-off-by: Hailong Cui <ihailong@amazon.com> * add unit test Signed-off-by: Hailong Cui <ihailong@amazon.com> * fix can't delete workspace due to invalid permission Signed-off-by: Hailong Cui <ihailong@amazon.com> --------- Signed-off-by: Hailong Cui <ihailong@amazon.com> * update test case Signed-off-by: Hailong Cui <ihailong@amazon.com> * Add change log Signed-off-by: Hailong Cui <ihailong@amazon.com> * update change log format Signed-off-by: Hailong Cui <ihailong@amazon.com> * update method comments to make it more clear Signed-off-by: Hailong Cui <ihailong@amazon.com> --------- Signed-off-by: Hailong Cui <ihailong@amazon.com> (cherry picked from commit 735424b)

* [Workspace] Delete saved objects by workspace (#6013) * [API] Delete saved objects by workspace (#216) * Delete saved objects by workspace Signed-off-by: Hailong Cui <ihailong@amazon.com> fix osd boostrap Signed-off-by: Hailong Cui <ihailong@amazon.com> * add unit test Signed-off-by: Hailong Cui <ihailong@amazon.com> * fix can't delete workspace due to invalid permission Signed-off-by: Hailong Cui <ihailong@amazon.com> --------- Signed-off-by: Hailong Cui <ihailong@amazon.com> * update test case Signed-off-by: Hailong Cui <ihailong@amazon.com> * Add change log Signed-off-by: Hailong Cui <ihailong@amazon.com> * update change log format Signed-off-by: Hailong Cui <ihailong@amazon.com> * update method comments to make it more clear Signed-off-by: Hailong Cui <ihailong@amazon.com> --------- Signed-off-by: Hailong Cui <ihailong@amazon.com> (cherry picked from commit 735424b) * Update CHANGELOG.md Co-authored-by: SuZhou-Joe <suzhou@amazon.com> Signed-off-by: Hailong Cui <ihailong@amazon.com> --------- Signed-off-by: Hailong Cui <ihailong@amazon.com> Co-authored-by: SuZhou-Joe <suzhou@amazon.com>

opensearch-trigger-bot · 2024-05-02T07:24:42Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-6013-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 735424bcaabfc752453c4d514ddd5d4b4f1b6d6d
# Push it to GitHub
git push --set-upstream origin backport/backport-6013-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-6013-to-2.x.

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

Hailong-am added 3 commits March 4, 2024 15:13

update test case

15b93b3

Signed-off-by: Hailong Cui <ihailong@amazon.com>

Add change log

c82eae2

Signed-off-by: Hailong Cui <ihailong@amazon.com>

Hailong-am force-pushed the main branch from 5755741 to c82eae2 Compare March 4, 2024 07:14

update change log format

f1fcfd4

Signed-off-by: Hailong Cui <ihailong@amazon.com>

Merge branch 'main' into main

606a933

Hailong-am marked this pull request as ready for review March 4, 2024 08:28

Hailong-am requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, kristenTian, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, BSFishy, curq, bandinib-amzn, SuZhou-Joe, ruanyl and BionIT as code owners March 4, 2024 08:28

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

Hailong-am mentioned this pull request Mar 4, 2024

[Workspace] Support delete saved objects by workspace #6016

Closed

Merge branch 'main' into main

c833954

ZilongX reviewed Mar 6, 2024

View reviewed changes

Hailong-am added 3 commits March 7, 2024 10:42

Merge remote-tracking branch 'upstream/main'

bf8023f

update method comments to make it more clear

99ea718

Signed-off-by: Hailong Cui <ihailong@amazon.com>

Merge branch 'main' into main

a2d1e52

ZilongX approved these changes Mar 8, 2024

View reviewed changes

Merge branch 'main' into main

2f3418c

SuZhou-Joe approved these changes Mar 11, 2024

View reviewed changes

SuZhou-Joe merged commit 735424b into opensearch-project:main Mar 11, 2024
67 of 68 checks passed

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

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

opensearch-trigger-bot bot added the failed backport label Apr 12, 2024

Hailong-am mentioned this pull request Apr 12, 2024

[Backport 2.x] [Workspace] Delete saved objects by workspace #6424

Merged

kavilla added backport 2.x and removed backport 2.x failed backport labels May 2, 2024

opensearch-trigger-bot bot added the failed backport label May 2, 2024

kavilla removed the failed backport label May 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workspace] Delete saved objects by workspace #6013

[Workspace] Delete saved objects by workspace #6013

Hailong-am commented Mar 4, 2024 •

edited by SuZhou-Joe

codecov bot commented Mar 4, 2024 •

edited

SuZhou-Joe commented Mar 4, 2024

Hailong-am commented Mar 4, 2024

ZilongX Mar 6, 2024

ZilongX Mar 6, 2024

Hailong-am Mar 7, 2024

Hailong-am commented Mar 11, 2024

SuZhou-Joe Mar 11, 2024

opensearch-trigger-bot bot commented Apr 12, 2024

opensearch-trigger-bot bot commented May 2, 2024

		@@ -30,6 +30,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
		- [Multiple Datasource] Add Vega support to MDS by specifying a data source name in the Vega spec ([#5975](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5975))
		- [Workspace] Consume workspace id in saved object client ([#6014](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6014))

[Workspace] Delete saved objects by workspace #6013

[Workspace] Delete saved objects by workspace #6013

Conversation

Hailong-am commented Mar 4, 2024 • edited by SuZhou-Joe

Description

Issues Resolved

Screenshot

Testing the changes

Check List

codecov bot commented Mar 4, 2024 • edited

Codecov Report

SuZhou-Joe commented Mar 4, 2024

Hailong-am commented Mar 4, 2024

ZilongX Mar 6, 2024

Choose a reason for hiding this comment

ZilongX Mar 6, 2024

Choose a reason for hiding this comment

Hailong-am Mar 7, 2024

Choose a reason for hiding this comment

Hailong-am commented Mar 11, 2024

SuZhou-Joe Mar 11, 2024

Choose a reason for hiding this comment

opensearch-trigger-bot bot commented Apr 12, 2024

opensearch-trigger-bot bot commented May 2, 2024

Hailong-am commented Mar 4, 2024 •

edited by SuZhou-Joe

codecov bot commented Mar 4, 2024 •

edited