[Workspace] Filter left nav menu items according to the current workspace #6234

ruanyl · 2024-03-21T03:01:59Z

Description

In this PR, left nav bar will be filtered by the feature configuration of current workspace.

Issues Resolved

#6153

Screenshot

left.menu.filter.by.workspace.mov

Accessing app which is NOT configured by the workspace will display "Application Not Found" page

Testing the changes

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-21T03:27:12Z

Codecov Report

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

Project coverage is 32.65%. Comparing base (a0eaf84) to head (7f7cefe).
Report is 1 commits behind head on main.

❗ Current head 7f7cefe differs from pull request most recent head ae9f515. Consider uploading reports for the commit ae9f515 to get more accurate results

Files	Patch %	Lines
src/plugins/workspace/public/plugin.ts	53.84%	5 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #6234       +/-   ##
===========================================
- Coverage   67.56%   32.65%   -34.92%     
===========================================
  Files        3379     2249     -1130     
  Lines       65894    45512    -20382     
  Branches    10660     7133     -3527     
===========================================
- Hits        44522    14860    -29662     
- Misses      18774    29956    +11182     
+ Partials     2598      696     -1902

Flag	Coverage Δ
Linux_1	`32.65% <73.91%> (+0.01%)`	⬆️
Linux_2	`?`
Linux_3	`?`
Linux_4	`?`
Windows_1	`?`
Windows_2	`?`
Windows_3	`?`
Windows_4	`?`

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.

Hailong-am · 2024-03-22T07:10:12Z

src/core/public/chrome/nav_links/nav_links_service.ts

+   * nav links, for example, filter the nav links or update a specific nav link's properties.
+   * {@link LinksUpdater}
+   */
+  getLinkUpdaters$(): BehaviorSubject<LinksUpdater[]>;


should we update the doc https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/core/public/chrome/README.md
and https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/core/public/public.api.md as well?

good point, I will update README.md, public.api.md is automatically generated.

SuZhou-Joe · 2024-03-21T08:04:59Z

src/plugins/workspace/public/utils.ts

+}) => {
+  let matched = false;
+
+  for (const featureConfig of featureConfigs) {


Nit: can we do a quick break once matched or not matched? Or what's the expect behavior if the featureConfigs is ['@management', '!security']

Found the answer in other PR. But as the question is asked by many reviewer, maybe adding some comments could help to reduce such question.

Sure, updated.

seraphjiang · 2024-03-23T23:37:29Z

@xluo-aws @ruanyl @BionIT @Flyingliuhub @bandinib-amzn @kgcreative @xeniatup @zengyan-amazon

Looks like we are going to have to global contexts: Workspace at left nav, DataSource at top navi if both are enabled

have we discussed or made the decision between Workspace and DataSource?

I assume DataSource always belongs to Workspace. if we all agree about it, from information hierarchy's perspective, should workspace selector being put on top nav bar. Once cx select workspace, then they could select datasource?

I feel we need to build both experience into future playground to get board feedback asap.

what do you think?

ruanyl · 2024-03-25T02:42:39Z

@seraphjiang

have we discussed or made the decision between Workspace and DataSource?
I feel we need to build both experience into future playground to get board feedback asap.

Agree on that, and yes, the current behavior of setting workspace and data source are more like setting two global contexts. However, base on my understanding so far, they may have correlations. For example, data source available in one workspace may not be available in another workspace.

I think we need to take this into consideration from UX design's perspective as early as possible. @kgcreative @lauralexis @xeniatup

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

Hailong-am · 2024-04-09T03:08:03Z

I have concern about mark those links as inaccessible for now, before we move index pattern/ saved objects page out, user have no ways to import data and create index pattern. That means user can't start create visualization and dashboards in a fresh workspace

ruanyl · 2024-04-09T05:04:02Z

I have concern about mark those links as inaccessible for now, before we move index pattern/ saved objects page out, user have no ways to import data and create index pattern. That means user can't start create visualization and dashboards in a fresh workspace

You'r right, maybe we should wait for index pattern to be moved out before merging this PR. For saved objects page, you mean saved object management page? Do we have upcoming PR/task about that?

ruanyl · 2024-04-09T05:09:24Z

@xluo-aws In this PR, it will forbid user to access the applications which are not configured in a workspace, even if user access directly via url. I believe this is the desired behavior, but this is different from what we implemented earlier which we just hide the nav links from ui in left nav menu. Do you have any concern with this?

SuZhou-Joe · 2024-04-09T05:38:22Z

Perhaps we can hide it from nav in this PR(which only sets the navLinkStatus to hidden), and adjust the logic to make them inaccessible in the PR that moves index pattern out of data management.

For saved objects management page, I do not think that will be in 2.14.

ruanyl · 2024-04-09T05:45:45Z

Perhaps we can hide it from nav in this PR(which only sets the navLinkStatus to hidden), and adjust the logic to make these inaccessible in the PR that moves index pattern out of data management.

I think that's too much back and forth, the change in this PR represent an atomic feature, and the index pattern moving should be a standalone PR as well. I think we can wait for the other PR to be merged if that's really a concern :)

xluo-aws · 2024-04-09T12:06:48Z

@xluo-aws In this PR, it will forbid user to access the applications which are not configured in a workspace, even if user access directly via url. I believe this is the desired behavior, but this is different from what we implemented earlier which we just hide the nav links from ui in left nav menu. Do you have any concern with this?

No concern, it's the right behavior.

ruanyl · 2024-04-10T02:42:14Z

I have concern about mark those links as inaccessible for now, before we move index pattern/ saved objects page out, user have no ways to import data and create index pattern. That means user can't start create visualization and dashboards in a fresh workspace

Since Index pattern will remain in "Dashboards Management" and "Dashboards Management" is available in workspace, so this is no longer a concern, is that correct?

…pace (opensearch-project#6234) * Filter left nav menu items according to the current workspace An "Application Not Found" page will be displayed if accessing app which is not configured by the workspace --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com> Signed-off-by: SuZhou-Joe <suzhou@amazon.com> Co-authored-by: SuZhou-Joe <suzhou@amazon.com>

…pace (opensearch-project#6234) (#323) * Filter left nav menu items according to the current workspace An "Application Not Found" page will be displayed if accessing app which is not configured by the workspace --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com> Signed-off-by: SuZhou-Joe <suzhou@amazon.com> Co-authored-by: Yulong Ruan <ruanyl@amazon.com>

This is caused by opensearch-project#6234 which marked apps as inaccessible when the apps are not configured into the current workspace. However, inaccessible apps can not be configured into a workspace. Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

…6234 (#331) * remove unnecessary changes due to the refactor in 6234 Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * fix snapshot Signed-off-by: Yulong Ruan <ruanyl@amazon.com> --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

* fix(workspace): apps are missing when updating a workspace This is caused by #6234 which marked apps as inaccessible when the apps are not configured into the current workspace. However, inaccessible apps can not be configured into a workspace. Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * refactor(workspace): store workspace configurable apps in a global variable Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * fix linter Signed-off-by: Yulong Ruan <ruanyl@amazon.com> --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com> Co-authored-by: ZilongX <99905560+ZilongX@users.noreply.github.com>

This is caused by opensearch-project#6234 which marked apps as inaccessible when the apps are not configured into the current workspace. However, inaccessible apps can not be configured into a workspace. Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

* fix(workspace): apps are missing when updating a workspace This is caused by opensearch-project#6234 which marked apps as inaccessible when the apps are not configured into the current workspace. However, inaccessible apps can not be configured into a workspace. Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * refactor workspace list page to use workspaceConfigurableApps Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * fix tests Signed-off-by: Yulong Ruan <ruanyl@amazon.com> --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

…6234 (opensearch-project#331) * remove unnecessary changes due to the refactor in 6234 Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * fix snapshot Signed-off-by: Yulong Ruan <ruanyl@amazon.com> --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

…pace (#6234) * Filter left nav menu items according to the current workspace An "Application Not Found" page will be displayed if accessing app which is not configured by the workspace --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com> Signed-off-by: SuZhou-Joe <suzhou@amazon.com> Co-authored-by: SuZhou-Joe <suzhou@amazon.com> (cherry picked from commit cb9b26c) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

…pace (#6234) (#6552) * Filter left nav menu items according to the current workspace An "Application Not Found" page will be displayed if accessing app which is not configured by the workspace --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com> Signed-off-by: SuZhou-Joe <suzhou@amazon.com> Co-authored-by: SuZhou-Joe <suzhou@amazon.com> (cherry picked from commit cb9b26c) 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>

* fix(workspace): apps are missing when updating a workspace This is caused by #6234 which marked apps as inaccessible when the apps are not configured into the current workspace. However, inaccessible apps can not be configured into a workspace. Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * refactor(workspace): store workspace configurable apps in a global variable Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * fix linter Signed-off-by: Yulong Ruan <ruanyl@amazon.com> --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com> Co-authored-by: ZilongX <99905560+ZilongX@users.noreply.github.com> (cherry picked from commit 4746f43) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…6606) * fix(workspace): apps are missing when updating a workspace This is caused by #6234 which marked apps as inaccessible when the apps are not configured into the current workspace. However, inaccessible apps can not be configured into a workspace. * refactor(workspace): store workspace configurable apps in a global variable * fix linter --------- (cherry picked from commit 4746f43) Signed-off-by: Yulong Ruan <ruanyl@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: ZilongX <99905560+ZilongX@users.noreply.github.com>

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

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

ruanyl added the workspace label Mar 21, 2024

ruanyl changed the title ~~Filter left nav menu items according to the current workspace~~ [Workspace] Filter left nav menu items according to the current workspace Mar 21, 2024

ruanyl force-pushed the filter-left-menu-based-on-current-workspace branch 2 times, most recently from 4f70782 to 8629acb Compare March 22, 2024 06:27

Hailong-am reviewed Mar 22, 2024

View reviewed changes

SuZhou-Joe previously approved these changes Mar 22, 2024

View reviewed changes

ruanyl dismissed SuZhou-Joe’s stale review via 023f054 March 22, 2024 09:06

ruanyl added 2 commits March 26, 2024 11:21

Filter left nav menu items according to the current workspace

d46cc94

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

fix type error

e917028

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

SuZhou-Joe approved these changes Apr 9, 2024

View reviewed changes

Merge branch 'main' into filter-left-menu-based-on-current-workspace

ae9f515

Flyingliuhub approved these changes Apr 9, 2024

View reviewed changes

Hailong-am approved these changes Apr 10, 2024

View reviewed changes

ruanyl merged commit cb9b26c into opensearch-project:main Apr 10, 2024
66 checks passed

ruanyl mentioned this pull request Apr 15, 2024

[Workspace] fix apps are missing when updating a workspace #6459

Merged

7 tasks

ruanyl mentioned this pull request Apr 17, 2024

[Workspace] Filter left nav menu according to the current workspace #6153

Closed

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

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

[Backport 2.x] [Workspace] Filter left nav menu items according to the current workspace #6552

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workspace] Filter left nav menu items according to the current workspace #6234

[Workspace] Filter left nav menu items according to the current workspace #6234

ruanyl commented Mar 21, 2024 •

edited

codecov bot commented Mar 21, 2024 •

edited

Hailong-am Mar 22, 2024

ruanyl Mar 22, 2024

SuZhou-Joe Mar 21, 2024

SuZhou-Joe Mar 22, 2024

ruanyl Mar 22, 2024

seraphjiang commented Mar 23, 2024

ruanyl commented Mar 25, 2024

Hailong-am commented Apr 9, 2024

ruanyl commented Apr 9, 2024

ruanyl commented Apr 9, 2024

SuZhou-Joe commented Apr 9, 2024 •

edited

ruanyl commented Apr 9, 2024

xluo-aws commented Apr 9, 2024

ruanyl commented Apr 10, 2024

[Workspace] Filter left nav menu items according to the current workspace #6234

[Workspace] Filter left nav menu items according to the current workspace #6234

Conversation

ruanyl commented Mar 21, 2024 • edited

Description

Issues Resolved

Screenshot

Testing the changes

Check List

codecov bot commented Mar 21, 2024 • edited

Codecov Report

Hailong-am Mar 22, 2024

Choose a reason for hiding this comment

ruanyl Mar 22, 2024

Choose a reason for hiding this comment

SuZhou-Joe Mar 21, 2024

Choose a reason for hiding this comment

SuZhou-Joe Mar 22, 2024

Choose a reason for hiding this comment

ruanyl Mar 22, 2024

Choose a reason for hiding this comment

seraphjiang commented Mar 23, 2024

ruanyl commented Mar 25, 2024

Hailong-am commented Apr 9, 2024

ruanyl commented Apr 9, 2024

ruanyl commented Apr 9, 2024

SuZhou-Joe commented Apr 9, 2024 • edited

ruanyl commented Apr 9, 2024

xluo-aws commented Apr 9, 2024

ruanyl commented Apr 10, 2024

ruanyl commented Mar 21, 2024 •

edited

codecov bot commented Mar 21, 2024 •

edited

SuZhou-Joe commented Apr 9, 2024 •

edited