[Navigation-next]Register workspace list card into home page #7247

Hailong-am · 2024-07-15T09:28:11Z

Description

Register workspace list card into home page

Empty state

Issues Resolved

#7294

Screenshot

Testing the changes

start OSD with workspace and new navigation enabled, add this to opensearch_dashboards.yml file

workspace.enabled: true
uiSettings:
  overrides:
    "home:useNewHomePage": true

start OSD and navigates to home page

Changelog

feat: Register workspace list card into home 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-07-15T09:41:53Z

Codecov Report

Attention: Patch coverage is 58.53659% with 17 lines in your changes missing coverage. Please review.

Project coverage is 67.70%. Comparing base (376ead0) to head (5eb1202).

Files	Patch %	Lines
...ic/components/service_card/workspace_list_card.tsx	62.85%	9 Missing and 4 partials ⚠️
src/plugins/workspace/public/plugin.ts	33.33%	3 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7247      +/-   ##
==========================================
- Coverage   67.72%   67.70%   -0.02%     
==========================================
  Files        3518     3519       +1     
  Lines       69638    69679      +41     
  Branches    11365    11373       +8     
==========================================
+ Hits        47165    47179      +14     
- Misses      19684    19706      +22     
- Partials     2789     2794       +5

Flag	Coverage Δ
Linux_1	`33.18% <58.53%> (+0.02%)`	⬆️
Linux_2	`55.46% <ø> (ø)`
Linux_3	`43.31% <ø> (ø)`
Linux_4	`34.69% <ø> (ø)`
Windows_1	`33.20% <58.53%> (-0.01%)`	⬇️
Windows_2	`55.41% <ø> (ø)`
Windows_3	`43.33% <ø> (ø)`
Windows_4	`34.69% <ø> (+<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.

ruanyl · 2024-07-20T05:38:34Z

Looks like unnecessary commits are included, maybe you can do a cherry pick instead

Signed-off-by: Hailong Cui <[email protected]>

src/plugins/workspace/public/components/service_card/workspace_list_card.tsx

ruanyl · 2024-07-21T03:33:28Z

src/plugins/workspace/public/components/service_card/workspace_list_card.tsx

+  private loadWorkspaceListItems() {
+    if (this.state.filter === 'viewed') {
+      this.setState({
+        workspaceList: _.orderBy(this.state.recentWorkspaces, ['timestamp'], ['desc'])


It seems workspaceList can be derived from existing state, I think we can simply compute it in the render() function.

If you use functional react component, you can use useMemo to avoid unnecessary recompute. Btw, why not use functional component? I can see it will make the implementation much simpler

Btw, why not use functional component? I can see it will make it implementation much simple

when i try to use functional component, dashboard embeddable not able to render it

Oh, that's odd, then I think you can keep the current implementation, I will investigate a bit on this, thanks ;)

thanks to @ruanyl help on debugging, seems functional component don't any issue, convert to functional component now.

Signed-off-by: Hailong Cui <[email protected]>

src/plugins/workspace/public/components/service_card/workspace_list_card.tsx

Signed-off-by: Hailong Cui <[email protected]>

SuZhou-Joe · 2024-07-21T06:10:33Z

src/plugins/workspace/public/plugin.ts

+  ) {
+    if (contentManagement) {
+      contentManagement.registerContentProvider({
+        id: HOME_PAGE_ID,


I guess the id is used for the content, not the page.

Yes, this is the content provider id, you can give it any unique string, like workspace_list_card

thanks for catching this, update to workspace_list_card_home

ruanyl · 2024-07-21T06:15:56Z

src/plugins/workspace/public/components/service_card/workspace_list_card.tsx

+      </EuiFlexGroup>
+
+      <EuiSpacer />
+      <EuiListGroup flush={true} bordered={false} style={{ minHeight: '300px' }}>


Nit: I'd suggest to have a future improvement task make this service card a flex container, so we don't need to specify a fix number 300px to stretch the list.

Signed-off-by: Hailong Cui <[email protected]>

* workspace list card on home Signed-off-by: Hailong Cui <[email protected]> * fix merge conflicts Signed-off-by: Hailong Cui <[email protected]> * add home as requiredBundles Signed-off-by: Hailong Cui <[email protected]> * Changeset file for PR #7247 created/updated * fix failed UT Signed-off-by: Hailong Cui <[email protected]> * address review comments Signed-off-by: Hailong Cui <[email protected]> * update to funtional component Signed-off-by: Hailong Cui <[email protected]> * udpate content provider id Signed-off-by: Hailong Cui <[email protected]> --------- Signed-off-by: Hailong Cui <[email protected]> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> (cherry picked from commit b32eade) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…7350) * workspace list card on home * fix merge conflicts * add home as requiredBundles * Changeset file for PR #7247 created/updated * fix failed UT * address review comments * update to funtional component * udpate content provider id --------- (cherry picked from commit b32eade) Signed-off-by: Hailong Cui <[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: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

github-actions bot added seasoned-contributor Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry labels Jul 15, 2024

Hailong-am marked this pull request as draft July 16, 2024 05:05

SuZhou-Joe force-pushed the feature/navigation-next branch from 34f3eb2 to 601317a Compare July 17, 2024 00:59

Hailong-am force-pushed the workspace_list_card branch from 570ccfa to 1b798a3 Compare July 17, 2024 03:53

SuZhou-Joe force-pushed the feature/navigation-next branch 2 times, most recently from d73444b to eaf5fea Compare July 17, 2024 07:26

Hailong-am force-pushed the workspace_list_card branch from 370c9e7 to 2ed4e83 Compare July 18, 2024 03:18

Hailong-am added 2 commits July 21, 2024 08:58

workspace list card on home

2e400e4

Signed-off-by: Hailong Cui <[email protected]>

fix merge conflicts

2897183

Signed-off-by: Hailong Cui <[email protected]>

Hailong-am force-pushed the workspace_list_card branch from 70de058 to 2897183 Compare July 21, 2024 01:18

Hailong-am and others added 2 commits July 21, 2024 09:29

add home as requiredBundles

f8f1213

Signed-off-by: Hailong Cui <[email protected]>

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

ad65e00

github-actions bot removed the Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry label Jul 21, 2024

fix failed UT

9a5846d

Signed-off-by: Hailong Cui <[email protected]>