diff --git a/superset-frontend/src/dashboard/components/menu/DownloadMenuItems/index.tsx b/superset-frontend/src/dashboard/components/menu/DownloadMenuItems/index.tsx
index c17fc0d0265..089ccb9179b 100644
--- a/superset-frontend/src/dashboard/components/menu/DownloadMenuItems/index.tsx
+++ b/superset-frontend/src/dashboard/components/menu/DownloadMenuItems/index.tsx
@@ -17,8 +17,11 @@
* under the License.
*/
import { Menu } from 'src/components/Menu';
+import { FeatureFlag, isFeatureEnabled } from '@superset-ui/core';
import DownloadScreenshot from './DownloadScreenshot';
import { DownloadScreenshotFormat } from './types';
+import DownloadAsPdf from './DownloadAsPdf';
+import DownloadAsImage from './DownloadAsImage';
export interface DownloadMenuItemProps {
pdfMenuItemTitle: string;
@@ -34,25 +37,48 @@ const DownloadMenuItems = (props: DownloadMenuItemProps) => {
imageMenuItemTitle,
logEvent,
dashboardId,
+ dashboardTitle,
...rest
} = props;
+ const isWebDriverScreenshotEnabled =
+ isFeatureEnabled(FeatureFlag.EnableDashboardScreenshotEndpoints) &&
+ isFeatureEnabled(FeatureFlag.EnableDashboardDownloadWebDriverScreenshot);
return (
);
};
diff --git a/superset-frontend/src/types/dom-to-pdf.d.ts b/superset-frontend/src/types/dom-to-pdf.d.ts
new file mode 100644
index 00000000000..061e80d96ce
--- /dev/null
+++ b/superset-frontend/src/types/dom-to-pdf.d.ts
@@ -0,0 +1,36 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+declare module 'dom-to-pdf' {
+ interface Image {
+ type: string;
+ quality: number;
+ }
+
+ interface Options {
+ margin: number;
+ filename: string;
+ image: Image;
+ html2canvas: object;
+ excludeClassNames?: string[];
+ }
+
+ function domToPdf(elementToPrint: Element, options?: Options): Promise
;
+
+ export default domToPdf;
+}
diff --git a/superset-frontend/src/utils/downloadAsPdf.ts b/superset-frontend/src/utils/downloadAsPdf.ts
new file mode 100644
index 00000000000..bb769d1eb11
--- /dev/null
+++ b/superset-frontend/src/utils/downloadAsPdf.ts
@@ -0,0 +1,74 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { SyntheticEvent } from 'react';
+import domToPdf from 'dom-to-pdf';
+import { kebabCase } from 'lodash';
+import { logging, t } from '@superset-ui/core';
+import { addWarningToast } from 'src/components/MessageToasts/actions';
+
+/**
+ * generate a consistent file stem from a description and date
+ *
+ * @param description title or description of content of file
+ * @param date date when file was generated
+ */
+const generateFileStem = (description: string, date = new Date()) =>
+ `${kebabCase(description)}-${date.toISOString().replace(/[: ]/g, '-')}`;
+
+/**
+ * Create an event handler for turning an element into an image
+ *
+ * @param selector css selector of the parent element which should be turned into image
+ * @param description name or a short description of what is being printed.
+ * Value will be normalized, and a date as well as a file extension will be added.
+ * @param isExactSelector if false, searches for the closest ancestor that matches selector.
+ * @returns event handler
+ */
+export default function downloadAsPdf(
+ selector: string,
+ description: string,
+ isExactSelector = false,
+) {
+ return (event: SyntheticEvent) => {
+ const elementToPrint = isExactSelector
+ ? document.querySelector(selector)
+ : event.currentTarget.closest(selector);
+
+ if (!elementToPrint) {
+ return addWarningToast(
+ t('PDF download failed, please refresh and try again.'),
+ );
+ }
+
+ const options = {
+ margin: 10,
+ filename: `${generateFileStem(description)}.pdf`,
+ image: { type: 'jpeg', quality: 1 },
+ html2canvas: { scale: 2 },
+ excludeClassNames: ['header-controls'],
+ };
+ return domToPdf(elementToPrint, options)
+ .then(() => {
+ // nothing to be done
+ })
+ .catch((e: Error) => {
+ logging.error('PDF generation failed', e);
+ });
+ };
+}
diff --git a/superset/config.py b/superset/config.py
index 40398ef39bf..c504c15f670 100644
--- a/superset/config.py
+++ b/superset/config.py
@@ -478,6 +478,14 @@ DEFAULT_FEATURE_FLAGS: dict[str, bool] = {
"PRESTO_EXPAND_DATA": False,
# Exposes API endpoint to compute thumbnails
"THUMBNAILS": False,
+ # Enable the endpoints to cache and retrieve dashboard screenshots via webdriver.
+ # Requires configuring Celery and a cache using THUMBNAIL_CACHE_CONFIG.
+ "ENABLE_DASHBOARD_SCREENSHOT_ENDPOINTS": False,
+ # Generate screenshots (PDF or JPG) of dashboards using the web driver.
+ # When disabled, screenshots are generated on the fly by the browser.
+ # This feature flag is used by the download feature in the dashboard view.
+ # It is dependent on ENABLE_DASHBOARD_SCREENSHOT_ENDPOINT being enabled.
+ "ENABLE_DASHBOARD_DOWNLOAD_WEBDRIVER_SCREENSHOT": False,
"SHARE_QUERIES_VIA_KV_STORE": False,
"TAGGING_SYSTEM": False,
"SQLLAB_BACKEND_PERSISTENCE": True,
diff --git a/superset/dashboards/api.py b/superset/dashboards/api.py
index 7255f79b88b..8b459fa945a 100644
--- a/superset/dashboards/api.py
+++ b/superset/dashboards/api.py
@@ -149,12 +149,18 @@ def with_dashboard(
class DashboardRestApi(BaseSupersetModelRestApi):
datamodel = SQLAInterface(Dashboard)
- @before_request(only=["thumbnail"])
+ @before_request(only=["thumbnail", "cache_dashboard_screenshot", "screenshot"])
def ensure_thumbnails_enabled(self) -> Optional[Response]:
if not is_feature_enabled("THUMBNAILS"):
return self.response_404()
return None
+ @before_request(only=["cache_dashboard_screenshot", "screenshot"])
+ def ensure_screenshots_enabled(self) -> Optional[Response]:
+ if not is_feature_enabled("ENABLE_DASHBOARD_SCREENSHOT_ENDPOINTS"):
+ return self.response_404()
+ return None
+
include_route_methods = RouteMethod.REST_MODEL_VIEW_CRUD_SET | {
RouteMethod.EXPORT,
RouteMethod.IMPORT,
@@ -1052,7 +1058,7 @@ class DashboardRestApi(BaseSupersetModelRestApi):
),
dashboard_id=dashboard.id,
dashboard_url=dashboard_url,
- force=True,
+ force=False,
thumb_size=thumb_size,
window_size=window_size,
cache_key=cache_key,
diff --git a/tests/integration_tests/dashboards/api_tests.py b/tests/integration_tests/dashboards/api_tests.py
index 86a855a2890..1c088ede1d1 100644
--- a/tests/integration_tests/dashboards/api_tests.py
+++ b/tests/integration_tests/dashboards/api_tests.py
@@ -2833,7 +2833,9 @@ class TestDashboardApi(ApiOwnersTestCaseMixin, InsertChartMixin, SupersetTestCas
return self.client.get(uri)
@pytest.mark.usefixtures("create_dashboard_with_tag")
- def test_cache_dashboard_screenshot_success(self):
+ @patch("superset.dashboards.api.is_feature_enabled")
+ def test_cache_dashboard_screenshot_success(self, is_feature_enabled):
+ is_feature_enabled.return_value = True
self.login(ADMIN_USERNAME)
dashboard = (
db.session.query(Dashboard)
@@ -2844,7 +2846,9 @@ class TestDashboardApi(ApiOwnersTestCaseMixin, InsertChartMixin, SupersetTestCas
self.assertEqual(response.status_code, 202)
@pytest.mark.usefixtures("create_dashboard_with_tag")
- def test_cache_dashboard_screenshot_dashboard_validation(self):
+ @patch("superset.dashboards.api.is_feature_enabled")
+ def test_cache_dashboard_screenshot_dashboard_validation(self, is_feature_enabled):
+ is_feature_enabled.return_value = True
self.login(ADMIN_USERNAME)
dashboard = (
db.session.query(Dashboard)
@@ -2860,7 +2864,9 @@ class TestDashboardApi(ApiOwnersTestCaseMixin, InsertChartMixin, SupersetTestCas
response = self._cache_screenshot(dashboard.id, invalid_payload)
self.assertEqual(response.status_code, 400)
- def test_cache_dashboard_screenshot_dashboard_not_found(self):
+ @patch("superset.dashboards.api.is_feature_enabled")
+ def test_cache_dashboard_screenshot_dashboard_not_found(self, is_feature_enabled):
+ is_feature_enabled.return_value = True
self.login(ADMIN_USERNAME)
non_existent_id = 999
response = self._cache_screenshot(non_existent_id)
@@ -2869,10 +2875,14 @@ class TestDashboardApi(ApiOwnersTestCaseMixin, InsertChartMixin, SupersetTestCas
@pytest.mark.usefixtures("create_dashboard_with_tag")
@patch("superset.dashboards.api.cache_dashboard_screenshot")
@patch("superset.dashboards.api.DashboardScreenshot.get_from_cache_key")
- def test_screenshot_success_png(self, mock_get_cache, mock_cache_task):
+ @patch("superset.dashboards.api.is_feature_enabled")
+ def test_screenshot_success_png(
+ self, is_feature_enabled, mock_get_cache, mock_cache_task
+ ):
"""
Validate screenshot returns png
"""
+ is_feature_enabled.return_value = True
self.login(ADMIN_USERNAME)
mock_cache_task.return_value = None
mock_get_cache.return_value = BytesIO(b"fake image data")
@@ -2895,12 +2905,14 @@ class TestDashboardApi(ApiOwnersTestCaseMixin, InsertChartMixin, SupersetTestCas
@patch("superset.dashboards.api.cache_dashboard_screenshot")
@patch("superset.dashboards.api.build_pdf_from_screenshots")
@patch("superset.dashboards.api.DashboardScreenshot.get_from_cache_key")
+ @patch("superset.dashboards.api.is_feature_enabled")
def test_screenshot_success_pdf(
- self, mock_get_from_cache, mock_build_pdf, mock_cache_task
+ self, is_feature_enabled, mock_get_from_cache, mock_build_pdf, mock_cache_task
):
"""
Validate screenshot can return pdf.
"""
+ is_feature_enabled.return_value = True
self.login(ADMIN_USERNAME)
mock_cache_task.return_value = None
mock_get_from_cache.return_value = BytesIO(b"fake image data")
@@ -2923,7 +2935,11 @@ class TestDashboardApi(ApiOwnersTestCaseMixin, InsertChartMixin, SupersetTestCas
@pytest.mark.usefixtures("create_dashboard_with_tag")
@patch("superset.dashboards.api.cache_dashboard_screenshot")
@patch("superset.dashboards.api.DashboardScreenshot.get_from_cache_key")
- def test_screenshot_not_in_cache(self, mock_get_cache, mock_cache_task):
+ @patch("superset.dashboards.api.is_feature_enabled")
+ def test_screenshot_not_in_cache(
+ self, is_feature_enabled, mock_get_cache, mock_cache_task
+ ):
+ is_feature_enabled.return_value = True
self.login(ADMIN_USERNAME)
mock_cache_task.return_value = None
mock_get_cache.return_value = None
@@ -2940,7 +2956,9 @@ class TestDashboardApi(ApiOwnersTestCaseMixin, InsertChartMixin, SupersetTestCas
response = self._get_screenshot(dashboard.id, cache_key, "pdf")
self.assertEqual(response.status_code, 404)
- def test_screenshot_dashboard_not_found(self):
+ @patch("superset.dashboards.api.is_feature_enabled")
+ def test_screenshot_dashboard_not_found(self, is_feature_enabled):
+ is_feature_enabled.return_value = True
self.login(ADMIN_USERNAME)
non_existent_id = 999
response = self._get_screenshot(non_existent_id, "some_cache_key", "png")
@@ -2949,7 +2967,11 @@ class TestDashboardApi(ApiOwnersTestCaseMixin, InsertChartMixin, SupersetTestCas
@pytest.mark.usefixtures("create_dashboard_with_tag")
@patch("superset.dashboards.api.cache_dashboard_screenshot")
@patch("superset.dashboards.api.DashboardScreenshot.get_from_cache_key")
- def test_screenshot_invalid_download_format(self, mock_get_cache, mock_cache_task):
+ @patch("superset.dashboards.api.is_feature_enabled")
+ def test_screenshot_invalid_download_format(
+ self, is_feature_enabled, mock_get_cache, mock_cache_task
+ ):
+ is_feature_enabled.return_value = True
self.login(ADMIN_USERNAME)
mock_cache_task.return_value = None
mock_get_cache.return_value = BytesIO(b"fake png data")
@@ -2965,4 +2987,21 @@ class TestDashboardApi(ApiOwnersTestCaseMixin, InsertChartMixin, SupersetTestCas
cache_key = json.loads(cache_resp.data.decode("utf-8"))["cache_key"]
response = self._get_screenshot(dashboard.id, cache_key, "invalid")
- self.assertEqual(response.status_code, 404)
+ assert response.status_code == 404
+
+ @pytest.mark.usefixtures("create_dashboard_with_tag")
+ @patch("superset.dashboards.api.is_feature_enabled")
+ def test_cache_dashboard_screenshot_feature_disabled(self, is_feature_enabled):
+ is_feature_enabled.return_value = False
+ self.login(ADMIN_USERNAME)
+
+ dashboard = (
+ db.session.query(Dashboard)
+ .filter(Dashboard.dashboard_title == "dash with tag")
+ .first()
+ )
+
+ assert dashboard is not None
+
+ response = self._cache_screenshot(dashboard.id)
+ assert response.status_code == 404