[Workspace] Fix: keep disallowed types when importing with overwrite #6668

SuZhou-Joe · 2024-04-29T03:04:11Z

Description

When importing data sources and configuration into a workspace with overwrite: true, we will prevent the creation of such objects. However, to ensure that objects dependent on the disallowed ones continue to function properly, we must leave their references untouched.

How the changes can keep the references untouched.

When user tries to import with overwrite: true, the logic will go into https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/core/server/saved_objects/import/check_conflicts.ts#L90, and in order to keep the references untouched, we just need to make sure the logic won't go into the branch of https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/core/server/saved_objects/import/check_conflicts.ts#L105 , which sets a new id reference to the current item. And the result it is consumed comes from the savedObjectsClient.checkConflicts(), which can be wrapped by savedObjectsClientWrapper mechanism to intercept special logic on specific objects.

Issues Resolved

Screenshot

Before fix

After fix

Testing the changes

There is a integration test case, named checkConflicts when importing disallowed types inside src/plugins/workspace/server/saved_objects/integration_tests/saved_objects_wrapper_for_check_workspace_conflict.test.ts to cover this case.

Changelog

fix: keep disallowed types when importing with overwrite

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

Signed-off-by: SuZhou-Joe <[email protected]>

codecov · 2024-04-29T03:18:26Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.81%. Comparing base (460428c) to head (1df34d1).
Report is 468 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6668      +/-   ##
==========================================
+ Coverage   67.79%   67.81%   +0.02%     
==========================================
  Files        3413     3413              
  Lines       66755    66770      +15     
  Branches    10861    10864       +3     
==========================================
+ Hits        45254    45282      +28     
+ Misses      18857    18845      -12     
+ Partials     2644     2643       -1

Flag	Coverage Δ
Linux_1	`33.21% <100.00%> (+0.02%)`	⬆️
Linux_2	`55.63% <ø> (ø)`
Linux_3	`45.24% <ø> (ø)`
Linux_4	`34.91% <ø> (ø)`
Windows_1	`33.26% <100.00%> (+0.04%)`	⬆️
Windows_2	`55.59% <ø> (ø)`
Windows_3	`45.26% <ø> (ø)`
Windows_4	`34.91% <ø> (ø)`

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.

Signed-off-by: SuZhou-Joe <[email protected]>

...plugins/workspace/server/saved_objects/saved_objects_wrapper_for_check_workspace_conflict.ts

ruanyl · 2024-04-29T08:04:50Z

we must leave their references untouched.

@SuZhou-Joe could you help me to understand how this PR addressed the above issue?

Signed-off-by: SuZhou-Joe <[email protected]>

SuZhou-Joe · 2024-04-29T08:56:36Z

@ruanyl Sure, updated in the description and thanks for calling it out. It requires some context to figure the whole flow out.

Hailong-am · 2024-04-29T12:18:06Z

...plugins/workspace/server/saved_objects/saved_objects_wrapper_for_check_workspace_conflict.ts

+      const disallowedSavedObjects: SavedObjectsCheckConflictsObject[] = [];
+      const allowedSavedObjects: SavedObjectsCheckConflictsObject[] = [];
+      objects.forEach((item) => {
+        const isImportIntoWorkspace = !!workspaces?.length;


nit: this line could move out the forEach loop

Hailong-am · 2024-04-29T12:18:30Z

...plugins/workspace/server/saved_objects/saved_objects_wrapper_for_check_workspace_conflict.ts

+        }
+
+        allowedSavedObjects.push(item);
+        return;


nit: return is not needed here

kavilla

+1 @Hailong-am comments>

For clarification, we are talking about keeping the disallowed types in the destination workspace right?

Approving because seems fine to me

…6668) * fix: keep disallowed types when importing with overwrite Signed-off-by: SuZhou-Joe <[email protected]> * Changeset file for PR #6668 created/updated * feat: update comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: address some minor concern Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> (cherry picked from commit de6a889) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…with overwrite (#6673) * [Workspace] Fix: keep disallowed types when importing with overwrite (#6668) * fix: keep disallowed types when importing with overwrite Signed-off-by: SuZhou-Joe <[email protected]> * Changeset file for PR #6668 created/updated * feat: update comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: address some minor concern Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> (cherry picked from commit de6a889) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Update src/plugins/workspace/server/saved_objects/integration_tests/saved_objects_wrapper_for_check_workspace_conflict.test.ts Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Co-authored-by: SuZhou-Joe <[email protected]>

…pensearch-project#6668) * fix: keep disallowed types when importing with overwrite Signed-off-by: SuZhou-Joe <[email protected]> * Changeset file for PR opensearch-project#6668 created/updated * feat: update comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: address some minor concern Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

fix: keep disallowed types when importing with overwrite

20daeed

Signed-off-by: SuZhou-Joe <[email protected]>

SuZhou-Joe requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, curq, bandinib-amzn, ruanyl, BionIT and xinruiba as code owners April 29, 2024 03:04

github-actions bot added seasoned-contributor failed changeset labels Apr 29, 2024

SuZhou-Joe added bug Something isn't working workspace v2.14.0 labels Apr 29, 2024

Changeset file for PR opensearch-project#6668 created/updated

fb89f0e

github-actions bot removed the failed changeset label Apr 29, 2024

opensearch-project deleted a comment from github-actions bot Apr 29, 2024

feat: update comment

7f2fe36

Signed-off-by: SuZhou-Joe <[email protected]>

wanglam reviewed Apr 29, 2024

View reviewed changes

...plugins/workspace/server/saved_objects/saved_objects_wrapper_for_check_workspace_conflict.ts Outdated Show resolved Hide resolved

feat: address some minor concern

1df34d1

Signed-off-by: SuZhou-Joe <[email protected]>

wanglam approved these changes Apr 29, 2024

View reviewed changes

ruanyl approved these changes Apr 29, 2024

View reviewed changes

Hailong-am reviewed Apr 29, 2024

View reviewed changes

kavilla approved these changes Apr 29, 2024

View reviewed changes

kavilla added the backport 2.x label Apr 29, 2024

SuZhou-Joe merged commit de6a889 into opensearch-project:main Apr 29, 2024
71 checks passed

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

[Backport 2.x] [Workspace] Fix: keep disallowed types when importing with overwrite #6673

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] Fix: keep disallowed types when importing with overwrite #6668

[Workspace] Fix: keep disallowed types when importing with overwrite #6668

SuZhou-Joe commented Apr 29, 2024 •

edited

Loading

codecov bot commented Apr 29, 2024 •

edited

Loading

ruanyl commented Apr 29, 2024

SuZhou-Joe commented Apr 29, 2024

Hailong-am Apr 29, 2024

Hailong-am Apr 29, 2024 •

edited

Loading

kavilla left a comment

[Workspace] Fix: keep disallowed types when importing with overwrite #6668

[Workspace] Fix: keep disallowed types when importing with overwrite #6668

Conversation

SuZhou-Joe commented Apr 29, 2024 • edited Loading

Description

How the changes can keep the references untouched.

Issues Resolved

Screenshot

Before fix

After fix

Testing the changes

Changelog

Check List

codecov bot commented Apr 29, 2024 • edited Loading

Codecov Report

ruanyl commented Apr 29, 2024

SuZhou-Joe commented Apr 29, 2024

Hailong-am Apr 29, 2024

Choose a reason for hiding this comment

Hailong-am Apr 29, 2024 • edited Loading

Choose a reason for hiding this comment

kavilla left a comment

Choose a reason for hiding this comment

SuZhou-Joe commented Apr 29, 2024 •

edited

Loading

codecov bot commented Apr 29, 2024 •

edited

Loading

Hailong-am Apr 29, 2024 •

edited

Loading