OpenSearch-Dashboards icon indicating copy to clipboard operation
OpenSearch-Dashboards copied to clipboard

[Workspace] Add a workspace client in workspace plugin

Open SuZhou-Joe opened this issue 11 months ago • 2 comments

Description

This PR mainly introduces a workspace client to perform CRUD operations request to server side and gives some useful utils function.

Issues Resolved

closes #6093

Screenshot

As the changes only happen in a frontend client, there is no screenshot for that.

Testing the changes

  • Clone the branch and enable workspace in yml file.
  • Open the file src/plugins/workspace/public/plugin.ts
  • Perform some operations through the initialized workspaceClient like: workspaceClient.create, workspaceClient.delete and so on, it should making http request to server accordingly in browser side.

Check List

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

SuZhou-Joe avatar Mar 08 '24 02:03 SuZhou-Joe

Codecov Report

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

Project coverage is 67.14%. Comparing base (362ab1e) to head (65fc363).

Files Patch % Lines
src/plugins/workspace/public/workspace_client.ts 72.41% 10 Missing and 6 partials :warning:
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6094      +/-   ##
==========================================
+ Coverage   67.13%   67.14%   +0.01%     
==========================================
  Files        3324     3326       +2     
  Lines       64330    64394      +64     
  Branches    10347    10358      +11     
==========================================
+ Hits        43188    43239      +51     
- Misses      18618    18626       +8     
- Partials     2524     2529       +5     
Flag Coverage Δ
Linux_1 31.73% <75.00%> (+0.06%) :arrow_up:
Linux_2 55.23% <ø> (ø)
Linux_3 44.71% <ø> (+<0.01%) :arrow_up:
Linux_4 35.08% <ø> (ø)
Windows_1 31.75% <75.00%> (+0.06%) :arrow_up:
Windows_2 55.20% <ø> (ø)
Windows_3 44.73% <ø> (ø)
Windows_4 35.08% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Mar 08 '24 02:03 codecov[bot]

@BionIT Could you please take a look here to see if all the comments have been addressed?

SuZhou-Joe avatar Mar 11 '24 11:03 SuZhou-Joe