Skip to content

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

Handle error response when reverting cards and dashboards (#74145)

Nick Fitzpatrick775c990ab30d
diff --git a/e2e/test/scenarios/dashboard/dashboard.cy.spec.js b/e2e/test/scenarios/dashboard/dashboard.cy.spec.js
index c36c30d79a6..ae45e08dd7a 100644
--- a/e2e/test/scenarios/dashboard/dashboard.cy.spec.js
+++ b/e2e/test/scenarios/dashboard/dashboard.cy.spec.js
@@ -1493,6 +1493,20 @@ describe("scenarios > dashboard", () => {
event: "revert_version_clicked",
event_detail: "dashboard",
});
+
+ // Simulate a backend failure on revert and confirm we surface
+ // the error message as a toast (UXW-310).
+ cy.intercept("POST", "/api/revision/revert", {
+ statusCode: 500,
+ body: { message: "Cannot revert: missing dashboard" },
+ }).as("failedRevert");
+
+ H.sidesheet().within(() => {
+ cy.findAllByTestId("question-revert-button").first().click();
+ });
+ cy.wait("@failedRevert");
+
+ H.undoToast().should("contain.text", "Cannot revert: missing dashboard");
});
});
});
diff --git a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts
index 6a232c51bdd..3144fca254b 100644
--- a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts
@@ -2626,6 +2626,20 @@ LIMIT
cy.findByTestId("transform-history-list")
.findByText(/reverted to an earlier version/)
.should("be.visible");
+
+ cy.log("Surface backend error when a revert fails (UXW-310)");
+ cy.intercept("POST", "/api/revision/revert", {
+ statusCode: 500,
+ body: { message: "Cannot revert: missing transform" },
+ }).as("failedRevert");
+
+ cy.findByTestId("transform-history-list")
+ .findAllByTestId("question-revert-button")
+ .first()
+ .click();
+ cy.wait("@failedRevert");
+
+ H.undoToast().should("contain.text", "Cannot revert: missing transform");
});
});
diff --git a/e2e/test/scenarios/documents/documents.cy.spec.ts b/e2e/test/scenarios/documents/documents.cy.spec.ts
index 968cdca4d1b..afc0ce2aecd 100644
--- a/e2e/test/scenarios/documents/documents.cy.spec.ts
+++ b/e2e/test/scenarios/documents/documents.cy.spec.ts
@@ -1898,6 +1898,20 @@ describe("documents", () => {
cy.findByTestId("document-history-list")
.findByText(/reverted to an earlier version/)
.should("be.visible");
+
+ cy.log("Surface backend error when a revert fails (UXW-310)");
+ cy.intercept("POST", "/api/revision/revert", {
+ statusCode: 500,
+ body: { message: "Cannot revert: missing document" },
+ }).as("failedRevert");
+
+ cy.findByTestId("document-history-list")
+ .findAllByTestId("question-revert-button")
+ .first()
+ .click();
+ cy.wait("@failedRevert");
+
+ H.undoToast().should("contain.text", "Cannot revert: missing document");
});
});
});
diff --git a/e2e/test/scenarios/metrics/metric-page.cy.spec.ts b/e2e/test/scenarios/metrics/metric-page.cy.spec.ts
index 4545a914219..1a4644b8a62 100644
--- a/e2e/test/scenarios/metrics/metric-page.cy.spec.ts
+++ b/e2e/test/scenarios/metrics/metric-page.cy.spec.ts
@@ -259,6 +259,23 @@ describe("scenarios > metrics > metric page", () => {
H.getNotebookStep("summarize")
.findByText("Sum of Total")
.should("be.visible");
+ H.undoToast().should("contain.text", "Metric query updated");
+ H.undoToast().findByRole("img", { name: /close/ }).click();
+
+ cy.log("surface backend error when a revert fails (UXW-310)");
+ cy.intercept("POST", "/api/revision/revert", {
+ statusCode: 500,
+ body: { message: "Cannot revert: missing metric" },
+ }).as("failedRevert");
+
+ H.MetricPage.historyTab().click();
+ cy.findByTestId("saved-question-history-list")
+ .findAllByTestId("question-revert-button")
+ .first()
+ .click();
+ cy.wait("@failedRevert");
+
+ H.undoToast().should("contain.text", "Cannot revert: missing metric");
});
it("should add metric to dashboard and move to trash via more menu", () => {
diff --git a/e2e/test/scenarios/question/saved.cy.spec.js b/e2e/test/scenarios/question/saved.cy.spec.js
index 3a93ca0cd49..b3bf623c2d6 100644
--- a/e2e/test/scenarios/question/saved.cy.spec.js
+++ b/e2e/test/scenarios/question/saved.cy.spec.js
@@ -208,7 +208,19 @@ describe("scenarios > question > saved", () => {
cy.findByRole("tab", { name: "History" }).click();
cy.findByText(/reverted to an earlier version/i);
cy.findByText(/This is a question/i).should("not.exist");
+
+ // Simulate a backend failure on revert and confirm we surface
+ // the error message as a toast (UXW-310).
+ cy.intercept("POST", "/api/revision/revert", {
+ statusCode: 500,
+ body: { message: "Cannot revert: missing card" },
+ }).as("failedRevert");
+
+ cy.findAllByTestId("question-revert-button").first().click();
+ cy.wait("@failedRevert");
});
+
+ H.undoToast().should("contain.text", "Cannot revert: missing card");
});
it("should show collection breadcrumbs for a saved question in the root collection", () => {
diff --git a/frontend/src/metabase/common/components/RevisionHistoryTimeline/RevisionHistoryTimeline.tsx b/frontend/src/metabase/common/components/RevisionHistoryTimeline/RevisionHistoryTimeline.tsx
index d1e04feb650..3e959b500d0 100644
--- a/frontend/src/metabase/common/components/RevisionHistoryTimeline/RevisionHistoryTimeline.tsx
+++ b/frontend/src/metabase/common/components/RevisionHistoryTimeline/RevisionHistoryTimeline.tsx
@@ -1,7 +1,10 @@
import { t } from "ttag";
+import { getErrorMessage } from "metabase/api/utils/errors";
import { getFormattedTime } from "metabase/common/components/DateTime/DateTime";
import type { RevisionOrModerationEvent } from "metabase/plugins";
+import { useDispatch } from "metabase/redux";
+import { addUndo } from "metabase/redux/undo";
import { Box, Button, Center, Flex, Icon, Text, Tooltip } from "metabase/ui";
import { getRelativeTime } from "metabase/utils/time-dayjs";
import type { Revision } from "metabase-types/api";
@@ -18,7 +21,9 @@ export type RevisionHistoryEntity =
interface RevisionHistoryTimelineProps {
entity: RevisionHistoryEntity;
events: RevisionOrModerationEvent[];
- revert: (revision: Revision) => void;
+ // Must reject on failure so the timeline can surface a toast. RTK Query
+ // callers should pipe the trigger result through `.unwrap()`.
+ revert: (revision: Revision) => Promise<unknown>;
canWrite: boolean;
className?: string;
"data-testid": string;
@@ -32,6 +37,26 @@ export function RevisionHistoryTimeline({
className,
entity,
}: RevisionHistoryTimelineProps) {
+ const dispatch = useDispatch();
+
+ const handleRevert = async (revision: Revision) => {
+ trackVersionRevertClicked(entity);
+ try {
+ await revert(revision);
+ } catch (error) {
+ dispatch(
+ addUndo({
+ icon: "warning",
+ toastColor: "error",
+ message: getErrorMessage(
+ error,
+ t`Failed to revert to previous version.`,
+ ),
+ }),
+ );
+ }
+ };
+
return (
<Box className={className} data-testid={dataTestId}>
<Box className={S.root}>
@@ -74,10 +99,7 @@ export function RevisionHistoryTimeline({
<Button
className={S.revertButton}
variant="subtle"
- onClick={() => {
- trackVersionRevertClicked(entity);
- revert(revision);
- }}
+ onClick={() => handleRevert(revision)}
data-testid="question-revert-button"
aria-label={t`revert to ${title}`}
>
diff --git a/frontend/src/metabase/common/components/RevisionHistoryTimeline/RevisionHistoryTimeline.unit.spec.tsx b/frontend/src/metabase/common/components/RevisionHistoryTimeline/RevisionHistoryTimeline.unit.spec.tsx
new file mode 100644
index 00000000000..367dcca1ae4
--- /dev/null
+++ b/frontend/src/metabase/common/components/RevisionHistoryTimeline/RevisionHistoryTimeline.unit.spec.tsx
@@ -0,0 +1,95 @@
+import userEvent from "@testing-library/user-event";
+
+import { renderWithProviders, screen, waitFor } from "__support__/ui";
+import type { RevisionOrModerationEvent } from "metabase/plugins";
+import { createMockRevision } from "metabase-types/api/mocks/revision";
+
+import { RevisionHistoryTimeline } from "./RevisionHistoryTimeline";
+
+const events: RevisionOrModerationEvent[] = [
+ {
+ title: "edited this",
+ timestamp: "2026-05-15T10:00:00Z",
+ icon: "pencil",
+ revision: createMockRevision({ id: 2 }),
+ },
+ {
+ title: "created this",
+ timestamp: "2026-05-14T10:00:00Z",
+ icon: "pencil",
+ revision: createMockRevision({ id: 1 }),
+ },
+];
+
+function setup({
+ revert,
+}: {
+ revert: (revision: unknown) => Promise<unknown>;
+}) {
+ return renderWithProviders(
+ <RevisionHistoryTimeline
+ entity="card"
+ events={events}
+ revert={revert}
+ canWrite
+ data-testid="history-list"
+ />,
+ );
+}
+
+describe("RevisionHistoryTimeline", () => {
+ it("shows an error toast with the backend-provided message when revert fails", async () => {
+ const revert = jest.fn().mockRejectedValue({
+ data: { message: "Cannot revert: missing card" },
+ });
+
+ const { store } = setup({ revert });
+
+ await userEvent.click(
+ (await screen.findAllByTestId("question-revert-button"))[0],
+ );
+
+ await waitFor(() => {
+ expect(store.getState().undo).toHaveLength(1);
+ });
+ expect(store.getState().undo[0]).toMatchObject({
+ toastColor: "error",
+ icon: "warning",
+ message: "Cannot revert: missing card",
+ });
+ });
+
+ it("falls back to a generic message when the error has no message", async () => {
+ const revert = jest.fn().mockRejectedValue({});
+
+ const { store } = setup({ revert });
+
+ await userEvent.click(
+ (await screen.findAllByTestId("question-revert-button"))[0],
+ );
+
+ await waitFor(() => {
+ expect(store.getState().undo).toHaveLength(1);
+ });
+ expect(store.getState().undo[0]).toMatchObject({
+ toastColor: "error",
+ icon: "warning",
+ message: "Failed to revert to previous version.",
+ });
+ });
+
+ it("does not show a toast when revert succeeds", async () => {
+ const revert = jest.fn().mockResolvedValue(undefined);
+
+ const { store } = setup({ revert });
+
+ await userEvent.click(
+ (await screen.findAllByTestId("question-revert-button"))[0],
+ );
+
+ await waitFor(() => {
+ expect(revert).toHaveBeenCalled();
+ });
+ expect(store.getState().undo).toHaveLength(0);
+ });
+});
diff --git a/frontend/src/metabase/documents/components/DocumentRevisionHistorySidebar.tsx b/frontend/src/metabase/documents/components/DocumentRevisionHistorySidebar.tsx
index 902137c8662..ef557f76ff1 100644
--- a/frontend/src/metabase/documents/components/DocumentRevisionHistorySidebar.tsx
+++ b/frontend/src/metabase/documents/components/DocumentRevisionHistorySidebar.tsx
@@ -67,7 +67,7 @@ export function DocumentRevisionHistorySidebar({
entity: "document",
id: document.id,
revision_id: revision.id,
- })
+ }).unwrap()
}
canWrite={canWrite}
entity="document"
diff --git a/frontend/src/metabase/metrics/components/MetricActivityTimeline/MetricActivityTimeline.tsx b/frontend/src/metabase/metrics/components/MetricActivityTimeline/MetricActivityTimeline.tsx
index ca6340c3a39..ef5e8b69b89 100644
--- a/frontend/src/metabase/metrics/components/MetricActivityTimeline/MetricActivityTimeline.tsx
+++ b/frontend/src/metabase/metrics/components/MetricActivityTimeline/MetricActivityTimeline.tsx
@@ -50,7 +50,7 @@ export function MetricActivityTimeline({ card }: MetricActivityTimelineProps) {
entity: "card",
id: card.id,
revision_id: revision.id,
- })
+ }).unwrap()
}
canWrite={card.can_write}
entity="card"
diff --git a/frontend/src/metabase/transforms/components/TransformRevisionHistorySidebar/TransformRevisionHistorySidebar.tsx b/frontend/src/metabase/transforms/components/TransformRevisionHistorySidebar/TransformRevisionHistorySidebar.tsx
index 4164f5e8d78..54cb0a03bab 100644
--- a/frontend/src/metabase/transforms/components/TransformRevisionHistorySidebar/TransformRevisionHistorySidebar.tsx
+++ b/frontend/src/metabase/transforms/components/TransformRevisionHistorySidebar/TransformRevisionHistorySidebar.tsx
@@ -71,7 +71,7 @@ export function TransformRevisionHistorySidebar({
entity: "transform",
id: transform.id,
revision_id: revision.id,
- })
+ }).unwrap()
}
entity="transform"
canWrite={!readOnly}