refactor(Dashboard): Fetch dashboard screenshot via dedicated endpoint (

apache#29272)

CODE_OF_CONDUCT.md

@@ -16,7 +16,6 @@
     specific language governing permissions and limitations
     under the License.
 -->
-
 # CODE OF CONDUCT
 
 *The following is copied for your convenience from <https://www.apache.org/foundation/policies/conduct.html>. If there's a discrepancy between the two, let us know or submit a PR to fix it.*

superset-frontend/package.json

@@ -132,7 +132,6 @@
     "core-js": "^3.37.1",
     "d3-scale": "^2.1.2",
     "dom-to-image-more": "^3.2.0",
-    "dom-to-pdf": "^0.3.1",
     "emotion-rgba": "0.0.12",
     "fast-glob": "^3.2.7",
     "fs-extra": "^10.0.0",

superset-frontend/src/dashboard/components/Header/HeaderActionsDropdown/index.jsx

@@ -276,7 +276,7 @@ export class HeaderActionsDropdown extends PureComponent {
             pdfMenuItemTitle={t('Export to PDF')}
             imageMenuItemTitle={t('Download as Image')}
             dashboardTitle={dashboardTitle}
-            addDangerToast={addDangerToast}
+            dashboardId={dashboardId}
           />
         </Menu.SubMenu>
         {userCanShare && (

superset-frontend/src/dashboard/components/menu/DownloadMenuItems/DownloadMenuItems.test.tsx

@@ -20,15 +20,17 @@ import { render, screen } from 'spec/helpers/testing-library';
 import DownloadMenuItems from '.';
 
 const createProps = () => ({
-  addDangerToast: jest.fn(),
   pdfMenuItemTitle: 'Export to PDF',
   imageMenuItemTitle: 'Download as Image',
   dashboardTitle: 'Test Dashboard',
   logEvent: jest.fn(),
+  dashboardId: '123',
 });
 
 const renderComponent = () => {
-  render(<DownloadMenuItems {...createProps()} />);
+  render(<DownloadMenuItems {...createProps()} />, {
+    useRedux: true,
+  });
 };
 
 test('Should render menu items', () => {

superset-frontend/src/dashboard/components/menu/DownloadMenuItems/DownloadScreenshot.test.tsx

@@ -0,0 +1,198 @@
+/**
+ * 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 { render, screen, waitFor } from 'spec/helpers/testing-library';
+import userEvent from '@testing-library/user-event';
+import { Menu } from 'src/components/Menu';
+import fetchMock from 'fetch-mock';
+import { logging } from '@superset-ui/core';
+import { DownloadScreenshotFormat } from './types';
+import DownloadScreenshot from './DownloadScreenshot';
+
+const mockAddDangerToast = jest.fn();
+const mockLogEvent = jest.fn();
+const mockAddSuccessToast = jest.fn();
+const mockAddInfoToast = jest.fn();
+
+jest.spyOn(logging, 'error').mockImplementation(() => {});
+
+jest.mock('src/components/MessageToasts/withToasts', () => ({
+  useToasts: () => ({
+    addDangerToast: mockAddDangerToast,
+    addSuccessToast: mockAddSuccessToast,
+    addInfoToast: mockAddInfoToast,
+  }),
+}));
+
+const defaultProps = () => ({
+  text: 'Download',
+  dashboardId: '123',
+  format: DownloadScreenshotFormat.PDF,
+  logEvent: mockLogEvent,
+});
+
+const renderComponent = () => {
+  render(
+    <Menu>
+      <DownloadScreenshot {...defaultProps()} />
+    </Menu>,
+    {
+      useRedux: true,
+    },
+  );
+};
+
+describe('DownloadScreenshot component', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+    jest.useRealTimers();
+    fetchMock.restore();
+  });
+
+  afterAll(() => {
+    jest.restoreAllMocks();
+  });
+
+  test('renders correctly with the given text', () => {
+    renderComponent();
+    expect(screen.getByText('Download')).toBeInTheDocument();
+  });
+
+  test('button renders with role="button"', async () => {
+    renderComponent();
+    const button = screen.getByRole('button', { name: 'Download' });
+    expect(button).toBeInTheDocument();
+  });
+
+  test('displays error message when API call fails', async () => {
+    const props = defaultProps();
+
+    fetchMock.post(
+      `glob:*/api/v1/dashboard/${props.dashboardId}/cache_dashboard_screenshot`,
+      {
+        status: 400,
+        body: {},
+      },
+    );
+
+    renderComponent();
+
+    userEvent.click(screen.getByRole('button', { name: 'Download' }));
+
+    await waitFor(() => {
+      expect(mockAddDangerToast).toHaveBeenCalledWith(
+        'The screenshot could not be downloaded. Please, try again later.',
+      );
+    });
+  });
+
+  test('displays success message when API call succeeds', async () => {
+    const props = defaultProps();
+    fetchMock.post(
+      `glob:*/api/v1/dashboard/${props.dashboardId}/cache_dashboard_screenshot`,
+      {
+        status: 200,
+        body: {
+          image_url: 'mocked_image_url',
+        },
+      },
+    );
+
+    fetchMock.get('glob:*/mocked_image_url?download_format=pdf', {
+      status: 200,
+      body: {},
+    });
+
+    renderComponent();
+
+    userEvent.click(screen.getByRole('button', { name: 'Download' }));
+
+    await waitFor(() => {
+      expect(mockAddInfoToast).toHaveBeenCalledWith(
+        'The screenshot is being generated. Please, do not leave the page.',
+      );
+    });
+  });
+
+  test('throws error when no image URL is provided', async () => {
+    const props = defaultProps();
+    fetchMock.post(
+      `glob:*/api/v1/dashboard/${props.dashboardId}/cache_dashboard_screenshot`,
+      {
+        status: 200,
+        body: {
+          image_url: '',
+        },
+      },
+    );
+
+    renderComponent();
+
+    // Simulate the user clicking the download button
+    userEvent.click(screen.getByRole('button', { name: 'Download' }));
+
+    await waitFor(() => {
+      expect(mockAddDangerToast).toHaveBeenCalledWith(
+        'The screenshot could not be downloaded. Please, try again later.',
+      );
+    });
+  });
+
+  test('displays success message when image retrieval succeeds', async () => {
+    const props = defaultProps();
+    const imageUrl = 'glob:*/mocked_image_url?download_format=pdf';
+    fetchMock.post(
+      `glob:*/api/v1/dashboard/${props.dashboardId}/cache_dashboard_screenshot`,
+      {
+        status: 200,
+        body: {
+          image_url: 'mocked_image_url',
+        },
+      },
+    );
+
+    fetchMock.get(imageUrl, {
+      status: 200,
+      headers: {
+        'Content-Type': 'image/png',
+      },
+      body: new Blob([], { type: 'image/png' }),
+    });
+
+    global.URL.createObjectURL = jest.fn(() => 'mockedObjectURL');
+    global.URL.revokeObjectURL = jest.fn();
+
+    // Render the component
+    renderComponent();
+
+    // Simulate the user clicking the download button
+    userEvent.click(screen.getByRole('button', { name: 'Download' }));
+
+    await waitFor(() => {
+      expect(fetchMock.calls(imageUrl).length).toBe(1);
+    });
+
+    // Wait for the successful image retrieval message
+    await waitFor(() => {
+      expect(mockAddSuccessToast).toHaveBeenCalledWith(
+        'The screenshot is now being downloaded.',
+      );
+    });
+  });
+});