Skip to content

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

feat: add duplicate option in 3 dot menu in a document (#68075)

Maksym Yakubych4b805ef2469a
diff --git a/e2e/test/scenarios/documents/documents.cy.spec.ts b/e2e/test/scenarios/documents/documents.cy.spec.ts
index badc8662a6d..44cb1f41aed 100644
--- a/e2e/test/scenarios/documents/documents.cy.spec.ts
+++ b/e2e/test/scenarios/documents/documents.cy.spec.ts
@@ -28,6 +28,190 @@ describe("documents", () => {
H.resetSnowplow();
});
+ describe("duplicating documents", () => {
+ it("should warn about unsaved changes when duplicating an existing document", () => {
+ H.createDocument({
+ name: "Unsaved Duplicate Doc",
+ document: {
+ content: [
+ {
+ type: "paragraph",
+ content: [{ type: "text", text: "Original content" }],
+ attrs: { _id: "1" },
+ },
+ ],
+ type: "doc",
+ },
+ collection_id: null,
+ alias: "document",
+ idAlias: "documentId",
+ });
+
+ H.visitDocument("@documentId");
+
+ cy.findByRole("textbox", { name: "Document Title" })
+ .should("have.value", "Unsaved Duplicate Doc")
+ .clear()
+ .type("Unsaved title");
+
+ H.documentContent().click();
+ H.addToDocument(" changed", false);
+
+ H.documentSaveButton().should("be.visible");
+
+ cy.findByLabelText("More options").click();
+ H.popover().findByText("Duplicate").click();
+
+ cy.findByTestId("save-confirmation").should("be.visible");
+
+ cy.findByRole("button", { name: "Cancel" }).click();
+
+ cy.findByTestId("save-confirmation").should("not.exist");
+ cy.findByRole("heading", { name: /Duplicate "/ }).should("not.exist");
+
+ // still unsaved
+ H.documentSaveButton().should("be.visible");
+ });
+
+ it("should save changes when duplicating, then copy and redirect to the new document", () => {
+ cy.intercept("POST", "/api/document/*/copy").as("copyDoc");
+
+ H.createDocument({
+ name: "Save Duplicate Doc",
+ document: {
+ content: [
+ {
+ type: "paragraph",
+ content: [{ type: "text", text: "Original content" }],
+ attrs: { _id: "1" },
+ },
+ ],
+ type: "doc",
+ },
+ collection_id: null,
+ alias: "document",
+ idAlias: "documentId",
+ });
+
+ H.visitDocument("@documentId");
+
+ cy.findByRole("textbox", { name: "Document Title" })
+ .should("have.value", "Save Duplicate Doc")
+ .clear()
+ .type("Saved title");
+
+ H.documentContent().click();
+ H.addToDocument(" changed", false);
+
+ H.documentSaveButton().should("be.visible");
+
+ cy.findByLabelText("More options").click();
+ H.popover().findByText("Duplicate").click();
+
+ cy.findByTestId("save-confirmation").should("be.visible");
+ cy.findByRole("button", { name: "Save changes" }).click();
+
+ // saved
+ H.documentSaveButton().should("not.exist");
+ cy.findByRole("textbox", { name: "Document Title" }).should(
+ "have.value",
+ "Saved title",
+ );
+
+ // duplicate modal
+ cy.findByRole("button", { name: "Duplicate" }).should("be.visible");
+ cy.findByRole("textbox", { name: "Name" }).then(($input) => {
+ // Snapshot the value now; aliasing a command chain here can become flaky after navigation.
+ const copyName = ($input.val() ?? "").toString();
+ cy.wrap(copyName).as("copyName");
+ });
+
+ cy.findByRole("button", { name: "Duplicate" }).click();
+
+ cy.wait("@copyDoc").then(({ response }) => {
+ const copiedId = response?.body?.id;
+ expect(copiedId).to.exist;
+
+ cy.location("pathname").should(
+ "match",
+ new RegExp(`^/document/${copiedId}`),
+ );
+ });
+
+ cy.get<string>("@copyName").then((copyName) => {
+ cy.findByRole("textbox", { name: "Document Title" }).should(
+ "have.value",
+ copyName,
+ );
+ });
+
+ // content should match the saved changes
+ H.documentContent().should("contain.text", "Original content changed");
+ });
+
+ it("should duplicate a document without any changes (happy path)", () => {
+ cy.intercept("POST", "/api/document/*/copy").as("copyDoc");
+
+ H.createDocument({
+ name: "Happy Path Duplicate Doc",
+ document: {
+ content: [
+ {
+ type: "paragraph",
+ content: [{ type: "text", text: "Original content" }],
+ attrs: { _id: "1" },
+ },
+ ],
+ type: "doc",
+ },
+ collection_id: null,
+ alias: "document",
+ idAlias: "documentId",
+ });
+
+ H.visitDocument("@documentId");
+
+ cy.findByRole("textbox", { name: "Document Title" }).should(
+ "have.value",
+ "Happy Path Duplicate Doc",
+ );
+ H.documentSaveButton().should("not.exist");
+
+ cy.findByLabelText("More options").click();
+ H.popover().findByText("Duplicate").click();
+
+ cy.findByRole("heading", {
+ name: 'Duplicate "Happy Path Duplicate Doc"',
+ }).should("be.visible");
+
+ cy.findByRole("textbox", { name: "Name" }).then(($input) => {
+ // Snapshot the value now; aliasing a command chain here can become flaky after navigation.
+ const copyName = ($input.val() ?? "").toString();
+ cy.wrap(copyName).as("copyName");
+ });
+ cy.findByRole("button", { name: "Duplicate" }).click();
+
+ cy.wait("@copyDoc").then(({ response }) => {
+ const copiedId = response?.body?.id;
+ expect(copiedId).to.exist;
+
+ cy.location("pathname").should(
+ "match",
+ new RegExp(`^/document/${copiedId}`),
+ );
+ });
+
+ cy.get<string>("@copyName").then((copyName) => {
+ cy.findByRole("textbox", { name: "Document Title" }).should(
+ "have.value",
+ copyName,
+ );
+ });
+
+ H.documentContent().should("contain.text", "Original content");
+ });
+ });
+
it("should allow you to create a new document from the new button and save", () => {
const getDocumentStub = cy.stub();
@@ -122,7 +306,7 @@ describe("documents", () => {
cy.findByTestId("collection-picker-button").click();
H.entityPickerModalItem(0, /Personal Collection/).click();
H.entityPickerModal().findByRole("button", { name: "Select" }).click();
- H.modal().findByRole("button", { name: "Copy" }).click();
+ H.modal().findByRole("button", { name: "Duplicate" }).click();
H.openNavigationSidebar();
H.navigationSidebar().findByText("Your personal collection").click();
@@ -1639,11 +1823,17 @@ describe("documents", () => {
H.documentContent().click();
H.addToDocument("Updated content");
H.documentSaveButton().click();
+ cy.findByTestId("toast-undo")
+ .should("be.visible")
+ .and("contain.text", "Document saved");
cy.log("Make another change");
H.documentContent().click();
H.addToDocument("More changes");
H.documentSaveButton().click();
+ cy.contains('[data-testid="toast-undo"]', "Document saved").should(
+ "be.visible",
+ );
cy.log("Open revision history");
cy.findByLabelText("More options").click();
diff --git a/frontend/src/metabase-types/analytics/event.ts b/frontend/src/metabase-types/analytics/event.ts
index 7ed072a330a..84397f9a05b 100644
--- a/frontend/src/metabase-types/analytics/event.ts
+++ b/frontend/src/metabase-types/analytics/event.ts
@@ -306,6 +306,11 @@ export type DocumentReplaceCardEvent = ValidateEvent<{
target_id: number | null;
}>;
+export type DocumentDuplicatedEvent = ValidateEvent<{
+ event: "document_duplicated";
+ target_id: number | null;
+}>;
+
export type DocumentAskMetabotEvent = ValidateEvent<{
event: "document_ask_metabot";
target_id: number | null;
@@ -652,6 +657,7 @@ export type SimpleEvent =
| DocumentAskMetabotEvent
| DocumentCreatedEvent
| DocumentReplaceCardEvent
+ | DocumentDuplicatedEvent
| DocumentUpdatedEvent
| DocumentPrintEvent
| DatabaseHelpClickedEvent
diff --git a/frontend/src/metabase-types/api/document.ts b/frontend/src/metabase-types/api/document.ts
index 51c85e76a21..aea6291673b 100644
--- a/frontend/src/metabase-types/api/document.ts
+++ b/frontend/src/metabase-types/api/document.ts
@@ -42,4 +42,11 @@ export type UpdateDocumentRequest = Pick<Document, "id"> &
export type DeleteDocumentRequest = Pick<Document, "id">;
+export type CopyDocumentRequest = {
+ id: DocumentId;
+ name?: string | null;
+ collection_id?: CollectionId | null;
+ collection_position?: number | null;
+};
+
export type GetPublicDocument = Pick<Document, "id" | "name" | "public_uuid">;
diff --git a/frontend/src/metabase/api/document.ts b/frontend/src/metabase/api/document.ts
index 5c5985687a9..ccccdb22f0c 100644
--- a/frontend/src/metabase/api/document.ts
+++ b/frontend/src/metabase/api/document.ts
@@ -1,6 +1,7 @@
import { Api } from "metabase/api/api";
import { idTag, listTag } from "metabase/api/tags";
import type {
+ CopyDocumentRequest,
CreateDocumentRequest,
DeleteDocumentRequest,
Document,
@@ -47,6 +48,16 @@ export const documentApi = Api.injectEndpoints({
!error
? [listTag("document"), idTag("document", id), listTag("revision")]
: [],
+ async onQueryStarted(_props, { dispatch, queryFulfilled }) {
+ const { data } = await queryFulfilled;
+ await dispatch(
+ documentApi.util.upsertQueryData(
+ "getDocument",
+ { id: data.id },
+ data,
+ ),
+ );
+ },
}),
deleteDocument: builder.mutation<void, DeleteDocumentRequest>({
query: (document) => ({
@@ -56,6 +67,24 @@ export const documentApi = Api.injectEndpoints({
invalidatesTags: (_, error, { id }) =>
!error ? [listTag("document"), idTag("document", id)] : [],
}),
+ copyDocument: builder.mutation<Document, CopyDocumentRequest>({
+ query: ({ id, ...body }) => ({
+ method: "POST",
+ url: `/api/document/${id}/copy`,
+ body,
+ }),
+ invalidatesTags: (_, error) => (error ? [] : [listTag("document")]),
+ async onQueryStarted(_props, { dispatch, queryFulfilled }) {
+ const { data } = await queryFulfilled;
+ await dispatch(
+ documentApi.util.upsertQueryData(
+ "getDocument",
+ { id: data.id },
+ data,
+ ),
+ );
+ },
+ }),
listPublicDocuments: builder.query<GetPublicDocument[], void>({
query: () => ({
method: "GET",
@@ -106,6 +135,8 @@ export const {
useGetDocumentQuery,
useCreateDocumentMutation,
useUpdateDocumentMutation,
+ useDeleteDocumentMutation,
+ useCopyDocumentMutation,
useListPublicDocumentsQuery,
useCreateDocumentPublicLinkMutation,
useDeleteDocumentPublicLinkMutation,
diff --git a/frontend/src/metabase/common/components/ConfirmModal/ConfirmModal.tsx b/frontend/src/metabase/common/components/ConfirmModal/ConfirmModal.tsx
index f8a198e13c5..2c85c814cf9 100644
--- a/frontend/src/metabase/common/components/ConfirmModal/ConfirmModal.tsx
+++ b/frontend/src/metabase/common/components/ConfirmModal/ConfirmModal.tsx
@@ -39,11 +39,14 @@ export const ConfirmModal = ({
const [confirming, setConfirming] = useState(false);
const handleConfirm = async () => {
const confirm = onConfirm();
- if (confirm instanceof Promise) {
- setConfirming(true);
- await confirm;
+ try {
+ if (confirm instanceof Promise) {
+ setConfirming(true);
+ await confirm;
+ }
+ } finally {
+ setConfirming(false);
}
- setConfirming(false);
};
return (
diff --git a/frontend/src/metabase/dashboard/containers/CopyDashboardForm.tsx b/frontend/src/metabase/dashboard/containers/CopyDashboardForm.tsx
index 8d45ec73585..e0c764fa513 100644
--- a/frontend/src/metabase/dashboard/containers/CopyDashboardForm.tsx
+++ b/frontend/src/metabase/dashboard/containers/CopyDashboardForm.tsx
@@ -1,6 +1,6 @@
import { useCallback, useMemo } from "react";
import { withRouter } from "react-router";
-import { t } from "ttag";
+import { c, t } from "ttag";
import * as Yup from "yup";
import { useGetDashboardQuery } from "metabase/api";
@@ -158,7 +158,7 @@ function CopyDashboardForm({
{!!onClose && (
<Button type="button" onClick={onClose}>{t`Cancel`}</Button>
)}
- <FormSubmitButton label={t`Duplicate`} />
+ <FormSubmitButton label={c(`A verb, not a noun`).t`Duplicate`} />
</FormFooter>
</Form>
</FormProvider>
diff --git a/frontend/src/metabase/documents/analytics.ts b/frontend/src/metabase/documents/analytics.ts
index bd8b2d43f8e..3d4ebf1c893 100644
--- a/frontend/src/metabase/documents/analytics.ts
+++ b/frontend/src/metabase/documents/analytics.ts
@@ -36,6 +36,13 @@ export const trackDocumentReplaceCard = (document?: Document | null) => {
});
};
+export const trackDocumentDuplicated = (document?: Document | null) => {
+ trackSimpleEvent({
+ event: "document_duplicated",
+ target_id: document?.id || null,
+ });
+};
+
export const trackDocumentAskMetabot = (document?: Document | null) => {
trackSimpleEvent({
event: "document_ask_metabot",
diff --git a/frontend/src/metabase/documents/components/DocumentCopyForm/DocumentCopyForm.tsx b/frontend/src/metabase/documents/components/DocumentCopyForm/DocumentCopyForm.tsx
index 777defe8b97..4afca88eb29 100644
--- a/frontend/src/metabase/documents/components/DocumentCopyForm/DocumentCopyForm.tsx
+++ b/frontend/src/metabase/documents/components/DocumentCopyForm/DocumentCopyForm.tsx
@@ -1,4 +1,4 @@
-import { t } from "ttag";
+import { c, t } from "ttag";
import * as Yup from "yup";
import FormCollectionPicker from "metabase/collections/containers/FormCollectionPicker";
@@ -56,13 +56,13 @@ export const DocumentCopyForm = ({
<FormTextInput
name="name"
label={t`Name`}
- placeholder={t`What is the name of your dashboard?`}
+ placeholder={t`What is the name of your document?`}
autoFocus
/>
<div>
<FormCollectionPicker
name="collection_id"
- title={t`Folder this document should be copied to`}
+ title={t`Where do you want to save this?`}
entityType="document"
/>
</div>
@@ -71,7 +71,10 @@ export const DocumentCopyForm = ({
{!!onCancel && (
<Button type="button" onClick={onCancel}>{t`Cancel`}</Button>
)}
- <FormSubmitButton label={t`Copy`} variant="primary" />
+ <FormSubmitButton
+ label={c(`A verb, not a noun`).t`Duplicate`}
+ variant="primary"
+ />
</FormFooter>
</Form>
)}
diff --git a/frontend/src/metabase/documents/components/DocumentHeader.tsx b/frontend/src/metabase/documents/components/DocumentHeader.tsx
index 010329faf2d..449100fc226 100644
--- a/frontend/src/metabase/documents/components/DocumentHeader.tsx
+++ b/frontend/src/metabase/documents/components/DocumentHeader.tsx
@@ -1,6 +1,6 @@
import { useCallback, useState } from "react";
import { Link } from "react-router";
-import { t } from "ttag";
+import { c, t } from "ttag";
import {
DateTime,
@@ -49,6 +49,7 @@ interface DocumentHeaderProps {
onTitleSubmit?: () => void;
onSave: () => void;
onMove: () => void;
+ onDuplicate: () => void;
onToggleBookmark: () => void;
onArchive: () => void;
onShowHistory: () => void;
@@ -66,6 +67,7 @@ export const DocumentHeader = ({
onTitleSubmit,
onSave,
onMove,
+ onDuplicate,
onToggleBookmark,
onArchive,
onShowHistory,
@@ -241,6 +243,12 @@ export const DocumentHeader = ({
{t`Move`}
</Menu.Item>
)}
+ <Menu.Item
+ leftSection={<Icon name="clone" />}
+ onClick={onDuplicate}
+ >
+ {c("A verb, not a noun").t`Duplicate`}
+ </Menu.Item>
<Menu.Item
leftSection={<Icon name={"bookmark"} />}
onClick={onToggleBookmark}
diff --git a/frontend/src/metabase/documents/components/DocumentHeader.unit.spec.tsx b/frontend/src/metabase/documents/components/DocumentHeader.unit.spec.tsx
index 6def6668f98..f1ec7139c29 100644
--- a/frontend/src/metabase/documents/components/DocumentHeader.unit.spec.tsx
+++ b/frontend/src/metabase/documents/components/DocumentHeader.unit.spec.tsx
@@ -24,6 +24,7 @@ const setup = ({
onTitleChange = jest.fn(),
onSave = jest.fn(),
onMove = jest.fn(),
+ onDuplicate = jest.fn(),
onToggleBookmark = jest.fn(),
onArchive = jest.fn(),
onShowHistory = jest.fn(),
@@ -39,6 +40,7 @@ const setup = ({
onTitleChange,
onSave,
onMove,
+ onDuplicate,
onToggleBookmark,
onArchive,
onShowHistory,
@@ -164,6 +166,8 @@ describe("DocumentHeader", () => {
expect(screen.getByText("Move")).toBeInTheDocument();
expect(screen.getByText("Move to trash")).toBeInTheDocument();
+
+ expect(screen.getByText("Duplicate")).toBeInTheDocument();
});
it("should not show move and archive options when user cannot write", async () => {
@@ -172,6 +176,9 @@ describe("DocumentHeader", () => {
expect(screen.queryByText("Move")).not.toBeInTheDocument();
expect(screen.queryByText("Move to trash")).not.toBeInTheDocument();
+
+ // User can still duplicate the document
+ expect(screen.getByText("Duplicate")).toBeInTheDocument();
});
it("should call onMove when move is clicked", async () => {
@@ -197,6 +204,7 @@ describe("DocumentHeader", () => {
await userEvent.click(screen.getByLabelText("More options"));
expect(screen.queryByText("Move")).not.toBeInTheDocument();
+ expect(screen.queryByText("Duplicate")).not.toBeInTheDocument();
expect(screen.queryByText("Bookmark")).not.toBeInTheDocument();
expect(screen.queryByText("Move to trash")).not.toBeInTheDocument();
});
@@ -207,5 +215,17 @@ describe("DocumentHeader", () => {
});
expect(screen.queryByLabelText("More options")).not.toBeInTheDocument();
});
+
+ it("should call onDuplicate when duplicate is clicked", async () => {
+ const onDuplicate = jest.fn();
+ setup({
+ isNewDocument: false,
+ documentTitle: "Test Document",
+ onDuplicate,
+ });
+ await userEvent.click(screen.getByLabelText("More options"));
+ await userEvent.click(screen.getByText("Duplicate"));
+ expect(onDuplicate).toHaveBeenCalled();
+ });
});
});
diff --git a/frontend/src/metabase/documents/components/DocumentPage.tsx b/frontend/src/metabase/documents/components/DocumentPage.tsx
index a7026b19187..31162483cc5 100644
--- a/frontend/src/metabase/documents/components/DocumentPage.tsx
+++ b/frontend/src/metabase/documents/components/DocumentPage.tsx
@@ -20,6 +20,7 @@ import _ from "underscore";
import {
skipToken,
+ useCopyDocumentMutation,
useCreateBookmarkMutation,
useCreateDocumentMutation,
useDeleteBookmarkMutation,
@@ -29,6 +30,7 @@ import {
useUpdateDocumentMutation,
} from "metabase/api";
import { canonicalCollectionId } from "metabase/collections/utils";
+import { ConfirmModal } from "metabase/common/components/ConfirmModal";
import {
LeaveConfirmModal,
LeaveRouteConfirmModal,
@@ -36,9 +38,11 @@ import {
import { CollectionPickerModal } from "metabase/common/components/Pickers/CollectionPicker";
import { useToast } from "metabase/common/hooks";
import { useCallbackEffect } from "metabase/common/hooks/use-callback-effect";
+import EntityCopyModal from "metabase/entities/containers/EntityCopyModal";
import { usePageTitle } from "metabase/hooks/use-page-title";
import { useDispatch, useSelector } from "metabase/lib/redux";
import { extractEntityId } from "metabase/lib/urls";
+import * as Urls from "metabase/lib/urls";
import { setErrorPage } from "metabase/redux/app";
import { Box } from "metabase/ui";
import type {
@@ -50,6 +54,7 @@ import type {
import {
trackDocumentBookmark,
trackDocumentCreated,
+ trackDocumentDuplicated,
trackDocumentUnsavedChangesWarningDisplayed,
trackDocumentUpdated,
} from "../analytics";
@@ -112,9 +117,13 @@ export const DocumentPage = ({
useCreateDocumentMutation();
const [updateDocument, { isLoading: isUpdating }] =
useUpdateDocumentMutation();
+ const [copyDocument] = useCopyDocumentMutation();
const [collectionPickerMode, setCollectionPickerMode] = useState<
"save" | "move" | null
>(null);
+ const [duplicateModalMode, setDuplicateModalMode] = useState<
+ "duplicate" | "leave" | null
+ >(null);
const [sendToast] = useToast();
const documentId = entityId === "new" ? "new" : extractEntityId(entityId);
@@ -269,6 +278,14 @@ export const DocumentPage = ({
[dispatch, editorInstance, documentContent, isNewDocument],
);
+ const handleDuplicate = useCallback(() => {
+ if (hasUnsavedChanges()) {
+ setDuplicateModalMode("leave");
+ return;
+ }
+ setDuplicateModalMode("duplicate");
+ }, [hasUnsavedChanges]);
+
const handleToggleBookmark = useCallback(() => {
if (!documentId) {
return;
@@ -330,7 +347,7 @@ export const DocumentPage = ({
const _document = response.data;
trackDocumentUpdated(_document);
scheduleNavigation(() => {
- dispatch(push(`/document/${_document.id}`));
+ dispatch(push(Urls.document(_document)));
});
}
return response;
@@ -344,7 +361,7 @@ export const DocumentPage = ({
const _document = response.data;
trackDocumentCreated(_document);
scheduleNavigation(() => {
- dispatch(replace(`/document/${_document.id}`));
+ dispatch(replace(Urls.document(_document)));
});
}
return response;
@@ -357,12 +374,18 @@ export const DocumentPage = ({
dispatch(clearDraftCards());
// Mark document as clean
dispatch(setHasUnsavedChanges(false));
+ return {
+ document: result.data,
+ };
} else if (result.error) {
throw result.error;
}
} catch (error) {
console.error("Failed to save document:", error);
sendToast({ message: t`Error saving document`, icon: "warning" });
+ return {
+ error: error,
+ };
}
},
[
@@ -478,6 +501,7 @@ export const DocumentPage = ({
}
}}
onMove={() => setCollectionPickerMode("move")}
+ onDuplicate={handleDuplicate}
onToggleBookmark={handleToggleBookmark}
onArchive={() => handleUpdate({ archived: true })}
onShowHistory={handleShowHistory}
@@ -489,7 +513,7 @@ export const DocumentPage = ({
onQuestionSelect={handleQuestionSelect}
initialContent={documentContent}
onChange={handleChange}
- editable={canWrite}
+ editable={canWrite && !isSaving}
isLoading={isDocumentLoading}
editorContainerRef={editorContainerRef}
/>
@@ -512,7 +536,7 @@ export const DocumentPage = ({
title={t`Where should we save this document?`}
onClose={() => setCollectionPickerMode(null)}
entityType="document"
- onChange={async (collection) => {
+ onChange={(collection) => {
if (collectionPickerMode === "save") {
handleSave(canonicalCollectionId(collection.id));
setCollectionPickerMode(null);
@@ -525,6 +549,42 @@ export const DocumentPage = ({
/>
)}
+ {duplicateModalMode === "duplicate" && (
+ <EntityCopyModal
+ entityType="documents"
+ onClose={() => setDuplicateModalMode(null)}
+ onSaved={(document) => {
+ setDuplicateModalMode(null);
+ scheduleNavigation(() => {
+ dispatch(push(Urls.document(document)));
+ });
+ }}
+ entityObject={documentData}
+ title={t`Duplicate "${documentData?.name}"`}
+ overwriteOnInitialValuesChange
+ copy={async (object) => {
+ if (!documentData?.id) {
+ throw new Error(
+ "Cannot duplicate document that has not been saved",
+ );
+ }
+
+ return await copyDocument({
+ ...object,
+ id: documentData.id,
+ }).then((response) => {
+ if (response.data) {
+ const _document = response.data;
+ trackDocumentDuplicated(_document);
+ return _document;
+ } else if (response.error) {
+ throw response.error;
+ }
+ });
+ }}
+ />
+ )}
+
{children}
<LeaveRouteConfirmModal
@@ -546,6 +606,23 @@ export const DocumentPage = ({
onConfirm={resetDocument}
onClose={() => forceUpdate()}
/>
+
+ <ConfirmModal
+ // only applies when trying to duplicate a document that has unsaved changes
+ opened={duplicateModalMode === "leave"}
+ confirmButtonText={t`Save changes`}
+ confirmButtonProps={{ color: "brand" }}
+ data-testid="save-confirmation"
+ message={t`You need to save before you can duplicate this document.`}
+ title={t`Save your changes first`}
+ onConfirm={async () => {
+ if ((await handleSave())?.error) {
+ throw new Error("Failed to save document");
+ }
+ setDuplicateModalMode("duplicate");
+ }}
+ onClose={() => setDuplicateModalMode(null)}
+ />
</Box>
{isHistorySidebarOpen && documentData && (
<Box className={styles.sidebar} data-testid="document-history-sidebar">
diff --git a/frontend/src/metabase/entities/containers/EntityCopyModal.tsx b/frontend/src/metabase/entities/containers/EntityCopyModal.tsx
index 559247771bc..8749bb17ca0 100644
--- a/frontend/src/metabase/entities/containers/EntityCopyModal.tsx
+++ b/frontend/src/metabase/entities/containers/EntityCopyModal.tsx
@@ -40,20 +40,22 @@ const EntityCopyModal = ({
resolvedObject?.collection?.id,
);
- if (defaultCollectionId) {
- resolvedObject.collection_id = defaultCollectionId;
- }
+ const resolvedObjectWithDefaultCollection = defaultCollectionId
+ ? { ...resolvedObject, collection_id: defaultCollectionId }
+ : resolvedObject;
const initialValues = {
- ...dissoc(resolvedObject, "id"),
- name: resolvedObject.name + " - " + t`Duplicate`,
+ ...dissoc(resolvedObjectWithDefaultCollection, "id"),
+ name: resolvedObjectWithDefaultCollection.name + " - " + t`Duplicate`,
};
useEscapeToCloseModal(onClose);
return (
<Modal
- title={title || t`Duplicate "${resolvedObject.name}"`}
+ title={
+ title || t`Duplicate "${resolvedObjectWithDefaultCollection.name}"`
+ }
opened
onClose={onClose}
closeOnEscape={false}
@@ -65,7 +67,7 @@ const EntityCopyModal = ({
onSaved={onSaved}
initialValues={initialValues}
{...props}
- originalDashboardId={resolvedObject.id}
+ originalDashboardId={resolvedObjectWithDefaultCollection.id}
/>
)}
{entityType === "cards" && (
diff --git a/frontend/src/metabase/entities/documents.ts b/frontend/src/metabase/entities/documents.ts
index ff4e03bd3e6..0c5133d9289 100644
--- a/frontend/src/metabase/entities/documents.ts
+++ b/frontend/src/metabase/entities/documents.ts
@@ -14,7 +14,7 @@ import { DocumentSchema } from "metabase/schema";
import { color } from "metabase/ui/utils/colors";
import type {
Collection,
- CollectionId,
+ CopyDocumentRequest,
CreateDocumentRequest,
DeleteDocumentRequest,
Document,
@@ -104,21 +104,12 @@ export const Documents = createEntity({
},
),
copy:
- (
- { id }: Document,
- overrides: { name: string; collection_id: CollectionId },
- ) =>
+ ({ id }: Document, overrides: Omit<CopyDocumentRequest, "id">) =>
async (dispatch: Dispatch) => {
- const data = (await dispatch(
- documentApi.endpoints.getDocument.initiate({ id }),
- )) as { data: Document };
-
- await dispatch(
- documentApi.endpoints.createDocument.initiate({
- document: data.data.document,
- ...overrides,
- }),
+ const result = await dispatch(
+ documentApi.endpoints.copyDocument.initiate({ id, ...overrides }),
);
+ return (result as { data: Document }).data;
},
},
diff --git a/frontend/src/metabase/questions/components/CopyCardForm/CopyCardForm.tsx b/frontend/src/metabase/questions/components/CopyCardForm/CopyCardForm.tsx
index 175c6658ed0..fc916a8bf69 100644
--- a/frontend/src/metabase/questions/components/CopyCardForm/CopyCardForm.tsx
+++ b/frontend/src/metabase/questions/components/CopyCardForm/CopyCardForm.tsx
@@ -1,5 +1,5 @@
import { useMemo } from "react";
-import { t } from "ttag";
+import { c, t } from "ttag";
import _ from "underscore";
import * as Yup from "yup";
@@ -147,7 +147,10 @@ export const CopyCardForm = ({
{!!onCancel && (
<Button type="button" onClick={onCancel}>{t`Cancel`}</Button>
)}
- <FormSubmitButton label={t`Duplicate`} variant="filled" />
+ <FormSubmitButton
+ label={c(`A verb, not a noun`).t`Duplicate`}
+ variant="filled"
+ />
</FormFooter>
</Form>
)}
diff --git a/src/metabase/documents/api/document.clj b/src/metabase/documents/api/document.clj
index 078ee945ff7..668e5316343 100644
--- a/src/metabase/documents/api/document.clj
+++ b/src/metabase/documents/api/document.clj
@@ -8,6 +8,7 @@
[metabase.collections.models.collection :as collection]
[metabase.documents.models.document :as m.document]
[metabase.documents.prose-mirror :as prose-mirror]
+ [metabase.documents.schema :as documents.schema]
[metabase.events.core :as events]
[metabase.public-sharing.validation :as public-sharing.validation]
[metabase.queries.core :as card]
@@ -267,6 +268,75 @@
:user-id api/*current-user-id*})
api/generic-204-no-content))
+;;; ---------------------------------------------------- Copy --------------------------------------------------------
+
+(mu/defn- copy-cards-for-document! :- [:map-of ms/PositiveInt ms/PositiveInt]
+ "Copies all cards that belong to the source document to the new document.
+
+ Args:
+ - source-document-id: ID of the document being copied
+ - new-document-id: ID of the newly created document
+ - new-collection-id: Collection ID for the new cards
+
+ Returns:
+ - Map of old-card-id -> new-card-id"
+ [source-document-id :- ms/PositiveInt
+ new-document-id :- ms/PositiveInt
+ new-collection-id :- [:or :nil ms/PositiveInt]]
+ (let [cards-to-copy (t2/select :model/Card :document_id source-document-id)]
+ (reduce (fn [accum card]
+ (let [new-card (create-card! (-> card
+ (dissoc :id :entity_id :created_at :updated_at :creator_id
+ :public_uuid :made_public_by_id :cache_invalidated_at)
+ (assoc :document_id new-document-id
+ :collection_id new-collection-id))
+ @api/*current-user*)]
+ (when (or (:archived card) (:archived_directly card))
+ (t2/update! :model/Card (:id new-card)
+ {:archived (boolean (:archived card))
+ :archived_directly (boolean (:archived_directly card))}))
+ (assoc accum (:id card) (:id new-card))))
+ {}
+ cards-to-copy)))
+
+(api.macros/defendpoint :post "/:from-document-id/copy" :- ::documents.schema/document
+ "Copy a Document."
+ [{:keys [from-document-id]} :- [:map
+ [:from-document-id ms/PositiveInt]]
+ _query-params
+ {:keys [name collection_id collection_position]} :- [:map
+ [:name {:optional true} [:maybe ms/NonBlankString]]
+ [:collection_id {:optional true} [:maybe ms/PositiveInt]]
+ [:collection_position {:optional true} [:maybe ms/PositiveInt]]]]
+ (api/create-check :model/Document {:collection_id collection_id})
+ (let [existing-document (api/check-404
+ (api/read-check
+ (t2/select-one :model/Document :id from-document-id :archived false)))
+ document-data {:name (or name (:name existing-document))
+ :document (:document existing-document)
+ :content_type (:content_type existing-document)
+ :creator_id api/*current-user-id*
+ :collection_id collection_id
+ :collection_position collection_position}
+ new-document (t2/with-transaction [_conn]
+ (when collection_position
+ (api/maybe-reconcile-collection-position! document-data))
+ (let [new-document-id (t2/insert-returning-pk! :model/Document document-data)
+ card-id-map (copy-cards-for-document! from-document-id new-document-id collection_id)]
+ (when (seq card-id-map)
+ (t2/update! :model/Document :id new-document-id
+ (update-cards-in-ast
+ {:document (:document existing-document)
+ :content_type (:content_type existing-document)}
+ card-id-map)))
+ (u/prog1 (get-document new-document-id)
+ (when (collections/remote-synced-collection? collection_id)
+ (collections/check-non-remote-synced-dependencies <>)))))]
+ (events/publish-event! :event/document-create
+ {:object new-document
+ :user-id api/*current-user-id*})
+ new-document))
+
;;; ----------------------------------------------- Sharing is Caring ------------------------------------------------
(api.macros/defendpoint :post "/:document-id/public-link" :- [:map [:uuid ms/UUIDString]]
diff --git a/test/metabase/documents/api/document_test.clj b/test/metabase/documents/api/document_test.clj
index a8094da4974..faa8161ae89 100644
--- a/test/metabase/documents/api/document_test.clj
+++ b/test/metabase/documents/api/document_test.clj
@@ -4,6 +4,7 @@
[clojure.test :refer :all]
[medley.core :as m]
[metabase.collections.models.collection :as collection]
+ [metabase.documents.prose-mirror :as prose-mirror]
[metabase.documents.test-util :as documents.test-util]
[metabase.events.core :as events]
[metabase.permissions.core :as perms]
@@ -133,6 +134,100 @@
(mt/user-http-request :crowberto
:get 404 "document/99999")))
+(deftest copy-document-test
+ (testing "POST /api/document/:id/copy"
+ (mt/with-model-cleanup [:model/Document :model/Card]
+ (mt/with-temp [:model/Collection {coll-id :id} {}
+ :model/Document {doc-id :id} {:name "Source Document"
+ :content_type prose-mirror/prose-mirror-content-type}
+ :model/Card {card-1-id :id} {:name "Card 1"
+ :document_id doc-id
+ :collection_id coll-id
+ :dataset_query (mt/mbql-query venues)
+ :archived false}
+ :model/Card {card-2-id :id} {:name "Card 2"
+ :document_id doc-id
+ :collection_id coll-id
+ :dataset_query (mt/mbql-query users)
+ :archived false}
+ :model/Card {archived-card-id :id} {:name "Archived Card"
+ :document_id doc-id
+ :collection_id coll-id
+ :dataset_query (mt/mbql-query venues)
+ :archived true}]
+ ;; Ensure the source document embeds the cards we expect to be copied (and one archived card that should not).
+ (t2/update! :model/Document doc-id
+ {:document {:type "doc"
+ :content [{:type "cardEmbed" :attrs {:id card-1-id :name nil}}
+ {:type "paragraph"}
+ {:type "cardEmbed" :attrs {:id card-2-id :name nil}}
+ {:type "cardEmbed" :attrs {:id archived-card-id :name nil}}]}})
+
+ (let [copied (mt/user-http-request :crowberto :post 200
+ (format "document/%d/copy" doc-id)
+ {:name "Copied Document"
+ :collection_id coll-id})]
+ (testing "creates a new document row"
+ (is (pos? (:id copied)))
+ (is (not= doc-id (:id copied)))
+ (is (= "Copied Document" (:name copied)))
+ (is (= coll-id (:collection_id copied))))
+
+ (testing "copies cards onto the new document"
+ (let [new-cards (t2/select :model/Card :document_id (:id copied))]
+ (is (= 3 (count new-cards)))
+ (is (every? #(not (contains? #{card-1-id card-2-id archived-card-id} (:id %))) new-cards))))
+
+ (testing "updates embedded card IDs in the copied document AST for all copied cards"
+ (let [new-cards-by-name (into {} (map (juxt :name :id)) (t2/select :model/Card :document_id (:id copied)))
+ embedded-ids (keep #(get-in % [:attrs :id]) (get-in copied [:document :content]))]
+ (is (contains? (set embedded-ids) (get new-cards-by-name "Card 1")))
+ (is (contains? (set embedded-ids) (get new-cards-by-name "Card 2")))
+ (is (contains? (set embedded-ids) (get new-cards-by-name "Archived Card"))))))))))
+
+(deftest copy-document-permissions-test
+ (testing "POST /api/document/:id/copy - permission checks"
+ (mt/with-model-cleanup [:model/Document]
+ (testing "fails with 403 when user cannot read the source document"
+ (mt/with-temp [:model/Collection {restricted-col :id} {}
+ :model/Document {doc-id :id} {:name "Restricted Source Doc"
+ :collection_id restricted-col
+ :document (documents.test-util/text->prose-mirror-ast "restricted")}]
+ (mt/with-non-admin-groups-no-collection-perms restricted-col
+ (mt/user-http-request :rasta :post 403
+ (format "document/%d/copy" doc-id)
+ {:name "Should Not Copy"}))))
+
+ (testing "fails with 403 when user cannot create the new document in destination collection"
+ (mt/with-temp [:model/Collection {allowed-col :id} {}
+ :model/Collection {restricted-dest-col :id} {}
+ :model/Document {doc-id :id} {:name "Source Doc"
+ :collection_id allowed-col
+ :document (documents.test-util/text->prose-mirror-ast "source")}]
+ ;; Ensure the user can read the source document, but cannot write to the destination collection.
+ (mt/with-non-admin-groups-no-collection-perms restricted-dest-col
+ (mt/user-http-request :rasta :post 403
+ (format "document/%d/copy" doc-id)
+ {:name "Should Not Copy"
+ :collection_id restricted-dest-col})))))))
+
+(deftest copy-document-nonexistent-document-test
+ (testing "POST /api/document/:id/copy - non-existent source document returns 404"
+ (is (= "Not found."
+ (mt/user-http-request :crowberto :post 404
+ (format "document/%d/copy" Integer/MAX_VALUE)
+ {:name "Copy"})))))
+
+(deftest copy-document-archived-document-test
+ (testing "POST /api/document/:id/copy - archived source document returns 404"
+ (mt/with-temp [:model/Document {doc-id :id} {:name "Archived Document"
+ :document (documents.test-util/text->prose-mirror-ast "archived")
+ :archived true}]
+ (is (= "Not found."
+ (mt/user-http-request :crowberto :post 404
+ (format "document/%d/copy" doc-id)
+ {:name "Copy"}))))))
+
(deftest document-collection-sync-integration-test
(testing "End-to-end collection synchronization through API"
(mt/with-temp [:model/Collection {old-collection-id :id} {:name "Old Collection"}