feat: dashboard page xlsx export #24005

vitoldi · 2023-05-10T13:54:19Z

SUMMARY

The Superset 2.1.0 release has new feature: excel export. But the feature is only available on the Chart page. Our customers have no access to the Chart page, so the Dashboard page is a primary place where we wanted Excel Export option.

This PR adds the ability to export to Excel on the Dashboard page.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Before:

After:

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

Resolves #23711

EugeneTorap · 2023-05-10T15:45:13Z

Hello @vitoldi!
Can you use Excel instead of .XLSX in Export to .XLSX ?
Can you add #23711 issue to the description and write: Resolves #23711 in order to automatically close the issue.
cc: @villebro @dpgaspar

vitoldi · 2023-05-10T16:14:28Z

Hello @vitoldi! Can you use Excel instead of .XLSX in Export to .XLSX ? Can you add #23711 issue to the description and write: Resolves #23711 in order to automatically close the issue. cc: @villebro @dpgaspar

Hello @EugeneTorap, it's done.

EugeneTorap · 2023-05-11T08:16:09Z

Hi @vitoldi, can you merge master branch -> your branch in order to fix CI tests

EugeneTorap · 2023-05-11T10:40:21Z

@vitoldi, pls, fix the prettier error

prettier.................................................................Failed
- hook id: prettier
- files were modified by this hook

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

vitoldi · 2023-05-11T11:48:32Z

@EugeneTorap, prettier error fixed.

EugeneTorap · 2023-05-11T13:46:48Z

superset-frontend/src/dashboard/components/SliceHeaderControls/SliceHeaderControls.test.tsx

+  renderWrapper(props);
+  expect(props.exportXLSX).toBeCalledTimes(0);
+  userEvent.hover(screen.getByText('Download'));
+  userEvent.click(await screen.findByText('Export to .XLSX'));


@vitoldi pls, fix the unit test. Use Excel instead of .XLSX

Error: Unable to find an element with the text: Export to .XLSX. This could be because the text is broken up by multiple elements. In this case, you can provide a function for your text matcher to make your matcher more flexible.

codecov · 2023-05-11T16:20:15Z

Codecov Report

Merging #24005 (444cac4) into master (6b54591) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head 444cac4 differs from pull request most recent head 67945ae. Consider uploading reports for the commit 67945ae to get more accurate results

@@           Coverage Diff           @@
##           master   #24005   +/-   ##
=======================================
  Coverage   68.27%   68.28%           
=======================================
  Files        1952     1952           
  Lines       75468    75476    +8     
  Branches     8202     8203    +1     
=======================================
+ Hits        51529    51537    +8     
  Misses      21832    21832           
  Partials     2107     2107

Flag	Coverage Δ
javascript	`54.68% <100.00%> (+<0.01%)`	⬆️

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

Impacted Files	Coverage Δ
...end/src/dashboard/components/SliceHeader/index.tsx	`90.74% <100.00%> (+0.17%)`	⬆️
...dashboard/components/SliceHeaderControls/index.tsx	`69.79% <100.00%> (+0.64%)`	⬆️
.../src/dashboard/components/gridComponents/Chart.jsx	`57.52% <100.00%> (+1.55%)`	⬆️
superset-frontend/src/logger/LogUtils.ts	`97.22% <100.00%> (+0.07%)`	⬆️

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

EugeneTorap · 2023-05-11T16:20:42Z

@villebro @dpgaspar @michael-s-molina Can you review this PR?

rusackas · 2023-05-15T22:50:17Z

@villebro @dpgaspar @michael-s-molina Can you review this PR?

Officially requested these reviewers.

rusackas · 2023-05-15T22:55:17Z

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

+  }
+
+  exportXLSX() {
+    this.exportTable('xlsx', false);


I think this is totally fine for now, but just wondering if folks will also want to do a "Full Excel" export like we do with CSV (when that feature flag is enabled). I'm totally fine skipping it for now, since it might cause performance issues, but it just made me wonder ¯\_(ツ)_/¯

While I'm on the topic, I wonder if the logger should also discern between regular and "full" CSV exports, in case anyone is trying to discern performance impact. Maybe an additional log for full CSV exports?

Again, not the point of this PR, but mentioning the bycatch...

rusackas

Code LGTM, but haven't tested it yet. Couple of comments about bycatch that might be worth exploring in a subsequent PR.

rusackas · 2023-05-18T22:24:13Z

@vitoldi I think we can merge this, but now there's a conflict. Would you mind doing a quick rebase?

vitoldi · 2023-05-19T07:34:37Z

@rusackas, I have resolved the conflict.

villebro

LGTM

sebastianliebscher · 2023-09-22T12:51:45Z

This feature is released with version 3.0.0.

feat: dashboard page xlsx export

d161770

pull-request-size bot added the size/M label May 10, 2023

"Export to .XLSX" changed to "Export to Excel"

d14ae20

Merge branch 'master' into feat/dashboard-page-xlsx-export

77760a7

fixed prettier issue

320cb79

EugeneTorap reviewed May 11, 2023

View reviewed changes

fixed SliceHeaderControls.test.tsx

9456f59

rusackas requested review from villebro, dpgaspar and michael-s-molina May 15, 2023 22:49

rusackas reviewed May 15, 2023

View reviewed changes

rusackas approved these changes May 15, 2023

View reviewed changes

merge master

67945ae

villebro approved these changes May 19, 2023

View reviewed changes

dpgaspar merged commit d0687d0 into apache:master May 19, 2023
26 checks passed

vitoldi deleted the feat/dashboard-page-xlsx-export branch May 19, 2023 12:17

vitoldi restored the feat/dashboard-page-xlsx-export branch May 30, 2023 14:05

vitoldi deleted the feat/dashboard-page-xlsx-export branch June 5, 2023 07:54

vitoldi mentioned this pull request Jun 5, 2023

feat: add dashboard page full xlsx export #24287

Merged

9 tasks

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 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: dashboard page xlsx export #24005

feat: dashboard page xlsx export #24005

vitoldi commented May 10, 2023 •

edited

Loading

EugeneTorap commented May 10, 2023 •

edited

Loading

vitoldi commented May 10, 2023

EugeneTorap commented May 11, 2023

EugeneTorap commented May 11, 2023

vitoldi commented May 11, 2023 •

edited

Loading

EugeneTorap May 11, 2023

vitoldi May 11, 2023

codecov bot commented May 11, 2023 •

edited

Loading

EugeneTorap commented May 11, 2023

rusackas commented May 15, 2023

rusackas May 15, 2023

rusackas May 15, 2023 •

edited

Loading

rusackas left a comment

rusackas commented May 18, 2023

vitoldi commented May 19, 2023 •

edited

Loading

villebro left a comment

sebastianliebscher commented Sep 22, 2023

feat: dashboard page xlsx export #24005

feat: dashboard page xlsx export #24005

Conversation

vitoldi commented May 10, 2023 • edited Loading

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

ADDITIONAL INFORMATION

EugeneTorap commented May 10, 2023 • edited Loading

vitoldi commented May 10, 2023

EugeneTorap commented May 11, 2023

EugeneTorap commented May 11, 2023

vitoldi commented May 11, 2023 • edited Loading

EugeneTorap May 11, 2023

Choose a reason for hiding this comment

vitoldi May 11, 2023

Choose a reason for hiding this comment

codecov bot commented May 11, 2023 • edited Loading

Codecov Report

EugeneTorap commented May 11, 2023

rusackas commented May 15, 2023

rusackas May 15, 2023

Choose a reason for hiding this comment

rusackas May 15, 2023 • edited Loading

Choose a reason for hiding this comment

rusackas left a comment

Choose a reason for hiding this comment

rusackas commented May 18, 2023

vitoldi commented May 19, 2023 • edited Loading

villebro left a comment

Choose a reason for hiding this comment

sebastianliebscher commented Sep 22, 2023

vitoldi commented May 10, 2023 •

edited

Loading

EugeneTorap commented May 10, 2023 •

edited

Loading

vitoldi commented May 11, 2023 •

edited

Loading

codecov bot commented May 11, 2023 •

edited

Loading

rusackas May 15, 2023 •

edited

Loading

vitoldi commented May 19, 2023 •

edited

Loading