[Workspace] Add workspace overview page #6584

Hailong-am · 2024-04-22T08:50:34Z

Description

This PR will implement a simple version of workspace overview page, it includes

start working section and getting start modal
overview tab - show workspace description
library tab - it will redirect to saved objects management page
settings tab - that will embed workspace update page
add workspace overview into breadcrumb for all pages if in a workspace

Issues Resolved

closes #6583

Screenshot

workspace_overview.mov

Testing the changes

Changelog

feat: [Workspace] Add workspace overview 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

Signed-off-by: Hailong Cui <ihailong@amazon.com> address review comments Signed-off-by: Hailong Cui <ihailong@amazon.com> address ux review comments Signed-off-by: Hailong Cui <ihailong@amazon.com> Add workspace overview to breadCrumb Signed-off-by: Hailong Cui <ihailong@amazon.com> getting start modal & settings tab Signed-off-by: Hailong Cui <ihailong@amazon.com> home breadcrumb Signed-off-by: Hailong Cui <ihailong@amazon.com> fix rebase issue Signed-off-by: Hailong Cui <ihailong@amazon.com> tmp enable management Signed-off-by: Hailong Cui <ihailong@amazon.com> add workspace overview collapsed into localStorage Signed-off-by: Hailong Cui <ihailong@amazon.com> getting start modal Signed-off-by: Hailong Cui <ihailong@amazon.com> page layout Signed-off-by: Hailong Cui <ihailong@amazon.com> Add test cases Signed-off-by: Hailong Cui <ihailong@amazon.com> fix breadcrumb Signed-off-by: Hailong Cui <ihailong@amazon.com>

Signed-off-by: Hailong Cui <ihailong@amazon.com>

github-actions · 2024-04-22T08:51:39Z

❌ Empty Changelog Section

The Changelog section in your PR description is empty. Please add a valid changelog entry or entries. If you did add a changelog entry, check to make sure that it was not accidentally included inside the comment block in the Changelog section.

github-actions · 2024-04-22T08:52:54Z

❌ Empty Changelog Section

The Changelog section in your PR description is empty. Please add a valid changelog entry or entries. If you did add a changelog entry, check to make sure that it was not accidentally included inside the comment block in the Changelog section.

Signed-off-by: Hailong Cui <ihailong@amazon.com>

src/plugins/workspace/public/plugin.ts

ruanyl · 2024-04-23T03:21:25Z

src/plugins/workspace/public/plugin.ts

+              core.application.navigateToApp('home');
+            },
+          };
+          breadCrumbs.splice(0, 0, homeCrumb, workspaceCrumb);


Should you use slice instead of splice? splice will change the array in place, I guess that's why subscribe to breadcrumb$ not refreshing the breadcrumb, because it returns the same array instance.

Changed to Promise.resolve().then(() => core.chrome.setBreadcrumbs(breadCrumbs)); as workaround

Just curious why using promise could solve the issue? :D

Just curious why using promise could solve the issue? :D

Yeah, I am looking into it, it does not make sense to me.

might be local build cache issue, after clean all build caches and start with a refresh package, it works well.

Signed-off-by: Hailong Cui <ihailong@amazon.com>

src/plugins/workspace/public/components/workspace_overview/index.scss

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

Signed-off-by: Hailong Cui <ihailong@amazon.com>

src/plugins/workspace/public/plugin.ts

Signed-off-by: Hailong Cui <ihailong@amazon.com>

…page

src/plugins/workspace/public/plugin.ts

Signed-off-by: Hailong Cui <ihailong@amazon.com>

Hailong-am · 2024-04-24T08:20:05Z

Failed CIs are try to get chromedriver version 124 while it doesn't have this version in npm repository yet. https://www.npmjs.com/package/chromedriver

* workspace overview page Signed-off-by: Hailong Cui <ihailong@amazon.com> address review comments Signed-off-by: Hailong Cui <ihailong@amazon.com> address ux review comments Signed-off-by: Hailong Cui <ihailong@amazon.com> Add workspace overview to breadCrumb Signed-off-by: Hailong Cui <ihailong@amazon.com> getting start modal & settings tab Signed-off-by: Hailong Cui <ihailong@amazon.com> home breadcrumb Signed-off-by: Hailong Cui <ihailong@amazon.com> fix rebase issue Signed-off-by: Hailong Cui <ihailong@amazon.com> tmp enable management Signed-off-by: Hailong Cui <ihailong@amazon.com> add workspace overview collapsed into localStorage Signed-off-by: Hailong Cui <ihailong@amazon.com> getting start modal Signed-off-by: Hailong Cui <ihailong@amazon.com> page layout Signed-off-by: Hailong Cui <ihailong@amazon.com> Add test cases Signed-off-by: Hailong Cui <ihailong@amazon.com> fix breadcrumb Signed-off-by: Hailong Cui <ihailong@amazon.com> * fix merge issue Signed-off-by: Hailong Cui <ihailong@amazon.com> * fix wrong dataSourceManagement id Signed-off-by: Hailong Cui <ihailong@amazon.com> * Changeset file for PR #6584 created/updated * update page layout Signed-off-by: Hailong Cui <ihailong@amazon.com> * overview tab layout update Signed-off-by: Hailong Cui <ihailong@amazon.com> * fix workspace overview page breadcrumb Signed-off-by: Hailong Cui <ihailong@amazon.com> * collapsed setting to be workspace level Signed-off-by: Hailong Cui <ihailong@amazon.com> * fix workspace_overview_modal unit test Signed-off-by: Hailong Cui <ihailong@amazon.com> * Update src/plugins/workspace/public/components/workspace_overview/getting_start_card.tsx Co-authored-by: SuZhou-Joe <suzhou@amazon.com> Signed-off-by: Hailong Cui <ihailong@amazon.com> * Update src/plugins/workspace/public/components/workspace_overview/workspace_overview_settings.tsx Co-authored-by: SuZhou-Joe <suzhou@amazon.com> Signed-off-by: Hailong Cui <ihailong@amazon.com> * Update src/plugins/workspace/public/components/workspace_overview/getting_start_modal.tsx Co-authored-by: SuZhou-Joe <suzhou@amazon.com> Signed-off-by: Hailong Cui <ihailong@amazon.com> * Update src/plugins/workspace/public/components/workspace_overview/getting_start_modal.tsx Co-authored-by: SuZhou-Joe <suzhou@amazon.com> Signed-off-by: Hailong Cui <ihailong@amazon.com> * Update src/plugins/workspace/public/components/workspace_overview/getting_start_modal.tsx Co-authored-by: SuZhou-Joe <suzhou@amazon.com> Signed-off-by: Hailong Cui <ihailong@amazon.com> * Update src/plugins/workspace/public/components/workspace_overview/getting_start_modal.tsx Co-authored-by: SuZhou-Joe <suzhou@amazon.com> Signed-off-by: Hailong Cui <ihailong@amazon.com> * address review comments Signed-off-by: Hailong Cui <ihailong@amazon.com> * address review comments Signed-off-by: Hailong Cui <ihailong@amazon.com> * fix setBreadcrumbs issue Signed-off-by: Hailong Cui <ihailong@amazon.com> * wording change of breadcrumbs Signed-off-by: Hailong Cui <ihailong@amazon.com> * udpate breadcrumb subscription to be a better name Signed-off-by: Hailong Cui <ihailong@amazon.com> * Add unit test Signed-off-by: Hailong Cui <ihailong@amazon.com> --------- Signed-off-by: Hailong Cui <ihailong@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Co-authored-by: SuZhou-Joe <suzhou@amazon.com> (cherry picked from commit 9c884b0) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* workspace overview page address review comments address ux review comments Add workspace overview to breadCrumb getting start modal & settings tab home breadcrumb fix rebase issue tmp enable management add workspace overview collapsed into localStorage getting start modal page layout Add test cases fix breadcrumb * fix merge issue * fix wrong dataSourceManagement id * Changeset file for PR #6584 created/updated * update page layout * overview tab layout update * fix workspace overview page breadcrumb * collapsed setting to be workspace level * fix workspace_overview_modal unit test * Update src/plugins/workspace/public/components/workspace_overview/getting_start_card.tsx * Update src/plugins/workspace/public/components/workspace_overview/workspace_overview_settings.tsx * Update src/plugins/workspace/public/components/workspace_overview/getting_start_modal.tsx * Update src/plugins/workspace/public/components/workspace_overview/getting_start_modal.tsx * Update src/plugins/workspace/public/components/workspace_overview/getting_start_modal.tsx * Update src/plugins/workspace/public/components/workspace_overview/getting_start_modal.tsx * address review comments * address review comments * fix setBreadcrumbs issue * wording change of breadcrumbs * udpate breadcrumb subscription to be a better name * Add unit test --------- (cherry picked from commit 9c884b0) Signed-off-by: Hailong Cui <ihailong@amazon.com> 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: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Co-authored-by: SuZhou-Joe <suzhou@amazon.com>

Hailong-am added 3 commits April 22, 2024 16:03

fix merge issue

481d993

Signed-off-by: Hailong Cui <ihailong@amazon.com>

fix wrong dataSourceManagement id

265fba2

Signed-off-by: Hailong Cui <ihailong@amazon.com>

Hailong-am requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, curq, bandinib-amzn, SuZhou-Joe, ruanyl, BionIT and xinruiba as code owners April 22, 2024 08:50

github-actions bot added the valued-contributor label Apr 22, 2024

Hailong-am changed the title ~~Workspace overview page~~ [WIP] [Workspace]Workspace overview page Apr 22, 2024

Hailong-am marked this pull request as draft April 22, 2024 08:51

github-actions bot added the failed changeset label Apr 22, 2024

Changeset file for PR opensearch-project#6584 created/updated

a4d8522

github-actions bot removed the failed changeset label Apr 22, 2024

Hailong-am added 2 commits April 22, 2024 17:57

update page layout

3349f6b

Signed-off-by: Hailong Cui <ihailong@amazon.com>

overview tab layout update

e50d43a

Signed-off-by: Hailong Cui <ihailong@amazon.com>

SuZhou-Joe reviewed Apr 23, 2024

View reviewed changes

src/plugins/workspace/public/plugin.ts Outdated Show resolved Hide resolved

ruanyl reviewed Apr 23, 2024

View reviewed changes

Hailong-am added 2 commits April 23, 2024 13:17

address review comments

97bb151

Signed-off-by: Hailong Cui <ihailong@amazon.com>

address review comments

789133a

Signed-off-by: Hailong Cui <ihailong@amazon.com>

ruanyl reviewed Apr 23, 2024

View reviewed changes

src/plugins/workspace/public/components/workspace_overview/index.scss Outdated Show resolved Hide resolved

ruanyl reviewed Apr 23, 2024

View reviewed changes

src/plugins/workspace/public/components/workspace_overview_app.tsx Outdated Show resolved Hide resolved

fix setBreadcrumbs issue

1d96b77

Signed-off-by: Hailong Cui <ihailong@amazon.com>

ruanyl added the workspace label Apr 23, 2024

ruanyl reviewed Apr 23, 2024

View reviewed changes

src/plugins/workspace/public/plugin.ts Outdated Show resolved Hide resolved

Hailong-am added 2 commits April 23, 2024 16:17

wording change of breadcrumbs

5054d43

Signed-off-by: Hailong Cui <ihailong@amazon.com>

Merge remote-tracking branch 'upstream/main' into workspace_overview_…

a758c8d

…page

ruanyl reviewed Apr 23, 2024

View reviewed changes

src/plugins/workspace/public/plugin.ts Outdated Show resolved Hide resolved

src/plugins/workspace/public/plugin.ts Outdated Show resolved Hide resolved

Hailong-am added 5 commits April 23, 2024 16:56

udpate breadcrumb subscription to be a better name

d303b1d

Signed-off-by: Hailong Cui <ihailong@amazon.com>

Add unit test

f6d3df1

Signed-off-by: Hailong Cui <ihailong@amazon.com>

Merge branch 'main' into workspace_overview_page

fa42855

Merge branch 'main' into workspace_overview_page

c554fc0

Signed-off-by: Hailong Cui <ihailong@amazon.com>

Merge branch 'main' into workspace_overview_page

a23e168

Hailong-am changed the title ~~[Workspace]Workspace overview page~~ [Workspace] Add workspace overview page Apr 24, 2024

Merge branch 'main' into workspace_overview_page

2e46fef

Merge branch 'main' into workspace_overview_page

f9911f3

ruanyl approved these changes Apr 25, 2024

View reviewed changes

Merge branch 'main' into workspace_overview_page

ae8cb6a

SuZhou-Joe approved these changes Apr 25, 2024

View reviewed changes

SuZhou-Joe added the v2.14.0 label Apr 25, 2024

SuZhou-Joe merged commit 9c884b0 into opensearch-project:main Apr 25, 2024
70 checks passed

SuZhou-Joe added the backport 2.x label Apr 25, 2024

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

[Backport 2.x] [Workspace] Add workspace overview page #6641

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workspace] Add workspace overview page #6584

[Workspace] Add workspace overview page #6584

Hailong-am commented Apr 22, 2024 •

edited by SuZhou-Joe

github-actions bot commented Apr 22, 2024

github-actions bot commented Apr 22, 2024

ruanyl Apr 23, 2024 •

edited

Hailong-am Apr 23, 2024

ruanyl Apr 23, 2024

SuZhou-Joe Apr 23, 2024

Hailong-am Apr 24, 2024

Hailong-am commented Apr 24, 2024

[Workspace] Add workspace overview page #6584

[Workspace] Add workspace overview page #6584

Conversation

Hailong-am commented Apr 22, 2024 • edited by SuZhou-Joe

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

github-actions bot commented Apr 22, 2024

❌ Empty Changelog Section

github-actions bot commented Apr 22, 2024

❌ Empty Changelog Section

ruanyl Apr 23, 2024 • edited

Choose a reason for hiding this comment

Hailong-am Apr 23, 2024

Choose a reason for hiding this comment

ruanyl Apr 23, 2024

Choose a reason for hiding this comment

SuZhou-Joe Apr 23, 2024

Choose a reason for hiding this comment

Hailong-am Apr 24, 2024

Choose a reason for hiding this comment

Hailong-am commented Apr 24, 2024

Hailong-am commented Apr 22, 2024 •

edited by SuZhou-Joe

ruanyl Apr 23, 2024 •

edited