[Workspace] Add duplicate saved objects API

[gaobinlong]

Description

This PR adds a new server api named duplicate_saved_objects which can be used to duplicate saved objects among workspaces, the implementation is simple, we leverage the code of the existing export api and import api to implement this functionality. In addition, same to export api and import api, the duplicate api will also be under the control of the setting savedObjects.maxImportExportSize(defaults to 10000) and savedObjects.maxImportPayloadBytes (defaults to 26214400).

For this new api, the usage is:
Request:

curl -X POST "localhost:5601/api/workspaces/_duplicate_saved_objects" -H 'osd-xsrf: true' -H 'Content-Type: application/json' -d '{"objects":[{"type":"index-pattern","id":"619cc200-ecd0-11ee-95b1-e7363f9e289d"}],"targetWorkspace":"9gt4lB"}'

Response:

{"successCount":1,"success":true,"successResults":[{"type":"index-pattern","id":"619cc200-ecd0-11ee-95b1-e7363f9e289d","meta":{"title":"test*","icon":"indexPatternApp"},"destinationId":"2ffee5da-55b3-49b4-b9e1-c3af5d1adbd3"}]}

Issues Resolved

#6286

Screenshot

No UI change in this PR, the UI change will be in the following PR, here is the video about it:

2024-04-07.10.55.45.mov

Testing the changes

1. Clone the latest code and run yarn osd bootstrap
2. Modify config/opensearch_dashboards.yml, add workspace.enabled: true
3. Run yarn start --no-base-path
4. Create a workspace and create some saved objects like index patterns, visualizations, etc.
5. Call the copy api following the above usage.

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]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.62%. Comparing base (85df662) to head (8c9a08d).
Report is 7 commits behind head on main.

❗ Current head 8c9a08d differs from pull request most recent head 7172f55. Consider uploading reports for the commit 7172f55 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6288      +/-   ##
==========================================
+ Coverage   55.58%   55.62%   +0.03%     
==========================================
  Files        1199     1199              
  Lines       24259    24259              
  Branches     4087     4087              
==========================================
+ Hits        13485    13493       +8     
+ Misses      10133    10124       -9     
- Partials      641      642       +1     

Flag	Coverage Δ
Linux_2	55.62% <ø> (?)
Windows_2	?

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.

[ashwin-pc]

Can we add docs for the new API changes? Als can we document the existing API as a part of this change?

[gaobinlong]

Can we add docs for the new API changes? Als can we document the existing API as a part of this change?

I'm glad to do that, and how could we add documents for the server apis?

[ashwin-pc]

Here are all the Readme's in the repo that document various features. https://opensearch-project.github.io/OpenSearch-Dashboards/docs/index.html#/. I think adding it to the main saved object plugin readme should be good enough. https://opensearch-project.github.io/OpenSearch-Dashboards/docs/index.html#/../src/plugins/saved_objects/README

[gaobinlong]

Here are all the Readme's in the repo that document various features. https://opensearch-project.github.io/OpenSearch-Dashboards/docs/index.html#/. I think adding it to the main saved object plugin readme should be good enough. https://opensearch-project.github.io/OpenSearch-Dashboards/docs/index.html#/../src/plugins/saved_objects/README

I've added the documentation for all saved objects API, the format refers to OpenSearch API's document, please help to take a look, thanks!

[gaobinlong]

Hi @gaobinlong,

I am taking one step back and thinking logic again after watching video and going over PR again - Why we need to introduce new API? You already retrieve and load data on page. You just need to create new saved object with new workspace. Why you are exporting and importing again?

And if we still want to use export import workflow, instead of adding new api, we can call directly existing export and import api, right? With new approach I observed you need to add validation logic which we already have in export api.

Thanks @bandinib-amzn , I think all of your comments above have been addressed yet, please take a look at the latest change, thank you!

For why we add this new API, firstly, the loaded data on the page are not complete, we need to fetch all the details of the references before creating them in the target workspace, secondly, instead of call export API and then import API, this new API makes it easier for users to duplicate saved objects when they just call the server APIs to complete their work, I saw many users asked about how to call the OSD's API in OpenSearch's forum, so I think this new API may reduce the complexity when they need.

[SuZhou-Joe]

LGTM

[bandinib-amzn]

Build and test / Build and Verify on Linux (ciGroup3) CI is failing due to #6360 . PR is open #6411 to fix issue.