[Workspace] Add a workspace client in workspace plugin #6094

SuZhou-Joe · 2024-03-08T02:25:35Z

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

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 · 2024-03-08T02:39:34Z

Codecov Report

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

Project coverage is 67.14%. Comparing base (362ab1e) to head (65fc363).
Report is 607 commits behind head on main.

Files with missing lines	Patch %	Lines
src/plugins/workspace/public/workspace_client.ts	72.41%	10 Missing and 6 partials ⚠️

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%)`	⬆️
Linux_2	`55.23% <ø> (ø)`
Linux_3	`44.71% <ø> (+<0.01%)`	⬆️
Linux_4	`35.08% <ø> (ø)`
Windows_1	`31.75% <75.00%> (+0.06%)`	⬆️
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.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/plugins/workspace/public/workspace_client.ts

BionIT · 2024-03-08T19:46:38Z

src/plugins/workspace/public/workspace_client.ts

+   * Check if provided workspace id exists,
+   * update the currentWorkspaceId$ if it exists.
+   */
+  public async enterWorkspace(id: string): Promise<IResponse<null>> {


is it better to call it updateCurrentWorkspace then? Not sure if anyone using it would understand what does enterWorkspace mean if not looking at the code or doc

currentWorkspace$ will be updated as a derived value in https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/core/public/workspace/workspaces_service.ts#L56. So for the workspace client it does not need to update explicitly. Would it be better that we update the doc to like
Check if provided workspace id exists in the storage and update core.currentWorkspaceId$ if it exists?

when will we use this method? is it when user tries to go inside a workspace?

We will use that in setup lifeCycle of workspace plugin when user visit the page with pattern match /w/${workspaceId}/xxx, which will validate if the workspaceId exists and change the currentWorkspaceId$ if it does.

src/plugins/workspace/public/workspace_client.ts

SuZhou-Joe · 2024-03-11T11:01:43Z

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

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

BionIT · 2024-03-12T03:02:54Z

src/plugins/workspace/public/workspace_client.ts

+   * Check if provided workspace id exists,
+   * update the currentWorkspaceId$ if it exists.
+   */
+  public async enterWorkspace(id: string): Promise<IResponse<null>> {


when will we use this method? is it when user tries to go inside a workspace?

…oject#6094) * feat: add comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: update unit test Signed-off-by: SuZhou-Joe <[email protected]> * feat: add CHANGELOG Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize code Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize code Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> Signed-off-by: Hailong Cui <[email protected]>

* Add workspacePluginSetup type Signed-off-by: Hailong Cui <[email protected]> * add fakenews.co to .lycheeexclude Signed-off-by: Hailong Cui <[email protected]> * [Workspace] Add a workspace client in workspace plugin (#6094) * feat: add comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: update unit test Signed-off-by: SuZhou-Joe <[email protected]> * feat: add CHANGELOG Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize code Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize code Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> Signed-off-by: Hailong Cui <[email protected]> * Revert "add fakenews.co to .lycheeexclude" This reverts commit 55f6344. Signed-off-by: Hailong Cui <[email protected]> * Add WorkspacePluginStart Signed-off-by: Hailong Cui <[email protected]> --------- Signed-off-by: Hailong Cui <[email protected]> Signed-off-by: SuZhou-Joe <[email protected]> Co-authored-by: SuZhou-Joe <[email protected]>

…oject#6094) * feat: add comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: update unit test Signed-off-by: SuZhou-Joe <[email protected]> * feat: add CHANGELOG Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize code Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize code Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]>

…oject#6094) (#308) * feat: add comment * feat: update unit test * feat: add CHANGELOG * feat: optimize comment * feat: optimize comment * feat: optimize code * feat: optimize code --------- Signed-off-by: SuZhou-Joe <[email protected]>

* feat: add comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: update unit test Signed-off-by: SuZhou-Joe <[email protected]> * feat: add CHANGELOG Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize code Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize code Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> (cherry picked from commit 4b89ad0) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

…#6409) * [Workspace] Add a workspace client in workspace plugin (#6094) * feat: add comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: update unit test Signed-off-by: SuZhou-Joe <[email protected]> * feat: add CHANGELOG Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize code Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize code Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> (cherry picked from commit 4b89ad0) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md * fix: unit test Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Add workspacePluginSetup type Signed-off-by: Hailong Cui <[email protected]> * add fakenews.co to .lycheeexclude Signed-off-by: Hailong Cui <[email protected]> * [Workspace] Add a workspace client in workspace plugin (#6094) * feat: add comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: update unit test Signed-off-by: SuZhou-Joe <[email protected]> * feat: add CHANGELOG Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize comment Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize code Signed-off-by: SuZhou-Joe <[email protected]> * feat: optimize code Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> Signed-off-by: Hailong Cui <[email protected]> * Revert "add fakenews.co to .lycheeexclude" This reverts commit 55f6344. Signed-off-by: Hailong Cui <[email protected]> * Add WorkspacePluginStart Signed-off-by: Hailong Cui <[email protected]> --------- Signed-off-by: Hailong Cui <[email protected]> Signed-off-by: SuZhou-Joe <[email protected]> Co-authored-by: SuZhou-Joe <[email protected]> (cherry picked from commit 9cdc7c9) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Add workspacePluginSetup type * add fakenews.co to .lycheeexclude * [Workspace] Add a workspace client in workspace plugin (#6094) * feat: add comment * feat: update unit test * feat: add CHANGELOG * feat: optimize comment * feat: optimize comment * feat: optimize code * feat: optimize code --------- * Revert "add fakenews.co to .lycheeexclude" This reverts commit 55f6344. * Add WorkspacePluginStart --------- (cherry picked from commit 9cdc7c9) Signed-off-by: Hailong Cui <[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: SuZhou-Joe <[email protected]>

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

github-actions bot added the valued-contributor label Mar 8, 2024

SuZhou-Joe force-pushed the feature/workspace-public-client branch from 898e80b to 5a8a728 Compare March 8, 2024 02:26

SuZhou-Joe added the workspace label Mar 8, 2024

SuZhou-Joe mentioned this pull request Mar 8, 2024

[Workspace] Consume workspace id in saved object client #6014

Merged

7 tasks

SuZhou-Joe force-pushed the feature/workspace-public-client branch from b81b5cd to 37e9793 Compare March 8, 2024 03:24

ZilongX previously approved these changes Mar 8, 2024

View reviewed changes

SuZhou-Joe dismissed ZilongX’s stale review via 9b21ba0 March 8, 2024 23:51

SuZhou-Joe force-pushed the feature/workspace-public-client branch from 37e9793 to 9b21ba0 Compare March 8, 2024 23:51

BionIT reviewed Mar 9, 2024

View reviewed changes

SuZhou-Joe force-pushed the feature/workspace-public-client branch from 56ba159 to 56d4113 Compare March 9, 2024 01:48

feat: add comment

226cd21

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

SuZhou-Joe added 6 commits March 12, 2024 10:38

feat: update unit test

3972488

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

feat: add CHANGELOG

ae2af70

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

feat: optimize comment

03bacb6

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

feat: optimize comment

43e00f4

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

feat: optimize code

9abb9c3

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

feat: optimize code

65fc363

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

SuZhou-Joe force-pushed the feature/workspace-public-client branch from 866d2e0 to 65fc363 Compare March 12, 2024 02:39

BionIT approved these changes Mar 12, 2024

View reviewed changes

ruanyl approved these changes Mar 12, 2024

View reviewed changes

SuZhou-Joe merged commit 4b89ad0 into opensearch-project:main Mar 12, 2024
68 of 69 checks passed

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

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

[Backport 2.x] [Workspace] Add a workspace client in workspace plugin #6408

Closed

SuZhou-Joe mentioned this pull request Apr 11, 2024

[Backport 2.x] [Workspace] Add a workspace client in workspace plugin #6409

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] Add a workspace client in workspace plugin #6094

[Workspace] Add a workspace client in workspace plugin #6094

SuZhou-Joe commented Mar 8, 2024 •

edited

Loading

codecov bot commented Mar 8, 2024 •

edited

Loading

BionIT Mar 8, 2024

SuZhou-Joe Mar 9, 2024

BionIT Mar 12, 2024

SuZhou-Joe Mar 12, 2024

SuZhou-Joe commented Mar 11, 2024

BionIT Mar 12, 2024

[Workspace] Add a workspace client in workspace plugin #6094

[Workspace] Add a workspace client in workspace plugin #6094

Conversation

SuZhou-Joe commented Mar 8, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Check List

codecov bot commented Mar 8, 2024 • edited Loading

Codecov Report

BionIT Mar 8, 2024

Choose a reason for hiding this comment

SuZhou-Joe Mar 9, 2024

Choose a reason for hiding this comment

BionIT Mar 12, 2024

Choose a reason for hiding this comment

SuZhou-Joe Mar 12, 2024

Choose a reason for hiding this comment

SuZhou-Joe commented Mar 11, 2024

BionIT Mar 12, 2024

Choose a reason for hiding this comment

SuZhou-Joe commented Mar 8, 2024 •

edited

Loading

codecov bot commented Mar 8, 2024 •

edited

Loading