Refactor: move workspace logic from repository to saved objects client wrapper

[SuZhou-Joe]

Description

Move workspace check conflict related logic to a saved objects client wrapper so that the logic can be turned off once workspace plugin is disabled, introducing as less as possible effect on OSD core.

Issues Resolved

Screenshot

Testing the changes

Check List

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

[ruanyl]

Left a comment, nice refactor!

[ruanyl]

Can we encapsulate this wrapper with the existing WorkspaceSavedObjectsClientWrapper? This may save some API calls to wrapperOptions.client.get and wrapperOptions.client.bulkGet

[SuZhou-Joe]

Yeah, sounds reasonable. Will take a look then.

[SuZhou-Joe]

Did some research and it seems that these two wrappers are controlled by different flags: workspace.enabled and workspace.permission.enabled. I am afraid combining these two wrappers as one may lead to complex if/else. And as we will merge the conflict wrapper before permission check wrapper, I'd like to raise a following issue to optimize the code if we have more bandwidth on 2.13.

[xluo-aws]

if they are for different purpose and can be used independently, better to have separate wrappers

[codecov-commenter]

Codecov Report

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

Project coverage is 66.75%. Comparing base (dc240eb) to head (25c32e5).
Report is 127 commits behind head on workspace.

Files	Patch %	Lines
...erver/saved_objects/import/create_saved_objects.ts	28.00%	14 Missing and 4 partials ⚠️
packages/osd-pm/src/utils/project.ts	26.08%	17 Missing ⚠️
packages/osd-pm/src/utils/scripts.ts	0.00%	15 Missing ⚠️
...rces/datasource_selector/datasource_selectable.tsx	68.29%	11 Missing and 2 partials ⚠️
src/core/server/saved_objects/routes/import.ts	0.00%	5 Missing ⚠️
...rver/saved_objects/routes/resolve_import_errors.ts	0.00%	5 Missing ⚠️
src/dev/build/lib/fs.ts	44.44%	5 Missing ⚠️
src/core/server/http/router/response_adapter.ts	0.00%	2 Missing and 2 partials ⚠️
...d_objects/import/check_conflict_for_data_source.ts	84.00%	1 Missing and 3 partials ⚠️
...cross_compatibility/cross_compatibility_service.ts	90.32%	2 Missing and 1 partial ⚠️
... and 21 more

Additional details and impacted files

@@              Coverage Diff              @@
##           workspace     #248      +/-   ##
=============================================
+ Coverage      66.24%   66.75%   +0.51%     
=============================================
  Files           3438     3337     -101     
  Lines          66264    64801    -1463     
  Branches       10694    10453     -241     
=============================================
- Hits           43899    43261     -638     
+ Misses         19757    18952     -805     
+ Partials        2608     2588      -20     

Flag	Coverage Δ
Linux_1	31.41% <7.66%> (+0.52%)	⬆️
Linux_2	55.22% <57.72%> (-0.21%)	⬇️
Linux_3	41.74% <39.25%> (-1.03%)	⬇️
Linux_4	34.88% <12.07%> (+0.35%)	⬆️

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]

Seems this function is only used by src/plugins/workspace/server/saved_objects/saved_objects_wrapper_for_check_workspace_conflict.ts, I think we can move it there so we don't need to bother this util class in core

[ruanyl]

Isn't workspaces already specified in the options? SavedObjectsBaseOptions

[wanglam]

The SavedObjectsBulkCreateObject doesn't extends SavedObjectsBaseOptions.

[opensearch-workspace-development]

The backport to workspace-pr-integr 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-workspace-pr-integr workspace-pr-integr
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-workspace-pr-integr
# Create a new branch
git switch --create backport/backport-248-to-workspace-pr-integr
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 415605f437ed138d4d8f5c08fa67a2b905ece4ff
# Push it to GitHub
git push --set-upstream origin backport/backport-248-to-workspace-pr-integr
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-workspace-pr-integr

Then, create a pull request where the base branch is workspace-pr-integr and the compare/head branch is backport/backport-248-to-workspace-pr-integr.