[Workspace][Feature] Left navigation menu adjustment #192

yuye-aws · 2023-09-21T05:57:05Z

Description

The main changes of this PR are about left navigation menu:

When workspace feature is enabled, filter features by workspace.
Rank categorized and uncategorized features according to order field.
Refactor Recently visited as a feature category.
Updated corresponding tests and snapshots.

Issues Resolved

Screenshot

Testing the changes

Check List

codecov-commenter · 2023-09-21T06:18:56Z

Codecov Report

Merging #192 (66d838c) into workspace-pr-integr (120d3b7) will increase coverage by 0.43%.
The diff coverage is 96.05%.

❗ Current head 66d838c differs from pull request most recent head 1e1e12a. Consider uploading reports for the commit 1e1e12a to get more accurate results

@@                   Coverage Diff                   @@
##           workspace-pr-integr     #192      +/-   ##
=======================================================
+ Coverage                66.11%   66.55%   +0.43%     
=======================================================
  Files                     3392     3419      +27     
  Lines                    65038    65439     +401     
  Branches                 10496    10507      +11     
=======================================================
+ Hits                     43000    43553     +553     
+ Misses                   19461    19271     -190     
- Partials                  2577     2615      +38

Flag	Coverage Δ
Linux_	`?`
_1	`35.00% <44.73%> (?)`
_2	`55.57% <100.00%> (+0.03%)`	⬆️
_3	`44.46% <9.30%> (?)`
_4	`34.85% <9.30%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
src/core/public/chrome/chrome_service.mock.ts	`100.00% <ø> (ø)`
src/core/public/chrome/nav_links/nav_link.ts	`66.66% <ø> (ø)`
.../core/public/chrome/nav_links/nav_links_service.ts	`100.00% <100.00%> (ø)`
...c/core/public/chrome/ui/header/collapsible_nav.tsx	`98.03% <100.00%> (+2.58%)`	⬆️
src/core/public/chrome/ui/header/nav_link.tsx	`69.56% <100.00%> (+9.56%)`	⬆️
...c/core/public/workspace/workspaces_service.mock.ts	`100.00% <100.00%> (ø)`
src/core/public/workspace/workspaces_service.ts	`88.88% <ø> (ø)`
src/core/utils/default_app_categories.ts	`100.00% <ø> (ø)`
...ment_section/objects_table/saved_objects_table.tsx	`67.98% <ø> (ø)`
src/plugins/workspace/public/utils.ts	`100.00% <100.00%> (ø)`
... and 1 more

... and 93 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

ruanyl · 2023-09-22T02:35:51Z

@yuye-aws A lot tests failed, please take a look. And please also add PR descriptions

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

src/core/public/chrome/ui/header/collapsible_nav.tsx

src/core/public/index.ts

src/plugins/workspace/public/plugin.ts

src/plugins/workspace/public/plugin.test.ts

src/core/public/chrome/ui/header/collapsible_nav.tsx

ruanyl · 2023-10-10T08:30:42Z

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

+        );
+      },
+
+      setNavLinks: (filteredNavLinks: ReadonlyMap<string, ChromeNavLink>) => {


Suggested change

setNavLinks: (filteredNavLinks: ReadonlyMap<string, ChromeNavLink>) => {

setNavLinks: (navLinks: ReadonlyMap<string, ChromeNavLink>) => {

ruanyl · 2023-10-10T08:38:47Z

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

@@ -132,36 +145,49 @@ export class NavLinksService {
    // manual link modifications to be able to re-apply then after every
    // availableApps$ changes.
    const linkUpdaters$ = new BehaviorSubject<LinksUpdater[]>([]);
-    const navLinks$ = new BehaviorSubject<ReadonlyMap<string, NavLinkWrapper>>(new Map());
+    const allNavLinks$ = new BehaviorSubject<ReadonlyMap<string, NavLinkWrapper>>(new Map());


We can move navLinks$ here so it align with existing pattern.

const navLinks$ = new BehaviorSubject<ReadonlyMap<string, ChromeNavLink> | undefined>( undefined );

ruanyl · 2023-10-10T08:41:33Z

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

      });

    const forceAppSwitcherNavigation$ = new BehaviorSubject(false);

    return {
      getNavLinks$: () => {
-        return navLinks$.pipe(map(sortNavLinks), takeUntil(this.stop$));
+        return combineLatest([allNavLinks$, this.navLinks$]).pipe(


Is this.navLinks$ the filtered links which will be displayed? If so, can we give it a precise name for readability? Something like displayedLinks?

ruanyl · 2023-10-10T08:45:24Z

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

+function sortChromeNavLinks(chromeNavLinks: ReadonlyMap<string, ChromeNavLink>) {
+  return sortBy(
+    [...chromeNavLinks.values()].map((link) => link as Readonly<ChromeNavLink>),
+    'order'
+  );
+}


I may combine sortNavLinks and sortChromeNavLinks like this:

function sortLinks(navLinks: ReadonlyMap<string, NavLinkWrapper | ChromeNavLink>) { return sortBy( [...navLinks.values()].map((link) => 'properties' in link ? link.properties : link), 'order' ); }

src/core/public/chrome/ui/header/collapsible_nav.tsx

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

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

opensearch-workspace-development · 2023-10-18T01:52:34Z

The backport to workspace failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-workspace workspace
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-workspace
# Create a new branch
git switch --create backport/backport-192-to-workspace
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 c271e741f8bb2aee06aeff1976249cb37813f3cd
# Push it to GitHub
git push --set-upstream origin backport/backport-192-to-workspace
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-workspace

Then, create a pull request where the base branch is workspace and the compare/head branch is backport/backport-192-to-workspace.

* [Workspace][Feature] Left navigation menu adjustment (#192) * add util function to filter workspace feature by wildcard Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * resolve conflict Signed-off-by: yuye-aws <yuyezhu@amazon.com> * update tests and snapshots Signed-off-by: yuye-aws <yuyezhu@amazon.com> * small adjustment to left menu Signed-off-by: yuye-aws <yuyezhu@amazon.com> * resolve git conflict Signed-off-by: yuye-aws <yuyezhu@amazon.com> * rename nav link service function Signed-off-by: yuye-aws <yuyezhu@amazon.com> * unit test for workspace plugin.ts Signed-off-by: yuye-aws <yuyezhu@amazon.com> * update snapshots Signed-off-by: yuye-aws <yuyezhu@amazon.com> * optimize code Signed-off-by: yuye-aws <yuyezhu@amazon.com> * optimize code Signed-off-by: yuye-aws <yuyezhu@amazon.com> * optimize code Signed-off-by: yuye-aws <yuyezhu@amazon.com> * optimize code Signed-off-by: yuye-aws <yuyezhu@amazon.com> * optimize code Signed-off-by: yuye-aws <yuyezhu@amazon.com> * optimize code Signed-off-by: yuye-aws <yuyezhu@amazon.com> --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com> Signed-off-by: yuye-aws <yuyezhu@amazon.com> Co-authored-by: Yulong Ruan <ruanyl@amazon.com> * resolve conflict Signed-off-by: yuye-aws <yuyezhu@amazon.com> * update snapshots Signed-off-by: yuye-aws <yuyezhu@amazon.com> * resolve conflicts Signed-off-by: yuye-aws <yuyezhu@amazon.com> * restore snapshot Signed-off-by: yuye-aws <yuyezhu@amazon.com> * update tests Signed-off-by: yuye-aws <yuyezhu@amazon.com> --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com> Signed-off-by: yuye-aws <yuyezhu@amazon.com> Co-authored-by: Yulong Ruan <ruanyl@amazon.com>

* add util function to filter workspace feature by wildcard Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * resolve conflict Signed-off-by: yuye-aws <yuyezhu@amazon.com> * update tests and snapshots Signed-off-by: yuye-aws <yuyezhu@amazon.com> * small adjustment to left menu Signed-off-by: yuye-aws <yuyezhu@amazon.com> * resolve git conflict Signed-off-by: yuye-aws <yuyezhu@amazon.com> * rename nav link service function Signed-off-by: yuye-aws <yuyezhu@amazon.com> * unit test for workspace plugin.ts Signed-off-by: yuye-aws <yuyezhu@amazon.com> * update snapshots Signed-off-by: yuye-aws <yuyezhu@amazon.com> * optimize code Signed-off-by: yuye-aws <yuyezhu@amazon.com> * optimize code Signed-off-by: yuye-aws <yuyezhu@amazon.com> * optimize code Signed-off-by: yuye-aws <yuyezhu@amazon.com> * optimize code Signed-off-by: yuye-aws <yuyezhu@amazon.com> * optimize code Signed-off-by: yuye-aws <yuyezhu@amazon.com> * optimize code Signed-off-by: yuye-aws <yuyezhu@amazon.com> --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com> Signed-off-by: yuye-aws <yuyezhu@amazon.com> Co-authored-by: Yulong Ruan <ruanyl@amazon.com>

github-actions bot added the seasoned-contributor label Sep 21, 2023

yuye-aws added the backport workspace label Sep 21, 2023

yuye-aws requested review from ruanyl and SuZhou-Joe September 22, 2023 08:19

yuye-aws changed the title ~~feat: left navigation menu~~ [Workspace][Feature] Left navigation menu adjustment Sep 22, 2023

wanglam reviewed Oct 8, 2023

View reviewed changes

wanglam reviewed Oct 9, 2023

View reviewed changes

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

wanglam approved these changes Oct 9, 2023

View reviewed changes

ruanyl reviewed Oct 10, 2023

View reviewed changes

src/core/public/chrome/ui/header/collapsible_nav.tsx Show resolved Hide resolved

ruanyl reviewed Oct 17, 2023

View reviewed changes

ruanyl and others added 14 commits October 17, 2023 15:02

add util function to filter workspace feature by wildcard

055480f

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

resolve conflict

93eec71

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

update tests and snapshots

a123701

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

small adjustment to left menu

b82ab2a

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

resolve git conflict

f6b6450

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

rename nav link service function

67c6ea8

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

unit test for workspace plugin.ts

ec57a73

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

update snapshots

64105bd

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

optimize code

222cb68

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

optimize code

811484d

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

optimize code

71b4134

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

optimize code

66d838c

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

optimize code

dc30421

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

optimize code

1e1e12a

Signed-off-by: yuye-aws <yuyezhu@amazon.com>

yuye-aws requested a review from ruanyl October 17, 2023 09:03

ruanyl approved these changes Oct 17, 2023

View reviewed changes

yuye-aws merged commit c271e74 into ruanyl:workspace-pr-integr Oct 18, 2023
32 checks passed

opensearch-workspace-development bot added the failed backport label Oct 18, 2023

yuye-aws mentioned this pull request Oct 18, 2023

[Backport workspace] Left navigation menu adjustment (#192) #233

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workspace][Feature] Left navigation menu adjustment #192

[Workspace][Feature] Left navigation menu adjustment #192

yuye-aws commented Sep 21, 2023 •

edited

Loading

codecov-commenter commented Sep 21, 2023 •

edited

Loading

ruanyl commented Sep 22, 2023

ruanyl Oct 10, 2023

ruanyl Oct 10, 2023

ruanyl Oct 10, 2023

ruanyl Oct 10, 2023

opensearch-workspace-development bot commented Oct 18, 2023

	setNavLinks: (filteredNavLinks: ReadonlyMap<string, ChromeNavLink>) => {
	setNavLinks: (navLinks: ReadonlyMap<string, ChromeNavLink>) => {

[Workspace][Feature] Left navigation menu adjustment #192

[Workspace][Feature] Left navigation menu adjustment #192

Conversation

yuye-aws commented Sep 21, 2023 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Check List

codecov-commenter commented Sep 21, 2023 • edited Loading

Codecov Report

ruanyl commented Sep 22, 2023

ruanyl Oct 10, 2023

Choose a reason for hiding this comment

ruanyl Oct 10, 2023

Choose a reason for hiding this comment

ruanyl Oct 10, 2023

Choose a reason for hiding this comment

ruanyl Oct 10, 2023

Choose a reason for hiding this comment

opensearch-workspace-development bot commented Oct 18, 2023

yuye-aws commented Sep 21, 2023 •

edited

Loading

codecov-commenter commented Sep 21, 2023 •

edited

Loading