Skip to content

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

Save pasted charts with a blank name as untitled questions (#84262)

Andrei Simionescu6132a0f16083
diff --git a/frontend/src/metabase/collections/components/CollectionContent/use-collection-chart-paste.unit.spec.tsx b/frontend/src/metabase/collections/components/CollectionContent/use-collection-chart-paste.unit.spec.tsx
index 6e1c92caab8..7221d6f137f 100644
--- a/frontend/src/metabase/collections/components/CollectionContent/use-collection-chart-paste.unit.spec.tsx
+++ b/frontend/src/metabase/collections/components/CollectionContent/use-collection-chart-paste.unit.spec.tsx
@@ -1,8 +1,10 @@
import { act } from "@testing-library/react";
import fetchMock from "fetch-mock";
+import { setupCardCreateEndpoint } from "__support__/server-mocks";
import { renderWithProviders, waitFor } from "__support__/ui";
import { serializeChartClipboard } from "metabase/common/utils/chart-clipboard";
+import * as Urls from "metabase/urls";
import type { Collection } from "metabase-types/api";
import { createMockCard, createMockCollection } from "metabase-types/api/mocks";
import { createMockStructuredDatasetQuery } from "metabase-types/api/mocks/query";
@@ -21,6 +23,23 @@ const chartText = serializeChartClipboard(
"https://metabase.example",
);
+const unsavedQuestionUrl = `https://metabase.example${Urls.card({
+ display: "bar",
+ dataset_query: datasetQuery,
+ visualization_settings: {},
+})}`;
+
+const blankChartText = serializeChartClipboard(
+ {
+ name: "",
+ description: "",
+ display: "bar",
+ dataset_query: datasetQuery,
+ visualization_settings: {},
+ },
+ "https://metabase.example",
+);
+
function TestComponent({ collection }: { collection: Collection }) {
useCollectionChartPaste(collection);
return null;
@@ -61,6 +80,37 @@ describe("useCollectionChartPaste", () => {
});
});
+ it.each([
+ { source: "an unsaved question's URL", text: unsavedQuestionUrl },
+ {
+ source: "a Metabot chart with a blank title and description",
+ text: blankChartText,
+ },
+ ])(
+ "saves a chart pasted from $source as an untitled question",
+ async ({ text }) => {
+ setupCardCreateEndpoint();
+
+ const { store } = setup({ canWrite: true });
+ act(() => {
+ paste(text);
+ });
+
+ await waitFor(() => {
+ expect(store.getState().undo).toContainEqual(
+ expect.objectContaining({ message: "Chart saved to My Collection" }),
+ );
+ });
+ const body: unknown = JSON.parse(
+ String(fetchMock.callHistory.lastCall("card-create")?.options.body),
+ );
+ expect(body).toMatchObject({
+ name: "Untitled question",
+ description: null,
+ });
+ },
+ );
+
it("shows an in-progress toast and ignores repeated pastes while saving", async () => {
fetchMock.post("path:/api/card", createMockCard({ id: 5 }), {
name: "create-card",
diff --git a/frontend/src/metabase/common/utils/card.ts b/frontend/src/metabase/common/utils/card.ts
index b73ed7412a0..717c7acf807 100644
--- a/frontend/src/metabase/common/utils/card.ts
+++ b/frontend/src/metabase/common/utils/card.ts
@@ -1,5 +1,6 @@
import querystring from "querystring";
+import { t } from "ttag";
import _ from "underscore";
import { clone } from "metabase/utils/clone";
@@ -32,6 +33,16 @@ import { isDashCardDataSeries } from "metabase-types/guards/dashboard";
export const QUESTION_NAME_MAX_LENGTH = 254;
+export function getNonBlankNameAndDescription({
+ name,
+ description,
+}: Partial<Pick<Card, "name" | "description">>) {
+ return {
+ name: name?.trim() ? name : t`Untitled question`,
+ description: description?.trim() ? description : null,
+ };
+}
+
export type SerializeCardOptions = {
includeDatasetQuery?: boolean;
includeOriginalCardId?: boolean;
diff --git a/frontend/src/metabase/common/utils/chart-clipboard.ts b/frontend/src/metabase/common/utils/chart-clipboard.ts
index 58e55003915..339ddd12153 100644
--- a/frontend/src/metabase/common/utils/chart-clipboard.ts
+++ b/frontend/src/metabase/common/utils/chart-clipboard.ts
@@ -4,7 +4,7 @@ import * as Urls from "metabase/urls";
import type { Card, CardDisplayType, DatasetQuery } from "metabase-types/api";
import { isCardDisplayType } from "metabase-types/api";
-import { deserializeCardFromUrl } from "./card";
+import { deserializeCardFromUrl, getNonBlankNameAndDescription } from "./card";
const ADHOC_QUESTION_HASH_REGEX = /\/question#([A-Za-z0-9_=-]+)/;
@@ -48,8 +48,7 @@ export function parseChartClipboard(
return null;
}
return {
- name: card.name ?? "",
- description: card.description ?? undefined,
+ ...getNonBlankNameAndDescription(card),
display: card.display,
dataset_query: card.dataset_query,
visualization_settings: card.visualization_settings ?? {},
diff --git a/frontend/src/metabase/common/utils/chart-clipboard.unit.spec.ts b/frontend/src/metabase/common/utils/chart-clipboard.unit.spec.ts
index cef023c9e23..5f09d7ec985 100644
--- a/frontend/src/metabase/common/utils/chart-clipboard.unit.spec.ts
+++ b/frontend/src/metabase/common/utils/chart-clipboard.unit.spec.ts
@@ -82,7 +82,7 @@ describe("chart-clipboard", () => {
expect(parseChartClipboard(`${SITE_URL}/question#${hash}`)).toEqual({
name: "Orders by month",
- description: undefined,
+ description: null,
display: "bar",
dataset_query: datasetQuery,
visualization_settings: {},
diff --git a/frontend/src/metabase/dashboard/components/Dashboard/use-dashboard-chart-paste.unit.spec.tsx b/frontend/src/metabase/dashboard/components/Dashboard/use-dashboard-chart-paste.unit.spec.tsx
index a9b829c5235..83a6578448b 100644
--- a/frontend/src/metabase/dashboard/components/Dashboard/use-dashboard-chart-paste.unit.spec.tsx
+++ b/frontend/src/metabase/dashboard/components/Dashboard/use-dashboard-chart-paste.unit.spec.tsx
@@ -2,6 +2,7 @@ import { act } from "@testing-library/react";
import fetchMock from "fetch-mock";
import {
+ setupCardCreateEndpoint,
setupCardEndpoints,
setupCardQueryEndpoints,
setupCardQueryMetadataEndpoint,
@@ -12,6 +13,7 @@ import { renderWithProviders, waitFor } from "__support__/ui";
import { serializeChartClipboard } from "metabase/common/utils/chart-clipboard";
import { MockDashboardContext } from "metabase/dashboard/context/mock-context";
import { getDashcards } from "metabase/dashboard/selectors";
+import * as Urls from "metabase/urls";
import type { Card } from "metabase-types/api";
import {
createMockCard,
@@ -43,6 +45,23 @@ const chartText = serializeChartClipboard(
"https://metabase.example",
);
+const unsavedQuestionUrl = `https://metabase.example${Urls.card({
+ display: "bar",
+ dataset_query: datasetQuery,
+ visualization_settings: {},
+})}`;
+
+const blankChartText = serializeChartClipboard(
+ {
+ name: "",
+ description: "",
+ display: "bar",
+ dataset_query: datasetQuery,
+ visualization_settings: {},
+ },
+ "https://metabase.example",
+);
+
function TestComponent() {
useDashboardChartPaste();
return null;
@@ -124,6 +143,38 @@ describe("useDashboardChartPaste", () => {
});
});
+ it.each([
+ { source: "an unsaved question's URL", text: unsavedQuestionUrl },
+ {
+ source: "a Metabot chart with a blank title and description",
+ text: blankChartText,
+ },
+ ])(
+ "adds a chart pasted from $source as an untitled question",
+ async ({ text }) => {
+ setupCardCreateEndpoint();
+ setupCardMocks(createMockCard());
+
+ const { store } = setup({ isEditing: true });
+ act(() => {
+ paste(text);
+ });
+
+ await waitFor(() => {
+ expect(store.getState().undo).toContainEqual(
+ expect.objectContaining({ message: "Chart added to dashboard" }),
+ );
+ });
+ const body: unknown = JSON.parse(
+ String(fetchMock.callHistory.lastCall("card-create")?.options.body),
+ );
+ expect(body).toMatchObject({
+ name: "Untitled question",
+ description: null,
+ });
+ },
+ );
+
it("shows an in-progress toast and ignores repeated pastes while saving", async () => {
setupCardMocks(CREATED_CARD);
fetchMock.post("path:/api/card", CREATED_CARD, {
diff --git a/frontend/src/metabase/documents/utils/draftCardUtils.ts b/frontend/src/metabase/documents/utils/draftCardUtils.ts
index 7aa340e05d1..b25b73cb965 100644
--- a/frontend/src/metabase/documents/utils/draftCardUtils.ts
+++ b/frontend/src/metabase/documents/utils/draftCardUtils.ts
@@ -1,6 +1,6 @@
-import { t } from "ttag";
import _ from "underscore";
+import { getNonBlankNameAndDescription } from "metabase/common/utils/card";
import type { Card, CardId, DocumentCardToCreate } from "metabase-types/api";
/**
@@ -21,8 +21,7 @@ export function getDocumentCardToCreate(
"result_metadata",
"cache_ttl",
),
- name: draftCard.name.trim() ? draftCard.name : t`Untitled question`,
- description: draftCard.description?.trim() ? draftCard.description : null,
+ ...getNonBlankNameAndDescription(draftCard),
source_card_id: sourceCardId,
};
}