Skip to content

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

Show confirmation modal when uploading CSV to model with duplicates (#77636)

Riley Thompsona08f7ff9184e
diff --git a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionActions.tsx b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionActions.tsx
index d93eec3365c..c011231040d 100644
--- a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionActions.tsx
+++ b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionActions.tsx
@@ -1,8 +1,10 @@
import type { ChangeEvent } from "react";
-import { useRef, useState } from "react";
-import { t } from "ttag";
+import { useMemo, useRef, useState } from "react";
+import { c, t } from "ttag";
+import { skipToken, useListCardsQuery } from "metabase/api";
import { BookmarkToggle } from "metabase/common/components/BookmarkToggle";
+import { ConfirmModal } from "metabase/common/components/ConfirmModal";
import { ToolbarButton } from "metabase/common/components/ToolbarButton";
import { UploadInput } from "metabase/common/components/upload";
import { useRegisterShortcut } from "metabase/palette/hooks/useRegisterShortcut";
@@ -66,20 +68,46 @@ export const QuestionActions = ({
: undefined;
const hasCollectionPermissions = question.canWrite();
- const canAppend =
- hasCollectionPermissions && !!question._card.based_on_upload;
+ const uploadTableId = question._card.based_on_upload;
+ const canAppend = hasCollectionPermissions && !!uploadTableId;
const fileInputRef = useRef<HTMLInputElement>(null);
+ const [isUploadWarningModalOpen, setIsUploadWarningModalOpen] =
+ useState(false);
+
+ const { data: cardsBasedOnUploadTable, isLoading: isLoadingCards } =
+ useListCardsQuery(
+ typeof uploadTableId === "number"
+ ? { f: "table", model_id: uploadTableId }
+ : skipToken,
+ );
+
+ const otherModelNames = useMemo(
+ () =>
+ (cardsBasedOnUploadTable ?? [])
+ .filter((card) => card.type === "model" && card.id !== question.id())
+ .map((card) => card.name)
+ .join(", "),
+ [cardsBasedOnUploadTable, question],
+ );
const handleUploadClick = (
newUploadMode: UploadMode.append | UploadMode.replace,
) => {
- if (fileInputRef.current) {
- setUploadMode(newUploadMode);
- fileInputRef.current.click();
+ setUploadMode(newUploadMode);
+
+ if (otherModelNames.length > 0) {
+ setIsUploadWarningModalOpen(true);
+ } else {
+ fileInputRef.current?.click();
}
};
+ const handleUploadWarningConfirm = () => {
+ setIsUploadWarningModalOpen(false);
+ fileInputRef.current?.click();
+ };
+
const handleFileUpload = (event: ChangeEvent<HTMLInputElement>) => {
const file = event.target.files?.[0];
if (file && question._card.based_on_upload) {
@@ -144,6 +172,7 @@ export const QuestionActions = ({
<Menu.Dropdown>
<Menu.Item
leftSection={<Icon name="add" />}
+ disabled={isLoadingCards}
onClick={() => handleUploadClick(UploadMode.append)}
>
{t`Append data to this model`}
@@ -151,6 +180,7 @@ export const QuestionActions = ({
<Menu.Item
leftSection={<Icon name="refresh" />}
+ disabled={isLoadingCards}
onClick={() => handleUploadClick(UploadMode.replace)}
>
{t`Replace all data in this model`}
@@ -158,6 +188,17 @@ export const QuestionActions = ({
</Menu.Dropdown>
</Menu>
</Box>
+ <ConfirmModal
+ opened={isUploadWarningModalOpen}
+ title={t`Upload data to this model?`}
+ message={c(
+ "{0} is a comma-separated list of model names sharing the same uploaded table",
+ )
+ .t`This model shares its underlying uploaded table with ${otherModelNames}. This CSV upload will also change the data for those models, along with any other questions or models based on them.`}
+ confirmButtonText={t`Upload anyway`}
+ onConfirm={handleUploadWarningConfirm}
+ onClose={() => setIsUploadWarningModalOpen(false)}
+ />
</>
)}
{!question.isArchived() && (
diff --git a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionActions.unit.spec.tsx b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionActions.unit.spec.tsx
index 6906c21c300..0df5a2f8a89 100644
--- a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionActions.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionActions.unit.spec.tsx
@@ -1,5 +1,7 @@
import userEvent from "@testing-library/user-event";
+import fetchMock from "fetch-mock";
+import { setupCardsForTableEndpoint } from "__support__/server-mocks";
import { setupListNotificationEndpoints } from "__support__/server-mocks/notification";
import { setupGetUserKeyValueEndpoint } from "__support__/server-mocks/user-key-value";
import { createMockEntitiesState } from "__support__/store";
@@ -57,12 +59,14 @@ interface SetupOpts {
card: Card;
hasDataPermissions?: boolean;
hasAcknowledgedModelModal?: boolean;
+ cardsBasedOnUploadTable?: Card[];
}
function setup({
card,
hasDataPermissions = true,
hasAcknowledgedModelModal = false,
+ cardsBasedOnUploadTable = [card],
}: SetupOpts) {
setupGetUserKeyValueEndpoint({
namespace: "user_acknowledgement",
@@ -72,6 +76,10 @@ function setup({
setupListNotificationEndpoints({ card_id: card.id }, []);
+ if (typeof card.based_on_upload === "number") {
+ setupCardsForTableEndpoint(card.based_on_upload, cardsBasedOnUploadTable);
+ }
+
const state = createMockState({
entities: createMockEntitiesState({
databases: hasDataPermissions ? [createSampleDatabase()] : [],
@@ -302,6 +310,76 @@ describe("QuestionActions", () => {
});
});
+ describe("uploading data to an upload-backed model", () => {
+ const UPLOAD_TABLE_ID = 42;
+
+ const uploadModelCard = createMockCard({
+ id: 1,
+ type: "model",
+ can_write: true,
+ based_on_upload: UPLOAD_TABLE_ID,
+ });
+
+ it("should warn before uploading when other models are based on the same uploaded table", async () => {
+ setup({
+ card: uploadModelCard,
+ cardsBasedOnUploadTable: [
+ uploadModelCard,
+ createMockCard({
+ id: 2,
+ name: "Original model",
+ type: "model",
+ based_on_upload: UPLOAD_TABLE_ID,
+ }),
+ createMockCard({
+ id: 3,
+ name: "Another duplicate",
+ type: "model",
+ based_on_upload: UPLOAD_TABLE_ID,
+ }),
+ ],
+ });
+
+ await waitForCardsBasedOnUploadTable();
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Upload data to this model" }),
+ );
+ const appendMenuItem = await screen.findByRole("menuitem", {
+ name: /Append data to this model/,
+ });
+ await waitFor(() => expect(appendMenuItem).toBeEnabled());
+ await userEvent.click(appendMenuItem);
+
+ const modal = await screen.findByRole("dialog", {
+ name: "Upload data to this model?",
+ });
+ expect(
+ within(modal).getByText(/Original model, Another duplicate/),
+ ).toBeInTheDocument();
+ });
+
+ it("should not warn when no other models are based on the same uploaded table", async () => {
+ setup({
+ card: uploadModelCard,
+ cardsBasedOnUploadTable: [uploadModelCard],
+ });
+
+ await waitForCardsBasedOnUploadTable();
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Upload data to this model" }),
+ );
+ const appendMenuItem = await screen.findByRole("menuitem", {
+ name: /Append data to this model/,
+ });
+ await waitFor(() => expect(appendMenuItem).toBeEnabled());
+ await userEvent.click(appendMenuItem);
+
+ expect(screen.queryByRole("dialog")).not.toBeInTheDocument();
+ });
+ });
+
it("should not render the menu when there are no menu items", () => {
setup({
card: createMockCard({
@@ -320,3 +398,13 @@ async function openActionsMenu() {
await userEvent.click(getIcon("ellipsis"));
expect(await screen.findByRole("menu")).toBeInTheDocument();
}
+
+async function waitForCardsBasedOnUploadTable() {
+ await waitFor(() => {
+ expect(
+ fetchMock.callHistory.called("path:/api/card", {
+ query: { f: "table" },
+ }),
+ ).toBe(true);
+ });
+}
diff --git a/frontend/test/__support__/server-mocks/card.ts b/frontend/test/__support__/server-mocks/card.ts
index 36115c0cdce..6c5e1b24c97 100644
--- a/frontend/test/__support__/server-mocks/card.ts
+++ b/frontend/test/__support__/server-mocks/card.ts
@@ -5,6 +5,7 @@ import type {
Card,
CardId,
CardQueryMetadata,
+ ConcreteTableId,
DashboardId,
Dataset,
GetPublicCard,
@@ -74,6 +75,17 @@ export function setupCardsUsingModelEndpoint(card: Card, usedBy: Card[] = []) {
});
}
+export function setupCardsForTableEndpoint(
+ tableId: ConcreteTableId,
+ cards: Card[] = [],
+) {
+ fetchMock.get({
+ url: "path:/api/card",
+ query: { f: "table", model_id: tableId },
+ response: cards,
+ });
+}
+
export function setupCardCreateEndpoint() {
fetchMock.post(
"path:/api/card",