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
Fix document restore (#74257)
Romeo Van Snickbf205c5074c7
diff --git a/enterprise/frontend/src/metabase-enterprise/clean_up/CleanupCollectionModal/CleanupCollectionBulkActions.tsx b/enterprise/frontend/src/metabase-enterprise/clean_up/CleanupCollectionModal/CleanupCollectionBulkActions.tsxindex 207e5e86bd0..fd874e62eb2 100644--- a/enterprise/frontend/src/metabase-enterprise/clean_up/CleanupCollectionModal/CleanupCollectionBulkActions.tsx+++ b/enterprise/frontend/src/metabase-enterprise/clean_up/CleanupCollectionModal/CleanupCollectionBulkActions.tsx@@ -2,12 +2,12 @@ import { useState } from "react";import { msgid, ngettext, t } from "ttag";import { archiveAndTrack } from "metabase/archive/analytics";+import { type ArchivableItem, useSetArchive } from "metabase/archive/hooks";import {BulkActionBar,BulkActionButton,} from "metabase/common/components/BulkActionBar";import { UndoListOverlay } from "metabase/common/components/UndoListing";-import { type ArchivableItem, useSetArchive } from "metabase/common/hooks";import type { Undo } from "metabase/redux/store/undo";import type { StaleCollectionItem } from "../types";diff --git a/frontend/src/metabase/admin/datamodel/containers/SegmentListApp.tsx b/frontend/src/metabase/admin/datamodel/containers/SegmentListApp.tsxindex 4bb3b4b039b..f3188a90adf 100644--- a/frontend/src/metabase/admin/datamodel/containers/SegmentListApp.tsx+++ b/frontend/src/metabase/admin/datamodel/containers/SegmentListApp.tsx@@ -6,10 +6,10 @@ import { t } from "ttag";import { SegmentItem } from "metabase/admin/datamodel/components/SegmentItem";import { FilteredToUrlTable } from "metabase/admin/datamodel/hoc/FilteredToUrlTable";import { useListSegmentsQuery } from "metabase/api";+import { useSetArchive } from "metabase/archive/hooks";import { Button } from "metabase/common/components/Button";import { Link } from "metabase/common/components/Link";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";-import { useSetArchive } from "metabase/common/hooks";import AdminS from "metabase/css/admin.module.css";import CS from "metabase/css/core/index.css";import { trackSegmentCreateStarted } from "metabase/data-studio/analytics";diff --git a/frontend/src/metabase/archive/hooks/index.ts b/frontend/src/metabase/archive/hooks/index.tsnew file mode 100644index 00000000000..6de77440199--- /dev/null+++ b/frontend/src/metabase/archive/hooks/index.ts@@ -0,0 +1,3 @@+export * from "./use-delete-item";+export * from "./use-restore";+export * from "./use-set-archive";diff --git a/frontend/src/metabase/common/hooks/use-delete-item.ts b/frontend/src/metabase/archive/hooks/use-delete-item.tssimilarity index 72%rename from frontend/src/metabase/common/hooks/use-delete-item.tsrename to frontend/src/metabase/archive/hooks/use-delete-item.tsindex c9091b7e304..d6c1662d273 100644--- a/frontend/src/metabase/common/hooks/use-delete-item.ts+++ b/frontend/src/metabase/archive/hooks/use-delete-item.ts@@ -1,5 +1,6 @@import { useCallback } from "react";import { match } from "ts-pattern";+import { t } from "ttag";import {useDeleteCardMutation,@@ -7,6 +8,8 @@ import {useDeleteDashboardMutation,useDeleteDocumentMutation,} from "metabase/api";+import { TRASHABLE_MODELS } from "metabase/archive/utils";+import { useToast } from "metabase/common/hooks/use-toast";import type {CardId,DashboardId,@@ -30,31 +33,27 @@ export type DeletableItem =export type DeletableModel = DeletableItem["model"];-const DELETABLE_MODELS = new Set<string>([- "card",- "dataset",- "metric",- "dashboard",- "collection",- "document",-]);+export function isDeletable(item: { model: string }): item is DeletableItem {+ return TRASHABLE_MODELS.has(item.model);+}export function canDelete(item: {model: string;can_delete?: boolean;}): item is DeletableItem {- return item.can_delete === true && DELETABLE_MODELS.has(item.model);+ return item.can_delete === true && isDeletable(item);}export function useDeleteItem() {+ const [sendToast] = useToast();const [deleteCard] = useDeleteCardMutation();const [deleteDashboard] = useDeleteDashboardMutation();const [deleteCollection] = useDeleteCollectionMutation();const [deleteDocument] = useDeleteDocumentMutation();return useCallback(- (item: DeletableItem) =>- match(item)+ async (item: DeletableItem) => {+ await match(item).with({ model: "card" },{ model: "dataset" },@@ -68,7 +67,10 @@ export function useDeleteItem() {.with({ model: "document" }, ({ id }) =>deleteDocument({ id }).unwrap(),)- .exhaustive(),- [deleteCard, deleteDashboard, deleteCollection, deleteDocument],+ .exhaustive();++ sendToast({ message: t`This item has been permanently deleted.` });+ },+ [sendToast, deleteCard, deleteDashboard, deleteCollection, deleteDocument],);}diff --git a/frontend/src/metabase/archive/hooks/use-delete-item.unit.spec.tsx b/frontend/src/metabase/archive/hooks/use-delete-item.unit.spec.tsxnew file mode 100644index 00000000000..b58340545b7--- /dev/null+++ b/frontend/src/metabase/archive/hooks/use-delete-item.unit.spec.tsx@@ -0,0 +1,86 @@+import userEvent from "@testing-library/user-event";+import fetchMock from "fetch-mock";++import { renderWithProviders, screen, waitFor } from "__support__/ui";+import { UndoListing } from "metabase/common/components/UndoListing";++import { type DeletableItem, useDeleteItem } from "./use-delete-item";++function TestComponent({ item }: { item: DeletableItem }) {+ const deleteItem = useDeleteItem();+ return (+ <div>+ <button onClick={() => deleteItem(item)}>Delete</button>+ <UndoListing />+ </div>+ );+}++const setup = (item: DeletableItem) => {+ renderWithProviders(<TestComponent item={item} />);+};++const clickDelete = async () => {+ await userEvent.click(screen.getByRole("button", { name: "Delete" }));+};++const expectSingleDeleteCall = async (path: string) => {+ await waitFor(() => {+ expect(+ fetchMock.callHistory.calls(path, { method: "DELETE" }),+ ).toHaveLength(1);+ });+};++describe("useDeleteItem", () => {+ it.each(["card", "dataset", "metric"] as const)(+ "deletes a %s via DELETE /api/card/:id",+ async (model) => {+ fetchMock.delete("path:/api/card/1", 204);++ setup({ model, id: 1, can_delete: true });+ await clickDelete();++ await expectSingleDeleteCall("path:/api/card/1");+ expect(+ await screen.findByText("This item has been permanently deleted."),+ ).toBeInTheDocument();+ },+ );++ it("deletes a dashboard via DELETE /api/dashboard/:id", async () => {+ fetchMock.delete("path:/api/dashboard/2", 204);++ setup({ model: "dashboard", id: 2, can_delete: true });+ await clickDelete();++ await expectSingleDeleteCall("path:/api/dashboard/2");+ expect(+ await screen.findByText("This item has been permanently deleted."),+ ).toBeInTheDocument();+ });++ it("deletes a collection via DELETE /api/collection/:id", async () => {+ fetchMock.delete("path:/api/collection/3", 204);++ setup({ model: "collection", id: 3, can_delete: true });+ await clickDelete();++ await expectSingleDeleteCall("path:/api/collection/3");+ expect(+ await screen.findByText("This item has been permanently deleted."),+ ).toBeInTheDocument();+ });++ it("deletes a document via DELETE /api/document/:id", async () => {+ fetchMock.delete("path:/api/document/4", 204);++ setup({ model: "document", id: 4, can_delete: true });+ await clickDelete();++ await expectSingleDeleteCall("path:/api/document/4");+ expect(+ await screen.findByText("This item has been permanently deleted."),+ ).toBeInTheDocument();+ });+});diff --git a/frontend/src/metabase/archive/hooks/use-restore.ts b/frontend/src/metabase/archive/hooks/use-restore.tsnew file mode 100644index 00000000000..52e2a03db0e--- /dev/null+++ b/frontend/src/metabase/archive/hooks/use-restore.ts@@ -0,0 +1,135 @@+import { useCallback } from "react";+import { push } from "react-router-redux";+import { match } from "ts-pattern";+import { t } from "ttag";+import _ from "underscore";++import {+ Api,+ useUpdateCardMutation,+ useUpdateCollectionMutation,+ useUpdateDashboardMutation,+ useUpdateDocumentMutation,+} from "metabase/api";+import { listTag } from "metabase/api/tags";+import { TRASHABLE_MODELS, getParentEntityLink } from "metabase/archive/utils";+import { useToast } from "metabase/common/hooks/use-toast";+import { useDispatch } from "metabase/redux";+import type {+ Card,+ CardId,+ Collection,+ CollectionEssentials,+ Dashboard,+ DashboardId,+ Document,+ DocumentId,+ RegularCollectionId,+} from "metabase-types/api";++type Restorable<M extends string, Id> = {+ model: M;+ id: Id;+ name?: string;+ can_restore?: boolean;+};++export type RestorableItem =+ | Restorable<"card", CardId>+ | Restorable<"dataset", CardId>+ | Restorable<"metric", CardId>+ | Restorable<"dashboard", DashboardId>+ | Restorable<"collection", RegularCollectionId>+ | Restorable<"document", DocumentId>;++export type RestorableModel = RestorableItem["model"];++export function isRestorable(item: { model: string }): item is RestorableItem {+ return TRASHABLE_MODELS.has(item.model);+}++export function canRestore(item: {+ model: string;+ can_restore?: boolean;+}): item is RestorableItem {+ return item.can_restore === true && isRestorable(item);+}++export type RestoredEntity = Card | Dashboard | Collection | Document;++export type RestoreResult = {+ entity: RestoredEntity;+ parentCollection: CollectionEssentials | Collection | undefined;+};++export function useRestore() {+ const dispatch = useDispatch();+ const [sendToast] = useToast();+ const [updateCard] = useUpdateCardMutation();+ const [updateDashboard] = useUpdateDashboardMutation();+ const [updateCollection] = useUpdateCollectionMutation();+ const [updateDocument] = useUpdateDocumentMutation();++ return useCallback(+ async (item: RestorableItem): Promise<RestoreResult> => {+ const result: RestoreResult = await match(item)+ .with(+ { model: "card" },+ { model: "dataset" },+ { model: "metric" },+ async ({ id }) => {+ const entity = await updateCard({ id, archived: false }).unwrap();+ return { entity, parentCollection: entity.collection ?? undefined };+ },+ )+ .with({ model: "dashboard" }, async ({ id }) => {+ const entity = await updateDashboard({+ id,+ archived: false,+ }).unwrap();+ return { entity, parentCollection: entity.collection ?? undefined };+ })+ .with({ model: "collection" }, async ({ id }) => {+ const entity = await updateCollection({+ id,+ archived: false,+ }).unwrap();+ return {+ entity,+ parentCollection: _.last(entity.effective_ancestors ?? []),+ };+ })+ .with({ model: "document" }, async ({ id }) => {+ const entity = await updateDocument({+ id,+ archived: false,+ }).unwrap();+ return { entity, parentCollection: entity.collection ?? undefined };+ })+ .exhaustive();++ dispatch(Api.util.invalidateTags([listTag("bookmark")]));++ const redirect = getParentEntityLink(+ result.entity,+ result.parentCollection,+ );+ const name = item.name ?? result.entity.name;+ sendToast({+ message: t`${name} has been restored.`,+ actionLabel: t`View`,+ action: () => dispatch(push(redirect)),+ });++ return result;+ },+ [+ dispatch,+ sendToast,+ updateCard,+ updateDashboard,+ updateCollection,+ updateDocument,+ ],+ );+}diff --git a/frontend/src/metabase/archive/hooks/use-restore.unit.spec.tsx b/frontend/src/metabase/archive/hooks/use-restore.unit.spec.tsxnew file mode 100644index 00000000000..a7ef2fd9e5c--- /dev/null+++ b/frontend/src/metabase/archive/hooks/use-restore.unit.spec.tsx@@ -0,0 +1,119 @@+import userEvent from "@testing-library/user-event";+import fetchMock from "fetch-mock";++import { findRequests } from "__support__/server-mocks";+import { renderWithProviders, screen } from "__support__/ui";+import { UndoListing } from "metabase/common/components/UndoListing";+import {+ createMockCard,+ createMockCollection,+ createMockDashboard,+ createMockDocument,+} from "metabase-types/api/mocks";++import { type RestorableItem, useRestore } from "./use-restore";++function TestComponent({ item }: { item: RestorableItem }) {+ const restore = useRestore();+ return (+ <div>+ <button onClick={() => restore(item)}>Restore</button>+ <UndoListing />+ </div>+ );+}++const setup = (item: RestorableItem) => {+ renderWithProviders(<TestComponent item={item} />);+};++const clickRestore = async () => {+ await userEvent.click(screen.getByRole("button", { name: "Restore" }));+};++const expectPutWithArchivedFalse = async (urlSubstring: string) => {+ const puts = await findRequests("PUT");+ expect(puts).toHaveLength(1);+ expect(puts[0].url).toContain(urlSubstring);+ expect(puts[0].body).toMatchObject({ archived: false });+};++describe("useRestore", () => {+ it.each(["card", "dataset", "metric"] as const)(+ "restores a %s via PUT /api/card/:id with archived: false",+ async (model) => {+ fetchMock.put(+ "path:/api/card/1",+ createMockCard({ id: 1, name: "My card", archived: false }),+ );++ setup({ model, id: 1, name: "My card", can_restore: true });+ await clickRestore();++ await expectPutWithArchivedFalse("/api/card/1");+ expect(+ await screen.findByText("My card has been restored."),+ ).toBeInTheDocument();+ expect(screen.getByText("View")).toBeInTheDocument();+ },+ );++ it("restores a dashboard via PUT /api/dashboard/:id with archived: false", async () => {+ fetchMock.put(+ "path:/api/dashboard/2",+ createMockDashboard({ id: 2, name: "My dash", archived: false }),+ );++ setup({ model: "dashboard", id: 2, name: "My dash", can_restore: true });+ await clickRestore();++ await expectPutWithArchivedFalse("/api/dashboard/2");+ expect(+ await screen.findByText("My dash has been restored."),+ ).toBeInTheDocument();+ });++ it("restores a collection via PUT /api/collection/:id with archived: false", async () => {+ fetchMock.put(+ "path:/api/collection/3",+ createMockCollection({ id: 3, name: "My folder", archived: false }),+ );++ setup({ model: "collection", id: 3, name: "My folder", can_restore: true });+ await clickRestore();++ await expectPutWithArchivedFalse("/api/collection/3");+ expect(+ await screen.findByText("My folder has been restored."),+ ).toBeInTheDocument();+ });++ it("restores a document via PUT /api/document/:id with archived: false", async () => {+ fetchMock.put(+ "path:/api/document/4",+ createMockDocument({ id: 4, name: "My doc", archived: false }),+ );++ setup({ model: "document", id: 4, name: "My doc", can_restore: true });+ await clickRestore();++ await expectPutWithArchivedFalse("/api/document/4");+ expect(+ await screen.findByText("My doc has been restored."),+ ).toBeInTheDocument();+ });++ it("falls back to the entity name when the item has no name", async () => {+ fetchMock.put(+ "path:/api/document/5",+ createMockDocument({ id: 5, name: "Server name", archived: false }),+ );++ setup({ model: "document", id: 5, can_restore: true });+ await clickRestore();++ expect(+ await screen.findByText("Server name has been restored."),+ ).toBeInTheDocument();+ });+});diff --git a/frontend/src/metabase/common/hooks/use-set-archive.ts b/frontend/src/metabase/archive/hooks/use-set-archive.tssimilarity index 100%rename from frontend/src/metabase/common/hooks/use-set-archive.tsrename to frontend/src/metabase/archive/hooks/use-set-archive.tsdiff --git a/frontend/src/metabase/archive/utils.ts b/frontend/src/metabase/archive/utils.tsindex 1a09810c798..02dc009408f 100644--- a/frontend/src/metabase/archive/utils.ts+++ b/frontend/src/metabase/archive/utils.ts@@ -1,8 +1,25 @@import { c } from "ttag";import _ from "underscore";+import * as Urls from "metabase/urls";import type { Collection, CollectionItem } from "metabase-types/api";+// Models that participate in the trash lifecycle (restore + permanent delete).+// A superset of ArchivableItem.model exists in metabase/archive/hooks/use-set-archive.ts —+// items like snippets and timelines can be archived but not surfaced in the trash UI.+export const TRASHABLE_MODELS_ARRAY = [+ "card",+ "dataset",+ "metric",+ "dashboard",+ "collection",+ "document",+] as const;++export type TrashableModel = (typeof TRASHABLE_MODELS_ARRAY)[number];++export const TRASHABLE_MODELS = new Set<string>(TRASHABLE_MODELS_ARRAY);+/*** @param updateActionResult - result value of await dispatch(Entity.action.update(...))*/@@ -15,6 +32,40 @@ export function HACK_getParentCollectionFromEntityUpdateAction(: updateActionResult?.payload?.object?.collection;}+function isDashboardQuestion(entity: unknown): entity is {+ type: "question";+ dashboard_id: number | string;+} {+ if (typeof entity !== "object" || entity === null) {+ return false;+ }+ const { type, dashboard_id } = entity as {+ type?: unknown;+ dashboard_id?: unknown;+ };+ return (+ type === "question" &&+ (typeof dashboard_id === "number" || typeof dashboard_id === "string")+ );+}++export function getParentEntityLink(+ updatedEntity: unknown,+ parentCollection: Pick<Collection, "id" | "name"> | undefined,+) {+ // get link for parent collection+ const parentCollectionLink = parentCollection+ ? Urls.collection(parentCollection)+ : `/collection/root`;++ // get link for parent dashboard if we're dealing with a dashboard question+ const parentDashboardLink = isDashboardQuestion(updatedEntity)+ ? Urls.dashboard({ id: updatedEntity.dashboard_id, name: "" })+ : undefined;++ return parentDashboardLink ? parentDashboardLink : parentCollectionLink;+}+export function getTrashUndoMessage(name: string, archived: boolean): string {return archived? c(diff --git a/frontend/src/metabase/archive/utils.unit.spec.ts b/frontend/src/metabase/archive/utils.unit.spec.tsnew file mode 100644index 00000000000..64b5c5276cb--- /dev/null+++ b/frontend/src/metabase/archive/utils.unit.spec.ts@@ -0,0 +1,37 @@+import {+ createMockCard,+ createMockCollectionItem,+ createMockDashboard,+} from "metabase-types/api/mocks";++import { getParentEntityLink } from "./utils";++describe("getParentEntityLink", () => {+ it("should generate collection link for collection question", () => {+ const updatedCollection = createMockCollectionItem({ archived: false });+ const link = getParentEntityLink(updatedCollection, undefined);+ expect(link).toBe("/collection/root");+ });++ it("should generate collection link for dashboards", () => {+ const updatedDashboard = createMockDashboard({ archived: false });+ const parentCollection = createMockCollectionItem({ id: 123 });+ const link = getParentEntityLink(updatedDashboard, parentCollection);+ expect(link).toBe("/collection/123-question");+ });++ it("should generate collection link for normal question", () => {+ const updatedQuestion = createMockCard({ archived: false });+ const link = getParentEntityLink(updatedQuestion, undefined);+ expect(link).toBe("/collection/root");+ });++ it("should generate collection link for dashboard question", () => {+ const updatedQuestion = createMockCard({+ archived: false,+ dashboard_id: 123,+ });+ const link = getParentEntityLink(updatedQuestion, undefined);+ expect(link).toBe("/dashboard/123");+ });+});diff --git a/frontend/src/metabase/browse/metrics/MetricsTable.tsx b/frontend/src/metabase/browse/metrics/MetricsTable.tsxindex fdcf3ed8a34..b5991f5ac10 100644--- a/frontend/src/metabase/browse/metrics/MetricsTable.tsx+++ b/frontend/src/metabase/browse/metrics/MetricsTable.tsx@@ -7,6 +7,7 @@ import {useCreateBookmarkMutation,useDeleteBookmarkMutation,} from "metabase/api";+import { useSetArchive } from "metabase/archive/hooks";import { getCollectionName } from "metabase/collections/utils";import { EllipsifiedCollectionPath } from "metabase/common/components/EllipsifiedPath/EllipsifiedCollectionPath";import { EntityItem } from "metabase/common/components/EntityItem";@@ -23,7 +24,6 @@ import { Columns } from "metabase/common/components/ItemsTable/Columns";import type { ResponsiveProps } from "metabase/common/components/ItemsTable/utils";import { Link } from "metabase/common/components/Link";import { MarkdownPreview } from "metabase/common/components/MarkdownPreview";-import { useSetArchive } from "metabase/common/hooks";import { useDispatch } from "metabase/redux";import {Button,diff --git a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsxindex 3a512be3dd3..a9d27e18ca9 100644--- a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx+++ b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx@@ -1,12 +1,15 @@import { useDisclosure } from "@mantine/hooks";import { useCallback, useMemo } from "react";-import { push } from "react-router-redux";import { t } from "ttag";-import _ from "underscore";-import { Api, collectionApi } from "metabase/api";-import { listTag } from "metabase/api/tags";-import { HACK_getParentCollectionFromEntityUpdateAction } from "metabase/archive/utils";+import {+ type ArchivableItem,+ isDeletable,+ isRestorable,+ useDeleteItem,+ useRestore,+ useSetArchive,+} from "metabase/archive/hooks";import { trackCollectionItemBookmarked } from "metabase/collections/analytics";import type {CreateBookmark,@@ -25,20 +28,15 @@ import {import { ConfirmModal } from "metabase/common/components/ConfirmModal";import { EntityItem } from "metabase/common/components/EntityItem";import {- type ArchivableItem,canMoveItem,canPinItem,isPinnable,- useSetArchive,useSetPinned,} from "metabase/common/hooks";import { useSetCollectionPreview } from "metabase/common/hooks/use-set-collection-preview";-import { useToast } from "metabase/common/hooks/use-toast";-import { entityForObject } from "metabase/entities/utils";-import { connect, useDispatch } from "metabase/redux";+import { connect } from "metabase/redux";import type { State } from "metabase/redux/store";import { getSetting } from "metabase/selectors/settings";-import * as Urls from "metabase/urls";import type Database from "metabase-lib/v1/metadata/Database";import type { Bookmark, Collection, CollectionItem } from "metabase-types/api";@@ -94,10 +92,10 @@ function ActionMenu({createBookmark,deleteBookmark,}: ActionMenuProps & ActionMenuStateProps) {- const dispatch = useDispatch();const archive = useSetArchive();+ const restore = useRestore();+ const deleteItem = useDeleteItem();const setPinned = useSetPinned();- const [sendToast] = useToast();const setCollectionPreview = useSetCollectionPreview();const [modalOpened, { open: openModal, close: closeModal }] = useDisclosure();const isBookmarked = bookmarks && getIsBookmarked(item, bookmarks);@@ -151,58 +149,18 @@ function ActionMenu({}, [item, setCollectionPreview]);const handleRestore = useCallback(async () => {- if (item.model === "collection") {- const collection = await dispatch(- collectionApi.endpoints.updateCollection.initiate({- id: item.id,- archived: false,- }),- ).unwrap();- dispatch(Api.util.invalidateTags([listTag("bookmark")]));-- const parentCollection = _.last(collection.effective_ancestors ?? []);- const redirect = getParentEntityLink(collection, parentCollection);-- sendToast({- message: t`${item.name} has been restored.`,- actionLabel: t`View`,- action: () => dispatch(push(redirect)),- });+ if (!isRestorable(item)) {return;}+ await restore(item);+ }, [item, restore]);- const Entity = entityForObject(item);- const result = await dispatch(- Entity.actions.update({ id: item.id, archived: false }),- );- dispatch(Api.util.invalidateTags([listTag("bookmark")]));-- const entity = Entity.HACK_getObjectFromAction(result);- const parentCollection = HACK_getParentCollectionFromEntityUpdateAction(- item,- result,- );- const redirect = getParentEntityLink(entity, parentCollection);-- sendToast({- message: t`${item.name} has been restored.`,- actionLabel: t`View`, // could be collection or dashboard- action: () => dispatch(push(redirect)),- });- }, [item, dispatch, sendToast]);-- const handleDeletePermanently = useCallback(() => {- if (item.model === "collection") {- dispatch(- collectionApi.endpoints.deleteCollection.initiate({ id: item.id }),- );- sendToast({ message: t`This item has been permanently deleted.` });+ const handleDeletePermanently = useCallback(async () => {+ if (!isDeletable(item)) {return;}- const Entity = entityForObject(item);- dispatch(Entity.actions.delete(item));- sendToast({ message: t`This item has been permanently deleted.` });- }, [item, dispatch, sendToast]);+ await deleteItem(item);+ }, [item, deleteItem]);return (<>@@ -233,24 +191,5 @@ function ActionMenu({);}-export function getParentEntityLink(- updatedEntity: any,- parentCollection: Pick<Collection, "id" | "name"> | undefined,-) {- // get link for parent collection- const parentCollectionLink = parentCollection- ? Urls.collection(parentCollection)- : `/collection/root`;-- // get link for parent dashboard if we're dealing with a dashboard question- const parentDashboardId =- updatedEntity.type === "question" ? updatedEntity.dashboard_id : undefined;- const parentDashboardLink = parentDashboardId- ? Urls.dashboard({ id: parentDashboardId, name: "" })- : undefined;-- return parentDashboardLink ? parentDashboardLink : parentCollectionLink;-}-// eslint-disable-next-line import/no-default-export -- deprecated usageexport default connect(mapStateToProps)(ActionMenu);diff --git a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.unit.spec.tsx b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.unit.spec.tsxindex cdb64ac1508..a57ec927f70 100644--- a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.unit.spec.tsx+++ b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.unit.spec.tsx@@ -5,8 +5,6 @@ import fetchMock from "fetch-mock";import { setupCardEndpoints } from "__support__/server-mocks";import { createMockEntitiesState } from "__support__/store";import { getIcon, queryIcon, renderWithProviders } from "__support__/ui";-import { Dashboards } from "metabase/entities/dashboards";-import { Questions } from "metabase/entities/questions";import {createMockSettingsState,createMockState,@@ -22,10 +20,10 @@ import {createMockCard,createMockCollection,createMockCollectionItem,- createMockDashboard,+ createMockDocument,} from "metabase-types/api/mocks";-import ActionMenu, { getParentEntityLink } from "./ActionMenu";+import ActionMenu from "./ActionMenu";interface SetupOpts {item: CollectionItem;@@ -207,39 +205,6 @@ describe("ActionMenu", () => {expect(screen.queryByText("Move")).not.toBeInTheDocument();expect(screen.queryByText("Move to trash")).not.toBeInTheDocument();});-- describe("getParentEntityLink", () => {- it("should generate collection link for collection question", () => {- const updatedCollection = createMockCollectionItem({ archived: false });- const link = getParentEntityLink(updatedCollection, undefined);- expect(link).toBe("/collection/root");- });-- it("should generate collection link for dashboards", () => {- const updatedDashboard = Dashboards.wrapEntity(- createMockDashboard({ archived: false }),- );- const parentCollection = createMockCollectionItem({ id: 123 });- const link = getParentEntityLink(updatedDashboard, parentCollection);- expect(link).toBe("/collection/123-question");- });-- it("should generate collection link for normal question", () => {- const updatedQuestion = Questions.wrapEntity(- createMockCard({ archived: false }),- );- const link = getParentEntityLink(updatedQuestion, undefined);- expect(link).toBe("/collection/root");- });-- it("should generate collection link for dashboard question", () => {- const updatedQuestion = Questions.wrapEntity(- createMockCard({ archived: false, dashboard_id: 123 }),- );- const link = getParentEntityLink(updatedQuestion, undefined);- expect(link).toBe("/dashboard/123");- });- });});describe("x-rays", () => {@@ -292,6 +257,67 @@ describe("ActionMenu", () => {});});+ describe("trashed documents", () => {+ it("should restore a document via PUT /api/document/:id with archived: false", async () => {+ const item = createMockCollectionItem({+ id: 7,+ name: "Trashed doc",+ model: "document",+ can_restore: true,+ archived: true,+ });+ fetchMock.put(+ "path:/api/document/7",+ createMockDocument({ id: 7, archived: false, collection_id: null }),+ );++ setup({ item });++ await userEvent.click(getIcon("ellipsis"));+ await userEvent.click(await screen.findByText("Restore"));++ await waitFor(() => {+ const calls = fetchMock.callHistory.calls("path:/api/document/7", {+ method: "PUT",+ });+ expect(calls).toHaveLength(1);+ });++ const [putCall] = fetchMock.callHistory.calls("path:/api/document/7", {+ method: "PUT",+ });+ expect(JSON.parse(putCall.options.body as string)).toMatchObject({+ archived: false,+ });+ });++ it("should permanently delete a document via DELETE /api/document/:id", async () => {+ const item = createMockCollectionItem({+ id: 7,+ name: "Trashed doc",+ model: "document",+ can_delete: true,+ archived: true,+ });+ fetchMock.delete("path:/api/document/7", 204);++ setup({ item });++ await userEvent.click(getIcon("ellipsis"));+ await userEvent.click(await screen.findByText("Delete permanently"));+ await userEvent.click(+ await screen.findByRole("button", { name: "Delete permanently" }),+ );++ await waitFor(() => {+ const calls = fetchMock.callHistory.calls("path:/api/document/7", {+ method: "DELETE",+ });+ expect(calls).toHaveLength(1);+ });+ });+ });+describe("tables", () => {it("should not allow actions on a table", () => {const item = createMockCollectionItem({diff --git a/frontend/src/metabase/collections/components/ArchiveCollectionModal/ArchiveCollectionModal.jsx b/frontend/src/metabase/collections/components/ArchiveCollectionModal/ArchiveCollectionModal.jsxindex a77b113cf74..62577c8780f 100644--- a/frontend/src/metabase/collections/components/ArchiveCollectionModal/ArchiveCollectionModal.jsx+++ b/frontend/src/metabase/collections/components/ArchiveCollectionModal/ArchiveCollectionModal.jsx@@ -3,8 +3,8 @@ import { withRouter } from "react-router";import { t } from "ttag";import { skipToken, useGetCollectionQuery } from "metabase/api";+import { useSetArchive } from "metabase/archive/hooks";import { ArchiveModal } from "metabase/common/components/ArchiveModal";-import { useSetArchive } from "metabase/common/hooks";import * as Urls from "metabase/urls";function ArchiveCollectionModalInner({ collection, onClose }) {diff --git a/frontend/src/metabase/collections/components/CollectionBulkActions/ArchivedBulkActions.tsx b/frontend/src/metabase/collections/components/CollectionBulkActions/ArchivedBulkActions.tsxindex c1099052612..337f7f2ad78 100644--- a/frontend/src/metabase/collections/components/CollectionBulkActions/ArchivedBulkActions.tsx+++ b/frontend/src/metabase/collections/components/CollectionBulkActions/ArchivedBulkActions.tsx@@ -2,18 +2,18 @@ import { useMemo } from "react";import { msgid, ngettext, t } from "ttag";import _ from "underscore";+import {+ canDelete,+ useDeleteItem,+ useSetArchive,+} from "metabase/archive/hooks";import { isRootTrashCollection } from "metabase/collections/utils";import {BulkActionButton,BulkActionDangerButton,} from "metabase/common/components/BulkActionBar";import { ConfirmModal } from "metabase/common/components/ConfirmModal";-import {- canDelete,- canMoveItem,- useDeleteItem,- useSetArchive,-} from "metabase/common/hooks";+import { canMoveItem } from "metabase/common/hooks";import { useDispatch } from "metabase/redux";import { addUndo } from "metabase/redux/undo";import type { Collection, CollectionItem } from "metabase-types/api";diff --git a/frontend/src/metabase/collections/components/CollectionBulkActions/UnarchivedBulkActions.tsx b/frontend/src/metabase/collections/components/CollectionBulkActions/UnarchivedBulkActions.tsxindex e3ecf79212b..b232ca501d9 100644--- a/frontend/src/metabase/collections/components/CollectionBulkActions/UnarchivedBulkActions.tsx+++ b/frontend/src/metabase/collections/components/CollectionBulkActions/UnarchivedBulkActions.tsx@@ -2,9 +2,10 @@ import { useMemo } from "react";import { t } from "ttag";import { archiveAndTrack } from "metabase/archive/analytics";+import { useSetArchive } from "metabase/archive/hooks";import { canArchiveItem } from "metabase/collections/utils";import { BulkActionButton } from "metabase/common/components/BulkActionBar";-import { canMoveItem, useSetArchive } from "metabase/common/hooks";+import { canMoveItem } from "metabase/common/hooks";import { useRegisterShortcut } from "metabase/palette/hooks/useRegisterShortcut";import type { Collection, CollectionItem } from "metabase-types/api";diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsxindex 6eed5389b54..cab9c0a6843 100644--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx@@ -14,6 +14,7 @@ import {} from "metabase/api";import { listTag } from "metabase/api/tags";import { ArchivedEntityBanner } from "metabase/archive/components/ArchivedEntityBanner";+import { useSetArchive } from "metabase/archive/hooks";import { trackCollectionBookmarked } from "metabase/collections/analytics";import { CollectionBulkActions } from "metabase/collections/components/CollectionBulkActions";import {@@ -35,11 +36,7 @@ import {} from "metabase/collections/utils";import { getVisibleColumnsMap } from "metabase/common/components/ItemsTable/utils";import { ItemsDragLayer } from "metabase/common/components/dnd/ItemsDragLayer";-import {- useSetArchive,- useSetCollection,- useToast,-} from "metabase/common/hooks";+import { useSetCollection, useToast } from "metabase/common/hooks";import { useListSelect } from "metabase/common/hooks/use-list-select";import { useDispatch } from "metabase/redux";import { addUndo } from "metabase/redux/undo";diff --git a/frontend/src/metabase/common/hooks/index.ts b/frontend/src/metabase/common/hooks/index.tsindex 727612c3f66..16c32d3f8ec 100644--- a/frontend/src/metabase/common/hooks/index.ts+++ b/frontend/src/metabase/common/hooks/index.ts@@ -16,8 +16,6 @@ export * from "./use-validate-password";export { useStoreUrl } from "./use-store-url/use-store-url";export * from "./use-capture-event";export * from "./use-progressive-loader";-export * from "./use-delete-item";-export * from "./use-set-archive";export * from "./use-set-collection";export * from "./use-set-pinned";export * from "./use-snapshot-selector";diff --git a/frontend/src/metabase/dashboard/components/DashboardSubscriptionsSidebar/DashboardSubscriptionsSidebar.tsx b/frontend/src/metabase/dashboard/components/DashboardSubscriptionsSidebar/DashboardSubscriptionsSidebar.tsxindex 36512161556..9c209358326 100644--- a/frontend/src/metabase/dashboard/components/DashboardSubscriptionsSidebar/DashboardSubscriptionsSidebar.tsx+++ b/frontend/src/metabase/dashboard/components/DashboardSubscriptionsSidebar/DashboardSubscriptionsSidebar.tsx@@ -2,10 +2,10 @@ import { useCallback, useEffect, useMemo, useRef, useState } from "react";import _ from "underscore";import { skipToken, useListSubscriptionsQuery } from "metabase/api";+import { useSetArchive } from "metabase/archive/hooks";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";import type { ScheduleChangeProp } from "metabase/common/components/SchedulePicker";import { Sidebar } from "metabase/common/components/Sidebar";-import { useSetArchive } from "metabase/common/hooks";import { isEmbeddingSdk } from "metabase/embedding-sdk/config";import {cancelEditingPulse,diff --git a/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx b/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsxindex 9582b4d24a5..b7775304283 100644--- a/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx+++ b/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx@@ -4,7 +4,8 @@ import { t } from "ttag";import { Api, useDeleteDocumentMutation } from "metabase/api";import { listTag } from "metabase/api/tags";import { ArchivedEntityBanner } from "metabase/archive/components/ArchivedEntityBanner/ArchivedEntityBanner";-import { useSetArchive, useSetCollection } from "metabase/common/hooks";+import { useSetArchive } from "metabase/archive/hooks";+import { useSetCollection } from "metabase/common/hooks";import { useDispatch, useSelector } from "metabase/redux";import { addUndo } from "metabase/redux/undo";diff --git a/frontend/src/metabase/embedding/components/ArchiveButton.tsx b/frontend/src/metabase/embedding/components/ArchiveButton.tsxindex 49325d710d4..6d7f5dfa8bc 100644--- a/frontend/src/metabase/embedding/components/ArchiveButton.tsx+++ b/frontend/src/metabase/embedding/components/ArchiveButton.tsx@@ -2,8 +2,8 @@ import { useDisclosure } from "@mantine/hooks";import { c, t } from "ttag";import { useGetCollectionQuery } from "metabase/api";+import { type ArchivableItem, useSetArchive } from "metabase/archive/hooks";import { canArchiveItem } from "metabase/collections/utils";-import { type ArchivableItem, useSetArchive } from "metabase/common/hooks";import { ActionIcon, Icon, Menu } from "metabase/ui";import type { CollectionItem } from "metabase-types/api";diff --git a/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionDetails.tsx b/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionDetails.tsxindex e590efe0a81..8fac2b805a0 100644--- a/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionDetails.tsx+++ b/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionDetails.tsx@@ -3,9 +3,9 @@ import { t } from "ttag";import _ from "underscore";import { useDeleteActionMutation, useListActionsQuery } from "metabase/api";+import { useSetArchive } from "metabase/archive/hooks";import { Button } from "metabase/common/components/Button";import { Link } from "metabase/common/components/Link";-import { useSetArchive } from "metabase/common/hooks";import { useConfirmation } from "metabase/common/hooks/use-confirmation";import { Databases } from "metabase/entities/databases";import * as Urls from "metabase/urls";diff --git a/frontend/src/metabase/timelines/collections/containers/EditEventModal/EditEventModal.tsx b/frontend/src/metabase/timelines/collections/containers/EditEventModal/EditEventModal.tsxindex 900717c3c0a..6f83bdbd399 100644--- a/frontend/src/metabase/timelines/collections/containers/EditEventModal/EditEventModal.tsx+++ b/frontend/src/metabase/timelines/collections/containers/EditEventModal/EditEventModal.tsx@@ -6,7 +6,7 @@ import {useGetTimelineQuery,useUpdateTimelineEventMutation,} from "metabase/api";-import { useSetArchive } from "metabase/common/hooks";+import { useSetArchive } from "metabase/archive/hooks";import type { ModalComponentProps } from "metabase/hoc/ModalRoute";import { useDispatch } from "metabase/redux";import EditEventModal from "metabase/timelines/common/components/EditEventModal";diff --git a/frontend/src/metabase/timelines/collections/containers/EditTimelineModal/EditTimelineModal.tsx b/frontend/src/metabase/timelines/collections/containers/EditTimelineModal/EditTimelineModal.tsxindex 092d56254dd..91ab649ef80 100644--- a/frontend/src/metabase/timelines/collections/containers/EditTimelineModal/EditTimelineModal.tsx+++ b/frontend/src/metabase/timelines/collections/containers/EditTimelineModal/EditTimelineModal.tsx@@ -5,7 +5,7 @@ import {useGetTimelineQuery,useUpdateTimelineMutation,} from "metabase/api";-import { useSetArchive } from "metabase/common/hooks";+import { useSetArchive } from "metabase/archive/hooks";import type { ModalComponentProps } from "metabase/hoc/ModalRoute";import { useDispatch } from "metabase/redux";import EditTimelineModal from "metabase/timelines/common/components/EditTimelineModal";diff --git a/frontend/src/metabase/timelines/collections/containers/TimelineArchiveModal/TimelineArchiveModal.tsx b/frontend/src/metabase/timelines/collections/containers/TimelineArchiveModal/TimelineArchiveModal.tsxindex 0b6cad1215c..9e1034ad8f5 100644--- a/frontend/src/metabase/timelines/collections/containers/TimelineArchiveModal/TimelineArchiveModal.tsx+++ b/frontend/src/metabase/timelines/collections/containers/TimelineArchiveModal/TimelineArchiveModal.tsx@@ -1,7 +1,7 @@import { push } from "react-router-redux";import { skipToken, useGetTimelineQuery } from "metabase/api";-import { useSetArchive } from "metabase/common/hooks";+import { useSetArchive } from "metabase/archive/hooks";import type { ModalComponentProps } from "metabase/hoc/ModalRoute";import { useDispatch } from "metabase/redux";import * as Urls from "metabase/urls";diff --git a/frontend/src/metabase/timelines/collections/containers/TimelineDetailsModal/TimelineDetailsModal.tsx b/frontend/src/metabase/timelines/collections/containers/TimelineDetailsModal/TimelineDetailsModal.tsxindex 30ceec7510c..8e2ea01d1bd 100644--- a/frontend/src/metabase/timelines/collections/containers/TimelineDetailsModal/TimelineDetailsModal.tsx+++ b/frontend/src/metabase/timelines/collections/containers/TimelineDetailsModal/TimelineDetailsModal.tsx@@ -5,7 +5,7 @@ import {useGetTimelineQuery,useListCollectionTimelinesQuery,} from "metabase/api";-import { useSetArchive } from "metabase/common/hooks";+import { useSetArchive } from "metabase/archive/hooks";import { useDispatch } from "metabase/redux";import * as Urls from "metabase/urls";import type { Timeline, TimelineEvent } from "metabase-types/api";diff --git a/frontend/src/metabase/timelines/collections/containers/TimelineListArchiveModal/TimelineListArchiveModal.tsx b/frontend/src/metabase/timelines/collections/containers/TimelineListArchiveModal/TimelineListArchiveModal.tsxindex 8a631574b00..822d70c2ec1 100644--- a/frontend/src/metabase/timelines/collections/containers/TimelineListArchiveModal/TimelineListArchiveModal.tsx+++ b/frontend/src/metabase/timelines/collections/containers/TimelineListArchiveModal/TimelineListArchiveModal.tsx@@ -5,7 +5,7 @@ import {useGetCollectionQuery,useListCollectionTimelinesQuery,} from "metabase/api";-import { useSetArchive } from "metabase/common/hooks";+import { useSetArchive } from "metabase/archive/hooks";import { useDispatch } from "metabase/redux";import * as Urls from "metabase/urls";import type { Collection, Timeline } from "metabase-types/api";diff --git a/frontend/src/metabase/timelines/questions/containers/EditEventModal/EditEventModal.tsx b/frontend/src/metabase/timelines/questions/containers/EditEventModal/EditEventModal.tsxindex e4b1c968274..4c8be2436a6 100644--- a/frontend/src/metabase/timelines/questions/containers/EditEventModal/EditEventModal.tsx+++ b/frontend/src/metabase/timelines/questions/containers/EditEventModal/EditEventModal.tsx@@ -4,7 +4,7 @@ import {useGetTimelineEventQuery,useUpdateTimelineEventMutation,} from "metabase/api";-import { useSetArchive } from "metabase/common/hooks";+import { useSetArchive } from "metabase/archive/hooks";import { useDispatch } from "metabase/redux";import { addUndo } from "metabase/redux/undo";import EditEventModal from "metabase/timelines/common/components/EditEventModal";diff --git a/frontend/src/metabase/timelines/questions/containers/TimelinePanel/TimelinePanel.tsx b/frontend/src/metabase/timelines/questions/containers/TimelinePanel/TimelinePanel.tsxindex cddc6895d98..e3b06eafc6c 100644--- a/frontend/src/metabase/timelines/questions/containers/TimelinePanel/TimelinePanel.tsx+++ b/frontend/src/metabase/timelines/questions/containers/TimelinePanel/TimelinePanel.tsx@@ -1,8 +1,8 @@import type { ComponentProps } from "react";import { useGetCollectionQuery } from "metabase/api";+import { useSetArchive } from "metabase/archive/hooks";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";-import { useSetArchive } from "metabase/common/hooks";import { ROOT_COLLECTION } from "metabase/entities/collections";import type { CollectionId, TimelineEvent } from "metabase-types/api";