[navigation-next] feat: introduce new interface for group #7060

SuZhou-Joe · 2024-06-19T09:57:42Z

Description

This PR mainly introduces new interface to register and get useCases from chrome service, and it is a fundamental change for the new navigation.

Issues Resolved

closes #7061

Screenshot

No UI changes.

Testing the changes

As there is no place using the new interfaces introduced in this PR. You can refer to the test cases here:
src/core/public/chrome/chrome_service.test.ts

Changelog

feat: Introduce new interface for group

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-06-19T10:24:17Z

Codecov Report

Attention: Patch coverage is 86.59794% with 13 lines in your changes missing coverage. Please review.

Project coverage is 67.48%. Comparing base (b85e177) to head (35c1db7).

Files	Patch %	Lines
src/core/public/chrome/utils.ts	78.18%	7 Missing and 5 partials ⚠️
src/core/public/chrome/chrome_service.mock.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7060      +/-   ##
==========================================
+ Coverage   67.45%   67.48%   +0.02%     
==========================================
  Files        3448     3451       +3     
  Lines       67964    68060      +96     
  Branches    11057    11068      +11     
==========================================
+ Hits        45845    45928      +83     
- Misses      19446    19454       +8     
- Partials     2673     2678       +5

Flag	Coverage Δ
Linux_1	`33.04% <7.21%> (-0.06%)`	⬇️
Linux_2	`55.18% <86.59%> (+0.12%)`	⬆️
Linux_3	`45.14% <7.21%> (-0.10%)`	⬇️
Linux_4	`34.76% <7.21%> (-0.07%)`	⬇️
Windows_1	`33.07% <7.21%> (-0.06%)`	⬇️
Windows_2	`55.13% <86.59%> (+0.12%)`	⬆️
Windows_3	`45.15% <7.21%> (-0.11%)`	⬇️
Windows_4	`34.76% <7.21%> (-0.07%)`	⬇️

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.

src/core/public/chrome/chrome_service.tsx

…project#7060) Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

src/core/public/chrome/nav_group/nav_group_service.ts

src/core/utils/default_app_categories.ts

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

src/core/public/chrome/nav_group/nav_group_service.ts

src/core/public/chrome/utils.ts

ruanyl · 2024-07-01T04:59:20Z

src/core/types/nav_group.ts

+   * Groups with type of NavGroupType.SYSTEM will:
+   * 1. Always display before USE_CASE_GROUP.
+   * 2. Not be pickable within the workspace creation page.
+   *
+   * @default undefined indicates it is of type useCase


Should this comment be adjusted a bit? Maybe the comment should be not in core, but at where the type is used.

Sure, move the comment to the enum NavGroupType, and the place which will use this type is in another PR and still waiting for finalized design.

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

…project#7060) Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

seraphjiang · 2024-07-01T15:55:56Z

@BionIT @ZilongX would you help to review and merge?

opensearch-trigger-bot · 2024-07-01T16:12:56Z

The backport to 2.x 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-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-7060-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 5212f09b780459c8212697a419d5651b83361d6d
# Push it to GitHub
git push --set-upstream origin backport/backport-7060-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-7060-to-2.x.

…-project#7060) * feat: introduce new interface for use case Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * Changeset file for PR opensearch-project#7060 created/updated * feat: introduce new interface for use case Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: introduce new interface for use case Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: introduce new interface for use case Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: update test snapshot Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: update based on comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * Changeset file for PR opensearch-project#7060 created/updated * fix: update based on comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: update based on comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: update based on comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update based on comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add default nav group Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: type error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: type error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: expose DEFAULT_NAV_GROUPS in src/core/public Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: export NavGroupItemInMap type Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update README Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update README Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update interface Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * refactor: move navGroup related interface into a service Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: remove useless code Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * [Navigation-Next] Add nav group enabled in chrome service(7072) Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * Remove useless code Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * use homepage flag Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update README Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: expose sorted navLinks Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: bootstrap error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: snapshot error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update according to comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: support parent link Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update according to comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update according to comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Co-authored-by: ZilongX <99905560+ZilongX@users.noreply.github.com> (cherry picked from commit 5212f09)

) * feat: introduce new interface for use case Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * Changeset file for PR #7060 created/updated * feat: introduce new interface for use case Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: introduce new interface for use case Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: introduce new interface for use case Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: update test snapshot Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: update based on comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * Changeset file for PR #7060 created/updated * fix: update based on comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: update based on comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: update based on comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update based on comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: add default nav group Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: type error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: type error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: expose DEFAULT_NAV_GROUPS in src/core/public Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: export NavGroupItemInMap type Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update README Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update README Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update interface Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * refactor: move navGroup related interface into a service Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: remove useless code Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * [Navigation-Next] Add nav group enabled in chrome service(7072) Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * Remove useless code Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * use homepage flag Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update README Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: expose sorted navLinks Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: unit test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: bootstrap error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: snapshot error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update according to comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: support parent link Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update according to comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update according to comment Signed-off-by: SuZhou-Joe <suzhou@amazon.com> --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Co-authored-by: ZilongX <99905560+ZilongX@users.noreply.github.com> (cherry picked from commit 5212f09)

zhyuanqi · 2024-07-09T20:16:41Z

#7136 Remove failed backport as it has been manually backported.

SuZhou-Joe requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, curq, bandinib-amzn, ruanyl, BionIT, xinruiba, zhyuanqi and mengweieric as code owners June 19, 2024 09:57

github-actions bot added seasoned-contributor failed changeset labels Jun 19, 2024

SuZhou-Joe added v2.16.0 backport 2.x and removed failed changeset labels Jun 19, 2024

opensearch-project deleted a comment from github-actions bot Jun 19, 2024

opensearch-changeset-bot bot added a commit to SuZhou-Joe/OpenSearch-Dashboards that referenced this pull request Jun 19, 2024

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

1c28c1c

wanglam mentioned this pull request Jun 20, 2024

[Navigation-Next] Add nav group enabled in chrome service #7072

Closed

7 tasks

Hailong-am reviewed Jun 20, 2024

View reviewed changes

src/core/public/chrome/chrome_service.tsx Outdated Show resolved Hide resolved

src/core/public/chrome/chrome_service.tsx Outdated Show resolved Hide resolved

src/core/public/chrome/chrome_service.tsx Outdated Show resolved Hide resolved

ruanyl reviewed Jun 20, 2024

View reviewed changes

opensearch-changeset-bot bot added a commit to SuZhou-Joe/OpenSearch-Dashboards that referenced this pull request Jun 20, 2024

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

ce528df

SuZhou-Joe added a commit to SuZhou-Joe/OpenSearch-Dashboards that referenced this pull request Jun 28, 2024

[navigation-next] feat: introduce new interface for group(opensearch-…

46c1518

…project#7060) Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

SuZhou-Joe added a commit that referenced this pull request Jun 28, 2024

[navigation-next] feat: introduce new interface for group(#7060)

74f5043

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

SuZhou-Joe marked this pull request as ready for review June 28, 2024 04:18

Hailong-am reviewed Jun 28, 2024

View reviewed changes

src/core/public/chrome/nav_group/nav_group_service.ts Outdated Show resolved Hide resolved

wanglam reviewed Jun 28, 2024

View reviewed changes

src/core/utils/default_app_categories.ts Show resolved Hide resolved

wanglam approved these changes Jun 28, 2024

View reviewed changes

SuZhou-Joe added 2 commits June 28, 2024 15:18

feat: update according to comment

b816574

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

feat: support parent link

7c2a516

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

seraphjiang approved these changes Jul 1, 2024

View reviewed changes

Merge branch 'main' into feature/register-use-case

244628f

ruanyl reviewed Jul 1, 2024

View reviewed changes

SuZhou-Joe added 2 commits July 1, 2024 15:38

feat: update according to comment

8374812

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

feat: update according to comment

35c1db7

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

SuZhou-Joe added a commit to SuZhou-Joe/OpenSearch-Dashboards that referenced this pull request Jul 1, 2024

[navigation-next] feat: introduce new interface for group(opensearch-…

afd2e97

…project#7060) Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

ruanyl approved these changes Jul 1, 2024

View reviewed changes

BionIT approved these changes Jul 1, 2024

View reviewed changes

BionIT merged commit 5212f09 into opensearch-project:main Jul 1, 2024
67 checks passed

opensearch-trigger-bot bot added the failed backport label Jul 1, 2024

This was referenced Jul 1, 2024

[Backport 2.x] [navigation-next] feat: introduce new interface for group #7135

Closed

[Backport 2.x][navigation-next] feat: introduce new interface for group (#7060) #7136

Merged

This was referenced Jul 2, 2024

[Workspace] Add useCaseEnabled in advanced settings #7073

Closed

[Navigation-Next] Support nested items in left navigation. #7118

Closed

This was referenced Jul 11, 2024

[Workspace] Use registered nav group as workspace use cases #7222

Closed

[Workspace] use registered nav groups in workspace form #7221

Merged

AMoo-Miki removed the failed backport label Aug 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[navigation-next] feat: introduce new interface for group #7060

[navigation-next] feat: introduce new interface for group #7060

SuZhou-Joe commented Jun 19, 2024 •

edited

Loading

codecov bot commented Jun 19, 2024 •

edited

Loading

ruanyl Jul 1, 2024

SuZhou-Joe Jul 1, 2024

seraphjiang commented Jul 1, 2024

opensearch-trigger-bot bot commented Jul 1, 2024

zhyuanqi commented Jul 9, 2024

[navigation-next] feat: introduce new interface for group #7060

[navigation-next] feat: introduce new interface for group #7060

Conversation

SuZhou-Joe commented Jun 19, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

codecov bot commented Jun 19, 2024 • edited Loading

Codecov Report

ruanyl Jul 1, 2024

Choose a reason for hiding this comment

SuZhou-Joe Jul 1, 2024

Choose a reason for hiding this comment

seraphjiang commented Jul 1, 2024

opensearch-trigger-bot bot commented Jul 1, 2024

zhyuanqi commented Jul 9, 2024

SuZhou-Joe commented Jun 19, 2024 •

edited

Loading

codecov bot commented Jun 19, 2024 •

edited

Loading