Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Deprecates some NVD3 charts in 3.0 #24322

Merged

Conversation

michael-s-molina
Copy link
Member

@michael-s-molina michael-s-molina commented Jun 8, 2023

SUMMARY

Deprecates the following NVD3 charts in 3.0 to be removed in the next major version:

  • Area
  • Bar
  • Dist Bar
  • Line
  • Pie

NVD3 charts that have a migration and an ECharts replacement will be removed in 3.0. The others remain untouched until we provide a migration and ECharts replacement in a future major version.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Screenshot 2023-06-08 at 15 08 24

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
Copy link

codecov bot commented Jun 8, 2023

Codecov Report

Merging #24322 (5a29b32) into master (e13b80a) will increase coverage by 0.27%.
The diff coverage is 90.69%.

❗ Current head 5a29b32 differs from pull request most recent head 657269a. Consider uploading reports for the commit 657269a to get more accurate results

@@            Coverage Diff             @@
##           master   #24322      +/-   ##
==========================================
+ Coverage   68.33%   68.60%   +0.27%     
==========================================
  Files        1957     1941      -16     
  Lines       75628    75201     -427     
  Branches     8225     8215      -10     
==========================================
- Hits        51680    51595      -85     
+ Misses      21835    21494     -341     
+ Partials     2113     2112       -1     
Flag Coverage Δ
javascript 54.96% <40.00%> (+0.20%) ⬆️
mysql ?

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

Impacted Files Coverage Δ
...plugins/legacy-preset-chart-nvd3/src/Area/index.js 66.66% <ø> (ø)
.../plugins/legacy-preset-chart-nvd3/src/Bar/index.js 66.66% <ø> (ø)
...gins/legacy-preset-chart-nvd3/src/DistBar/index.js 66.66% <ø> (ø)
...plugins/legacy-preset-chart-nvd3/src/Line/index.js 66.66% <ø> (ø)
...nd/plugins/legacy-preset-chart-nvd3/src/NVD3Vis.js 0.00% <0.00%> (ø)
.../plugins/legacy-preset-chart-nvd3/src/Pie/index.js 33.33% <ø> (ø)
...end/plugins/legacy-preset-chart-nvd3/src/preset.js 0.00% <ø> (ø)
...ins/legacy-preset-chart-nvd3/src/transformProps.js 7.40% <ø> (+0.74%) ⬆️
...rset-frontend/src/components/ReportModal/index.tsx 79.03% <ø> (ø)
superset-frontend/src/dashboard/actions/hydrate.js 2.04% <ø> (ø)
... and 22 more

... and 7 files with indirect coverage changes

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

@@ -24,11 +24,15 @@ import controlPanel from './controlPanel';
const metadata = new ChartMetadata({
credits: ['http://nvd3.org'],
description: '',
name: t('Pie Chart'),
name: t('Pie Chart (deprecated)'),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I wonder if it's fair to add deprecated: true to the metadata here, which would hide it from the viz gallery. Maybe we should gather some thoughts on this at Town Hall tomorrow? I'll stick it on the agenda.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one does not appear in the viz gallery already. I just marked it as deprecated to be removed in 4.0.

Copy link
Member

@rusackas rusackas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, with possible add-ons (which could be a separate PR, they're certainly non-blocking):

  1. Maybe we should also remove them from the viz gallery (existing charts left in place)
    OR
  2. Maybe we should add label: ChartLabel.DEPRECATED to their metadata, which adds the visible "DEPRECATED" label in the viz gallery.

@michael-s-molina
Copy link
Member Author

  1. Maybe we should add label: ChartLabel.DEPRECATED to their metadata, which adds the visible "DEPRECATED" label in the viz gallery.

I didn't know about this label. I'll add the label to all 👍🏼

@michael-s-molina
Copy link
Member Author

@rusackas I added the DEPRECATED label to all and kept the (legacy) suffix in the name. I updated the PR image to reflect the change.

@michael-s-molina michael-s-molina merged commit 7e626c0 into apache:master Jun 8, 2023
28 checks passed
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 3.0.0 labels Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/M 🚢 3.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants