Report fails to generate if dashboard doesn't contain a chart #29629

Activity

1. dosubot

   added

   alert-reportsNamespace | Anything related to the Alert & Reports featureNamespace | Anything related to the Alert & Reports feature

   dashboard:errorRelated to Dashboard errorsRelated to Dashboard errors

   on Jul 18, 2024
2. dosubot commented on Jul 18, 2024

   

   dosubotBot

   on Jul 18, 2024 – with DosuBot

   More actions

   Hello @oscep! I'm here to help you with any bugs, questions, or contributions you have for the repository. Let's work together to solve any issues you're facing.

   To address the issue of generating reports for dashboards without chart elements, you can use the force_screenshot option. This option ensures that a screenshot is taken even if the dashboard does not contain any chart elements. Here is the relevant code snippet:

   const shouldEnableForceScreenshot = contentType === 'chart' && !isReport;
   const data: any = {
     ...currentAlert,
     type: isReport ? 'Report' : 'Alert',
     force_screenshot: shouldEnableForceScreenshot || forceScreenshot,
     validator_type: conditionNotNull ? 'not null' : 'operator',
     validator_config_json: conditionNotNull
       ? {}
       : currentAlert?.validator_config_json,
     chart: contentType === 'chart' ? currentAlert?.chart?.value : null,
     dashboard:
       contentType === 'dashboard' ? currentAlert?.dashboard?.value : null,
     custom_width: isScreenshot ? currentAlert?.custom_width : undefined,
     database: currentAlert?.database?.value,
     owners: (currentAlert?.owners || []).map(
       owner => (owner as MetaObject).value || owner.id,
     ),
     recipients,
     report_format: reportFormat || DEFAULT_NOTIFICATION_FORMAT,
   };

   This approach ensures that the alert or report will still function correctly even if the dashboard lacks chart elements by forcing a screenshot ^[1].

   Additionally, to provide more meaningful error messages, you can customize the error handling in the report scheduling system. For example, you can modify the string passed to the custom exceptions to include more context, such as the report name:

   raise ReportScheduleScreenshotFailedError(
       f"Failed taking a screenshot for report {self._report_schedule.name}: {str(ex)}"
   ) from ex

   This would make the error messages more informative and helpful for debugging ^[2][3].

   To continue talking to Dosu, mention @dosu.
3. rusackas commented on Apr 2, 2025

   

   rusackas

   on Apr 2, 2025

   Member

   More actions

   I'm not sure if the bot is correct here or not, but this has been silent for 250+ days. Can you confirm this is still an issue in newer (4.1.2 or better yet 5.0.0) versions? If you're willing to open a PR with a better error message, that'd be appreciated. Also curious if the Playwright version works better.
4. rusackas

   added

   validation:requiredA committer should validate the issueA committer should validate the issue

   on Apr 2, 2025
5. hxtmdev commented on May 19, 2025

   

   hxtmdev

   on May 19, 2025

   Last edited by hxtmdev

   Contributor

   More actions

   Might be resolved with #33107?

   Edit: Or rather #30767 if not using Playwright...
6. rusackas commented on Feb 22, 2026

   

   rusackas

   on Feb 22, 2026

   Member

   More actions

   This issue has been resolved by two separate fixes:

   1. For Selenium-based screenshots: PR fix(empty dashboards): Allow downloading a screenshot of an empty dashboard #30767 (merged Nov 2024) - Checks if a dashboard contains charts first and skips the wait if empty
   2. For Playwright-based screenshots: PR fix(playwright): allow screenshotting empty dashboards #33107 (merged Apr 2025) - Allows screenshotting empty dashboards without timeout

   Both fixes are now available in recent Superset releases. Empty dashboards containing only text or other non-chart elements can now be successfully screenshot for reports.

   Thank you for the detailed bug report with reproduction steps and stack trace - this helped identify and fix the issue for both screenshot implementations.

   Closing as fixed.
7. rusackas

   closed this as completedon Feb 22, 2026