feat(explore): Replace overlay with alert banner when chart controls change #19696

kgabryje · 2022-04-13T17:48:46Z

SUMMARY

Before, when user made some changes to controls, we displayed an overlay with "Run query" button. This PR removes that overlay and introduces an alert banner that tells the user that some controls have changed and that they should click "Update chart" button. Thanks to that, the user can still view their chart while doing changes to controls.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Screen.Recording.2022-04-13.at.18.50.32.mov

TESTING INSTRUCTIONS

Create a chart
Do some changes in controls and verify that an alert banner showed up.
After clicking "Update chart" the banner should disappear.
When banner is visible, the chart should still respond to events that trigger rerendering, such as changing the width of browser window.

ADDITIONAL INFORMATION

Has associated issue:
Required feature flags:
Changes UI
Includes DB Migration (follow approval process in SIP-59)
- Migration is atomic, supports rollback & is backwards-compatible
- Confirm DB migration upgrade and downgrade tested
- Runtime estimates and downtime expectations provided
Introduces new feature or API
Removes existing feature or API

CC @kasiazjc

kgabryje · 2022-04-13T17:51:56Z

superset-frontend/src/explore/components/ExploreAlert.tsx

@@ -0,0 +1,127 @@
+/**


This is ControlPanelAlert, just renamed. No need to review this file

codecov · 2022-04-13T18:38:21Z

Codecov Report

Merging #19696 (112c4d8) into master (594523e) will increase coverage by 0.01%.
The diff coverage is 61.90%.

@@            Coverage Diff             @@
##           master   #19696      +/-   ##
==========================================
+ Coverage   66.49%   66.51%   +0.01%     
==========================================
  Files        1689     1690       +1     
  Lines       64614    64616       +2     
  Branches     6650     6656       +6     
==========================================
+ Hits        42966    42978      +12     
+ Misses      19947    19937      -10     
  Partials     1701     1701

Flag	Coverage Δ
javascript	`51.19% <61.90%> (+0.03%)`	⬆️

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

Impacted Files	Coverage Δ
superset-frontend/src/components/Chart/Chart.jsx	`52.54% <0.00%> (+2.54%)`	⬆️
.../src/explore/components/ControlPanelsContainer.tsx	`79.80% <ø> (ø)`
.../explore/components/ExploreViewContainer/index.jsx	`52.29% <10.00%> (-0.61%)`	⬇️
...t-frontend/src/explore/components/ExploreAlert.tsx	`58.33% <58.33%> (ø)`
.../src/utils/getChartRequiredFieldsMissingMessage.ts	`66.66% <66.66%> (ø)`
...et-frontend/src/components/Chart/ChartRenderer.jsx	`54.23% <100.00%> (+1.60%)`	⬆️
...ntend/src/explore/components/ExploreChartPanel.jsx	`71.66% <100.00%> (+3.14%)`	⬆️
...rc/explore/controlUtils/getFormDataFromControls.ts	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

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

kgabryje · 2022-04-14T11:25:51Z

/testenv up

github-actions · 2022-04-14T11:51:27Z

@kgabryje Ephemeral environment spinning up at http://54.200.67.72:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

jinghua-qa · 2022-04-16T05:18:39Z

tested PR locally, did not find major issue, LGTM

villebro

LGTM! A few minor comments, but overall I think this is a great improvement! Also, thanks for the cleanup, this change again leaves the codebase slightly more readable and performant 👍

villebro · 2022-04-19T06:29:13Z

superset-frontend/src/components/Chart/Chart.jsx

+  ? t(
+      'Drag and drop values into highlighted field(s) in the control panel. Then run the query by clicking on the "Create chart" button.',
+    )
+  : t(
+      'Select values in highlighted field(s) in the control panel. Then run the query by clicking on the "Create chart" button.',
+    );


Not something you're changing here, but to get rid of a ternary, I wonder if we couldn't get away with just one message here. As the current default supports both dragging and dropping and clicking on the ghost button, the "Select values in highlighted field(s) in the control panel" message could IMO be an ok message for both DnD and non-DnD scenarios.

Sounds good 👍

villebro · 2022-04-19T06:35:31Z

superset-frontend/src/components/Chart/Chart.jsx

      queriesResponse = [],
      isDeactivatedViz = false,
      width,
    } = this.props;

    const isLoading = chartStatus === 'loading';
-    const isFaded = refreshOverlayVisible && !errorMessage;
+    const isFaded = chartIsStale && !errorMessage;


As we're no longer fading, this variable should probably be renamed

villebro · 2022-04-19T06:57:20Z

superset-frontend/src/explore/components/ExploreChartPanel.jsx

+  ? t(
+      'Drag and drop values into highlighted field(s) in the control panel. Then run the query by clicking on the "Update chart" button.',
+    )
+  : t(
+      'Select values in highlighted field(s) in the control panel. Then run the query by clicking on the "Update chart" button.',
+    );


As this is identical to the text in src/components/Chart/Chart.tsx, we should perhaps consider placing these strings in a constants.ts to ensure they stay the same (otherwise someone might only update one but not the other).

Not exactly identical - the other one says "Create chart", this one "Update chart". Though we should probably make it more generic, like move to a function with argument isCreating or isUpdating

github-actions · 2022-04-19T12:57:31Z

Ephemeral environment shutdown and build artifacts deleted.

…change (apache#19696) * Rename explore alert * Rename refreshOverlayVisible to chartIsStale * Implement banners * Add tests * Add clickable text to empty state * Fix viz type switching * styling changes * Fixes after rebasing * Code review fixes * Fix bug * Fix redundant refreshing

kgabryje requested review from zhaoyongjie, villebro, geido and michael-s-molina April 13, 2022 17:48

pull-request-size bot added the size/XL label Apr 13, 2022

kgabryje commented Apr 13, 2022

View reviewed changes

kgabryje added the need:qa-review Requires QA review label Apr 14, 2022

kgabryje force-pushed the feat/chart-alert-banner branch from d6a2e0b to 35bc351 Compare April 14, 2022 20:13

villebro approved these changes Apr 19, 2022

View reviewed changes

kgabryje added 9 commits April 19, 2022 10:11

Rename explore alert

092dedd

Rename refreshOverlayVisible to chartIsStale

aa115f1

Implement banners

f405fb7

Add tests

aa1b987

Add clickable text to empty state

0a31a6c

Fix viz type switching

e71d5fa

styling changes

f41cb2d

Fixes after rebasing

a50e0f0

Code review fixes

7114545

kgabryje force-pushed the feat/chart-alert-banner branch from 35bc351 to 7114545 Compare April 19, 2022 08:47

kgabryje added 2 commits April 19, 2022 12:55

Fix bug

1a92694

Fix redundant refreshing

112c4d8

kgabryje merged commit 6f4480a into apache:master Apr 19, 2022

mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 2.0.0 labels Mar 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(explore): Replace overlay with alert banner when chart controls change #19696

feat(explore): Replace overlay with alert banner when chart controls change #19696

kgabryje commented Apr 13, 2022 •

edited

kgabryje Apr 13, 2022

codecov bot commented Apr 13, 2022 •

edited

kgabryje commented Apr 14, 2022

github-actions bot commented Apr 14, 2022

jinghua-qa commented Apr 16, 2022

villebro left a comment

villebro Apr 19, 2022

kgabryje Apr 19, 2022

villebro Apr 19, 2022

villebro Apr 19, 2022

kgabryje Apr 19, 2022

github-actions bot commented Apr 19, 2022

feat(explore): Replace overlay with alert banner when chart controls change #19696

feat(explore): Replace overlay with alert banner when chart controls change #19696

Conversation

kgabryje commented Apr 13, 2022 • edited

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

kgabryje Apr 13, 2022

Choose a reason for hiding this comment

codecov bot commented Apr 13, 2022 • edited

Codecov Report

kgabryje commented Apr 14, 2022

github-actions bot commented Apr 14, 2022

jinghua-qa commented Apr 16, 2022

villebro left a comment

Choose a reason for hiding this comment

villebro Apr 19, 2022

Choose a reason for hiding this comment

kgabryje Apr 19, 2022

Choose a reason for hiding this comment

villebro Apr 19, 2022

Choose a reason for hiding this comment

villebro Apr 19, 2022

Choose a reason for hiding this comment

kgabryje Apr 19, 2022

Choose a reason for hiding this comment

github-actions bot commented Apr 19, 2022

kgabryje commented Apr 13, 2022 •

edited

codecov bot commented Apr 13, 2022 •

edited