Skip to content

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

Remove the `setArchive` entity object action in favor of a `useSetArchive` hook (#73384)

Romeo Van Snickb876fdd6587f
diff --git a/enterprise/frontend/src/metabase-enterprise/clean_up/CleanupCollectionModal/CleanupCollectionBulkActions.tsx b/enterprise/frontend/src/metabase-enterprise/clean_up/CleanupCollectionModal/CleanupCollectionBulkActions.tsx
index 52cd2829dbb..207e5e86bd0 100644
--- a/enterprise/frontend/src/metabase-enterprise/clean_up/CleanupCollectionModal/CleanupCollectionBulkActions.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/clean_up/CleanupCollectionModal/CleanupCollectionBulkActions.tsx
@@ -7,8 +7,8 @@ import {
BulkActionButton,
} from "metabase/common/components/BulkActionBar";
import { UndoListOverlay } from "metabase/common/components/UndoListing";
+import { type ArchivableItem, useSetArchive } from "metabase/common/hooks";
import type { Undo } from "metabase/redux/store/undo";
-import type { CollectionItem } from "metabase-types/api";
import type { StaleCollectionItem } from "../types";
@@ -28,10 +28,13 @@ export const CleanupCollectionBulkActions = ({
onArchive,
}: CleanupCollectionBulkActionsProps) => {
const [undo, setUndo] = useState<Undo | undefined>();
+ const archive = useSetArchive();
- const handleUndo = async (items: CollectionItem[]) => {
+ const handleUndo = async (items: StaleCollectionItem[]) => {
return Promise.all(
- items.map((item) => item?.setArchived?.(false, { notify: false })),
+ items.map((item) =>
+ archive(item as ArchivableItem, false, { notify: false }),
+ ),
)
.then(() => resetPagination())
.finally(() => setUndo(undefined));
@@ -40,10 +43,9 @@ export const CleanupCollectionBulkActions = ({
const handleBulkArchive = async () => {
const actions = selected.map((item) => {
return archiveAndTrack({
- archive: () =>
- item.setArchived
- ? item.setArchived(true, { notify: false })
- : Promise.resolve(),
+ archive: async () => {
+ await archive(item as ArchivableItem, true, { notify: false });
+ },
model: item.model,
modelId: item.id,
triggeredFrom: "cleanup_modal",
diff --git a/frontend/src/metabase-types/api/collection.ts b/frontend/src/metabase-types/api/collection.ts
index 78c2e53356c..58ea62bc692 100644
--- a/frontend/src/metabase-types/api/collection.ts
+++ b/frontend/src/metabase-types/api/collection.ts
@@ -139,10 +139,6 @@ export interface CollectionItem {
effective_location?: string;
authority_level?: CollectionAuthorityLevel;
dashboard_count?: number | null;
- setArchived?: (
- isArchived: boolean,
- opts?: Record<string, unknown>,
- ) => Promise<void>;
setPinned?: (isPinned: number | boolean) => void;
setCollection?: (
collection: Pick<Collection, "id"> | Pick<Dashboard, "id">,
diff --git a/frontend/src/metabase-types/entities/common.ts b/frontend/src/metabase-types/entities/common.ts
index d1e99038f18..a618a527891 100644
--- a/frontend/src/metabase-types/entities/common.ts
+++ b/frontend/src/metabase-types/entities/common.ts
@@ -3,7 +3,6 @@ import type { Collection } from "metabase-types/api";
export type WrappedEntity<Entity> = {
getName: () => string;
getCollection: () => Collection;
- setArchived: (isArchived: boolean) => void;
setCollection: (collection: Collection) => void;
setCollectionPreview: (isEnabled: boolean) => void;
setPinned: (isPinned: boolean) => void;
diff --git a/frontend/src/metabase/admin/datamodel/containers/SegmentListApp.tsx b/frontend/src/metabase/admin/datamodel/containers/SegmentListApp.tsx
index a121d0392fd..c800b5418f3 100644
--- a/frontend/src/metabase/admin/datamodel/containers/SegmentListApp.tsx
+++ b/frontend/src/metabase/admin/datamodel/containers/SegmentListApp.tsx
@@ -7,6 +7,7 @@ import { SegmentItem } from "metabase/admin/datamodel/components/SegmentItem";
import { FilteredToUrlTable } from "metabase/admin/datamodel/hoc/FilteredToUrlTable";
import { Button } from "metabase/common/components/Button";
import { Link } from "metabase/common/components/Link";
+import { useSetArchive } from "metabase/common/hooks";
import AdminS from "metabase/css/admin.module.css";
import CS from "metabase/css/core/index.css";
import { trackSegmentCreateStarted } from "metabase/data-studio/analytics";
@@ -22,13 +23,6 @@ interface Props {
isAdmin: boolean;
isRemoteSyncReadOnly: boolean;
segments: Segment[];
- setArchived: (
- { id }: Pick<Segment, "id">,
- archived: boolean,
- opts?: {
- revision_message?: string;
- },
- ) => void;
tableSelector: ReactNode;
}
@@ -36,9 +30,9 @@ function SegmentListAppInner({
isAdmin,
isRemoteSyncReadOnly,
segments,
- setArchived,
tableSelector,
}: Props) {
+ const archive = useSetArchive();
const trackSegmentCreateClick = () => {
trackSegmentCreateStarted("admin_datamodel_segments");
};
@@ -78,7 +72,11 @@ function SegmentListAppInner({
key={segment.id}
segment={segment}
readOnly={segment.table?.is_published && isRemoteSyncReadOnly}
- onRetire={isAdmin ? () => setArchived(segment, true) : undefined}
+ onRetire={
+ isAdmin
+ ? () => archive({ id: segment.id, model: "segment" }, true)
+ : undefined
+ }
/>
))}
</tbody>
@@ -96,13 +94,8 @@ function SegmentListAppInner({
export const SegmentListApp = _.compose(
Segments.loadList(),
FilteredToUrlTable,
- connect(
- (state: State) => ({
- isAdmin: getUserIsAdmin(state),
- isRemoteSyncReadOnly: PLUGIN_REMOTE_SYNC.getIsRemoteSyncReadOnly(state),
- }),
- {
- setArchived: Segments.actions.setArchived,
- },
- ),
+ connect((state: State) => ({
+ isAdmin: getUserIsAdmin(state),
+ isRemoteSyncReadOnly: PLUGIN_REMOTE_SYNC.getIsRemoteSyncReadOnly(state),
+ })),
)(SegmentListAppInner);
diff --git a/frontend/src/metabase/api/action.ts b/frontend/src/metabase/api/action.ts
index 6c449ad7021..abbbcfd71fc 100644
--- a/frontend/src/metabase/api/action.ts
+++ b/frontend/src/metabase/api/action.ts
@@ -112,6 +112,7 @@ export const {
useGetActionQuery,
useListActionsQuery,
useListPublicActionsQuery,
+ useUpdateActionMutation,
useDeleteActionPublicLinkMutation,
endpoints: {
listPublicActions,
diff --git a/frontend/src/metabase/browse/metrics/MetricsTable.tsx b/frontend/src/metabase/browse/metrics/MetricsTable.tsx
index 8d06a62fa2f..34ca1ef96c5 100644
--- a/frontend/src/metabase/browse/metrics/MetricsTable.tsx
+++ b/frontend/src/metabase/browse/metrics/MetricsTable.tsx
@@ -23,8 +23,8 @@ import { Columns } from "metabase/common/components/ItemsTable/Columns";
import type { ResponsiveProps } from "metabase/common/components/ItemsTable/utils";
import { Link } from "metabase/common/components/Link";
import { MarkdownPreview } from "metabase/common/components/MarkdownPreview";
+import { useSetArchive } from "metabase/common/hooks";
import { Bookmarks } from "metabase/entities/bookmarks";
-import { Questions } from "metabase/entities/questions";
import { useDispatch } from "metabase/redux";
import {
Button,
@@ -331,6 +331,7 @@ function MenuCell({ metric }: { metric?: MetricResult }) {
const [createBookmark] = useCreateBookmarkMutation();
const [deleteBookmark] = useDeleteBookmarkMutation();
const dispatch = useDispatch();
+ const archive = useSetArchive();
const actions = useMemo(() => {
if (!metric) {
@@ -387,18 +388,13 @@ function MenuCell({ metric }: { metric?: MetricResult }) {
title: t`Move to trash`,
icon: "trash",
action() {
- dispatch(
- Questions.actions.setArchived(
- { id: metric.id, model: "metric" },
- true,
- ),
- );
+ archive({ id: metric.id, model: "metric" }, true);
},
});
}
return actions;
- }, [metric, createBookmark, deleteBookmark, dispatch]);
+ }, [metric, createBookmark, deleteBookmark, dispatch, archive]);
return (
<td
diff --git a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx
index 306b81c909d..939ed91d278 100644
--- a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx
+++ b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx
@@ -23,6 +23,7 @@ import {
} 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 { useToast } from "metabase/common/hooks/use-toast";
import { bookmarks as BookmarkEntity } from "metabase/entities";
import { entityForObject } from "metabase/entities/utils";
@@ -86,6 +87,7 @@ function ActionMenu({
deleteBookmark,
}: ActionMenuProps & ActionMenuStateProps) {
const dispatch = useDispatch();
+ const archive = useSetArchive();
const [sendToast] = useToast();
const [modalOpened, { open: openModal, close: closeModal }] = useDisclosure();
const isBookmarked = bookmarks && getIsBookmarked(item, bookmarks);
@@ -110,9 +112,10 @@ function ActionMenu({
onMove?.([item]);
}, [item, onMove]);
- const handleArchive = useCallback(() => {
- return item.setArchived ? item.setArchived(true) : Promise.resolve();
- }, [item]);
+ const handleArchive = useCallback(
+ () => archive(item as ArchivableItem, true),
+ [archive, item],
+ );
const handleToggleBookmark = useMemo(() => {
if (!createBookmark && !deleteBookmark) {
diff --git a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.unit.spec.tsx b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.unit.spec.tsx
index 83728e32952..dbd6eb28717 100644
--- a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.unit.spec.tsx
+++ b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.unit.spec.tsx
@@ -1,5 +1,6 @@
import { screen } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
+import fetchMock from "fetch-mock";
import { createMockEntitiesState } from "__support__/store";
import { getIcon, queryIcon, renderWithProviders } from "__support__/ui";
@@ -128,12 +129,13 @@ describe("ActionMenu", () => {
describe("moving and archiving", () => {
it("should allow to move and archive regular collections", async () => {
const item = createMockCollectionItem({
+ id: 1,
name: "Collection",
model: "collection",
can_write: true,
setCollection: jest.fn(),
- setArchived: jest.fn(() => Promise.resolve()),
});
+ fetchMock.put("path:/api/collection/1", { ...item, archived: true });
const { onMove } = setup({ item });
@@ -143,7 +145,14 @@ describe("ActionMenu", () => {
await userEvent.click(getIcon("ellipsis"));
await userEvent.click(await screen.findByText("Move to trash"));
- expect(item.setArchived).toHaveBeenCalledWith(true);
+
+ const calls = fetchMock.callHistory.calls("path:/api/collection/1");
+ expect(calls).toHaveLength(1);
+ const [putCall] = calls;
+ expect(putCall.options.method).toBe("PUT");
+ expect(JSON.parse(putCall.options.body as string)).toMatchObject({
+ archived: true,
+ });
});
it("should not allow to move and archive personal collections", async () => {
@@ -153,7 +162,6 @@ describe("ActionMenu", () => {
can_write: true,
personal_owner_id: 1,
setCollection: jest.fn(),
- setArchived: jest.fn(() => Promise.resolve()),
copy: true,
});
@@ -170,7 +178,6 @@ describe("ActionMenu", () => {
model: "collection",
can_write: false,
setCollection: jest.fn(),
- setArchived: jest.fn(() => Promise.resolve()),
copy: true,
});
diff --git a/frontend/src/metabase/collections/components/ArchiveCollectionModal/ArchiveCollectionModal.jsx b/frontend/src/metabase/collections/components/ArchiveCollectionModal/ArchiveCollectionModal.jsx
index 7c6e9de92c1..772a249f2f8 100644
--- a/frontend/src/metabase/collections/components/ArchiveCollectionModal/ArchiveCollectionModal.jsx
+++ b/frontend/src/metabase/collections/components/ArchiveCollectionModal/ArchiveCollectionModal.jsx
@@ -1,42 +1,31 @@
/* eslint-disable react/prop-types */
-import { Component } from "react";
import { withRouter } from "react-router";
-import { push } from "react-router-redux";
import { t } from "ttag";
import _ from "underscore";
import { ArchiveModal } from "metabase/common/components/ArchiveModal";
+import { useSetArchive } from "metabase/common/hooks";
import { Collections } from "metabase/entities/collections";
-import { connect } from "metabase/redux";
import * as Urls from "metabase/urls";
-const mapDispatchToProps = {
- setCollectionArchived: Collections.actions.setArchived,
- push,
-};
+function ArchiveCollectionModalInner({ collection, onClose }) {
+ const archive = useSetArchive();
+ const handleArchive = () =>
+ archive({ id: collection.id, model: "collection" }, true);
-class ArchiveCollectionModalInner extends Component {
- archive = async () => {
- const { collection, setCollectionArchived } = this.props;
- await setCollectionArchived(collection, true);
- };
-
- render() {
- return (
- <ArchiveModal
- title={t`Move this collection to trash?`}
- message={t`The dashboards, collections, and alerts in this collection will also be moved to the trash.`}
- model="collection"
- modelId={this.props.collection.id}
- onClose={this.props.onClose}
- onArchive={this.archive}
- />
- );
- }
+ return (
+ <ArchiveModal
+ title={t`Move this collection to trash?`}
+ message={t`The dashboards, collections, and alerts in this collection will also be moved to the trash.`}
+ model="collection"
+ modelId={collection.id}
+ onClose={onClose}
+ onArchive={handleArchive}
+ />
+ );
}
export const ArchiveCollectionModal = _.compose(
- connect(null, mapDispatchToProps),
Collections.load({
id: (state, props) => Urls.extractCollectionId(props.params.slug),
}),
diff --git a/frontend/src/metabase/collections/components/CollectionBulkActions/ArchivedBulkActions.tsx b/frontend/src/metabase/collections/components/CollectionBulkActions/ArchivedBulkActions.tsx
index 31b82c8b4e0..c9ab8ff1ecc 100644
--- a/frontend/src/metabase/collections/components/CollectionBulkActions/ArchivedBulkActions.tsx
+++ b/frontend/src/metabase/collections/components/CollectionBulkActions/ArchivedBulkActions.tsx
@@ -8,6 +8,7 @@ import {
BulkActionDangerButton,
} from "metabase/common/components/BulkActionBar";
import { ConfirmModal } from "metabase/common/components/ConfirmModal";
+import { useSetArchive } from "metabase/common/hooks";
import { useDispatch } from "metabase/redux";
import { addUndo } from "metabase/redux/undo";
import type { Collection, CollectionItem } from "metabase-types/api";
@@ -32,6 +33,7 @@ export const ArchivedBulkActions = ({
setSelectedAction,
}: ArchivedBulkActionsProps) => {
const dispatch = useDispatch();
+ const archive = useSetArchive();
const hasSelectedItems = useMemo(
() => !!selectedItems && !_.isEmpty(selectedItems),
@@ -59,7 +61,7 @@ export const ArchivedBulkActions = ({
}, [selected]);
const handleBulkRestore = () => {
- const actions = selected.map((item) => item.setArchived(false));
+ const actions = selected.map((item) => archive(item, false));
Promise.all(actions).finally(unselect);
};
diff --git a/frontend/src/metabase/collections/components/CollectionBulkActions/UnarchivedBulkActions.tsx b/frontend/src/metabase/collections/components/CollectionBulkActions/UnarchivedBulkActions.tsx
index db192467f21..d4c81f8c0d0 100644
--- a/frontend/src/metabase/collections/components/CollectionBulkActions/UnarchivedBulkActions.tsx
+++ b/frontend/src/metabase/collections/components/CollectionBulkActions/UnarchivedBulkActions.tsx
@@ -4,6 +4,7 @@ import { t } from "ttag";
import { archiveAndTrack } from "metabase/archive/analytics";
import { canArchiveItem, canMoveItem } from "metabase/collections/utils";
import { BulkActionButton } from "metabase/common/components/BulkActionBar";
+import { useSetArchive } from "metabase/common/hooks";
import { useRegisterShortcut } from "metabase/palette/hooks/useRegisterShortcut";
import type { Collection, CollectionItem } from "metabase-types/api";
@@ -22,6 +23,8 @@ export const UnarchivedBulkActions = ({
setSelectedItems,
setSelectedAction,
}: UnarchivedBulkActionsProps) => {
+ const archive = useSetArchive();
+
// archive
const canArchive = useMemo(() => {
return selected.every((item) => canArchiveItem(item, collection));
@@ -30,10 +33,9 @@ export const UnarchivedBulkActions = ({
const handleBulkArchive = async () => {
const actions = selected.map((item) => {
return archiveAndTrack({
- archive: () =>
- item.setArchived
- ? item.setArchived(true, { notify: false })
- : Promise.resolve(),
+ archive: async () => {
+ await archive(item, true, { notify: false });
+ },
model: item.model,
modelId: item.id,
triggeredFrom: "collection",
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.tsx
index c593c8182ba..cee4ef1326d 100644
--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.tsx
+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.tsx
@@ -1,10 +1,12 @@
import { useCallback } from "react";
-import { useListCollectionsTreeQuery } from "metabase/api";
+import {
+ useGetCollectionQuery,
+ useListCollectionsTreeQuery,
+} from "metabase/api";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import {
useBookmarkListQuery,
- useCollectionQuery,
useDatabaseListQuery,
} from "metabase/common/hooks";
import { Bookmarks } from "metabase/entities/bookmarks";
@@ -36,7 +38,7 @@ export function CollectionContent({
"exclude-archived": true,
});
- const { data: collection, error: collectionError } = useCollectionQuery({
+ const { data: collection, error: collectionError } = useGetCollectionQuery({
id: collectionId,
});
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx
index a9288df88c7..f84bdc6eaac 100644
--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx
+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx
@@ -29,7 +29,7 @@ import {
} from "metabase/collections/utils";
import { getVisibleColumnsMap } from "metabase/common/components/ItemsTable/utils";
import { ItemsDragLayer } from "metabase/common/components/dnd/ItemsDragLayer";
-import { useToast } from "metabase/common/hooks";
+import { useSetArchive, 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";
@@ -136,6 +136,7 @@ const CollectionContentViewInner = ({
}, [bookmarks, collectionId]);
const dispatch = useDispatch();
+ const archive = useSetArchive();
const [sendToast] = useToast();
const visibleColumnsMap = useMemo(
@@ -254,8 +255,7 @@ const CollectionContentViewInner = ({
canRestore={collection.can_restore}
canDelete={collection.can_delete}
onUnarchive={async () => {
- const input = { ...actionId, name: collection.name };
- await dispatch(Collections.actions.setArchived(input, false));
+ await archive({ id: collectionId, model: "collection" }, false);
await dispatch(Bookmarks.actions.invalidateLists());
}}
onMove={({ id }) =>
diff --git a/frontend/src/metabase/collections/components/CollectionCopyEntityModal.tsx b/frontend/src/metabase/collections/components/CollectionCopyEntityModal.tsx
index 0ebed774679..0d9d40f07c2 100644
--- a/frontend/src/metabase/collections/components/CollectionCopyEntityModal.tsx
+++ b/frontend/src/metabase/collections/components/CollectionCopyEntityModal.tsx
@@ -2,19 +2,9 @@ import { dissoc } from "icepick";
import { useState } from "react";
import { t } from "ttag";
-import { Collections } from "metabase/entities/collections";
+import { useInitialCollectionId } from "metabase/collections/hooks";
import EntityCopyModal from "metabase/entities/containers/EntityCopyModal";
import { entityTypeForObject } from "metabase/entities/utils";
-import { connect } from "metabase/redux";
-
-function mapStateToProps(state: any, props: any) {
- return {
- initialCollectionId: Collections.selectors.getInitialCollectionId(state, {
- ...props,
- collectionId: props.entityObject.collection_id,
- }),
- };
-}
const getTitle = (entityObject: any, isShallowCopy: boolean) => {
if (entityObject.model !== "dashboard") {
@@ -28,15 +18,16 @@ const getTitle = (entityObject: any, isShallowCopy: boolean) => {
function CollectionCopyEntityModal({
entityObject,
- initialCollectionId,
onClose,
onSaved,
}: {
entityObject: any;
- initialCollectionId: number;
onClose: () => void;
onSaved: (newEntityObject: any) => void;
}) {
+ const initialCollectionId = useInitialCollectionId({
+ collectionId: entityObject.collection_id,
+ });
const [isShallowCopy, setIsShallowCopy] = useState(true);
const title = getTitle(entityObject, isShallowCopy);
@@ -68,4 +59,4 @@ function CollectionCopyEntityModal({
}
// eslint-disable-next-line import/no-default-export
-export default connect(mapStateToProps)(CollectionCopyEntityModal);
+export default CollectionCopyEntityModal;
diff --git a/frontend/src/metabase/collections/components/CreateCollectionForm/CreateCollectionForm.tsx b/frontend/src/metabase/collections/components/CreateCollectionForm/CreateCollectionForm.tsx
index bd3f6e09a48..b3c34a6b458 100644
--- a/frontend/src/metabase/collections/components/CreateCollectionForm/CreateCollectionForm.tsx
+++ b/frontend/src/metabase/collections/components/CreateCollectionForm/CreateCollectionForm.tsx
@@ -1,4 +1,5 @@
import { useMemo, useState } from "react";
+import type { WithRouterProps } from "react-router";
import { withRouter } from "react-router";
import { t } from "ttag";
import _ from "underscore";
@@ -6,6 +7,7 @@ import * as Yup from "yup";
import { skipToken, useGetCollectionQuery } from "metabase/api";
import FormCollectionPicker from "metabase/collections/containers/FormCollectionPicker";
+import { useInitialCollectionId } from "metabase/collections/hooks";
import { Button } from "metabase/common/components/Button";
import { FormErrorMessage } from "metabase/common/components/FormErrorMessage";
import { FormFooter } from "metabase/common/components/FormFooter";
@@ -20,7 +22,6 @@ import { Collections } from "metabase/entities/collections";
import { Form, FormProvider } from "metabase/forms";
import { PLUGIN_TENANTS } from "metabase/plugins";
import { connect } from "metabase/redux";
-import type { State } from "metabase/redux/store";
import { Flex } from "metabase/ui";
import * as Errors from "metabase/utils/errors";
import type { Collection } from "metabase-types/api";
@@ -41,7 +42,7 @@ const COLLECTION_SCHEMA = Yup.object({
export interface CreateCollectionProperties {
name: string;
description: string | null;
- parent_id: Collection["id"];
+ parent_id: Collection["id"] | null;
}
export interface CreateCollectionFormOwnProps {
@@ -53,10 +54,6 @@ export interface CreateCollectionFormOwnProps {
showAuthorityLevelPicker?: boolean;
}
-interface CreateCollectionFormStateProps {
- initialCollectionId: Collection["id"];
-}
-
interface CreateCollectionFormDispatchProps {
handleCreateCollection: (
collection: CreateCollectionProperties,
@@ -64,33 +61,28 @@ interface CreateCollectionFormDispatchProps {
}
type Props = CreateCollectionFormOwnProps &
- CreateCollectionFormStateProps &
- CreateCollectionFormDispatchProps;
-
-function mapStateToProps(
- state: State,
- props: CreateCollectionFormOwnProps,
-): CreateCollectionFormStateProps {
- return {
- initialCollectionId: Collections.selectors.getInitialCollectionId(
- state,
- props,
- ),
- };
-}
+ CreateCollectionFormDispatchProps &
+ WithRouterProps;
const mapDispatchToProps = {
handleCreateCollection: Collections.actions.create,
};
function CreateCollectionForm({
- initialCollectionId,
+ collectionId,
+ location,
+ params,
onSubmit,
onCancel,
filterPersonalCollections,
showCollectionPicker = true,
showAuthorityLevelPicker = true,
}: Props) {
+ const initialCollectionId = useInitialCollectionId({
+ collectionId,
+ location,
+ params,
+ });
const initialValues = useMemo(
() => ({
...COLLECTION_SCHEMA.getDefault(),
@@ -168,5 +160,5 @@ function CreateCollectionForm({
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default _.compose(
withRouter,
- connect(mapStateToProps, mapDispatchToProps),
+ connect(null, mapDispatchToProps),
)(CreateCollectionForm);
diff --git a/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.stories.tsx b/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.stories.tsx
index d841fe1c51a..1e348326d69 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",
- setArchived: action("setArchived"),
setPinned: action("setPinned"),
copy: true,
setCollection: action("setCollection"),
@@ -63,7 +62,6 @@ export const Dashboard = {
description: Array(20)
.fill("This is a description of the dashboard.")
.join(" "),
- setArchived: action("setArchived"),
setPinned: action("setPinned"),
archived: false,
},
@@ -84,7 +82,6 @@ export const Model = {
collection_id: null,
name: "Model",
description: "This is a description of the model",
- setArchived: action("setArchived"),
setPinned: action("setPinned"),
archived: false,
},
diff --git a/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.unit.spec.tsx b/frontend/src/metabase/collections/components/PinnedItemCard/PinnedItemCard.unit.spec.tsx
index 80374aa891a..94b9c0a34aa 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,
- setArchived = jest.fn(),
setPinned = jest.fn(),
...rest
}: {
@@ -57,7 +56,6 @@ const getCollectionItem = ({
name?: string;
description?: string;
collection_position?: number;
- setArchived?: (isArchived: boolean) => Promise<void>;
setPinned?: (isPinned: boolean | number) => void;
} = {}): CollectionItem & { description: string } => {
return createMockCollectionItem({
@@ -67,7 +65,6 @@ const getCollectionItem = ({
name,
description,
collection_position,
- setArchived,
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.tsx
index a77d9e9174e..ca45d33038f 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",
- setArchived: jest.fn(),
setPinned: jest.fn(),
archived: false,
};
@@ -33,7 +32,6 @@ const dashboardItem2: CollectionItem = {
collection_id: null,
name: "Dashboard Bar",
description: "description foo",
- setArchived: jest.fn(),
setPinned: jest.fn(),
archived: false,
};
diff --git a/frontend/src/metabase/collections/hooks.ts b/frontend/src/metabase/collections/hooks.ts
index caa9b78681e..6b402bcbe13 100644
--- a/frontend/src/metabase/collections/hooks.ts
+++ b/frontend/src/metabase/collections/hooks.ts
@@ -1,21 +1,131 @@
-import getInitialCollectionId from "metabase/entities/collections/getInitialCollectionId";
+import type { Location } from "history";
+import { useMemo } from "react";
+
+import { collectionApi } from "metabase/api";
+import { ROOT_COLLECTION } from "metabase/entities/collections/constants";
import { PLUGIN_COLLECTIONS } from "metabase/plugins";
import { useSelector } from "metabase/redux";
-import type { CollectionId } from "metabase-types/api";
+import type { State } from "metabase/redux/store";
+import { getUserPersonalCollectionId } from "metabase/selectors/user";
+import * as Urls from "metabase/urls/collections";
+import type { Collection, CollectionId } from "metabase-types/api";
+
+import {
+ canonicalCollectionId,
+ isLibraryCollection,
+ isRootTrashCollection,
+} from "./utils";
+
+export type UseInitialCollectionIdProps = {
+ collectionId?: Collection["id"] | null;
+ location?: Location;
+ params?: { collectionId?: Collection["id"]; slug?: string };
+};
+
+// Collections are loaded into two places during the entity-system → RTK migration:
+// the legacy `state.entities.collections` slice via `Collections.actions.fetch`,
+// `Collections.load` HOC, etc.) and the RTK Query cache (via `useGetCollectionQuery`).
+// We read from both so this hook works regardless of which path loaded the collection.
+//
+// TODO: Once collections are exclusively RTK-loaded, the entity-state branch can be dropped.
+function selectCollectionFromCache(
+ state: State,
+ id: Collection["id"],
+): Collection | undefined {
+ const fromEntities = state.entities?.collections?.[id] as
+ | Collection
+ | undefined;
+ if (fromEntities) {
+ return fromEntities;
+ }
+ const queryState = collectionApi.endpoints.getCollection.select({ id })(
+ state,
+ );
+ if (queryState?.status === "fulfilled") {
+ return queryState.data as Collection | undefined;
+ }
+ return undefined;
+}
+
+// Picks the collection ID a "create new X" form should default to, given a set of route/prop hints.
+//
+// TODO: Once collections are exclusively RTK-loaded, this can become a wrapper around `useGetCollectionQuery`
+// with explicit loading states.
+export function useInitialCollectionId({
+ collectionId,
+ location,
+ params,
+}: UseInitialCollectionIdProps = {}): CollectionId | null {
+ const fromCollectionId = useSelector((state) =>
+ collectionId != null
+ ? selectCollectionFromCache(state, collectionId)
+ : undefined,
+ );
+
+ const fromNavParam = useSelector((state) =>
+ params?.collectionId != null
+ ? selectCollectionFromCache(state, params.collectionId)
+ : undefined,
+ );
+
+ const idFromSlug =
+ params?.slug && location && Urls.isCollectionPath(location.pathname)
+ ? Urls.extractCollectionId(params.slug)
+ : undefined;
+ const fromSlug = useSelector((state) =>
+ idFromSlug != null
+ ? selectCollectionFromCache(state, idFromSlug)
+ : undefined,
+ );
+
+ const idFromQuery = location?.query?.collectionId as
+ | Collection["id"]
+ | undefined;
+ const fromQuery = useSelector((state) =>
+ idFromQuery != null
+ ? selectCollectionFromCache(state, idFromQuery)
+ : undefined,
+ );
+
+ const personalCollectionId = useSelector(getUserPersonalCollectionId);
+ const rootCollection = useSelector((state) =>
+ selectCollectionFromCache(state, ROOT_COLLECTION.id),
+ );
+
+ return useMemo(() => {
+ const candidates = [
+ fromCollectionId,
+ fromNavParam,
+ fromSlug,
+ fromQuery,
+ rootCollection,
+ ];
+
+ for (const collection of candidates) {
+ if (collection == null || isRootTrashCollection(collection)) {
+ continue;
+ }
+ if (collection.can_write && !isLibraryCollection(collection)) {
+ return canonicalCollectionId(collection.id);
+ }
+ }
+ return canonicalCollectionId(personalCollectionId);
+ }, [
+ fromCollectionId,
+ fromNavParam,
+ fromSlug,
+ fromQuery,
+ rootCollection,
+ personalCollectionId,
+ ]);
+}
export const useOSSGetDefaultCollectionId = (
sourceCollectionId?: CollectionId | null,
): CollectionId | null => {
- // TODO: refactor this selector to be this hook and fetch the necessary collections
- // right now we assume that the root collection and any other relevant collections are already
- // in the redux store
- const initialCollectionId = useSelector((state) =>
- getInitialCollectionId(state, {
- collectionId: sourceCollectionId ?? undefined,
- }),
- );
-
- return initialCollectionId;
+ return useInitialCollectionId({
+ collectionId: sourceCollectionId ?? undefined,
+ });
};
export const useGetDefaultCollectionId = (
diff --git a/frontend/src/metabase/common/CreateDashboard/CreateDashboardForm.tsx b/frontend/src/metabase/common/CreateDashboard/CreateDashboardForm.tsx
index d37b4d829ae..cacef948feb 100644
--- a/frontend/src/metabase/common/CreateDashboard/CreateDashboardForm.tsx
+++ b/frontend/src/metabase/common/CreateDashboard/CreateDashboardForm.tsx
@@ -5,12 +5,12 @@ import * as Yup from "yup";
import type { SdkCollectionId } from "embedding-sdk-bundle/types";
import { useCreateDashboardMutation } from "metabase/api";
import FormCollectionPicker from "metabase/collections/containers/FormCollectionPicker/FormCollectionPicker";
+import { useInitialCollectionId } from "metabase/collections/hooks";
import { FormFooter } from "metabase/common/components/FormFooter";
import {
DASHBOARD_DESCRIPTION_MAX_LENGTH,
DASHBOARD_NAME_MAX_LENGTH,
} from "metabase/common/utils/dashboard";
-import { Collections } from "metabase/entities/collections";
import {
Form,
FormErrorMessage,
@@ -19,7 +19,6 @@ import {
FormTextInput,
FormTextarea,
} from "metabase/forms";
-import { useSelector } from "metabase/redux";
import { Button, Stack } from "metabase/ui";
import * as Errors from "metabase/utils/errors";
import type { CollectionId, Dashboard } from "metabase-types/api";
@@ -50,7 +49,7 @@ export interface CreateDashboardProperties {
/**
* @internal
*/
- collection_id: CollectionId;
+ collection_id: CollectionId | null;
}
export interface CreateDashboardFormOwnProps {
@@ -66,9 +65,7 @@ export function CreateDashboardForm({
onCreate,
onCancel,
}: CreateDashboardFormOwnProps) {
- const initialCollectionId = useSelector((state) =>
- Collections.selectors.getInitialCollectionId(state, { collectionId }),
- );
+ const initialCollectionId = useInitialCollectionId({ collectionId });
// When passing `"root"` it will be resolved to `null`
const hasTargetCollection = targetCollection !== undefined;
diff --git a/frontend/src/metabase/common/hooks/index.ts b/frontend/src/metabase/common/hooks/index.ts
index a8bdc47ccc8..1b0145b0f8e 100644
--- a/frontend/src/metabase/common/hooks/index.ts
+++ b/frontend/src/metabase/common/hooks/index.ts
@@ -14,5 +14,6 @@ export * from "./use-url-with-utm";
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-snapshot-selector";
export * from "./use-subscriber";
diff --git a/frontend/src/metabase/common/hooks/use-set-archive.ts b/frontend/src/metabase/common/hooks/use-set-archive.ts
new file mode 100644
index 00000000000..9b25c3f3fff
--- /dev/null
+++ b/frontend/src/metabase/common/hooks/use-set-archive.ts
@@ -0,0 +1,235 @@
+import { useCallback } from "react";
+import { match } from "ts-pattern";
+import { t } from "ttag";
+
+import {
+ useUpdateActionMutation,
+ useUpdateCardMutation,
+ useUpdateCollectionMutation,
+ useUpdateDashboardMutation,
+ useUpdateDocumentMutation,
+ useUpdateSegmentMutation,
+ useUpdateSnippetMutation,
+ useUpdateSubscriptionMutation,
+ useUpdateTimelineEventMutation,
+ useUpdateTimelineMutation,
+} from "metabase/api";
+import { useDispatch } from "metabase/redux";
+import { addUndo } from "metabase/redux/undo";
+import type {
+ Card,
+ Collection,
+ Dashboard,
+ DashboardSubscription,
+ Document,
+ NativeQuerySnippet,
+ Segment,
+ Timeline,
+ TimelineEvent,
+ WritebackAction,
+} from "metabase-types/api";
+
+type Archivable<M extends string, T extends { id: unknown }> = {
+ model: M;
+ id: T["id"];
+ archived?: boolean;
+ can_write?: boolean;
+};
+
+export type ArchivableItem =
+ | Archivable<"card", Card>
+ | Archivable<"dataset", Card>
+ | Archivable<"metric", Card>
+ | Archivable<"dashboard", Dashboard>
+ | Archivable<"collection", Collection>
+ | Archivable<"snippet-collection", Collection>
+ | Archivable<"document", Document>
+ | Archivable<"action", WritebackAction>
+ | Archivable<"segment", Segment>
+ | Archivable<"timeline", Timeline>
+ | Archivable<"timeline-event", TimelineEvent>
+ | Archivable<"pulse", DashboardSubscription>
+ | Archivable<"snippet", NativeQuerySnippet>;
+
+export type ArchivableModel = ArchivableItem["model"];
+
+type ArchivableLabels = {
+ subject: () => string;
+ archived: () => string;
+ unarchived: () => string;
+};
+
+const LABELS = {
+ card: {
+ subject: () => t`question`,
+ archived: () => t`trashed`,
+ unarchived: () => t`restored`,
+ },
+ dataset: {
+ subject: () => t`model`,
+ archived: () => t`trashed`,
+ unarchived: () => t`restored`,
+ },
+ metric: {
+ subject: () => t`metric`,
+ archived: () => t`trashed`,
+ unarchived: () => t`restored`,
+ },
+ dashboard: {
+ subject: () => t`dashboard`,
+ archived: () => t`trashed`,
+ unarchived: () => t`restored`,
+ },
+ collection: {
+ subject: () => t`collection`,
+ archived: () => t`trashed`,
+ unarchived: () => t`restored`,
+ },
+ document: {
+ subject: () => t`document`,
+ archived: () => t`trashed`,
+ unarchived: () => t`restored`,
+ },
+ action: {
+ subject: () => t`action`,
+ archived: () => t`archived`,
+ unarchived: () => t`unarchived`,
+ },
+ segment: {
+ subject: () => t`segment`,
+ archived: () => t`archived`,
+ unarchived: () => t`unarchived`,
+ },
+ timeline: {
+ subject: () => t`timeline`,
+ archived: () => t`archived`,
+ unarchived: () => t`unarchived`,
+ },
+ "timeline-event": {
+ subject: () => t`event`,
+ archived: () => t`archived`,
+ unarchived: () => t`unarchived`,
+ },
+ pulse: {
+ subject: () => t`subscription`,
+ archived: () => t`deleted`,
+ unarchived: () => t`restored`,
+ },
+ snippet: {
+ subject: () => t`snippet`,
+ archived: () => t`archived`,
+ unarchived: () => t`unarchived`,
+ },
+ "snippet-collection": {
+ subject: () => t`folder`,
+ archived: () => t`archived`,
+ unarchived: () => t`unarchived`,
+ },
+} as const satisfies Record<ArchivableModel, ArchivableLabels>;
+
+/**
+ * Returns true if the given item can be archived and is writable.
+ */
+export function canArchive(item: ArchivableItem): boolean {
+ return item.model in LABELS && item.can_write !== false;
+}
+
+export type ArchiveOptions = {
+ notify?: boolean;
+};
+
+export function useSetArchive() {
+ const dispatch = useDispatch();
+ const [updateCard] = useUpdateCardMutation();
+ const [updateDashboard] = useUpdateDashboardMutation();
+ const [updateCollection] = useUpdateCollectionMutation();
+ const [updateDocument] = useUpdateDocumentMutation();
+ const [updateAction] = useUpdateActionMutation();
+ const [updateSegment] = useUpdateSegmentMutation();
+ const [updateTimeline] = useUpdateTimelineMutation();
+ const [updateTimelineEvent] = useUpdateTimelineEventMutation();
+ const [updateSubscription] = useUpdateSubscriptionMutation();
+ const [updateSnippet] = useUpdateSnippetMutation();
+
+ const setArchived = useCallback(
+ (item: ArchivableItem, archived: boolean) =>
+ match(item)
+ .with(
+ { model: "card" },
+ { model: "dataset" },
+ { model: "metric" },
+ ({ id }) => updateCard({ id, archived }),
+ )
+ .with({ model: "dashboard" }, ({ id }) =>
+ updateDashboard({ id, archived }),
+ )
+ .with(
+ { model: "collection" },
+ { model: "snippet-collection" },
+ ({ id }) => updateCollection({ id, archived }),
+ )
+ .with({ model: "document" }, ({ id }) =>
+ updateDocument({ id, archived }),
+ )
+ .with({ model: "action" }, ({ id }) => updateAction({ id, archived }))
+ .with({ model: "segment" }, ({ id }) =>
+ updateSegment({
+ id,
+ archived,
+ revision_message: archived ? "(Archive)" : "(Unarchive)",
+ }),
+ )
+ .with({ model: "timeline" }, ({ id }) =>
+ updateTimeline({ id, archived, default: false }),
+ )
+ .with({ model: "timeline-event" }, ({ id }) =>
+ updateTimelineEvent({ id, archived }),
+ )
+ .with({ model: "pulse" }, ({ id }) =>
+ updateSubscription({ id, archived }),
+ )
+ .with({ model: "snippet" }, ({ id }) => updateSnippet({ id, archived }))
+ .exhaustive(),
+ [
+ updateCard,
+ updateDashboard,
+ updateCollection,
+ updateDocument,
+ updateAction,
+ updateSegment,
+ updateTimeline,
+ updateTimelineEvent,
+ updateSubscription,
+ updateSnippet,
+ ],
+ );
+
+ return useCallback(
+ async (
+ item: ArchivableItem,
+ archived = true,
+ { notify = true }: ArchiveOptions = {},
+ ) => {
+ if (!canArchive(item)) {
+ throw new Error(
+ `useArchive: cannot archive item with model "${item.model}"`,
+ );
+ }
+
+ await setArchived(item, archived);
+
+ if (notify) {
+ const labels = LABELS[item.model];
+
+ dispatch(
+ addUndo({
+ subject: labels.subject(),
+ verb: archived ? labels.archived() : labels.unarchived(),
+ actions: [() => setArchived(item, !archived)],
+ }),
+ );
+ }
+ },
+ [dispatch, setArchived],
+ );
+}
diff --git a/frontend/src/metabase/dashboard/actions/cards-typed.ts b/frontend/src/metabase/dashboard/actions/cards-typed.ts
index a1711a084ad..0f2fe59444a 100644
--- a/frontend/src/metabase/dashboard/actions/cards-typed.ts
+++ b/frontend/src/metabase/dashboard/actions/cards-typed.ts
@@ -2,6 +2,7 @@ import { createAction } from "@reduxjs/toolkit";
import { t } from "ttag";
import _ from "underscore";
+import { cardApi } from "metabase/api";
import { Questions } from "metabase/entities/questions";
import { loadMetadataForCard } from "metabase/questions/actions";
import { createThunkAction } from "metabase/redux";
@@ -554,13 +555,18 @@ export const trashDashboardQuestion = createThunkAction(
cardId: DashboardCard["card_id"];
}) =>
async (dispatch) => {
+ if (cardId == null) {
+ return;
+ }
await dispatch(
- Questions.actions.setArchived({ id: cardId }, true, {
- notify: {
- action: () =>
- dispatch(undoTrashDashboardQuestion({ dashcardId, cardId })),
- undo: false,
- },
+ cardApi.endpoints.updateCard.initiate({ id: cardId, archived: true }),
+ );
+ dispatch(
+ addUndo({
+ subject: t`question`,
+ verb: t`trashed`,
+ action: () =>
+ dispatch(undoTrashDashboardQuestion({ dashcardId, cardId })),
}),
);
dispatch(removeCardFromDashboard({ dashcardId, cardId }));
@@ -577,13 +583,18 @@ const undoTrashDashboardQuestion = createThunkAction(
cardId: DashboardCard["card_id"];
}) =>
async (dispatch) => {
+ if (cardId == null) {
+ return;
+ }
await dispatch(
- Questions.actions.setArchived({ id: cardId }, false, {
- notify: {
- action: () =>
- dispatch(trashDashboardQuestion({ dashcardId, cardId })),
- undo: false,
- },
+ cardApi.endpoints.updateCard.initiate({ id: cardId, archived: false }),
+ );
+ dispatch(
+ addUndo({
+ subject: t`question`,
+ verb: t`restored`,
+ action: () =>
+ dispatch(trashDashboardQuestion({ dashcardId, cardId })),
}),
);
dispatch(undoRemoveCardFromDashboard({ dashcardId }));
diff --git a/frontend/src/metabase/dashboard/components/DashboardCopyModal.tsx b/frontend/src/metabase/dashboard/components/DashboardCopyModal.tsx
index 4c77054e6df..240b43f10cf 100644
--- a/frontend/src/metabase/dashboard/components/DashboardCopyModal.tsx
+++ b/frontend/src/metabase/dashboard/components/DashboardCopyModal.tsx
@@ -5,12 +5,11 @@ import { replace } from "react-router-redux";
import { t } from "ttag";
import _ from "underscore";
+import { useInitialCollectionId } from "metabase/collections/hooks";
import type { CopyDashboardFormProperties } from "metabase/dashboard/containers/CopyDashboardForm";
-import { Collections } from "metabase/entities/collections";
import EntityCopyModal from "metabase/entities/containers/EntityCopyModal";
import { Dashboards } from "metabase/entities/dashboards";
-import { connect } from "metabase/redux";
-import type { State } from "metabase/redux/store";
+import { connect, useSelector } from "metabase/redux";
import * as Urls from "metabase/urls";
import type { Dashboard } from "metabase-types/api";
@@ -20,29 +19,14 @@ type OwnProps = {
onClose: () => void;
};
-const mapStateToProps = (state: State, props: OwnProps) => {
- const dashboard = getDashboardComplete(state);
- return {
- dashboard,
- initialCollectionId: Collections.selectors.getInitialCollectionId(state, {
- ...props,
- collectionId: dashboard?.collection_id,
- }),
- };
-};
-
const mapDispatchToProps = {
copyDashboard: Dashboards.actions.copy,
onReplaceLocation: replace,
};
-type StateProps = ReturnType<typeof mapStateToProps>;
type DispatchProps = typeof mapDispatchToProps;
-type DashboardCopyModalProps = OwnProps &
- StateProps &
- DispatchProps &
- WithRouterProps;
+type DashboardCopyModalProps = OwnProps & DispatchProps & WithRouterProps;
const getTitle = (
dashboard: Dashboard | null,
@@ -61,10 +45,15 @@ const DashboardCopyModal = ({
onClose,
onReplaceLocation,
copyDashboard,
- dashboard,
- initialCollectionId,
params,
+ location,
}: DashboardCopyModalProps) => {
+ const dashboard = useSelector(getDashboardComplete);
+ const initialCollectionId = useInitialCollectionId({
+ collectionId: dashboard?.collection_id,
+ params,
+ location,
+ });
const [isShallowCopy, setIsShallowCopy] = useState(true);
const dashboardIdFromSlug = Urls.extractEntityId(params?.slug);
@@ -102,5 +91,5 @@ const DashboardCopyModal = ({
export const DashboardCopyModalConnected = _.compose(
withRouter,
- connect(mapStateToProps, mapDispatchToProps),
+ connect(null, mapDispatchToProps),
)(DashboardCopyModal);
diff --git a/frontend/src/metabase/dashboard/components/DashboardSubscriptionsSidebar/DashboardSubscriptionsSidebar.tsx b/frontend/src/metabase/dashboard/components/DashboardSubscriptionsSidebar/DashboardSubscriptionsSidebar.tsx
index 38fc8fdadb1..32f59e3d97c 100644
--- a/frontend/src/metabase/dashboard/components/DashboardSubscriptionsSidebar/DashboardSubscriptionsSidebar.tsx
+++ b/frontend/src/metabase/dashboard/components/DashboardSubscriptionsSidebar/DashboardSubscriptionsSidebar.tsx
@@ -4,6 +4,7 @@ import _ from "underscore";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import type { ScheduleChangeProp } from "metabase/common/components/SchedulePicker";
import { Sidebar } from "metabase/common/components/Sidebar";
+import { useSetArchive } from "metabase/common/hooks";
import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
import { Pulses } from "metabase/entities/pulses";
import {
@@ -124,7 +125,6 @@ const mapDispatchToProps = {
saveEditingPulse,
cancelEditingPulse,
fetchPulseFormInput,
- setPulseArchived: Pulses.actions.setArchived,
testPulse,
};
@@ -159,10 +159,6 @@ interface DashboardSubscriptionsSidebarInnerProps {
cancelEditingPulse: () => void;
pulses?: DashboardSubscription[];
onCancel: () => void;
- setPulseArchived: (
- pulse: DraftDashboardSubscription,
- archived: boolean,
- ) => Promise<void>;
params?: Record<string, string>;
loading?: boolean;
}
@@ -179,9 +175,9 @@ function DashboardSubscriptionsSidebarInner({
cancelEditingPulse: cancelEditing,
pulses,
onCancel,
- setPulseArchived,
loading: isSubscriptionListLoading,
}: DashboardSubscriptionsSidebarInnerProps) {
+ const archive = useSetArchive();
const [editingMode, setEditingMode] = useState<EditingMode>(
EDITING_MODES.LIST_PULSES_OR_NEW_PULSE,
);
@@ -380,7 +376,9 @@ function DashboardSubscriptionsSidebarInner({
);
const handleArchive = useCallback(async () => {
- await setPulseArchived(pulse, true);
+ if (pulse.id != null) {
+ await archive({ id: pulse.id, model: "pulse" }, true);
+ }
if (isEmbeddingSdk() && pulses?.length === 1) {
onCancel();
@@ -388,7 +386,7 @@ function DashboardSubscriptionsSidebarInner({
setEditingMode(EDITING_MODES.LIST_PULSES_OR_NEW_PULSE);
setReturnMode([]);
}
- }, [pulse, pulses, setPulseArchived, onCancel]);
+ }, [pulse.id, pulses, archive, onCancel]);
// Because you can navigate down the sidebar, we need to wrap
// onCancel from props and either call that or reset back a screen
diff --git a/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx b/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx
index e0671dca6e6..7ac7a98d0f4 100644
--- a/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx
+++ b/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx
@@ -2,6 +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 { Bookmarks } from "metabase/entities/bookmarks";
import { Documents } from "metabase/entities/documents";
import { useDispatch, useSelector } from "metabase/redux";
@@ -10,6 +11,7 @@ import { getCurrentDocument } from "../selectors";
export const DocumentArchivedEntityBanner = () => {
const dispatch = useDispatch();
+ const archive = useSetArchive();
const document = useSelector(getCurrentDocument);
if (!document) {
@@ -24,7 +26,7 @@ export const DocumentArchivedEntityBanner = () => {
canRestore={document.can_restore}
canDelete={document.can_delete}
onUnarchive={async () => {
- await dispatch(Documents.actions.setArchived(document, false));
+ await archive({ id: document.id, model: "document" }, false);
await dispatch(Bookmarks.actions.invalidateLists());
}}
onMove={({ id }) =>
diff --git a/frontend/src/metabase/embedding/components/ArchiveButton.tsx b/frontend/src/metabase/embedding/components/ArchiveButton.tsx
index 8617b1dc6da..49325d710d4 100644
--- a/frontend/src/metabase/embedding/components/ArchiveButton.tsx
+++ b/frontend/src/metabase/embedding/components/ArchiveButton.tsx
@@ -3,6 +3,7 @@ import { c, t } from "ttag";
import { useGetCollectionQuery } from "metabase/api";
import { canArchiveItem } from "metabase/collections/utils";
+import { type ArchivableItem, useSetArchive } from "metabase/common/hooks";
import { ActionIcon, Icon, Menu } from "metabase/ui";
import type { CollectionItem } from "metabase-types/api";
@@ -17,9 +18,10 @@ export function ArchiveButton({ item }: ArchiveButtonProps) {
});
const canArchive = collection ? canArchiveItem(item, collection) : false;
const [dropdownOpened, dropdownActions] = useDisclosure();
+ const archive = useSetArchive();
const handleArchive = () => {
- item.setArchived?.(true);
+ archive(item as ArchivableItem, true);
dropdownActions.close();
};
diff --git a/frontend/src/metabase/entities/actions/actions.ts b/frontend/src/metabase/entities/actions/actions.ts
index a1aae995540..4b44d7d4e95 100644
--- a/frontend/src/metabase/entities/actions/actions.ts
+++ b/frontend/src/metabase/entities/actions/actions.ts
@@ -20,7 +20,7 @@ import type {
WritebackQueryAction,
} from "metabase-types/api";
-import { createEntity, entityCompatibleQuery, undo } from "../utils";
+import { createEntity, entityCompatibleQuery } from "../utils";
type BaseCreateActionParams = Pick<
WritebackAction,
@@ -196,12 +196,6 @@ export const Actions = createEntity({
return { id };
},
),
- setArchived: ({ id }: WritebackAction, archived: boolean) =>
- Actions.actions.update(
- { id },
- { archived },
- undo({}, t`action`, archived ? t`archived` : t`unarchived`),
- ),
},
reducer: (state, { type, payload }: { type: string; payload: any }) => {
switch (type) {
diff --git a/frontend/src/metabase/entities/collections/collections.ts b/frontend/src/metabase/entities/collections/collections.ts
index bd5873acc32..6a0886c8de0 100644
--- a/frontend/src/metabase/entities/collections/collections.ts
+++ b/frontend/src/metabase/entities/collections/collections.ts
@@ -28,7 +28,6 @@ import type {
import { createEntity, entityCompatibleQuery, undo } from "../utils";
import getExpandedCollectionsById from "./getExpandedCollectionsById";
-import getInitialCollectionId from "./getInitialCollectionId";
import { getCollectionType } from "./utils";
const listCollectionsTree = (
@@ -109,17 +108,6 @@ export const Collections = createEntity({
},
objectActions: {
- setArchived: (
- { id }: Collection,
- archived: boolean,
- opts: Record<string, unknown>,
- ) =>
- Collections.actions.update(
- { id },
- { archived },
- undo(opts, t`collection`, archived ? t`trashed` : t`restored`),
- ),
-
setCollection: (
{ id }: Collection,
collection: Collection,
@@ -153,7 +141,6 @@ export const Collections = createEntity({
collectionFilter,
),
),
- getInitialCollectionId,
},
getAnalyticsMetadata(
diff --git a/frontend/src/metabase/entities/collections/getInitialCollectionId.ts b/frontend/src/metabase/entities/collections/getInitialCollectionId.ts
deleted file mode 100644
index e2c22af9491..00000000000
--- a/frontend/src/metabase/entities/collections/getInitialCollectionId.ts
+++ /dev/null
@@ -1,87 +0,0 @@
-import { createSelector } from "@reduxjs/toolkit";
-import type { Location } from "history";
-
-import {
- canonicalCollectionId,
- isLibraryCollection,
- isRootTrashCollection,
-} from "metabase/collections/utils";
-import type { State } from "metabase/redux/store";
-import { getUserPersonalCollectionId } from "metabase/selectors/user";
-import * as Urls from "metabase/urls/collections";
-import type { Collection, CollectionId } from "metabase-types/api";
-
-import { ROOT_COLLECTION } from "./constants";
-
-type Props = {
- collectionId?: Collection["id"];
- location?: Location;
- params?: { collectionId?: Collection["id"]; slug?: string };
-};
-
-function byCollectionIdProp(state: State, { collectionId }: Props) {
- return collectionId;
-}
-
-function byCollectionIdNavParam(state: State, { params }: Props) {
- return params && params.collectionId;
-}
-
-function byCollectionUrlId(state: State, { params, location }: Props) {
- const isCollectionPath =
- params &&
- params.slug &&
- location &&
- Urls.isCollectionPath(location.pathname);
- return isCollectionPath && Urls.extractCollectionId(params.slug);
-}
-
-function byCollectionQueryParameter(state: State, { location }: Props) {
- return location && location.query && location.query.collectionId;
-}
-
-const getInitialCollectionId = createSelector(
- [
- (state) => {
- const collections = state.entities.collections || {};
- return collections as Record<CollectionId, Collection>;
- },
- getUserPersonalCollectionId,
-
- // these are listed in order of priority
- byCollectionIdProp,
- byCollectionIdNavParam,
- byCollectionUrlId,
- byCollectionQueryParameter, // used by new model flow
- ],
- (collections, personalCollectionId, ...collectionIds) => {
- const rootCollectionId = ROOT_COLLECTION.id as CollectionId;
- const validCollectionIds = collectionIds
- .filter((id) => !isRootTrashCollection(collections[id as CollectionId]))
- .concat(rootCollectionId) as CollectionId[];
-
- if (personalCollectionId) {
- validCollectionIds.push(personalCollectionId);
- }
-
- for (const collectionId of validCollectionIds) {
- const collection = collections[collectionId];
- if (
- collection != null &&
- collection.can_write &&
- !isLibraryCollection(collection)
- ) {
- return canonicalCollectionId(collectionId);
- }
- }
-
- const rootCollection = collections[rootCollectionId];
-
- return rootCollection?.can_write
- ? canonicalCollectionId(rootCollectionId)
- : canonicalCollectionId(personalCollectionId);
- },
-);
-
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default getInitialCollectionId;
diff --git a/frontend/src/metabase/entities/collections/tests/selectors.unit.spec.js b/frontend/src/metabase/entities/collections/tests/selectors.unit.spec.js
deleted file mode 100644
index f230156c43f..00000000000
--- a/frontend/src/metabase/entities/collections/tests/selectors.unit.spec.js
+++ /dev/null
@@ -1,236 +0,0 @@
-import { Collections } from "metabase/entities/collections";
-import { ROOT_COLLECTION } from "metabase/entities/collections/constants";
-
-describe("Collection selectors", () => {
- const CANONICAL_ROOT_COLLECTION_ID = null;
-
- const PERSONAL_COLLECTION = {
- id: 1,
- name: "My personal collection",
- can_write: true,
- };
-
- const TEST_COLLECTION = {
- id: 2,
- name: "Writable Collection",
- can_write: true,
- };
-
- const TEST_COLLECTION_2 = {
- id: 3,
- name: "One More Writable Collection",
- can_write: true,
- };
-
- const TEST_READ_ONLY_COLLECTION = {
- id: 4,
- name: "Read-only Collection",
- can_write: false,
- };
-
- const DEFAULT_COLLECTIONS = {
- [TEST_COLLECTION.id]: TEST_COLLECTION,
- [TEST_COLLECTION_2.id]: TEST_COLLECTION_2,
- [TEST_READ_ONLY_COLLECTION.id]: TEST_READ_ONLY_COLLECTION,
- };
-
- function getReduxState({
- isAdmin = false,
- collections = DEFAULT_COLLECTIONS,
- } = {}) {
- return {
- currentUser: {
- personal_collection_id: PERSONAL_COLLECTION.id,
- },
- entities: {
- collections: {
- root: {
- id: "root",
- name: "Our analytics",
- can_write: isAdmin,
- },
- [PERSONAL_COLLECTION.id]: PERSONAL_COLLECTION,
- ...collections,
- },
- },
- };
- }
-
- describe("getInitialCollectionId", () => {
- const { getInitialCollectionId } = Collections.selectors;
- const state = getReduxState();
-
- it("suggests direct collectionId prop", () => {
- const props = { collectionId: TEST_COLLECTION.id };
- expect(getInitialCollectionId(state, props)).toBe(TEST_COLLECTION.id);
- });
-
- it("suggests collectionId navigation parameter", () => {
- const props = {
- params: {
- collectionId: TEST_COLLECTION.id,
- },
- };
- expect(getInitialCollectionId(state, props)).toBe(TEST_COLLECTION.id);
- });
-
- it("suggests id from collection URL slug", () => {
- const slug = `${TEST_COLLECTION.id}-writable-collection`;
- const props = {
- params: {
- slug,
- },
- location: {
- pathname: `/collection/${slug}`,
- },
- };
- expect(getInitialCollectionId(state, props)).toBe(TEST_COLLECTION.id);
- });
-
- it("suggests collectionId query parameter", () => {
- const props = {
- location: {
- query: {
- collectionId: TEST_COLLECTION.id,
- },
- },
- };
- expect(getInitialCollectionId(state, props)).toBe(TEST_COLLECTION.id);
- });
-
- it("fallbacks to root collection for admin users if can't suggest an id from props", () => {
- const adminState = getReduxState({ isAdmin: true });
- const props = {};
- expect(getInitialCollectionId(adminState, props)).toBe(
- CANONICAL_ROOT_COLLECTION_ID,
- );
- });
-
- it("fallbacks to personal collection for non-admin users if can't suggest an id from props", () => {
- const props = {};
- expect(getInitialCollectionId(state, props)).toBe(PERSONAL_COLLECTION.id);
- });
-
- it("does not use URL slug if it's not collection URL", () => {
- const slug = `5-dashboard`;
- const props = {
- params: {
- slug,
- },
- location: {
- pathname: `/dashboard/${slug}`,
- },
- };
- expect(getInitialCollectionId(state, props)).toBe(PERSONAL_COLLECTION.id);
- });
-
- describe("order priority", () => {
- it("prioritizes direct collectionId prop", () => {
- const props = {
- collectionId: TEST_COLLECTION.id,
- params: {
- collectionId: TEST_COLLECTION_2.id,
- slug: `${TEST_COLLECTION_2.id}-slug`,
- },
- location: {
- pathname: `/collection/${TEST_COLLECTION_2.id}-slug`,
- query: {
- collectionId: TEST_COLLECTION_2.id,
- },
- },
- };
- expect(getInitialCollectionId(state, props)).toBe(TEST_COLLECTION.id);
- });
-
- it("prioritizes collectionId navigation param", () => {
- const props = {
- params: {
- collectionId: TEST_COLLECTION.id,
- slug: `${TEST_COLLECTION_2.id}-slug`,
- },
- location: {
- pathname: `/collection/${TEST_COLLECTION_2.id}-slug`,
- query: {
- collectionId: TEST_COLLECTION_2.id,
- },
- },
- };
- expect(getInitialCollectionId(state, props)).toBe(TEST_COLLECTION.id);
- });
-
- it("prioritizes id from a URL slug", () => {
- const props = {
- params: {
- slug: `${TEST_COLLECTION.id}-slug`,
- },
- location: {
- pathname: `/collection/${TEST_COLLECTION.id}-slug`,
- query: {
- collectionId: TEST_COLLECTION_2.id,
- },
- },
- };
- expect(getInitialCollectionId(state, props)).toBe(TEST_COLLECTION.id);
- });
- });
-
- describe("permissions", () => {
- it("does not suggest a read-only collection", () => {
- const props = {
- collectionId: TEST_READ_ONLY_COLLECTION.id,
- params: {
- collectionId: TEST_READ_ONLY_COLLECTION.id,
- slug: `${TEST_READ_ONLY_COLLECTION.id}-slug`,
- },
- location: {
- pathname: `/collection/${TEST_READ_ONLY_COLLECTION.id}-slug`,
- query: {
- collectionId: TEST_READ_ONLY_COLLECTION.id,
- },
- },
- };
- expect(getInitialCollectionId(state, props)).toBe(
- PERSONAL_COLLECTION.id,
- );
- });
-
- it("does not suggest a read-only root collection when others collections permissions had not been loaded yet", () => {
- const { can_write, ...personalCollectionWithoutPermissionsLoaded } =
- PERSONAL_COLLECTION;
-
- const state = getReduxState({
- collections: {
- [PERSONAL_COLLECTION.id]:
- personalCollectionWithoutPermissionsLoaded,
- },
- });
- const props = {
- collectionId: ROOT_COLLECTION.id,
- params: {
- collectionId: CANONICAL_ROOT_COLLECTION_ID,
- slug: ROOT_COLLECTION.id,
- },
- location: {
- pathname: `/collection/${ROOT_COLLECTION.id}`,
- query: {
- collectionId: ROOT_COLLECTION.id,
- },
- },
- };
- expect(getInitialCollectionId(state, props)).toBe(
- PERSONAL_COLLECTION.id,
- );
- });
-
- it("picks writable collection even if read-only is prior", () => {
- const props = {
- collectionId: TEST_READ_ONLY_COLLECTION.id,
- params: {
- collectionId: TEST_COLLECTION.id,
- },
- };
- expect(getInitialCollectionId(state, props)).toBe(TEST_COLLECTION.id);
- });
- });
- });
-});
diff --git a/frontend/src/metabase/entities/dashboards.js b/frontend/src/metabase/entities/dashboards.js
index 983e6309729..7db8853e0a8 100644
--- a/frontend/src/metabase/entities/dashboards.js
+++ b/frontend/src/metabase/entities/dashboards.js
@@ -91,13 +91,6 @@ export const Dashboards = createEntity({
},
objectActions: {
- setArchived: ({ id }, archived, opts) =>
- Dashboards.actions.update(
- { id },
- { archived },
- undo(opts, t`dashboard`, archived ? t`trashed` : t`restored`),
- ),
-
setCollection: ({ id }, collection, opts) =>
Dashboards.actions.update(
{ id },
diff --git a/frontend/src/metabase/entities/documents.ts b/frontend/src/metabase/entities/documents.ts
index e9756a0abf6..ae2531760c3 100644
--- a/frontend/src/metabase/entities/documents.ts
+++ b/frontend/src/metabase/entities/documents.ts
@@ -70,13 +70,6 @@ export const Documents = createEntity({
},
objectActions: {
- setArchived: ({ id }: Document, archived: boolean) =>
- Documents.actions.update(
- { id },
- { archived },
- undo({}, t`document`, archived ? t`trashed` : t`restored`),
- ),
-
setCollection: (
{ id }: Document,
collection: Pick<Collection, "type" | "id">,
diff --git a/frontend/src/metabase/entities/pulses.js b/frontend/src/metabase/entities/pulses.js
index ddd6ee72d8d..a77d4347ee3 100644
--- a/frontend/src/metabase/entities/pulses.js
+++ b/frontend/src/metabase/entities/pulses.js
@@ -1,5 +1,3 @@
-import { t } from "ttag";
-
import {
subscriptionApi,
useGetSubscriptionQuery,
@@ -7,7 +5,7 @@ import {
} from "metabase/api";
import { getCollectionType } from "metabase/entities/collections/utils";
-import { createEntity, entityCompatibleQuery, undo } from "./utils";
+import { createEntity, entityCompatibleQuery } from "./utils";
/**
* @deprecated use "metabase/api" instead
@@ -54,16 +52,6 @@ export const Pulses = createEntity({
},
},
- objectActions: {
- setArchived: ({ id }, archived, opts) => {
- return Pulses.actions.update(
- { id },
- { archived },
- undo(opts, t`subscription`, archived ? t`deleted` : t`restored`),
- );
- },
- },
-
objectSelectors: {
getName: (pulse) => pulse && pulse.name,
},
diff --git a/frontend/src/metabase/entities/questions.js b/frontend/src/metabase/entities/questions.js
index cb9e5f88e40..44c5b43efac 100644
--- a/frontend/src/metabase/entities/questions.js
+++ b/frontend/src/metabase/entities/questions.js
@@ -75,13 +75,6 @@ export const Questions = createEntity({
},
objectActions: {
- setArchived: (card, archived, opts) =>
- Questions.actions.update(
- { id: card.id },
- { archived },
- undo(opts, getLabel(card), archived ? t`trashed` : t`restored`),
- ),
-
// 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) => {
diff --git a/frontend/src/metabase/entities/search.js b/frontend/src/metabase/entities/search.js
index 135c013b4f6..394ea993768 100644
--- a/frontend/src/metabase/entities/search.js
+++ b/frontend/src/metabase/entities/search.js
@@ -122,15 +122,6 @@ export const Search = createEntity({
},
objectActions: {
- setArchived: (object, archived) => {
- return (dispatch) => {
- const entity = entityForObject(object);
- return entity
- ? dispatch(entity.actions.setArchived(object, archived))
- : warnEntityAndReturnObject(object);
- };
- },
-
delete: (object) => {
return (dispatch) => {
const entity = entityForObject(object);
diff --git a/frontend/src/metabase/entities/segments.js b/frontend/src/metabase/entities/segments.js
index 914e883603d..aff3057840b 100644
--- a/frontend/src/metabase/entities/segments.js
+++ b/frontend/src/metabase/entities/segments.js
@@ -52,12 +52,6 @@ export const Segments = createEntity({
},
objectActions: {
- setArchived: (
- { id },
- archived,
- { revision_message = archived ? "(Archive)" : "(Unarchive)" } = {},
- ) => Segments.actions.update({ id }, { archived, revision_message }),
-
// NOTE: DELETE not currently implemented
delete: null,
},
diff --git a/frontend/src/metabase/entities/snippet-collections.js b/frontend/src/metabase/entities/snippet-collections.js
index 4661e833860..8d1c66652f2 100644
--- a/frontend/src/metabase/entities/snippet-collections.js
+++ b/frontend/src/metabase/entities/snippet-collections.js
@@ -40,13 +40,6 @@ export const SnippetCollections = createEntity({
),
objectActions: {
- setArchived: ({ id }, archived, opts) =>
- SnippetCollections.actions.update(
- { id },
- { archived },
- undo(opts, "folder", archived ? "archived" : "unarchived"),
- ),
-
setCollection: ({ id }, collection, opts) =>
SnippetCollections.actions.update(
{ id },
diff --git a/frontend/src/metabase/entities/timeline-events.js b/frontend/src/metabase/entities/timeline-events.js
index a6e05aea6ef..67bae5c0d7f 100644
--- a/frontend/src/metabase/entities/timeline-events.js
+++ b/frontend/src/metabase/entities/timeline-events.js
@@ -58,14 +58,6 @@ export const TimelineEvents = createEntity({
undo(opts, t`event`, t`moved`),
);
},
-
- setArchived: ({ id }, archived, opts) => {
- return TimelineEvents.actions.update(
- { id },
- { archived },
- undo(opts, t`event`, archived ? t`archived` : t`unarchived`),
- );
- },
},
});
diff --git a/frontend/src/metabase/entities/timelines.js b/frontend/src/metabase/entities/timelines.js
index a0eb2aea91a..88d1d027ce3 100644
--- a/frontend/src/metabase/entities/timelines.js
+++ b/frontend/src/metabase/entities/timelines.js
@@ -101,14 +101,6 @@ export const Timelines = createEntity({
undo(opts, t`timeline`, t`moved`),
);
},
-
- setArchived: (timeline, archived, opts) => {
- return Timelines.actions.update(
- { id: timeline.id },
- { archived, default: false },
- undo(opts, t`timeline`, archived ? t`archived` : t`unarchived`),
- );
- },
},
reducer: (state = {}, action) => {
diff --git a/frontend/src/metabase/entities/utils.ts b/frontend/src/metabase/entities/utils.ts
index ae14a81850f..b2812a56f11 100644
--- a/frontend/src/metabase/entities/utils.ts
+++ b/frontend/src/metabase/entities/utils.ts
@@ -107,7 +107,6 @@ export type EntitySelectors = {
getFetched: EntitySelector;
getError: EntitySelector;
getListMetadata: EntitySelector;
- getInitialCollectionId: EntitySelector;
getExpandedCollectionsById: EntitySelector;
};
diff --git a/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionDetails.tsx b/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionDetails.tsx
index 918b3613380..0ce9c75ea2c 100644
--- a/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionDetails.tsx
+++ b/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionDetails.tsx
@@ -4,6 +4,7 @@ import _ from "underscore";
import { Button } from "metabase/common/components/Button";
import { Link } from "metabase/common/components/Link";
+import { useSetArchive } from "metabase/common/hooks";
import { useConfirmation } from "metabase/common/hooks/use-confirmation";
import { Actions } from "metabase/entities/actions";
import { Databases } from "metabase/entities/databases";
@@ -42,7 +43,6 @@ interface OwnProps {
interface DispatchProps {
onEnableImplicitActions: () => void;
- onArchiveAction: (action: WritebackAction) => void;
onDeleteAction: (action: WritebackAction) => void;
}
@@ -63,8 +63,6 @@ function mapDispatchToProps(dispatch: Dispatch, { model }: OwnProps) {
return {
onEnableImplicitActions: () =>
dispatch(Actions.actions.enableImplicitActionsForModel(model.id())),
- onArchiveAction: (action: WritebackAction) =>
- dispatch(Actions.objectActions.setArchived(action, true)),
onDeleteAction: (action: WritebackAction) =>
dispatch(Actions.actions.delete(action.id)),
};
@@ -75,9 +73,14 @@ function ModelActionDetails({
actions,
databases,
onEnableImplicitActions,
- onArchiveAction,
onDeleteAction,
}: Props) {
+ const archive = useSetArchive();
+ const onArchiveAction = useCallback(
+ (action: WritebackAction) =>
+ archive({ id: action.id, model: "action" }, true),
+ [archive],
+ );
const { show: askConfirmation, modalContent: confirmationModal } =
useConfirmation();
diff --git a/frontend/src/metabase/nav/containers/AppBar/AppBar.tsx b/frontend/src/metabase/nav/containers/AppBar/AppBar.tsx
index eef425f7fc7..4f2e2189fa6 100644
--- a/frontend/src/metabase/nav/containers/AppBar/AppBar.tsx
+++ b/frontend/src/metabase/nav/containers/AppBar/AppBar.tsx
@@ -1,11 +1,11 @@
import { withRouter } from "react-router";
import _ from "underscore";
+import { useInitialCollectionId } from "metabase/collections/hooks";
import {
getCommentSidebarOpen,
getSidebarOpen,
} from "metabase/documents/selectors";
-import { Collections } from "metabase/entities/collections";
import { getMetabotVisible } from "metabase/metabot/state";
import { connect } from "metabase/redux";
import { closeNavbar, toggleNavbar } from "metabase/redux/app";
@@ -27,10 +27,10 @@ import { getIsEmbeddingIframe } from "metabase/selectors/embed";
import { getUser } from "metabase/selectors/user";
import AppBar from "../../components/AppBar";
+import type { AppBarProps } from "../../components/AppBar/AppBar";
const mapStateToProps = (state: State, props: RouterProps) => ({
currentUser: getUser(state),
- collectionId: Collections.selectors.getInitialCollectionId(state, props),
isNavBarOpen: getIsNavbarOpen(state),
isNavBarEnabled: getIsNavBarEnabled(state, props),
isMetabotVisible: getMetabotVisible(state, "omnibot"),
@@ -52,8 +52,13 @@ const mapDispatchToProps = {
onCloseNavbar: closeNavbar,
};
+function AppBarContainer(props: AppBarProps & RouterProps) {
+ const collectionId = useInitialCollectionId(props) ?? undefined;
+ return <AppBar {...props} collectionId={collectionId} />;
+}
+
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default _.compose(
withRouter,
connect(mapStateToProps, mapDispatchToProps),
-)(AppBar);
+)(AppBarContainer);
diff --git a/frontend/src/metabase/new/components/NewModals/NewModals.tsx b/frontend/src/metabase/new/components/NewModals/NewModals.tsx
index a3ae77ca116..47b87b2dc9b 100644
--- a/frontend/src/metabase/new/components/NewModals/NewModals.tsx
+++ b/frontend/src/metabase/new/components/NewModals/NewModals.tsx
@@ -6,6 +6,7 @@ import { useLocation } from "react-use";
import ActionCreator from "metabase/actions/containers/ActionCreator";
import CreateCollectionModal from "metabase/collections/containers/CreateCollectionModal";
+import { useInitialCollectionId } from "metabase/collections/hooks";
import { CreateDashboardModal } from "metabase/common/CreateDashboard/CreateDashboardModal";
import { Modal } from "metabase/common/components/Modal";
import { UpgradeModal } from "metabase/common/components/upsells/components/UpgradeModal";
@@ -15,7 +16,6 @@ import {
type LegacyStaticEmbeddingModalProps,
} from "metabase/embedding/embedding-iframe-sdk-setup/components/LegacyStaticEmbeddingModal";
import { SdkIframeEmbedSetupModal } from "metabase/embedding/embedding-iframe-sdk-setup/components/SdkIframeEmbedSetupModal";
-import { Collections } from "metabase/entities/collections/collections";
import { PaletteShortcutsModal } from "metabase/palette/components/PaletteShortcutsModal/PaletteShortcutsModal";
import { useRegisterShortcut } from "metabase/palette/hooks/useRegisterShortcut";
import type { SdkIframeEmbedSetupModalProps } from "metabase/plugins";
@@ -31,9 +31,7 @@ export const NewModals = withRouter((props: WithRouterProps) => {
getCurrentOpenModalState,
);
const dispatch = useDispatch();
- const collectionId = useSelector((state) =>
- Collections.selectors.getInitialCollectionId(state, props),
- );
+ const collectionId = useInitialCollectionId(props) ?? undefined;
const handleActionCreated = useCallback(
(action: WritebackAction) => {
diff --git a/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx b/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx
index 317b7a3bb1f..752bca6f7f9 100644
--- a/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx
+++ b/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx
@@ -5,13 +5,13 @@ import { push } from "react-router-redux";
import { useLatest } from "react-use";
import { t } from "ttag";
+import { useInitialCollectionId } from "metabase/collections/hooks";
import {
useDatabaseListQuery,
useSearchListQuery,
} from "metabase/common/hooks";
import { trackMetricCreateStarted } from "metabase/data-studio/analytics";
import { canAccessDataStudio } from "metabase/data-studio/selectors";
-import { Collections } from "metabase/entities/collections/collections";
import { useDispatch, useSelector } from "metabase/redux";
import { openDiagnostics } from "metabase/redux/app";
import type { ModalName } from "metabase/redux/store/modal";
@@ -61,9 +61,7 @@ export const useCommandPaletteBasicActions = ({
...props
}: WithRouterProps & { isLoggedIn: boolean }) => {
const dispatch = useDispatch();
- const collectionId = useSelector((state) =>
- Collections.selectors.getInitialCollectionId(state, props),
- );
+ const collectionId = useInitialCollectionId(props) ?? undefined;
const { data: databases = [] } = useDatabaseListQuery({
enabled: isLoggedIn,
diff --git a/frontend/src/metabase/timelines/collections/containers/EditEventModal/EditEventModal.tsx b/frontend/src/metabase/timelines/collections/containers/EditEventModal/EditEventModal.tsx
index 77c938a77b6..5bc0dc4b63a 100644
--- a/frontend/src/metabase/timelines/collections/containers/EditEventModal/EditEventModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/EditEventModal/EditEventModal.tsx
@@ -1,9 +1,11 @@
+import type { ComponentProps } from "react";
import { push } from "react-router-redux";
import _ from "underscore";
+import { useSetArchive } from "metabase/common/hooks";
import { TimelineEvents } from "metabase/entities/timeline-events";
import { Timelines } from "metabase/entities/timelines";
-import { connect } from "metabase/redux";
+import { connect, useDispatch } from "metabase/redux";
import type { State } from "metabase/redux/store";
import EditEventModal from "metabase/timelines/common/components/EditEventModal";
import * as Urls from "metabase/urls";
@@ -37,17 +39,23 @@ const mapDispatchToProps = (dispatch: any) => ({
dispatch(push(Urls.timelineInCollection(timeline)));
}
},
- onArchive: async (event: TimelineEvent, timeline?: Timeline) => {
- await dispatch(TimelineEvents.actions.setArchived(event, true));
+});
+
+function EditEventModalContainer(props: ComponentProps<typeof EditEventModal>) {
+ const archive = useSetArchive();
+ const dispatch = useDispatch();
+ const onArchive = async (event: TimelineEvent, timeline?: Timeline) => {
+ await archive({ id: event.id, model: "timeline-event" }, true);
if (timeline) {
dispatch(push(Urls.timelineInCollection(timeline)));
}
- },
-});
+ };
+ return <EditEventModal {...props} onArchive={onArchive} />;
+}
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default _.compose(
Timelines.load(timelineProps),
TimelineEvents.load(timelineEventProps),
connect(null, mapDispatchToProps),
-)(EditEventModal);
+)(EditEventModalContainer);
diff --git a/frontend/src/metabase/timelines/collections/containers/EditTimelineModal/EditTimelineModal.tsx b/frontend/src/metabase/timelines/collections/containers/EditTimelineModal/EditTimelineModal.tsx
index c3058d2e3e8..3cf98a62af6 100644
--- a/frontend/src/metabase/timelines/collections/containers/EditTimelineModal/EditTimelineModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/EditTimelineModal/EditTimelineModal.tsx
@@ -1,8 +1,10 @@
+import type { ComponentProps } from "react";
import { push } from "react-router-redux";
import _ from "underscore";
+import { useSetArchive } from "metabase/common/hooks";
import { Timelines } from "metabase/entities/timelines";
-import { connect } from "metabase/redux";
+import { connect, useDispatch } from "metabase/redux";
import type { State } from "metabase/redux/store";
import EditTimelineModal from "metabase/timelines/common/components/EditTimelineModal";
import * as Urls from "metabase/urls";
@@ -27,14 +29,22 @@ const mapDispatchToProps = (dispatch: any) => ({
await dispatch(Timelines.actions.update(timeline));
dispatch(push(Urls.timelineInCollection(timeline)));
},
- onArchive: async (timeline: Timeline) => {
- await dispatch(Timelines.actions.setArchived(timeline, true));
- dispatch(push(Urls.timelinesInCollection(timeline.collection)));
- },
});
+function EditTimelineModalContainer(
+ props: ComponentProps<typeof EditTimelineModal>,
+) {
+ const archive = useSetArchive();
+ const dispatch = useDispatch();
+ const onArchive = async (timeline: Timeline) => {
+ await archive({ id: timeline.id, model: "timeline" }, true);
+ dispatch(push(Urls.timelinesInCollection(timeline.collection)));
+ };
+ return <EditTimelineModal {...props} onArchive={onArchive} />;
+}
+
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default _.compose(
Timelines.load(timelineProps),
connect(null, mapDispatchToProps),
-)(EditTimelineModal);
+)(EditTimelineModalContainer);
diff --git a/frontend/src/metabase/timelines/collections/containers/TimelineArchiveModal/TimelineArchiveModal.tsx b/frontend/src/metabase/timelines/collections/containers/TimelineArchiveModal/TimelineArchiveModal.tsx
index 2c88fccc198..b854369d12f 100644
--- a/frontend/src/metabase/timelines/collections/containers/TimelineArchiveModal/TimelineArchiveModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/TimelineArchiveModal/TimelineArchiveModal.tsx
@@ -1,7 +1,8 @@
+import type { ComponentProps } from "react";
import { push } from "react-router-redux";
import _ from "underscore";
-import { TimelineEvents } from "metabase/entities/timeline-events";
+import { useSetArchive } from "metabase/common/hooks";
import { Timelines } from "metabase/entities/timelines";
import { connect } from "metabase/redux";
import type { State } from "metabase/redux/store";
@@ -28,16 +29,22 @@ const mapStateToProps = () => ({
});
const mapDispatchToProps = (dispatch: any) => ({
- onUnarchive: async (event: TimelineEvent) => {
- await dispatch(TimelineEvents.actions.setArchived(event, false));
- },
onGoBack: (timeline: Timeline) => {
dispatch(push(Urls.timelineInCollection(timeline)));
},
});
+function TimelineArchiveModalContainer(
+ props: ComponentProps<typeof TimelineDetailsModal>,
+) {
+ const archive = useSetArchive();
+ const onUnarchive = (event: TimelineEvent) =>
+ archive({ id: event.id, model: "timeline-event" }, false);
+ return <TimelineDetailsModal {...props} onUnarchive={onUnarchive} />;
+}
+
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default _.compose(
Timelines.load(timelineProps),
connect(mapStateToProps, mapDispatchToProps),
-)(TimelineDetailsModal);
+)(TimelineArchiveModalContainer);
diff --git a/frontend/src/metabase/timelines/collections/containers/TimelineDetailsModal/TimelineDetailsModal.tsx b/frontend/src/metabase/timelines/collections/containers/TimelineDetailsModal/TimelineDetailsModal.tsx
index db9252a2f2f..f20b4e3be4a 100644
--- a/frontend/src/metabase/timelines/collections/containers/TimelineDetailsModal/TimelineDetailsModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/TimelineDetailsModal/TimelineDetailsModal.tsx
@@ -1,7 +1,8 @@
+import type { ComponentProps } from "react";
import { push } from "react-router-redux";
import _ from "underscore";
-import { TimelineEvents } from "metabase/entities/timeline-events";
+import { useSetArchive } from "metabase/common/hooks";
import { Timelines } from "metabase/entities/timelines";
import { connect } from "metabase/redux";
import type { State } from "metabase/redux/store";
@@ -37,17 +38,23 @@ const mapStateToProps = (state: State, props: TimelineDetailsModalProps) => ({
});
const mapDispatchToProps = (dispatch: any) => ({
- onArchive: async (event: TimelineEvent) => {
- await dispatch(TimelineEvents.actions.setArchived(event, true));
- },
onGoBack: (timeline: Timeline) => {
dispatch(push(Urls.timelinesInCollection(timeline.collection)));
},
});
+function TimelineDetailsModalContainer(
+ props: ComponentProps<typeof TimelineDetailsModal>,
+) {
+ const archive = useSetArchive();
+ const onArchive = (event: TimelineEvent) =>
+ archive({ id: event.id, model: "timeline-event" }, true);
+ return <TimelineDetailsModal {...props} onArchive={onArchive} />;
+}
+
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default _.compose(
Timelines.load(timelineProps),
Timelines.loadList(timelinesProps),
connect(mapStateToProps, mapDispatchToProps),
-)(TimelineDetailsModal);
+)(TimelineDetailsModalContainer);
diff --git a/frontend/src/metabase/timelines/collections/containers/TimelineListArchiveModal/TimelineListArchiveModal.tsx b/frontend/src/metabase/timelines/collections/containers/TimelineListArchiveModal/TimelineListArchiveModal.tsx
index 183ceb518dc..621f9760df5 100644
--- a/frontend/src/metabase/timelines/collections/containers/TimelineListArchiveModal/TimelineListArchiveModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/TimelineListArchiveModal/TimelineListArchiveModal.tsx
@@ -1,12 +1,14 @@
+import type { ComponentProps } from "react";
import { push } from "react-router-redux";
import _ from "underscore";
+import { useSetArchive } from "metabase/common/hooks";
import { Collections } from "metabase/entities/collections";
import { Timelines } from "metabase/entities/timelines";
import { connect } from "metabase/redux";
import type { State } from "metabase/redux/store";
import * as Urls from "metabase/urls";
-import type { Collection, TimelineEvent } from "metabase-types/api";
+import type { Collection, Timeline } from "metabase-types/api";
import LoadingAndErrorWrapper from "../../components/LoadingAndErrorWrapper";
import TimelineListModal from "../../components/TimelineListModal";
@@ -36,17 +38,23 @@ const mapStateToProps = () => ({
});
const mapDispatchToProps = (dispatch: any) => ({
- onUnarchive: async (event: TimelineEvent) => {
- await dispatch(Timelines.actions.setArchived(event, false));
- },
onGoBack: (collection: Collection) => {
dispatch(push(Urls.timelinesInCollection(collection)));
},
});
+function TimelineListArchiveModalContainer(
+ props: ComponentProps<typeof TimelineListModal>,
+) {
+ const archive = useSetArchive();
+ const onUnarchive = (timeline: Timeline) =>
+ archive({ id: timeline.id, model: "timeline" }, false);
+ return <TimelineListModal {...props} onUnarchive={onUnarchive} />;
+}
+
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default _.compose(
Timelines.loadList(timelineProps),
Collections.load(collectionProps),
connect(mapStateToProps, mapDispatchToProps),
-)(TimelineListModal);
+)(TimelineListArchiveModalContainer);
diff --git a/frontend/src/metabase/timelines/questions/containers/EditEventModal/EditEventModal.tsx b/frontend/src/metabase/timelines/questions/containers/EditEventModal/EditEventModal.tsx
index d193df9c44e..05cad98599a 100644
--- a/frontend/src/metabase/timelines/questions/containers/EditEventModal/EditEventModal.tsx
+++ b/frontend/src/metabase/timelines/questions/containers/EditEventModal/EditEventModal.tsx
@@ -1,6 +1,8 @@
+import type { ComponentProps } from "react";
import { t } from "ttag";
import _ from "underscore";
+import { useSetArchive } from "metabase/common/hooks";
import { TimelineEvents } from "metabase/entities/timeline-events";
import { connect } from "metabase/redux";
import type { State } from "metabase/redux/store";
@@ -29,13 +31,17 @@ const mapDispatchToProps = (dispatch: any) => ({
await dispatch(TimelineEvents.actions.update(event));
dispatch(addUndo({ message: t`Updated event` }));
},
- onArchive: async (event: TimelineEvent) => {
- await dispatch(TimelineEvents.actions.setArchived(event, true));
- },
});
+function EditEventModalContainer(props: ComponentProps<typeof EditEventModal>) {
+ const archive = useSetArchive();
+ const onArchive = (event: TimelineEvent) =>
+ archive({ id: event.id, model: "timeline-event" }, true);
+ return <EditEventModal {...props} onArchive={onArchive} />;
+}
+
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default _.compose(
TimelineEvents.load(timelineEventProps),
connect(mapStateToProps, mapDispatchToProps),
-)(EditEventModal);
+)(EditEventModalContainer);
diff --git a/frontend/src/metabase/timelines/questions/containers/TimelinePanel/TimelinePanel.tsx b/frontend/src/metabase/timelines/questions/containers/TimelinePanel/TimelinePanel.tsx
index 3a2b62b35ba..a7e98c79af2 100644
--- a/frontend/src/metabase/timelines/questions/containers/TimelinePanel/TimelinePanel.tsx
+++ b/frontend/src/metabase/timelines/questions/containers/TimelinePanel/TimelinePanel.tsx
@@ -1,8 +1,7 @@
-import _ from "underscore";
+import type { ComponentProps } from "react";
+import { useSetArchive } from "metabase/common/hooks";
import { Collections, ROOT_COLLECTION } from "metabase/entities/collections";
-import { TimelineEvents } from "metabase/entities/timeline-events";
-import { connect } from "metabase/redux";
import type { State } from "metabase/redux/store";
import type { TimelineEvent } from "metabase-types/api";
@@ -18,14 +17,12 @@ const collectionProps = {
},
};
-const mapDispatchToProps = (dispatch: any) => ({
- onArchiveEvent: (event: TimelineEvent) => {
- dispatch(TimelineEvents.actions.setArchived(event, true));
- },
-});
+function TimelinePanelContainer(props: ComponentProps<typeof TimelinePanel>) {
+ const archive = useSetArchive();
+ const onArchiveEvent = (event: TimelineEvent) =>
+ archive({ id: event.id, model: "timeline-event" }, true);
+ return <TimelinePanel {...props} onArchiveEvent={onArchiveEvent} />;
+}
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default _.compose(
- Collections.load(collectionProps),
- connect(null, mapDispatchToProps),
-)(TimelinePanel);
+export default Collections.load(collectionProps)(TimelinePanelContainer);