[navigation] feat: Render dev tools inside a modal #7938

SuZhou-Joe · 2024-08-30T08:37:16Z

Description

Change dev tools to a full page modal.

Issues Resolved

Screenshot

20240830181306154.mp4

Testing the changes

Changelog

feat: change dev tools to a modal

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-08-30T08:53:47Z

Codecov Report

Attention: Patch coverage is 85.18519% with 4 lines in your changes missing coverage. Please review.

Project coverage is 60.93%. Comparing base (a663a84) to head (fcf2c23).
Report is 149 commits behind head on main.

Files with missing lines	Patch %	Lines
src/plugins/dev_tools/public/dev_tools_icon.tsx	75.00%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7938      +/-   ##
==========================================
+ Coverage   60.92%   60.93%   +0.01%     
==========================================
  Files        3750     3751       +1     
  Lines       89103    89164      +61     
  Branches    13925    13937      +12     
==========================================
+ Hits        54285    54334      +49     
- Misses      31442    31450       +8     
- Partials     3376     3380       +4

Flag	Coverage Δ
Linux_1	`28.85% <ø> (+0.02%)`	⬆️
Linux_2	`56.35% <ø> (-0.01%)`	⬇️
Linux_3	`37.75% <85.18%> (+0.02%)`	⬆️
Linux_4	`29.96% <ø> (+<0.01%)`	⬆️
Windows_1	`28.87% <ø> (+0.02%)`	⬆️
Windows_2	`56.30% <ø> (-0.01%)`	⬇️
Windows_3	`37.75% <85.18%> (+0.02%)`	⬆️
Windows_4	`29.96% <ø> (+<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.

src/plugins/dev_tools/public/dev_tools_icon.tsx

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

ruanyl · 2024-09-30T09:37:25Z

Nit: the spacing between the buttons seems larger then it should be?

Hailong-am · 2024-10-01T07:16:50Z

src/plugins/console/public/application/components/top_nav_menu.tsx


 export interface TopNavMenuItem {
  id: string;
  label: string;
  description: string;
  onClick: () => void;
  testId: string;
+  render?: (commonProps: CommonProps) => React.JSX.Element;
+  position: MenuItemPosition;


maybe add order for the item?

May not because we are adding these items in an array and all the items come from a single file, not a registration placeholder for other plugins to insert.

Hailong-am · 2024-10-01T07:25:03Z

src/plugins/dev_tools/public/dev_tools_icon.tsx

+            >
+              <EuiFlexGroup direction="column" className="eui-fullHeight devToolsModalContent">
+                <EuiFlexItem grow={false}>
+                  <EuiSpacer />


nit: the default size for Spacer is large, should we changed to m?

Sure, updated.

Hailong-am · 2024-10-01T07:40:43Z

Nit: the spacing between the buttons seems larger then it should be?

the order of help and settings is not match with mock

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

SuZhou-Joe · 2024-10-01T07:56:00Z

@ruanyl @Hailong-am Thanks for the comment, all addressed.

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

* feat: render the content inside a modal Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * Changeset file for PR #7938 created/updated * feat: use memory router when opened in modal Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update buttons Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: optimize layout Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: optimize layout Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: vertical scrollbar issue Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update test Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update order Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: update snapshot 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> (cherry picked from commit baccf53) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* feat: render the content inside a modal * Changeset file for PR #7938 created/updated * feat: use memory router when opened in modal * feat: update * feat: update buttons * feat: update * feat: optimize layout * feat: optimize layout * fix: vertical scrollbar issue * feat: update test * feat: update * feat: update * feat: update order * fix: update snapshot --------- (cherry picked from commit baccf53) Signed-off-by: SuZhou-Joe <suzhou@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: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

…t#7938) (opensearch-project#8434) * feat: render the content inside a modal * Changeset file for PR opensearch-project#7938 created/updated * feat: use memory router when opened in modal * feat: update * feat: update buttons * feat: update * feat: optimize layout * feat: optimize layout * fix: vertical scrollbar issue * feat: update test * feat: update * feat: update * feat: update order * fix: update snapshot --------- (cherry picked from commit baccf53) Signed-off-by: SuZhou-Joe <suzhou@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: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

github-actions bot added the distinguished-contributor label Aug 30, 2024

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

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

c9b7174

SuZhou-Joe added backport 2.x v2.17.0 navigation labels Aug 30, 2024

SuZhou-Joe commented Aug 30, 2024

View reviewed changes

src/plugins/dev_tools/public/dev_tools_icon.tsx Show resolved Hide resolved

SuZhou-Joe mentioned this pull request Aug 30, 2024

[navigation] Add default render path when there is basePath opensearch-project/dashboards-query-workbench#381

Closed

6 tasks

TackAdam mentioned this pull request Sep 5, 2024

[Bug] Fix url redirection, add default render path opensearch-project/dashboards-query-workbench#387

Merged

6 tasks

SuZhou-Joe and others added 6 commits September 10, 2024 18:34

feat: render the content inside a modal

89800d1

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

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

f18c322

feat: use memory router when opened in modal

05ece3e

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

feat: update

202e740

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

feat: update buttons

7a8ed67

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

feat: update

f6cdf5d

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

SuZhou-Joe force-pushed the feature/change-devtool-to-modal branch from d26b7cc to f6cdf5d Compare September 10, 2024 10:34

SuZhou-Joe added 2 commits September 10, 2024 19:23

feat: optimize layout

f6d338d

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

feat: optimize layout

9191281

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

SuZhou-Joe removed the v2.17.0 label Sep 12, 2024

SuZhou-Joe added 2 commits September 23, 2024 15:34

feat: update

90c6dc6

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

fix: vertical scrollbar issue

7ca1e95

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

SuZhou-Joe marked this pull request as ready for review September 23, 2024 08:57

SuZhou-Joe requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon and zhongnansu as code owners September 23, 2024 08:57

SuZhou-Joe requested review from virajsanghvi, sejli, joshuali925 and huyaboo as code owners September 23, 2024 08:57

SuZhou-Joe added the 2.17.1 label Sep 23, 2024

SuZhou-Joe added 2 commits September 24, 2024 11:00

Merge branch 'main' into feature/change-devtool-to-modal

0c2b20e

feat: update test

e7abbbb

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

SuZhou-Joe added the workspace label Sep 29, 2024

SuZhou-Joe added 2 commits September 29, 2024 17:13

feat: update

41e54d3

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

feat: merge

06c26d8

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

SuZhou-Joe changed the title ~~feat: render the content inside a modal~~ [navigation] feat: Render dev tools inside a modal Sep 30, 2024

ruanyl previously approved these changes Sep 30, 2024

View reviewed changes

Merge branch 'main' into feature/change-devtool-to-modal

06aabda

Hailong-am reviewed Oct 1, 2024

View reviewed changes

feat: update

8e80783

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

SuZhou-Joe dismissed ruanyl’s stale review via 8e80783 October 1, 2024 07:44

feat: update order

ba6c9f7

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

fix: update snapshot

fcf2c23

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

Hailong-am approved these changes Oct 2, 2024

View reviewed changes

ruanyl approved these changes Oct 2, 2024

View reviewed changes

SuZhou-Joe removed the 2.17.1 label Oct 2, 2024

SuZhou-Joe merged commit baccf53 into opensearch-project:main Oct 2, 2024
67 checks passed

opensearch-trigger-bot bot mentioned this pull request Oct 2, 2024

[Backport 2.x] [navigation] feat: Render dev tools inside a modal #8434

Merged

ananzh added the v2.18.0 label Oct 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[navigation] feat: Render dev tools inside a modal #7938

[navigation] feat: Render dev tools inside a modal #7938

SuZhou-Joe commented Aug 30, 2024 •

edited

Loading

codecov bot commented Aug 30, 2024 •

edited

Loading

ruanyl commented Sep 30, 2024

Hailong-am Oct 1, 2024

SuZhou-Joe Oct 1, 2024

Hailong-am Oct 1, 2024

SuZhou-Joe Oct 1, 2024

Hailong-am commented Oct 1, 2024

SuZhou-Joe commented Oct 1, 2024

[navigation] feat: Render dev tools inside a modal #7938

[navigation] feat: Render dev tools inside a modal #7938

Conversation

SuZhou-Joe commented Aug 30, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

codecov bot commented Aug 30, 2024 • edited Loading

Codecov Report

ruanyl commented Sep 30, 2024

Hailong-am Oct 1, 2024

Choose a reason for hiding this comment

SuZhou-Joe Oct 1, 2024

Choose a reason for hiding this comment

Hailong-am Oct 1, 2024

Choose a reason for hiding this comment

SuZhou-Joe Oct 1, 2024

Choose a reason for hiding this comment

Hailong-am commented Oct 1, 2024

SuZhou-Joe commented Oct 1, 2024

SuZhou-Joe commented Aug 30, 2024 •

edited

Loading

codecov bot commented Aug 30, 2024 •

edited

Loading