feat: Migrates Area chart by michael-s-molina · Pull Request #23870 · apache/superset

michael-s-molina · 2023-04-28T18:43:42Z

SUMMARY

This PR migrates the Area chart to the ECharts version.

Removes the legacy Area chart code and unregisters the plugin.
Removes old plugin references throughout the codebase
Updates unit tests
Updates E2E tests
Updates the example dashboards
Updates translation files

Note a previous migration existed however the legacy chart wasn't removed and thus new legacy Area charts could have been created.

AFTER SCREENSHOT

TESTING INSTRUCTIONS

1 - Make sure all Area (legacy) charts were converted to the ECharts version
2 - Make sure Area (legacy) is not available anymore in the viz picker
3 - Make sure that it's possible to revert the migration by executing superset db downgrade and reverting this PR

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 · 2023-05-01T17:30:16Z

Codecov Report

Merging #23870 (d31f6e7) into master (7891cea) will increase coverage by 0.00%.
The diff coverage is 90.47%.

❗ Current head d31f6e7 differs from pull request most recent head 0d4824c. Consider uploading reports for the commit 0d4824c to get more accurate results

@@           Coverage Diff           @@
##           master   #23870   +/-   ##
=======================================
  Coverage   68.28%   68.29%           
=======================================
  Files        1955     1953    -2     
  Lines       75493    75499    +6     
  Branches     8220     8220           
=======================================
+ Hits        51553    51562    +9     
+ Misses      21833    21830    -3     
  Partials     2107     2107

Flag	Coverage Δ
hive	`53.32% <10.00%> (-0.03%)`	⬇️
javascript	`54.68% <0.00%> (-0.01%)`	⬇️
mysql	`78.97% <95.00%> (+0.01%)`	⬆️
postgres	`79.04% <95.00%> (+0.01%)`	⬆️
presto	`53.24% <10.00%> (-0.03%)`	⬇️
python	`82.86% <95.00%> (+0.01%)`	⬆️
sqlite	`77.58% <95.00%> (+0.01%)`	⬆️
unit	`53.35% <0.00%> (-0.03%)`	⬇️

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

Impacted Files	Coverage Δ
...nd/plugins/legacy-preset-chart-nvd3/src/NVD3Vis.js	`0.00% <ø> (ø)`
...end/plugins/legacy-preset-chart-nvd3/src/preset.js	`0.00% <ø> (ø)`
...gin-chart-echarts/src/Timeseries/transformProps.ts	`57.75% <0.00%> (ø)`
...ponents/controls/VizTypeControl/VizTypeGallery.tsx	`88.23% <ø> (ø)`
...-frontend/src/visualizations/presets/MainPreset.js	`100.00% <ø> (ø)`
superset/examples/birth_names.py	`70.00% <ø> (ø)`
superset/examples/world_bank.py	`31.57% <ø> (ø)`
superset/viz.py	`61.29% <ø> (-0.11%)`	⬇️
...perset/migrations/shared/migrate_viz/processors.py	`97.29% <95.00%> (-2.71%)`	⬇️

... and 1 file with indirect coverage changes

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

john-bodley · 2023-05-22T22:58:43Z

    remove_keys = {"contribution", "stacked_style", "x_axis_label"}
+    rename_keys = {
+        "x_axis_label": "x_axis_title",
+        "x_axis_format": "x_axis_time_format",


I'm surprised this has the term time in it given that I thought part of the broader EChart migration was to support time agnostic, i.e., generic, charts.

I find that weird too. After we migrate the legacy charts and find ourselves in a more consolidated state, we should have another round to polish the form data to rename/remove some keys.

john-bodley · 2023-05-22T22:59:18Z

+    rename_keys = {
+        "x_axis_label": "x_axis_title",
+        "x_axis_format": "x_axis_time_format",
+        "x_ticks_layout": "xAxisLabelRotation",


Why is there a mix of snake- and camel-case keys?

Because the controls were defined using non-standard nomenclature 😢

john-bodley · 2023-05-22T23:00:58Z

-        if self.data.get("contribution"):
-            self.data["contributionMode"] = "row"
+        if contribution := self.data.get("contribution"):
+            self.data["contributionMode"] = "row" if contribution else None


Given, per line #48, contribution is truthy this should reduce to:

if self.data.get("contribution"): self.data["contributionMode"] = "row"

This code will be inherited from the base TimeseriesChart that was created in the Line migration. I will rebase this PR on top of that one.

john-bodley · 2023-05-22T23:02:12Z

+            self.data["contributionMode"] = "row" if contribution else None
+
+        show_brush = self.data.get("show_brush")
+        self.data["zoomable"] = False if show_brush == "no" else True


Suggested change

self.data["zoomable"] = False if show_brush == "no" else True

self.data["zoomable"] = not self.data.get("show_brush") == "no"

This code will be inherited from the base TimeseriesChart that was created in the Line migration. I will rebase this PR on top of that one.

john-bodley · 2023-05-22T23:03:17Z

-            self.data["x_axis_title"] = x_axis_label
-            self.data["x_axis_title_margin"] = 30
+        if x_ticks_layout := self.data.get("x_ticks_layout"):
+            self.data["x_ticks_layout"] = 45 if x_ticks_layout == "45°" else 0


Is 0 akin to None or undefined? If so there's probably no need to set it.

No. It should be a number to match the type definition.

john-bodley · 2023-05-22T23:14:28Z

+        self.data["opacity"] = 0.7
+
+        if rolling_type := self.data.get("rolling_type"):
+            self.data["rolling_type"] = None if rolling_type == "None" else rolling_type


See https://github.com/apache/superset/pull/23973/files#r1201214384.

This code will be inherited from the base TimeseriesChart that was created in the Line migration. I will rebase this PR on top of that one.

john-bodley · 2023-05-22T23:16:27Z

+        x_axis_label = self.data.get("x_axis_label")
+        bottom_margin = self.data.get("bottom_margin")
+        if x_axis_label and (not bottom_margin or bottom_margin == "auto"):
+            self.data["bottom_margin"] = 30


See https://github.com/apache/superset/pull/23973/files#r1201287181.

This code will be inherited from the base TimeseriesChart that was created in the Line migration. I will rebase this PR on top of that one.

john-bodley · 2023-05-22T23:17:44Z

+
+        x_axis_label = self.data.get("x_axis_label")
+        bottom_margin = self.data.get("bottom_margin")
+        if x_axis_label and (not bottom_margin or bottom_margin == "auto"):


See https://github.com/apache/superset/pull/23973/files#r1201279048.

This code will be inherited from the base TimeseriesChart that was created in the Line migration. I will rebase this PR on top of that one.

EugeneTorap · 2023-07-07T17:27:16Z

Hi @michael-s-molina! When do we plan to merge it?

michael-s-molina · 2023-07-07T17:28:19Z

Hi @michael-s-molina! When do we plan to merge it?

4.0 given that the window for breaking changes is now closed.

michael-s-molina · 2023-11-10T17:38:11Z

Closing this PR in favor of #25952 which makes it possible to migrate the chart without introducing a breaking change.

pull-request-size Bot added the size/M label Apr 28, 2023

michael-s-molina added risk:breaking-change Issues or PRs that will introduce breaking changes hold! On hold v3.0 Label added by the release manager to track PRs to be included in the 3.0 branch labels May 1, 2023

pull-request-size Bot added size/XXL and removed size/M labels May 1, 2023

michael-s-molina marked this pull request as ready for review May 1, 2023 17:21

michael-s-molina requested review from a team, betodealmeida, eschutho, geido, jinghua-qa and rusackas as code owners May 1, 2023 17:21

michael-s-molina requested review from john-bodley, kgabryje and villebro May 1, 2023 17:22

michael-s-molina added 4 commits May 22, 2023 18:11

feat: Migrates Area chart

f04e607

Removes legacy code

876f1c3

Fixes E2E tests

7ff79fe

Migrates Advanced Analytics section

7089df3

michael-s-molina force-pushed the migrate-area branch from ef3690b to 7089df3 Compare May 22, 2023 21:16

Fixes walrus lint error

0d4824c

john-bodley reviewed May 22, 2023

View reviewed changes

michael-s-molina removed the v3.0 Label added by the release manager to track PRs to be included in the 3.0 branch label Jun 26, 2023

michael-s-molina mentioned this pull request Jul 17, 2023

feat: migrate charts on import #24703

Merged

9 tasks

rusackas added the v4.0 Label added by the release manager to track PRs to be included in the 4.0 branch label Jul 23, 2023

michael-s-molina mentioned this pull request Jul 31, 2023

Date column in superset displayed as unix timestamp #21508

Closed

3 tasks

michael-s-molina closed this Nov 10, 2023

michael-s-molina removed the hold! On hold label Jan 16, 2024

	self.data["zoomable"] = False if show_brush == "no" else True
	self.data["zoomable"] = not self.data.get("show_brush") == "no"

Conversation

michael-s-molina commented Apr 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

SUMMARY

AFTER SCREENSHOT

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

Uh oh!

codecov Bot commented May 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

michael-s-molina May 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

john-bodley May 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

EugeneTorap commented Jul 7, 2023

Uh oh!

michael-s-molina commented Jul 7, 2023

Uh oh!

michael-s-molina commented Nov 10, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

michael-s-molina commented Apr 28, 2023 •

edited

Loading

codecov Bot commented May 1, 2023 •

edited

Loading

michael-s-molina May 23, 2023 •

edited

Loading

john-bodley May 22, 2023 •

edited

Loading