feat: Add `rightNavigationButton` component in chrome service for applications to register and add dev tool to top right navigation #6553

raintygao · 2024-04-19T05:56:50Z

Description

Update chrome service and define functions and components internally to register top right navigation for applications to call.
Register top right navigation in dev tool app.

Issues Resolved

#6330

Screenshot

Testing the changes

Changelog

skip

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

github-actions · 2024-04-19T05:57:21Z

❌ Invalid Prefix For Manual Changeset Creation

Invalid description prefix. Found "feat". Only "skip" entry option is permitted for manual commit of changeset files.

If you were trying to skip the changelog entry, please use the "skip" entry option in the ##Changelog section of your PR description.

github-actions · 2024-04-19T05:58:30Z

❌ Invalid Prefix For Manual Changeset Creation

Invalid description prefix. Found "feat". Only "skip" entry option is permitted for manual commit of changeset files.

If you were trying to skip the changelog entry, please use the "skip" entry option in the ##Changelog section of your PR description.

github-actions · 2024-04-19T06:00:04Z

❌ Invalid Prefix For Manual Changeset Creation

Invalid description prefix. Found "feat". Only "skip" entry option is permitted for manual commit of changeset files.

If you were trying to skip the changelog entry, please use the "skip" entry option in the ##Changelog section of your PR description.

src/core/public/chrome/nav_controls/nav_controls_service.ts

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

src/plugins/dev_tools/public/plugin.ts

CHANGELOG.md

ashwin-pc · 2024-04-22T06:15:26Z

How is this different from registerRight?

Signed-off-by: tygao <[email protected]>

Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: tygao <[email protected]>

Signed-off-by: tygao <[email protected]>

Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: tygao <[email protected]>

Signed-off-by: tygao <[email protected]>

…ons to register and add dev tool to top right navigation. Signed-off-by: tygao <[email protected]>

Signed-off-by: tygao <[email protected]>

SuZhou-Joe · 2024-04-29T06:27:03Z

src/plugins/dev_tools/public/plugin.ts

+          application: core.application,
+          http: core.http,


Nit: perhaps CoreStart will be better for backward-capability.

Hailong-am · 2024-04-29T10:11:56Z

src/core/public/chrome/constants.ts

+export enum RightNavigationOrder {
+  // order of dev tool should be after advance settings
+  Settings = 1,
+  DevTool = 2,


nit: the value could be 10, 20 and leave some gaps between them so that we can add more between settings and devtool without change the value.

That makes sense. Updated.

ruanyl

Approved with a minor comment

ruanyl · 2024-04-29T13:34:13Z

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

+  const navigateToApp = (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => {
+    /* Use href and onClick to support "open in new tab" and SPA navigation in the same link */
+    if (
+      event.button === 0 && // ignore everything but left clicks


Nit: consider to extract to a function for better readability

const isLeftClickEvent = (event) => event.button === 0;

Seems your guys approvals were dismissed because of commits to address comments. Could you guys help add 2.x label and approve again?

Signed-off-by: tygao <[email protected]>

…lications to register and add dev tool to top right navigation (#6553) * feat: add dev tool to top right navigation Signed-off-by: tygao <[email protected]> * doc: update changelog Signed-off-by: tygao <[email protected]> * test: update component props snapshot Signed-off-by: tygao <[email protected]> * update nav_controls_service.ts Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: tygao <[email protected]> * update dependency props and constants Signed-off-by: tygao <[email protected]> * update nav control test Signed-off-by: tygao <[email protected]> * Update CHANGELOG.md Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: tygao <[email protected]> * test: update snapshots Signed-off-by: tygao <[email protected]> * doc: update changelog Signed-off-by: tygao <[email protected]> * update click handle Signed-off-by: tygao <[email protected]> * update click handle Signed-off-by: tygao <[email protected]> * doc: add doc for registerRightNavigation Signed-off-by: tygao <[email protected]> * Add `rightNavigationButton` component in chrome service for applications to register and add dev tool to top right navigation. Signed-off-by: tygao <[email protected]> * test: update core start type Signed-off-by: tygao <[email protected]> * update RightNavigationOrder value Signed-off-by: tygao <[email protected]> * extract left click function Signed-off-by: tygao <[email protected]> --------- Signed-off-by: tygao <[email protected]> Co-authored-by: SuZhou-Joe <[email protected]> Co-authored-by: Yulong Ruan <[email protected]> (cherry picked from commit cfe7cd1) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

…lications to register and add dev tool to top right navigation (#6553) (#6684) * feat: add dev tool to top right navigation Signed-off-by: tygao <[email protected]> * doc: update changelog Signed-off-by: tygao <[email protected]> * test: update component props snapshot Signed-off-by: tygao <[email protected]> * update nav_controls_service.ts Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: tygao <[email protected]> * update dependency props and constants Signed-off-by: tygao <[email protected]> * update nav control test Signed-off-by: tygao <[email protected]> * Update CHANGELOG.md Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: tygao <[email protected]> * test: update snapshots Signed-off-by: tygao <[email protected]> * doc: update changelog Signed-off-by: tygao <[email protected]> * update click handle Signed-off-by: tygao <[email protected]> * update click handle Signed-off-by: tygao <[email protected]> * doc: add doc for registerRightNavigation Signed-off-by: tygao <[email protected]> * Add `rightNavigationButton` component in chrome service for applications to register and add dev tool to top right navigation. Signed-off-by: tygao <[email protected]> * test: update core start type Signed-off-by: tygao <[email protected]> * update RightNavigationOrder value Signed-off-by: tygao <[email protected]> * extract left click function Signed-off-by: tygao <[email protected]> --------- Signed-off-by: tygao <[email protected]> Co-authored-by: SuZhou-Joe <[email protected]> Co-authored-by: Yulong Ruan <[email protected]> (cherry picked from commit cfe7cd1) 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>

…lications to register and add dev tool to top right navigation (opensearch-project#6553) * feat: add dev tool to top right navigation Signed-off-by: tygao <[email protected]> * doc: update changelog Signed-off-by: tygao <[email protected]> * test: update component props snapshot Signed-off-by: tygao <[email protected]> * update nav_controls_service.ts Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: tygao <[email protected]> * update dependency props and constants Signed-off-by: tygao <[email protected]> * update nav control test Signed-off-by: tygao <[email protected]> * Update CHANGELOG.md Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: tygao <[email protected]> * test: update snapshots Signed-off-by: tygao <[email protected]> * doc: update changelog Signed-off-by: tygao <[email protected]> * update click handle Signed-off-by: tygao <[email protected]> * update click handle Signed-off-by: tygao <[email protected]> * doc: add doc for registerRightNavigation Signed-off-by: tygao <[email protected]> * Add `rightNavigationButton` component in chrome service for applications to register and add dev tool to top right navigation. Signed-off-by: tygao <[email protected]> * test: update core start type Signed-off-by: tygao <[email protected]> * update RightNavigationOrder value Signed-off-by: tygao <[email protected]> * extract left click function Signed-off-by: tygao <[email protected]> --------- Signed-off-by: tygao <[email protected]> Co-authored-by: SuZhou-Joe <[email protected]> Co-authored-by: Yulong Ruan <[email protected]>

github-actions bot added the repeat-contributor label Apr 19, 2024

github-actions bot added the failed changeset label Apr 19, 2024

raintygao marked this pull request as ready for review April 19, 2024 05:59

raintygao requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, curq, bandinib-amzn, SuZhou-Joe, ruanyl, BionIT and xinruiba as code owners April 19, 2024 05:59

github-actions bot added Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry and removed failed changeset labels Apr 19, 2024

SuZhou-Joe reviewed Apr 19, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

raintygao changed the title ~~feat: add dev tool to top right navigation~~ feat: introduce registerRightNavigation in chrome service to reigster standard top right navigation and add dev tool to top right navigation Apr 22, 2024

raintygao and others added 12 commits April 29, 2024 10:11

test: update component props snapshot

25c8bc4

Signed-off-by: tygao <[email protected]>

update nav_controls_service.ts

0faebef

Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: tygao <[email protected]>

update dependency props and constants

c962c9e

Signed-off-by: tygao <[email protected]>

update nav control test

943d0fe

Signed-off-by: tygao <[email protected]>

Update CHANGELOG.md

2723569

Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: tygao <[email protected]>

test: update snapshots

e737c46

Signed-off-by: tygao <[email protected]>

doc: update changelog

e1663a5

Signed-off-by: tygao <[email protected]>

update click handle

3966338

Signed-off-by: tygao <[email protected]>

update click handle

30c0ee5

Signed-off-by: tygao <[email protected]>

doc: add doc for registerRightNavigation

c5ff561

Signed-off-by: tygao <[email protected]>

Add rightNavigationButton component in chrome service for applicati…

2d1a8ee

…ons to register and add dev tool to top right navigation. Signed-off-by: tygao <[email protected]>

test: update core start type

64051a6

Signed-off-by: tygao <[email protected]>

raintygao force-pushed the feat-add-navigation branch from 1c0da2a to 64051a6 Compare April 29, 2024 02:12

SuZhou-Joe previously approved these changes Apr 29, 2024

View reviewed changes

Hailong-am reviewed Apr 29, 2024

View reviewed changes

ruanyl previously approved these changes Apr 29, 2024

View reviewed changes

update RightNavigationOrder value

57881d7

Signed-off-by: tygao <[email protected]>

raintygao dismissed stale reviews from ruanyl and SuZhou-Joe via 57881d7 April 29, 2024 13:48

extract left click function

052a1fd

Signed-off-by: tygao <[email protected]>

ruanyl approved these changes Apr 30, 2024

View reviewed changes

Merge branch 'main' into feat-add-navigation

99b0fde

SuZhou-Joe approved these changes Apr 30, 2024

View reviewed changes

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

SuZhou-Joe merged commit cfe7cd1 into opensearch-project:main Apr 30, 2024
70 of 71 checks passed

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

[Backport 2.x] feat: Add rightNavigationButton component in chrome service for applications to register and add dev tool to top right navigation #6684

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add `rightNavigationButton` component in chrome service for applications to register and add dev tool to top right navigation #6553

feat: Add `rightNavigationButton` component in chrome service for applications to register and add dev tool to top right navigation #6553

raintygao commented Apr 19, 2024 •

edited

Loading

github-actions bot commented Apr 19, 2024

github-actions bot commented Apr 19, 2024

github-actions bot commented Apr 19, 2024

ashwin-pc commented Apr 22, 2024

SuZhou-Joe Apr 29, 2024

Hailong-am Apr 29, 2024

raintygao Apr 29, 2024

ruanyl left a comment

ruanyl Apr 29, 2024

raintygao Apr 29, 2024

raintygao Apr 29, 2024 •

edited

Loading

feat: Add rightNavigationButton component in chrome service for applications to register and add dev tool to top right navigation #6553

feat: Add rightNavigationButton component in chrome service for applications to register and add dev tool to top right navigation #6553

Conversation

raintygao commented Apr 19, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

github-actions bot commented Apr 19, 2024

❌ Invalid Prefix For Manual Changeset Creation

github-actions bot commented Apr 19, 2024

❌ Invalid Prefix For Manual Changeset Creation

github-actions bot commented Apr 19, 2024

❌ Invalid Prefix For Manual Changeset Creation

ashwin-pc commented Apr 22, 2024

SuZhou-Joe Apr 29, 2024

Choose a reason for hiding this comment

Hailong-am Apr 29, 2024

Choose a reason for hiding this comment

raintygao Apr 29, 2024

Choose a reason for hiding this comment

ruanyl left a comment

Choose a reason for hiding this comment

ruanyl Apr 29, 2024

Choose a reason for hiding this comment

raintygao Apr 29, 2024

Choose a reason for hiding this comment

raintygao Apr 29, 2024 • edited Loading

Choose a reason for hiding this comment

feat: Add `rightNavigationButton` component in chrome service for applications to register and add dev tool to top right navigation #6553

feat: Add `rightNavigationButton` component in chrome service for applications to register and add dev tool to top right navigation #6553

raintygao commented Apr 19, 2024 •

edited

Loading

raintygao Apr 29, 2024 •

edited

Loading