Skip to content

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

[UXW-3795] Setting visualization options on dashboard cards breaks error messages (#73879)

Andrei Chernykhc848b50e2f18
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
index 600fa2f00bb..7115cf2685e 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
@@ -14,7 +14,10 @@ import {
getDashCardInlineValuePopulatedParameters,
getDashcardData,
} from "metabase/dashboard/selectors";
-import { getVirtualCardType } from "metabase/dashboard/utils";
+import {
+ getVirtualCardType,
+ isDashcardAccessRestricted,
+} from "metabase/dashboard/utils";
import { EmbeddingEntityContextProvider } from "metabase/embedding/context";
import { PLUGIN_CONTENT_TRANSLATION } from "metabase/plugins";
import { useDispatch, useSelector } from "metabase/redux";
@@ -204,6 +207,11 @@ export function DashCardVisualization({
) {
return;
}
+ // Skip when access is denied; the permission message would otherwise be
+ // masked by "Some columns are missing".
+ if (isDashcardAccessRestricted(rawSeries)) {
+ return;
+ }
const missingCols = getMissingColumnsFromVisualizationSettings({
visualizerEntity: dashcard.visualization_settings.visualization,
@@ -247,9 +255,10 @@ export function DashCardVisualization({
]),
);
- const didEveryDatasetLoad = dataSources.every(
- (dataSource) => dataSourceDatasets[dataSource.id] != null,
- );
+ const everyDatasetLoaded = dataSources.every((dataSource) => {
+ const dataset = dataSourceDatasets[dataSource.id];
+ return dataset != null && dataset.error == null;
+ });
const columns = getVisualizationColumns(
visualizerEntity,
@@ -267,7 +276,8 @@ export function DashCardVisualization({
_.omit(dashcard.visualization_settings, "visualization"),
);
- if (!didEveryDatasetLoad) {
+ if (!everyDatasetLoaded) {
+ // No `data` so the parent <Visualization> picks its error or loading view.
return [{ card }] as RawSeries;
}
diff --git a/frontend/src/metabase/dashboard/components/DashCard/Dashcard.unit.spec.tsx b/frontend/src/metabase/dashboard/components/DashCard/Dashcard.unit.spec.tsx
index 9a06d6d4435..9869667bdc4 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/Dashcard.unit.spec.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/Dashcard.unit.spec.tsx
@@ -21,6 +21,7 @@ import {
createMockDashboardState,
createMockState,
} from "metabase/redux/store/mocks";
+import { SERVER_ERROR_TYPES } from "metabase/utils/errors";
import registerVisualizations from "metabase/visualizations/register";
import type { DashCardDataMap } from "metabase-types/api";
import {
@@ -303,6 +304,114 @@ describe("DashCard", () => {
expect(screen.queryByLabelText("Replace")).not.toBeInTheDocument();
});
+ const permissionDeniedDataset = createMockDataset({
+ error: { status: 403 },
+ error_type: SERVER_ERROR_TYPES.missingPermissions,
+ });
+
+ it("should show the permission-denied message on a visualizer dashcard the user cannot read", () => {
+ const visualizerDashcard = createMockDashboardCard({
+ card: createMockCard({
+ name: "Private Card",
+ display: "table",
+ }),
+ visualization_settings: {
+ visualization: {
+ display: "table",
+ columns: [],
+ columnValuesMapping: {
+ COLUMN_1: [
+ {
+ sourceId: `card:${tableDashcard.card.id}`,
+ originalName: "SUBTOTAL",
+ name: "COLUMN_1",
+ },
+ ],
+ },
+ settings: {},
+ },
+ },
+ });
+ const permissionDeniedData: DashCardDataMap = {
+ [visualizerDashcard.id]: {
+ [visualizerDashcard.card.id]: permissionDeniedDataset,
+ },
+ };
+
+ setup({
+ dashboard: {
+ ...testDashboard,
+ dashcards: [visualizerDashcard],
+ },
+ dashcard: visualizerDashcard,
+ dashcardData: permissionDeniedData,
+ });
+
+ expect(
+ screen.getByText("Sorry, you don't have permission to see this card."),
+ ).toBeVisible();
+ expect(
+ screen.queryByText(/Some columns are missing/),
+ ).not.toBeInTheDocument();
+ });
+
+ it("should show the permission-denied message on a multi-source visualizer dashcard when any source is denied", () => {
+ const allowedSourceCardId = 9000;
+ const deniedSourceCardId = 9001;
+ const visualizerDashcard = createMockDashboardCard({
+ card: createMockCard({
+ id: allowedSourceCardId,
+ name: "Public Source",
+ display: "table",
+ }),
+ series: [
+ createMockCard({
+ id: deniedSourceCardId,
+ name: "Private Source",
+ display: "table",
+ }),
+ ],
+ visualization_settings: {
+ visualization: {
+ display: "table",
+ columns: [],
+ columnValuesMapping: {
+ COLUMN_1: [
+ {
+ sourceId: `card:${deniedSourceCardId}`,
+ originalName: "SUBTOTAL",
+ name: "COLUMN_1",
+ },
+ ],
+ },
+ settings: {},
+ },
+ },
+ });
+ const mixedAccessData: DashCardDataMap = {
+ [visualizerDashcard.id]: {
+ [allowedSourceCardId]: createMockDataset(),
+ [deniedSourceCardId]: permissionDeniedDataset,
+ },
+ };
+
+ setup({
+ dashboard: {
+ ...testDashboard,
+ dashcards: [visualizerDashcard],
+ },
+ dashcard: visualizerDashcard,
+ dashcardData: mixedAccessData,
+ });
+
+ expect(
+ screen.getByText("Sorry, you don't have permission to see this card."),
+ ).toBeVisible();
+ expect(
+ screen.queryByText(/Some columns are missing/),
+ ).not.toBeInTheDocument();
+ });
+
describe("edit mode", () => {
it("should not show the info icon", () => {
setup({ isEditing: true });
diff --git a/frontend/src/metabase/dashboard/utils.ts b/frontend/src/metabase/dashboard/utils.ts
index ddefd88a5a6..53bd1842bea 100644
--- a/frontend/src/metabase/dashboard/utils.ts
+++ b/frontend/src/metabase/dashboard/utils.ts
@@ -259,17 +259,21 @@ export function isDashcardLoading(
return cardData.length === 0 || cardData.some((data) => data == null);
}
-export function getDashcardResultsError(
- datasets: Dataset[],
- isGuestEmbed: boolean,
+export function isDashcardAccessRestricted(
+ datasets: ReadonlyArray<Pick<Dataset, "error" | "error_type">>,
) {
- const isAccessRestricted = datasets.some(
+ return datasets.some(
(s) =>
s.error_type === SERVER_ERROR_TYPES.missingPermissions ||
(typeof s.error === "object" && s.error?.status === 403),
);
+}
- if (isAccessRestricted) {
+export function getDashcardResultsError(
+ datasets: Dataset[],
+ isGuestEmbed: boolean,
+) {
+ if (isDashcardAccessRestricted(datasets)) {
return {
message: getPermissionErrorMessage(),
icon: "key" as const,
diff --git a/frontend/src/metabase/visualizer/utils/merge-data.ts b/frontend/src/metabase/visualizer/utils/merge-data.ts
index 48f670e3259..4928076ef96 100644
--- a/frontend/src/metabase/visualizer/utils/merge-data.ts
+++ b/frontend/src/metabase/visualizer/utils/merge-data.ts
@@ -51,7 +51,8 @@ export function mergeVisualizerData({
const insights: Insight[] = [];
referencedColumns.forEach((ref) => {
const dataset = datasets[ref.sourceId];
- if (!dataset) {
+ // Errored datasets (e.g. permission denied) may not carry `data`.
+ if (!dataset || dataset.error != null) {
return;
}
const columnIndex = dataset.data.cols.findIndex(
diff --git a/frontend/src/metabase/visualizer/utils/merge-data.unit.spec.ts b/frontend/src/metabase/visualizer/utils/merge-data.unit.spec.ts
index c7b3915e0d6..7ad4003fd29 100644
--- a/frontend/src/metabase/visualizer/utils/merge-data.unit.spec.ts
+++ b/frontend/src/metabase/visualizer/utils/merge-data.unit.spec.ts
@@ -1,4 +1,5 @@
import { NumberColumn, StringColumn } from "__support__/visualizations";
+import { SERVER_ERROR_TYPES } from "metabase/utils/errors";
import { createMockColumn, createMockDataset } from "metabase-types/api/mocks";
import { mergeVisualizerData } from "./merge-data";
@@ -118,4 +119,41 @@ describe("mergeVisualizerData", () => {
"COLUMN_3",
]);
});
+
+ it.each([
+ { label: "undefined", dataset: undefined },
+ { label: "null", dataset: null },
+ {
+ label: "errored (e.g. permission denied)",
+ dataset: createMockDataset({
+ error: { status: 403 },
+ error_type: SERVER_ERROR_TYPES.missingPermissions,
+ }),
+ },
+ ])(
+ "should return an empty merge when a referenced dataset is $label",
+ ({ dataset }) => {
+ const column = createMockColumn(StringColumn({ name: "COLUMN_1" }));
+ const result = mergeVisualizerData({
+ columns: [column],
+ columnValuesMapping: {
+ COLUMN_1: [
+ {
+ sourceId: "card:1",
+ originalName: "CREATED_AT",
+ name: "COLUMN_1",
+ },
+ ],
+ },
+ datasets: { "card:1": dataset },
+ dataSources: [
+ { id: "card:1", sourceId: 1, type: "card", name: "Chart 1" },
+ ],
+ });
+
+ expect(result.cols).toEqual([column]);
+ expect(result.rows).toEqual([]);
+ expect(result.insights).toEqual([]);
+ },
+ );
});