Skip to content

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

Send only the fields a new card takes when saving a document (#84204)

Andrei Simionescu70008194d5bc
diff --git a/frontend/src/metabase-types/api/card.ts b/frontend/src/metabase-types/api/card.ts
index 65e5d035bfc..4266c41247c 100644
--- a/frontend/src/metabase-types/api/card.ts
+++ b/frontend/src/metabase-types/api/card.ts
@@ -8,6 +8,7 @@ import type {
Dashboard,
DashboardCardSize,
DashboardId,
+ DashboardParameterMapping,
DashboardTabId,
} from "./dashboard";
import type { Database, DatabaseId } from "./database";
@@ -48,6 +49,13 @@ export type CardCreationType =
export type CardDashboardInfo = Pick<Dashboard, "id" | "name">;
export type CardDocumentInfo = Pick<Document, "id" | "name">;
+export type CardParameterMapping = Omit<
+ DashboardParameterMapping,
+ "card_id"
+> & {
+ card_id?: CardId | null;
+};
+
export interface Card<
Q extends DatasetQuery = DatasetQuery,
> extends UnsavedCard<Q> {
@@ -82,6 +90,7 @@ export interface Card<
metabot_chart_id?: string | null;
dashboard_count: number | null;
parameter_usage_count?: number | null;
+ parameter_mappings?: CardParameterMapping[] | null;
result_metadata: Field[] | null;
param_fields?: Record<ParameterId, Field[]>;
@@ -623,7 +632,7 @@ export interface CreateCardRequest {
visualization_settings: VisualizationSettings;
type?: CardType;
parameters?: Parameter[];
- parameter_mappings?: unknown;
+ parameter_mappings?: CardParameterMapping[] | null;
description?: string | null;
collection_id?: CollectionId | null;
dashboard_id?: DashboardId | null;
diff --git a/frontend/src/metabase-types/api/document.ts b/frontend/src/metabase-types/api/document.ts
index c8bde95af72..8506fe7a123 100644
--- a/frontend/src/metabase-types/api/document.ts
+++ b/frontend/src/metabase-types/api/document.ts
@@ -1,6 +1,6 @@
import type { JSONContent } from "@tiptap/core";
-import type { Card, CardId } from "./card";
+import type { Card, CreateCardRequest } from "./card";
import type { Collection, CollectionId } from "./collection";
import type { BaseUser, UserId } from "./user";
@@ -34,7 +34,19 @@ export type Document = {
export type GetDocumentRequest = { id: DocumentId };
-export type DocumentCardToCreate = Card & { source_card_id?: CardId };
+export type DocumentCardToCreate = Pick<
+ CreateCardRequest,
+ | "name"
+ | "dataset_query"
+ | "display"
+ | "visualization_settings"
+ | "description"
+ | "parameters"
+ | "parameter_mappings"
+ | "result_metadata"
+ | "cache_ttl"
+ | "source_card_id"
+>;
export type CreateDocumentRequest = Pick<Document, "name"> & {
document: DocumentContent;
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardMenu/DashCardMenu.unit.spec.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardMenu/DashCardMenu.unit.spec.tsx
index 2b8928689bf..c017ef6e5b3 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardMenu/DashCardMenu.unit.spec.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardMenu/DashCardMenu.unit.spec.tsx
@@ -138,6 +138,7 @@ const setup = ({
const dashcard = createMockDashboardCard({
...card,
dashboard_id: card.dashboard_id ?? undefined,
+ parameter_mappings: [],
});
setupCardQueryDownloadEndpoint(card, "json");
diff --git a/frontend/src/metabase/documents/hooks/use-document-editor.ts b/frontend/src/metabase/documents/hooks/use-document-editor.ts
index f2d9d3716aa..522cb2270c8 100644
--- a/frontend/src/metabase/documents/hooks/use-document-editor.ts
+++ b/frontend/src/metabase/documents/hooks/use-document-editor.ts
@@ -50,6 +50,7 @@ import {
getDraftCards,
getHasUnsavedChanges,
} from "../selectors";
+import { getDocumentCardToCreate } from "../utils/draftCardUtils";
import { useDocumentState } from "./use-document-state";
import { useRegisterDocumentMetabotContext } from "./use-register-document-metabot-context";
@@ -328,10 +329,10 @@ export function useDocumentEditor({
if (cardId < 0 && draftCards[cardId]) {
const originalId: CardId | undefined =
draftCardOriginalIds[cardId];
- cardsToSave[cardId] =
- originalId != null
- ? { ...draftCards[cardId], source_card_id: originalId }
- : draftCards[cardId];
+ cardsToSave[cardId] = getDocumentCardToCreate(
+ draftCards[cardId],
+ originalId,
+ );
}
}
}
diff --git a/frontend/src/metabase/documents/hooks/use-document-editor.unit.spec.ts b/frontend/src/metabase/documents/hooks/use-document-editor.unit.spec.ts
index 686b6aedcf8..b453968a1de 100644
--- a/frontend/src/metabase/documents/hooks/use-document-editor.unit.spec.ts
+++ b/frontend/src/metabase/documents/hooks/use-document-editor.unit.spec.ts
@@ -5,9 +5,16 @@ import Paragraph from "@tiptap/extension-paragraph";
import Text from "@tiptap/extension-text";
import fetchMock from "fetch-mock";
+import { setupCreateDocumentEndpoint } from "__support__/server-mocks";
import { act, getTestStoreAndWrapper, waitFor } from "__support__/ui";
import { documentApi } from "metabase/api/document";
-import type { Document } from "metabase-types/api";
+import { buildDraftCard } from "metabase/rich_text_editing/tiptap/extensions/shared/draft-card";
+import type {
+ Card,
+ CardParameterMapping,
+ Document,
+ DocumentId,
+} from "metabase-types/api";
import {
createMockCard,
createMockDocument,
@@ -21,6 +28,12 @@ import { useDocumentEditor } from "./use-document-editor";
const DOCUMENT_ID = 1;
const UPDATE_CACHE_KEY = `document:${DOCUMENT_ID}`;
+const PARAMETER_MAPPING: CardParameterMapping = {
+ parameter_id: "abc123",
+ card_id: 10,
+ target: ["dimension", ["template-tag", "category"]],
+};
+
function deferred<T>() {
let resolve!: (value: T) => void;
const promise = new Promise<T>((res) => {
@@ -41,7 +54,11 @@ function setupEndpoints(doc: Document) {
return put;
}
-function renderEditorHook() {
+interface SetupOpts {
+ documentId?: DocumentId | "new";
+}
+
+function renderEditorHook({ documentId = DOCUMENT_ID }: SetupOpts = {}) {
const { wrapper, store } = getTestStoreAndWrapper({
initialRoute: "/",
withRouter: true,
@@ -50,7 +67,7 @@ function renderEditorHook() {
});
const { result, unmount } = renderHook(
- () => useDocumentEditor({ documentId: DOCUMENT_ID }),
+ () => useDocumentEditor({ documentId }),
{ wrapper },
);
@@ -80,6 +97,62 @@ function startUpdate(store: ReturnType<typeof renderEditorHook>["store"]) {
});
}
+interface SaveDraftCardsOpts extends SetupOpts {
+ draftCards: { draftId: number; originalCard: Card }[];
+ embeddedCardId: number;
+}
+
+async function saveDraftCards({
+ documentId = DOCUMENT_ID,
+ draftCards,
+ embeddedCardId,
+}: SaveDraftCardsOpts): Promise<unknown> {
+ const doc = createMockDocument({ id: DOCUMENT_ID });
+ setupEndpoints(doc).resolve(doc);
+ setupCreateDocumentEndpoint(doc);
+
+ const isNewDocument = documentId === "new";
+ const { result, store } = renderEditorHook({ documentId });
+ if (!isNewDocument) {
+ await waitForDocument(result);
+ }
+
+ const CardEmbed = Node.create({
+ name: "cardEmbed",
+ group: "block",
+ addAttributes: () => ({ id: { default: null } }),
+ renderHTML: () => ["div"],
+ });
+ const editor = new Editor({
+ extensions: [TiptapDocument, Paragraph, Text, CardEmbed],
+ content: {
+ type: "doc",
+ content: [{ type: "cardEmbed", attrs: { id: embeddedCardId } }],
+ },
+ });
+
+ act(() => {
+ result.current.setEditorInstance(editor);
+ draftCards.forEach(({ draftId, originalCard }) => {
+ store.dispatch(
+ createDraftCard({ originalCard, modifiedData: {}, draftId }),
+ );
+ });
+ });
+
+ await act(() => result.current.handleSave());
+ await waitFor(() => {
+ expect(result.current.isSaving).toBe(false);
+ });
+
+ const saveCall = isNewDocument
+ ? fetchMock.callHistory.lastCall("path:/api/document", { method: "POST" })
+ : fetchMock.callHistory.lastCall(`path:/api/document/${DOCUMENT_ID}`, {
+ method: "PUT",
+ });
+ return JSON.parse(String(saveCall?.options.body));
+}
+
describe("useDocumentEditor", () => {
afterEach(() => {
fetchMock.removeRoutes().clearHistory();
@@ -151,57 +224,111 @@ describe("useDocumentEditor", () => {
});
it("sends the saved card id as source_card_id when a chart is edited twice", async () => {
- const doc = createMockDocument({ id: DOCUMENT_ID });
- const put = setupEndpoints(doc);
+ const body = await saveDraftCards({
+ draftCards: [
+ { draftId: -1, originalCard: createMockCard({ id: 5 }) },
+ { draftId: -2, originalCard: createMockCard({ id: -1 }) },
+ ],
+ embeddedCardId: -2,
+ });
- const { result, store } = renderEditorHook();
- await waitForDocument(result);
+ expect(body).toHaveProperty(["cards", "-2", "source_card_id"], 5);
+ });
- const CardEmbed = Node.create({
- name: "cardEmbed",
- group: "block",
- addAttributes: () => ({ id: { default: null } }),
- renderHTML: () => ["div"],
+ it("sends only the fields a new card takes when saving a drafted chart", async () => {
+ const { name, display, dataset_query, visualization_settings } =
+ createMockCard();
+ const body = await saveDraftCards({
+ draftCards: [
+ {
+ draftId: -1,
+ originalCard: buildDraftCard({
+ id: -1,
+ name,
+ display,
+ dataset_query,
+ visualization_settings,
+ }),
+ },
+ ],
+ embeddedCardId: -1,
});
- const editor = new Editor({
- extensions: [TiptapDocument, Paragraph, Text, CardEmbed],
- content: {
- type: "doc",
- content: [{ type: "cardEmbed", attrs: { id: -2 } }],
- },
+
+ expect(body).toHaveProperty(["cards", "-1"], {
+ name,
+ display,
+ dataset_query,
+ visualization_settings,
+ description: null,
+ result_metadata: [],
+ cache_ttl: null,
});
+ });
- act(() => {
- result.current.setEditorInstance(editor);
- store.dispatch(
- createDraftCard({
- originalCard: createMockCard({ id: 5 }),
- modifiedData: {},
- draftId: -1,
- }),
- );
- store.dispatch(
- createDraftCard({
- originalCard: createMockCard({ id: -1 }),
- modifiedData: {},
- draftId: -2,
- }),
+ it.each<{ path: string; documentId: DocumentId | "new" }>([
+ { path: "create", documentId: "new" },
+ { path: "update", documentId: DOCUMENT_ID },
+ ])(
+ "keeps a saved question's parameter mappings on $path",
+ async ({ documentId }) => {
+ const body = await saveDraftCards({
+ documentId,
+ draftCards: [
+ {
+ draftId: -1,
+ originalCard: createMockCard({
+ id: 5,
+ parameter_mappings: [PARAMETER_MAPPING],
+ }),
+ },
+ ],
+ embeddedCardId: -1,
+ });
+
+ expect(body).toHaveProperty(
+ ["cards", "-1", "parameter_mappings"],
+ [PARAMETER_MAPPING],
);
+ },
+ );
+
+ it("sends a default name and no description when a draft has blank ones", async () => {
+ const { display, dataset_query, visualization_settings } = createMockCard();
+ const body = await saveDraftCards({
+ draftCards: [
+ {
+ draftId: -1,
+ originalCard: buildDraftCard({
+ id: -1,
+ name: "",
+ description: "",
+ display,
+ dataset_query,
+ visualization_settings,
+ }),
+ },
+ ],
+ embeddedCardId: -1,
});
- put.resolve(doc);
- await act(() => result.current.handleSave());
- await waitFor(() => {
- expect(result.current.isSaving).toBe(false);
+ expect(body).toMatchObject({
+ cards: { "-1": { name: "Untitled question", description: null } },
});
+ });
- const body = JSON.parse(
- String(
- fetchMock.callHistory.lastCall(`path:/api/document/${DOCUMENT_ID}`, {
- method: "PUT",
- })?.options.body,
- ),
- );
- expect(body.cards["-2"]).toMatchObject({ source_card_id: 5 });
+ it("sends a nonblank name and description as written", async () => {
+ const name = " Orders ";
+ const description = " SELECT 1";
+ const body = await saveDraftCards({
+ draftCards: [
+ {
+ draftId: -1,
+ originalCard: createMockCard({ id: 5, name, description }),
+ },
+ ],
+ embeddedCardId: -1,
+ });
+
+ expect(body).toMatchObject({ cards: { "-1": { name, description } } });
});
});
diff --git a/frontend/src/metabase/documents/utils/draftCardUtils.ts b/frontend/src/metabase/documents/utils/draftCardUtils.ts
new file mode 100644
index 00000000000..7aa340e05d1
--- /dev/null
+++ b/frontend/src/metabase/documents/utils/draftCardUtils.ts
@@ -0,0 +1,28 @@
+import { t } from "ttag";
+import _ from "underscore";
+
+import type { Card, CardId, DocumentCardToCreate } from "metabase-types/api";
+
+/**
+ * Converts a draft card to the card that saving its document creates
+ */
+export function getDocumentCardToCreate(
+ draftCard: Card,
+ sourceCardId?: CardId,
+): DocumentCardToCreate {
+ return {
+ ..._.pick(
+ draftCard,
+ "dataset_query",
+ "display",
+ "visualization_settings",
+ "parameters",
+ "parameter_mappings",
+ "result_metadata",
+ "cache_ttl",
+ ),
+ name: draftCard.name.trim() ? draftCard.name : t`Untitled question`,
+ description: draftCard.description?.trim() ? draftCard.description : null,
+ source_card_id: sourceCardId,
+ };
+}
diff --git a/frontend/test/__support__/server-mocks/document.ts b/frontend/test/__support__/server-mocks/document.ts
index 20079dd8da3..db062e3700a 100644
--- a/frontend/test/__support__/server-mocks/document.ts
+++ b/frontend/test/__support__/server-mocks/document.ts
@@ -12,6 +12,10 @@ export function setupDocumentEndpoints(doc: Document) {
fetchMock.delete(`path:/api/document/${doc.id}`, {});
}
+export function setupCreateDocumentEndpoint(doc: Document) {
+ fetchMock.post("path:/api/document", doc);
+}
+
export function setupListPublicDocumentsEndpoint(
publicDocuments: GetPublicDocument[],
) {