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
Add tracking events for collection filtering, selection, pinning, and move interactions (#79926)
Anderson6ab7bfb2c6c1
diff --git a/frontend/src/metabase/archive/analytics.ts b/frontend/src/metabase/archive/analytics.tsindex 925fbc1f65f..b854cabccff 100644--- a/frontend/src/metabase/archive/analytics.ts+++ b/frontend/src/metabase/archive/analytics.ts@@ -15,7 +15,11 @@ type MoveToTrashEventDetail =| "measure"| "exploration";-type MoveToTrashTriggeredFrom = "collection" | "detail_page" | "cleanup_modal";+type MoveToTrashTriggeredFrom =+ | "collection"+ | "detail_page"+ | "cleanup_modal"+ | "drag_and_drop";export const archiveAndTrack = async ({archive,diff --git a/frontend/src/metabase/collections/components/CollectionBulkActions/CollectionBulkActions.tsx b/frontend/src/metabase/collections/components/CollectionBulkActions/CollectionBulkActions.tsxindex a0d10502820..2fef0646a7f 100644--- a/frontend/src/metabase/collections/components/CollectionBulkActions/CollectionBulkActions.tsx+++ b/frontend/src/metabase/collections/components/CollectionBulkActions/CollectionBulkActions.tsx@@ -2,6 +2,7 @@ import { memo, useCallback, useMemo, useState } from "react";import { msgid, ngettext, t } from "ttag";import CollectionCopyEntityModal from "metabase/collections/components/CollectionCopyEntityModal";+import { moveCollectionItemAndTrack } from "metabase/common/collections/analytics";import {type Destination,QuestionMoveConfirmModal,@@ -144,9 +145,13 @@ export const CollectionBulkActions = memo(const doMove = async (destination: Destination) => {if (selectedItems) {await Promise.all(- selectedItems- .filter(isMovable)- .map((item) => setCollection(item, destination)),+ selectedItems.filter(isMovable).map((item) =>+ moveCollectionItemAndTrack({+ item,+ move: () => setCollection(item, destination),+ triggeredFrom: "move_modal",+ }),+ ),).finally(clearSelected);}handleCloseModal();diff --git a/frontend/src/metabase/collections/components/CollectionBulkActions/CollectionBulkActions.unit.spec.tsx b/frontend/src/metabase/collections/components/CollectionBulkActions/CollectionBulkActions.unit.spec.tsxindex 5dfbaf9166b..11a13089344 100644--- a/frontend/src/metabase/collections/components/CollectionBulkActions/CollectionBulkActions.unit.spec.tsx+++ b/frontend/src/metabase/collections/components/CollectionBulkActions/CollectionBulkActions.unit.spec.tsx@@ -2,10 +2,29 @@ import userEvent from "@testing-library/user-event";import fetchMock from "fetch-mock";import { useState } from "react";-import { renderWithProviders, screen, waitFor, within } from "__support__/ui";+import {+ setupCardEndpoints,+ setupCollectionByIdEndpoint,+ setupCollectionItemsEndpoint,+ setupCollectionsEndpoints,+ setupDatabasesEndpoints,+ setupRecentViewsAndSelectionsEndpoints,+ setupRootCollectionItemsEndpoint,+} from "__support__/server-mocks";+import {+ mockGetBoundingClientRect,+ renderWithProviders,+ screen,+ waitFor,+ waitForLoaderToBeRemoved,+ within,+} from "__support__/ui";+import * as Analytics from "metabase/analytics";+import { ROOT_COLLECTION } from "metabase/common/collections/constants";import type { Bookmark, Collection, CollectionItem } from "metabase-types/api";import {createMockBookmark,+ createMockCard,createMockCollection,createMockCollectionItem,createMockDashboard,@@ -20,6 +39,14 @@ const writableCollection = createMockCollection({can_write: true,});+const destinationCollectionId = 10;+const destinationCollection = createMockCollection({+ id: destinationCollectionId,+ name: "Destination collection",+ can_write: true,+ location: "/",+});+const pinnedDashboard = createMockCollectionItem({id: 1,name: "Pinned dashboard",@@ -149,7 +176,59 @@ function getMenuItem(name: string) {return screen.getByRole("menuitem", { name });}+function getTrackedEvents(+ trackSimpleEvent: jest.SpiedFunction<typeof Analytics.trackSimpleEvent>,+ eventName: string,+) {+ return trackSimpleEvent.mock.calls+ .map(([event]) => event)+ .filter(({ event }) => event === eventName);+}++function setupMovePickerEndpoints() {+ mockGetBoundingClientRect();+ const rootCollection = createMockCollection(ROOT_COLLECTION);+ setupRecentViewsAndSelectionsEndpoints([], ["views", "selections"]);+ setupDatabasesEndpoints([]);+ setupCollectionsEndpoints({+ collections: [writableCollection, destinationCollection],+ rootCollection,+ });+ setupCollectionByIdEndpoint({+ collections: [writableCollection, destinationCollection],+ });+ setupRootCollectionItemsEndpoint({+ rootCollectionItems: [+ createMockCollectionItem({+ id: destinationCollectionId,+ model: "collection",+ name: destinationCollection.name,+ collection_id: null,+ can_write: true,+ }),+ ],+ });+ setupCollectionItemsEndpoint({+ collection: writableCollection,+ collectionItems: [],+ });+ setupCollectionItemsEndpoint({+ collection: destinationCollection,+ collectionItems: [],+ });+ fetchMock.get("path:/api/search", { data: [] });+ fetchMock.get("path:/api/user/recipients", { data: [] });+}+describe("CollectionBulkActions", () => {+ beforeEach(() => {+ jest.clearAllMocks();+ });++ afterEach(() => {+ jest.restoreAllMocks();+ });+describe("selection composition", () => {it("keeps Move primary and offers Pin all for an unpinned-only selection", async () => {setup({ selected: [tableQuestion, tableDashboard] });@@ -220,6 +299,7 @@ describe("CollectionBulkActions", () => {describe("pinning", () => {it("pins only the unpinned items with Pin all", async () => {+ const trackSimpleEvent = jest.spyOn(Analytics, "trackSimpleEvent");fetchMock.put("path:/api/card/3", {});fetchMock.put("path:/api/dashboard/4", {});const { clearSelected } = setup({@@ -242,9 +322,33 @@ describe("CollectionBulkActions", () => {await waitFor(() => {expect(clearSelected).toHaveBeenCalled();});+ const pinEvents = getTrackedEvents(+ trackSimpleEvent,+ "collection_item_pinned",+ );+ expect(pinEvents).toHaveLength(2);+ expect(pinEvents).toEqual(+ expect.arrayContaining([+ {+ event: "collection_item_pinned",+ event_detail: "question",+ target_id: tableQuestion.id,+ triggered_from: "bulk_action_bar",+ result: "success",+ },+ {+ event: "collection_item_pinned",+ event_detail: "dashboard",+ target_id: tableDashboard.id,+ triggered_from: "bulk_action_bar",+ result: "success",+ },+ ]),+ );});it("unpins only the pinned items with Unpin all", async () => {+ const trackSimpleEvent = jest.spyOn(Analytics, "trackSimpleEvent");fetchMock.put("path:/api/dashboard/1", {});fetchMock.put("path:/api/card/2", {});const { clearSelected } = setup({@@ -267,6 +371,65 @@ describe("CollectionBulkActions", () => {await waitFor(() => {expect(clearSelected).toHaveBeenCalled();});+ const unpinEvents = getTrackedEvents(+ trackSimpleEvent,+ "collection_item_unpinned",+ );+ expect(unpinEvents).toHaveLength(2);+ expect(unpinEvents).toEqual(+ expect.arrayContaining([+ {+ event: "collection_item_unpinned",+ event_detail: "dashboard",+ target_id: pinnedDashboard.id,+ triggered_from: "bulk_action_bar",+ result: "success",+ },+ {+ event: "collection_item_unpinned",+ event_detail: "question",+ target_id: pinnedQuestion.id,+ triggered_from: "bulk_action_bar",+ result: "success",+ },+ ]),+ );+ });++ it("tracks each result when a bulk pin partially fails", async () => {+ const trackSimpleEvent = jest.spyOn(Analytics, "trackSimpleEvent");+ fetchMock.put("path:/api/card/3", {});+ fetchMock.put("path:/api/dashboard/4", {+ status: 500,+ body: { message: "Something went wrong" },+ });+ const { clearSelected } = setup({+ selected: [tableQuestion, tableDashboard],+ });++ await openOverflowMenu();+ await userEvent.click(getMenuItem("Pin all"));++ await waitFor(() => {+ expect(clearSelected).toHaveBeenCalled();+ });+ const pinEvents = getTrackedEvents(+ trackSimpleEvent,+ "collection_item_pinned",+ );+ expect(pinEvents).toHaveLength(2);+ expect(pinEvents).toEqual(+ expect.arrayContaining([+ expect.objectContaining({+ target_id: tableQuestion.id,+ result: "success",+ }),+ expect.objectContaining({+ target_id: tableDashboard.id,+ result: "failure",+ }),+ ]),+ );});it("unpins a pinned-only selection with the primary Unpin all button", async () => {@@ -545,5 +708,40 @@ describe("CollectionBulkActions", () => {expect(screen.getByRole("button", { name: "Move" })).toBeEnabled();});++ it("tracks items moved to another collection from the move modal", async () => {+ const trackSimpleEvent = jest.spyOn(Analytics, "trackSimpleEvent");+ setupMovePickerEndpoints();+ setupCardEndpoints(+ createMockCard({+ id: tableQuestion.id,+ name: tableQuestion.name,+ collection_id: writableCollection.id,+ }),+ );+ setup({ selected: [tableQuestion] });++ await userEvent.click(screen.getByRole("button", { name: "Move" }));+ await waitForLoaderToBeRemoved();+ await userEvent.click(await screen.findByText("Our analytics"));+ await userEvent.click(+ await screen.findByText(destinationCollection.name),+ );+ await userEvent.click(+ within(screen.getByRole("dialog")).getByRole("button", {+ name: "Move",+ }),+ );++ await waitFor(() => {+ expect(trackSimpleEvent).toHaveBeenCalledWith({+ event: "collection_item_moved",+ event_detail: "question",+ target_id: tableQuestion.id,+ triggered_from: "move_modal",+ result: "success",+ });+ });+ });});});diff --git a/frontend/src/metabase/collections/components/CollectionBulkActions/use-bulk-pin.ts b/frontend/src/metabase/collections/components/CollectionBulkActions/use-bulk-pin.tsindex dc5d501ac71..3b54097ad3b 100644--- a/frontend/src/metabase/collections/components/CollectionBulkActions/use-bulk-pin.ts+++ b/frontend/src/metabase/collections/components/CollectionBulkActions/use-bulk-pin.ts@@ -1,6 +1,7 @@import { useCallback, useMemo } from "react";import { t } from "ttag";+import { setCollectionItemPinnedAndTrack } from "metabase/common/collections/analytics";import { isItemPinned } from "metabase/common/collections/utils";import { canPinItem, isPinnable, useSetPinned } from "metabase/common/hooks";import { useMetadataToasts } from "metabase/metadata/hooks";@@ -32,9 +33,14 @@ export const useBulkPin = (const pinSelected = useCallback(async () => {try {await Promise.all(- unpinnedItems- .filter(isPinnable)- .map((item) => setPinned(item, true).unwrap()),+ unpinnedItems.filter(isPinnable).map((item) =>+ setCollectionItemPinnedAndTrack({+ item,+ pinned: true,+ triggeredFrom: "bulk_action_bar",+ setPinned: () => setPinned(item, true).unwrap(),+ }),+ ),);} catch {sendErrorToast(t`There was an error pinning these items.`);@@ -44,9 +50,14 @@ export const useBulkPin = (const unpinSelected = useCallback(async () => {try {await Promise.all(- pinnedItems- .filter(isPinnable)- .map((item) => setPinned(item, false).unwrap()),+ pinnedItems.filter(isPinnable).map((item) =>+ setCollectionItemPinnedAndTrack({+ item,+ pinned: false,+ triggeredFrom: "bulk_action_bar",+ setPinned: () => setPinned(item, false).unwrap(),+ }),+ ),);} catch {sendErrorToast(t`There was an error unpinning these items.`);diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentSelection.unit.spec.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentSelection.unit.spec.tsxindex 90c64ec002b..ab6602db120 100644--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentSelection.unit.spec.tsx+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentSelection.unit.spec.tsx@@ -11,7 +11,14 @@ import {setupSearchEndpoints,setupUserMetabotPermissionsEndpoint,} from "__support__/server-mocks";-import { fireEvent, renderWithProviders, screen, within } from "__support__/ui";+import {+ fireEvent,+ renderWithProviders,+ screen,+ waitFor,+ within,+} from "__support__/ui";+import * as Analytics from "metabase/analytics";import { Route } from "metabase/router";import type { Collection, CollectionItem } from "metabase-types/api";import {@@ -117,6 +124,42 @@ function getPinnedLink(itemName: string) {}describe("CollectionContent selection", () => {+ beforeEach(() => {+ jest.clearAllMocks();+ });++ afterEach(() => {+ jest.restoreAllMocks();+ });++ it("tracks entering selection mode once per selection session", async () => {+ const trackSimpleEvent = jest.spyOn(Analytics, "trackSimpleEvent");+ await setup();++ await userEvent.click(getRowSelectionButton(tableQuestion.name));+ await waitFor(() => {+ expect(trackSimpleEvent).toHaveBeenCalledWith({+ event: "collection_select_mode_entered",+ target_id: defaultCollection.id,+ });+ });++ await userEvent.click(getRowSelectionButton(tableDashboard.name));+ expect(trackSimpleEvent).toHaveBeenCalledTimes(1);++ await userEvent.click(getRowSelectionButton(tableQuestion.name));+ await userEvent.click(getRowSelectionButton(tableDashboard.name));+ await userEvent.click(getRowSelectionButton(tableQuestion.name));++ await waitFor(() => {+ expect(trackSimpleEvent).toHaveBeenCalledTimes(2);+ });+ expect(trackSimpleEvent).toHaveBeenLastCalledWith({+ event: "collection_select_mode_entered",+ target_id: defaultCollection.id,+ });+ });+it("should render pinned cards as links when nothing is selected", async () => {await setup();diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsxindex e420c4c8ce7..da1138e83c9 100644--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx@@ -18,7 +18,10 @@ import { useSetArchive } from "metabase/archive/hooks";import { CollectionBulkActions } from "metabase/collections/components/CollectionBulkActions";import { CollectionHeader } from "metabase/collections/components/CollectionHeader";import { PinnedItemsGrid } from "metabase/collections/components/PinnedItemsGrid";-import { trackCollectionBookmarked } from "metabase/common/collections/analytics";+import {+ trackCollectionBookmarked,+ trackCollectionSelectModeEntered,+} from "metabase/common/collections/analytics";import { getComposedDragProps } from "metabase/common/collections/dropzone";import type {CollectionOrTableIdProps,@@ -102,6 +105,7 @@ export const CollectionContentView = ({const { clear, getIsSelected, selected, selectOnlyTheseItems, toggleItem } =useListSelect(itemKeyFn);const previousCollection = usePrevious(collection);+ const previousSelectedCount = usePrevious(selected.length);useEffect(() => {if (previousCollection && previousCollection.id !== collection.id) {@@ -109,6 +113,12 @@ export const CollectionContentView = ({}}, [previousCollection, collection, clear]);+ useEffect(() => {+ if (previousSelectedCount === 0 && selected.length > 0) {+ trackCollectionSelectModeEntered(collectionId);+ }+ }, [collectionId, previousSelectedCount, selected.length]);+const saveFile = useCallback((file: File) => {setUploadedFile(file);diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.tsxindex 864c52de4f6..d052665d7f2 100644--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.tsx+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.tsx@@ -6,6 +6,7 @@ import {useMemo,useState,} from "react";+import { usePrevious } from "react-use";import { t } from "ttag";import NoResultsImg from "assets/img/no_results.svg";@@ -17,6 +18,7 @@ import {DEFAULT_VISIBLE_COLUMNS_LIST,} from "metabase/collections/components/CollectionContent/constants";import CollectionEmptyState from "metabase/collections/components/CollectionEmptyState";+import { trackCollectionItemsFiltered } from "metabase/common/collections/analytics";import type {CreateBookmark,DeleteBookmark,@@ -170,6 +172,7 @@ export const CollectionItemsTable = ({);const trimmedSearchText =searchText.trim().length > 0 ? debouncedSearchText.trim() : "";+ const previousTrimmedSearchText = usePrevious(trimmedSearchText);const [itemsSorting, setItemsSorting] = useState<SortingOptions<ListCollectionItemsSortColumn>@@ -184,6 +187,12 @@ export const CollectionItemsTable = ({setFilterSelection({ collectionId, value: null });}, [collectionId, resetPage]);+ useEffect(() => {+ if (previousTrimmedSearchText === "" && trimmedSearchText.length > 0) {+ trackCollectionItemsFiltered({ collectionId, filter: "search" });+ }+ }, [collectionId, previousTrimmedSearchText, trimmedSearchText]);+const handleSearchTextChange = useCallback((value: string) => {setSearch({ collectionId, value });@@ -194,10 +203,13 @@ export const CollectionItemsTable = ({const handleSelectedFiltersChange = useCallback((nextFilters: CollectionItemModel[] | null) => {+ if (selectedFilters == null && nextFilters != null) {+ trackCollectionItemsFiltered({ collectionId, filter: "type" });+ }setFilterSelection({ collectionId, value: nextFilters });setPage(0);},- [collectionId, setPage],+ [collectionId, selectedFilters, setPage],);const handleItemsSortingChange = useCallback(diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.unit.spec.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.unit.spec.tsxindex 2f2dfaf73da..8c8d0732d8e 100644--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.unit.spec.tsx+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.unit.spec.tsx@@ -10,6 +10,7 @@ import {waitFor,within,} from "__support__/ui";+import * as Analytics from "metabase/analytics";import { Api } from "metabase/api";import { Route } from "metabase/router";import { SEARCH_DEBOUNCE_DURATION } from "metabase/utils/constants";@@ -153,7 +154,12 @@ function CollectionNavigationTest({}describe("CollectionItemsTable", () => {+ beforeEach(() => {+ jest.clearAllMocks();+ });+afterEach(() => {+ jest.restoreAllMocks();jest.useRealTimers();});@@ -323,6 +329,46 @@ describe("CollectionItemsTable", () => {expect(new URL(getSearchCalls()[0].url).searchParams.get("q")).toBe("rev");});+ it("tracks each search engagement once", async () => {+ const trackSimpleEvent = jest.spyOn(Analytics, "trackSimpleEvent");+ const user = setupUserWithFakeTimers();+ setup();+ const searchInput = await screen.findByPlaceholderText(+ "Search by name or editor...",+ );++ await user.type(searchInput, "revenue");+ advanceSearchDebounce();+ await waitFor(() => {+ expect(trackSimpleEvent).toHaveBeenCalledWith({+ event: "collection_items_filtered",+ event_detail: "search",+ target_id: collection.id,+ });+ });++ await user.type(searchInput, " overview");+ advanceSearchDebounce();+ await waitFor(() => {+ expect(getSearchCalls()).toHaveLength(2);+ });+ expect(trackSimpleEvent).toHaveBeenCalledTimes(1);++ await user.click(+ await screen.findByRole("button", { name: "Clear search" }),+ );+ await user.type(searchInput, "customer");+ advanceSearchDebounce();+ await waitFor(() => {+ expect(trackSimpleEvent).toHaveBeenCalledTimes(2);+ });+ expect(trackSimpleEvent).toHaveBeenLastCalledWith({+ event: "collection_items_filtered",+ event_detail: "search",+ target_id: collection.id,+ });+ });+it("clears the search and restores the unfiltered list", async () => {const user = setupUserWithFakeTimers();setup();@@ -537,6 +583,36 @@ describe("CollectionItemsTable", () => {expect(screen.queryByText("Orders model")).not.toBeInTheDocument();});+ it("tracks each type-filter engagement once", async () => {+ const trackSimpleEvent = jest.spyOn(Analytics, "trackSimpleEvent");+ setup();++ await userEvent.click(+ await screen.findByTestId("collection-type-filter-button"),+ );+ await userEvent.click(screen.getByLabelText("Dashboard"));++ expect(trackSimpleEvent).toHaveBeenCalledWith({+ event: "collection_items_filtered",+ event_detail: "type",+ target_id: collection.id,+ });++ await userEvent.click(screen.getByLabelText("Model"));+ expect(trackSimpleEvent).toHaveBeenCalledTimes(1);++ await userEvent.click(screen.getByLabelText("Dashboard"));+ await userEvent.click(screen.getByLabelText("Model"));+ await userEvent.click(screen.getByLabelText("Dashboard"));++ expect(trackSimpleEvent).toHaveBeenCalledTimes(2);+ expect(trackSimpleEvent).toHaveBeenLastCalledWith({+ event: "collection_items_filtered",+ event_detail: "type",+ target_id: collection.id,+ });+ });+it("uses no_models and shows no results when every type is unchecked", async () => {setup();diff --git a/frontend/src/metabase/common/collections/analytics.ts b/frontend/src/metabase/common/collections/analytics.tsindex 27cf1bfb6e2..9866a7290aa 100644--- a/frontend/src/metabase/common/collections/analytics.ts+++ b/frontend/src/metabase/common/collections/analytics.ts@@ -1,5 +1,49 @@import { trackSimpleEvent } from "metabase/analytics";-import type { CollectionItem } from "metabase-types/api/collection";+import type {+ CollectionId,+ CollectionItem,+} from "metabase-types/api/collection";++type CollectionItemActionResult = "success" | "failure";+type CollectionItemPinTriggeredFrom =+ | "item_menu"+ | "bulk_action_bar"+ | "drag_and_drop";+type CollectionItemMoveTriggeredFrom = "drag_and_drop" | "move_modal";++const getEntityForAnalytics = (model: CollectionItem["model"]) => {+ switch (model) {+ case "card":+ return "question";+ case "dataset":+ return "model";+ default:+ return model;+ }+};++const getCollectionTargetId = (collectionId?: CollectionId) =>+ typeof collectionId === "number" ? collectionId : null;++const trackCollectionItemPinResult = ({+ item,+ pinned,+ triggeredFrom,+ result,+}: {+ item: CollectionItem;+ pinned: boolean;+ triggeredFrom: CollectionItemPinTriggeredFrom;+ result: CollectionItemActionResult;+}) => {+ trackSimpleEvent({+ event: pinned ? "collection_item_pinned" : "collection_item_unpinned",+ event_detail: getEntityForAnalytics(item.model),+ target_id: item.id,+ triggered_from: triggeredFrom,+ result,+ });+};export const trackDataReferenceClicked = () => {trackSimpleEvent({@@ -15,6 +59,86 @@ export const trackCollectionBookmarked = () => {});};+export const trackCollectionItemsFiltered = ({+ collectionId,+ filter,+}: {+ collectionId?: CollectionId;+ filter: "search" | "type";+}) => {+ trackSimpleEvent({+ event: "collection_items_filtered",+ event_detail: filter,+ target_id: getCollectionTargetId(collectionId),+ });+};++export const trackCollectionSelectModeEntered = (+ collectionId: CollectionId,+) => {+ trackSimpleEvent({+ event: "collection_select_mode_entered",+ target_id: getCollectionTargetId(collectionId),+ });+};++export const setCollectionItemPinnedAndTrack = async ({+ item,+ pinned,+ triggeredFrom,+ setPinned,+}: {+ item: CollectionItem;+ pinned: boolean;+ triggeredFrom: CollectionItemPinTriggeredFrom;+ setPinned: () => PromiseLike<unknown>;+}) => {+ const trackEvent = (result: CollectionItemActionResult) =>+ trackCollectionItemPinResult({ item, pinned, triggeredFrom, result });+ let mutationResult: unknown;++ try {+ mutationResult = await setPinned();+ } catch (error) {+ trackEvent("failure");+ throw error;+ }++ const failed =+ typeof mutationResult === "object" &&+ mutationResult !== null &&+ "error" in mutationResult;+ trackEvent(failed ? "failure" : "success");+};++export const moveCollectionItemAndTrack = async ({+ item,+ move,+ triggeredFrom,+}: {+ item: CollectionItem;+ move: () => Promise<unknown>;+ triggeredFrom: CollectionItemMoveTriggeredFrom;+}) => {+ const trackEvent = (result: CollectionItemActionResult) =>+ trackSimpleEvent({+ event: "collection_item_moved",+ event_detail: getEntityForAnalytics(item.model),+ target_id: item.id,+ triggered_from: triggeredFrom,+ result,+ });++ try {+ await move();+ } catch (error) {+ trackEvent("failure");+ throw error;+ }++ trackEvent("success");+};+export const trackCollectionItemBookmarked = (item: CollectionItem & {model: CollectionItem["model"];@@ -30,32 +154,9 @@ export const trackCollectionItemBookmarked = (return;}- const analyticsModel = item.model;-- const getEntityForAnalytics = (- analyticsModel:- | "metric"- | "dashboard"- | "collection"- | "dataset"- | "document"- | "card"- | "table"- | "exploration",- ) => {- switch (analyticsModel) {- case "card":- return "question";- case "dataset":- return "model";- default:- return analyticsModel;- }- };-trackSimpleEvent({event: "bookmark_added",- event_detail: getEntityForAnalytics(analyticsModel),+ event_detail: getEntityForAnalytics(item.model),triggered_from: "collection_list",});};diff --git a/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx b/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsxindex 333c74cf093..9d8adc49934 100644--- a/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx+++ b/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx@@ -10,7 +10,10 @@ import {useRestore,useSetArchive,} from "metabase/archive/hooks";-import { trackCollectionItemBookmarked } from "metabase/common/collections/analytics";+import {+ setCollectionItemPinnedAndTrack,+ trackCollectionItemBookmarked,+} from "metabase/common/collections/analytics";import type {CreateBookmark,DeleteBookmark,@@ -101,7 +104,13 @@ function ActionMenuInner({const handlePin = useCallback(() => {if (isPinnable(item)) {- setPinned(item, !isItemPinned(item));+ const pinned = !isItemPinned(item);+ void setCollectionItemPinnedAndTrack({+ item,+ pinned,+ triggeredFrom: "item_menu",+ setPinned: () => setPinned(item, pinned),+ });}}, [item, setPinned]);diff --git a/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.unit.spec.tsx b/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.unit.spec.tsxindex 8df3ac53ed2..150f064824a 100644--- a/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.unit.spec.tsx+++ b/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.unit.spec.tsx@@ -4,6 +4,7 @@ import fetchMock from "fetch-mock";import { createMockEntitiesState } from "__support__/store";import { getIcon, queryIcon, renderWithProviders } from "__support__/ui";+import * as Analytics from "metabase/analytics";import {createMockSettingsState,createMockState,@@ -69,6 +70,14 @@ const setup = ({};describe("ActionMenu", () => {+ beforeEach(() => {+ jest.clearAllMocks();+ });++ afterEach(() => {+ jest.restoreAllMocks();+ });+describe("bookmarks", () => {it("should bookmark an item with its id and model", async () => {const item = createMockCollectionItem({@@ -87,6 +96,86 @@ describe("ActionMenu", () => {});});+ describe("pinning", () => {+ it("tracks a successful pin", async () => {+ const trackSimpleEvent = jest.spyOn(Analytics, "trackSimpleEvent");+ const item = createMockCollectionItem({+ id: 1,+ name: "Dashboard",+ model: "dashboard",+ collection_position: null,+ });+ fetchMock.put("path:/api/dashboard/1", {});+ setup({ item });++ await userEvent.click(getIcon("ellipsis"));+ await userEvent.click(await screen.findByText("Pin this"));++ await waitFor(() => {+ expect(trackSimpleEvent).toHaveBeenCalledWith({+ event: "collection_item_pinned",+ event_detail: "dashboard",+ target_id: item.id,+ triggered_from: "item_menu",+ result: "success",+ });+ });+ });++ it("tracks a successful unpin and normalizes questions", async () => {+ const trackSimpleEvent = jest.spyOn(Analytics, "trackSimpleEvent");+ const item = createMockCollectionItem({+ id: 2,+ name: "Question",+ model: "card",+ collection_position: 1,+ });+ fetchMock.put("path:/api/card/2", {});+ setup({ item });++ await userEvent.click(getIcon("ellipsis"));+ await userEvent.click(await screen.findByText("Unpin"));++ await waitFor(() => {+ expect(trackSimpleEvent).toHaveBeenCalledWith({+ event: "collection_item_unpinned",+ event_detail: "question",+ target_id: item.id,+ triggered_from: "item_menu",+ result: "success",+ });+ });+ });++ it("tracks a failed pin", async () => {+ const trackSimpleEvent = jest.spyOn(Analytics, "trackSimpleEvent");+ const item = createMockCollectionItem({+ id: 3,+ name: "Dashboard",+ model: "dashboard",+ collection_position: null,+ });+ fetchMock.put("path:/api/dashboard/3", {+ status: 500,+ body: { message: "Something went wrong" },+ });+ setup({ item });++ await userEvent.click(getIcon("ellipsis"));+ await userEvent.click(await screen.findByText("Pin this"));++ await waitFor(() => {+ expect(trackSimpleEvent).toHaveBeenCalledWith({+ event: "collection_item_pinned",+ event_detail: "dashboard",+ target_id: item.id,+ triggered_from: "item_menu",+ result: "failure",+ });+ });+ });+ });+describe("selection", () => {const item = createMockCollectionItem({id: 1,diff --git a/frontend/src/metabase/common/components/dnd/ItemDragSource.tsx b/frontend/src/metabase/common/components/dnd/ItemDragSource.tsxindex 1ad5e90486d..75634026346 100644--- a/frontend/src/metabase/common/components/dnd/ItemDragSource.tsx+++ b/frontend/src/metabase/common/components/dnd/ItemDragSource.tsx@@ -13,14 +13,14 @@ import { isRootTrashCollection } from "metabase/common/collections/utils";import {type MovableItem,type PinnableItem,- isMovable,- isPinnable,useSetCollection,useSetPinned,useToast,} from "metabase/common/hooks";import type { Collection, CollectionItem } from "metabase-types/api";+import { type ItemDropResult, handleItemDrop } from "./handle-item-drop";+import { type ItemDragPayload, dragTypeForItem, isItemDragPayload } from ".";interface ItemDragSourceInnerProps {@@ -61,7 +61,10 @@ interface DragSourceOwnProps {collection?: Collection;onDrop?: () => void;onMoveError?: (error: unknown) => void;- setPinned: (item: PinnableItem, pinned: boolean | number) => void;+ setPinned: (+ item: PinnableItem,+ pinned: boolean | number,+ ) => PromiseLike<unknown>;setCollection: (item: MovableItem,destination: { id: Collection["id"] },@@ -110,28 +113,19 @@ const DragSourceComponent = DragSource(return;}const { items } = payload;- // Unjustified type cast. FIXME- const { collection, pinIndex } = monitor.getDropResult() as {- collection?: Collection;- pinIndex?: number;- };+ // React DnD v4 does not expose a type for target-specific drop results.+ const dropResult = monitor.getDropResult() as ItemDropResult;if (items.length > 0) {try {- if (collection !== undefined) {- if (!items.every(isMovable)) {- return;- }- await Promise.all(- items.map((item) => setCollection(item, collection)),- );- } else if (pinIndex !== undefined) {- if (!items.every(isPinnable)) {- return;- }- await Promise.all(items.map((item) => setPinned(item, pinIndex)));+ const handled = await handleItemDrop({+ items,+ dropResult,+ setPinned,+ setCollection,+ });+ if (handled) {+ onDrop?.();}-- onDrop?.();} catch (e) {onMoveError?.(e);}diff --git a/frontend/src/metabase/common/components/dnd/handle-item-drop.ts b/frontend/src/metabase/common/components/dnd/handle-item-drop.tsnew file mode 100644index 00000000000..16389293039--- /dev/null+++ b/frontend/src/metabase/common/components/dnd/handle-item-drop.ts@@ -0,0 +1,97 @@+import { archiveAndTrack } from "metabase/archive/analytics";+import {+ moveCollectionItemAndTrack,+ setCollectionItemPinnedAndTrack,+} from "metabase/common/collections/analytics";+import {+ isItemPinned,+ isRootTrashCollection,+} from "metabase/common/collections/utils";+import {+ type MovableItem,+ type PinnableItem,+ isMovable,+ isPinnable,+} from "metabase/common/hooks";+import type { Collection, CollectionItem } from "metabase-types/api";++export type ItemDropResult = {+ collection?: Collection;+ pinIndex?: number | null;+};++type HandleItemDropProps = {+ items: CollectionItem[];+ dropResult: ItemDropResult;+ setPinned: (+ item: PinnableItem,+ pinned: boolean | number,+ ) => PromiseLike<unknown>;+ setCollection: (+ item: MovableItem,+ destination: { id: Collection["id"] },+ ) => Promise<unknown>;+};++export async function handleItemDrop({+ items,+ dropResult: { collection, pinIndex },+ setPinned,+ setCollection,+}: HandleItemDropProps): Promise<boolean> {+ if (collection !== undefined) {+ const movableItems = items.filter(isMovable);+ if (movableItems.length !== items.length) {+ return false;+ }++ await Promise.all(+ movableItems.map((item) => {+ if (isRootTrashCollection(collection)) {+ return archiveAndTrack({+ archive: async () => {+ await setCollection(item, collection);+ },+ model: item.model,+ modelId: item.id,+ triggeredFrom: "drag_and_drop",+ });+ }++ return moveCollectionItemAndTrack({+ item,+ move: () => setCollection(item, collection),+ triggeredFrom: "drag_and_drop",+ });+ }),+ );+ return true;+ }++ if (pinIndex !== undefined) {+ const pinnableItems = items.filter(isPinnable);+ if (pinnableItems.length !== items.length) {+ return false;+ }++ const pinned = pinIndex !== null;+ const pinValue = pinIndex ?? false;+ await Promise.all(+ pinnableItems.map(async (item) => {+ if (isItemPinned(item) === pinned) {+ await setPinned(item, pinValue);+ return;+ }++ await setCollectionItemPinnedAndTrack({+ item,+ pinned,+ triggeredFrom: "drag_and_drop",+ setPinned: () => setPinned(item, pinValue),+ });+ }),+ );+ }++ return true;+}diff --git a/frontend/src/metabase/common/components/dnd/handle-item-drop.unit.spec.ts b/frontend/src/metabase/common/components/dnd/handle-item-drop.unit.spec.tsnew file mode 100644index 00000000000..093d8020ef2--- /dev/null+++ b/frontend/src/metabase/common/components/dnd/handle-item-drop.unit.spec.ts@@ -0,0 +1,154 @@+import * as Analytics from "metabase/analytics";+import type { CollectionItem } from "metabase-types/api";+import {+ createMockCollection,+ createMockCollectionItem,+} from "metabase-types/api/mocks";++import { handleItemDrop } from "./handle-item-drop";++const question = createMockCollectionItem({+ id: 1,+ model: "card",+ collection_position: null,+});+const dashboard = createMockCollectionItem({+ id: 2,+ model: "dashboard",+ collection_position: null,+});++function setup(items: CollectionItem[] = [question]) {+ return {+ items,+ setCollection: jest.fn().mockResolvedValue(undefined),+ setPinned: jest.fn().mockResolvedValue({ data: {} }),+ };+}++describe("handleItemDrop", () => {+ beforeEach(() => {+ jest.clearAllMocks();+ });++ afterEach(() => {+ jest.restoreAllMocks();+ });++ it("tracks each item moved to a collection with drag and drop", async () => {+ const trackSimpleEvent = jest.spyOn(Analytics, "trackSimpleEvent");+ const props = setup([question, dashboard]);+ const collection = createMockCollection({ id: 10 });++ await handleItemDrop({+ ...props,+ dropResult: { collection },+ });++ expect(props.setCollection).toHaveBeenCalledTimes(2);+ expect(trackSimpleEvent).toHaveBeenCalledTimes(2);+ expect(trackSimpleEvent).toHaveBeenCalledWith({+ event: "collection_item_moved",+ event_detail: "question",+ target_id: question.id,+ triggered_from: "drag_and_drop",+ result: "success",+ });+ expect(trackSimpleEvent).toHaveBeenCalledWith({+ event: "collection_item_moved",+ event_detail: "dashboard",+ target_id: dashboard.id,+ triggered_from: "drag_and_drop",+ result: "success",+ });+ });++ it("tracks failed collection moves and preserves the rejection", async () => {+ const trackSimpleEvent = jest.spyOn(Analytics, "trackSimpleEvent");+ const props = setup();+ const error = new Error("Move failed");+ props.setCollection.mockRejectedValue(error);++ await expect(+ handleItemDrop({+ ...props,+ dropResult: { collection: createMockCollection({ id: 10 }) },+ }),+ ).rejects.toBe(error);+ expect(trackSimpleEvent).toHaveBeenCalledWith({+ event: "collection_item_moved",+ event_detail: "question",+ target_id: question.id,+ triggered_from: "drag_and_drop",+ result: "failure",+ });+ });++ it("reuses moved-to-trash analytics for a trash drop", async () => {+ const trackSchemaEvent = jest.spyOn(Analytics, "trackSchemaEvent");+ const trackSimpleEvent = jest.spyOn(Analytics, "trackSimpleEvent");+ const props = setup();++ await handleItemDrop({+ ...props,+ dropResult: {+ collection: createMockCollection({ id: "trash", type: "trash" }),+ },+ });++ expect(trackSimpleEvent).not.toHaveBeenCalled();+ expect(trackSchemaEvent).toHaveBeenCalledWith("simple_event", {+ event: "moved-to-trash",+ event_detail: "question",+ target_id: question.id,+ triggered_from: "drag_and_drop",+ duration_ms: expect.any(Number),+ result: "success",+ });+ });++ it("tracks pinning and unpinning but not pinned-item reordering", async () => {+ const trackSimpleEvent = jest.spyOn(Analytics, "trackSimpleEvent");+ const pinProps = setup();+ await handleItemDrop({+ ...pinProps,+ dropResult: { pinIndex: 1 },+ });+ expect(pinProps.setPinned).toHaveBeenCalledWith(question, 1);+ expect(trackSimpleEvent).toHaveBeenCalledWith({+ event: "collection_item_pinned",+ event_detail: "question",+ target_id: question.id,+ triggered_from: "drag_and_drop",+ result: "success",+ });++ const pinnedDashboard = {+ ...dashboard,+ collection_position: 1,+ };+ const unpinProps = setup([pinnedDashboard]);+ unpinProps.setPinned.mockResolvedValue({ error: {} });+ await handleItemDrop({+ ...unpinProps,+ dropResult: { pinIndex: null },+ });+ expect(unpinProps.setPinned).toHaveBeenCalledWith(pinnedDashboard, false);+ expect(trackSimpleEvent).toHaveBeenCalledWith({+ event: "collection_item_unpinned",+ event_detail: "dashboard",+ target_id: pinnedDashboard.id,+ triggered_from: "drag_and_drop",+ result: "failure",+ });++ trackSimpleEvent.mockClear();+ const reorderProps = setup([pinnedDashboard]);+ await handleItemDrop({+ ...reorderProps,+ dropResult: { pinIndex: 2 },+ });+ expect(reorderProps.setPinned).toHaveBeenCalledWith(pinnedDashboard, 2);+ expect(trackSimpleEvent).not.toHaveBeenCalled();+ });+});