The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
UXW-2333 Add revision history to transforms and documents (#66989)
Gabriel Morenoc13f91f92258
diff --git a/e2e/test/scenarios/data-studio/transforms.cy.spec.ts b/e2e/test/scenarios/data-studio/transforms.cy.spec.tsindex b5a0435b47d..0126eb51a34 100644--- a/e2e/test/scenarios/data-studio/transforms.cy.spec.ts+++ b/e2e/test/scenarios/data-studio/transforms.cy.spec.ts@@ -2010,6 +2010,71 @@ LIMITcy.findByTestId("python-library-header").should("be.visible");});});++ describe("revision history", () => {+ beforeEach(() => {+ cy.intercept("POST", "/api/revision/revert").as("revert");+ cy.intercept("GET", "/api/revision*").as("revisionHistory");+ });++ it("should be able to view and revert transform revisions", () => {+ cy.log("Create a transform with initial name");+ createMbqlTransform({+ name: "Revision Test Transform",+ visitTransform: true,+ });++ cy.log("Make changes to create a revision");+ H.DataStudio.Transforms.header()+ .findByPlaceholderText("Name")+ .clear()+ .type("Updated Transform Name")+ .blur();+ cy.wait("@updateTransform");++ cy.log("Make another change");+ H.DataStudio.Transforms.header()+ .findByPlaceholderText("Name")+ .clear()+ .type("Another Updated Name")+ .blur();+ cy.wait("@updateTransform");++ cy.log("Open revision history");+ H.DataStudio.Transforms.header().icon("ellipsis").click();+ H.popover().findByText("History").click();++ cy.wait("@revisionHistory");++ cy.log("Verify revision history sidebar is open");+ cy.findByTestId("transform-history-list").should("be.visible");++ cy.log("Verify revision entries are displayed");+ cy.findByTestId("transform-history-list")+ .findByText(/created this/)+ .should("be.visible");++ cy.log("Revert to an earlier revision");+ cy.intercept("GET", "/api/ee/transform/*").as("transformReload");+ cy.findByTestId("transform-history-list")+ .findByText(/created this/)+ .parent()+ .within(() => {+ cy.findByTestId("question-revert-button").click();+ });+ cy.wait(["@revert", "@transformReload"]);++ cy.log("Verify transform was reverted");+ H.DataStudio.Transforms.header()+ .findByPlaceholderText("Name")+ .should("have.value", "Revision Test Transform");++ cy.log("Verify revert entry appears in history");+ cy.findByTestId("transform-history-list")+ .findByText(/reverted to an earlier version/)+ .should("be.visible");+ });+ });});describe("scenarios > admin > transforms > databases without :schemas", () => {diff --git a/e2e/test/scenarios/documents/documents.cy.spec.ts b/e2e/test/scenarios/documents/documents.cy.spec.tsindex 27683a27c29..7d7887702ce 100644--- a/e2e/test/scenarios/documents/documents.cy.spec.ts+++ b/e2e/test/scenarios/documents/documents.cy.spec.ts@@ -1284,6 +1284,87 @@ describe("documents", () => {H.documentSaveButton().should("be.visible");});});++ describe("revision history", () => {+ beforeEach(() => {+ cy.intercept("POST", "/api/revision/revert").as("revert");+ cy.intercept("GET", "/api/revision*").as("revisionHistory");+ });++ it("should be able to view and revert document revisions", () => {+ cy.log("Create a document with initial content");+ H.createDocument({+ name: "Revision Test Document",+ document: {+ type: "doc",+ content: [+ {+ type: "paragraph",+ content: [+ {+ type: "text",+ text: "Initial content",+ },+ ],+ },+ ],+ },+ idAlias: "documentId",+ });++ H.visitDocument("@documentId");++ cy.log("Make changes to create a revision");+ cy.findByRole("textbox", { name: "Document Title" })+ .clear()+ .type("Updated Document Title");+ H.documentContent().click();+ H.addToDocument("Updated content");+ H.documentSaveButton().click();++ cy.log("Make another change");+ H.documentContent().click();+ H.addToDocument("More changes");+ H.documentSaveButton().click();++ cy.log("Open revision history");+ cy.findByLabelText("More options").click();+ H.popover().findByText("History").click();++ cy.wait("@revisionHistory");++ cy.log("Verify revision history sidebar is open");+ cy.findByTestId("document-history-list").should("be.visible");++ cy.log("Verify revision entries are displayed");+ cy.findByTestId("document-history-list")+ .findByText(/created this/)+ .should("be.visible");++ cy.log("Revert to an earlier revision");+ cy.intercept("GET", "/api/document/*").as("documentReload");+ cy.findByTestId("document-history-list")+ .findByText(/created this/)+ .parent()+ .within(() => {+ cy.findByTestId("question-revert-button").click();+ });+ cy.wait(["@revert", "@documentReload"]);++ cy.log("Verify document was reverted");+ cy.findByRole("textbox", { name: "Document Title" }).should(+ "have.value",+ "Revision Test Document",+ );+ H.documentContent().should("contain.text", "Initial content");+ H.documentContent().should("not.contain.text", "Updated content");++ cy.log("Verify revert entry appears in history");+ cy.findByTestId("document-history-list")+ .findByText(/reverted to an earlier version/)+ .should("be.visible");+ });+ });});const assertOnlyOneOptionActive = (diff --git a/enterprise/frontend/src/metabase-enterprise/api/transform.ts b/enterprise/frontend/src/metabase-enterprise/api/transform.tsindex e5f5b2bfa53..091a1ad3201 100644--- a/enterprise/frontend/src/metabase-enterprise/api/transform.ts+++ b/enterprise/frontend/src/metabase-enterprise/api/transform.ts@@ -160,7 +160,11 @@ export const transformApi = EnterpriseApi.injectEndpoints({body,}),invalidatesTags: (_, error, { id, collection_id }) => {- const tags = [listTag("transform"), idTag("transform", id)];+ const tags = [+ listTag("transform"),+ idTag("transform", id),+ listTag("revision"),+ ];if (collection_id != null) {tags.push(idTag("collection", collection_id));}diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/TransformHeader/TransformMoreMenu/TransformMoreMenu.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/TransformHeader/TransformMoreMenu/TransformMoreMenu.tsxindex d962e8130a5..07209206192 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/components/TransformHeader/TransformMoreMenu/TransformMoreMenu.tsx+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/TransformHeader/TransformMoreMenu/TransformMoreMenu.tsx@@ -8,6 +8,8 @@ import { useMetadataToasts } from "metabase/metadata/hooks";import { ActionIcon, Icon, Menu } from "metabase/ui";import type { Transform } from "metabase-types/api";+import { TransformRevisionHistorySidebar } from "../../TransformRevisionHistorySidebar";+import { DeleteTransformModal } from "./DeleteTransformModal";import { MoveTransformModal } from "./MoveTransformModal";import type { TransformMoreMenuModalType } from "./types";@@ -18,10 +20,14 @@ type TransformMoreMenuProps = {export function TransformMoreMenu({ transform }: TransformMoreMenuProps) {const [modalType, setModalType] = useState<TransformMoreMenuModalType>();+ const [isHistorySidebarOpen, setIsHistorySidebarOpen] = useState(false);return (<>- <TransformMenu onOpenModal={setModalType} />+ <TransformMenu+ onOpenModal={setModalType}+ onShowHistory={() => setIsHistorySidebarOpen(true)}+ />{modalType != null && (<TransformModaltransform={transform}@@ -29,15 +35,22 @@ export function TransformMoreMenu({ transform }: TransformMoreMenuProps) {onClose={() => setModalType(undefined)}/>)}+ {isHistorySidebarOpen && (+ <TransformRevisionHistorySidebar+ transform={transform}+ onClose={() => setIsHistorySidebarOpen(false)}+ />+ )}</>);}type TransformMenuProps = {onOpenModal: (modalType: TransformMoreMenuModalType) => void;+ onShowHistory: () => void;};-function TransformMenu({ onOpenModal }: TransformMenuProps) {+function TransformMenu({ onOpenModal, onShowHistory }: TransformMenuProps) {const handleIconClick = (event: MouseEvent) => {event.preventDefault();event.stopPropagation();@@ -51,6 +64,12 @@ function TransformMenu({ onOpenModal }: TransformMenuProps) {</ActionIcon></Menu.Target><Menu.Dropdown>+ <Menu.Item+ leftSection={<Icon name="history" />}+ onClick={onShowHistory}+ >+ {t`History`}+ </Menu.Item><Menu.ItemleftSection={<Icon name="move" />}onClick={() => onOpenModal("move")}diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/TransformRevisionHistorySidebar/TransformRevisionHistorySidebar.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/TransformRevisionHistorySidebar/TransformRevisionHistorySidebar.tsxnew file mode 100644index 00000000000..e99c1b667a8--- /dev/null+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/TransformRevisionHistorySidebar/TransformRevisionHistorySidebar.tsx@@ -0,0 +1,81 @@+import { useHotkeys } from "@mantine/hooks";+import { useMemo, useState } from "react";+import { useMount } from "react-use";+import { t } from "ttag";++import {+ skipToken,+ useListRevisionsQuery,+ useRevertRevisionMutation,+} from "metabase/api";+import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";+import { Sidesheet, SidesheetCard } from "metabase/common/components/Sidesheet";+import { Timeline } from "metabase/common/components/Timeline";+import { getTimelineEvents } from "metabase/common/components/Timeline/utils";+import { useSelector } from "metabase/lib/redux";+import { getUser } from "metabase/selectors/user";+import type { Transform } from "metabase-types/api";++interface TransformRevisionHistorySidebarProps {+ transform: Transform;+ onClose: () => void;+}++export function TransformRevisionHistorySidebar({+ transform,+ onClose,+}: TransformRevisionHistorySidebarProps) {+ const [isOpen, setIsOpen] = useState(false);+ const currentUser = useSelector(getUser);++ useHotkeys([["]", onClose]]);++ useMount(() => {+ setIsOpen(true);+ });++ const {+ data: revisions,+ isLoading,+ error,+ } = useListRevisionsQuery(+ transform ? { id: transform.id, entity: "transform" } : skipToken,+ );+ const [revertToRevision] = useRevertRevisionMutation();++ const events = useMemo(() => {+ const revisionEvents = getTimelineEvents({ revisions, currentUser });+ return revisionEvents.sort(+ (a, b) =>+ new Date(b.timestamp).getTime() - new Date(a.timestamp).getTime(),+ );+ }, [revisions, currentUser]);++ if (isLoading || error) {+ return;+ }++ return (+ <Sidesheet isOpen={isOpen} title={t`History`} onClose={onClose}>+ <SidesheetCard>+ {isLoading || error ? (+ <LoadingAndErrorWrapper loading={isLoading} error={error} />+ ) : (+ <Timeline+ events={events}+ data-testid="transform-history-list"+ revert={(revision) =>+ revertToRevision({+ entity: "transform",+ id: transform.id,+ revision_id: revision.id,+ })+ }+ entity="transform"+ canWrite+ />+ )}+ </SidesheetCard>+ </Sidesheet>+ );+}diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/TransformRevisionHistorySidebar/TransformRevisionHistorySidebar.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/TransformRevisionHistorySidebar/TransformRevisionHistorySidebar.unit.spec.tsxnew file mode 100644index 00000000000..97c82c713f8--- /dev/null+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/TransformRevisionHistorySidebar/TransformRevisionHistorySidebar.unit.spec.tsx@@ -0,0 +1,136 @@+import userEvent from "@testing-library/user-event";++import {+ setupTransformRevisionsEndpoint,+ setupUsersEndpoints,+} from "__support__/server-mocks";+import {+ renderWithProviders,+ screen,+ waitForLoaderToBeRemoved,+} from "__support__/ui";+import type { Revision, Transform } from "metabase-types/api";+import {+ createMockRevision,+ createMockTransform,+ createMockUser,+} from "metabase-types/api/mocks";+import { createMockState } from "metabase-types/store/mocks";++import { TransformRevisionHistorySidebar } from "./TransformRevisionHistorySidebar";++const mockUser = createMockUser();++const mockRevisions: Revision[] = [+ createMockRevision({+ id: 2,+ description: 'renamed this Transform from "Old Name" to "Test Transform".',+ timestamp: "2024-01-02T10:00:00Z",+ user: {+ id: mockUser.id,+ first_name: mockUser.first_name ?? "",+ last_name: mockUser.last_name ?? "",+ common_name: mockUser.common_name ?? "",+ },+ }),+ createMockRevision({+ id: 1,+ description: "created this.",+ timestamp: "2024-01-01T10:00:00Z",+ is_creation: true,+ user: {+ id: mockUser.id,+ first_name: mockUser.first_name ?? "",+ last_name: mockUser.last_name ?? "",+ common_name: mockUser.common_name ?? "",+ },+ }),+];++const mockTransform = createMockTransform({+ id: 1,+ name: "Test Transform",+});++function setup({+ transform = mockTransform,+ revisions = mockRevisions,+}: {+ transform?: Transform;+ revisions?: Revision[];+} = {}) {+ const onClose = jest.fn();+ const currentUser = mockUser;++ setupTransformRevisionsEndpoint(transform.id, revisions);+ setupUsersEndpoints([currentUser]);++ const state = createMockState({+ currentUser,+ });++ renderWithProviders(+ <TransformRevisionHistorySidebar transform={transform} onClose={onClose} />,+ { storeInitialState: state },+ );++ return { onClose, transform };+}++describe("TransformRevisionHistorySidebar", () => {+ it("should render the sidebar when open", async () => {+ setup();++ await waitForLoaderToBeRemoved();++ expect(await screen.findByText("History")).toBeInTheDocument();+ expect(+ await screen.findByTestId("transform-history-list"),+ ).toBeInTheDocument();+ });++ it("should display revision history entries", async () => {+ setup();++ await waitForLoaderToBeRemoved();++ expect(await screen.findByText(/created this/)).toBeInTheDocument();+ expect(+ await screen.findByText(/renamed this Transform/),+ ).toBeInTheDocument();+ });++ it("should show revert buttons", async () => {+ setup();++ await waitForLoaderToBeRemoved();++ await screen.findByText(/created this/);+ await screen.findByText(/renamed this Transform/);++ const revertButtons = screen.getAllByTestId("question-revert-button");+ expect(revertButtons).toHaveLength(1);+ });++ it("should handle empty revisions", async () => {+ setup({ revisions: [] });++ await waitForLoaderToBeRemoved();++ expect(+ await screen.findByTestId("transform-history-list"),+ ).toBeInTheDocument();+ });++ it("should call onClose when close button is clicked", async () => {+ const { onClose } = setup();++ await waitForLoaderToBeRemoved();+ await screen.findByText("History");++ const closeButton = screen.getByRole("button", { name: /close/i });+ await userEvent.click(closeButton);++ expect(onClose).toHaveBeenCalledTimes(1);+ });+});diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/TransformRevisionHistorySidebar/index.ts b/enterprise/frontend/src/metabase-enterprise/transforms/components/TransformRevisionHistorySidebar/index.tsnew file mode 100644index 00000000000..3af7dbfbaa8--- /dev/null+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/TransformRevisionHistorySidebar/index.ts@@ -0,0 +1 @@+export { TransformRevisionHistorySidebar } from "./TransformRevisionHistorySidebar";diff --git a/frontend/src/metabase-types/analytics/event.ts b/frontend/src/metabase-types/analytics/event.tsindex 27aa76016ac..3289ade8df2 100644--- a/frontend/src/metabase-types/analytics/event.ts+++ b/frontend/src/metabase-types/analytics/event.ts@@ -400,7 +400,7 @@ export type MetabotEvent =export type RevertVersionEvent = ValidateEvent<{event: "revert_version_clicked";- event_detail: "card" | "dashboard";+ event_detail: "card" | "dashboard" | "document" | "transform";}>;export type LearnAboutDataClickedEvent = ValidateEvent<{diff --git a/frontend/src/metabase-types/api/revision.ts b/frontend/src/metabase-types/api/revision.tsindex f17c2a09ae3..79287006aea 100644--- a/frontend/src/metabase-types/api/revision.ts+++ b/frontend/src/metabase-types/api/revision.ts@@ -33,12 +33,12 @@ export interface Revision {}export interface ListRevisionRequest {- entity: "card" | "dashboard" | "segment";+ entity: "card" | "dashboard" | "segment" | "document" | "transform";id: number | string;}export interface RevertRevisionRequest {- entity: "card" | "dashboard" | "segment";+ entity: "card" | "dashboard" | "segment" | "document" | "transform";id: number | string;revision_id: number;}diff --git a/frontend/src/metabase-types/store/documents.ts b/frontend/src/metabase-types/store/documents.tsindex 4dc20f797ab..6d3efa15872 100644--- a/frontend/src/metabase-types/store/documents.ts+++ b/frontend/src/metabase-types/store/documents.ts@@ -21,4 +21,5 @@ export interface DocumentsState {childTargetId: string | undefined;hoveredChildTargetId: string | undefined;hasUnsavedChanges: boolean;+ isHistorySidebarOpen: boolean;}diff --git a/frontend/src/metabase/api/document.ts b/frontend/src/metabase/api/document.tsindex 593fd7e1c03..5c5985687a9 100644--- a/frontend/src/metabase/api/document.ts+++ b/frontend/src/metabase/api/document.ts@@ -44,7 +44,9 @@ export const documentApi = Api.injectEndpoints({body: document,}),invalidatesTags: (_, error, { id }) =>- !error ? [listTag("document"), idTag("document", id)] : [],+ !error+ ? [listTag("document"), idTag("document", id), listTag("revision")]+ : [],}),deleteDocument: builder.mutation<void, DeleteDocumentRequest>({query: (document) => ({diff --git a/frontend/src/metabase/api/revision.ts b/frontend/src/metabase/api/revision.tsindex 2430bbcf092..d813a45a78e 100644--- a/frontend/src/metabase/api/revision.ts+++ b/frontend/src/metabase/api/revision.ts@@ -5,7 +5,12 @@ import type {} from "metabase-types/api";import { Api } from "./api";-import { invalidateTags, listTag, provideRevisionListTags } from "./tags";+import {+ idTag,+ invalidateTags,+ listTag,+ provideRevisionListTags,+} from "./tags";export const revisionApi = Api.injectEndpoints({endpoints: (builder) => ({@@ -23,8 +28,22 @@ export const revisionApi = Api.injectEndpoints({url: "/api/revision/revert",body,}),- invalidatesTags: (_, error) =>- invalidateTags(error, [listTag("revision")]),+ invalidatesTags: (_, error, { entity, id }) => {+ const tags = [listTag("revision")];+ // Also invalidate the entity that was reverted so it refetches+ if (entity === "card") {+ tags.push(idTag("card", id));+ } else if (entity === "dashboard") {+ tags.push(idTag("dashboard", id));+ } else if (entity === "document") {+ tags.push(idTag("document", id));+ } else if (entity === "segment") {+ tags.push(idTag("segment", id));+ } else if (entity === "transform") {+ tags.push(idTag("transform", id));+ }+ return invalidateTags(error, tags);+ },}),}),});diff --git a/frontend/src/metabase/common/components/Timeline/Timeline.tsx b/frontend/src/metabase/common/components/Timeline/Timeline.tsxindex 563bab30681..2ac212299b8 100644--- a/frontend/src/metabase/common/components/Timeline/Timeline.tsx+++ b/frontend/src/metabase/common/components/Timeline/Timeline.tsx@@ -24,7 +24,7 @@ interface TimelineProps {canWrite: boolean;revert: (revision: Revision) => void;className?: string;- entity: "card" | "dashboard";+ entity: "card" | "dashboard" | "document" | "transform";}export function Timeline({diff --git a/frontend/src/metabase/common/components/Timeline/analytics.ts b/frontend/src/metabase/common/components/Timeline/analytics.tsindex df6e98d749a..fb545b1cbc1 100644--- a/frontend/src/metabase/common/components/Timeline/analytics.ts+++ b/frontend/src/metabase/common/components/Timeline/analytics.ts@@ -1,6 +1,8 @@import { trackSimpleEvent } from "metabase/lib/analytics";-export const trackVersionRevertClicked = (entity: "card" | "dashboard") => {+export const trackVersionRevertClicked = (+ entity: "card" | "dashboard" | "document" | "transform",+) => {trackSimpleEvent({event: "revert_version_clicked",event_detail: entity,diff --git a/frontend/src/metabase/documents/components/DocumentHeader.tsx b/frontend/src/metabase/documents/components/DocumentHeader.tsxindex 6e95181b976..ee1d87cf22d 100644--- a/frontend/src/metabase/documents/components/DocumentHeader.tsx+++ b/frontend/src/metabase/documents/components/DocumentHeader.tsx@@ -50,6 +50,7 @@ interface DocumentHeaderProps {onMove: () => void;onToggleBookmark: () => void;onArchive: () => void;+ onShowHistory: () => void;hasComments?: boolean;}@@ -66,6 +67,7 @@ export const DocumentHeader = ({onMove,onToggleBookmark,onArchive,+ onShowHistory,hasComments = false,}: DocumentHeaderProps) => {const isPublicSharingEnabled = useSetting("enable-public-sharing");@@ -244,6 +246,12 @@ export const DocumentHeader = ({>{isBookmarked ? t`Remove from Bookmarks` : t`Bookmark`}</Menu.Item>+ <Menu.Item+ leftSection={<Icon name="history" />}+ onClick={onShowHistory}+ >+ {t`History`}+ </Menu.Item>{canWrite && (<><Menu.Divider />diff --git a/frontend/src/metabase/documents/components/DocumentHeader.unit.spec.tsx b/frontend/src/metabase/documents/components/DocumentHeader.unit.spec.tsxindex e61c1a68b52..6def6668f98 100644--- a/frontend/src/metabase/documents/components/DocumentHeader.unit.spec.tsx+++ b/frontend/src/metabase/documents/components/DocumentHeader.unit.spec.tsx@@ -26,6 +26,7 @@ const setup = ({onMove = jest.fn(),onToggleBookmark = jest.fn(),onArchive = jest.fn(),+ onShowHistory = jest.fn(),onToggleComments = jest.fn(),} = {}) => {const props = {@@ -40,6 +41,7 @@ const setup = ({onMove,onToggleBookmark,onArchive,+ onShowHistory,onToggleComments,};diff --git a/frontend/src/metabase/documents/components/DocumentPage.tsx b/frontend/src/metabase/documents/components/DocumentPage.tsxindex 507ba136959..8cdcc24596f 100644--- a/frontend/src/metabase/documents/components/DocumentPage.tsx+++ b/frontend/src/metabase/documents/components/DocumentPage.tsx@@ -59,12 +59,14 @@ import {setChildTargetId,setCurrentDocument,setHasUnsavedChanges,+ setIsHistorySidebarOpen,} from "../documents.slice";import { useDocumentState } from "../hooks/use-document-state";import { useRegisterDocumentMetabotContext } from "../hooks/use-register-document-metabot-context";import {getDraftCards,getHasUnsavedChanges,+ getIsHistorySidebarOpen,getSelectedEmbedIndex,getSelectedQuestionId,} from "../selectors";@@ -73,6 +75,7 @@ import { getListCommentsQuery } from "../utils/api";import { DocumentArchivedEntityBanner } from "./DocumentArchivedEntityBanner";import { DocumentHeader } from "./DocumentHeader";import styles from "./DocumentPage.module.css";+import { DocumentRevisionHistorySidebar } from "./DocumentRevisionHistorySidebar";import { Editor } from "./Editor";import { EmbedQuestionSettingsSidebar } from "./EmbedQuestionSettingsSidebar";@@ -97,6 +100,7 @@ export const DocumentPage = ({const selectedQuestionId = useSelector(getSelectedQuestionId);const selectedEmbedIndex = useSelector(getSelectedEmbedIndex);const draftCards = useSelector(getDraftCards);+ const isHistorySidebarOpen = useSelector(getIsHistorySidebarOpen);const [editorInstance, setEditorInstance] = useState<TiptapEditor | null>(null,);@@ -268,6 +272,10 @@ export const DocumentPage = ({: createBookmark({ type: "document", id: documentId });}, [isBookmarked, deleteBookmark, createBookmark, documentId]);+ const handleShowHistory = useCallback(() => {+ dispatch(setIsHistorySidebarOpen(true));+ }, [dispatch]);+const handleSave = useCallback(async (collectionId: RegularCollectionId | null = null) => {if (!editorInstance || isSaving) {@@ -455,6 +463,7 @@ export const DocumentPage = ({onMove={() => setCollectionPickerMode("move")}onToggleBookmark={handleToggleBookmark}onArchive={() => handleUpdate({ archived: true })}+ onShowHistory={handleShowHistory}hasComments={hasComments}/><Editor@@ -524,6 +533,14 @@ export const DocumentPage = ({onClose={() => forceUpdate()}/></Box>+ {isHistorySidebarOpen && documentData && (+ <Box className={styles.sidebar} data-testid="document-history-sidebar">+ <DocumentRevisionHistorySidebar+ document={documentData}+ onClose={() => dispatch(setIsHistorySidebarOpen(false))}+ />+ </Box>+ )}</Box>);};diff --git a/frontend/src/metabase/documents/components/DocumentRevisionHistorySidebar.tsx b/frontend/src/metabase/documents/components/DocumentRevisionHistorySidebar.tsxnew file mode 100644index 00000000000..dc2b988773e--- /dev/null+++ b/frontend/src/metabase/documents/components/DocumentRevisionHistorySidebar.tsx@@ -0,0 +1,79 @@+import { useHotkeys } from "@mantine/hooks";+import { useMemo, useState } from "react";+import { useMount } from "react-use";+import { t } from "ttag";++import {+ skipToken,+ useListRevisionsQuery,+ useRevertRevisionMutation,+} from "metabase/api";+import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";+import { Sidesheet, SidesheetCard } from "metabase/common/components/Sidesheet";+import { Timeline } from "metabase/common/components/Timeline";+import { getTimelineEvents } from "metabase/common/components/Timeline/utils";+import { useSelector } from "metabase/lib/redux";+import { getUser } from "metabase/selectors/user";+import type { Document } from "metabase-types/api";++interface DocumentRevisionHistorySidebarProps {+ document: Document;+ onClose: () => void;+}++export function DocumentRevisionHistorySidebar({+ document,+ onClose,+}: DocumentRevisionHistorySidebarProps) {+ const [isOpen, setIsOpen] = useState(false);+ const currentUser = useSelector(getUser);++ useHotkeys([["]", onClose]]);++ useMount(() => {+ setIsOpen(true);+ });++ const {+ data: revisions,+ isLoading,+ error,+ } = useListRevisionsQuery(+ document ? { id: document.id, entity: "document" } : skipToken,+ );+ const [revertToRevision] = useRevertRevisionMutation();++ const canWrite = document.can_write && !document.archived;++ const events = useMemo(() => {+ const revisionEvents = getTimelineEvents({ revisions, currentUser });+ return revisionEvents.sort(+ (a, b) =>+ new Date(b.timestamp).getTime() - new Date(a.timestamp).getTime(),+ );+ }, [revisions, currentUser]);++ return (+ <Sidesheet isOpen={isOpen} title={t`History`} onClose={onClose}>+ <SidesheetCard>+ {isLoading || error ? (+ <LoadingAndErrorWrapper loading={isLoading} error={error} />+ ) : (+ <Timeline+ events={events}+ data-testid="document-history-list"+ revert={(revision) =>+ revertToRevision({+ entity: "document",+ id: document.id,+ revision_id: revision.id,+ })+ }+ canWrite={canWrite}+ entity="document"+ />+ )}+ </SidesheetCard>+ </Sidesheet>+ );+}diff --git a/frontend/src/metabase/documents/components/DocumentRevisionHistorySidebar.unit.spec.tsx b/frontend/src/metabase/documents/components/DocumentRevisionHistorySidebar.unit.spec.tsxnew file mode 100644index 00000000000..636b76ebd00--- /dev/null+++ b/frontend/src/metabase/documents/components/DocumentRevisionHistorySidebar.unit.spec.tsx@@ -0,0 +1,158 @@+import userEvent from "@testing-library/user-event";++import {+ setupDocumentRevisionsEndpoint,+ setupUsersEndpoints,+} from "__support__/server-mocks";+import {+ renderWithProviders,+ screen,+ waitForLoaderToBeRemoved,+} from "__support__/ui";+import type { Document, Revision } from "metabase-types/api";+import {+ createMockDocument,+ createMockRevision,+ createMockUser,+} from "metabase-types/api/mocks";+import { createMockState } from "metabase-types/store/mocks";++import { DocumentRevisionHistorySidebar } from "./DocumentRevisionHistorySidebar";++const mockUser = createMockUser();++const mockRevisions: Revision[] = [+ createMockRevision({+ id: 2,+ description: 'renamed this Document from "Old Name" to "Test Document".',+ timestamp: "2024-01-02T10:00:00Z",+ user: {+ id: mockUser.id,+ first_name: mockUser.first_name ?? "",+ last_name: mockUser.last_name ?? "",+ common_name: mockUser.common_name ?? "",+ },+ }),+ createMockRevision({+ id: 1,+ description: "created this.",+ timestamp: "2024-01-01T10:00:00Z",+ is_creation: true,+ user: {+ id: mockUser.id,+ first_name: mockUser.first_name ?? "",+ last_name: mockUser.last_name ?? "",+ common_name: mockUser.common_name ?? "",+ },+ }),+];++const mockDocument = createMockDocument({+ id: 1,+ name: "Test Document",+ can_write: true,+ archived: false,+});++function setup({+ document = mockDocument,+ revisions = mockRevisions,+}: {+ document?: Document;+ revisions?: Revision[];+} = {}) {+ const onClose = jest.fn();+ const currentUser = mockUser;++ setupDocumentRevisionsEndpoint(document.id, revisions);+ setupUsersEndpoints([currentUser]);++ const state = createMockState({+ currentUser,+ });++ renderWithProviders(+ <DocumentRevisionHistorySidebar document={document} onClose={onClose} />,+ { storeInitialState: state },+ );++ return { onClose, document };+}++describe("DocumentRevisionHistorySidebar", () => {+ it("should render the sidebar when open", async () => {+ setup();++ await waitForLoaderToBeRemoved();++ expect(screen.getByText("History")).toBeInTheDocument();+ expect(screen.getByTestId("document-history-list")).toBeInTheDocument();+ });++ it("should display revision history entries", async () => {+ setup();++ await waitForLoaderToBeRemoved();++ expect(await screen.findByText(/created this/)).toBeInTheDocument();+ expect(+ await screen.findByText(/renamed this Document/),+ ).toBeInTheDocument();+ });++ it("should show revert buttons when user can write", async () => {+ setup();++ await waitForLoaderToBeRemoved();++ await screen.findByText(/created this/);+ await screen.findByText(/renamed this Document/);++ const revertButtons = screen.getAllByTestId("question-revert-button");+ expect(revertButtons).toHaveLength(1);+ });++ it("should not show revert buttons when user cannot write", async () => {+ setup();++ await waitForLoaderToBeRemoved();++ const revertButtons = screen.queryAllByRole("button", { name: "Revert" });+ expect(revertButtons).toHaveLength(0);+ });++ it("should not show revert buttons when document is archived", async () => {+ setup({+ document: createMockDocument({+ id: 1,+ name: "Test Document",+ can_write: true,+ archived: true,+ }),+ });++ await waitForLoaderToBeRemoved();++ const revertButtons = screen.queryAllByRole("button", { name: "Revert" });+ expect(revertButtons).toHaveLength(0);+ });++ it("should handle empty revisions", async () => {+ setup({ revisions: [] });++ await waitForLoaderToBeRemoved();++ expect(screen.getByTestId("document-history-list")).toBeInTheDocument();+ });++ it("should call onClose when close button is clicked", async () => {+ const { onClose } = setup();++ await waitForLoaderToBeRemoved();++ const closeButton = screen.getByRole("button", { name: /close/i });+ await userEvent.click(closeButton);++ expect(onClose).toHaveBeenCalledTimes(1);+ });+});diff --git a/frontend/src/metabase/documents/documents.slice.ts b/frontend/src/metabase/documents/documents.slice.tsindex ee44e47eea4..feb69639be1 100644--- a/frontend/src/metabase/documents/documents.slice.ts+++ b/frontend/src/metabase/documents/documents.slice.ts@@ -40,6 +40,7 @@ export const initialState: DocumentsState = {childTargetId: undefined,hoveredChildTargetId: undefined,hasUnsavedChanges: false,+ isHistorySidebarOpen: false,};const documentsSlice = createSlice({@@ -128,6 +129,9 @@ const documentsSlice = createSlice({setHasUnsavedChanges: (state, action: PayloadAction<boolean>) => {state.hasUnsavedChanges = action.payload;},+ setIsHistorySidebarOpen: (state, action: PayloadAction<boolean>) => {+ state.isHistorySidebarOpen = action.payload;+ },},});@@ -146,6 +150,7 @@ export const {setChildTargetId,setHoveredChildTargetId,setHasUnsavedChanges,+ setIsHistorySidebarOpen,} = documentsSlice.actions;export const generateDraftCardId = (): number => {diff --git a/frontend/src/metabase/documents/selectors.ts b/frontend/src/metabase/documents/selectors.tsindex 9e38a09e83f..658ed63d1bb 100644--- a/frontend/src/metabase/documents/selectors.ts+++ b/frontend/src/metabase/documents/selectors.ts@@ -90,3 +90,8 @@ export const getHasUnsavedChanges = createSelector(getDocumentsState,(documents) => documents.hasUnsavedChanges,);++export const getIsHistorySidebarOpen = createSelector(+ getDocumentsState,+ (documents) => documents.isHistorySidebarOpen,+);diff --git a/frontend/test/__support__/server-mocks/revision.ts b/frontend/test/__support__/server-mocks/revision.tsindex a1de45f239b..7412c6d826e 100644--- a/frontend/test/__support__/server-mocks/revision.ts+++ b/frontend/test/__support__/server-mocks/revision.ts@@ -12,3 +12,23 @@ export function setupSegmentRevisionsEndpoint() {fetchMock.get(`path:/api/revision?entity=segment&id=${segmentId}`, revisions);}++export function setupDocumentRevisionsEndpoint(+ documentId: number,+ revisions: Revision[],+) {+ fetchMock.get(+ `path:/api/revision?entity=document&id=${documentId}`,+ revisions,+ );+}++export function setupTransformRevisionsEndpoint(+ transformId: number,+ revisions: Revision[],+) {+ fetchMock.get(+ `path:/api/revision?entity=transform&id=${transformId}`,+ revisions,+ );+}diff --git a/resources/openapi/openapi.json b/resources/openapi/openapi.jsonindex 27003e6ff1d..c2d26bab76d 100644--- a/resources/openapi/openapi.json+++ b/resources/openapi/openapi.json@@ -32444,7 +32444,7 @@"name" : "entity","required" : true,"schema" : {- "enum" : [ "card", "dashboard", "document", "segment" ],+ "enum" : [ "card", "dashboard", "document", "segment", "transform" ],"type" : "string"}} ],@@ -32473,7 +32473,7 @@"schema" : {"properties" : {"entity" : {- "enum" : [ "card", "dashboard", "document", "segment" ],+ "enum" : [ "card", "dashboard", "document", "segment", "transform" ],"type" : "string"},"id" : {@@ -32516,7 +32516,7 @@"name" : "entity","required" : true,"schema" : {- "enum" : [ "card", "dashboard", "document", "segment" ],+ "enum" : [ "card", "dashboard", "document", "segment", "transform" ],"type" : "string"}}, {diff --git a/src/metabase/revisions/api.clj b/src/metabase/revisions/api.cljindex f31c356230a..5c3da1d140e 100644--- a/src/metabase/revisions/api.clj+++ b/src/metabase/revisions/api.clj@@ -6,13 +6,15 @@[metabase.revisions.models.revision :as revision][metabase.util.malli.schema :as ms][metabase.util.regex :as u.regex]- [toucan2.core :as t2]))+ [toucan2.core :as t2]+ [toucan2.model :as t2.model]))(def ^:private entity->model{"card" :model/Card"dashboard" :model/Dashboard"document" :model/Document- "segment" :model/Segment})+ "segment" :model/Segment+ "transform" :model/Transform})(def ^:private Entity"Schema for a valid revisionable entity name."@@ -23,6 +25,8 @@(defn- model-and-instance [entity-name id](let [model (entity->model entity-name)](assert (keyword? model))+ ;; Ensure the model namespace is loaded before using it+ (t2.model/resolve-model model)[model (t2/select-one model :id id)]));; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to@@ -77,5 +81,7 @@[:id ms/PositiveInt]]](let [model (entity->model entity)](assert (keyword? model))+ ;; Ensure the model namespace is loaded before using it+ (t2.model/resolve-model model)(api/read-check model id)(revision/revisions+details model id)))diff --git a/src/metabase/revisions/models/revision/diff.clj b/src/metabase/revisions/models/revision/diff.cljindex e31d363c6f5..3c8c203b9cb 100644--- a/src/metabase/revisions/models/revision/diff.clj+++ b/src/metabase/revisions/models/revision/diff.clj@@ -5,7 +5,7 @@[metabase.util.i18n :refer [deferred-tru]][toucan2.core :as t2]))-(defn- diff-string [k v1 v2 identifier]+(defn- match-1 [k v1 v2 identifier](match [k v1 v2][:name _ _](deferred-tru "renamed {0} from \"{1}\" to \"{2}\"" identifier v1 v2)@@ -16,6 +16,9 @@[:description (_ :guard some?) _](deferred-tru "changed the description")+ [:document _ _]+ (deferred-tru "edited the content")+[:private true false](deferred-tru "made {0} public" identifier)@@ -43,6 +46,10 @@[:embedding_params _ _](deferred-tru "changed the embedding parameters")+ :else nil))++(defn- match-2 [k v1 v2 identifier]+ (match [k v1 v2][:archived _ after](if after(deferred-tru "trashed {0}" identifier)@@ -107,6 +114,9 @@(deferred-tru "changed the width setting from {0} to {1}" (name v1) (name v2))(deferred-tru "changed the width setting"))+ [:source _ _]+ (deferred-tru "changed the source")+;; whenever database_id, query_type, table_id changed,;; the dataset_query will changed so we don't need a description for this[#{:table_id :database_id :query_type} _ _]@@ -114,6 +124,10 @@:else nil))+(defn- diff-string [k v1 v2 identifier]+ (or (match-1 k v1 v2 identifier)+ (match-2 k v1 v2 identifier)))+(defn build-sentence"Join parts of a sentence together to build a compound one."[parts]@@ -129,7 +143,8 @@"Dashboard" (deferred-tru "Dashboard")"Card" (deferred-tru "Card")"Segment" (deferred-tru "Segment")- "Document" (deferred-tru "Document")))+ "Document" (deferred-tru "Document")+ "Transform" (deferred-tru "Transform")))(defn diff-strings*"Create a seq of string describing how `o1` is different from `o2`.