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 `setPinned` from entity object actions to an RTK hook (#73506)
Romeo Van Snick111ac1042dc0
diff --git a/frontend/src/metabase-types/api/card.ts b/frontend/src/metabase-types/api/card.tsindex 39f0c85436a..4c60f033da2 100644--- a/frontend/src/metabase-types/api/card.ts+++ b/frontend/src/metabase-types/api/card.ts@@ -453,7 +453,7 @@ export interface UpdateCardRequest {collection_id?: CollectionId | null;dashboard_id?: DashboardId | null;document_id?: DocumentId | null;- collection_position?: number;+ collection_position?: number | null;result_metadata?: Field[] | null;cache_ttl?: number;collection_preview?: boolean;diff --git a/frontend/src/metabase-types/api/collection.ts b/frontend/src/metabase-types/api/collection.tsindex 4298ae4ddf8..caf5f414c4e 100644--- a/frontend/src/metabase-types/api/collection.ts+++ b/frontend/src/metabase-types/api/collection.ts@@ -139,7 +139,6 @@ export interface CollectionItem {effective_location?: string;authority_level?: CollectionAuthorityLevel;dashboard_count?: number | null;- setPinned?: (isPinned: number | boolean) => void;setCollection?: (collection: Pick<Collection, "id"> | Pick<Dashboard, "id">,) => void;diff --git a/frontend/src/metabase-types/api/document.ts b/frontend/src/metabase-types/api/document.tsindex aea6291673b..a4868357997 100644--- a/frontend/src/metabase-types/api/document.ts+++ b/frontend/src/metabase-types/api/document.ts@@ -14,6 +14,7 @@ export type Document = {name: string;version: number;collection_id: CollectionId | null;+ collection_position?: number | null;collection?: Collection | null;created_at: string;updated_at: string;diff --git a/frontend/src/metabase-types/entities/common.ts b/frontend/src/metabase-types/entities/common.tsindex f92b4eab7e8..1439e0d5d7a 100644--- a/frontend/src/metabase-types/entities/common.ts+++ b/frontend/src/metabase-types/entities/common.ts@@ -2,5 +2,4 @@ import type { Collection } from "metabase-types/api";export type WrappedEntity<Entity> = {setCollection: (collection: Collection) => void;- setPinned: (isPinned: boolean) => void;} & Entity;diff --git a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsxindex 8c4b3c9d6e8..ab0a7db7877 100644--- a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx+++ b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx@@ -16,14 +16,19 @@ import {canBookmarkItem,canCopyItem,canMoveItem,- canPinItem,canPreviewItem,isItemPinned,isPreviewEnabled,} from "metabase/collections/utils";import { ConfirmModal } from "metabase/common/components/ConfirmModal";import { EntityItem } from "metabase/common/components/EntityItem";-import { type ArchivableItem, useSetArchive } from "metabase/common/hooks";+import {+ type ArchivableItem,+ 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 { bookmarks as BookmarkEntity } from "metabase/entities";@@ -89,6 +94,7 @@ function ActionMenu({}: ActionMenuProps & ActionMenuStateProps) {const dispatch = useDispatch();const archive = useSetArchive();+ const setPinned = useSetPinned();const [sendToast] = useToast();const setCollectionPreview = useSetCollectionPreview();const [modalOpened, { open: openModal, close: closeModal }] = useDisclosure();@@ -103,8 +109,10 @@ function ActionMenu({const canCopy = onCopy && canCopyItem(item);const handlePin = useCallback(() => {- item.setPinned?.(!isItemPinned(item));- }, [item]);+ if (isPinnable(item)) {+ setPinned(item, !isItemPinned(item));+ }+ }, [item, setPinned]);const handleCopy = useCallback(() => {onCopy?.([item]);diff --git a/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.stories.tsx b/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.stories.tsxindex 1e348326d69..3bd9ffea97d 100644--- a/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.stories.tsx+++ b/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.stories.tsx@@ -38,7 +38,6 @@ export const Question = {model: "card",name: "Question",description: "This is a description of the question",- setPinned: action("setPinned"),copy: true,setCollection: action("setCollection"),archived: false,@@ -62,7 +61,6 @@ export const Dashboard = {description: Array(20).fill("This is a description of the dashboard.").join(" "),- setPinned: action("setPinned"),archived: false,},onCopy,@@ -82,7 +80,6 @@ export const Model = {collection_id: null,name: "Model",description: "This is a description of the model",- setPinned: action("setPinned"),archived: false,},onCopy,diff --git a/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.unit.spec.tsx b/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.unit.spec.tsxindex 94b9c0a34aa..2e9f188d674 100644--- a/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.unit.spec.tsx+++ b/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.unit.spec.tsx@@ -48,7 +48,6 @@ const getCollectionItem = ({name = "My Item",description = "description foo foo foo",collection_position = 1,- setPinned = jest.fn(),...rest}: {id?: number;@@ -56,7 +55,6 @@ const getCollectionItem = ({name?: string;description?: string;collection_position?: number;- setPinned?: (isPinned: boolean | number) => void;} = {}): CollectionItem & { description: string } => {return createMockCollectionItem({...rest,@@ -65,7 +63,6 @@ const getCollectionItem = ({name,description,collection_position,- setPinned,}) as CollectionItem & { description: string };};diff --git a/frontend/src/metabase/collections/components/PinnedItemOverview/PinnedItemOverview.unit.spec.tsx b/frontend/src/metabase/collections/components/PinnedItemOverview/PinnedItemOverview.unit.spec.tsxindex ca45d33038f..f13fa4fdeec 100644--- a/frontend/src/metabase/collections/components/PinnedItemOverview/PinnedItemOverview.unit.spec.tsx+++ b/frontend/src/metabase/collections/components/PinnedItemOverview/PinnedItemOverview.unit.spec.tsx@@ -21,7 +21,6 @@ const dashboardItem1: CollectionItem = {collection_id: null,name: "Dashboard Foo",description: "description foo",- setPinned: jest.fn(),archived: false,};@@ -32,7 +31,6 @@ const dashboardItem2: CollectionItem = {collection_id: null,name: "Dashboard Bar",description: "description foo",- setPinned: jest.fn(),archived: false,};diff --git a/frontend/src/metabase/collections/utils.ts b/frontend/src/metabase/collections/utils.tsindex 110097f1db3..98a53d6062a 100644--- a/frontend/src/metabase/collections/utils.ts+++ b/frontend/src/metabase/collections/utils.ts@@ -243,10 +243,6 @@ export function canBookmarkItem({ model, type, archived }: CollectionItem) {}}-export function canPinItem(item: CollectionItem, collection?: Collection) {- return collection?.can_write && item.setPinned != null && !item.archived;-}-export function canPreviewItem(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 9d4e1db1c20..66b22c0e362 100644--- a/frontend/src/metabase/common/components/dnd/ItemDragSource.tsx+++ b/frontend/src/metabase/common/components/dnd/ItemDragSource.tsx@@ -10,7 +10,12 @@ import { getEmptyImage } from "react-dnd-html5-backend";import { getErrorMessage } from "metabase/api/utils";import { isRootTrashCollection } from "metabase/collections/utils";-import { useToast } from "metabase/common/hooks";+import {+ type PinnableItem,+ isPinnable,+ useSetPinned,+ useToast,+} from "metabase/common/hooks";import type { Collection, CollectionItem } from "metabase-types/api";import { dragTypeForItem } from ".";@@ -53,6 +58,7 @@ interface DragSourceOwnProps {collection?: Collection;onDrop?: () => void;onMoveError?: (error: unknown) => void;+ setPinned: (item: PinnableItem, pinned: boolean | number) => void;children?: ReactNode | ((props: Record<string, unknown>) => ReactNode);}@@ -77,7 +83,7 @@ const DragSourceComponent = DragSource(return { item: props.item };},async endDrag(- { selected, onDrop, onMoveError }: DragSourceOwnProps,+ { selected, onDrop, onMoveError, setPinned }: DragSourceOwnProps,monitor: DragSourceMonitor,) {if (!monitor.didDrop()) {@@ -97,7 +103,7 @@ const DragSourceComponent = DragSource();} else if (pinIndex !== undefined) {await Promise.all(- items.map((i) => i.setPinned && i.setPinned(pinIndex)),+ items.filter(isPinnable).map((i) => setPinned(i, pinIndex)),);}@@ -127,11 +133,18 @@ interface ItemDragSourceProps {export function ItemDragSource(props: ItemDragSourceProps) {const [sendToast] = useToast();+ const setPinned = useSetPinned();const onMoveError = (error: unknown) =>sendToast({message: getErrorMessage(error),icon: "warning_triangle_filled",iconColor: "warning",});- return <DragSourceComponent {...props} onMoveError={onMoveError} />;+ return (+ <DragSourceComponent+ {...props}+ onMoveError={onMoveError}+ setPinned={setPinned}+ />+ );}diff --git a/frontend/src/metabase/common/hooks/index.ts b/frontend/src/metabase/common/hooks/index.tsindex 1c477c68a27..46a87b74fd9 100644--- a/frontend/src/metabase/common/hooks/index.ts+++ b/frontend/src/metabase/common/hooks/index.ts@@ -16,5 +16,6 @@ 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-pinned";export * from "./use-snapshot-selector";export * from "./use-subscriber";diff --git a/frontend/src/metabase/common/hooks/use-set-pinned.ts b/frontend/src/metabase/common/hooks/use-set-pinned.tsnew file mode 100644index 00000000000..8f87fc63ead--- /dev/null+++ b/frontend/src/metabase/common/hooks/use-set-pinned.ts@@ -0,0 +1,81 @@+import { useCallback } from "react";+import { match } from "ts-pattern";++import {+ useUpdateCardMutation,+ useUpdateDashboardMutation,+ useUpdateDocumentMutation,+} from "metabase/api";+import type {+ Card,+ Collection,+ CollectionItem,+ Dashboard,+ Document,+} from "metabase-types/api";++type Pinnable<M extends string, T extends { id: unknown }> = {+ model: M;+ id: T["id"];+};++export type PinnableItem =+ | Pinnable<"card", Card>+ | Pinnable<"dataset", Card>+ | Pinnable<"metric", Card>+ | Pinnable<"dashboard", Dashboard>+ | Pinnable<"document", Document>;++export type PinnableModel = PinnableItem["model"];++const PINNABLE_MODELS = new Set<PinnableModel>([+ "card",+ "dataset",+ "metric",+ "dashboard",+ "document",+]);++export function isPinnable<T extends { model: string }>(+ item: T,+): item is T & { model: PinnableModel } {+ return PINNABLE_MODELS.has(item.model as PinnableModel);+}++export function canPinItem(item: CollectionItem, collection?: Collection) {+ return !!collection?.can_write && isPinnable(item) && !item.archived;+}++function toCollectionPosition(pinned: boolean | number): number | null {+ if (typeof pinned === "number") {+ return pinned;+ }+ return pinned ? 1 : null;+}++export function useSetPinned() {+ const [updateCard] = useUpdateCardMutation();+ const [updateDashboard] = useUpdateDashboardMutation();+ const [updateDocument] = useUpdateDocumentMutation();++ return useCallback(+ (item: PinnableItem, pinned: boolean | number) => {+ const collection_position = toCollectionPosition(pinned);+ return match(item)+ .with(+ { model: "card" },+ { model: "dataset" },+ { model: "metric" },+ ({ id }) => updateCard({ id, collection_position }),+ )+ .with({ model: "dashboard" }, ({ id }) =>+ updateDashboard({ id, collection_position }),+ )+ .with({ model: "document" }, ({ id }) =>+ updateDocument({ id, collection_position }),+ )+ .exhaustive();+ },+ [updateCard, updateDashboard, updateDocument],+ );+}diff --git a/frontend/src/metabase/entities/dashboards.js b/frontend/src/metabase/entities/dashboards.jsindex 0a9eda5124f..0ecf3669cc0 100644--- a/frontend/src/metabase/entities/dashboards.js+++ b/frontend/src/metabase/entities/dashboards.js@@ -98,16 +98,6 @@ export const Dashboards = createEntity({undo(opts, "dashboard", "moved"),),- setPinned: ({ id }, pinned, opts) =>- Dashboards.actions.update(- { id },- {- collection_position:- typeof pinned === "number" ? pinned : pinned ? 1 : null,- },- opts,- ),-// 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 ca736ab88f0..6620bc608ca 100644--- a/frontend/src/metabase/entities/documents.ts+++ b/frontend/src/metabase/entities/documents.ts@@ -83,14 +83,6 @@ export const Documents = createEntity({undo({}, t`document`, t`moved`),),- setPinned: ({ id }: Document, pinned: number | boolean) =>- Documents.actions.update(- { id },- {- collection_position:- typeof pinned === "number" ? pinned : pinned ? 1 : null,- },- ),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 b4213813f72..3472e651343 100644--- a/frontend/src/metabase/entities/questions.js+++ b/frontend/src/metabase/entities/questions.js@@ -119,16 +119,6 @@ export const Questions = createEntity({return result;};},-- setPinned: ({ id }, pinned, opts) =>- Questions.actions.update(- { id },- {- collection_position:- typeof pinned === "number" ? pinned : pinned ? 1 : null,- },- opts,- ),},selectors: {