fix: should be able to remove selection from X-AXIS control #21371

zhaoyongjie · 2022-09-08T08:45:28Z

SUMMARY

Should be able to remove a column from X-AXIS control, since the x-axis control has supported categorical or date columns.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Before

remove.axis.before.mov

After

should.be.able.to.remove.selection.column.from.x-axis.mov

TESTING INSTRUCTIONS

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

codecov · 2022-09-08T10:32:27Z

Codecov Report

Merging #21371 (3bec298) into master (9c285da) will increase coverage by 0.03%.
The diff coverage is 35.71%.

❗ Current head 3bec298 differs from pull request most recent head e1098bb. Consider uploading reports for the commit e1098bb to get more accurate results

@@            Coverage Diff             @@
##           master   #21371      +/-   ##
==========================================
+ Coverage   66.53%   66.57%   +0.03%     
==========================================
  Files        1791     1791              
  Lines       68599    68559      -40     
  Branches     7320     7319       -1     
==========================================
- Hits        45645    45644       -1     
+ Misses      21064    21021      -43     
- Partials     1890     1894       +4

Flag	Coverage Δ
javascript	`52.73% <35.71%> (-0.02%)`	⬇️

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

Impacted Files	Coverage Δ
...d/packages/superset-ui-chart-controls/src/types.ts	`100.00% <ø> (ø)`
...ontend/src/explore/controlUtils/getControlState.ts	`80.32% <28.57%> (-10.42%)`	⬇️
...i-chart-controls/src/shared-controls/constants.tsx	`33.33% <42.85%> (+14.58%)`	⬆️
.../explore/components/controls/TextControl/index.tsx	`76.66% <0.00%> (-10.00%)`	⬇️
...ntend/src/explore/components/ExploreChartPanel.jsx	`67.60% <0.00%> (-4.02%)`	⬇️
...plore/components/DataTablesPane/DataTablesPane.tsx	`78.04% <0.00%> (-2.44%)`	⬇️
superset/explore/commands/get.py	`89.65% <0.00%> (-2.30%)`	⬇️
.../src/explore/components/controls/SelectControl.jsx	`62.50% <0.00%> (-1.79%)`	⬇️
...ontrols/AnnotationLayerControl/AnnotationLayer.jsx	`74.25% <0.00%> (-0.60%)`	⬇️
... and 15 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

villebro

I left a few comments. I think the important thing to test is to ensure that a chart that has been created before the flag was enabled still renders correctly (=with the x-axis control being set to the temporal column)

superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/constants.tsx

villebro · 2022-09-08T12:39:21Z

superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/constants.tsx

-    // default to the chosen time column if x-axis is unset and the
-    // GENERIC_CHART_AXES feature flag is enabled
-    const { value } = control;
-    if (value) {
-      return value;
-    }
-    const timeColumn = controlPanel?.form_data?.granularity_sqla;
-    if (isFeatureEnabled(FeatureFlag.GENERIC_CHART_AXES) && timeColumn) {
-      return timeColumn;
-    }
-    return null;
-  },


IIRC, this logic was added so that charts that were created when the GENERIC_CHART_AXES FF was unset would render correctly when exploring them after the GENERIC_CHART_AXES FF was enabled. Otherwise it would open Explor and clear the chart due to the required x_axis control being unset. So the flow should be something like this:

When entering Explore with FF disabled, nothing should happen (x_axis should be null)

When entering Explore with the FF enabled and the x_axis value is unset, the value should be set to the temporal column

When entering Explore with the FF enabled and the x_axis value is set, it should not be changed

The X-Axis control value should be set instead of setting the default value because if the default value had been set, the X-Axis control wouldn't have chance to remove it(the X-AXIS always sets a default value). Let me find a way to set the X-Axis as the sqla_grainularity if GENERIC_CHART_AXES is enabled.

Hi @villebro, I have added a new property for controls, initialValue. It refers to how to initialize a control when loading, this setting avoids the default value always set to the control.

I also tested charts between FF enabled and disabled.

Create a Bar Chart V2 when GENERIC_CHART_AXES is disabled, and then create a dashboard and take the chart.

Open the GENERIC_CHART_AXES

the Chart on the Explore page and Dashboard same as the disabled FF.

Hi @villebro, I have added a new property for controls, initialValue. It refers to how to initialize a control when loading, this setting avoids the default value always set to the control.

This is a really useful addition 👍 I'm sure this will be needed in the future at some point.

zhaoyongjie · 2022-09-13T07:27:24Z

/testenv up

github-actions · 2022-09-13T07:30:24Z

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

villebro

LGTM and tested to work as expected 👍

villebro · 2022-09-13T12:07:33Z

superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/constants.tsx

-    // default to the chosen time column if x-axis is unset and the
-    // GENERIC_CHART_AXES feature flag is enabled
-    const { value } = control;
-    if (value) {
-      return value;
-    }
-    const timeColumn = controlPanel?.form_data?.granularity_sqla;
-    if (isFeatureEnabled(FeatureFlag.GENERIC_CHART_AXES) && timeColumn) {
-      return timeColumn;
-    }
-    return null;
-  },


Hi @villebro, I have added a new property for controls, initialValue. It refers to how to initialize a control when loading, this setting avoids the default value always set to the control.

This is a really useful addition 👍 I'm sure this will be needed in the future at some point.

github-actions · 2022-09-13T13:05:36Z

Ephemeral environment shutdown and build artifacts deleted.

pull-request-size bot added the size/M label Sep 8, 2022

zhaoyongjie requested review from stephenLYZ and villebro September 8, 2022 08:57

villebro reviewed Sep 8, 2022

View reviewed changes

zhaoyongjie changed the title ~~fix: should be able to remove selection from X-AXIS control~~ [WIP]fix: should be able to remove selection from X-AXIS control Sep 9, 2022

zhaoyongjie changed the title ~~[WIP]fix: should be able to remove selection from X-AXIS control~~ fix: should be able to remove selection from X-AXIS control Sep 9, 2022

pull-request-size bot added size/L and removed size/M labels Sep 11, 2022

zhaoyongjie force-pushed the fix/remove_xaxis branch from afde2bd to b7df283 Compare September 13, 2022 03:17

fix: should be able to remove selection in X-AXIS control

e1098bb

zhaoyongjie force-pushed the fix/remove_xaxis branch from b7df283 to e1098bb Compare September 13, 2022 06:25

pull-request-size bot added size/M and removed size/L labels Sep 13, 2022

villebro approved these changes Sep 13, 2022

View reviewed changes

zhaoyongjie merged commit eb4ba5b into apache:master Sep 13, 2022

mistercrunch added the 🚢 2.1.3 label Feb 18, 2024

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: should be able to remove selection from X-AXIS control #21371

fix: should be able to remove selection from X-AXIS control #21371

zhaoyongjie commented Sep 8, 2022 •

edited

codecov bot commented Sep 8, 2022 •

edited

villebro left a comment

villebro Sep 8, 2022 •

edited

zhaoyongjie Sep 9, 2022

zhaoyongjie Sep 13, 2022

villebro Sep 13, 2022

zhaoyongjie commented Sep 13, 2022

github-actions bot commented Sep 13, 2022

villebro left a comment

villebro Sep 13, 2022

github-actions bot commented Sep 13, 2022

fix: should be able to remove selection from X-AXIS control #21371

fix: should be able to remove selection from X-AXIS control #21371

Conversation

zhaoyongjie commented Sep 8, 2022 • edited

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Before

After

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

codecov bot commented Sep 8, 2022 • edited

Codecov Report

villebro left a comment

Choose a reason for hiding this comment

villebro Sep 8, 2022 • edited

Choose a reason for hiding this comment

zhaoyongjie Sep 9, 2022

Choose a reason for hiding this comment

zhaoyongjie Sep 13, 2022

Choose a reason for hiding this comment

villebro Sep 13, 2022

Choose a reason for hiding this comment

zhaoyongjie commented Sep 13, 2022

github-actions bot commented Sep 13, 2022

villebro left a comment

Choose a reason for hiding this comment

villebro Sep 13, 2022

Choose a reason for hiding this comment

github-actions bot commented Sep 13, 2022

zhaoyongjie commented Sep 8, 2022 •

edited

codecov bot commented Sep 8, 2022 •

edited

villebro Sep 8, 2022 •

edited