feat(#7367): ProgressBar for `ExportAsJSONAction` #7374

ozyx · 2024-01-12T20:01:43Z

Closes #7367
Closes #7380

Describe your changes:

Adds a ProgressBar to asynchronous Export as JSON actions (such as with external persistence i.e. CouchDB).

Also a few refactors and minor fixes:

Updates the URLs for example imagery
Updates LocalStorageProvider to use the actual localStorage api (getItem() and setItem(), etc).
Updates ExportAsJSONAction to use private methods
Refactors out the model prop object in ProgressDialog-- use individual props instead

Screen.Recording.2024-01-12.at.11.58.02.AM.mov

All Submissions:

Have you followed the guidelines in our Contributing document?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?
Is this change backwards compatible? For example, developers won't need to change how they are calling the API or how they've extended core plugins such as Tables or Plots.

Author Checklist

Changes address original issue?
Tests included and/or updated with changes?
Has this been smoke tested?
Have you associated this PR with a type: label? Note: this is not necessarily the same as the original issue.
Have you associated a milestone with this PR? Note: leave blank if unsure.
Is this a breaking change to be called out in the release notes?
Testing instructions included in associated issue OR is this a dependency/testcase change?

Reviewer Checklist

Changes appear to address issue?
Reviewer has tested changes by following the provided instructions?
Changes appear not to be breaking changes?
Appropriate automated tests included?
Code style and in-line documentation are appropriate?

ozyx · 2024-01-12T20:03:05Z

src/plugins/localStorage/LocalStorageObjectProvider.js

@@ -71,14 +71,14 @@ export default class LocalStorageObjectProvider {
   * @private
   */
  persistSpace(space) {
-    this.localStorage[this.spaceKey] = JSON.stringify(space);
+    this.localStorage.setItem(this.spaceKey, JSON.stringify(space));


this is a driveby, but figured we should be using the localStorage API here

deploysentinel · 2024-01-12T20:09:14Z

Current Playwright Test Results Summary

✅ 174 Passing - ❌ 1 Failing - ⚠️ 2 Flaky

Run may still be in progress, this comment will be updated as current testing workflow or job completes...

(Last updated on 01/12/2024 09:34:41pm UTC)

Run Details

Running Job e2e-stable on CircleCI

Commit: 655cb39

Started: 01/12/2024 09:29:00pm UTC

❌ Failures

📄 functional/plugins/plot/logPlot.e2e.spec.js • 1 Failure

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes

Log plot tests Log Plot ticks are functionally correct in regular and log mode and after refresh
Retry 2 • Retry 1 • Initial Attempt

Error: locator.click: Error: strict mode violation: locator('div:nth-child(5) .c-form-r...

locator.click: Error: strict mode violation: locator('div:nth-child(5) .c-form-row__controls .form-control .field input') resolved to 11 elements:
    1) <input name="name" type="text" id="form-name"/> aka getByLabel('Title', { exact: true })
    2) <input type="number" aria-label="Period"/> aka getByLabel('Period')
    3) <input type="number" aria-label="Amplitude"/> aka getByLabel('Amplitude')
    4) <input type="number" aria-label="Offset"/> aka getByLabel('Offset')
    5) <input type="number" aria-label="Data Rate (hz)"/> aka getByLabel('Data Rate (hz)')
    6) <input type="number" aria-label="Phase (radians)"/> aka getByLabel('Phase (radians)')
    7) <input type="number" aria-label="Randomness"/> aka getByLabel('Randomness')
    8) <input type="number" aria-label="Loading Delay (ms)"/> aka getByLabel('Loading Delay (ms)')
    9) <input id="switchId" type="checkbox"/> aka getByRole('checkbox', { name: 'Include Infinity Values' })
    10) <input id="switchId" type="checkbox"/> aka getByRole('checkbox', { name: 'Exceed Float32 Limits' })
    ...

=========================== logs ===========================
waiting for locator('div:nth-child(5) .c-form-row__controls .form-control .field input')
============================================================

2.38% (2)

2 / 84 runs
failed over last 7 days

27.38% (23)

23 / 84 runs
flaked over last 7 days

⚠️ Flakes

📄 functional/plugins/imagery/exampleImagery.e2e.spec.js • 1 Flake

Test Case Results

Test Case	Last 7 days Failures	Last 7 days Flakes
Example Imagery Object Can use Mouse Wheel to zoom in and out of latest image Retry 1 • Initial Attempt	0% (0) 0 / 66 runs failed over last 7 days	28.79% (19) 19 / 66 runs flaked over last 7 days

📄 functional/plugins/plot/overlayPlot.e2e.spec.js • 1 Flake

Test Case Results

Test Case	Last 7 days Failures	Last 7 days Flakes
Overlay Plot Limit lines persist when series is moved to another Y Axis and on refresh Retry 1 • Initial Attempt	4.82% (4) 4 / 83 runs failed over last 7 days	4.82% (4) 4 / 83 runs flaked over last 7 days

View Detailed Build Results

codecov · 2024-01-12T20:10:10Z

Codecov Report

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

Comparison is base (70f5ba9) 55.88% compared to head (b47ceff) 55.89%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #7374      +/-   ##
==========================================
+ Coverage   55.88%   55.89%   +0.01%     
==========================================
  Files         659      659              
  Lines       26247    26278      +31     
  Branches     2550     2550              
==========================================
+ Hits        14667    14687      +20     
- Misses      10872    10882      +10     
- Partials      708      709       +1

Flag	Coverage Δ		*Carryforward flag
e2e-full	`41.24% <ø> (+0.09%)`	⬆️	Carriedforward from ef64b0d
e2e-stable	`58.97% <20.48%> (-0.09%)`	⬇️
unit	`48.91% <88.09%> (+<0.01%)`	⬆️

*This pull request uses carry forward flags. Click here to find out more.

Files	Coverage Δ
example/imagery/plugin.js	`79.66% <ø> (ø)`
src/api/menu/MenuAPI.js	`88.00% <100.00%> (-0.47%)`	⬇️
src/api/overlays/Overlay.js	`94.11% <ø> (-0.33%)`	⬇️
src/api/overlays/OverlayAPI.js	`86.66% <ø> (ø)`
src/api/overlays/ProgressDialog.js	`100.00% <100.00%> (ø)`
src/exporters/CSVExporter.js	`0.00% <ø> (ø)`
src/exporters/ImageExporter.js	`70.21% <ø> (ø)`
src/exporters/JSONExporter.js	`0.00% <ø> (ø)`
...plugins/localStorage/LocalStorageObjectProvider.js	`100.00% <100.00%> (ø)`
...ins/notebook/actions/ExportNotebookAsTextAction.js	`50.00% <ø> (ø)`
... and 3 more

... and 10 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 70f5ba9...b47ceff. Read the comment docs.

unlikelyzero · 2024-01-17T22:02:51Z

e2e/tests/functional/plugins/plot/logPlot.e2e.spec.js

-  await page.locator('div:nth-child(7) .c-form-row__controls .form-control .field input').fill('2');
+  await page.getByLabel('Period').fill('2');
+  await page.getByLabel('Amplitude').fill('6');
+  await page.getByLabel('Offset').fill('4');


lol what were we doing with the old locator pattern

…tItem()`" This reverts commit 4f8403a.

… and `setItem()`"" This reverts commit 0de6640.

scottbell

Good looks good. Example imagery now working:

and JSON exports for CouchDB now have a nifty progress bar:

Screen.Recording.2024-01-18.at.12.17.08.PM.mov

* refactor(ExportAsJSONAction): use private methods * refactor: remove unnecessary webpack alias * refactor: lint * fix: tests for `ExportAsJSONAction` * test: stabilize `InspectorStylesSpec` tests * docs: fix jsdocs * chore: remove dead / redundant code * refactor(LocalStorageObjectProvider): use `getItem()` and `setItem()` * refactor(ExportAsJSONAction): use `Promise.all` where applicable * refactor(MenuAPI): one-liner * feat: add percentage ProgressBar to ExportAsJSONAction * fix(ProgressBar.vue): v-if conditionals * test(fix): update mockLocalStorage * test: fix locators * test: remove unneeded awaits * fix: example imagery urls (moved after NASA wordpress migration) * Revert "refactor(LocalStorageObjectProvider): use `getItem()` and `setItem()`" This reverts commit 4f8403a. * test(e2e): fix logPlot test * Revert "Revert "refactor(LocalStorageObjectProvider): use `getItem()` and `setItem()`"" This reverts commit 0de6640. * test(e2e): remove waitForNavigations

ozyx added the type:enhancement label Jan 12, 2024

ozyx added this to the Target:3.3.0 milestone Jan 12, 2024

ozyx commented Jan 12, 2024

View reviewed changes

ozyx added 13 commits January 17, 2024 11:15

refactor(ExportAsJSONAction): use private methods

68edf79

refactor: remove unnecessary webpack alias

b07a73e

refactor: lint

a0b71f4

fix: tests for ExportAsJSONAction

95ac152

test: stabilize InspectorStylesSpec tests

44fac67

docs: fix jsdocs

81b6b97

chore: remove dead / redundant code

9a1437a

refactor(LocalStorageObjectProvider): use getItem() and setItem()

4f8403a

refactor(ExportAsJSONAction): use Promise.all where applicable

7378351

refactor(MenuAPI): one-liner

201deea

feat: add percentage ProgressBar to ExportAsJSONAction

9f85a0b

fix(ProgressBar.vue): v-if conditionals

975ef25

test(fix): update mockLocalStorage

3a0c975

ozyx force-pushed the mct7367-export-as-json-progress-bar branch from 655cb39 to 3a0c975 Compare January 17, 2024 19:15

ozyx added 3 commits January 17, 2024 12:02

test: fix locators

24b80e3

test: remove unneeded awaits

b88c849

fix: example imagery urls (moved after NASA wordpress migration)

d5b02b0

ozyx requested review from unlikelyzero, scottbell and davetsay January 17, 2024 21:20

ozyx marked this pull request as ready for review January 17, 2024 21:21

unlikelyzero reviewed Jan 17, 2024

View reviewed changes

ozyx added 3 commits January 17, 2024 15:28

Revert "refactor(LocalStorageObjectProvider): use getItem() and `se…

0de6640

…tItem()`" This reverts commit 4f8403a.

test(e2e): fix logPlot test

cb3d408

Revert "Revert "refactor(LocalStorageObjectProvider): use getItem()…

ef64b0d

… and `setItem()`"" This reverts commit 0de6640.

test(e2e): remove waitForNavigations

b47ceff

ozyx added the pr:e2e:couchdb npm run test:e2e:couchdb label Jan 18, 2024

github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Jan 18, 2024

unlikelyzero modified the milestones: Target:3.3.0, Target:4.0.0 Jan 18, 2024

scottbell mentioned this pull request Jan 18, 2024

Provide renderWhenVisible to LadTableSets #7384

Merged

15 tasks

scottbell approved these changes Jan 18, 2024

View reviewed changes

scottbell merged commit 01434ff into master Jan 18, 2024
37 of 39 checks passed

scottbell deleted the mct7367-export-as-json-progress-bar branch January 18, 2024 11:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(#7367): ProgressBar for `ExportAsJSONAction` #7374

feat(#7367): ProgressBar for `ExportAsJSONAction` #7374

ozyx commented Jan 12, 2024 •

edited by scottbell

Loading

ozyx Jan 12, 2024

deploysentinel bot commented Jan 12, 2024 •

edited

Loading

Test Case Results

Test Case Results

Test Case Results

codecov bot commented Jan 12, 2024 •

edited

Loading

unlikelyzero Jan 17, 2024 •

edited

Loading

scottbell left a comment

feat(#7367): ProgressBar for ExportAsJSONAction #7374

feat(#7367): ProgressBar for ExportAsJSONAction #7374

Conversation

ozyx commented Jan 12, 2024 • edited by scottbell Loading

Describe your changes:

All Submissions:

Author Checklist

Reviewer Checklist

ozyx Jan 12, 2024

Choose a reason for hiding this comment

deploysentinel bot commented Jan 12, 2024 • edited Loading

Current Playwright Test Results Summary

❌ Failures

Test Case Results

⚠️ Flakes

Test Case Results

Test Case Results

codecov bot commented Jan 12, 2024 • edited Loading

Codecov Report

unlikelyzero Jan 17, 2024 • edited Loading

Choose a reason for hiding this comment

scottbell left a comment

Choose a reason for hiding this comment

feat(#7367): ProgressBar for `ExportAsJSONAction` #7374

feat(#7367): ProgressBar for `ExportAsJSONAction` #7374

ozyx commented Jan 12, 2024 •

edited by scottbell

Loading

deploysentinel bot commented Jan 12, 2024 •

edited

Loading

codecov bot commented Jan 12, 2024 •

edited

Loading

unlikelyzero Jan 17, 2024 •

edited

Loading