[Workspace] Add workspace list page #6182

raintygao · 2024-03-18T10:08:30Z

Description

In this PR, a new page will be added to workspace module. This page shows all workspaces in a table, user can view the name, id, description and features of each workspace. And users could search workspace through inputing name.

Issues Resolved

#6132

Screenshot

Testing the changes

Clone the latest code and run yarn osd bootstrap
Modify config/opensearch_dashboards.yml add workspace.enabled: true
Run yarn start --no-base-path
Visit workspace list page

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-18T10:22:05Z

Codecov Report

Attention: Patch coverage is 81.25000% with 15 lines in your changes missing coverage. Please review.

Project coverage is 67.44%. Comparing base (74e0df3) to head (d53b2a1).
Report is 564 commits behind head on main.

Files with missing lines	Patch %	Lines
...rkspace/public/components/workspace_list/index.tsx	75.00%	6 Missing and 5 partials ⚠️
.../delete_workspace_modal/delete_workspace_modal.tsx	89.47%	0 Missing and 2 partials ⚠️
src/plugins/workspace/public/plugin.ts	33.33%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6182      +/-   ##
==========================================
+ Coverage   67.42%   67.44%   +0.01%     
==========================================
  Files        3362     3366       +4     
  Lines       65258    65338      +80     
  Branches    10524    10541      +17     
==========================================
+ Hits        43999    44066      +67     
- Misses      18701    18708       +7     
- Partials     2558     2564       +6

Flag	Coverage Δ
Linux_1	`32.14% <78.75%> (+0.08%)`	⬆️
Linux_2	`55.58% <100.00%> (+0.01%)`	⬆️
Linux_3	`44.82% <16.66%> (-0.02%)`	⬇️
Linux_4	`35.03% <16.66%> (-0.01%)`	⬇️
Windows_1	`32.16% <78.75%> (+0.08%)`	⬆️
Windows_2	`55.54% <100.00%> (+0.01%)`	⬆️
Windows_3	`44.84% <16.66%> (+<0.01%)`	⬆️
Windows_4	`35.03% <16.66%> (-0.01%)`	⬇️

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.

ZilongX · 2024-03-20T18:16:45Z

src/plugins/workspace/public/components/delete_workspace_modal/delete_workspace_modal.tsx

typo ? model instead of modal ?

I think modal may be more appropriate because this is a modal UI component and references the modal component of OUI . What's your opinion?

ZilongX · 2024-03-20T21:57:27Z

generally looking good, need to resolve the conflicts in the CHANGELOG though

ZilongX · 2024-03-20T21:57:40Z

re-running failed checks

SuZhou-Joe · 2024-03-22T02:27:49Z

src/plugins/workspace/public/components/utils/workspace.ts

+  }
+};
+
+export const updateWorkspace = ({ application, http }: Core, id: string) => {


Nit: The function name here is a little bit confusing.

Do you have any recommendations?

Suggested change

export const updateWorkspace = ({ application, http }: Core, id: string) => {

export const navigateToWorkspaceUpdatePage = ({ application, http }: Core, id: string) => {

SuZhou-Joe · 2024-03-22T02:35:20Z

src/plugins/workspace/public/components/delete_workspace_modal/delete_workspace_modal.tsx

+        if (http && application && returnToHome) {
+          const homeUrl = application.getUrlForApp('home', {
+            path: '/',
+            absolute: false,
+          });
+          const targetUrl = http.basePath.prepend(http.basePath.remove(homeUrl), {
+            withoutWorkspace: true,
+          });
+          await application.navigateToUrl(targetUrl);
+        }


DeleteWorkspaceModal should only care about if we delete the workspace successfully and gives a toast, it should be the component who embed the Modal to decide if jump to other page?

Because both workspace update page and list page use this component and their delete logic is same, so I put this part of the logic in deleteModal for code reuse. There is a param called returnToHome to decide whether navigate.

Im not sure if we could put delete logic in deleteModal to let it handle directly.

For update page, it will jump to the homepage when delete successfully.

For list page, it need to refresh the list page when delete successfully.

The DeleteWorkspaceModal should expose a function props named onDeleteSuccess so that parent component can decide what to do next. Pass returnToHome is coupling the DeleteModal and the handle logic of the parent component.

seraphjiang · 2024-03-23T23:42:08Z

One question: How could a user find this page? From which menu could they navigate to this page?

raintygao · 2024-03-25T03:27:10Z

One question: How could a user find this page? From which menu could they navigate to this page?

There is an entry named All workspaces in workspace dropdown menu #6150 , user could navigate to this page from this entry.

seraphjiang · 2024-03-25T03:31:51Z

There is an entry named All workspaces in workspace dropdown menu #6150 , user could navigate to this page from this entry.

Got it, Thanks @raintygao for clarification

SuZhou-Joe

LGTM

Signed-off-by: tygao <tygao@amazon.com>

* feat: add workspace list Signed-off-by: tygao <tygao@amazon.com> * doc: update changelog Signed-off-by: tygao <tygao@amazon.com> * fix test for delete workspace modal (#299) Signed-off-by: tygao <tygao@amazon.com> * update function name and modal Signed-off-by: tygao <tygao@amazon.com> --------- Signed-off-by: tygao <tygao@amazon.com> (cherry picked from commit 2a94f32) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

* feat: add workspace list Signed-off-by: tygao <tygao@amazon.com> * doc: update changelog Signed-off-by: tygao <tygao@amazon.com> * fix test for delete workspace modal (#299) Signed-off-by: tygao <tygao@amazon.com> * update function name and modal Signed-off-by: tygao <tygao@amazon.com> --------- Signed-off-by: tygao <tygao@amazon.com> (cherry picked from commit 2a94f32) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

github-actions bot added the repeat-contributor label Mar 18, 2024

raintygao marked this pull request as ready for review March 18, 2024 10:10

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

ZilongX reviewed Mar 20, 2024

View reviewed changes

ruanyl added the workspace label Mar 21, 2024

raintygao force-pushed the workspace-list-pr branch from e9beed8 to 63856e7 Compare March 21, 2024 03:32

raintygao requested a review from xinruiba as a code owner March 21, 2024 03:32

raintygao force-pushed the workspace-list-pr branch from 63856e7 to 6e68a53 Compare March 21, 2024 06:08

ZilongX self-requested a review March 21, 2024 16:21

ZilongX previously approved these changes Mar 21, 2024

View reviewed changes

SuZhou-Joe reviewed Mar 22, 2024

View reviewed changes

raintygao dismissed ZilongX’s stale review via ada9f5b March 22, 2024 11:31

raintygao force-pushed the workspace-list-pr branch from ada9f5b to eabb00d Compare March 25, 2024 03:29

SuZhou-Joe previously approved these changes Mar 25, 2024

View reviewed changes

raintygao requested a review from ZilongX March 25, 2024 07:48

raintygao added 4 commits March 26, 2024 14:08

feat: add workspace list

72c6a5a

Signed-off-by: tygao <tygao@amazon.com>

doc: update changelog

a5ef8d6

Signed-off-by: tygao <tygao@amazon.com>

fix test for delete workspace modal (opensearch-project#299)

7a735eb

Signed-off-by: tygao <tygao@amazon.com>

update function name and modal

d53b2a1

Signed-off-by: tygao <tygao@amazon.com>

raintygao dismissed SuZhou-Joe’s stale review via d53b2a1 March 26, 2024 06:12

raintygao force-pushed the workspace-list-pr branch from eabb00d to d53b2a1 Compare March 26, 2024 06:12

SuZhou-Joe approved these changes Mar 26, 2024

View reviewed changes

ZilongX approved these changes Mar 26, 2024

View reviewed changes

ZilongX merged commit 2a94f32 into opensearch-project:main Mar 26, 2024
68 checks passed

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

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

[Backport 2.x] [Workspace] Add workspace list page #6525

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 workspace list page #6182

[Workspace] Add workspace list page #6182

raintygao commented Mar 18, 2024 •

edited

Loading

codecov bot commented Mar 18, 2024 •

edited

Loading

ZilongX Mar 20, 2024

raintygao Mar 21, 2024

ZilongX Mar 21, 2024

ZilongX commented Mar 20, 2024

ZilongX commented Mar 20, 2024

SuZhou-Joe Mar 22, 2024

raintygao Mar 22, 2024

SuZhou-Joe Mar 22, 2024 •

edited

Loading

SuZhou-Joe Mar 22, 2024 •

edited

Loading

raintygao Mar 22, 2024 •

edited

Loading

raintygao Mar 22, 2024

SuZhou-Joe Mar 22, 2024

seraphjiang commented Mar 23, 2024

raintygao commented Mar 25, 2024

seraphjiang commented Mar 25, 2024

SuZhou-Joe left a comment

	export const updateWorkspace = ({ application, http }: Core, id: string) => {
	export const navigateToWorkspaceUpdatePage = ({ application, http }: Core, id: string) => {

[Workspace] Add workspace list page #6182

[Workspace] Add workspace list page #6182

Conversation

raintygao commented Mar 18, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Check List

codecov bot commented Mar 18, 2024 • edited Loading

Codecov Report

ZilongX Mar 20, 2024

Choose a reason for hiding this comment

raintygao Mar 21, 2024

Choose a reason for hiding this comment

ZilongX Mar 21, 2024

Choose a reason for hiding this comment

ZilongX commented Mar 20, 2024

ZilongX commented Mar 20, 2024

SuZhou-Joe Mar 22, 2024

Choose a reason for hiding this comment

raintygao Mar 22, 2024

Choose a reason for hiding this comment

SuZhou-Joe Mar 22, 2024 • edited Loading

Choose a reason for hiding this comment

SuZhou-Joe Mar 22, 2024 • edited Loading

Choose a reason for hiding this comment

raintygao Mar 22, 2024 • edited Loading

Choose a reason for hiding this comment

raintygao Mar 22, 2024

Choose a reason for hiding this comment

SuZhou-Joe Mar 22, 2024

Choose a reason for hiding this comment

seraphjiang commented Mar 23, 2024

raintygao commented Mar 25, 2024

seraphjiang commented Mar 25, 2024

SuZhou-Joe left a comment

Choose a reason for hiding this comment

raintygao commented Mar 18, 2024 •

edited

Loading

codecov bot commented Mar 18, 2024 •

edited

Loading

SuZhou-Joe Mar 22, 2024 •

edited

Loading

SuZhou-Joe Mar 22, 2024 •

edited

Loading

raintygao Mar 22, 2024 •

edited

Loading