Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

UXW-4983 disable download to pdf for empty dashboard tab (#79490)

Denis Berezin2f3d32a2baa7
diff --git a/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_Light_Theme_No_Results.png b/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_Light_Theme_No_Results.png
index e1d49191154..a86a3ed674b 100644
Binary files a/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_Light_Theme_No_Results.png and b/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_Light_Theme_No_Results.png differ
diff --git a/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_Narrow_With_Many_Tabs.png b/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_Narrow_With_Many_Tabs.png
index f0b5c00bfa1..0ff5f475f62 100644
Binary files a/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_Narrow_With_Many_Tabs.png and b/.loki/reference/chrome_laptop_App_Embed_PublicOrEmbeddedDashboardView_Narrow_With_Many_Tabs.png differ
diff --git a/e2e/test/scenarios/sharing/public-sharing-embed-button-behavior.cy.spec.js b/e2e/test/scenarios/sharing/public-sharing-embed-button-behavior.cy.spec.js
index e2cf5926afd..de97d771288 100644
--- a/e2e/test/scenarios/sharing/public-sharing-embed-button-behavior.cy.spec.js
+++ b/e2e/test/scenarios/sharing/public-sharing-embed-button-behavior.cy.spec.js
@@ -1035,11 +1035,10 @@ function assertNonAdminCannotCreatePublicLink(resource) {
}
if (resource === "dashboard") {
- // No public link: dashboards keep the app link copy and the PDF export.
+ // No public link: dashboards keep the app link copy
H.openSharingMenu();
H.sharingMenu().within(() => {
cy.findByText("Copy link").should("be.visible");
- cy.findByText("Export as PDF").should("be.visible");
cy.findByText("Embed").should("not.exist");
cy.findByText(/public link/i).should("not.exist");
});
diff --git a/frontend/src/metabase/dashboard/components/DashboardHeader/DashboardHeaderButtonRow/DashboardSharingMenu/DashboardSharingMenu.tsx b/frontend/src/metabase/dashboard/components/DashboardHeader/DashboardHeaderButtonRow/DashboardSharingMenu/DashboardSharingMenu.tsx
index 86d50b241ee..1633f37165e 100644
--- a/frontend/src/metabase/dashboard/components/DashboardHeader/DashboardHeaderButtonRow/DashboardSharingMenu/DashboardSharingMenu.tsx
+++ b/frontend/src/metabase/dashboard/components/DashboardHeader/DashboardHeaderButtonRow/DashboardSharingMenu/DashboardSharingMenu.tsx
@@ -6,6 +6,7 @@ import {
getIsDashCardsRunning,
getSelectedTabId,
} from "metabase/dashboard/selectors";
+import { isDashboardOrTabEmpty } from "metabase/dashboard/utils";
import { CopyLinkButton } from "metabase/embedding/components/SharingMenu/ActionButtons/CopyLinkButton";
import { EmbedButton } from "metabase/embedding/components/SharingMenu/ActionButtons/EmbedButton";
import { InviteToViewModal } from "metabase/embedding/components/SharingMenu/InviteToViewModal";
@@ -68,6 +69,8 @@ function AdminDashboardSharingMenu({ dashboard }: { dashboard: Dashboard }) {
const [isInviteOpen, { open: openInvite, close: closeInvite }] =
useDisclosure();
const isDashCardsRunning = useSelector(getIsDashCardsRunning);
+ const selectedTabId = useSelector(getSelectedTabId);
+ const isEmpty = isDashboardOrTabEmpty(dashboard, selectedTabId);
const isPublicSharingEnabled = useSetting("enable-public-sharing");
const siteUrl = useSetting("site-url");
const isAnalytics =
@@ -100,7 +103,12 @@ function AdminDashboardSharingMenu({ dashboard }: { dashboard: Dashboard }) {
}
>
<InviteToViewMenuItem onClick={openInvite} />
- <ExportPdfMenuItem dashboard={dashboard} loading={isDashCardsRunning} />
+ {!isEmpty && (
+ <ExportPdfMenuItem
+ dashboard={dashboard}
+ loading={isDashCardsRunning}
+ />
+ )}
{canShare && isPublicSharingEnabled && (hasPublicLink || canWrite) && (
<PublicLinkMenuItem
hasPublicLink={hasPublicLink}
@@ -133,11 +141,15 @@ function AdminDashboardSharingMenu({ dashboard }: { dashboard: Dashboard }) {
// the PDF export, and a public link copy when one already exists.
function NonAdminDashboardSharingMenu({ dashboard }: { dashboard: Dashboard }) {
const isDashCardsRunning = useSelector(getIsDashCardsRunning);
+ const selectedTabId = useSelector(getSelectedTabId);
+ const isEmpty = isDashboardOrTabEmpty(dashboard, selectedTabId);
const publicUuid = dashboard.public_uuid;
return (
<SharingMenu actions={<CopyDashboardLinkButton dashboard={dashboard} />}>
- <ExportPdfMenuItem dashboard={dashboard} loading={isDashCardsRunning} />
+ {!isEmpty && (
+ <ExportPdfMenuItem dashboard={dashboard} loading={isDashCardsRunning} />
+ )}
{publicUuid && (
<CopyPublicLinkMenuItem
url={getPublicDashboardUrl(publicUuid)}
diff --git a/frontend/src/metabase/dashboard/components/DashboardHeader/DashboardHeaderButtonRow/DashboardSharingMenu/DashboardSharingMenu.unit.spec.tsx b/frontend/src/metabase/dashboard/components/DashboardHeader/DashboardHeaderButtonRow/DashboardSharingMenu/DashboardSharingMenu.unit.spec.tsx
index b9ae615ae39..9a7d967a35c 100644
--- a/frontend/src/metabase/dashboard/components/DashboardHeader/DashboardHeaderButtonRow/DashboardSharingMenu/DashboardSharingMenu.unit.spec.tsx
+++ b/frontend/src/metabase/dashboard/components/DashboardHeader/DashboardHeaderButtonRow/DashboardSharingMenu/DashboardSharingMenu.unit.spec.tsx
@@ -4,6 +4,7 @@ import fetchMock from "fetch-mock";
import { screen, waitFor } from "__support__/ui";
import type { Dashboard } from "metabase-types/api";
import {
+ createMockDashboardCard,
createMockDashboardTab,
createMockUser,
} from "metabase-types/api/mocks";
@@ -83,6 +84,46 @@ describe("DashboardSharingMenu", () => {
{ cursor: "wait" },
);
});
+
+ it("should not be shown if the dashboard is empty", async () => {
+ setupDashboardSharingMenu({ dashboard: { dashcards: [] } });
+ await openMenu();
+ expect(
+ screen.queryByTestId("dashboard-export-pdf-button"),
+ ).not.toBeInTheDocument();
+ });
+
+ it("should not be shown if the selected tab is empty", async () => {
+ setupDashboardSharingMenu({
+ dashboard: {
+ tabs: [
+ createMockDashboardTab({ id: 1 }),
+ createMockDashboardTab({ id: 2 }),
+ ],
+ dashcards: [createMockDashboardCard({ id: 1, dashboard_tab_id: 2 })],
+ },
+ dashboardState: { selectedTabId: 1 },
+ });
+ await openMenu();
+ expect(
+ screen.queryByTestId("dashboard-export-pdf-button"),
+ ).not.toBeInTheDocument();
+ });
+
+ it("should be enabled if the selected tab has cards", async () => {
+ setupDashboardSharingMenu({
+ dashboard: {
+ tabs: [
+ createMockDashboardTab({ id: 1 }),
+ createMockDashboardTab({ id: 2 }),
+ ],
+ dashcards: [createMockDashboardCard({ id: 1, dashboard_tab_id: 2 })],
+ },
+ dashboardState: { selectedTabId: 2 },
+ });
+ await openMenu();
+ expect(screen.getByTestId("dashboard-export-pdf-button")).toBeEnabled();
+ });
});
describe("public links", () => {
diff --git a/frontend/src/metabase/dashboard/components/DashboardHeader/buttons/ExportAsPdfButton.tsx b/frontend/src/metabase/dashboard/components/DashboardHeader/buttons/ExportAsPdfButton.tsx
index 2c7c4d3887b..8633cd25e62 100644
--- a/frontend/src/metabase/dashboard/components/DashboardHeader/buttons/ExportAsPdfButton.tsx
+++ b/frontend/src/metabase/dashboard/components/DashboardHeader/buttons/ExportAsPdfButton.tsx
@@ -4,6 +4,7 @@ import { t } from "ttag";
import { ToolbarButton } from "metabase/common/components/ToolbarButton";
import { useDashboardContext } from "metabase/dashboard/context";
+import { isDashboardOrTabEmpty } from "metabase/dashboard/utils";
import { useDispatch } from "metabase/redux";
import { downloadDashboardToPdf } from "metabase/redux/downloads";
import type { ActionIconProps } from "metabase/ui";
@@ -12,8 +13,9 @@ import { checkNotNull } from "metabase/utils/types";
export const ExportAsPdfButton = (
props: ActionIconProps & ButtonHTMLAttributes<HTMLButtonElement>,
) => {
- const { dashboard } = useDashboardContext();
+ const { dashboard, selectedTabId } = useDashboardContext();
const dispatch = useDispatch();
+ const isEmpty = !dashboard || isDashboardOrTabEmpty(dashboard, selectedTabId);
const [{ loading }, saveAsPDF] = useAsyncFn(async () => {
await dispatch(
@@ -24,6 +26,10 @@ export const ExportAsPdfButton = (
);
}, [dispatch, dashboard]);
+ if (isEmpty) {
+ return null;
+ }
+
return (
<ToolbarButton
icon="download"
diff --git a/frontend/src/metabase/dashboard/components/DashboardHeader/buttons/ExportAsPdfButton.unit.spec.tsx b/frontend/src/metabase/dashboard/components/DashboardHeader/buttons/ExportAsPdfButton.unit.spec.tsx
index 51e44458bad..3a7cc94c438 100644
--- a/frontend/src/metabase/dashboard/components/DashboardHeader/buttons/ExportAsPdfButton.unit.spec.tsx
+++ b/frontend/src/metabase/dashboard/components/DashboardHeader/buttons/ExportAsPdfButton.unit.spec.tsx
@@ -2,8 +2,14 @@ import userEvent from "@testing-library/user-event";
import { renderWithProviders, screen, waitFor } from "__support__/ui";
import { MockDashboardContext } from "metabase/dashboard/context/mock-context";
+import type { SelectedTabId } from "metabase/redux/store";
import { createMockDashboardState } from "metabase/redux/store/mocks";
-import { createMockDashboard } from "metabase-types/api/mocks";
+import type { Dashboard } from "metabase-types/api";
+import {
+ createMockDashboard,
+ createMockDashboardCard,
+ createMockDashboardTab,
+} from "metabase-types/api/mocks";
import { ExportAsPdfButton } from "./ExportAsPdfButton";
@@ -17,9 +23,15 @@ jest.mock("metabase/redux/analytics", () => ({
trackExportDashboardToPDF: jest.fn(),
}));
-const setup = () => {
- const dashboard = createMockDashboard();
-
+const setup = ({
+ dashboard = createMockDashboard({
+ dashcards: [createMockDashboardCard()],
+ }),
+ selectedTabId = null,
+}: {
+ dashboard?: Dashboard;
+ selectedTabId?: SelectedTabId;
+} = {}) => {
return renderWithProviders(
<MockDashboardContext dashboardId={dashboard.id} dashboard={dashboard}>
<ExportAsPdfButton />
@@ -28,6 +40,7 @@ const setup = () => {
storeInitialState: {
dashboard: createMockDashboardState({
dashboardId: dashboard.id,
+ selectedTabId,
dashboards: {
[dashboard.id]: { ...dashboard, dashcards: [] },
},
@@ -54,4 +67,36 @@ describe("ExportAsPdfButton", () => {
await waitFor(() => expect(button).toHaveAttribute("data-loading", "true"));
expect(button).toBeDisabled();
});
+
+ it("does not render when the dashboard is empty", () => {
+ setup({ dashboard: createMockDashboard({ dashcards: [] }) });
+
+ expect(
+ screen.queryByTestId("export-as-pdf-button"),
+ ).not.toBeInTheDocument();
+ });
+
+ describe("multi-tab dashboards", () => {
+ const dashboard = createMockDashboard({
+ tabs: [
+ createMockDashboardTab({ id: 1 }),
+ createMockDashboardTab({ id: 2 }),
+ ],
+ dashcards: [createMockDashboardCard({ dashboard_tab_id: 2 })],
+ });
+
+ it("does not render when the selected tab is empty", () => {
+ setup({ dashboard, selectedTabId: 1 });
+
+ expect(
+ screen.queryByTestId("export-as-pdf-button"),
+ ).not.toBeInTheDocument();
+ });
+
+ it("renders when the selected tab has cards", () => {
+ setup({ dashboard, selectedTabId: 2 });
+
+ expect(screen.getByTestId("export-as-pdf-button")).toBeEnabled();
+ });
+ });
});
diff --git a/frontend/src/metabase/dashboard/utils.ts b/frontend/src/metabase/dashboard/utils.ts
index 0f20bf80f23..15cecb1df32 100644
--- a/frontend/src/metabase/dashboard/utils.ts
+++ b/frontend/src/metabase/dashboard/utils.ts
@@ -218,6 +218,13 @@ export function getCurrentTabDashboardCards(
);
}
+export function isDashboardOrTabEmpty(
+ dashboard: Dashboard,
+ selectedTabId: SelectedTabId,
+): boolean {
+ return getCurrentTabDashboardCards(dashboard, selectedTabId).length === 0;
+}
+
export function hasDatabaseActionsEnabled(database: Database) {
return database.settings?.["database-enable-actions"] ?? false;
}