Feature: Dev Tools Query Export/Import #3810

kishor82 · 2023-04-08T18:47:46Z

Description

Add support for exporting and restoring the history of commands in Dev Tools #3767

Screenshot

Screen.Recording.2023-09-07.at.6.37.35.PM.mov

Check List

joshuarrrr · 2023-04-10T16:36:54Z

@kishor82 Thanks! I see this involves some new UI changes. To help our UX designers review those flows, can you please add some screenshots or screencasts that demo the new feature?

codecov-commenter · 2023-04-10T18:00:46Z

Codecov Report

Merging #3810 (680fca8) into main (43fe5d5) will increase coverage by 0.04%.
The diff coverage is 92.70%.

@@            Coverage Diff             @@
##             main    #3810      +/-   ##
==========================================
+ Coverage   66.45%   66.49%   +0.04%     
==========================================
  Files        3399     3402       +3     
  Lines       64915    65011      +96     
  Branches    10387    10401      +14     
==========================================
+ Hits        43141    43232      +91     
- Misses      19210    19211       +1     
- Partials     2564     2568       +4

Flag	Coverage Δ
Linux_1	`34.80% <ø> (ø)`
Linux_2	`55.31% <ø> (ø)`
Linux_3	`44.61% <92.70%> (+0.14%)`	⬆️
Linux_4	`34.89% <ø> (ø)`
Windows_1	`34.81% <ø> (ø)`
Windows_2	`55.27% <ø> (ø)`
Windows_3	`44.61% <92.70%> (+0.13%)`	⬆️
Windows_4	`34.89% <ø> (ø)`

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

Files Changed	Coverage Δ
...blic/application/contexts/services_context.mock.ts	`100.00% <ø> (ø)`
...e/public/application/contexts/services_context.tsx	`77.77% <ø> (ø)`
...lic/application/components/import_mode_control.tsx	`92.30% <92.30%> (ø)`
...le/public/application/components/import_flyout.tsx	`92.50% <92.50%> (ø)`
.../public/application/components/overwrite_modal.tsx	`100.00% <100.00%> (ø)`
...c/application/hooks/use_data_init/use_data_init.ts	`8.00% <100.00%> (+3.83%)`	⬆️

... and 1 file with indirect coverage changes

kishor82 · 2023-04-10T21:19:16Z

@joshuarrrr Please let me know if you have any further feedback or suggestions. Thank you for taking the time to review my work.

dev-tool.mp4

joshuarrrr · 2023-04-13T00:45:53Z

@KrooshalUX or @kgcreative can you review the new UI in the screencast above?

kgcreative · 2023-04-17T22:17:33Z

LGTM - @KrooshalUX -- any recommendations or concerns?

kishor82 · 2023-09-07T20:14:47Z

@ashwin-pc, the link checker step is failing for my PR, and I'm not sure what's causing it to fail. Can you help me troubleshoot this issue?

kishor82 · 2023-09-07T20:27:12Z

@ashwin-pc, the link checker step is failing for my PR, and I'm not sure what's causing it to fail. Can you help me troubleshoot this issue?

Ohh, I think it's failing because https://www.circl.lu/doc/misp/ is not reachable right now.

ashwin-pc

Really nice job with the PR. The changes look good to me and nice coverage with tests. The only real concern i had is with the name of the export but that can be addressed in a followup PR too.

Note: I'd suggest adding a screen recording or screenshots in future PR's to speed up the review proces since without them I ususally have to pull down the change and validate the change myself. Tagging @kgcreative to take a look at the UX changes from this PR, just to make sure there arent any issues with the new UX.

ashwin-pc · 2023-09-08T01:07:17Z

src/plugins/console/public/application/containers/main/main.tsx

+    const results = await objectStorageClient.text.findAll();
+    const senseData = results.sort((a, b) => a.createdAt - b.createdAt)[0];
+    const blob = new Blob([JSON.stringify(senseData || {})], { type: 'application/json' });
+    saveAs(blob, 'sense.json');


Why is this named sense.json?

At the time, no other name really came to mind, and I had a good experience with the 'Sense' Chrome extension for Elasticsearch queries, so I went with 'sense.json'! 😄

ashwin-pc · 2023-09-08T01:28:37Z

src/plugins/console/public/application/components/overwrite_modal.test.tsx

+
+  it('should call onConfirm when clicking the "Overwrite" button', () => {
+    act(() => {
+      // @ts-ignore


nit: Why the ts-ignore?

I saw a similar test in an existing plugin that used @ts-ignore. I tried various approaches but couldn't get it to work, so I added @ts-ignore. I'll keep trying to fix it.

kgcreative · 2023-09-08T16:01:49Z

LGTM! I would eventually love to be able to save this as a local view, or as a saved object (similar to a discover saved search) -- but I think for now this works!

ashwin-pc · 2023-09-08T16:24:33Z

@kishor82 I wouldn't worry about the link checker since it's unrelated to your change and is something thats probably already fixed in main by now.

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

…zyme test suites. Signed-off-by: kishor82 <[email protected]>

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

…ations Signed-off-by: kishor82 <[email protected]>

* feat: Add export functionality for dev tool queries Signed-off-by: kishor82 <[email protected]> * feat: Add import functionality for dev tool queries Signed-off-by: kishor82 <[email protected]> * update: changelog. Signed-off-by: kishor82 <[email protected]> * feat: updated license headers for new file. Signed-off-by: kishor82 <[email protected]> * fix: typo:ImportFlyout and removed ImportModeControl prop (isLegacyFile) Signed-off-by: kishor82 <[email protected]> * fix: default query export Signed-off-by: kishor82 <[email protected]> * fix: added basic text validation for imported file. Signed-off-by: kishor82 <[email protected]> * update: removed legacy variable export. Signed-off-by: kishor82 <[email protected]> * test: Add unit tests for OverwriteModal component Signed-off-by: kishor82 <[email protected]> * test: Add unit tests for ImportModeControl component Signed-off-by: kishor82 <[email protected]> * test: Add unit tests for ImportFlyout component Signed-off-by: kishor82 <[email protected]> * test: updated unit tests for ImportFlyout component Signed-off-by: kishor82 <[email protected]> * test: Enhance async operation handling and complete async cycle in Enzyme test suites. Signed-off-by: kishor82 <[email protected]> * test: Enhanced test coverage for ImportFlyout component unit tests Signed-off-by: kishor82 <[email protected]> * fix: Add 'http' property to serviceContextMock and update test expectations Signed-off-by: kishor82 <[email protected]> --------- Signed-off-by: kishor82 <[email protected]> (cherry picked from commit 56dd85b) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* feat: Add export functionality for dev tool queries * feat: Add import functionality for dev tool queries * update: changelog. * feat: updated license headers for new file. * fix: typo:ImportFlyout and removed ImportModeControl prop (isLegacyFile) * fix: default query export * fix: added basic text validation for imported file. * update: removed legacy variable export. * test: Add unit tests for OverwriteModal component * test: Add unit tests for ImportModeControl component * test: Add unit tests for ImportFlyout component * test: updated unit tests for ImportFlyout component * test: Enhance async operation handling and complete async cycle in Enzyme test suites. * test: Enhanced test coverage for ImportFlyout component unit tests * fix: Add 'http' property to serviceContextMock and update test expectations --------- (cherry picked from commit 56dd85b) Signed-off-by: kishor82 <[email protected]> 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>

kishor82 requested a review from a team as a code owner April 8, 2023 18:47

github-actions bot added the first-time-contributor label Apr 8, 2023

kishor82 mentioned this pull request Apr 8, 2023

Add support for exporting and restoring the history of commands in Dev Tools #3767

Open

kishor82 force-pushed the feature/console-query-export branch from 460c061 to 5f90ef5 Compare April 11, 2023 05:33

joshuarrrr added the ux / ui Improvements or additions to user experience, flows, components, UI elements label Apr 13, 2023

kishor82 force-pushed the feature/console-query-export branch from 5f90ef5 to f132c60 Compare April 13, 2023 05:30

kishor82 requested review from ananzh, kavilla, seanneumann, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, kristenTian, zhongnansu and manasvinibs as code owners April 13, 2023 05:30

kishor82 force-pushed the feature/console-query-export branch from f132c60 to 8e08282 Compare April 14, 2023 16:55

joshuarrrr assigned zhongnansu Apr 14, 2023

kishor82 force-pushed the feature/console-query-export branch 2 times, most recently from e4a357f to 1a6b993 Compare April 17, 2023 21:18

kishor82 force-pushed the feature/console-query-export branch 4 times, most recently from 938c365 to 89aa76a Compare April 20, 2023 17:59

ashwin-pc approved these changes Sep 8, 2023

View reviewed changes

kishor82 added 15 commits September 8, 2023 23:50

feat: Add export functionality for dev tool queries

2547f26

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

feat: Add import functionality for dev tool queries

9322883

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

update: changelog.

8a7774c

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

feat: updated license headers for new file.

b329a00

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

fix: typo:ImportFlyout and removed ImportModeControl prop (isLegacyFile)

38fe226

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

fix: default query export

e5e01d3

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

fix: added basic text validation for imported file.

1994c86

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

update: removed legacy variable export.

cecaf67

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

test: Add unit tests for OverwriteModal component

9b4bc14

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

test: Add unit tests for ImportModeControl component

7079533

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

test: Add unit tests for ImportFlyout component

301f16a

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

test: updated unit tests for ImportFlyout component

9274d87

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

test: Enhance async operation handling and complete async cycle in En…

69013eb

…zyme test suites. Signed-off-by: kishor82 <[email protected]>

test: Enhanced test coverage for ImportFlyout component unit tests

3530df8

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

fix: Add 'http' property to serviceContextMock and update test expect…

680fca8

…ations Signed-off-by: kishor82 <[email protected]>

kishor82 force-pushed the feature/console-query-export branch from 00698cc to 680fca8 Compare September 8, 2023 18:20

zhongnansu approved these changes Sep 8, 2023

View reviewed changes

manasvinibs merged commit 56dd85b into opensearch-project:main Sep 11, 2023
106 checks passed

manasvinibs added the backport 2.10 label Sep 11, 2023

This was referenced Sep 11, 2023

[Backport 2.x] Feature: Dev Tools Query Export/Import #4986

Merged

[Backport 2.10] Feature: Dev Tools Query Export/Import #4987

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Dev Tools Query Export/Import #3810

Feature: Dev Tools Query Export/Import #3810

kishor82 commented Apr 8, 2023 •

edited by ashwin-pc

Loading

joshuarrrr commented Apr 10, 2023

codecov-commenter commented Apr 10, 2023 •

edited by codecov bot

Loading

kishor82 commented Apr 10, 2023

joshuarrrr commented Apr 13, 2023

kgcreative commented Apr 17, 2023

kishor82 commented Sep 7, 2023

kishor82 commented Sep 7, 2023

ashwin-pc left a comment

ashwin-pc Sep 8, 2023

kishor82 Sep 8, 2023

ashwin-pc Sep 8, 2023

kishor82 Sep 8, 2023

kgcreative commented Sep 8, 2023

ashwin-pc commented Sep 8, 2023

Feature: Dev Tools Query Export/Import #3810

Feature: Dev Tools Query Export/Import #3810

Conversation

kishor82 commented Apr 8, 2023 • edited by ashwin-pc Loading

Description

Screenshot

Check List

joshuarrrr commented Apr 10, 2023

codecov-commenter commented Apr 10, 2023 • edited by codecov bot Loading

Codecov Report

kishor82 commented Apr 10, 2023

joshuarrrr commented Apr 13, 2023

kgcreative commented Apr 17, 2023

kishor82 commented Sep 7, 2023

kishor82 commented Sep 7, 2023

ashwin-pc left a comment

Choose a reason for hiding this comment

ashwin-pc Sep 8, 2023

Choose a reason for hiding this comment

kishor82 Sep 8, 2023

Choose a reason for hiding this comment

ashwin-pc Sep 8, 2023

Choose a reason for hiding this comment

kishor82 Sep 8, 2023

Choose a reason for hiding this comment

kgcreative commented Sep 8, 2023

ashwin-pc commented Sep 8, 2023

kishor82 commented Apr 8, 2023 •

edited by ashwin-pc

Loading

codecov-commenter commented Apr 10, 2023 •

edited by codecov bot

Loading