[Fix] Inactive State on 'Discover' Tab in Side Navigation Menu by willie-hung · Pull Request #5432 · opensearch-project/OpenSearch-Dashboards

willie-hung · 2023-11-05T18:10:15Z

Description

This PR resolves the issue where the 'Discover' tab in the collapsible side navigation menu failed to display the appropriate active state styling upon selection. The modification ensures that when a user selects the 'Discover' tab, it is now triggered and displayed with an active state background.

Issues Resolved

Resolves #5226

Screenshot

Before

before.mov

After

after.mov

Testing

Add unit tests for the following functions to ensure the newly added function operates correctly.

isActiveNavLink (newly added function)
createEuiListItem

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: Willie Hung <willie880201044@gmail.com>

codecov · 2023-11-05T18:31:14Z

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (5fabb73) 66.97% compared to head (a37d42c) 66.97%.

Files	Patch %	Lines
src/core/public/chrome/ui/header/nav_link.tsx	66.66%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5432      +/-   ##
==========================================
- Coverage   66.97%   66.97%   -0.01%     
==========================================
  Files        3293     3293              
  Lines       63289    63292       +3     
  Branches    10065    10066       +1     
==========================================
  Hits        42390    42390              
- Misses      18458    18459       +1     
- Partials     2441     2443       +2

Flag	Coverage Δ
Linux_1	`35.24% <66.66%> (+<0.01%)`	⬆️
Linux_2	`55.17% <66.66%> (+<0.01%)`	⬆️
Linux_3	`43.80% <66.66%> (-0.01%)`	⬇️
Linux_4	`35.34% <66.66%> (+<0.01%)`	⬆️
Windows_1	`35.27% <66.66%> (+<0.01%)`	⬆️
Windows_2	`55.14% <66.66%> (+<0.01%)`	⬆️
Windows_3	`43.80% <66.66%> (+<0.01%)`	⬆️
Windows_4	`35.34% <66.66%> (+<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.

Signed-off-by: Willie Hung <willie880201044@gmail.com>

Signed-off-by: Josh Romero <rmerqg@amazon.com>

Signed-off-by: Willie Hung <willie880201044@gmail.com>

joshuarrrr

@Willie-The-Lord I think this PR is great, but I have a couple ideas for how we might make it a little better oriented with future improvements.

joshuarrrr · 2023-11-13T22:57:06Z

 export const isModifiedOrPrevented = (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) =>
  event.metaKey || event.altKey || event.ctrlKey || event.shiftKey || event.defaultPrevented;

+// Future: should make this function more generic


For comments that indicate future work, we generally use the TODO: prefix, which is actually parsed and identified by several tools. Also, in the case of any TODO, there should be an open issue, and the link should be included in the comment itself. This makes it much easier to know if a given todo has actually been completed or if the comment is still valid.

Suggested change

// Future: should make this function more generic

// TODO: make this function more generic

@joshuarrrr should I create an issue for the future improvement?

@Willie-The-Lord Yes, please, that would be appreciated! 😄

@joshuarrrr issue created.

Co-authored-by: Josh Romero <rmerqg@amazon.com> Signed-off-by: Willie Hung <willie880201044@gmail.com>

Signed-off-by: Willie Hung <willie880201044@gmail.com>

Signed-off-by: Josh Romero <rmerqg@amazon.com>

Co-authored-by: SuZhou-Joe <suzhou@amazon.com> Signed-off-by: Willie Hung <willie880201044@gmail.com>

joshuarrrr

LGTM - @Willie-The-Lord please open a follow-up issue, if you haven't already, for creating a registration function.

* Fix active background render error * Update CHANGELOG.md * Revise test suit * Add isActive logic * Remove redundant tests and add comment for future reference * Update src/core/public/chrome/ui/header/nav_link.tsx * Seperate special cases from logic && revise test * Update CHANGELOG.md * Update src/core/public/chrome/ui/header/nav_link.tsx Co-authored-by: SuZhou-Joe <suzhou@amazon.com> Signed-off-by: Willie Hung <willie880201044@gmail.com> --------- Signed-off-by: Willie Hung <willie880201044@gmail.com> Signed-off-by: Josh Romero <rmerqg@amazon.com> Co-authored-by: Josh Romero <rmerqg@amazon.com> Co-authored-by: SuZhou-Joe <suzhou@amazon.com> (cherry picked from commit 478176a) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

#5606) * Fix active background render error * Update CHANGELOG.md * Revise test suit * Add isActive logic * Remove redundant tests and add comment for future reference * Update src/core/public/chrome/ui/header/nav_link.tsx * Seperate special cases from logic && revise test * Update CHANGELOG.md * Update src/core/public/chrome/ui/header/nav_link.tsx --------- (cherry picked from commit 478176a) Signed-off-by: Willie Hung <willie880201044@gmail.com> Signed-off-by: Josh Romero <rmerqg@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: Josh Romero <rmerqg@amazon.com> Co-authored-by: SuZhou-Joe <suzhou@amazon.com>

* Fix active background render error * Update CHANGELOG.md * Revise test suit * Add isActive logic * Remove redundant tests and add comment for future reference * Update src/core/public/chrome/ui/header/nav_link.tsx * Seperate special cases from logic && revise test * Update CHANGELOG.md * Update src/core/public/chrome/ui/header/nav_link.tsx Co-authored-by: SuZhou-Joe <suzhou@amazon.com> Signed-off-by: Willie Hung <willie880201044@gmail.com> --------- Signed-off-by: Willie Hung <willie880201044@gmail.com> Signed-off-by: Josh Romero <rmerqg@amazon.com> Co-authored-by: Josh Romero <rmerqg@amazon.com> Co-authored-by: SuZhou-Joe <suzhou@amazon.com> (cherry picked from commit 478176a) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

#5744) * Fix active background render error * Update CHANGELOG.md * Revise test suit * Add isActive logic * Remove redundant tests and add comment for future reference * Update src/core/public/chrome/ui/header/nav_link.tsx * Seperate special cases from logic && revise test * Update CHANGELOG.md * Update src/core/public/chrome/ui/header/nav_link.tsx --------- (cherry picked from commit 478176a) Signed-off-by: Willie Hung <willie880201044@gmail.com> Signed-off-by: Josh Romero <rmerqg@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: Josh Romero <rmerqg@amazon.com> Co-authored-by: SuZhou-Joe <suzhou@amazon.com>

Fix active background render error

8745b7b

Signed-off-by: Willie Hung <willie880201044@gmail.com>

willie-hung requested review from AMoo-Miki, BSFishy, Flyingliuhub, ZilongX, abbyhu2000, ananzh, ashwin-pc, curq, joshuarrrr, kavilla, kristenTian, manasvinibs, seanneumann, zengyan-amazon and zhongnansu as code owners November 5, 2023 18:10

github-actions bot added the repeat-contributor label Nov 5, 2023

Update CHANGELOG.md

0378e8b

Signed-off-by: Willie Hung <willie880201044@gmail.com>

willie-hung changed the title ~~[Fix] Fix Inactive State on 'Discover' Tab in Side Navigation Menu~~ [Fix] Inactive State on 'Discover' Tab in Side Navigation Menu Nov 5, 2023

willie-hung and others added 3 commits November 5, 2023 13:35

Revise test suit

e69ff56

Signed-off-by: Willie Hung <willie880201044@gmail.com>

Add isActive logic

4cd1632

Signed-off-by: Willie Hung <willie880201044@gmail.com>

Merge branch 'main' into bug/discover-tab

8f1bedf

Signed-off-by: Josh Romero <rmerqg@amazon.com>

ananzh reviewed Nov 11, 2023

View reviewed changes

Comment thread src/core/public/chrome/ui/header/nav_link.test.tsx Outdated

Comment thread src/core/public/chrome/ui/header/nav_link.test.tsx

Comment thread src/core/public/chrome/ui/header/nav_link.tsx Outdated

Remove redundant tests and add comment for future reference

aa623d6

Signed-off-by: Willie Hung <willie880201044@gmail.com>

ananzh previously approved these changes Nov 13, 2023

View reviewed changes

ananzh added bug Something isn't working v2.12.0 backport 2.x labels Nov 13, 2023

joshuarrrr reviewed Nov 13, 2023

View reviewed changes

Update src/core/public/chrome/ui/header/nav_link.tsx

6dae6d1

Co-authored-by: Josh Romero <rmerqg@amazon.com> Signed-off-by: Willie Hung <willie880201044@gmail.com>

willie-hung dismissed ananzh’s stale review via 6dae6d1 November 14, 2023 00:24

willie-hung and others added 4 commits November 13, 2023 20:09

Seperate special cases from logic && revise test

d05929e

Signed-off-by: Willie Hung <willie880201044@gmail.com>

Update CHANGELOG.md

b222fd3

Signed-off-by: Willie Hung <willie880201044@gmail.com>

Merge branch 'main' into bug/discover-tab

dbe169b

Signed-off-by: Josh Romero <rmerqg@amazon.com>

Merge branch 'main' into bug/discover-tab

778de06

willie-hung requested a review from bandinib-amzn as a code owner December 8, 2023 02:25

ananzh previously approved these changes Dec 12, 2023

View reviewed changes

Merge branch 'main' into bug/discover-tab

f97c452

willie-hung requested a review from SuZhou-Joe as a code owner December 13, 2023 00:57

SuZhou-Joe reviewed Dec 13, 2023

View reviewed changes

Comment thread src/core/public/chrome/ui/header/nav_link.tsx Outdated

Update src/core/public/chrome/ui/header/nav_link.tsx

a37d42c

Co-authored-by: SuZhou-Joe <suzhou@amazon.com> Signed-off-by: Willie Hung <willie880201044@gmail.com>

willie-hung dismissed ananzh’s stale review via a37d42c December 13, 2023 04:33

joshuarrrr approved these changes Dec 13, 2023

View reviewed changes

ananzh approved these changes Dec 13, 2023

View reviewed changes

ananzh merged commit 478176a into opensearch-project:main Dec 13, 2023

willie-hung deleted the bug/discover-tab branch December 13, 2023 20:25

opensearch-trigger-bot bot mentioned this pull request Dec 13, 2023

[Backport 2.x] [Fix] Inactive State on 'Discover' Tab in Side Navigation Menu #5606

Merged

joshuarrrr approved these changes Dec 13, 2023

View reviewed changes

Comment thread src/core/public/chrome/ui/header/nav_link.tsx

willie-hung mentioned this pull request Dec 13, 2023

[Enhance] Implement Registration Function for Dynamic NavLink Management #5608

Open

ananzh added the backport 2.11 label Jan 26, 2024

opensearch-trigger-bot bot mentioned this pull request Jan 26, 2024

[Backport 2.11] [Fix] Inactive State on 'Discover' Tab in Side Navigation Menu #5744

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fix] Inactive State on 'Discover' Tab in Side Navigation Menu#5432

[Fix] Inactive State on 'Discover' Tab in Side Navigation Menu#5432
ananzh merged 13 commits intoopensearch-project:mainfrom
willie-hung:bug/discover-tab

willie-hung commented Nov 5, 2023 •

edited

Loading

Uh oh!

codecov bot commented Nov 5, 2023 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joshuarrrr left a comment

Uh oh!

joshuarrrr Nov 13, 2023

Uh oh!

willie-hung Nov 14, 2023

Uh oh!

joshuarrrr Nov 16, 2023

Uh oh!

willie-hung Dec 13, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joshuarrrr left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	// Future: should make this function more generic
	// TODO: make this function more generic

Conversation

willie-hung commented Nov 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Screenshot

Before

After

Testing

Check List

Uh oh!

codecov bot commented Nov 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joshuarrrr left a comment

Choose a reason for hiding this comment

Uh oh!

joshuarrrr Nov 13, 2023

Choose a reason for hiding this comment

Uh oh!

willie-hung Nov 14, 2023

Choose a reason for hiding this comment

Uh oh!

joshuarrrr Nov 16, 2023

Choose a reason for hiding this comment

Uh oh!

willie-hung Dec 13, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joshuarrrr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

willie-hung commented Nov 5, 2023 •

edited

Loading

codecov bot commented Nov 5, 2023 •

edited

Loading