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

fix(empty dashboards): Allow downloading a screenshot of an empty dashboard #30767

Merged
merged 7 commits into from
Nov 13, 2024

Conversation

msyavuz
Copy link
Contributor

@msyavuz msyavuz commented Oct 31, 2024

SUMMARY

Check if a dashboard contains charts first, if not don't wait for them to load etc. This fixes the bug where if the dashboard is empty screenshot fails.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

  1. Create an empty dashboard
  2. Download png/pdf screenshot of the empty dashboard

ADDITIONAL INFORMATION

Copy link

codecov bot commented Oct 31, 2024

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 83.91%. Comparing base (76d897e) to head (38032e5).
Report is 966 commits behind head on master.

Files with missing lines Patch % Lines
superset/utils/webdriver.py 0.00% 4 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           master   #30767       +/-   ##
===========================================
+ Coverage   60.48%   83.91%   +23.43%     
===========================================
  Files        1931      536     -1395     
  Lines       76236    38921    -37315     
  Branches     8568        0     -8568     
===========================================
- Hits        46114    32662    -13452     
+ Misses      28017     6259    -21758     
+ Partials     2105        0     -2105     
Flag Coverage Δ
javascript ?

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@geido geido added preset:bounty Issues that have been selected by Preset and have a bounty attached. hold! On hold labels Oct 31, 2024
@pull-request-size pull-request-size bot added size/S and removed size/M labels Nov 4, 2024
@msyavuz msyavuz marked this pull request as ready for review November 6, 2024 10:07
@dosubot dosubot bot added the dashboard:error Related to Dashboard errors label Nov 6, 2024
@geido geido removed the hold! On hold label Nov 13, 2024
superset/utils/webdriver.py Outdated Show resolved Hide resolved
@geido geido changed the title fix(empty dashboards): Check for chart-container first fix(empty dashboards): Allow downloading a screenshot of an empty dashboard Nov 13, 2024
superset/utils/webdriver.py Outdated Show resolved Hide resolved
superset/utils/webdriver.py Outdated Show resolved Hide resolved
Copy link
Member

@geido geido left a comment

Choose a reason for hiding this comment

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

I did some text enhancements for comments and errors but the general approach looks fine to me. It would be nice to have a better way to differentiate between an empty dashboard (that will never load any charts) and a dashboard that is waiting for chart containers to draw, but I guess this should do fine for now. I tested it locally too. Thanks!

@geido geido merged commit 58f9be9 into apache:master Nov 13, 2024
33 checks passed
asher-lab added a commit to asher-lab/superset that referenced this pull request Nov 22, 2024
* fix: Exception handling for SQL Lab views (apache#30897)

* fix: don't show metadata for embedded dashboards (apache#30875)

* feat: add logging durations for screenshot async service (apache#30884)

* refactor(Avatar): Migrate Avatar to Ant Design 5 (apache#30740)

* refactor(input): Migrate Input component to Ant Design 5 (apache#30730)

* fix(empty dashboards): Allow downloading a screenshot of an empty dashboard (apache#30767)

Co-authored-by: Geido <60598000+geido@users.noreply.github.com>

* chore(ci): add tai and michael to helm owners (apache#30925)

* fix(helm): use submodule on helm release action (apache#30924)

* docs: add Free2Move to INTHEWILD.md (apache#30930)

* fix: blocks UI elements on right side (apache#30886)

Co-authored-by: Evan Rusackas <evan@preset.io>

* chore(deps): Migrate from `crate[sqlalchemy]` to `sqlalchemy-cratedb` (apache#29243)

* chore: update change log, UPDATING.md and bug-report.yml for 4.1 release (apache#30915)

* chore(docs): Update list of supported databases to include CrateDB (apache#30946)

* feat(trino,presto): add missing time grains (apache#30926)

* fix(Dashboard): Exclude edit param in async screenshot (apache#30962)

* fix(Card): Use correct class names for Ant Design 5 Card component (apache#30964)

* chore(Accessibility): Fix accessibility for 'Show x entries' dropdown in tables (apache#30818)

* build(deps): bump cross-spawn from 7.0.3 to 7.0.6 in /superset-frontend/cypress-base (apache#30969)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix(release validation): scripts now support RSA and EDDSA keys. (apache#30967)

* build(deps): bump cross-spawn from 7.0.3 to 7.0.6 in /docs (apache#30970)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore: add performance information to tooltip (apache#30948)

* fix(helm-chart): Fix broken PodDisruptionBudget due to introduction of extraLabels. (apache#30966)

* chore(helm): bumping app version to 4.1.1 in helm chart (apache#30918)

* chore: add unit tests for `is_mutating()` (apache#31021)

* chore(🦾): bump python numexpr 2.10.0 -> 2.10.1 (apache#31006)

Co-authored-by: GitHub Action <action@github.com>

* chore(🦾): bump python cffi 1.16.0 -> 1.17.1 (apache#31002)

Co-authored-by: GitHub Action <action@github.com>

* chore(🦾): bump python flask-babel subpackage(s) (apache#31000)

Co-authored-by: GitHub Action <action@github.com>

* fix(Dashboard): Retain colors when color scheme not set (apache#30646)

* fix(explore): verified props is not updated (apache#31008)

* chore: publish wheels (apache#30981)

* docs: Embedded sdk (apache#30972)

* fix(imports): import query_context for imports with charts (apache#30887)

* docs: Update doc about CSV upload (apache#30867)

Co-authored-by: Evan Rusackas <evan@preset.io>

* chore(🦾): bump python cattrs 23.2.3 -> 24.1.2 (apache#30998)

Co-authored-by: GitHub Action <action@github.com>

* fix(dataset): use sqlglot for DML check (apache#31024)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Michael S. Molina <70410625+michael-s-molina@users.noreply.github.com>
Co-authored-by: Joe Li <joe@preset.io>
Co-authored-by: Maxime Beauchemin <maximebeauchemin@gmail.com>
Co-authored-by: Mehmet Salih Yavuz <salih.yavuz@proton.me>
Co-authored-by: Geido <60598000+geido@users.noreply.github.com>
Co-authored-by: Ville Brofeldt <33317356+villebro@users.noreply.github.com>
Co-authored-by: Paolo Terzi <PaoloTerzi@users.noreply.github.com>
Co-authored-by: Sukuna <90980311+samarsrivastav@users.noreply.github.com>
Co-authored-by: Evan Rusackas <evan@preset.io>
Co-authored-by: Andreas Motl <andreas.motl@elmyra.de>
Co-authored-by: Andreas Motl <andreas.motl@crate.io>
Co-authored-by: Levis Mbote <111055098+LevisNgigi@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Elizabeth Thompson <eschutho@gmail.com>
Co-authored-by: Christoph Keller <github@christophkeller.cc>
Co-authored-by: lodu <48859312+lodu@users.noreply.github.com>
Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: GitHub Action <action@github.com>
Co-authored-by: JUST.in DO IT <justin.park@airbnb.com>
Co-authored-by: David Hotham <david.hotham@microsoft.com>
Co-authored-by: Giampaolo Capelli <giampaolo.capelli@gmail.com>
Co-authored-by: Linden <zairrow@gmail.com>
Co-authored-by: Seiya <20365512+seiyab@users.noreply.github.com>
Co-authored-by: Asher Manangan <amanangan@powercosts.com>
nyohasstium pushed a commit to Webgains/superset that referenced this pull request Jan 2, 2025
…hboard (apache#30767)

Co-authored-by: Geido <60598000+geido@users.noreply.github.com>
betodealmeida pushed a commit that referenced this pull request Jan 14, 2025
…hboard (#30767)

Co-authored-by: Geido <60598000+geido@users.noreply.github.com>
(cherry picked from commit 58f9be9)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dashboard:error Related to Dashboard errors preset:bounty Issues that have been selected by Preset and have a bounty attached. size/S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dashboard Screenshot API Endpooint Gives and Error Message when a Dashboard is Empty or has no Charts
3 participants