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
Move `setCollection` from entity object action to RTK-based hook (#73525)
Romeo Van Snick88c51b6946bb
diff --git a/frontend/src/metabase-types/api/collection.ts b/frontend/src/metabase-types/api/collection.tsindex caf5f414c4e..9d39222f640 100644--- a/frontend/src/metabase-types/api/collection.ts+++ b/frontend/src/metabase-types/api/collection.ts@@ -1,7 +1,6 @@import type {BaseEntityId,CollectionEssentials,- Dashboard,DashboardId,PaginationRequest,PaginationResponse,@@ -139,9 +138,6 @@ export interface CollectionItem {effective_location?: string;authority_level?: CollectionAuthorityLevel;dashboard_count?: number | null;- setCollection?: (- collection: Pick<Collection, "id"> | Pick<Dashboard, "id">,- ) => void;is_shared_tenant_collection?: boolean;is_tenant_dashboard?: boolean;is_remote_synced?: boolean;diff --git a/frontend/src/metabase-types/entities/common.ts b/frontend/src/metabase-types/entities/common.tsdeleted file mode 100644index 1439e0d5d7a..00000000000--- a/frontend/src/metabase-types/entities/common.ts+++ /dev/null@@ -1,5 +0,0 @@-import type { Collection } from "metabase-types/api";--export type WrappedEntity<Entity> = {- setCollection: (collection: Collection) => void;-} & Entity;diff --git a/frontend/src/metabase-types/entities/index.ts b/frontend/src/metabase-types/entities/index.tsdeleted file mode 100644index 6b571608924..00000000000--- a/frontend/src/metabase-types/entities/index.ts+++ /dev/null@@ -1 +0,0 @@-export * from "./common";diff --git a/frontend/src/metabase/api/dashboard.ts b/frontend/src/metabase/api/dashboard.tsindex 61a3f797deb..9ca1ee90142 100644--- a/frontend/src/metabase/api/dashboard.ts+++ b/frontend/src/metabase/api/dashboard.ts@@ -280,6 +280,7 @@ export const {deleteDashboardPublicLink,createDashboard,createDashboardPublicLink,+ updateDashboard,updateDashboardEnableEmbedding,updateDashboardEmbeddingParams,},diff --git a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsxindex ab0a7db7877..89baead202a 100644--- a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx+++ b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx@@ -15,7 +15,6 @@ import {canArchiveItem,canBookmarkItem,canCopyItem,- canMoveItem,canPreviewItem,isItemPinned,isPreviewEnabled,@@ -24,6 +23,7 @@ import { ConfirmModal } from "metabase/common/components/ConfirmModal";import { EntityItem } from "metabase/common/components/EntityItem";import {type ArchivableItem,+ canMoveItem,canPinItem,isPinnable,useSetArchive,diff --git a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.unit.spec.tsx b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.unit.spec.tsxindex faa72d1b628..c59c1754e31 100644--- a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.unit.spec.tsx+++ b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.unit.spec.tsx@@ -159,7 +159,6 @@ describe("ActionMenu", () => {name: "Collection",model: "collection",can_write: true,- setCollection: jest.fn(),});fetchMock.put("path:/api/collection/1", { ...item, archived: true });@@ -187,7 +186,6 @@ describe("ActionMenu", () => {model: "collection",can_write: true,personal_owner_id: 1,- setCollection: jest.fn(),copy: true,});@@ -203,7 +201,6 @@ describe("ActionMenu", () => {name: "My Read Only collection",model: "collection",can_write: false,- setCollection: jest.fn(),copy: true,});diff --git a/frontend/src/metabase/collections/components/CollectionBulkActions/ArchivedBulkActions.tsx b/frontend/src/metabase/collections/components/CollectionBulkActions/ArchivedBulkActions.tsxindex c9ab8ff1ecc..f598d7356e0 100644--- a/frontend/src/metabase/collections/components/CollectionBulkActions/ArchivedBulkActions.tsx+++ b/frontend/src/metabase/collections/components/CollectionBulkActions/ArchivedBulkActions.tsx@@ -2,13 +2,13 @@ import { useMemo } from "react";import { msgid, ngettext, t } from "ttag";import _ from "underscore";-import { canMoveItem, isRootTrashCollection } from "metabase/collections/utils";+import { isRootTrashCollection } from "metabase/collections/utils";import {BulkActionButton,BulkActionDangerButton,} from "metabase/common/components/BulkActionBar";import { ConfirmModal } from "metabase/common/components/ConfirmModal";-import { useSetArchive } from "metabase/common/hooks";+import { canMoveItem, useSetArchive } 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/CollectionBulkActions.tsx b/frontend/src/metabase/collections/components/CollectionBulkActions/CollectionBulkActions.tsxindex 289e2569da9..4a6b5522abc 100644--- a/frontend/src/metabase/collections/components/CollectionBulkActions/CollectionBulkActions.tsx+++ b/frontend/src/metabase/collections/components/CollectionBulkActions/CollectionBulkActions.tsx@@ -7,6 +7,11 @@ import { isTrashedCollection } from "metabase/collections/utils";import { BulkActionBar } from "metabase/common/components/BulkActionBar";import type { OmniPickerItem } from "metabase/common/components/Pickers";import { BulkMoveModal } from "metabase/common/components/Pickers/MoveModal/MoveModal";+import {+ type MovableItem,+ isMovable,+ useSetCollection,+} from "metabase/common/hooks";import type { Collection, CollectionItem } from "metabase-types/api";import { ArchivedBulkActions } from "./ArchivedBulkActions";@@ -38,6 +43,7 @@ export const CollectionBulkActions = memo(}: CollectionBulkActionsProps) => {const [rememberedDestination, setRememberedDestination] =useState<Destination | null>(null);+ const setCollection = useSetCollection();const isVisible = selected.length > 0 && selectedAction !== "confirm-move";@@ -73,7 +79,9 @@ export const CollectionBulkActions = memo(if (selectedItems) {await tryOrClear(Promise.all(- selectedItems.map((item) => item.setCollection?.(destination)),+ selectedItems+ .filter(isMovable)+ .map((item) => setCollection(item as MovableItem, destination)),),);}diff --git a/frontend/src/metabase/collections/components/CollectionBulkActions/UnarchivedBulkActions.tsx b/frontend/src/metabase/collections/components/CollectionBulkActions/UnarchivedBulkActions.tsxindex d4c81f8c0d0..e3ecf79212b 100644--- a/frontend/src/metabase/collections/components/CollectionBulkActions/UnarchivedBulkActions.tsx+++ b/frontend/src/metabase/collections/components/CollectionBulkActions/UnarchivedBulkActions.tsx@@ -2,9 +2,9 @@ import { useMemo } from "react";import { t } from "ttag";import { archiveAndTrack } from "metabase/archive/analytics";-import { canArchiveItem, canMoveItem } from "metabase/collections/utils";+import { canArchiveItem } from "metabase/collections/utils";import { BulkActionButton } from "metabase/common/components/BulkActionBar";-import { useSetArchive } from "metabase/common/hooks";+import { canMoveItem, useSetArchive } 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 ad45d5df4a8..fcd1be7497f 100644--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx@@ -30,7 +30,11 @@ import {} from "metabase/collections/utils";import { getVisibleColumnsMap } from "metabase/common/components/ItemsTable/utils";import { ItemsDragLayer } from "metabase/common/components/dnd/ItemsDragLayer";-import { useSetArchive, useToast } from "metabase/common/hooks";+import {+ useSetArchive,+ useSetCollection,+ useToast,+} from "metabase/common/hooks";import { useListSelect } from "metabase/common/hooks/use-list-select";import { Bookmarks } from "metabase/entities/bookmarks";import { Collections } from "metabase/entities/collections";@@ -147,6 +151,7 @@ export const CollectionContentView = ({}, [bookmarks, collectionId]);const archive = useSetArchive();+ const setCollection = useSetCollection();const [sendToast] = useToast();const visibleColumnsMap = useMemo(@@ -269,7 +274,7 @@ export const CollectionContentView = ({await dispatch(Bookmarks.actions.invalidateLists());}}onMove={({ id }) =>- dispatch(Collections.actions.setCollection(actionId, { id }))+ setCollection({ model: "collection", id: collectionId }, { id })}onDeletePermanently={() =>dispatch(deletePermanently(Collections.actions.delete(actionId)))diff --git a/frontend/src/metabase/collections/components/MoveCollectionModal/MoveCollectionModal.tsx b/frontend/src/metabase/collections/components/MoveCollectionModal/MoveCollectionModal.tsxindex 053282f8297..fa66079cad7 100644--- a/frontend/src/metabase/collections/components/MoveCollectionModal/MoveCollectionModal.tsx+++ b/frontend/src/metabase/collections/components/MoveCollectionModal/MoveCollectionModal.tsx@@ -8,8 +8,7 @@ import type {} from "metabase/collections/types";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";import { MoveModal } from "metabase/common/components/Pickers/MoveModal/MoveModal";-import { Collections } from "metabase/entities/collections";-import { useDispatch } from "metabase/redux";+import { useSetCollection } from "metabase/common/hooks";import * as Urls from "metabase/urls";import type { Collection, CollectionId } from "metabase-types/api";@@ -60,7 +59,7 @@ export const MoveCollectionModal = ({params?: { slug: string };onClose: () => void;}) => {- const dispatch = useDispatch();+ const setCollection = useSetCollection();const collectionIdfromUrl = Urls.extractCollectionId(params?.slug);const resolvedCollectionId = collectionId ?? collectionIdfromUrl;@@ -80,7 +79,10 @@ export const MoveCollectionModal = ({<MoveCollectionModalViewcollection={collection}onMove={async (source, destination) => {- await dispatch(Collections.actions.setCollection(source, destination));+ await setCollection(+ { model: "collection", id: source.id },+ destination,+ );}}onClose={onClose}/>diff --git a/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.stories.tsx b/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.stories.tsxindex 3bd9ffea97d..254b3726739 100644--- a/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.stories.tsx+++ b/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.stories.tsx@@ -39,7 +39,6 @@ export const Question = {name: "Question",description: "This is a description of the question",copy: true,- setCollection: action("setCollection"),archived: false,},onCopy,diff --git a/frontend/src/metabase/collections/utils.ts b/frontend/src/metabase/collections/utils.tsindex 98a53d6062a..469a8ca7723 100644--- a/frontend/src/metabase/collections/utils.ts+++ b/frontend/src/metabase/collections/utils.ts@@ -252,16 +252,6 @@ export function canPreviewItem(item: CollectionItem, collection?: Collection) {);}-export function canMoveItem(item: CollectionItem, collection?: Collection) {- return (- (collection?.can_write || isRootTrashCollection(collection)) &&- !isReadOnlyCollection(item) &&- item.setCollection != null &&- !(isItemCollection(item) && isRootPersonalCollection(item)) &&- !isLibraryCollection(item as Pick<Collection, "type">)- );-}-export function canArchiveItem(item: CollectionItem, collection?: Collection) {return (collection?.can_write &&diff --git a/frontend/src/metabase/common/components/dnd/ItemDragSource.tsx b/frontend/src/metabase/common/components/dnd/ItemDragSource.tsxindex 66b22c0e362..d8be4ecebdb 100644--- a/frontend/src/metabase/common/components/dnd/ItemDragSource.tsx+++ b/frontend/src/metabase/common/components/dnd/ItemDragSource.tsx@@ -11,8 +11,11 @@ import { getEmptyImage } from "react-dnd-html5-backend";import { getErrorMessage } from "metabase/api/utils";import { isRootTrashCollection } from "metabase/collections/utils";import {+ type MovableItem,type PinnableItem,+ isMovable,isPinnable,+ useSetCollection,useSetPinned,useToast,} from "metabase/common/hooks";@@ -59,6 +62,10 @@ interface DragSourceOwnProps {onDrop?: () => void;onMoveError?: (error: unknown) => void;setPinned: (item: PinnableItem, pinned: boolean | number) => void;+ setCollection: (+ item: MovableItem,+ destination: { id: Collection["id"] },+ ) => Promise<unknown>;children?: ReactNode | ((props: Record<string, unknown>) => ReactNode);}@@ -83,7 +90,13 @@ const DragSourceComponent = DragSource(return { item: props.item };},async endDrag(- { selected, onDrop, onMoveError, setPinned }: DragSourceOwnProps,+ {+ selected,+ onDrop,+ onMoveError,+ setPinned,+ setCollection,+ }: DragSourceOwnProps,monitor: DragSourceMonitor,) {if (!monitor.didDrop()) {@@ -99,7 +112,9 @@ const DragSourceComponent = DragSource(try {if (collection !== undefined) {await Promise.all(- items.map((i) => i.setCollection && i.setCollection(collection)),+ items+ .filter(isMovable)+ .map((i) => setCollection(i as MovableItem, collection)),);} else if (pinIndex !== undefined) {await Promise.all(@@ -134,6 +149,7 @@ interface ItemDragSourceProps {export function ItemDragSource(props: ItemDragSourceProps) {const [sendToast] = useToast();const setPinned = useSetPinned();+ const setCollection = useSetCollection();const onMoveError = (error: unknown) =>sendToast({message: getErrorMessage(error),@@ -145,6 +161,7 @@ export function ItemDragSource(props: ItemDragSourceProps) {{...props}onMoveError={onMoveError}setPinned={setPinned}+ setCollection={setCollection}/>);}diff --git a/frontend/src/metabase/common/hooks/index.ts b/frontend/src/metabase/common/hooks/index.tsindex 46a87b74fd9..05c68091e8d 100644--- a/frontend/src/metabase/common/hooks/index.ts+++ b/frontend/src/metabase/common/hooks/index.ts@@ -16,6 +16,7 @@ export { useStoreUrl } from "./use-store-url/use-store-url";export * from "./use-capture-event";export * from "./use-progressive-loader";export * from "./use-set-archive";+export * from "./use-set-collection";export * from "./use-set-pinned";export * from "./use-snapshot-selector";export * from "./use-subscriber";diff --git a/frontend/src/metabase/common/hooks/use-set-collection.ts b/frontend/src/metabase/common/hooks/use-set-collection.tsnew file mode 100644index 00000000000..f3e80d90135--- /dev/null+++ b/frontend/src/metabase/common/hooks/use-set-collection.ts@@ -0,0 +1,314 @@+import type { ReactNode } from "react";+import { useCallback } from "react";+import { match } from "ts-pattern";+import { t } from "ttag";++import {+ cardApi,+ collectionApi,+ dashboardApi,+ documentApi,+ timelineApi,+ useUpdateCardMutation,+ useUpdateCollectionMutation,+ useUpdateDashboardMutation,+ useUpdateDocumentMutation,+ useUpdateTimelineMutation,+} from "metabase/api";+import {+ canonicalCollectionId,+ isItemCollection,+ isLibraryCollection,+ isReadOnlyCollection,+ isRootPersonalCollection,+ isRootTrashCollection,+} from "metabase/collections/utils";+import { useDispatch } from "metabase/redux";+import { addUndo } from "metabase/redux/undo";+import type {+ Card,+ Collection,+ CollectionItem,+ Dashboard,+ DashboardId,+ Document,+ Timeline,+} from "metabase-types/api";++type Movable<+ M extends string,+ T extends { id: unknown },+ K extends keyof T = never,+> = {+ model: M;+ id: T["id"];+} & Pick<T, K>;++export type MovableItem =+ | Movable<"card", Card>+ | Movable<"dataset", Card>+ | Movable<"metric", Card>+ | Movable<"dashboard", Dashboard>+ | Movable<"collection", Collection>+ | Movable<"snippet-collection", Collection>+ | Movable<"document", Document>+ | Movable<"timeline", Timeline, "name">;++export type MovableModel = MovableItem["model"];++const MOVABLE_MODELS = new Set<MovableModel>([+ "card",+ "dataset",+ "metric",+ "dashboard",+ "collection",+ "snippet-collection",+ "document",+ "timeline",+]);++export function isMovable<T extends { model: string }>(+ item: T,+): item is T & { model: MovableModel } {+ return MOVABLE_MODELS.has(item.model as MovableModel);+}++export type SetCollectionDestination =+ | (Pick<Collection, "id"> &+ Partial<Pick<Collection, "type">> & { model?: "collection" })+ | (Pick<Dashboard, "id"> & { model: "dashboard" });++const LABELS = {+ card: () => t`question`,+ dataset: () => t`model`,+ metric: () => t`metric`,+ dashboard: () => t`dashboard`,+ collection: () => t`collection`,+ "snippet-collection": () => t`folder`,+ document: () => t`document`,+ timeline: () => t`timeline`,+} as const satisfies Record<MovableModel, () => string>;++export type SetCollectionOptions = {+ notify?: boolean;+ message?: ReactNode;+};++function isCollectionDestination(+ destination: SetCollectionDestination,+): destination is Pick<Collection, "id"> &+ Partial<Pick<Collection, "type">> & { model?: "collection" } {+ return destination.model !== "dashboard";+}++export function useSetCollection() {+ const dispatch = useDispatch();+ const [updateCard] = useUpdateCardMutation();+ const [updateDashboard] = useUpdateDashboardMutation();+ const [updateCollection] = useUpdateCollectionMutation();+ const [updateDocument] = useUpdateDocumentMutation();+ const [updateTimeline] = useUpdateTimelineMutation();++ const setCollection = useCallback(+ (item: MovableItem, destination: SetCollectionDestination) => {+ const archived =+ isCollectionDestination(destination) &&+ isRootTrashCollection(destination);++ return match(item)+ .with(+ { model: "card" },+ { model: "dataset" },+ { model: "metric" },+ ({ id }) => {+ const update = isCollectionDestination(destination)+ ? {+ collection_id: canonicalCollectionId(destination.id),+ dashboard_id: null,+ archived,+ }+ : {+ dashboard_id: destination.id as DashboardId,+ archived: false,+ delete_old_dashcards: true,+ };+ return updateCard({ id, ...update }).unwrap();+ },+ )+ .with({ model: "dashboard" }, ({ id }) => {+ if (!isCollectionDestination(destination)) {+ throw new Error("Cannot move a dashboard into a dashboard");+ }+ return updateDashboard({+ id,+ collection_id: canonicalCollectionId(destination.id),+ archived,+ }).unwrap();+ })+ .with({ model: "document" }, ({ id }) => {+ if (!isCollectionDestination(destination)) {+ throw new Error("Cannot move a document into a dashboard");+ }+ return updateDocument({+ id,+ collection_id: canonicalCollectionId(destination.id),+ archived,+ }).unwrap();+ })+ .with({ model: "collection" }, ({ id }) => {+ if (!isCollectionDestination(destination)) {+ throw new Error("Cannot move a collection into a dashboard");+ }+ return updateCollection({+ id,+ parent_id: canonicalCollectionId(destination.id),+ archived,+ }).unwrap();+ })+ .with({ model: "snippet-collection" }, ({ id }) => {+ if (!isCollectionDestination(destination)) {+ throw new Error("Cannot move a snippet folder into a dashboard");+ }+ return updateCollection({+ id,+ parent_id: canonicalCollectionId(destination.id),+ }).unwrap();+ })+ .with({ model: "timeline" }, ({ id, name }) => {+ if (!isCollectionDestination(destination)) {+ throw new Error("Cannot move a timeline into a dashboard");+ }+ return updateTimeline({+ id,+ name,+ collection_id: canonicalCollectionId(destination.id),+ default: false,+ }).unwrap();+ })+ .exhaustive();+ },+ [+ updateCard,+ updateDashboard,+ updateCollection,+ updateDocument,+ updateTimeline,+ ],+ );++ const captureUndoAction = useCallback(+ (item: MovableItem): Promise<() => Promise<unknown>> =>+ match(item)+ .with(+ { model: "card" },+ { model: "dataset" },+ { model: "metric" },+ async ({ id }) => {+ const card = await dispatch(+ cardApi.endpoints.getCard.initiate({ id }),+ ).unwrap();+ return () =>+ updateCard({+ id,+ collection_id: card.collection_id,+ dashboard_id: card.dashboard_id,+ archived: card.archived,+ });+ },+ )+ .with({ model: "dashboard" }, async ({ id }) => {+ const dashboard = await dispatch(+ dashboardApi.endpoints.getDashboard.initiate({ id }),+ ).unwrap();+ return () =>+ updateDashboard({+ id,+ collection_id: dashboard.collection_id,+ archived: dashboard.archived,+ });+ })+ .with({ model: "document" }, async ({ id }) => {+ const document = await dispatch(+ documentApi.endpoints.getDocument.initiate({ id }),+ ).unwrap();+ return () =>+ updateDocument({+ id,+ collection_id: document.collection_id,+ archived: document.archived,+ });+ })+ .with(+ { model: "collection" },+ { model: "snippet-collection" },+ async ({ id }) => {+ const collection = await dispatch(+ collectionApi.endpoints.getCollection.initiate({ id }),+ ).unwrap();+ return () =>+ updateCollection({+ id,+ parent_id: collection.parent_id ?? null,+ archived: collection.archived ?? false,+ });+ },+ )+ .with({ model: "timeline" }, async ({ id }) => {+ const timeline = await dispatch(+ timelineApi.endpoints.getTimeline.initiate({ id }),+ ).unwrap();+ return () =>+ updateTimeline({+ id,+ name: timeline.name,+ collection_id: timeline.collection_id,+ default: timeline.default,+ });+ })+ .exhaustive(),+ [+ dispatch,+ updateCard,+ updateDashboard,+ updateCollection,+ updateDocument,+ updateTimeline,+ ],+ );++ return useCallback(+ async (+ item: MovableItem,+ destination: SetCollectionDestination,+ { notify = true, message }: SetCollectionOptions = {},+ ) => {+ const undoAction = notify ? await captureUndoAction(item) : null;++ const result = await setCollection(item, destination);++ if (undoAction) {+ dispatch(+ addUndo({+ subject: LABELS[item.model](),+ verb: t`moved`,+ message,+ actions: [undoAction],+ }),+ );+ }++ return result;+ },+ [dispatch, setCollection, captureUndoAction],+ );+}++export function canMoveItem(item: CollectionItem, collection?: Collection) {+ return (+ (collection?.can_write || isRootTrashCollection(collection)) &&+ !isReadOnlyCollection(item) &&+ isMovable(item) &&+ !(isItemCollection(item) && isRootPersonalCollection(item)) &&+ !isLibraryCollection(item as Pick<Collection, "type">)+ );+}diff --git a/frontend/src/metabase/dashboard/components/DashboardMoveModal.tsx b/frontend/src/metabase/dashboard/components/DashboardMoveModal.tsxindex debfd6aa2fb..f30b518e890 100644--- a/frontend/src/metabase/dashboard/components/DashboardMoveModal.tsx+++ b/frontend/src/metabase/dashboard/components/DashboardMoveModal.tsx@@ -1,37 +1,28 @@import { c, t } from "ttag";-import _ from "underscore";import { useGetCollectionQuery } from "metabase/api";import { Link } from "metabase/common/components/Link";import { MoveModal } from "metabase/common/components/Pickers/MoveModal/MoveModal";+import { useSetCollection } from "metabase/common/hooks";import { ROOT_COLLECTION } from "metabase/entities/collections";import { Dashboards } from "metabase/entities/dashboards";-import { connect } from "metabase/redux";import type { State } from "metabase/redux/store";import { Flex, Icon } from "metabase/ui";import { color } from "metabase/ui/utils/colors";import * as Urls from "metabase/urls";-import type { CollectionId, Dashboard, DashboardId } from "metabase-types/api";+import type { CollectionId, Dashboard } from "metabase-types/api";import S from "./DashboardMoveModal.module.css";-const mapDispatchToProps = {- setDashboardCollection: Dashboards.actions.setCollection,-};-function DashboardMoveModal({dashboard,onClose,- setDashboardCollection,}: {dashboard: Dashboard;onClose: () => void;- setDashboardCollection: (- source: { id: DashboardId },- destination: { id: CollectionId },- options: any,- ) => void;}) {+ const setCollection = useSetCollection();+return (<MoveModaltitle={t`Move dashboard to…`}@@ -47,15 +38,17 @@ function DashboardMoveModal({model: "dashboard",}}onMove={async (destination) => {- await setDashboardCollection({ id: dashboard.id }, destination, {- notify: {+ await setCollection(+ { model: "dashboard", id: dashboard.id },+ destination,+ {message: (<DashboardMoveToastcollectionId={destination.id || ROOT_COLLECTION.id}/>),},- });+ );onClose();}}/>@@ -94,10 +87,7 @@ const DashboardMoveToast = ({);};-export const DashboardMoveModalConnected = _.compose(- connect(null, mapDispatchToProps),- Dashboards.load({- id: (_state: State, props: { params: { slug: string } }) =>- Urls.extractCollectionId(props.params.slug),- }),-)(DashboardMoveModal);+export const DashboardMoveModalConnected = Dashboards.load({+ id: (_state: State, props: { params: { slug: string } }) =>+ Urls.extractCollectionId(props.params.slug),+})(DashboardMoveModal);diff --git a/frontend/src/metabase/dashboard/components/QuestionPicker/QuestionList.tsx b/frontend/src/metabase/dashboard/components/QuestionPicker/QuestionList.tsxindex acc83063bf6..e0b5c882e57 100644--- a/frontend/src/metabase/dashboard/components/QuestionPicker/QuestionList.tsx+++ b/frontend/src/metabase/dashboard/components/QuestionPicker/QuestionList.tsx@@ -29,7 +29,6 @@ import type {CollectionItem,SearchResult,} from "metabase-types/api";-import type { WrappedEntity } from "metabase-types/entities";import S from "./QuestionList.module.css";import { trackVisualizeAnotherWayClicked } from "./analytics";@@ -115,7 +114,7 @@ export function QuestionList({const error = isSearching ? searchError : itemsError;const isFetching = isSearching ? searchIsFetching : itemsIsFetching;const dispatch = useDispatch();- const list: WrappedEntity<SearchResult | CollectionItem>[] = useMemo(() => {+ const list: (SearchResult | CollectionItem)[] = useMemo(() => {return data?.data?.map((item) => Search.wrapEntity(item, dispatch)) ?? [];}, [data, dispatch]);diff --git a/frontend/src/metabase/dashboard/reducers-typed.ts b/frontend/src/metabase/dashboard/reducers-typed.tsindex 89126c7c76a..7578b382e7e 100644--- a/frontend/src/metabase/dashboard/reducers-typed.ts+++ b/frontend/src/metabase/dashboard/reducers-typed.ts@@ -5,6 +5,7 @@ import { omit } from "underscore";import {createDashboardPublicLink,deleteDashboardPublicLink,+ updateDashboard,updateDashboardEmbeddingParams,updateDashboardEnableEmbedding,} from "metabase/api";@@ -325,6 +326,13 @@ export const dashboards = createReducer(draftDashboard.collection = payload.dashboard.collection;}})+ .addMatcher(updateDashboard.matchFulfilled, (state, { payload }) => {+ const draftDashboard = state[payload.id];+ if (draftDashboard) {+ draftDashboard.collection_id = payload.collection_id;+ draftDashboard.collection = payload.collection;+ }+ }).addMatcher(createDashboardPublicLink.matchFulfilled,(state, { payload }) =>diff --git a/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx b/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsxindex 7ac7a98d0f4..ca8a80fa69e 100644--- a/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx+++ b/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx@@ -2,7 +2,7 @@ import { t } from "ttag";import { deletePermanently } from "metabase/archive/actions";import { ArchivedEntityBanner } from "metabase/archive/components/ArchivedEntityBanner/ArchivedEntityBanner";-import { useSetArchive } from "metabase/common/hooks";+import { useSetArchive, useSetCollection } from "metabase/common/hooks";import { Bookmarks } from "metabase/entities/bookmarks";import { Documents } from "metabase/entities/documents";import { useDispatch, useSelector } from "metabase/redux";@@ -12,6 +12,7 @@ import { getCurrentDocument } from "../selectors";export const DocumentArchivedEntityBanner = () => {const dispatch = useDispatch();const archive = useSetArchive();+ const setCollection = useSetCollection();const document = useSelector(getCurrentDocument);if (!document) {@@ -30,7 +31,7 @@ export const DocumentArchivedEntityBanner = () => {await dispatch(Bookmarks.actions.invalidateLists());}}onMove={({ id }) =>- dispatch(Documents.actions.setCollection(document, { id }))+ setCollection({ model: "document", id: document.id }, { id })}onDeletePermanently={() => {const deleteAction = Documents.actions.delete({ id: document.id });diff --git a/frontend/src/metabase/entities/collections/collections.ts b/frontend/src/metabase/entities/collections/collections.tsindex f2e039ec93d..9fef6690f5f 100644--- a/frontend/src/metabase/entities/collections/collections.ts+++ b/frontend/src/metabase/entities/collections/collections.ts@@ -9,10 +9,6 @@ import {useListCollectionsQuery,useListCollectionsTreeQuery,} from "metabase/api";-import {- canonicalCollectionId,- isRootTrashCollection,-} from "metabase/collections/utils";import type { Dispatch, GetState, ReduxAction } from "metabase/redux/store";import { CollectionSchema } from "metabase/schema";import { getUserPersonalCollectionId } from "metabase/selectors/user";@@ -25,7 +21,7 @@ import type {UpdateCollectionRequest,} from "metabase-types/api";-import { createEntity, entityCompatibleQuery, undo } from "../utils";+import { createEntity, entityCompatibleQuery } from "../utils";import getExpandedCollectionsById from "./getExpandedCollectionsById";import { getCollectionType } from "./utils";@@ -107,22 +103,6 @@ export const Collections = createEntity({),},- objectActions: {- setCollection: (- { id }: Collection,- collection: Collection,- opts: Record<string, unknown>,- ) =>- Collections.actions.update(- { id },- {- parent_id: canonicalCollectionId(collection?.id),- archived: isRootTrashCollection(collection),- },- undo(opts, "collection", "moved"),- ),- },-selectors: {getExpandedCollectionsById: createSelector([diff --git a/frontend/src/metabase/entities/dashboards.js b/frontend/src/metabase/entities/dashboards.jsindex 0ecf3669cc0..ade8e1cac60 100644--- a/frontend/src/metabase/entities/dashboards.js+++ b/frontend/src/metabase/entities/dashboards.js@@ -5,20 +5,11 @@ import {useGetDashboardQuery,useListDashboardsQuery,} from "metabase/api/dashboard";-import {- canonicalCollectionId,- isRootTrashCollection,-} from "metabase/collections/utils";import { getCollectionType } from "metabase/entities/collections/utils";import { compose, withAction } from "metabase/redux";import { addUndo } from "metabase/redux/undo";-import {- createEntity,- entityCompatibleQuery,- undo,- withRequestState,-} from "./utils";+import { createEntity, entityCompatibleQuery, withRequestState } from "./utils";const COPY_ACTION = `metabase/entities/dashboards/COPY`;@@ -88,16 +79,6 @@ export const Dashboards = createEntity({},objectActions: {- setCollection: ({ id }, collection, opts) =>- Dashboards.actions.update(- { id },- {- collection_id: canonicalCollectionId(collection && collection.id),- archived: isRootTrashCollection(collection),- },- undo(opts, "dashboard", "moved"),- ),-// TODO move into more common area as copy is implemented for more entitiescopy: compose(withAction(COPY_ACTION),diff --git a/frontend/src/metabase/entities/documents.ts b/frontend/src/metabase/entities/documents.tsindex 6620bc608ca..2c47dda2568 100644--- a/frontend/src/metabase/entities/documents.ts+++ b/frontend/src/metabase/entities/documents.ts@@ -1,14 +1,9 @@import { t } from "ttag";import { documentApi, useGetDocumentQuery } from "metabase/api";-import {- canonicalCollectionId,- isRootTrashCollection,-} from "metabase/collections/utils";import type { Dispatch } from "metabase/redux/store";import { DocumentSchema } from "metabase/schema";import type {- Collection,CopyDocumentRequest,CreateDocumentRequest,DeleteDocumentRequest,@@ -17,7 +12,7 @@ import type {UpdateDocumentRequest,} from "metabase-types/api";-import { createEntity, entityCompatibleQuery, undo } from "./utils";+import { createEntity, entityCompatibleQuery } from "./utils";/*** @deprecated use "metabase/api" instead*/@@ -70,19 +65,6 @@ export const Documents = createEntity({},objectActions: {- setCollection: (- { id }: Document,- collection: Pick<Collection, "type" | "id">,- ) =>- Documents.actions.update(- { id },- {- collection_id: canonicalCollectionId(collection && collection.id),- archived: isRootTrashCollection(collection),- },- undo({}, t`document`, t`moved`),- ),-copy:({ id }: Document, overrides: Omit<CopyDocumentRequest, "id">) =>async (dispatch: Dispatch) => {diff --git a/frontend/src/metabase/entities/questions.js b/frontend/src/metabase/entities/questions.jsindex 3472e651343..346cadfbab5 100644--- a/frontend/src/metabase/entities/questions.js+++ b/frontend/src/metabase/entities/questions.js@@ -1,22 +1,14 @@import { updateIn } from "icepick";-import { t } from "ttag";import { cardApi, useGetCardQuery, useListCardsQuery } from "metabase/api";-import {- canonicalCollectionId,- isRootTrashCollection,-} from "metabase/collections/utils";-import { Collections, getCollectionType } from "metabase/entities/collections";-import {- API_UPDATE_QUESTION,- SOFT_RELOAD_CARD,-} from "metabase/redux/query-builder";+import { getCollectionType } from "metabase/entities/collections";+import { SOFT_RELOAD_CARD } from "metabase/redux/query-builder";import {getMetadata,getMetadataUnfiltered,} from "metabase/selectors/metadata";-import { createEntity, entityCompatibleQuery, undo } from "./utils";+import { createEntity, entityCompatibleQuery } from "./utils";export const INJECT_RTK_QUERY_QUESTION_VALUE ="metabase/entities/questions/FETCH_ADHOC_METADATA";@@ -70,57 +62,6 @@ export const Questions = createEntity({entityCompatibleQuery(id, dispatch, cardApi.endpoints.deleteCard),},- objectActions: {- // NOTE: standard questions (i.e. not models, metrics, etc.) can live in dashboards as well as collections.- // this function name is incorrect but maintained for consistency with other entities.- setCollection: (card, destination, opts) => {- return async (dispatch) => {- const archived =- destination.model === "collection" &&- isRootTrashCollection(destination);-- const update =- destination.model === "dashboard"- ? {- dashboard_id: destination.id,- archived,- delete_old_dashcards: true,- }- : {- collection_id: canonicalCollectionId(destination.id),- dashboard_id: null,- archived,- };-- const result = await dispatch(- Questions.actions.update(- { id: card.id },- update,- undo(opts, getLabel(card), t`moved`),- ),- );-- dispatch(- Collections.actions.fetchList(- {- tree: true,- "exclude-archived": true,- },- { reload: true },- ),- );-- const updatedCard = result?.payload?.question;-- if (updatedCard) {- dispatch({ type: API_UPDATE_QUESTION, payload: updatedCard });- }-- return result;- };- },- },-selectors: {getObject: (state, { entityId }) => getMetadata(state).question(entityId),getObjectUnfiltered: (state, { entityId }) =>@@ -185,15 +126,3 @@ export const Questions = createEntity({return type && `collection=${type}`;},});--function getLabel(card) {- if (card.type === "model" || card.model === "dataset") {- return t`model`;- }-- if (card.type === "metric" || card.model === "metric") {- return t`metric`;- }-- return t`question`;-}diff --git a/frontend/src/metabase/entities/snippet-collections.js b/frontend/src/metabase/entities/snippet-collections.jsindex 8d1c66652f2..5a5e8278d00 100644--- a/frontend/src/metabase/entities/snippet-collections.js+++ b/frontend/src/metabase/entities/snippet-collections.js@@ -3,7 +3,6 @@ import { t } from "ttag";import _ from "underscore";import { skipToken, useGetCollectionQuery } from "metabase/api";-import { canonicalCollectionId } from "metabase/collections/utils";import {Collections,getExpandedCollectionsById,@@ -11,7 +10,7 @@ import {} from "metabase/entities/collections";import { SnippetCollectionSchema } from "metabase/schema";-import { createEntity, undo } from "./utils";+import { createEntity } from "./utils";/*** @deprecated use "metabase/api" instead@@ -40,13 +39,6 @@ export const SnippetCollections = createEntity({),objectActions: {- setCollection: ({ id }, collection, opts) =>- SnippetCollections.actions.update(- { id },- { parent_id: canonicalCollectionId(collection && collection.id) },- undo(opts, "folder", "moved"),- ),-delete: null, // not implemented},diff --git a/frontend/src/metabase/entities/timelines.js b/frontend/src/metabase/entities/timelines.jsindex 88d1d027ce3..530729b1ed6 100644--- a/frontend/src/metabase/entities/timelines.js+++ b/frontend/src/metabase/entities/timelines.js@@ -1,5 +1,4 @@import { updateIn } from "icepick";-import { t } from "ttag";import _ from "underscore";import {@@ -10,15 +9,11 @@ import {useListCollectionTimelinesQuery,useListTimelinesQuery,} from "metabase/api";-import { canonicalCollectionId } from "metabase/collections/utils";-import {- getDefaultTimeline,- getTimelineName,-} from "metabase/common/utils/timelines";+import { getDefaultTimeline } from "metabase/common/utils/timelines";import { TimelineSchema } from "metabase/schema";import { TimelineEvents } from "./timeline-events";-import { createEntity, entityCompatibleQuery, undo } from "./utils";+import { createEntity, entityCompatibleQuery } from "./utils";/*** @deprecated use "metabase/api" instead@@ -89,20 +84,6 @@ export const Timelines = createEntity({},},- objectActions: {- setCollection: (timeline, collection, opts) => {- return Timelines.actions.update(- { id: timeline.id },- {- name: getTimelineName(timeline),- collection_id: canonicalCollectionId(collection && collection.id),- default: false,- },- undo(opts, t`timeline`, t`moved`),- );- },- },-reducer: (state = {}, action) => {if (action.type === TimelineEvents.actionTypes.CREATE && !action.error) {const event = TimelineEvents.HACK_getObjectFromAction(action);diff --git a/frontend/src/metabase/query_builder/components/view/View/View/View.jsx b/frontend/src/metabase/query_builder/components/view/View/View/View.jsxindex d76e86a8423..a031305f416 100644--- a/frontend/src/metabase/query_builder/components/view/View/View/View.jsx+++ b/frontend/src/metabase/query_builder/components/view/View/View/View.jsx@@ -7,9 +7,11 @@ import { t } from "ttag";import _ from "underscore";import { deletePermanently } from "metabase/archive/actions";+import { getEntityTypeFromCardType } from "metabase/collections/utils";import { ExplicitSize } from "metabase/common/components/ExplicitSize";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";import { Toaster } from "metabase/common/components/Toaster";+import { useSetCollection } from "metabase/common/hooks";import CS from "metabase/css/core/index.css";import QueryBuilderS from "metabase/css/query_builder.module.css";import { Bookmarks } from "metabase/entities/bookmarks";@@ -21,7 +23,8 @@ import {} from "metabase/query_builder/actions";import { SIDEBAR_SIZES } from "metabase/query_builder/constants";import { MetricEditor } from "metabase/querying/metrics/components/MetricEditor";-import { connect } from "metabase/redux";+import { connect, useDispatch } from "metabase/redux";+import { API_UPDATE_QUESTION } from "metabase/redux/query-builder";import { Flex } from "metabase/ui";import * as Lib from "metabase-lib";@@ -37,7 +40,24 @@ import { ViewRightSidebarContainer } from "../ViewRightSidebarContainer";import S from "./View.module.css";-const ViewInner = forwardRef(function _ViewInner(props, ref) {+const ViewInner = forwardRef(function ViewInnerImpl(propsIn, ref) {+ const dispatch = useDispatch();+ const setCollection = useSetCollection();+ const props = {+ ...propsIn,+ onMove: async (question, newCollection) => {+ const updated = await setCollection(+ {+ model: getEntityTypeFromCardType(question.type()),+ id: question.id(),+ },+ newCollection,+ { notify: false },+ );+ // keep the QB in sync with where the question now lives+ dispatch({ type: API_UPDATE_QUESTION, payload: updated });+ },+ };const {question,result,@@ -282,12 +302,6 @@ const mapDispatchToProps = (dispatch) => ({await dispatch(setArchivedQuestion(question, false));await dispatch(Bookmarks.actions.invalidateLists());},- onMove: (question, newCollection) =>- dispatch(- Questions.actions.setCollection({ id: question.id() }, newCollection, {- notify: { undo: false },- }),- ),onDeletePermanently: (id) => {const deleteAction = Questions.actions.delete({ id });dispatch(deletePermanently(deleteAction));diff --git a/frontend/src/metabase/questions/components/CollectionBadge.tsx b/frontend/src/metabase/questions/components/CollectionBadge.tsxindex 4ff060f1a9c..9d553349fc1 100644--- a/frontend/src/metabase/questions/components/CollectionBadge.tsx+++ b/frontend/src/metabase/questions/components/CollectionBadge.tsx@@ -12,7 +12,6 @@ import type {CollectionId,Collection as CollectionType,} from "metabase-types/api";-import type { WrappedEntity } from "metabase-types/entities";const IRREGULAR_ICON_WIDTH = 16;const IRREGULAR_ICON_PROPS = {@@ -25,7 +24,7 @@ const IRREGULAR_ICON_PROPS = {type CollectionBadgeProps = {className?: string;- collection: WrappedEntity<CollectionType>;+ collection: CollectionType;isSingleLine?: boolean;onClick?: () => void;};diff --git a/frontend/src/metabase/timelines/collections/actions.ts b/frontend/src/metabase/timelines/collections/actions.tsdeleted file mode 100644index 44813bbde1c..00000000000--- a/frontend/src/metabase/timelines/collections/actions.ts+++ /dev/null@@ -1,20 +0,0 @@-import { push } from "react-router-redux";--import { Timelines } from "metabase/entities/timelines";-import type { State } from "metabase/redux/store";-import * as Urls from "metabase/urls";-import type { Timeline } from "metabase-types/api";--export const setCollectionAndNavigate = (- timeline: Timeline,- collectionId: number | null,-) => {- return async (dispatch: any, getState: () => State) => {- const collection = { id: collectionId };- await dispatch(Timelines.actions.setCollection(timeline, collection));-- const newProps = { entityId: timeline.id };- const newTimeline = Timelines.selectors.getObject(getState(), newProps);- dispatch(push(Urls.timelineInCollection(newTimeline)));- };-};diff --git a/frontend/src/metabase/timelines/collections/containers/MoveTimelineModal/MoveTimelineModal.tsx b/frontend/src/metabase/timelines/collections/containers/MoveTimelineModal/MoveTimelineModal.tsxindex e5e94b1453e..e7a15ed6b8f 100644--- a/frontend/src/metabase/timelines/collections/containers/MoveTimelineModal/MoveTimelineModal.tsx+++ b/frontend/src/metabase/timelines/collections/containers/MoveTimelineModal/MoveTimelineModal.tsx@@ -1,18 +1,24 @@+import { useCallback } from "react";+import { push } from "react-router-redux";import _ from "underscore";+import { collectionApi, useGetCollectionQuery } from "metabase/api";+import { useSetCollection } from "metabase/common/hooks";+import { getDefaultTimelineName } from "metabase/common/utils/timelines";import { Timelines } from "metabase/entities/timelines";-import { connect } from "metabase/redux";+import { useDispatch } from "metabase/redux";import type { State } from "metabase/redux/store";import MoveTimelineModal from "metabase/timelines/common/components/MoveTimelineModal";import * as Urls from "metabase/urls";-import type { Timeline } from "metabase-types/api";+import type { CollectionId, Timeline } from "metabase-types/api";-import { setCollectionAndNavigate } from "../../actions";import LoadingAndErrorWrapper from "../../components/LoadingAndErrorWrapper";import type { ModalParams } from "../../types";interface MoveTimelineModalProps {params: ModalParams;+ timeline: Timeline;+ onClose: () => void;}const timelineProps = {@@ -22,14 +28,50 @@ const timelineProps = {LoadingAndErrorWrapper,};-const mapDispatchToProps = (dispatch: any) => ({- onSubmit: async (timeline: Timeline, collectionId: number | null) => {- dispatch(setCollectionAndNavigate(timeline, collectionId));- },-});+function MoveTimelineModalContainer(props: MoveTimelineModalProps) {+ const dispatch = useDispatch();+ const setCollection = useSetCollection();+ const { data: sourceCollection } = useGetCollectionQuery({+ id: props.timeline.collection_id ?? "root",+ });++ const handleSubmit = useCallback(+ (timeline: Timeline, collectionId: CollectionId) => {+ const name =+ timeline.default && sourceCollection+ ? getDefaultTimelineName(sourceCollection)+ : timeline.name;+ // Fire-and-forget so the modal can close back to the parent path before+ // we push the new timeline detail URL — otherwise ModalRoute's onClose+ // would compute the parent off the post-navigation location and bounce+ // us off the timeline page.+ void (async () => {+ await setCollection(+ { model: "timeline", id: timeline.id, name },+ { id: collectionId },+ );+ const { data: collection } = await dispatch(+ collectionApi.endpoints.getCollection.initiate({ id: collectionId }),+ );+ dispatch(+ push(+ Urls.timelineInCollection({+ ...timeline,+ collection_id:+ typeof collectionId === "number" ? collectionId : null,+ collection,+ } as Timeline),+ ),+ );+ })();+ },+ [dispatch, setCollection, sourceCollection],+ );++ return <MoveTimelineModal {...props} onSubmit={handleSubmit} />;+}// eslint-disable-next-line import/no-default-export -- deprecated usage-export default _.compose(- Timelines.load(timelineProps),- connect(null, mapDispatchToProps),-)(MoveTimelineModal);+export default _.compose(Timelines.load(timelineProps))(+ MoveTimelineModalContainer,+);