Skip to content

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

Retire redux navigation in favour of useNavigate (#79300)

Romeo Van Snick8d14aa839186
diff --git a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/index.tsx b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/index.tsx
index 4b3d4f30dfd..15ca308311b 100644
--- a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/index.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/index.tsx
@@ -13,7 +13,7 @@ import {
PLUGIN_REDUCERS,
type PermissionOption,
} from "metabase/plugins";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import { hasPremiumFeature } from "metabase-enterprise/settings";
import { DataPermissionValue } from "metabase-types/api";
@@ -138,12 +138,12 @@ export function initializePlugin() {
label: t`Edit Impersonated`,
iconColor: "warning",
icon: "database",
- actionCreator: (entityId, groupId, view) => {
+ onSelect: (entityId, groupId, view) => {
if (entityId == null) {
throw new Error("Impersonation can only be configured for databases");
}
- return push(getEditImpersonationUrl(entityId, groupId, view));
+ navigate(getEditImpersonationUrl(entityId, groupId, view));
},
});
diff --git a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/reducer.ts b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/reducer.ts
index 8776637390b..36cb558322b 100644
--- a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/reducer.ts
+++ b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/reducer.ts
@@ -10,7 +10,7 @@ import {
DATABASES_BASE_PATH,
GROUPS_BASE_PATH,
} from "metabase/admin/permissions/utils/urls";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import {
DataPermission,
DataPermissionValue,
@@ -25,10 +25,10 @@ export const getImpersonatedPostAction = (
view: "database" | "group",
) =>
view === "database"
- ? push(
+ ? navigate(
`${DATABASES_BASE_PATH}/${entityId.databaseId}/impersonated/group/${groupId}`,
)
- : push(
+ : navigate(
`${GROUPS_BASE_PATH}/${groupId}/impersonated/database/${entityId.databaseId}`,
);
diff --git a/enterprise/frontend/src/metabase-enterprise/ai-controls/components/RequireMetabotConfigured.tsx b/enterprise/frontend/src/metabase-enterprise/ai-controls/components/RequireMetabotConfigured.tsx
index 5051898ebee..942055bb165 100644
--- a/enterprise/frontend/src/metabase-enterprise/ai-controls/components/RequireMetabotConfigured.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/ai-controls/components/RequireMetabotConfigured.tsx
@@ -1,7 +1,6 @@
import { useLayoutEffect } from "react";
-import { useDispatch } from "metabase/redux";
-import { Outlet, replace } from "metabase/router";
+import { Outlet, useNavigate } from "metabase/router";
import { useSetting } from "metabase/settings";
const FALLBACK_PATH = "/admin/metabot/";
@@ -13,13 +12,13 @@ export const RequireMetabotConfigured = ({
children?: React.ReactNode;
}) => {
const isConfigured = useSetting("llm-metabot-configured?");
- const dispatch = useDispatch();
+ const navigate = useNavigate();
useLayoutEffect(() => {
if (!isConfigured) {
- dispatch(replace(FALLBACK_PATH));
+ navigate(FALLBACK_PATH, { replace: true });
}
- }, [isConfigured, dispatch]);
+ }, [isConfigured, navigate]);
if (!isConfigured) {
return null;
diff --git a/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.ts b/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.ts
index 88a1467a703..6c5041bf0f8 100644
--- a/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.ts
+++ b/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.ts
@@ -4,7 +4,7 @@ import Cookies from "js-cookie";
import { logout, refreshSession } from "metabase/redux/auth";
import type { State } from "metabase/redux/store";
-import { replace } from "metabase/router";
+import { navigate } from "metabase/router";
import { isSameOrSiteUrlOrigin } from "metabase/utils/dom";
export const SESSION_KEY = "metabase.TIMEOUT";
@@ -54,7 +54,7 @@ export const createSessionMiddleware = (
const redirectUrl = getRedirectUrl();
if (wasLoggedIn && !!redirectUrl && !preventImmedidateRedirect()) {
- store.dispatch(replace(redirectUrl));
+ navigate(redirectUrl, { replace: true });
}
intervalId = setInterval(async () => {
@@ -67,7 +67,7 @@ export const createSessionMiddleware = (
await store.dispatch(refreshSession())?.unwrap();
if (redirectUrl !== null) {
- store.dispatch(replace(redirectUrl));
+ navigate(redirectUrl, { replace: true });
}
} else {
const url = location.pathname + location.search + location.hash;
diff --git a/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.unit.spec.ts b/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.unit.spec.ts
index 8bcd7c1f94e..73a4fec7c41 100644
--- a/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.unit.spec.ts
+++ b/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.unit.spec.ts
@@ -1,7 +1,7 @@
import Cookie from "js-cookie";
import { logout, refreshSession } from "metabase/redux/auth";
-import { replace } from "metabase/router";
+import { navigate } from "metabase/router";
import {
COOKIE_POOLING_TIMEOUT,
@@ -16,7 +16,7 @@ jest.mock("metabase/redux/auth", () => ({
}));
jest.mock("metabase/router", () => ({
...jest.requireActual("metabase/router"),
- replace: jest.fn(),
+ navigate: jest.fn(),
}));
const actionStub = { type: "ANY_ACTION" };
@@ -134,7 +134,7 @@ describe("createSessionMiddleware", () => {
jest.advanceTimersByTime(COOKIE_POOLING_TIMEOUT);
expect(dispatchMock).not.toHaveBeenCalled();
- expect(replace).not.toHaveBeenCalled();
+ expect(navigate).not.toHaveBeenCalled();
});
it("should redirect to the redirectUrl", async () => {
@@ -147,13 +147,14 @@ describe("createSessionMiddleware", () => {
.mockImplementationOnce(() => "alive")
.mockImplementationOnce(() => "alive");
- const { handleAction, dispatchMock } = setup();
+ const { handleAction } = setup();
handleAction(actionStub);
jest.advanceTimersByTime(COOKIE_POOLING_TIMEOUT);
- expect(dispatchMock).toHaveBeenCalled();
- expect(replace).toHaveBeenCalledWith("/question/1?query=5#hash");
+ expect(navigate).toHaveBeenCalledWith("/question/1?query=5#hash", {
+ replace: true,
+ });
});
});
@@ -182,7 +183,9 @@ describe("createSessionMiddleware", () => {
// wait for the refreshSession to resolve
await Promise.resolve();
- expect(replace).toHaveBeenCalledWith("/question/1?query=5#hash");
+ expect(navigate).toHaveBeenCalledWith("/question/1?query=5#hash", {
+ replace: true,
+ });
});
});
});
diff --git a/enterprise/frontend/src/metabase-enterprise/custom_viz/components/CustomVizPage.tsx b/enterprise/frontend/src/metabase-enterprise/custom_viz/components/CustomVizPage.tsx
index 2997a968e4f..2d61cb0c752 100644
--- a/enterprise/frontend/src/metabase-enterprise/custom_viz/components/CustomVizPage.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/custom_viz/components/CustomVizPage.tsx
@@ -14,8 +14,7 @@ import {
FormProvider,
FormSubmitButton,
} from "metabase/forms";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
Box,
Button,
@@ -74,7 +73,7 @@ const validationSchema: Yup.SchemaOf<FormState> = Yup.object({
});
export function CustomVizPage({ params }: Props) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const pluginId = params?.id ? parseInt(params.id, 10) : undefined;
const { data: plugins } = useListAllCustomVizPluginsQuery();
const plugin = pluginId ? plugins?.find((p) => p.id === pluginId) : undefined;
@@ -112,29 +111,29 @@ export function CustomVizPage({ params }: Props) {
throw error;
}
}
- dispatch(push(Urls.customViz()));
+ navigate(Urls.customViz());
},
- [createPlugin, replaceBundle, plugin, isEdit, dispatch],
+ [createPlugin, replaceBundle, plugin, isEdit, navigate],
);
const handleCancel = useCallback(() => {
- dispatch(push(Urls.customViz()));
- }, [dispatch]);
+ navigate(Urls.customViz());
+ }, [navigate]);
const shouldRedirectToList = isEdit && !plugin && !!plugins;
const shouldRedirectToDev = isEdit && !!plugin?.dev_only;
useEffect(() => {
if (shouldRedirectToList) {
- dispatch(push(Urls.customViz()));
+ navigate(Urls.customViz());
}
- }, [shouldRedirectToList, dispatch]);
+ }, [shouldRedirectToList, navigate]);
useEffect(() => {
if (shouldRedirectToDev) {
- dispatch(push(Urls.customVizDev()));
+ navigate(Urls.customVizDev());
}
- }, [shouldRedirectToDev, dispatch]);
+ }, [shouldRedirectToDev, navigate]);
if (shouldRedirectToList || shouldRedirectToDev) {
return null;
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/LibraryPage/components/CreateMenu.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/library/LibraryPage/components/CreateMenu.tsx
index eb21a76cfa9..ec632277f8b 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/LibraryPage/components/CreateMenu.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/LibraryPage/components/CreateMenu.tsx
@@ -6,7 +6,7 @@ import { trackMetricCreateStarted } from "metabase/common/data-studio/analytics"
import { PLUGIN_SNIPPET_FOLDERS } from "metabase/plugins";
import { useDispatch, useSelector } from "metabase/redux";
import { setOpenModalWithProps } from "metabase/redux/ui";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
canUserCreateNativeQueries,
canUserCreateQueries,
@@ -30,6 +30,7 @@ export const CreateMenu = ({
canWriteToDataCollection?: boolean;
}) => {
const dispatch = useDispatch();
+ const navigate = useNavigate();
const [
showPublishTableModal,
{ close: closePublishTableModal, open: openPublishTableModal },
@@ -140,7 +141,7 @@ export const CreateMenu = ({
<PublishTableModal
opened={showPublishTableModal}
onClose={closePublishTableModal}
- onPublished={(table) => dispatch(push(Urls.dataStudioTable(table.id)))}
+ onPublished={(table) => navigate(Urls.dataStudioTable(table.id))}
/>
</>
);
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/components/PublishTablesModal/PublishTablesModal.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/library/components/PublishTablesModal/PublishTablesModal.tsx
index 972ebbe7dd3..727d1c599a2 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/components/PublishTablesModal/PublishTablesModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/components/PublishTablesModal/PublishTablesModal.tsx
@@ -12,8 +12,7 @@ import {
} from "metabase/forms";
import { useMetadataToasts } from "metabase/metadata/hooks";
import { PLUGIN_LIBRARY, type PublishTablesModalProps } from "metabase/plugins";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
Box,
Button,
@@ -108,7 +107,7 @@ function ModalBody({
});
const [publishTables] = usePublishTablesMutation();
const { sendSuccessToast } = useMetadataToasts();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const { data: dataCollection, isLoading: isLoadingDataCollection } =
PLUGIN_LIBRARY.useGetLibraryChildCollectionByType({
type: "library-data",
@@ -136,7 +135,7 @@ function ModalBody({
if (collection != null) {
sendSuccessToast(
t`Published`,
- () => dispatch(push(Urls.dataStudioLibrary())),
+ () => navigate(Urls.dataStudioLibrary()),
t`Go to ${collection.name}`,
);
} else {
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/snippets/components/SnippetMoreMenu/SnippetModal/ArchiveSnippetModal.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/library/snippets/components/SnippetMoreMenu/SnippetModal/ArchiveSnippetModal.tsx
index 4eb7495d777..75ff64c6d4f 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/snippets/components/SnippetMoreMenu/SnippetModal/ArchiveSnippetModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/snippets/components/SnippetMoreMenu/SnippetModal/ArchiveSnippetModal.tsx
@@ -4,8 +4,7 @@ import { useUpdateSnippetMutation } from "metabase/api";
import { getErrorMessage } from "metabase/api/utils";
import { Link } from "metabase/common/components/Link";
import { useToast } from "metabase/common/hooks";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Button, Group, Modal, Stack, Text } from "metabase/ui";
import * as Urls from "metabase/urls";
import type { NativeQuerySnippet } from "metabase-types/api";
@@ -17,7 +16,7 @@ type ArchiveSnippetModalProps = {
export function ArchiveSnippetModal(props: ArchiveSnippetModalProps) {
const { snippet, onClose } = props;
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [updateSnippet, { isLoading }] = useUpdateSnippetMutation();
const [sendToast] = useToast();
@@ -49,7 +48,7 @@ export function ArchiveSnippetModal(props: ArchiveSnippetModalProps) {
),
icon: "check",
});
- dispatch(push(Urls.dataStudioLibrary()));
+ navigate(Urls.dataStudioLibrary());
onClose();
}
};
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/snippets/pages/NewSnippetPage/NewSnippetPage.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/library/snippets/pages/NewSnippetPage/NewSnippetPage.tsx
index f3f8da7a3f1..9499120ff5b 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/snippets/pages/NewSnippetPage/NewSnippetPage.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/snippets/pages/NewSnippetPage/NewSnippetPage.tsx
@@ -18,8 +18,8 @@ import {
} from "metabase/common/data-studio/components/PaneHeader";
import { useToast } from "metabase/common/hooks";
import { PLUGIN_REMOTE_SYNC, PLUGIN_SNIPPET_FOLDERS } from "metabase/plugins";
-import { useDispatch, useSelector } from "metabase/redux";
-import { push } from "metabase/router";
+import { useSelector } from "metabase/redux";
+import { useNavigate } from "metabase/router";
import { Card, Flex, Stack } from "metabase/ui";
import * as Urls from "metabase/urls";
import type {
@@ -32,7 +32,7 @@ import S from "./NewSnippetPage.module.css";
const SNIPPET_NAME_MAX_LENGTH = 254;
export function NewSnippetPage() {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [sendToast] = useToast();
const [name, setName] = useState(t`New SQL snippet`);
const [description, setDescription] = useState("");
@@ -69,9 +69,9 @@ export function NewSnippetPage() {
useEffect(() => {
if (savedSnippet) {
- dispatch(push(Urls.dataStudioSnippet(savedSnippet.id)));
+ navigate(Urls.dataStudioSnippet(savedSnippet.id));
}
- }, [savedSnippet, dispatch]);
+ }, [savedSnippet, navigate]);
const handleSave = async () => {
if (!PLUGIN_SNIPPET_FOLDERS.isEnabled) {
@@ -82,7 +82,7 @@ export function NewSnippetPage() {
};
const handleCancel = () => {
- dispatch(push(Urls.dataStudioLibrary()));
+ navigate(Urls.dataStudioLibrary());
};
const handleCollectionSelected = async (
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/components/TableHeader/TableMoreMenu/TableMoreMenu.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/components/TableHeader/TableMoreMenu/TableMoreMenu.tsx
index c07333866a4..44a1b31a3a7 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/components/TableHeader/TableMoreMenu/TableMoreMenu.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/components/TableHeader/TableMoreMenu/TableMoreMenu.tsx
@@ -7,7 +7,7 @@ import { CollectionPickerModal } from "metabase/common/components/Pickers";
import { useSetCollection } from "metabase/common/hooks/use-set-collection";
import { PLUGIN_LIBRARY, PLUGIN_REMOTE_SYNC } from "metabase/plugins";
import { useDispatch, useSelector } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { ActionIcon, Box, FixedSizeIcon, Icon, Menu } from "metabase/ui";
import * as Urls from "metabase/urls";
import type { CollectionId, CollectionItem, Table } from "metabase-types/api";
@@ -23,6 +23,7 @@ export type TableMoreMenuProps = {
export function TableMoreMenu({ table, onMoved }: TableMoreMenuProps) {
const dispatch = useDispatch();
+ const navigate = useNavigate();
const [modalType, setModalType] = useState<TableModalType>();
const setCollection = useSetCollection();
const remoteSyncReadOnly = useSelector(
@@ -33,7 +34,7 @@ export function TableMoreMenu({ table, onMoved }: TableMoreMenuProps) {
const handleUnpublish = () => {
setModalType(undefined);
- dispatch(push(Urls.dataStudioLibrary()));
+ navigate(Urls.dataStudioLibrary());
};
const handleMove = async (newCollection: { id: CollectionId }) => {
diff --git a/enterprise/frontend/src/metabase-enterprise/database_routing/DestinationDatabaseConnectionModal/DestinationDatabaseConnectionModal.tsx b/enterprise/frontend/src/metabase-enterprise/database_routing/DestinationDatabaseConnectionModal/DestinationDatabaseConnectionModal.tsx
index 18776228774..74a3b6a4478 100644
--- a/enterprise/frontend/src/metabase-enterprise/database_routing/DestinationDatabaseConnectionModal/DestinationDatabaseConnectionModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/database_routing/DestinationDatabaseConnectionModal/DestinationDatabaseConnectionModal.tsx
@@ -9,7 +9,7 @@ import { useDocsUrl } from "metabase/common/hooks";
import { usePageTitle } from "metabase/hooks/use-page-title";
import { useDispatch } from "metabase/redux";
import { addUndo } from "metabase/redux/undo";
-import { push, replace, useParams } from "metabase/router";
+import { useNavigate, useParams } from "metabase/router";
import { Flex, Icon, Modal, Text } from "metabase/ui";
import * as Urls from "metabase/urls";
import { useCreateDestinationDatabaseMutation } from "metabase-enterprise/api";
@@ -26,6 +26,7 @@ export const DestinationDatabaseConnectionModal = () => {
destinationDatabaseId: string;
}>();
const dispatch = useDispatch();
+ const navigate = useNavigate();
// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- Admin settings
const { url: docsUrl } = useDocsUrl("permissions/database-routing");
@@ -56,9 +57,9 @@ export const DestinationDatabaseConnectionModal = () => {
const handleCloseModal = (method = "push") => {
const dbId = parseInt(databaseId, 10);
if (method === "push") {
- dispatch(push(Urls.viewDatabase(dbId)));
+ navigate(Urls.viewDatabase(dbId));
} else {
- dispatch(replace(Urls.viewDatabase(dbId)));
+ navigate(Urls.viewDatabase(dbId), { replace: true });
}
};
diff --git a/enterprise/frontend/src/metabase-enterprise/database_routing/DestinationDatabasesModal/DestinationDatabasesModal.tsx b/enterprise/frontend/src/metabase-enterprise/database_routing/DestinationDatabasesModal/DestinationDatabasesModal.tsx
index 2a8be00b4ca..7544337005a 100644
--- a/enterprise/frontend/src/metabase-enterprise/database_routing/DestinationDatabasesModal/DestinationDatabasesModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/database_routing/DestinationDatabasesModal/DestinationDatabasesModal.tsx
@@ -1,7 +1,6 @@
import { t } from "ttag";
-import { useDispatch } from "metabase/redux";
-import { push, useParams } from "metabase/router";
+import { useNavigate, useParams } from "metabase/router";
import { Modal } from "metabase/ui";
import * as Urls from "metabase/urls";
@@ -13,9 +12,9 @@ export const DestinationDatabasesModal = () => {
const params = useParams<{ databaseId: string }>();
const primaryDbId = parseInt(params.databaseId ?? "", 10);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const handleCloseModal = () => {
- dispatch(push(Urls.viewDatabase(primaryDbId)));
+ navigate(Urls.viewDatabase(primaryDbId));
};
return (
diff --git a/enterprise/frontend/src/metabase-enterprise/database_routing/RemoveDestinationDatabaseModal.tsx b/enterprise/frontend/src/metabase-enterprise/database_routing/RemoveDestinationDatabaseModal.tsx
index 1f1f6e21212..12def400ad7 100644
--- a/enterprise/frontend/src/metabase-enterprise/database_routing/RemoveDestinationDatabaseModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/database_routing/RemoveDestinationDatabaseModal.tsx
@@ -3,8 +3,7 @@ import { t } from "ttag";
import { DeleteDatabaseModal } from "metabase/admin/databases/components/DeleteDatabaseModel/DeleteDatabaseModal";
import { useDeleteDatabaseMutation, useGetDatabaseQuery } from "metabase/api";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-import { useDispatch } from "metabase/redux";
-import { push, useParams } from "metabase/router";
+import { useNavigate, useParams } from "metabase/router";
import { Modal } from "metabase/ui";
import * as Urls from "metabase/urls";
@@ -13,7 +12,7 @@ export const RemoveDestinationDatabaseModal = () => {
databaseId: string;
destinationDatabaseId: string;
}>();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const dbId = parseInt(params.databaseId ?? "", 10);
const destDbId = parseInt(params.destinationDatabaseId ?? "", 10);
@@ -22,7 +21,7 @@ export const RemoveDestinationDatabaseModal = () => {
const [deleteDatabase] = useDeleteDatabaseMutation();
const handleCloseModal = () => {
- dispatch(push(Urls.viewDatabase(dbId)));
+ navigate(Urls.viewDatabase(dbId));
};
const handleDelete = async () => {
diff --git a/enterprise/frontend/src/metabase-enterprise/database_routing/hooks.ts b/enterprise/frontend/src/metabase-enterprise/database_routing/hooks.ts
index e62a835f6be..88bbfbd0655 100644
--- a/enterprise/frontend/src/metabase-enterprise/database_routing/hooks.ts
+++ b/enterprise/frontend/src/metabase-enterprise/database_routing/hooks.ts
@@ -1,25 +1,20 @@
import { useEffect } from "react";
-import { useDispatch } from "metabase/redux";
-import { replace } from "metabase/router";
+import { useNavigate } from "metabase/router";
import * as Urls from "metabase-enterprise/urls";
import type { Database } from "metabase-types/api";
export function useRedirectDestinationDatabase(
database: Pick<Database, "id" | "router_database_id"> | undefined,
) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
useEffect(() => {
if (database?.router_database_id) {
- dispatch(
- replace(
- Urls.editDestinationDatabase(
- database.router_database_id,
- database.id,
- ),
- ),
+ navigate(
+ Urls.editDestinationDatabase(database.router_database_id, database.id),
+ { replace: true },
);
}
- }, [dispatch, database?.router_database_id, database?.id]);
+ }, [database?.router_database_id, database?.id, navigate]);
}
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/GraphEntryInput.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/GraphEntryInput.tsx
index 5f6ccbbe579..f1a6a95664e 100644
--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/GraphEntryInput.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/GraphEntryInput.tsx
@@ -2,8 +2,7 @@ import { useDisclosure } from "@mantine/hooks";
import { useState } from "react";
import { trackDependencyEntitySelected } from "metabase/common/data-studio/analytics";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Card } from "metabase/ui";
import type {
DependencyEntry,
@@ -29,12 +28,12 @@ export function GraphEntryInput({
}: GraphEntryInputProps) {
const [searchModels, setSearchModels] =
useState<SearchModel[]>(SEARCH_MODELS);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [isPickerOpened, { open: openPicker, close: closePicker }] =
useDisclosure();
const handleEntryChange = (newEntry: DependencyEntry | undefined) => {
- dispatch(push(getGraphUrl(newEntry)));
+ navigate(getGraphUrl(newEntry));
if (newEntry) {
trackDependencyEntitySelected({
diff --git a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/data-model-permission.ts b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/data-model-permission.ts
index f593706ea88..733195c7087 100644
--- a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/data-model-permission.ts
+++ b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/data-model-permission.ts
@@ -1,6 +1,7 @@
import { t } from "ttag";
import { Messages } from "metabase/admin/permissions/constants/messages";
+import { navigateToGranularPermissions } from "metabase/admin/permissions/permissions";
import {
getPermissionWarning,
getPermissionWarningModal,
@@ -15,8 +16,6 @@ import {
getSchemasPermission,
getTablesPermission,
} from "metabase/admin/permissions/utils/graph";
-import { getGroupFocusPermissionsUrl } from "metabase/admin/permissions/utils/urls";
-import { push } from "metabase/router";
import {
DataPermission,
DataPermissionValue,
@@ -167,8 +166,7 @@ export const buildDataModelPermission = (
],
postActions: hasChildEntities
? {
- controlled: () =>
- push(getGroupFocusPermissionsUrl(groupId, entityId)),
+ controlled: () => navigateToGranularPermissions(groupId, entityId),
}
: undefined,
};
diff --git a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/download-permission.ts b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/download-permission.ts
index 64cf74925b1..8327d9c3c5e 100644
--- a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/download-permission.ts
+++ b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/download-permission.ts
@@ -1,6 +1,7 @@
import { t } from "ttag";
import { Messages } from "metabase/admin/permissions/constants/messages";
+import { navigateToGranularPermissions } from "metabase/admin/permissions/permissions";
import {
getPermissionWarning,
getPermissionWarningModal,
@@ -15,8 +16,6 @@ import {
getSchemasPermission,
getTablesPermission,
} from "metabase/admin/permissions/utils/graph";
-import { getGroupFocusPermissionsUrl } from "metabase/admin/permissions/utils/urls";
-import { push } from "metabase/router";
import {
DataPermission,
DataPermissionValue,
@@ -205,8 +204,7 @@ export const buildDownloadPermission = (
],
postActions: hasChildEntities
? {
- controlled: () =>
- push(getGroupFocusPermissionsUrl(groupId, entityId)),
+ controlled: () => navigateToGranularPermissions(groupId, entityId),
}
: undefined,
};
diff --git a/enterprise/frontend/src/metabase-enterprise/group_managers/actions.ts b/enterprise/frontend/src/metabase-enterprise/group_managers/actions.ts
index e7624f3890f..bb5b2995607 100644
--- a/enterprise/frontend/src/metabase-enterprise/group_managers/actions.ts
+++ b/enterprise/frontend/src/metabase-enterprise/group_managers/actions.ts
@@ -1,6 +1,6 @@
import { permissionApi } from "metabase/api";
import { createThunkAction } from "metabase/redux";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import { getAdminPaths } from "metabase/selectors/admin";
import {
@@ -26,7 +26,7 @@ export const confirmDeleteMembership = createThunkAction(
: getRevokeManagerGroupsRedirect(currentUserMemberships, adminPaths);
if (redirectUrl) {
- await dispatch(push(redirectUrl));
+ await navigate(redirectUrl);
}
},
);
@@ -48,7 +48,7 @@ export const confirmUpdateMembership = createThunkAction(
: getRevokeManagerGroupsRedirect(currentUserMemberships, adminPaths);
if (redirectUrl) {
- await dispatch(push(redirectUrl));
+ await navigate(redirectUrl);
}
},
);
@@ -66,7 +66,7 @@ export const deleteGroup = createThunkAction(
if (isLastGroup) {
const adminPaths = getAdminPaths(getState());
const redirectUrl = getRevokedAllGroupManagersPath(adminPaths);
- await dispatch(push(redirectUrl));
+ await navigate(redirectUrl);
}
},
);
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/ConversationStatsPage.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/ConversationStatsPage.tsx
index 71a0e7261df..e0faae20348 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/ConversationStatsPage.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/ConversationStatsPage.tsx
@@ -8,8 +8,7 @@ import { useUrlState } from "metabase/common/hooks/use-url-state";
import { MonitorHeaderTitle } from "metabase/monitor/components/MonitorHeaderTitle";
import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
import { serializeDateParameterValue } from "metabase/querying/parameters/utils/parsing";
-import { useDispatch } from "metabase/redux";
-import { push, queryToSearch, useLocation } from "metabase/router";
+import { queryToSearch, useLocation, useNavigate } from "metabase/router";
import {
Button,
Flex,
@@ -146,7 +145,7 @@ const labelUnknownIpAddress = (value: unknown) =>
export function ConversationStatsPage() {
const location = useLocation();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [{ date, user, group, tenant, metric }, { patchUrlState }] =
useUrlState(location, statsUrlStateConfig);
@@ -201,25 +200,23 @@ export function ConversationStatsPage() {
const navigateToConversations = useCallback(
(filterOverrides: Partial<ConversationsUrlState>) => {
- dispatch(
- push({
- pathname: Urls.monitorAiAuditingConversations(),
- search: queryToSearch(
- conversationsUrlStateConfig.serialize({
- page: 0,
- sort_column: "created_at",
- sort_direction: "desc",
- date,
- user,
- group,
- tenant,
- ...filterOverrides,
- }),
- ),
- }),
- );
+ navigate({
+ pathname: Urls.monitorAiAuditingConversations(),
+ search: queryToSearch(
+ conversationsUrlStateConfig.serialize({
+ page: 0,
+ sort_column: "created_at",
+ sort_direction: "desc",
+ date,
+ user,
+ group,
+ tenant,
+ ...filterOverrides,
+ }),
+ ),
+ });
},
- [dispatch, date, user, group, tenant],
+ [date, user, group, tenant, navigate],
);
const handleDayClick = useCallback(
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationsPage/ConversationsTable.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationsPage/ConversationsTable.tsx
index f57d3e68350..c3e41c64c14 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationsPage/ConversationsTable.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationsPage/ConversationsTable.tsx
@@ -10,8 +10,7 @@ import { useSortingStateChange } from "metabase/common/hooks/use-sorting-state-c
import { renderMetabotProfileLabel } from "metabase/metabot/constants";
import { MonitorEmptyState } from "metabase/monitor/components/MonitorEmptyState";
import { MonitorTableCard } from "metabase/monitor/components/MonitorTableCard";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
Badge,
Card,
@@ -70,7 +69,7 @@ export function ConversationsTable({
sortingOptions,
onSortingOptionsChange,
}: Props) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const rows: ConversationRow[] = useMemo(
() =>
@@ -100,9 +99,9 @@ export function ConversationsTable({
// This only covers keyboard activation (Enter on a keyboard-focused row).
const handleRowActivate = useCallback(
(row: Row<ConversationRow>) => {
- dispatch(push(getRowHref(row)));
+ navigate(getRowHref(row));
},
- [dispatch, getRowHref],
+ [getRowHref, navigate],
);
const treeTableInstance = useTreeTableInstance<ConversationRow>({
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/slash-commands.ts b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/slash-commands.ts
index 297bcd878a9..df34d3354ea 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/slash-commands.ts
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/slash-commands.ts
@@ -1,7 +1,7 @@
import { getMetabotConversation } from "metabase/metabot/state";
import type { MetabotSlashCommandHandler } from "metabase/plugins/oss/audit";
import { addUndo } from "metabase/redux/undo";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import { getUserIsAdmin } from "metabase/selectors/user";
import * as Urls from "metabase/urls";
@@ -26,6 +26,6 @@ export const handleMetabotSlashCommand: MetabotSlashCommandHandler = ({
dispatch(addUndo({ message: "No message history to inspect" }));
return true;
}
- dispatch(push(Urls.monitorAiAuditingConversationDetail(conversationId)));
+ navigate(Urls.monitorAiAuditingConversationDetail(conversationId));
return true;
};
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/pages/DependencyDiagnosticsPage.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/pages/DependencyDiagnosticsPage.tsx
index 0dbf794c20e..c7543ce0ff9 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/pages/DependencyDiagnosticsPage.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/pages/DependencyDiagnosticsPage.tsx
@@ -1,8 +1,7 @@
import { useEffect, useMemo, useRef } from "react";
import { useUserKeyValue } from "metabase/common/hooks/use-user-key-value";
-import { useDispatch } from "metabase/redux";
-import { replace, useLocation } from "metabase/router";
+import { useLocation, useNavigate } from "metabase/router";
import type * as Urls from "metabase/urls";
import { DependencyDiagnostics } from "metabase-enterprise/monitor/dependency-diagnostics/components";
import type {
@@ -25,7 +24,7 @@ type DependencyDiagnosticsPageProps = {
function DependencyDiagnosticsPage({ mode }: DependencyDiagnosticsPageProps) {
const location = useLocation();
const isInitializingRef = useRef(false);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const {
value: rawLastUsedParams,
@@ -50,15 +49,15 @@ function DependencyDiagnosticsPage({ mode }: DependencyDiagnosticsPageProps) {
if (withSetLastUsedParams) {
setLastUsedParams(getUserParams(params));
}
- dispatch(replace(getPageUrl(mode, params)));
+ navigate(getPageUrl(mode, params), { replace: true });
};
useEffect(() => {
if (!isInitializingRef.current && !isLoadingParams) {
isInitializingRef.current = true;
- dispatch(replace(getPageUrl(mode, params)));
+ navigate(getPageUrl(mode, params), { replace: true });
}
- }, [mode, params, isLoadingParams, dispatch]);
+ }, [mode, params, isLoadingParams, navigate]);
return (
<DependencyDiagnostics
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErroringQuestionsTable.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErroringQuestionsTable.tsx
index af4f07bef21..ee881e4a0af 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErroringQuestionsTable.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErroringQuestionsTable.tsx
@@ -13,8 +13,7 @@ import { Link } from "metabase/common/components/Link";
import { useScrollToTop } from "metabase/common/hooks";
import { MonitorEmptyState } from "metabase/monitor/components/MonitorEmptyState";
import { MonitorTableCard } from "metabase/monitor/components/MonitorTableCard";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
Ellipsified,
LoadingOverlay,
@@ -70,7 +69,7 @@ export const ErroringQuestionsTable = ({
onSortingChange,
onRowSelectionChange,
}: ErroringQuestionsTableProps) => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const columns = useMemo(() => getColumns(), []);
const sortingState = useMemo(() => getSortingState(sorting), [sorting]);
@@ -83,9 +82,9 @@ export const ErroringQuestionsTable = ({
const handleRowActivate = useCallback(
(row: Row<ErroringCard>) => {
- dispatch(push(Urls.card({ id: row.original.id })));
+ navigate(Urls.card({ id: row.original.id }));
},
- [dispatch],
+ [navigate],
);
const handleRowClick = useCallback(
diff --git a/enterprise/frontend/src/metabase-enterprise/multi_factor_auth/components/AccountSecurityPanel/AccountSecurityPanel.tsx b/enterprise/frontend/src/metabase-enterprise/multi_factor_auth/components/AccountSecurityPanel/AccountSecurityPanel.tsx
index 8869d22a7be..9ec790faad2 100644
--- a/enterprise/frontend/src/metabase-enterprise/multi_factor_auth/components/AccountSecurityPanel/AccountSecurityPanel.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/multi_factor_auth/components/AccountSecurityPanel/AccountSecurityPanel.tsx
@@ -3,8 +3,7 @@ import { t } from "ttag";
import { DelayedLoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper/DelayedLoadingAndErrorWrapper";
import { useHasTokenFeature } from "metabase/common/hooks";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Box, Button, Group, Stack } from "metabase/ui";
import * as Urls from "metabase/urls";
import { useGetMfaStatusQuery } from "metabase-enterprise/api";
@@ -20,14 +19,14 @@ export function AccountSecurityPanel() {
const { data: status, isLoading, error } = useGetMfaStatusQuery();
const [openedModal, setOpenedModal] = useState<SecurityModal | null>(null);
const hasFeature = useHasTokenFeature("multi-factor-auth");
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const handleCloseModal = () => setOpenedModal(null);
const handleDisableSuccess = () => {
setOpenedModal(null);
if (!hasFeature) {
- dispatch(push(Urls.accountSettings()));
+ navigate(Urls.accountSettings());
}
};
diff --git a/enterprise/frontend/src/metabase-enterprise/sandboxes/index.tsx b/enterprise/frontend/src/metabase-enterprise/sandboxes/index.tsx
index d472584aa77..35a3faab073 100644
--- a/enterprise/frontend/src/metabase-enterprise/sandboxes/index.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/sandboxes/index.tsx
@@ -19,7 +19,7 @@ import {
PLUGIN_REDUCERS,
type PermissionOption,
} from "metabase/plugins";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import { hasPremiumFeature } from "metabase-enterprise/settings";
import type {
GroupId,
@@ -79,7 +79,7 @@ const getEditSegmentedAccessPostAction = (
entityId: PermissionEntityId,
groupId: GroupId,
view: "database" | "group",
-) => push(getEditSegementedAccessUrl(entityId, groupId, view));
+) => navigate(getEditSegementedAccessUrl(entityId, groupId, view));
/**
* Initialize sandboxes plugin features that depend on hasPremiumFeature.
@@ -99,8 +99,8 @@ export function initializePlugin() {
label: t`Edit row and column security`,
iconColor: "brand",
icon: "pencil",
- actionCreator: (entityId, groupId, view) =>
- push(getEditSegementedAccessUrl(entityId, groupId, view)),
+ onSelect: (entityId, groupId, view) =>
+ navigate(getEditSegementedAccessUrl(entityId, groupId, view)),
});
PLUGIN_ADMIN_PERMISSIONS_TABLE_FIELDS_CONFIRMATIONS.push(
(permissions, groupId, entityId, newValue) =>
diff --git a/enterprise/frontend/src/metabase-enterprise/schema_viewer/components/SchemaViewer/components/SchemaPickerInput/SchemaPickerInput.tsx b/enterprise/frontend/src/metabase-enterprise/schema_viewer/components/SchemaViewer/components/SchemaPickerInput/SchemaPickerInput.tsx
index 494de697ac9..97cf9bf4a24 100644
--- a/enterprise/frontend/src/metabase-enterprise/schema_viewer/components/SchemaViewer/components/SchemaPickerInput/SchemaPickerInput.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/schema_viewer/components/SchemaViewer/components/SchemaPickerInput/SchemaPickerInput.tsx
@@ -5,8 +5,7 @@ import { t } from "ttag";
import { skipToken, useGetDatabaseQuery } from "metabase/api";
import { MiniPicker } from "metabase/common/components/Pickers/MiniPicker";
import type { MiniPickerPickableItem } from "metabase/common/components/Pickers/MiniPicker/types";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Button, FixedSizeIcon, Text } from "metabase/ui";
import * as Urls from "metabase/urls";
import { isNamelessSchema } from "metabase-lib/v1/metadata/utils/schema";
@@ -25,7 +24,7 @@ export function SchemaPickerInput({
schema,
onSchemaChange,
}: SchemaPickerInputProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [opened, setOpened] = useState(databaseId == null);
const handleChange = useCallback(
@@ -35,17 +34,15 @@ export function SchemaPickerInput({
return;
}
onSchemaChange();
- dispatch(
- push(
- Urls.dataStudioSchemaViewer({
- databaseId: picked.database_id,
- schema: picked.name,
- }),
- ),
+ navigate(
+ Urls.dataStudioSchemaViewer({
+ databaseId: picked.database_id,
+ schema: picked.name,
+ }),
);
setOpened(false);
},
- [dispatch, onSchemaChange],
+ [onSchemaChange, navigate],
);
const hasNamedSchema = schema != null && schema.length > 0;
diff --git a/enterprise/frontend/src/metabase-enterprise/schema_viewer/pages/SchemaViewerPage/useRedirectToLastDatabase.ts b/enterprise/frontend/src/metabase-enterprise/schema_viewer/pages/SchemaViewerPage/useRedirectToLastDatabase.ts
index 761afe49193..91dc06d32ca 100644
--- a/enterprise/frontend/src/metabase-enterprise/schema_viewer/pages/SchemaViewerPage/useRedirectToLastDatabase.ts
+++ b/enterprise/frontend/src/metabase-enterprise/schema_viewer/pages/SchemaViewerPage/useRedirectToLastDatabase.ts
@@ -2,8 +2,7 @@ import { useEffect, useMemo, useRef } from "react";
import { useListDatabasesQuery } from "metabase/api";
import { useUserKeyValue } from "metabase/common/hooks/use-user-key-value";
-import { useDispatch } from "metabase/redux";
-import { replace } from "metabase/router";
+import { useNavigate } from "metabase/router";
import * as Urls from "metabase/urls";
import type { DatabaseId } from "metabase-types/api";
@@ -24,7 +23,7 @@ export function useRedirectToLastDatabase({
databaseId,
schema,
}: UseRedirectToLastDatabaseArgs) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const {
value: lastDatabase,
@@ -68,7 +67,7 @@ export function useRedirectToLastDatabase({
databaseId: lastDatabase.databaseId,
schema: lastDatabase.schema,
});
- dispatch(replace(url));
+ navigate(url, { replace: true });
}
}
// Mark as "redirected" even if we didn't redirect (no saved db or db
@@ -82,7 +81,7 @@ export function useRedirectToLastDatabase({
hasDbSelected,
lastDatabase,
databases,
- dispatch,
+ navigate,
]);
// Save current database/schema as last opened.
diff --git a/enterprise/frontend/src/metabase-enterprise/support/components/SupportSettingsSection/SupportSettingsSection.tsx b/enterprise/frontend/src/metabase-enterprise/support/components/SupportSettingsSection/SupportSettingsSection.tsx
index f32f385e6b6..d265d1994c2 100644
--- a/enterprise/frontend/src/metabase-enterprise/support/components/SupportSettingsSection/SupportSettingsSection.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/support/components/SupportSettingsSection/SupportSettingsSection.tsx
@@ -3,8 +3,7 @@ import { t } from "ttag";
import { SettingsSection } from "metabase/admin/components/SettingsSection";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { PaginationControls } from "metabase/common/components/PaginationControls";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Box, Button, Flex, LoadingOverlay, Text, Title } from "metabase/ui";
import { adminHelpGrantAccess } from "metabase/urls";
@@ -13,7 +12,7 @@ import { useAccessGrantsQuery } from "../../hooks/useAccessGrantsQuery";
import { AccessGrantList } from "./AccessGrantList";
export function SupportSettingsSection() {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const {
accessGrants,
accessGrantsError,
@@ -50,7 +49,7 @@ export function SupportSettingsSection() {
<Box pb="lg">
<Button
disabled={!!currentAccessGrant}
- onClick={() => dispatch(push(adminHelpGrantAccess()))}
+ onClick={() => navigate(adminHelpGrantAccess())}
variant="filled"
title={
currentAccessGrant
diff --git a/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/use-adhoc-table-query.ts b/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/use-adhoc-table-query.ts
index 18e2034c5f7..ea028f1a809 100644
--- a/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/use-adhoc-table-query.ts
+++ b/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/use-adhoc-table-query.ts
@@ -3,7 +3,7 @@ import { useCallback, useEffect, useMemo } from "react";
import { loadMetadataForTable } from "metabase/questions/actions";
import { useDispatch, useSelector } from "metabase/redux";
import type { Location } from "metabase/router";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { getMetadata } from "metabase/selectors/metadata";
import { b64url_to_utf8, utf8_to_b64url } from "metabase/utils/encoding";
import * as Lib from "metabase-lib";
@@ -23,6 +23,7 @@ export const useAdHocTableQuery = ({
}: UseAdHocTableQueryProps) => {
const metadata = useSelector(getMetadata);
const dispatch = useDispatch();
+ const navigate = useNavigate();
const queryParam = useMemo(() => {
const query = new URLSearchParams(location.search).get("query");
@@ -69,14 +70,12 @@ export const useAdHocTableQuery = ({
if (newFilters.length > 0 || newOrderBys.length > 0) {
const searchParams = new URLSearchParams();
searchParams.set("query", serializeQueryToUrl(Lib.toJsQuery(newQuery)));
- dispatch(
- push(`${window.location.pathname}?${searchParams.toString()}`),
- );
+ navigate(`${window.location.pathname}?${searchParams.toString()}`);
} else {
- dispatch(push(window.location.pathname));
+ navigate(window.location.pathname);
}
},
- [dispatch],
+ [navigate],
);
const tableQuery = useMemo(() => {
diff --git a/enterprise/frontend/src/metabase-enterprise/tenants/EditUserStrategyModal/EditUserStrategyModal.tsx b/enterprise/frontend/src/metabase-enterprise/tenants/EditUserStrategyModal/EditUserStrategyModal.tsx
index 0b698ca7d91..641f72a7f0a 100644
--- a/enterprise/frontend/src/metabase-enterprise/tenants/EditUserStrategyModal/EditUserStrategyModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/tenants/EditUserStrategyModal/EditUserStrategyModal.tsx
@@ -6,7 +6,7 @@ import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErr
import { useToast } from "metabase/common/hooks";
import { useConfirmation } from "metabase/common/hooks/use-confirmation";
import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { useAdminSetting } from "metabase/settings";
import { Button, Flex, Group, Modal, Radio, Stack, Text } from "metabase/ui";
@@ -20,6 +20,7 @@ export const EditUserStrategyModal = ({
onClose,
}: EditUserStrategyModalProps) => {
const dispatch = useDispatch();
+ const navigate = useNavigate();
const { isLoading, error, value, updateSetting, refetch } =
useAdminSetting("use-tenants");
@@ -91,7 +92,7 @@ export const EditUserStrategyModal = ({
// This ensures `createTenantsRouteGuard` sees the updated setting.
await refetch();
- dispatch(push("/admin/people/tenants"));
+ navigate("/admin/people/tenants");
}
};
diff --git a/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/hooks/use-field-distinct-values.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/hooks/use-field-distinct-values.unit.spec.tsx
index 838c34c9dd5..757d2547da6 100644
--- a/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/hooks/use-field-distinct-values.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/hooks/use-field-distinct-values.unit.spec.tsx
@@ -34,7 +34,7 @@ function setup({ fieldId, rows }: SetupOpts) {
}
}
- const store = getStore(reducers, undefined, createMockState());
+ const store = getStore(reducers, createMockState());
function Wrapper({ children }: { children: React.ReactNode }) {
return (
diff --git a/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantCollectionPermissionsPage/TenantCollectionPermissionsPage.tsx b/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantCollectionPermissionsPage/TenantCollectionPermissionsPage.tsx
index ab87aec2090..d5907ff1592 100644
--- a/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantCollectionPermissionsPage/TenantCollectionPermissionsPage.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantCollectionPermissionsPage/TenantCollectionPermissionsPage.tsx
@@ -18,7 +18,7 @@ import type { PermissionEditorEntity } from "metabase/admin/permissions/types";
import { assertNumericId } from "metabase/admin/permissions/types";
import { useListCollectionsTreeQuery } from "metabase/api";
import { useDispatch, useSelector } from "metabase/redux";
-import { push, useParams } from "metabase/router";
+import { useNavigate, useParams } from "metabase/router";
import type { CollectionId } from "metabase-types/api";
import {
@@ -31,6 +31,7 @@ import {
export function TenantCollectionPermissionsPage() {
const dispatch = useDispatch();
+ const navigate = useNavigate();
useListCollectionsTreeQuery(tenantCollectionsQuery);
// These selectors resolve the selected collection from the route, so they
@@ -53,7 +54,7 @@ export function TenantCollectionPermissionsPage() {
}, [dispatch]);
const navigateToItem = ({ id }: { id: CollectionId }) =>
- dispatch(push(`/admin/permissions/tenant-collections/${id}`));
+ navigate(`/admin/permissions/tenant-collections/${id}`);
const handlePermissionChange = useCallback(
(
diff --git a/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantSpecificCollectionPermissionsPage/TenantSpecificCollectionPermissionsPage.tsx b/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantSpecificCollectionPermissionsPage/TenantSpecificCollectionPermissionsPage.tsx
index 2ab860ba71e..1b0d197cc26 100644
--- a/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantSpecificCollectionPermissionsPage/TenantSpecificCollectionPermissionsPage.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantSpecificCollectionPermissionsPage/TenantSpecificCollectionPermissionsPage.tsx
@@ -19,7 +19,7 @@ import type { PermissionEditorEntity } from "metabase/admin/permissions/types";
import { assertNumericId } from "metabase/admin/permissions/types";
import { useListCollectionsTreeQuery } from "metabase/api";
import { useDispatch, useSelector } from "metabase/redux";
-import { push, useParams } from "metabase/router";
+import { useNavigate, useParams } from "metabase/router";
import type { Collection, CollectionId } from "metabase-types/api";
import {
@@ -35,6 +35,7 @@ function TenantSpecificCollectionPermissionsPageView() {
useListCollectionsTreeQuery(tenantSpecificCollectionsQuery);
const dispatch = useDispatch();
+ const navigate = useNavigate();
const props = useMemo(() => ({ params: { collectionId } }), [collectionId]);
const sidebar = useSelector((state) =>
@@ -62,9 +63,9 @@ function TenantSpecificCollectionPermissionsPageView() {
const navigateToItem = useCallback(
({ id }: { id: CollectionId }) => {
- dispatch(push(`/admin/permissions/tenant-specific-collections/${id}`));
+ navigate(`/admin/permissions/tenant-specific-collections/${id}`);
},
- [dispatch],
+ [navigate],
);
const updateCollectionPermission = useCallback(
diff --git a/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantsListing/TenantsListing.tsx b/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantsListing/TenantsListing.tsx
index a8335f248d6..7d739670594 100644
--- a/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantsListing/TenantsListing.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantsListing/TenantsListing.tsx
@@ -10,8 +10,7 @@ import {
import { ForwardRefLink } from "metabase/common/components/Link";
import { UserAvatar } from "metabase/common/components/UserAvatar";
import CS from "metabase/css/core/index.css";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
Box,
Button,
@@ -47,12 +46,12 @@ export const TenantsListing = ({
children,
hasNoTenants,
}: TenantsListingProps) => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const openNewTenantModal = () => {
const param = hasNoTenants ? "?onboarding=true" : "";
- dispatch(push(Urls.newTenant() + param));
+ navigate(Urls.newTenant() + param);
};
const filteredTenants = useMemo(() => {
diff --git a/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantsSummaryOnboardingStep/TenantsSummaryOnboardingStep.tsx b/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantsSummaryOnboardingStep/TenantsSummaryOnboardingStep.tsx
index 881fa87d81d..c399c47ddec 100644
--- a/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantsSummaryOnboardingStep/TenantsSummaryOnboardingStep.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantsSummaryOnboardingStep/TenantsSummaryOnboardingStep.tsx
@@ -4,8 +4,7 @@ import { jt, msgid, ngettext, t } from "ttag";
import { RelatedSettingCard } from "metabase/admin/components/RelatedSettingsSection";
import type { CreatedTenantData } from "metabase/plugins/oss/tenants";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Button, Flex, SimpleGrid, Stack, Text, Title } from "metabase/ui";
import { conjunct } from "metabase/utils/formatting/strings";
import type { DataSegregationStrategy } from "metabase-types/api";
@@ -38,14 +37,14 @@ export const TenantsSummaryOnboardingStep = ({
rlsTableNames?: string[];
rlsColumnName?: string | null;
}) => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const { data: tenantsData } = useListTenantsQuery(
{ status: "active" },
{ skip: tenants.length > 0 },
);
- const onDone = () => dispatch(push("/admin/embedding/setup-guide"));
+ const onDone = () => navigate("/admin/embedding/setup-guide");
const tenantsToShow = useMemo(() => {
// If we have tenants from the flow, use them
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms-inspector/pages/TransformInspectPage/components/LensNavigator/useLensNavigation.ts b/enterprise/frontend/src/metabase-enterprise/transforms-inspector/pages/TransformInspectPage/components/LensNavigator/useLensNavigation.ts
index 153b781f099..9bfc6ac7fda 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms-inspector/pages/TransformInspectPage/components/LensNavigator/useLensNavigation.ts
+++ b/enterprise/frontend/src/metabase-enterprise/transforms-inspector/pages/TransformInspectPage/components/LensNavigator/useLensNavigation.ts
@@ -1,9 +1,8 @@
import { useCallback, useEffect, useMemo, useState } from "react";
import { t } from "ttag";
-import { useDispatch } from "metabase/redux";
import type { Location } from "metabase/router";
-import { push, queryToSearch, replace } from "metabase/router";
+import { queryToSearch, useNavigate } from "metabase/router";
import type { InspectorLensMetadata } from "metabase-types/api";
import type { LensHandle, RouteParams } from "../../types";
@@ -33,7 +32,7 @@ export const useLensNavigation = (
params: Partial<RouteParams>,
location: Location,
): UseLensNavigationResult => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [loadedLenses, setLoadedLenses] = useState<Set<string>>(new Set());
const [dynamicTabs, setDynamicTabs] = useState<LensTab[]>([]);
@@ -91,15 +90,15 @@ export const useLensNavigation = (
return prev.filter((tab) => tab.key !== key);
});
- const navigate = useCallback(
+ const navigateToPath = useCallback(
(handle: LensHandle, isReplace: boolean = false) => {
- const action = isReplace ? replace : push;
const path = `${basePath}/${handle.id}`;
- dispatch(
- action({ pathname: path, search: queryToSearch(handle.params ?? {}) }),
+ navigate(
+ { pathname: path, search: queryToSearch(handle.params ?? {}) },
+ { replace: isReplace },
);
},
- [basePath, dispatch],
+ [basePath, navigate],
);
const navigateToLens = useCallback(
@@ -109,9 +108,9 @@ export const useLensNavigation = (
if (!alreadyExists) {
addDynamicTab(handle);
}
- navigate(handle, isReplace);
+ navigateToPath(handle, isReplace);
},
- [tabs, navigate],
+ [tabs, navigateToPath],
);
useEffect(() => {
@@ -139,11 +138,11 @@ export const useLensNavigation = (
const newActiveIndex = Math.min(tabIndex, remainingTabs.length - 1);
const newActiveTab = remainingTabs[newActiveIndex];
if (newActiveTab) {
- navigate(newActiveTab.lensHandle);
+ navigateToPath(newActiveTab.lensHandle);
}
}
},
- [tabs, activeTabKey, navigate],
+ [tabs, activeTabKey, navigateToPath],
);
const markLensAsLoaded = useCallback((lensKey: string) => {
@@ -156,10 +155,10 @@ export const useLensNavigation = (
(tabKey: string) => {
const tab = tabs.find(({ key }) => key === tabKey);
if (tab) {
- navigate(tab.lensHandle);
+ navigateToPath(tab.lensHandle);
}
},
- [navigate, tabs],
+ [navigateToPath, tabs],
);
const updateTabTitle = useCallback((tabKey: string, title: string) => {
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonEditorBody/PythonEditorBody.tsx b/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonEditorBody/PythonEditorBody.tsx
index 9904c350dc9..96bc7adc8bd 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonEditorBody/PythonEditorBody.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonEditorBody/PythonEditorBody.tsx
@@ -5,8 +5,7 @@ import { t } from "ttag";
import { clickableTokens } from "metabase/common/components/CodeMirror";
import { RunButtonWithTooltip } from "metabase/querying/components/QueryVisualization/RunButtonWithTooltip";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Button, Flex, Icon, Stack, Tooltip } from "metabase/ui";
import * as Urls from "metabase/urls";
@@ -57,7 +56,7 @@ export function PythonEditorBody({
const [isResizing, setIsResizing] = useState(false);
const showResizeHandle = isEditMode && withDebugger;
const editorHeight = useInitialEditorHeight(isEditMode, showResizeHandle);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const navigateToCommonLibrary = useCallback(
(e: MouseEvent) => {
@@ -68,10 +67,10 @@ export function PythonEditorBody({
if (openInNewTab) {
window.open(href, "_blank", "noopener,noreferrer");
} else {
- dispatch(push(href));
+ navigate(href);
}
},
- [dispatch],
+ [navigate],
);
const clickableTokensExtension = useMemo(
diff --git a/enterprise/frontend/src/metabase-enterprise/writable_connection/pages/WritableConnectionInfoPage/WritableConnectionInfoPage.tsx b/enterprise/frontend/src/metabase-enterprise/writable_connection/pages/WritableConnectionInfoPage/WritableConnectionInfoPage.tsx
index b96596c2b59..d38db787160 100644
--- a/enterprise/frontend/src/metabase-enterprise/writable_connection/pages/WritableConnectionInfoPage/WritableConnectionInfoPage.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/writable_connection/pages/WritableConnectionInfoPage/WritableConnectionInfoPage.tsx
@@ -11,8 +11,7 @@ import { LeaveRouteConfirmModal } from "metabase/common/components/LeaveConfirmM
import { DelayedLoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper/DelayedLoadingAndErrorWrapper";
import { DatabaseForm } from "metabase/databases/components/DatabaseForm";
import type { DatabaseFormConfig } from "metabase/databases/types";
-import { useDispatch } from "metabase/redux";
-import { push, useParams } from "metabase/router";
+import { useNavigate, useParams } from "metabase/router";
import { Box, Flex, ScrollArea, Title } from "metabase/ui";
import * as Urls from "metabase/urls";
import type { Database, DatabaseData } from "metabase-types/api";
@@ -58,18 +57,18 @@ function WritableConnectionInfoPageBody({
const initialValues = useMemo(() => getInitialValues(database), [database]);
const [isDirty, setIsDirty] = useState(false);
const [updateDatabase, { isLoading: isSaving }] = useUpdateDatabaseMutation();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const handleSubmit = async (newValues: DatabaseData) => {
await updateDatabase({
id: database.id,
write_data_details: getSubmitDetails(newValues),
}).unwrap();
- dispatch(push(Urls.viewDatabase(database.id)));
+ navigate(Urls.viewDatabase(database.id));
};
const handleCancel = () => {
- dispatch(push(Urls.viewDatabase(database.id)));
+ navigate(Urls.viewDatabase(database.id));
};
return (
diff --git a/frontend/src/embedding-sdk-bundle/store/index.ts b/frontend/src/embedding-sdk-bundle/store/index.ts
index 44db3f3b74c..caa1fe4bc76 100644
--- a/frontend/src/embedding-sdk-bundle/store/index.ts
+++ b/frontend/src/embedding-sdk-bundle/store/index.ts
@@ -26,7 +26,6 @@ export const getSdkStore = () =>
// Unjustified type cast. FIXME
getStore(
sdkReducers,
- null,
{
embed: {
options: {
diff --git a/frontend/src/metabase/account/app/containers/AccountApp/AccountApp.tsx b/frontend/src/metabase/account/app/containers/AccountApp/AccountApp.tsx
index 46e95ca6da1..4fc6e6ef07e 100644
--- a/frontend/src/metabase/account/app/containers/AccountApp/AccountApp.tsx
+++ b/frontend/src/metabase/account/app/containers/AccountApp/AccountApp.tsx
@@ -1,11 +1,11 @@
-import { useDispatch, useSelector } from "metabase/redux";
-import { push, useLocation } from "metabase/router";
+import { useSelector } from "metabase/redux";
+import { useLocation, useNavigate } from "metabase/router";
import { getUser } from "metabase/selectors/user";
import AccountLayout from "../../components/AccountLayout";
export function AccountApp() {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const user = useSelector(getUser);
const { pathname } = useLocation();
@@ -13,7 +13,7 @@ export function AccountApp() {
<AccountLayout
user={user}
path={pathname}
- onChangeLocation={(nextLocation) => dispatch(push(nextLocation))}
+ onChangeLocation={(nextLocation) => navigate(nextLocation)}
/>
);
}
diff --git a/frontend/src/metabase/account/notifications/actions.ts b/frontend/src/metabase/account/notifications/actions.ts
index 3e2d52d6e43..1c9a8714b8d 100644
--- a/frontend/src/metabase/account/notifications/actions.ts
+++ b/frontend/src/metabase/account/notifications/actions.ts
@@ -1,5 +1,4 @@
import type { NotificationListItem } from "metabase/notifications/types";
-import { push } from "metabase/router";
const PREFIX = `/account/notifications`;
@@ -10,22 +9,16 @@ const TYPE_MAP: Record<ListItemType, string> = {
pulse: "pulse",
};
-export const navigateToUnsubscribe = (
- item: { id: number },
- type: ListItemType,
-) => {
- return push(`${PREFIX}/${TYPE_MAP[type]}/${item.id}/unsubscribe`);
-};
+export const getUnsubscribeUrl = (item: { id: number }, type: ListItemType) =>
+ `${PREFIX}/${TYPE_MAP[type]}/${item.id}/unsubscribe`;
-export const navigateToArchive = (
+export const getArchiveUrl = (
item: { id: number },
type: ListItemType,
hasUnsubscribed?: boolean,
) => {
const query = hasUnsubscribed ? "?unsubscribed=true" : "";
- return push(`${PREFIX}/${TYPE_MAP[type]}/${item.id}/archive${query}`);
+ return `${PREFIX}/${TYPE_MAP[type]}/${item.id}/archive${query}`;
};
-export const navigateToHelp = () => {
- return push(`${PREFIX}/help`);
-};
+export const getHelpUrl = () => `${PREFIX}/help`;
diff --git a/frontend/src/metabase/account/notifications/containers/NotificationsApp/NotificationsApp.tsx b/frontend/src/metabase/account/notifications/containers/NotificationsApp/NotificationsApp.tsx
index eb1ac9ebb41..fe1db302948 100644
--- a/frontend/src/metabase/account/notifications/containers/NotificationsApp/NotificationsApp.tsx
+++ b/frontend/src/metabase/account/notifications/containers/NotificationsApp/NotificationsApp.tsx
@@ -7,26 +7,22 @@ import {
useListSubscriptionsQuery,
} from "metabase/api";
import type { NotificationListItem } from "metabase/notifications/types";
-import { useDispatch, useSelector } from "metabase/redux";
-import { Outlet } from "metabase/router";
+import { useSelector } from "metabase/redux";
+import { Outlet, useNavigate } from "metabase/router";
import {
canManageSubscriptions as canManageSubscriptionsSelector,
getUser,
} from "metabase/selectors/user";
import { parseTimestamp } from "metabase/utils/time-dayjs";
-import {
- navigateToArchive,
- navigateToHelp,
- navigateToUnsubscribe,
-} from "../../actions";
+import { getArchiveUrl, getHelpUrl, getUnsubscribeUrl } from "../../actions";
import { NotificationList } from "../../components/NotificationList";
export const NotificationsApp = (): JSX.Element | null => {
const user = useSelector(getUser);
const canManageSubscriptions = useSelector(canManageSubscriptionsSelector);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const { data: pulses = [] } = useListSubscriptionsQuery({
creator_or_recipient: true,
@@ -60,11 +56,11 @@ export const NotificationsApp = (): JSX.Element | null => {
);
}, [pulses, questionNotifications]);
- const onHelp = () => dispatch(navigateToHelp());
+ const onHelp = () => navigate(getHelpUrl());
const onUnsubscribe = ({ item, type }: NotificationListItem) =>
- dispatch(navigateToUnsubscribe(item, type));
+ navigate(getUnsubscribeUrl(item, type));
const onArchive = ({ item, type }: NotificationListItem) =>
- dispatch(navigateToArchive(item, type));
+ navigate(getArchiveUrl(item, type));
if (!user) {
return null;
diff --git a/frontend/src/metabase/account/notifications/containers/UnsubscribeAlertModal/UnsubscribeAlertModal.tsx b/frontend/src/metabase/account/notifications/containers/UnsubscribeAlertModal/UnsubscribeAlertModal.tsx
index 8662b6b2fe9..554dd07ad19 100644
--- a/frontend/src/metabase/account/notifications/containers/UnsubscribeAlertModal/UnsubscribeAlertModal.tsx
+++ b/frontend/src/metabase/account/notifications/containers/UnsubscribeAlertModal/UnsubscribeAlertModal.tsx
@@ -1,6 +1,6 @@
import { t } from "ttag";
-import { navigateToArchive } from "metabase/account/notifications/actions";
+import { getArchiveUrl } from "metabase/account/notifications/actions";
import {
skipToken,
useGetNotificationQuery,
@@ -9,7 +9,8 @@ import {
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { useToast } from "metabase/common/hooks/use-toast";
import { UnsubscribeConfirmModal } from "metabase/notifications/modals/UnsubscribeConfirmModal";
-import { useDispatch, useSelector } from "metabase/redux";
+import { useSelector } from "metabase/redux";
+import { useNavigate } from "metabase/router";
import { getUser } from "metabase/selectors/user";
import type { Notification, User } from "metabase-types/api";
@@ -29,7 +30,7 @@ export const UnsubscribeAlertModal = ({
const id = getAlertId(params?.alertId);
const user = useSelector(getUser);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [sendToast] = useToast();
const {
@@ -55,7 +56,7 @@ export const UnsubscribeAlertModal = ({
if (isCreator(alert, user)) {
onClose();
- dispatch(navigateToArchive(alert, "question-notification", true));
+ navigate(getArchiveUrl(alert, "question-notification", true));
} else {
onClose();
}
diff --git a/frontend/src/metabase/account/notifications/containers/UnsubscribePulseModal/UnsubscribePulseModal.tsx b/frontend/src/metabase/account/notifications/containers/UnsubscribePulseModal/UnsubscribePulseModal.tsx
index 04cf9a03de1..ba8f1904981 100644
--- a/frontend/src/metabase/account/notifications/containers/UnsubscribePulseModal/UnsubscribePulseModal.tsx
+++ b/frontend/src/metabase/account/notifications/containers/UnsubscribePulseModal/UnsubscribePulseModal.tsx
@@ -2,10 +2,11 @@ import { skipToken } from "@reduxjs/toolkit/query/react";
import { useGetSubscriptionQuery, useUnsubscribeMutation } from "metabase/api";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-import { useDispatch, useSelector } from "metabase/redux";
+import { useSelector } from "metabase/redux";
+import { useNavigate } from "metabase/router";
import { getUser } from "metabase/selectors/user";
-import { navigateToArchive } from "../../actions";
+import { getArchiveUrl } from "../../actions";
import { UnsubscribeModal } from "../../components/UnsubscribeModal";
import { getPulseId } from "../../selectors";
@@ -18,7 +19,7 @@ export function UnsubscribePulseModal({
params,
onClose,
}: UnsubscribePulseModalProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const pulseId = getPulseId({ params });
const user = useSelector(getUser);
@@ -39,7 +40,7 @@ export function UnsubscribePulseModal({
_type: "alert" | "pulse",
hasUnsubscribed: boolean,
): void => {
- dispatch(navigateToArchive(item, "pulse", hasUnsubscribed));
+ navigate(getArchiveUrl(item, "pulse", hasUnsubscribed));
};
if (isLoading || error) {
diff --git a/frontend/src/metabase/actions/containers/ActionCreatorModal/ActionCreatorModal.tsx b/frontend/src/metabase/actions/containers/ActionCreatorModal/ActionCreatorModal.tsx
index 020a8842fea..6ccc7e44373 100644
--- a/frontend/src/metabase/actions/containers/ActionCreatorModal/ActionCreatorModal.tsx
+++ b/frontend/src/metabase/actions/containers/ActionCreatorModal/ActionCreatorModal.tsx
@@ -3,10 +3,9 @@ import { useEffect } from "react";
import { skipToken, useGetActionQuery, useGetCardQuery } from "metabase/api";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import type { ModalComponentProps } from "metabase/common/components/ModalRoute";
-import { connect, useSelector } from "metabase/redux";
+import { useDispatch, useSelector } from "metabase/redux";
import { setErrorPage } from "metabase/redux/app";
-import type { AppErrorDescriptor } from "metabase/redux/store";
-import { type LocationDescriptor, replace } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { getMetadata } from "metabase/selectors/metadata";
import * as Urls from "metabase/urls";
import type Question from "metabase-lib/v1/Question";
@@ -28,26 +27,16 @@ interface EntityLoaderProps {
loading?: boolean;
}
-interface DispatchProps {
- setErrorPage: (error: AppErrorDescriptor) => void;
- onChangeLocation: (location: LocationDescriptor) => void;
-}
-
-type ActionCreatorModalProps = OwnProps & EntityLoaderProps & DispatchProps;
-
-const mapDispatchToProps = {
- setErrorPage,
- onChangeLocation: replace,
-};
+type ActionCreatorModalProps = OwnProps & EntityLoaderProps;
function ActionCreatorModal({
model,
params,
loading: isModelLoading,
onClose,
- setErrorPage,
- onChangeLocation,
}: ActionCreatorModalProps) {
+ const dispatch = useDispatch();
+ const navigate = useNavigate();
const actionId = Urls.extractEntityId(params.actionId);
const modelId = Urls.extractEntityId(params.slug);
const databaseId = model.databaseId() ?? undefined;
@@ -65,9 +54,9 @@ function ActionCreatorModal({
if (notFound || action?.archived) {
const nextLocation = Urls.modelDetail(model.card(), "actions");
- onChangeLocation(nextLocation);
+ navigate(nextLocation, { replace: true });
} else if (hasModelMismatch) {
- setErrorPage({ status: 404 });
+ dispatch(setErrorPage({ status: 404 }));
}
}
// We only need to run this once, when the action is fetched
@@ -89,11 +78,7 @@ function ActionCreatorModal({
);
}
-function ActionCreatorModalLoader({
- params,
- onClose,
- ...dispatchProps
-}: ModalComponentProps & DispatchProps) {
+function ActionCreatorModalLoader({ params, onClose }: ModalComponentProps) {
const modelId = Urls.extractEntityId(params.slug);
const { isLoading, error } = useGetCardQuery(
modelId != null ? { id: modelId } : skipToken,
@@ -112,10 +97,9 @@ function ActionCreatorModalLoader({
onClose={onClose}
model={model}
loading={isLoading}
- {...dispatchProps}
/>
);
}
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default connect(null, mapDispatchToProps)(ActionCreatorModalLoader);
+export default ActionCreatorModalLoader;
diff --git a/frontend/src/metabase/admin/databases/components/DatabaseConnectionInfoSection/DatabaseConnectionInfoSection.tsx b/frontend/src/metabase/admin/databases/components/DatabaseConnectionInfoSection/DatabaseConnectionInfoSection.tsx
index d11a7581949..e0341f82bc1 100644
--- a/frontend/src/metabase/admin/databases/components/DatabaseConnectionInfoSection/DatabaseConnectionInfoSection.tsx
+++ b/frontend/src/metabase/admin/databases/components/DatabaseConnectionInfoSection/DatabaseConnectionInfoSection.tsx
@@ -14,7 +14,7 @@ import {
isDbModifiable,
} from "metabase/common/utils/database";
import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Button, Flex, Tooltip } from "metabase/ui";
import { isSyncCompleted } from "metabase/utils/syncing";
import type { Database } from "metabase-types/api";
@@ -35,6 +35,7 @@ export const DatabaseConnectionInfoSection = ({
const isSynced = isSyncCompleted(database);
const dispatch = useDispatch();
+ const navigate = useNavigate();
const [syncDatabaseSchema] = useSyncDatabaseSchemaMutation();
const [rescanDatabaseFieldValues] = useRescanDatabaseFieldValuesMutation();
const [dismissSyncSpinner] = useDismissDatabaseSyncSpinnerMutation();
@@ -51,8 +52,8 @@ export const DatabaseConnectionInfoSection = ({
);
const openDbDetailsModal = useCallback(() => {
- dispatch(push(`/admin/databases/${database.id}/edit`));
- }, [database.id, dispatch]);
+ navigate(`/admin/databases/${database.id}/edit`);
+ }, [database.id, navigate]);
return (
<DatabaseInfoSection
diff --git a/frontend/src/metabase/admin/databases/components/DeleteDatabaseModel/DeleteDatabaseModal.tsx b/frontend/src/metabase/admin/databases/components/DeleteDatabaseModel/DeleteDatabaseModal.tsx
index d97d37b3c26..e73fb58d5c3 100644
--- a/frontend/src/metabase/admin/databases/components/DeleteDatabaseModel/DeleteDatabaseModal.tsx
+++ b/frontend/src/metabase/admin/databases/components/DeleteDatabaseModel/DeleteDatabaseModal.tsx
@@ -4,8 +4,7 @@ import { jt, t } from "ttag";
import { useGetDatabaseUsageInfoQuery } from "metabase/api";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
Alert,
Box,
@@ -64,7 +63,7 @@ export const DeleteDatabaseModal = ({
onDelete,
...props
}: DeleteDatabaseModalProps) => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const { data: usageInfo, isLoading: loading } = useGetDatabaseUsageInfoQuery(
database.id,
@@ -90,7 +89,7 @@ export const DeleteDatabaseModal = ({
const handleEditConnectionDetailsClick: MouseEventHandler = (e) => {
e.preventDefault();
onClose();
- dispatch(push(Urls.editDatabase(database.id)));
+ navigate(Urls.editDatabase(database.id));
};
const hasContent = usageInfo && hasContentInDatabase(usageInfo);
diff --git a/frontend/src/metabase/admin/databases/database.ts b/frontend/src/metabase/admin/databases/database.ts
index 63c06a0afb8..c5f38216694 100644
--- a/frontend/src/metabase/admin/databases/database.ts
+++ b/frontend/src/metabase/admin/databases/database.ts
@@ -6,7 +6,7 @@ import { combineReducers } from "metabase/redux";
import { createDatabase } from "metabase/redux/databases";
import { updateMetadata } from "metabase/redux/metadata";
import type { Dispatch } from "metabase/redux/store";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import { DatabaseSchema } from "metabase/schema";
import type { DatabaseData, DatabaseId } from "metabase-types/api";
@@ -53,7 +53,7 @@ export const deleteDatabase = function (databaseId: DatabaseId) {
dispatch,
databaseApi.endpoints.deleteDatabase,
);
- dispatch(push("/admin/databases/"));
+ navigate("/admin/databases/");
dispatch(DELETE_DATABASE({ databaseId }));
} catch (error) {
diff --git a/frontend/src/metabase/admin/databases/hooks/use-database-connection.ts b/frontend/src/metabase/admin/databases/hooks/use-database-connection.ts
index 1b5e7e66089..aceb7962747 100644
--- a/frontend/src/metabase/admin/databases/hooks/use-database-connection.ts
+++ b/frontend/src/metabase/admin/databases/hooks/use-database-connection.ts
@@ -4,8 +4,7 @@ import { skipToken, useGetDatabaseQuery } from "metabase/api";
import { getDefaultEngineKey } from "metabase/databases/utils/engine";
import { RETURN_TO_SETUP_GUIDE_PARAM } from "metabase/embedding/constants";
import { PLUGIN_DB_ROUTING } from "metabase/plugins";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import type { DatabaseId, Engine, EngineKey } from "metabase-types/api";
interface UseDatabaseConnectionProps {
@@ -17,7 +16,7 @@ export const useDatabaseConnection = ({
databaseId,
engines,
}: UseDatabaseConnectionProps) => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const queryParams = new URLSearchParams(location.search);
const preselectedEngine =
queryParams.get("engine") ?? getDefaultEngineKey(engines || {});
@@ -36,10 +35,8 @@ export const useDatabaseConnection = ({
};
const handleCancel = () => {
- dispatch(
- database?.id
- ? push(`/admin/databases/${database.id}`)
- : push(`/admin/databases`),
+ navigate(
+ database?.id ? `/admin/databases/${database.id}` : `/admin/databases`,
);
};
@@ -48,7 +45,7 @@ export const useDatabaseConnection = ({
const param = fromEmbeddingSetupGuide
? `?${RETURN_TO_SETUP_GUIDE_PARAM}=true`
: "";
- dispatch(push(`/admin/databases/${savedDB.id}${param}`));
+ navigate(`/admin/databases/${savedDB.id}${param}`);
} else {
handleCancel();
}
diff --git a/frontend/src/metabase/admin/datamodel/containers/SegmentApp.tsx b/frontend/src/metabase/admin/datamodel/containers/SegmentApp.tsx
index 71d7d8e1d98..f1afbe1545d 100644
--- a/frontend/src/metabase/admin/datamodel/containers/SegmentApp.tsx
+++ b/frontend/src/metabase/admin/datamodel/containers/SegmentApp.tsx
@@ -12,8 +12,7 @@ import { trackSegmentCreated } from "metabase/common/data-studio/analytics";
import { useLoadTableWithMetadata } from "metabase/common/data-studio/hooks/use-load-table-with-metadata";
import { useCallbackEffect } from "metabase/common/hooks/use-callback-effect";
import { useMetadataToasts } from "metabase/metadata/hooks";
-import { useDispatch } from "metabase/redux";
-import { push, useParams } from "metabase/router";
+import { useNavigate, useParams } from "metabase/router";
import type {
CreateSegmentRequest,
Segment,
@@ -31,7 +30,7 @@ type UpdateSegmentFormProps = {
};
function UpdateSegmentForm({ segmentId }: UpdateSegmentFormProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [isDirty, setIsDirty] = useState(false);
const [updateSegment] = useUpdateSegmentMutation();
@@ -57,9 +56,9 @@ function UpdateSegmentForm({ segmentId }: UpdateSegmentFormProps) {
setIsDirty(isDirty);
return;
}
- dispatch(push("/admin/datamodel/segments"));
+ navigate("/admin/datamodel/segments");
},
- [dispatch, segmentId, updateSegment, isDirty],
+ [segmentId, updateSegment, isDirty, navigate],
);
const isLoading = isLoadingSegment || isLoadingTable;
@@ -83,7 +82,7 @@ function UpdateSegmentForm({ segmentId }: UpdateSegmentFormProps) {
}
function CreateSegmentForm() {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [isDirty, setIsDirty] = useState(false);
const { sendErrorToast } = useMetadataToasts();
const [createSegment] = useCreateSegmentMutation();
@@ -113,10 +112,10 @@ function CreateSegmentForm() {
"admin_datamodel_segments",
result.data?.id,
);
- dispatch(push("/admin/datamodel/segments"));
+ navigate("/admin/datamodel/segments");
});
},
- [scheduleCallback, createSegment, dispatch, sendErrorToast, isDirty],
+ [scheduleCallback, createSegment, navigate, sendErrorToast, isDirty],
);
return (
diff --git a/frontend/src/metabase/admin/datamodel/hoc/FilteredToUrlTable.tsx b/frontend/src/metabase/admin/datamodel/hoc/FilteredToUrlTable.tsx
index fab4c6a87b6..cd465fc0292 100644
--- a/frontend/src/metabase/admin/datamodel/hoc/FilteredToUrlTable.tsx
+++ b/frontend/src/metabase/admin/datamodel/hoc/FilteredToUrlTable.tsx
@@ -6,16 +6,15 @@ import { skipToken, useGetTableQuery } from "metabase/api";
import { FieldSet } from "metabase/common/components/FieldSet";
import CS from "metabase/css/core/index.css";
import { DatabaseSchemaAndTableDataSelector } from "metabase/querying/common/components/DataSelector";
-import { connect, useSelector } from "metabase/redux";
-import type { Location, LocationDescriptorObject } from "metabase/router";
-import { push, queryToSearch } from "metabase/router";
+import { useSelector } from "metabase/redux";
+import type { Location } from "metabase/router";
+import { queryToSearch, useNavigate } from "metabase/router";
import { getMetadata } from "metabase/selectors/metadata";
import { Icon } from "metabase/ui";
import type { ConcreteTableId, Segment } from "metabase-types/api";
type FilteredToUrlTableInnerProps = {
location: Location;
- push: (location: LocationDescriptorObject) => void;
segments: Segment[];
};
@@ -35,22 +34,25 @@ export function FilteredToUrlTable(
) {
const Inner = ({
location,
- push,
segments,
...props
}: FilteredToUrlTableInnerProps) => {
+ const navigate = useNavigate();
const [tableId, setTableIdState] = useState<ConcreteTableId | null>(() =>
getTableIdFromLocation(location),
);
const setTableId = (newTableId: ConcreteTableId | null) => {
setTableIdState(newTableId);
- push({
- ...location,
- search: queryToSearch(
- newTableId == null ? {} : { table: String(newTableId) },
- ),
- });
+ navigate(
+ {
+ ...location,
+ search: queryToSearch(
+ newTableId == null ? {} : { table: String(newTableId) },
+ ),
+ },
+ { state: location.state },
+ );
};
const filteredItems =
@@ -69,7 +71,7 @@ export function FilteredToUrlTable(
return <ComposedComponent {...composedProps} />;
};
- return connect(null, { push })(Inner);
+ return Inner;
}
type TableSelectorProps = {
diff --git a/frontend/src/metabase/admin/embedding/components/ThemeEditor/EmbeddingThemeEditorApp.tsx b/frontend/src/metabase/admin/embedding/components/ThemeEditor/EmbeddingThemeEditorApp.tsx
index 6de71207ff9..175738febe8 100644
--- a/frontend/src/metabase/admin/embedding/components/ThemeEditor/EmbeddingThemeEditorApp.tsx
+++ b/frontend/src/metabase/admin/embedding/components/ThemeEditor/EmbeddingThemeEditorApp.tsx
@@ -5,8 +5,7 @@ import { useEmbeddingThemeEditor } from "metabase/admin/embedding/hooks/use-embe
import { NotFound } from "metabase/common/components/ErrorPages";
import { LeaveRouteConfirmModal } from "metabase/common/components/LeaveConfirmModal/LeaveRouteConfirmModal";
import { useBeforeUnload } from "metabase/common/hooks/use-before-unload";
-import { useDispatch } from "metabase/redux";
-import { push, useParams } from "metabase/router";
+import { useNavigate, useParams } from "metabase/router";
import { Flex, Loader, Stack } from "metabase/ui";
import { EditorPanel } from "./EditorPanel";
@@ -17,13 +16,13 @@ export function EmbeddingThemeEditorApp() {
const themeId =
themeIdParam === "new" ? "new" : parseInt(themeIdParam ?? "", 10);
const editor = useEmbeddingThemeEditor(themeId);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
// Suppresses the unsaved-changes prompt when we navigate away intentionally
// (save or delete), since those flows leave the editor while `isDirty` is true.
const isSavingRef = useRef(false);
const goToThemeList = () => {
- dispatch(push("/admin/embedding/themes"));
+ navigate("/admin/embedding/themes");
};
const {
diff --git a/frontend/src/metabase/admin/embedding/components/ThemeListing/EmbeddingThemeListingApp.tsx b/frontend/src/metabase/admin/embedding/components/ThemeListing/EmbeddingThemeListingApp.tsx
index 9b2d284e6be..3507629b47c 100644
--- a/frontend/src/metabase/admin/embedding/components/ThemeListing/EmbeddingThemeListingApp.tsx
+++ b/frontend/src/metabase/admin/embedding/components/ThemeListing/EmbeddingThemeListingApp.tsx
@@ -7,8 +7,7 @@ import {
useListEmbeddingThemesQuery,
} from "metabase/api/embedding-theme";
import { useHasTokenFeature, useToast } from "metabase/common/hooks";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Loader, SimpleGrid, Stack, Text, Title } from "metabase/ui";
import { EmbeddingThemeCard } from "./EmbeddingThemeCard";
@@ -25,14 +24,14 @@ export function EmbeddingThemeListingApp() {
}
function EmbeddingThemeListingAppInner() {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const { data: themes, isLoading } = useListEmbeddingThemesQuery();
const [duplicateTheme] = useCopyEmbeddingThemeMutation();
const [sendToast] = useToast();
const { requestDelete, modal: deleteModal } = useDeleteThemeFlow();
const handleCreateTheme = () => {
- dispatch(push(`/admin/embedding/themes/new`));
+ navigate(`/admin/embedding/themes/new`);
};
const handleDuplicateTheme = async (themeId: number) => {
@@ -67,7 +66,7 @@ function EmbeddingThemeListingAppInner() {
<EmbeddingThemeCard
key={theme.id}
theme={theme}
- onEdit={() => dispatch(push(`/admin/embedding/themes/${theme.id}`))}
+ onEdit={() => navigate(`/admin/embedding/themes/${theme.id}`)}
onDuplicate={() => handleDuplicateTheme(theme.id)}
onDelete={() => requestDelete(theme.id)}
/>
diff --git a/frontend/src/metabase/admin/people/containers/NewUserModal.tsx b/frontend/src/metabase/admin/people/containers/NewUserModal.tsx
index e37a8ea757f..98e73d41e04 100644
--- a/frontend/src/metabase/admin/people/containers/NewUserModal.tsx
+++ b/frontend/src/metabase/admin/people/containers/NewUserModal.tsx
@@ -9,7 +9,7 @@ import { trackUserInvited } from "metabase/common/analytics";
import { UserForm } from "metabase/common/components/UserForm";
import { PLUGIN_TENANTS } from "metabase/plugins";
import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Modal } from "metabase/ui";
import * as Urls from "metabase/urls";
import { generatePassword } from "metabase/utils/password";
@@ -28,6 +28,7 @@ export const NewUserModal = ({
external = false,
}: NewUserModalProps) => {
const dispatch = useDispatch();
+ const navigate = useNavigate();
const [createUser] = useCreateUserMutation();
const { data: groups } = useListPermissionsGroupsQuery({
@@ -60,7 +61,7 @@ export const NewUserModal = ({
if (password) {
dispatch(storeTemporaryPassword({ id: user.id, password }));
}
- dispatch(push(Urls.newUserSuccess(user)));
+ navigate(Urls.newUserSuccess(user));
} catch (error) {
if (!external) {
trackUserInvited({
diff --git a/frontend/src/metabase/admin/people/containers/UserSuccessModal.tsx b/frontend/src/metabase/admin/people/containers/UserSuccessModal.tsx
index 2c867ac25f2..4406401cf50 100644
--- a/frontend/src/metabase/admin/people/containers/UserSuccessModal.tsx
+++ b/frontend/src/metabase/admin/people/containers/UserSuccessModal.tsx
@@ -10,7 +10,7 @@ import { PasswordReveal } from "metabase/common/components/PasswordReveal";
import CS from "metabase/css/core/index.css";
import { PLUGIN_TENANTS } from "metabase/plugins";
import { useDispatch, useSelector } from "metabase/redux";
-import { push, replace } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { isSsoEnabled } from "metabase/selectors/settings";
import { getSetting } from "metabase/settings";
import { Box } from "metabase/ui";
@@ -37,13 +37,10 @@ export function UserSuccessModal({ params }: UserSuccessModalProps) {
getSetting(state, "enable-password-login"),
);
const dispatch = useDispatch();
+ const navigate = useNavigate();
const handleClose = () => {
- dispatch(
- isExternalUser
- ? push("/admin/people/tenants/people")
- : push("/admin/people"),
- );
+ navigate(isExternalUser ? "/admin/people/tenants/people" : "/admin/people");
};
useEffect(() => {
@@ -54,9 +51,9 @@ export function UserSuccessModal({ params }: UserSuccessModalProps) {
useEffect(() => {
if (isExternalUser && !temporaryPassword) {
- dispatch(replace("/admin/people/tenants/people"));
+ navigate("/admin/people/tenants/people", { replace: true });
}
- }, [isExternalUser, temporaryPassword, dispatch]);
+ }, [isExternalUser, temporaryPassword, navigate]);
if (!user || isLoading || error != null) {
return <LoadingAndErrorWrapper loading={isLoading} error={error} />;
diff --git a/frontend/src/metabase/admin/permissions/components/PermissionsPageLayout/PermissionsPageLayout.tsx b/frontend/src/metabase/admin/permissions/components/PermissionsPageLayout/PermissionsPageLayout.tsx
index 244b300d9bb..912de353504 100644
--- a/frontend/src/metabase/admin/permissions/components/PermissionsPageLayout/PermissionsPageLayout.tsx
+++ b/frontend/src/metabase/admin/permissions/components/PermissionsPageLayout/PermissionsPageLayout.tsx
@@ -16,7 +16,7 @@ import type { PermissionsGraphDiff } from "metabase/admin/permissions/types";
import { ConfirmModal } from "metabase/common/components/ConfirmModal";
import { LeaveRouteConfirmModal } from "metabase/common/components/LeaveConfirmModal";
import { useDispatch, useSelector } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { useUserSetting } from "metabase/settings";
import {
Group,
@@ -93,9 +93,10 @@ export function PermissionsPageLayout({
const isHelpReferenceOpen = useSelector(getIsHelpReferenceOpen);
const dispatch = useDispatch();
+ const navigate = useNavigate();
const navigateToTab = (tab: PermissionsPageTab) =>
- dispatch(push(`/admin/permissions/${tab}`));
+ navigate(`/admin/permissions/${tab}`);
const clearSaveError = () => {
dispatch(clearPermissionsSaveError());
diff --git a/frontend/src/metabase/admin/permissions/pages/CollectionPermissionsPage/CollectionPermissionsPage.tsx b/frontend/src/metabase/admin/permissions/pages/CollectionPermissionsPage/CollectionPermissionsPage.tsx
index 7b565fadbcd..cdfe7a00e64 100644
--- a/frontend/src/metabase/admin/permissions/pages/CollectionPermissionsPage/CollectionPermissionsPage.tsx
+++ b/frontend/src/metabase/admin/permissions/pages/CollectionPermissionsPage/CollectionPermissionsPage.tsx
@@ -4,7 +4,7 @@ import { t } from "ttag";
import { CollectionPermissionsHelp } from "metabase/admin/permissions/components/CollectionPermissionsHelp";
import { useListCollectionsTreeQuery } from "metabase/api";
import { useDispatch, useSelector } from "metabase/redux";
-import { push, useParams } from "metabase/router";
+import { useNavigate, useParams } from "metabase/router";
import type { CollectionId } from "metabase-types/api";
import {
@@ -31,6 +31,7 @@ import { assertNumericId } from "../../types";
export function CollectionPermissionsPage() {
const dispatch = useDispatch();
+ const navigate = useNavigate();
useListCollectionsTreeQuery(collectionsQuery);
// These selectors resolve the selected collection from the route, so they
@@ -58,7 +59,7 @@ export function CollectionPermissionsPage() {
}, [dispatch]);
const navigateToItem = ({ id }: { id: CollectionId }) =>
- dispatch(push(`/admin/permissions/collections/${id}`));
+ navigate(`/admin/permissions/collections/${id}`);
const handlePermissionChange = useCallback(
(
diff --git a/frontend/src/metabase/admin/permissions/pages/DatabasePermissionsPage/DatabasesPermissionsPage.tsx b/frontend/src/metabase/admin/permissions/pages/DatabasePermissionsPage/DatabasesPermissionsPage.tsx
index 1767cdafabc..75f7189ed19 100644
--- a/frontend/src/metabase/admin/permissions/pages/DatabasePermissionsPage/DatabasesPermissionsPage.tsx
+++ b/frontend/src/metabase/admin/permissions/pages/DatabasePermissionsPage/DatabasesPermissionsPage.tsx
@@ -6,7 +6,7 @@ import { PermissionsEditorLegacyNoSelfServiceWarning } from "metabase/admin/perm
import type { ITreeNodeItem } from "metabase/common/components/tree/types";
import { PLUGIN_ADVANCED_PERMISSIONS } from "metabase/plugins";
import { useDispatch, useSelector } from "metabase/redux";
-import { Outlet, push, useParams } from "metabase/router";
+import { Outlet, useNavigate, useParams } from "metabase/router";
import { getSetting } from "metabase/settings";
import { Center, Loader } from "metabase/ui";
@@ -43,6 +43,7 @@ import {
export function DatabasesPermissionsPage() {
const dispatch = useDispatch();
+ const navigate = useNavigate();
// These selectors resolve the focused database/schema/table from the route,
// so they take the route params rather than reading them from the store.
@@ -64,17 +65,15 @@ export function DatabasesPermissionsPage() {
);
const navigateToItem = (item: ITreeNodeItem) =>
- dispatch(
- push(
- getDatabaseFocusPermissionsUrl(
- // The sidebar types `onSelect` with the base tree item, but every node
- // it renders here comes from `getDataFocusSidebar`, which builds
- // `DataTreeNodeItem`s carrying an `entityId`.
- (item as DataTreeNodeItem).entityId,
- ),
+ navigate(
+ getDatabaseFocusPermissionsUrl(
+ // The sidebar types `onSelect` with the base tree item, but every node
+ // it renders here comes from `getDataFocusSidebar`, which builds
+ // `DataTreeNodeItem`s carrying an `entityId`.
+ (item as DataTreeNodeItem).entityId,
),
);
- const navigateToDatabaseList = () => dispatch(push(DATABASES_BASE_PATH));
+ const navigateToDatabaseList = () => navigate(DATABASES_BASE_PATH);
const showSplitPermsMessage = useSelector((state) =>
getSetting(state, "show-updated-permission-banner"),
@@ -88,9 +87,9 @@ export function DatabasesPermissionsPage() {
const handleEntityChange = useCallback(
(entityType: string) => {
- dispatch(push(`/admin/permissions/data/${entityType}`));
+ navigate(`/admin/permissions/data/${entityType}`);
},
- [dispatch],
+ [navigate],
);
const handlePermissionChange = useCallback(
@@ -119,14 +118,12 @@ export function DatabasesPermissionsPage() {
action: PermissionAction,
item: PermissionEditorEntity,
) => {
- dispatch(
- action.actionCreator(item.entityId, assertNumericId(item.id), "database"),
- );
+ action.onSelect(item.entityId, assertNumericId(item.id), "database");
};
const handleBreadcrumbsItemSelect = (item: PermissionEditorBreadcrumb) => {
if (item.url) {
- dispatch(push(item.url));
+ navigate(item.url);
}
};
diff --git a/frontend/src/metabase/admin/permissions/pages/GroupDataPermissionsPage/GroupsPermissionsPage.tsx b/frontend/src/metabase/admin/permissions/pages/GroupDataPermissionsPage/GroupsPermissionsPage.tsx
index 0001c94757d..44430a4497f 100644
--- a/frontend/src/metabase/admin/permissions/pages/GroupDataPermissionsPage/GroupsPermissionsPage.tsx
+++ b/frontend/src/metabase/admin/permissions/pages/GroupDataPermissionsPage/GroupsPermissionsPage.tsx
@@ -6,7 +6,7 @@ import { PermissionsEditorLegacyNoSelfServiceWarning } from "metabase/admin/perm
import type { ITreeNodeItem } from "metabase/common/components/tree/types";
import { PLUGIN_ADVANCED_PERMISSIONS } from "metabase/plugins";
import { useDispatch, useSelector } from "metabase/redux";
-import { Outlet, push, useParams } from "metabase/router";
+import { Outlet, useNavigate, useParams } from "metabase/router";
import { getSetting } from "metabase/settings";
import { Center, Loader } from "metabase/ui";
@@ -42,6 +42,7 @@ import {
export function GroupsPermissionsPage() {
const dispatch = useDispatch();
+ const navigate = useNavigate();
// These selectors resolve the focused group from the route, so they take the
// route params rather than reading them from the store.
@@ -60,7 +61,7 @@ export function GroupsPermissionsPage() {
const groupRouteParams = parseGroupRouteParams(params);
const navigateToItem = (item: ITreeNodeItem) =>
- dispatch(push(`${GROUPS_BASE_PATH}/${item.id}`));
+ navigate(`${GROUPS_BASE_PATH}/${item.id}`);
const { loading: isLoading } = useAsync(async () => {
if (groupRouteParams.groupId) {
@@ -77,9 +78,9 @@ export function GroupsPermissionsPage() {
const handleEntityChange = useCallback(
(entityType: string) => {
- dispatch(push(`/admin/permissions/data/${entityType}/`));
+ navigate(`/admin/permissions/data/${entityType}/`);
},
- [dispatch],
+ [navigate],
);
const handleTableItemSelect = useCallback(
@@ -87,13 +88,11 @@ export function GroupsPermissionsPage() {
if (groupRouteParams.groupId == null) {
return;
}
- dispatch(
- push(
- getGroupFocusPermissionsUrl(groupRouteParams.groupId, item.entityId),
- ),
+ navigate(
+ getGroupFocusPermissionsUrl(groupRouteParams.groupId, item.entityId),
);
},
- [dispatch, groupRouteParams.groupId],
+ [groupRouteParams.groupId, navigate],
);
const handlePermissionChange = useCallback(
@@ -125,14 +124,12 @@ export function GroupsPermissionsPage() {
if (groupRouteParams.groupId == null) {
return;
}
- dispatch(
- action.actionCreator(item.entityId, groupRouteParams.groupId, "group"),
- );
+ action.onSelect(item.entityId, groupRouteParams.groupId, "group");
};
const handleBreadcrumbsItemSelect = (item: PermissionEditorBreadcrumb) => {
if (item.url) {
- dispatch(push(item.url));
+ navigate(item.url);
}
};
diff --git a/frontend/src/metabase/admin/permissions/permissions.ts b/frontend/src/metabase/admin/permissions/permissions.ts
index f5da3223db3..2c124d7b695 100644
--- a/frontend/src/metabase/admin/permissions/permissions.ts
+++ b/frontend/src/metabase/admin/permissions/permissions.ts
@@ -29,7 +29,7 @@ import {
createAction,
createThunkAction,
} from "metabase/redux";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import { getMetadataWithHiddenTables } from "metabase/selectors/metadata";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type {
@@ -186,18 +186,14 @@ export const limitDatabasePermission = createThunkAction(
);
}
- dispatch(navigateToGranularPermissions(groupId, entityId));
+ navigateToGranularPermissions(groupId, entityId);
},
);
-export const NAVIGATE_TO_GRANULAR_PERMISSIONS =
- "metabase/admin/permissions/NAVIGATE_TO_GRANULAR_PERMISSIONS";
-export const navigateToGranularPermissions = createThunkAction(
- NAVIGATE_TO_GRANULAR_PERMISSIONS,
- (groupId, entityId) => (dispatch) => {
- dispatch(push(getGroupFocusPermissionsUrl(groupId, entityId)));
- },
-);
+export const navigateToGranularPermissions = (
+ groupId: GroupId,
+ entityId: PermissionEntityId,
+) => navigate(getGroupFocusPermissionsUrl(groupId, entityId));
export interface UpdateDataPermissionParams {
groupId: GroupId;
@@ -249,18 +245,15 @@ export const updateDataPermission = createThunkAction(
}
const metadata = getMetadataWithHiddenTables(getState());
- if (permissionInfo.postActions) {
- const action = permissionInfo.postActions?.[value]?.(
- entityId,
- groupId,
- view,
- value,
- getState,
- );
+ const postAction = permissionInfo.postActions?.[value];
+ if (postAction) {
+ // A post action takes the change over: it sends the admin to where this
+ // value is configured, so the permission is not applied here.
+ const action = postAction(entityId, groupId, view, value, getState);
if (action) {
dispatch(action);
- return;
}
+ return;
}
return { groupId, permissionInfo, value, metadata, entityId };
diff --git a/frontend/src/metabase/admin/utils.ts b/frontend/src/metabase/admin/utils.ts
index 3e20a1a1b18..27a7ed4d393 100644
--- a/frontend/src/metabase/admin/utils.ts
+++ b/frontend/src/metabase/admin/utils.ts
@@ -1,11 +1,9 @@
import { useLayoutEffect } from "react";
import { shouldShowTenantsUpsell } from "metabase/admin/people/selectors";
-import { connect } from "metabase/redux";
-import type { State } from "metabase/redux/store";
-import type { AdminPath } from "metabase/redux/store/admin";
+import { useSelector } from "metabase/redux";
import { createRedirectGuard } from "metabase/route-guards";
-import { push, replace } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { getAdminPaths } from "metabase/selectors/admin";
import { getSetting } from "metabase/settings";
@@ -16,36 +14,19 @@ export const createAdminRouteGuard = (routeKey: string) =>
"/unauthorized",
);
-const mapStateToProps = (state: State) => ({
- adminItems: getAdminPaths(state),
-});
+export const RedirectToAllowedSettings = () => {
+ const adminItems = useSelector(getAdminPaths);
+ const navigate = useNavigate();
-const mapDispatchToProps = {
- push,
- replace,
-};
-
-interface RedirectToAllowedSettingsInnerProps {
- adminItems: AdminPath[];
- replace: (path: string) => void;
-}
-
-const RedirectToAllowedSettingsInner = ({
- adminItems,
- replace,
-}: RedirectToAllowedSettingsInnerProps) => {
useLayoutEffect(() => {
- replace(adminItems.length === 0 ? "/unauthorized" : adminItems[0].path);
- }, [adminItems, replace]);
+ navigate(adminItems.length === 0 ? "/unauthorized" : adminItems[0].path, {
+ replace: true,
+ });
+ }, [adminItems, navigate]);
return null;
};
-export const RedirectToAllowedSettings = connect(
- mapStateToProps,
- mapDispatchToProps,
-)(RedirectToAllowedSettingsInner);
-
export const createTenantsRouteGuard = () =>
createRedirectGuard(
(state) =>
diff --git a/frontend/src/metabase/app-main.js b/frontend/src/metabase/app-main.js
index b78baea5cd3..78c84078090 100644
--- a/frontend/src/metabase/app-main.js
+++ b/frontend/src/metabase/app-main.js
@@ -10,7 +10,7 @@ import { init } from "metabase/app";
import { setRequestClientHeaders } from "metabase/embedding/lib/auth/set-request-client-headers";
import { mainReducers } from "metabase/reducers-main";
import { setErrorPage } from "metabase/redux/app";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import { getRoutes } from "metabase/routes";
import { getUser } from "metabase/selectors/user";
import { IFRAMED_IN_SELF, isWithinIframe } from "metabase/utils/iframe";
@@ -59,7 +59,7 @@ init(mainReducers, getRoutes, (store) => {
if (getUser(store.getState())) {
store.dispatch(Api.util.resetApiState());
}
- store.dispatch(push("/auth/login"));
+ navigate("/auth/login");
});
// received a 403 response
diff --git a/frontend/src/metabase/app.js b/frontend/src/metabase/app.js
index a21c5e658b9..68c4d4aa675 100644
--- a/frontend/src/metabase/app.js
+++ b/frontend/src/metabase/app.js
@@ -36,7 +36,7 @@ import { initializeInteractiveEmbedding } from "metabase/embedding/interactive-e
import { MetabotProvider } from "metabase/metabot/context";
import { PLUGIN_APP_INIT_FUNCTIONS } from "metabase/plugins";
import { MetabaseReduxProvider } from "metabase/redux";
-import { LOCATION_CHANGE, createRouterNavigator } from "metabase/router";
+import { LOCATION_CHANGE } from "metabase/router";
import { getUserId } from "metabase/selectors/user";
import { refetchSiteSettings } from "metabase/settings";
import { GlobalStyles } from "metabase/styled-components/containers/GlobalStyles";
@@ -78,12 +78,7 @@ function _init(reducers, getRoutes, callback) {
});
}
- const store = getStore(
- reducers,
- createRouterNavigator(),
- undefined,
- extraMiddlewares,
- );
+ const store = getStore(reducers, undefined, extraMiddlewares);
const routes = getRoutes(store);
const mirrorLocation = createLocationMirror(store.dispatch);
diff --git a/frontend/src/metabase/app/nav/AppBar.tsx b/frontend/src/metabase/app/nav/AppBar.tsx
index 5f9387bf9fb..970467deb49 100644
--- a/frontend/src/metabase/app/nav/AppBar.tsx
+++ b/frontend/src/metabase/app/nav/AppBar.tsx
@@ -27,7 +27,7 @@ import {
} from "metabase/query_builder/selectors";
import { useDispatch, useSelector } from "metabase/redux";
import { closeNavbar, toggleNavbar } from "metabase/redux/app";
-import { push, useLocation, useParams } from "metabase/router";
+import { useLocation, useNavigate, useParams } from "metabase/router";
import { getDetailViewState, getIsNavbarOpen } from "metabase/selectors/app";
import { getUser } from "metabase/selectors/user";
import { modelToUrl } from "metabase/urls";
@@ -55,6 +55,7 @@ export function getSearchResultSelection(
export function AppBarContainer() {
const dispatch = useDispatch();
+ const navigate = useNavigate();
// These selectors derive app-bar visibility from the URL, so they take the
// router props rather than reading them from the store.
@@ -113,7 +114,7 @@ export function AppBarContainer() {
if (selection.type === "zoom") {
dispatch(zoomInRow({ objectId: selection.objectId }));
} else {
- dispatch(push(selection.url));
+ navigate(selection.url);
}
};
diff --git a/frontend/src/metabase/archive/actions.ts b/frontend/src/metabase/archive/actions.ts
index 907024d1a8e..52063bc5fa7 100644
--- a/frontend/src/metabase/archive/actions.ts
+++ b/frontend/src/metabase/archive/actions.ts
@@ -2,14 +2,14 @@ import { t } from "ttag";
import { createThunkAction } from "metabase/redux";
import { addUndo } from "metabase/redux/undo";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
export const deletePermanently = createThunkAction(
"metabase/archive/DELETE_PERMANENTLY",
// pass in result of Entity.actions.delete(...)
(entityDeleteAction: any) => async (dispatch) => {
await dispatch(entityDeleteAction);
- dispatch(push("/trash"));
+ navigate("/trash");
dispatch(addUndo({ message: t`This item has been permanently deleted.` }));
},
);
diff --git a/frontend/src/metabase/archive/hooks/use-restore.ts b/frontend/src/metabase/archive/hooks/use-restore.ts
index 39f3735a25e..6258a06d556 100644
--- a/frontend/src/metabase/archive/hooks/use-restore.ts
+++ b/frontend/src/metabase/archive/hooks/use-restore.ts
@@ -14,7 +14,7 @@ import { listTag } from "metabase/api/tags";
import { TRASHABLE_MODELS, getParentEntityLink } from "metabase/archive/utils";
import { useToast } from "metabase/common/hooks/use-toast";
import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import type {
Card,
CardId,
@@ -64,6 +64,7 @@ export type RestoreResult = {
export function useRestore() {
const dispatch = useDispatch();
+ const navigate = useNavigate();
const [sendToast] = useToast();
const [updateCard] = useUpdateCardMutation();
const [updateDashboard] = useUpdateDashboardMutation();
@@ -118,7 +119,7 @@ export function useRestore() {
sendToast({
message: t`${name} has been restored.`,
actionLabel: t`View`,
- action: () => dispatch(push(redirect)),
+ action: () => navigate(redirect),
});
return result;
@@ -130,6 +131,7 @@ export function useRestore() {
updateDashboard,
updateCollection,
updateDocument,
+ navigate,
],
);
}
diff --git a/frontend/src/metabase/auth/components/ResetPassword/ResetPassword.tsx b/frontend/src/metabase/auth/components/ResetPassword/ResetPassword.tsx
index 66935c72fcd..3a90fafafad 100644
--- a/frontend/src/metabase/auth/components/ResetPassword/ResetPassword.tsx
+++ b/frontend/src/metabase/auth/components/ResetPassword/ResetPassword.tsx
@@ -7,7 +7,7 @@ import { useValidatePassword } from "metabase/common/hooks";
import { useToast } from "metabase/common/hooks/use-toast";
import { useDispatch } from "metabase/redux";
import { resetPassword } from "metabase/redux/auth";
-import { replace, useParams, useSearchParams } from "metabase/router";
+import { useNavigate, useParams, useSearchParams } from "metabase/router";
import { Button } from "metabase/ui";
import * as Urls from "metabase/urls";
@@ -28,6 +28,7 @@ export const ResetPassword = (): JSX.Element | null => {
const redirectUrl = searchParams.get("redirect") ?? undefined;
const email = searchParams.get("email") ?? undefined;
const dispatch = useDispatch();
+ const navigate = useNavigate();
const [sendToast] = useToast();
const validatePassword = useValidatePassword();
const { data: status, isLoading } =
@@ -38,12 +39,12 @@ export const ResetPassword = (): JSX.Element | null => {
const { sessionCreated } = await dispatch(
resetPassword({ token, password }),
).unwrap();
- dispatch(
- replace(sessionCreated ? redirectUrl || "/" : Urls.login(redirectUrl)),
- );
+ navigate(sessionCreated ? redirectUrl || "/" : Urls.login(redirectUrl), {
+ replace: true,
+ });
sendToast({ message: t`You've updated your password.` });
},
- [token, dispatch, redirectUrl, sendToast],
+ [token, dispatch, redirectUrl, sendToast, navigate],
);
if (isLoading) {
diff --git a/frontend/src/metabase/browse/metrics/MetricsTable.tsx b/frontend/src/metabase/browse/metrics/MetricsTable.tsx
index 955647c4ed8..5aa313ecbb2 100644
--- a/frontend/src/metabase/browse/metrics/MetricsTable.tsx
+++ b/frontend/src/metabase/browse/metrics/MetricsTable.tsx
@@ -23,8 +23,7 @@ import type { ResponsiveProps } from "metabase/common/components/ItemsTable/util
import { Link } from "metabase/common/components/Link";
import { MarkdownPreview } from "metabase/common/components/MarkdownPreview";
import CS from "metabase/css/core/index.css";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
Button,
FixedSizeIcon,
@@ -167,7 +166,7 @@ export function MetricsTable({
}
function MetricRow({ metric }: { metric?: MetricResult }) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const handleClick = useCallback(
(event: MouseEvent) => {
@@ -195,10 +194,10 @@ function MetricRow({ metric }: { metric?: MetricResult }) {
if ((event.ctrlKey || event.metaKey) && event.button === 0) {
Urls.openInNewTab(subpathSafeUrl);
} else {
- dispatch(push(url));
+ navigate(url);
}
},
- [metric, dispatch],
+ [metric, navigate],
);
return (
@@ -321,7 +320,7 @@ type MetricAction = {
function MenuCell({ metric }: { metric?: MetricResult }) {
const [createBookmark] = useCreateBookmarkMutation();
const [deleteBookmark] = useDeleteBookmarkMutation();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const archive = useSetArchive();
const actions = useMemo(() => {
@@ -365,7 +364,7 @@ function MenuCell({ metric }: { metric?: MetricResult }) {
title: t`Open collection`,
icon: "folder",
action() {
- dispatch(push(Urls.collection(metric.collection)));
+ navigate(Urls.collection(metric.collection));
},
});
}
@@ -382,7 +381,7 @@ function MenuCell({ metric }: { metric?: MetricResult }) {
}
return actions;
- }, [metric, createBookmark, deleteBookmark, dispatch, archive]);
+ }, [metric, createBookmark, deleteBookmark, navigate, archive]);
return (
<td
diff --git a/frontend/src/metabase/browse/models/ModelsTable.tsx b/frontend/src/metabase/browse/models/ModelsTable.tsx
index 282b74aa1e8..55665b6519a 100644
--- a/frontend/src/metabase/browse/models/ModelsTable.tsx
+++ b/frontend/src/metabase/browse/models/ModelsTable.tsx
@@ -18,8 +18,7 @@ import type { ResponsiveProps } from "metabase/common/components/ItemsTable/util
import { Link } from "metabase/common/components/Link";
import { MarkdownPreview } from "metabase/common/components/MarkdownPreview";
import { useGetIcon } from "metabase/hooks/use-icon";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
Ellipsified,
FixedSizeIcon,
@@ -159,7 +158,7 @@ function preventDefault(event: MouseEvent) {
}
const ModelRow = ({ model }: { model?: ModelResult }) => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const handleClick = useCallback(
(event: MouseEvent) => {
@@ -186,10 +185,10 @@ const ModelRow = ({ model }: { model?: ModelResult }) => {
if ((event.ctrlKey || event.metaKey) && event.button === 0) {
Urls.openInNewTab(subpathSafeUrl);
} else {
- dispatch(push(url));
+ navigate(url);
}
},
- [model, dispatch],
+ [model, navigate],
);
return (
diff --git a/frontend/src/metabase/browse/tables/TablePermalinkRedirect.tsx b/frontend/src/metabase/browse/tables/TablePermalinkRedirect.tsx
index 77e18aed40b..3abd7100e0b 100644
--- a/frontend/src/metabase/browse/tables/TablePermalinkRedirect.tsx
+++ b/frontend/src/metabase/browse/tables/TablePermalinkRedirect.tsx
@@ -4,8 +4,7 @@ import { useListDatabasesQuery, useListTablesQuery } from "metabase/api";
import { NotFound } from "metabase/common/components/ErrorPages";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { findDatabaseByName } from "metabase/common/utils/database";
-import { useDispatch } from "metabase/redux";
-import { replace, useParams } from "metabase/router";
+import { useNavigate, useParams } from "metabase/router";
import * as Urls from "metabase/urls";
import type { DatabaseId, Table } from "metabase-types/api";
import { isConcreteTableId } from "metabase-types/api";
@@ -30,7 +29,7 @@ export const TablePermalinkRedirect = () => {
tableName = "",
} = useParams<{ dbName: string; schemaName: string; tableName: string }>();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const {
data: databasesData,
error: databasesError,
@@ -61,9 +60,9 @@ export const TablePermalinkRedirect = () => {
useEffect(() => {
if (targetUrl) {
- dispatch(replace(targetUrl));
+ navigate(targetUrl, { replace: true });
}
- }, [targetUrl, dispatch]);
+ }, [targetUrl, navigate]);
const error = databasesError ?? tablesError;
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx
index 392c9109aeb..5ccfce97626 100644
--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx
+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx
@@ -41,7 +41,7 @@ import { useListSelect } from "metabase/common/hooks/use-list-select";
import { useDispatch } from "metabase/redux";
import { addUndo } from "metabase/redux/undo";
import { MAX_UPLOAD_SIZE, MAX_UPLOAD_STRING } from "metabase/redux/uploads";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import type Database from "metabase-lib/v1/metadata/Database";
import type {
Bookmark,
@@ -85,6 +85,7 @@ export const CollectionContentView = ({
visibleColumns?: CollectionContentTableColumn[];
}) => {
const dispatch = useDispatch();
+ const navigate = useNavigate();
const [deleteCollection] = useDeleteCollectionMutation();
useCollectionChartPaste(collection);
@@ -278,7 +279,7 @@ export const CollectionContentView = ({
onDeletePermanently={async () => {
try {
await deleteCollection({ id: collectionId }).unwrap();
- dispatch(push("/trash"));
+ navigate("/trash");
dispatch(
addUndo({
message: t`This item has been permanently deleted.`,
diff --git a/frontend/src/metabase/collections/components/CollectionHeader/CollectionPermissions.tsx b/frontend/src/metabase/collections/components/CollectionHeader/CollectionPermissions.tsx
index 1ef53a2030b..1a27547fc3d 100644
--- a/frontend/src/metabase/collections/components/CollectionHeader/CollectionPermissions.tsx
+++ b/frontend/src/metabase/collections/components/CollectionHeader/CollectionPermissions.tsx
@@ -2,8 +2,7 @@ import { t } from "ttag";
import { Link } from "metabase/common/components/Link/Link";
import { ToolbarButton } from "metabase/common/components/ToolbarButton";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import * as Urls from "metabase/urls";
import type { Collection } from "metabase-types/api";
@@ -14,7 +13,7 @@ interface CollectionPermissionsProps {
export const CollectionPermissions = ({
collection,
}: CollectionPermissionsProps) => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const url = `${Urls.collection(collection)}/permissions`;
return (
@@ -26,7 +25,7 @@ export const CollectionPermissions = ({
tooltipPosition="bottom"
onClick={() => {
// ToolbarButton has "e.preventDefault", so we have to navigate manually
- dispatch(push(url));
+ navigate(url);
}}
/>
</Link>
diff --git a/frontend/src/metabase/collections/components/CollectionLanding/CollectionLanding.tsx b/frontend/src/metabase/collections/components/CollectionLanding/CollectionLanding.tsx
index 5b241beb9b0..415213457e4 100644
--- a/frontend/src/metabase/collections/components/CollectionLanding/CollectionLanding.tsx
+++ b/frontend/src/metabase/collections/components/CollectionLanding/CollectionLanding.tsx
@@ -1,8 +1,7 @@
import { useEffect } from "react";
import { useGetCollectionQuery } from "metabase/api";
-import { useDispatch } from "metabase/redux";
-import { Outlet, replace, useParams } from "metabase/router";
+import { Outlet, useNavigate, useParams } from "metabase/router";
import { extractCollectionId } from "metabase/urls";
import { isNotNull } from "metabase/utils/types";
@@ -14,7 +13,7 @@ export type CollectionLandingParams = {
const CollectionLanding = () => {
const { slug } = useParams<CollectionLandingParams>();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const { data: trashCollection } = useGetCollectionQuery({ id: "trash" });
const collectionId = extractCollectionId(slug);
@@ -29,10 +28,10 @@ const CollectionLanding = () => {
trashCollection.id === collectionId;
if (isTrashSlug || isTrashCollectionId) {
- dispatch(replace("/trash"));
+ navigate("/trash", { replace: true });
}
},
- [dispatch, slug, trashCollection?.id, collectionId],
+ [slug, trashCollection?.id, collectionId, navigate],
);
if (!isNotNull(collectionId)) {
diff --git a/frontend/src/metabase/comments/utils.ts b/frontend/src/metabase/comments/utils.ts
index f8c1dd85c4c..12cf7650d32 100644
--- a/frontend/src/metabase/comments/utils.ts
+++ b/frontend/src/metabase/comments/utils.ts
@@ -2,8 +2,7 @@ import dayjs from "dayjs";
import type { LocationSensorState } from "react-use/lib/useLocation";
import { match } from "ts-pattern";
-import type { DispatchFn } from "metabase/redux";
-import { replace } from "metabase/router";
+import { navigate } from "metabase/router";
import type { Comment, CommentEntityType, EntityId } from "metabase-types/api";
import type { CommentThread } from "./types";
@@ -123,10 +122,7 @@ export function formatCommentDate(dateOrString: string | Date) {
}).format(date);
}
-export function deleteNewParamFromURLIfNeeded(
- location: LocationSensorState,
- dispatch: DispatchFn,
-) {
+export function deleteNewParamFromURLIfNeeded(location: LocationSensorState) {
const search = new URLSearchParams(location.search);
if (search.get("new") == null) {
@@ -135,5 +131,8 @@ export function deleteNewParamFromURLIfNeeded(
search.delete("new");
const newSearch = search.toString();
- dispatch(replace({ pathname: location.pathname, search: newSearch }));
+ navigate(
+ { pathname: location.pathname, search: newSearch },
+ { replace: true },
+ );
}
diff --git a/frontend/src/metabase/common/CreateDashboard/CreateDashboardModal.tsx b/frontend/src/metabase/common/CreateDashboard/CreateDashboardModal.tsx
index f6756a3a723..42b7d0edf4a 100644
--- a/frontend/src/metabase/common/CreateDashboard/CreateDashboardModal.tsx
+++ b/frontend/src/metabase/common/CreateDashboard/CreateDashboardModal.tsx
@@ -1,8 +1,7 @@
import { useCallback } from "react";
import { t } from "ttag";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Modal, type ModalProps } from "metabase/ui";
import * as Urls from "metabase/urls";
import type { CollectionId, Dashboard } from "metabase-types/api";
@@ -24,17 +23,17 @@ export const CreateDashboardModal = ({
onCreate,
onClose,
}: CreateDashboardModalProps & Omit<ModalProps, "onClose">) => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const handleCreate = useCallback(
(dashboard: Dashboard) => {
if (typeof onCreate === "function") {
onCreate(dashboard);
} else {
onClose?.();
- dispatch(push(Urls.dashboard(dashboard, { editMode: true })));
+ navigate(Urls.dashboard(dashboard, { editMode: true }));
}
},
- [onCreate, onClose, dispatch],
+ [onCreate, onClose, navigate],
);
return (
diff --git a/frontend/src/metabase/common/collections/containers/CreateCollectionModal.tsx b/frontend/src/metabase/common/collections/containers/CreateCollectionModal.tsx
index eb682db5375..509a4f8ac68 100644
--- a/frontend/src/metabase/common/collections/containers/CreateCollectionModal.tsx
+++ b/frontend/src/metabase/common/collections/containers/CreateCollectionModal.tsx
@@ -4,8 +4,7 @@ import { t } from "ttag";
import { useCreateCollectionMutation } from "metabase/api";
import { getCollectionPathAsArray } from "metabase/common/collections/utils";
import { PLUGIN_LIBRARY } from "metabase/plugins";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Modal } from "metabase/ui";
import * as Urls from "metabase/urls";
import type { Collection } from "metabase-types/api";
@@ -29,7 +28,7 @@ function CreateCollectionModal({
shouldNavigateOnCreate = true,
...props
}: CreateCollectionModalOwnProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [createCollection] = useCreateCollectionMutation();
const handleCreate = useCallback(
@@ -57,10 +56,10 @@ function CreateCollectionModal({
});
}
- dispatch(push(visitUrl));
+ navigate(visitUrl);
}
},
- [createCollection, dispatch, onCreate, onClose, shouldNavigateOnCreate],
+ [createCollection, onCreate, onClose, shouldNavigateOnCreate, navigate],
);
return (
diff --git a/frontend/src/metabase/common/components/NotFoundFallbackPage.tsx b/frontend/src/metabase/common/components/NotFoundFallbackPage.tsx
index 3e5045eee99..ca80d975d55 100644
--- a/frontend/src/metabase/common/components/NotFoundFallbackPage.tsx
+++ b/frontend/src/metabase/common/components/NotFoundFallbackPage.tsx
@@ -2,11 +2,10 @@ import { useMount } from "react-use";
import { useLazyGetCurrentUserQuery } from "metabase/api";
import { NotFound } from "metabase/common/components/ErrorPages";
-import { useDispatch } from "metabase/redux";
-import { replace } from "metabase/router";
+import { useNavigate } from "metabase/router";
export const NotFoundFallbackPage = () => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
// A 404 can mean the session expired.
// Re-check who we are and bounce to login if the current user can't be fetched.
const [refetchCurrentUser] = useLazyGetCurrentUserQuery();
@@ -15,7 +14,7 @@ export const NotFoundFallbackPage = () => {
async function refresh() {
const { isError } = await refetchCurrentUser();
if (isError) {
- dispatch(replace("/auth/login"));
+ navigate("/auth/login", { replace: true });
}
}
refresh();
diff --git a/frontend/src/metabase/common/components/SearchResult/SearchResult.tsx b/frontend/src/metabase/common/components/SearchResult/SearchResult.tsx
index bc16251892b..9e294e3ec3c 100644
--- a/frontend/src/metabase/common/components/SearchResult/SearchResult.tsx
+++ b/frontend/src/metabase/common/components/SearchResult/SearchResult.tsx
@@ -5,9 +5,8 @@ import { forwardRef, useCallback } from "react";
import { Markdown } from "metabase/common/components/Markdown";
import { trackSearchClick } from "metabase/common/search/analytics";
import { PLUGIN_MODERATION } from "metabase/plugins";
-import { useDispatch } from "metabase/redux";
import type { LocationDescriptorObject } from "metabase/router";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import type { AnchorProps, BoxProps, StackProps } from "metabase/ui";
import {
Anchor,
@@ -113,13 +112,11 @@ export function SearchResult({
const isActive = isItemActive(result);
const isLoading = isItemLoading(result);
-
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const onChangeLocation = useCallback(
- (nextLocation: LocationDescriptorObject | string) =>
- dispatch(push(nextLocation)),
- [dispatch],
+ (nextLocation: LocationDescriptorObject | string) => navigate(nextLocation),
+ [navigate],
);
const onXRayClick = (e: MouseEvent<HTMLButtonElement>) => {
diff --git a/frontend/src/metabase/common/hooks/use-url-state/use-url-state.ts b/frontend/src/metabase/common/hooks/use-url-state/use-url-state.ts
index 4fa345f1734..4151ec4c168 100644
--- a/frontend/src/metabase/common/hooks/use-url-state/use-url-state.ts
+++ b/frontend/src/metabase/common/hooks/use-url-state/use-url-state.ts
@@ -3,9 +3,8 @@ import { useEffectOnce, useLatest } from "react-use";
import _ from "underscore";
import { useDebouncedValue } from "metabase/common/hooks/use-debounced-value";
-import { useDispatch } from "metabase/redux";
import type { Location } from "metabase/router";
-import { push, queryToSearch, replace } from "metabase/router";
+import { queryToSearch, useNavigate } from "metabase/router";
import { parseSearchQuery } from "metabase/utils/browser";
import type { UrlStateQuery } from "./types";
@@ -41,7 +40,7 @@ export function useUrlState<State extends BaseState>(
location: Location,
{ parse, serialize }: UrlStateConfig<State>,
): [State, UrlStateActions<State>] {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [state, setState] = useState(() =>
parse(parseSearchQuery(location.search)),
);
@@ -75,9 +74,9 @@ export function useUrlState<State extends BaseState>(
...location,
search: queryToSearch(serialize(state)),
};
- dispatch(push(newLocation));
+ navigate(newLocation);
},
- [dispatch, location, serialize],
+ [location, serialize, navigate],
);
const updateUrlRef = useLatest(updateUrl);
@@ -87,7 +86,10 @@ export function useUrlState<State extends BaseState>(
// Replacing to the identical URL notifies the router, which re-renders every
// location consumer on the page for nothing.
if (!_.isEqual(query, parseSearchQuery(location.search))) {
- dispatch(replace({ ...location, search: queryToSearch(query) }));
+ navigate(
+ { ...location, search: queryToSearch(query) },
+ { replace: true, state: location.state },
+ );
}
});
diff --git a/frontend/src/metabase/common/hooks/use-user-key-value.unit.spec.tsx b/frontend/src/metabase/common/hooks/use-user-key-value.unit.spec.tsx
index f0dbb25f7f7..6af19f43c48 100644
--- a/frontend/src/metabase/common/hooks/use-user-key-value.unit.spec.tsx
+++ b/frontend/src/metabase/common/hooks/use-user-key-value.unit.spec.tsx
@@ -23,7 +23,7 @@ function setup({
}: {
hookArgs: UseUserKeyValueParams<UserKeyValue>;
}) {
- const store = getStore(reducers, undefined, createMockState());
+ const store = getStore(reducers, createMockState());
function Wrapper({ children }: any) {
return (
diff --git a/frontend/src/metabase/dashboard/actions/actions.unit.spec.ts b/frontend/src/metabase/dashboard/actions/actions.unit.spec.ts
index c01e0a2a997..e2d78e39f11 100644
--- a/frontend/src/metabase/dashboard/actions/actions.unit.spec.ts
+++ b/frontend/src/metabase/dashboard/actions/actions.unit.spec.ts
@@ -5,6 +5,7 @@ import {
createMockState,
createMockStoreDashboard,
} from "metabase/redux/store/mocks";
+import { navigate } from "metabase/router";
import {
createMockDashboard,
createMockDashboardCard,
@@ -29,11 +30,17 @@ import {
updateDashboardAndCards,
} from "./";
+jest.mock("metabase/router", () => ({
+ ...jest.requireActual("metabase/router"),
+ navigate: jest.fn(),
+}));
+
describe("dashboard actions", () => {
let dispatch: jest.MockedFunction<Dispatch>;
let getState: GetState;
beforeEach(() => {
+ jest.mocked(navigate).mockClear();
dispatch = jest.fn();
getState = () =>
createMockState({
@@ -216,13 +223,7 @@ describe("dashboard actions", () => {
setEditingDashboard(null, location)(dispatch);
- expect(dispatch).toHaveBeenCalledWith({
- payload: {
- args: ["/dashboard/1"],
- method: "push",
- },
- type: "@@router/CALL_HISTORY_METHOD",
- });
+ expect(navigate).toHaveBeenCalledWith("/dashboard/1");
});
// The v3 history rebuilds `search` from `query`, so pushing a location
@@ -236,13 +237,7 @@ describe("dashboard actions", () => {
setEditingDashboard(null, location)(dispatch);
- expect(dispatch).toHaveBeenCalledWith({
- payload: {
- args: ["/dashboard/1?tab=2-tab-two"],
- method: "push",
- },
- type: "@@router/CALL_HISTORY_METHOD",
- });
+ expect(navigate).toHaveBeenCalledWith("/dashboard/1?tab=2-tab-two");
});
// The location is captured when the caller rendered, so navigating with no
@@ -256,9 +251,7 @@ describe("dashboard actions", () => {
setEditingDashboard(null, location)(dispatch);
- expect(dispatch).not.toHaveBeenCalledWith(
- expect.objectContaining({ type: "@@router/CALL_HISTORY_METHOD" }),
- );
+ expect(navigate).not.toHaveBeenCalled();
expect(dispatch).toHaveBeenCalledWith({
type: SET_EDITING_DASHBOARD,
payload: null,
diff --git a/frontend/src/metabase/dashboard/actions/core.ts b/frontend/src/metabase/dashboard/actions/core.ts
index 2ad06dfd9e4..2cfd65859c7 100644
--- a/frontend/src/metabase/dashboard/actions/core.ts
+++ b/frontend/src/metabase/dashboard/actions/core.ts
@@ -1,7 +1,7 @@
import { createAction } from "@reduxjs/toolkit";
import type { Dispatch } from "metabase/redux/store";
-import { type Location, push } from "metabase/router";
+import { type Location, navigate } from "metabase/router";
import type {
DashCardId,
DashCardVisualizationSettings,
@@ -20,14 +20,12 @@ export const setEditingDashboard = (
// current location, since this no longer reads the retired routing slice.
//
// Only navigate when there is actually a hash to strip. The location is
- // captured when the caller rendered, so pushing it unconditionally would
+ // captured when the caller rendered, so navigating unconditionally would
// clobber query params written since then (e.g. the tab the dashboard URL
// sync just selected, which it will not re-add because it dedupes on the
- // previous params). Push a path string rather than spreading the location:
- // it has no v3 `query` field, and the v3 history rebuilds `search` from
- // `query`, so spreading it would drop the query string entirely.
+ // previous params).
if (dashboard === null && location?.hash) {
- dispatch(push(`${location.pathname}${location.search}`));
+ navigate(`${location.pathname}${location.search}`);
}
dispatch({
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
index 9b9a9ac6afe..9baa66ac278 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
@@ -22,7 +22,7 @@ import { EmbeddingEntityContextProvider } from "metabase/embedding/context";
import { PLUGIN_CONTENT_TRANSLATION } from "metabase/plugins";
import { useDispatch, useSelector } from "metabase/redux";
import type { LocationDescriptorObject } from "metabase/router";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { getSetting } from "metabase/settings";
import { Flex, Group, type IconProps, Menu, Title } from "metabase/ui";
import { parseSearchQuery } from "metabase/utils/browser";
@@ -177,17 +177,18 @@ export function DashCardVisualization({
} = useDashboardContext();
const dispatch = useDispatch();
+ const navigate = useNavigate();
const onSameOriginNavigation = useCallback(
(location: LocationDescriptorObject) => {
- dispatch(push(location));
+ navigate(location);
dispatch(
setParameterValuesFromQueryParams(
parseSearchQuery(location.search ?? ""),
),
);
},
- [dispatch],
+ [dispatch, navigate],
);
const datasets = useSelector((state) => getDashcardData(state, dashcard.id));
diff --git a/frontend/src/metabase/dashboard/components/DashboardCopyModal.tsx b/frontend/src/metabase/dashboard/components/DashboardCopyModal.tsx
index f5776ea1cd0..d2555ee9622 100644
--- a/frontend/src/metabase/dashboard/components/DashboardCopyModal.tsx
+++ b/frontend/src/metabase/dashboard/components/DashboardCopyModal.tsx
@@ -6,8 +6,8 @@ import { useCopyDashboardMutation } from "metabase/api";
import { useInitialCollectionId } from "metabase/common/collections/hooks";
import type { CopyDashboardFormProperties } from "metabase/common/components/CopyDashboardForm";
import { CopyModal } from "metabase/common/components/CopyModal";
-import { useDispatch, useSelector } from "metabase/redux";
-import { replace, useLocation, useParams } from "metabase/router";
+import { useSelector } from "metabase/redux";
+import { useLocation, useNavigate, useParams } from "metabase/router";
import * as Urls from "metabase/urls";
import type { Dashboard } from "metabase-types/api";
@@ -33,7 +33,7 @@ const getTitle = (
const DashboardCopyModal = ({ onClose }: DashboardCopyModalProps) => {
const location = useLocation();
const params = useParams();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [copyDashboard] = useCopyDashboardMutation();
const dashboard = useSelector(getDashboardComplete);
const initialCollectionId = useInitialCollectionId({
@@ -74,7 +74,7 @@ const DashboardCopyModal = ({ onClose }: DashboardCopyModalProps) => {
}}
onClose={onClose}
onSaved={(savedDashboard: Dashboard) =>
- dispatch(replace(Urls.dashboard(savedDashboard)))
+ navigate(Urls.dashboard(savedDashboard), { replace: true })
}
onValuesChange={handleValuesChange}
/>
diff --git a/frontend/src/metabase/dashboard/components/QuestionPicker/actions.ts b/frontend/src/metabase/dashboard/components/QuestionPicker/actions.ts
index 28687cbd327..c40a407030e 100644
--- a/frontend/src/metabase/dashboard/components/QuestionPicker/actions.ts
+++ b/frontend/src/metabase/dashboard/components/QuestionPicker/actions.ts
@@ -1,6 +1,6 @@
import { getDashboard } from "metabase/dashboard/selectors";
import { createThunkAction } from "metabase/redux";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import * as Urls from "metabase/urls";
import type { Dashboard } from "metabase-types/api";
@@ -38,7 +38,7 @@ export const addDashboardQuestion = createThunkAction(
(type: "native" | "notebook") => (dispatch, getState) => {
const dashboard = getDashboard(getState());
if (dashboard) {
- dispatch(push(getNewQuestionUrl({ dashboard, type })));
+ navigate(getNewQuestionUrl({ dashboard, type }));
}
},
);
diff --git a/frontend/src/metabase/dashboard/containers/DashboardApp/DashboardApp.tsx b/frontend/src/metabase/dashboard/containers/DashboardApp/DashboardApp.tsx
index 8f321082143..8a59743c4a3 100644
--- a/frontend/src/metabase/dashboard/containers/DashboardApp/DashboardApp.tsx
+++ b/frontend/src/metabase/dashboard/containers/DashboardApp/DashboardApp.tsx
@@ -32,7 +32,7 @@ import {
import { useDispatch, useSelector } from "metabase/redux";
import { setErrorPage } from "metabase/redux/app";
import type { Location } from "metabase/router";
-import { Outlet, replace, useLocation, useParams } from "metabase/router";
+import { Outlet, useLocation, useNavigate, useParams } from "metabase/router";
import * as Urls from "metabase/urls";
import {
parseHashOptions,
@@ -81,6 +81,7 @@ export const DashboardApp = () => {
const location = useLocation();
const params = useParams();
const dispatch = useDispatch();
+ const navigate = useNavigate();
const [error, setError] = useState<string>();
@@ -132,7 +133,10 @@ export const DashboardApp = () => {
const hashString = stringifyHashOptions(options);
const hash = hashString ? "#" + hashString : "";
if (hash !== location.hash) {
- await dispatch(replace({ ...location, hash }));
+ await navigate(
+ { ...location, hash },
+ { replace: true, state: location.state },
+ );
}
} catch (error) {
// 400: provided entity id format is invalid.
diff --git a/frontend/src/metabase/dashboard/context/context.redux.ts b/frontend/src/metabase/dashboard/context/context.redux.ts
index 96ca7354ffb..0b13546829e 100644
--- a/frontend/src/metabase/dashboard/context/context.redux.ts
+++ b/frontend/src/metabase/dashboard/context/context.redux.ts
@@ -57,7 +57,6 @@ import {
showAddParameterPopover,
} from "metabase/redux/dashboard";
import type { State } from "metabase/redux/store";
-import { push } from "metabase/router";
import {
canManageSubscriptions,
getUserIsAdmin,
@@ -161,7 +160,6 @@ export const mapDispatchToProps = {
hideAddParameterPopover,
fetchDashboard,
fetchDashboardCardData,
- onChangeLocation: push,
reset,
closeDashboard,
setArchivedDashboard,
diff --git a/frontend/src/metabase/dashboard/context/context.tsx b/frontend/src/metabase/dashboard/context/context.tsx
index c1ef890b635..22d8320b5d2 100644
--- a/frontend/src/metabase/dashboard/context/context.tsx
+++ b/frontend/src/metabase/dashboard/context/context.tsx
@@ -16,6 +16,7 @@ import { isEqual, noop } from "underscore";
import { isAbortError } from "metabase/api/client";
import { useEmbeddingEntityContext } from "metabase/embedding/context";
import { getTabHiddenParameterSlugs } from "metabase/embedding/lib/tab-parameters";
+import { type NavigateFunction, navigate } from "metabase/router";
import type Question from "metabase-lib/v1/Question";
import type {
Dashboard,
@@ -111,6 +112,7 @@ export type DashboardContextReturned = DashboardContextOwnResult &
DashboardContextErrorState &
DashboardFullscreenControls & {
fullscreenRef: ReturnType<typeof useDashboardFullscreen>["ref"];
+ onChangeLocation: NavigateFunction;
} & DashboardRefreshPeriodControls &
EmbedThemeControls;
@@ -468,6 +470,10 @@ const DashboardContextProviderInner = forwardRef(
toggleSidebar,
reset,
closeDashboard,
+
+ // `navigate` needs no dispatch, so it cannot ride in the
+ // action-creator map that `connect` binds.
+ onChangeLocation: navigate,
...reduxProps,
}}
>
diff --git a/frontend/src/metabase/dashboard/hooks/use-auto-scroll-to-dashcard.ts b/frontend/src/metabase/dashboard/hooks/use-auto-scroll-to-dashcard.ts
index 1a1faa2e86c..b8c636de9db 100644
--- a/frontend/src/metabase/dashboard/hooks/use-auto-scroll-to-dashcard.ts
+++ b/frontend/src/metabase/dashboard/hooks/use-auto-scroll-to-dashcard.ts
@@ -1,8 +1,7 @@
import { useCallback, useMemo } from "react";
-import { useDispatch } from "metabase/redux";
import type { LocationDescriptorObject } from "metabase/router";
-import { replace } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { parseHashOptions, stringifyHashOptions } from "metabase/utils/browser";
import type { DashCardId } from "metabase-types/api";
@@ -14,7 +13,7 @@ export interface UseAutoScrollToDashcardResult {
export const useAutoScrollToDashcard = (
location: LocationDescriptorObject,
): UseAutoScrollToDashcardResult => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const hashOptions = useMemo(() => {
if (!location.hash) {
@@ -34,14 +33,15 @@ export const useAutoScrollToDashcard = (
// if the dashcard is unmounted then remounted
const { scrollTo, ...restHashOptions } = hashOptions;
const hash = stringifyHashOptions(restHashOptions);
- dispatch(
- replace({
+ navigate(
+ {
pathname: location.pathname,
search: location.search,
hash: hash ? "#" + hash : "",
- }),
+ },
+ { replace: true },
);
- }, [hashOptions, dispatch, location.pathname, location.search]);
+ }, [hashOptions, location.pathname, location.search, navigate]);
return {
autoScrollToDashcardId,
diff --git a/frontend/src/metabase/dashboard/hooks/use-dashboard-url-query.ts b/frontend/src/metabase/dashboard/hooks/use-dashboard-url-query.ts
index d5a0f267f8b..b582af07f35 100644
--- a/frontend/src/metabase/dashboard/hooks/use-dashboard-url-query.ts
+++ b/frontend/src/metabase/dashboard/hooks/use-dashboard-url-query.ts
@@ -7,11 +7,10 @@ import { useDispatch, useSelector } from "metabase/redux";
import { selectTab } from "metabase/redux/dashboard";
import {
type Location,
- push,
queryToSearch,
- replace,
subscribeLocation,
useIsNavigationHeld,
+ useNavigate,
} from "metabase/router";
import { useSetting } from "metabase/settings";
import * as Urls from "metabase/urls";
@@ -35,6 +34,7 @@ export function useDashboardUrlQuery(location: Location) {
const isNavigationHeld = useIsNavigationHeld();
const dispatch = useDispatch();
+ const navigate = useNavigate();
const parameterValuesBySlug = useMemo(
() => getParameterValuesBySlug(parameters),
@@ -111,8 +111,10 @@ export function useDashboardUrlQuery(location: Location) {
previousQueryParams?.tab &&
queryParams.tab !== previousQueryParams.tab;
- const action = isDashboardTabChange ? push : replace;
- dispatch(action({ ...location, search: queryToSearch(nextQuery) }));
+ navigate(
+ { ...location, search: queryToSearch(nextQuery) },
+ { replace: !isDashboardTabChange, state: location.state },
+ );
}
}, [
dashboardId,
@@ -120,7 +122,7 @@ export function useDashboardUrlQuery(location: Location) {
previousQueryParams,
location,
siteUrl,
- dispatch,
+ navigate,
isNavigationHeld,
]);
diff --git a/frontend/src/metabase/dashboard/hooks/use-dashboard-url-query.unit.spec.tsx b/frontend/src/metabase/dashboard/hooks/use-dashboard-url-query.unit.spec.tsx
index 67af6e42e58..f7f4050e487 100644
--- a/frontend/src/metabase/dashboard/hooks/use-dashboard-url-query.unit.spec.tsx
+++ b/frontend/src/metabase/dashboard/hooks/use-dashboard-url-query.unit.spec.tsx
@@ -10,31 +10,34 @@ import {
createMockStoreDashboard,
} from "metabase/redux/store/mocks";
import type { Location } from "metabase/router";
-import {
- notifyLocationListeners,
- push,
- replace,
- useIsNavigationHeld,
-} from "metabase/router";
+import { notifyLocationListeners, useIsNavigationHeld } from "metabase/router";
import type { ParameterValueOrArray } from "metabase-types/api";
import { createMockParameter } from "metabase-types/api/mocks";
import { useDashboardUrlQuery } from "./use-dashboard-url-query";
// Pins the dashboard URL-query sync seam: how dashboard parameter and tab state
-// gets pushed or replaced into the location query string, plus the location
-// subscription that selects a tab. The react-router migration re-plumbs both.
+// is written into the location query string, and whether it replaces the entry
+// or adds one, plus the location subscription that selects a tab.
+
+const navigateMock = jest.fn();
jest.mock("metabase/router", () => ({
...jest.requireActual("metabase/router"),
- push: jest.fn((descriptor) => ({ type: "MOCK_PUSH", payload: descriptor })),
- replace: jest.fn((descriptor) => ({
- type: "MOCK_REPLACE",
- payload: descriptor,
- })),
+ useNavigate: () => navigateMock,
useIsNavigationHeld: jest.fn(() => false),
}));
+const replacedWith = (search: string) => [
+ expect.objectContaining({ search }),
+ expect.objectContaining({ replace: true }),
+];
+
+const pushedWith = (search: string) => [
+ expect.objectContaining({ search }),
+ expect.objectContaining({ replace: false }),
+];
+
jest.mock("metabase/embedding/config", () => ({
...jest.requireActual("metabase/embedding/config"),
isEmbedPreview: jest.fn(() => false),
@@ -102,10 +105,7 @@ function setup({
describe("useDashboardUrlQuery", () => {
beforeEach(() => {
- // Unjustified type cast. FIXME
- (push as jest.Mock).mockClear();
- // Unjustified type cast. FIXME
- (replace as jest.Mock).mockClear();
+ navigateMock.mockClear();
// Unjustified type cast. FIXME
(isEmbedPreview as jest.Mock).mockReturnValue(false);
// Unjustified type cast. FIXME
@@ -126,8 +126,7 @@ describe("useDashboardUrlQuery", () => {
parameterValues: { "1": "bar" },
});
- expect(replace).not.toHaveBeenCalled();
- expect(push).not.toHaveBeenCalled();
+ expect(navigateMock).not.toHaveBeenCalled();
});
it("syncs once the prompt is answered", () => {
@@ -138,32 +137,27 @@ describe("useDashboardUrlQuery", () => {
parameters: [createMockParameter({ id: "1", slug: "text" })],
parameterValues: { "1": "bar" },
});
- expect(replace).not.toHaveBeenCalled();
+ expect(navigateMock).not.toHaveBeenCalled();
// Unjustified type cast. FIXME
(useIsNavigationHeld as jest.Mock).mockReturnValue(false);
rerender();
- expect(replace).toHaveBeenCalledWith(
- expect.objectContaining({ search: "?text=bar" }),
- );
+ expect(navigateMock).toHaveBeenCalledWith(...replacedWith("?text=bar"));
});
});
- it("syncs a parameter-value change with replace (not push), writing the parameter slug values into the search string", () => {
+ it("syncs a parameter-value change by replacing the entry, writing the parameter slug values into the search string", () => {
setup({
parameters: [createMockParameter({ id: "1", slug: "text" })],
parameterValues: { "1": "bar" },
});
- expect(replace).toHaveBeenCalledTimes(1);
- expect(replace).toHaveBeenCalledWith(
- expect.objectContaining({ search: "?text=bar" }),
- );
- expect(push).not.toHaveBeenCalled();
+ expect(navigateMock).toHaveBeenCalledTimes(1);
+ expect(navigateMock).toHaveBeenCalledWith(...replacedWith("?text=bar"));
});
- it("syncs a tab change with push (not replace), writing the new tab slug into the search string", () => {
+ it("syncs a tab change by adding a history entry, writing the new tab slug into the search string", () => {
const { store } = setup({
tabs: [
{ id: 1, name: "Tab 1" },
@@ -172,20 +166,15 @@ describe("useDashboardUrlQuery", () => {
selectedTabId: 1,
});
- // The mount sync (previous query params were undefined) uses replace.
- (push as jest.Mock).mockClear();
- // Unjustified type cast. FIXME
- (replace as jest.Mock).mockClear();
+ // The mount sync (previous query params were undefined) replaces.
+ navigateMock.mockClear();
act(() => {
store.dispatch(selectTab({ tabId: 2 }));
});
- expect(push).toHaveBeenCalledTimes(1);
- expect(push).toHaveBeenCalledWith(
- expect.objectContaining({ search: "?tab=2-tab-2" }),
- );
- expect(replace).not.toHaveBeenCalled();
+ expect(navigateMock).toHaveBeenCalledTimes(1);
+ expect(navigateMock).toHaveBeenCalledWith(...pushedWith("?tab=2-tab-2"));
});
it("does not sync when isEmbedPreview() is true", () => {
@@ -197,8 +186,7 @@ describe("useDashboardUrlQuery", () => {
parameterValues: { "1": "bar" },
});
- expect(push).not.toHaveBeenCalled();
- expect(replace).not.toHaveBeenCalled();
+ expect(navigateMock).not.toHaveBeenCalled();
});
it("does not sync when there is no dashboardId", () => {
@@ -208,8 +196,7 @@ describe("useDashboardUrlQuery", () => {
parameterValues: { "1": "bar" },
});
- expect(push).not.toHaveBeenCalled();
- expect(replace).not.toHaveBeenCalled();
+ expect(navigateMock).not.toHaveBeenCalled();
});
describe("location tab subscription", () => {
@@ -262,8 +249,7 @@ describe("useDashboardUrlQuery", () => {
pathname: "/dashboard/999",
});
- expect(push).not.toHaveBeenCalled();
- expect(replace).not.toHaveBeenCalled();
+ expect(navigateMock).not.toHaveBeenCalled();
});
it("preserves an allow-listed query param (objectId) when syncing", () => {
@@ -273,10 +259,10 @@ describe("useDashboardUrlQuery", () => {
search: "?objectId=42",
});
- expect(replace).toHaveBeenCalledTimes(1);
- expect(replace).toHaveBeenCalledWith(
+ expect(navigateMock).toHaveBeenCalledTimes(1);
+ expect(navigateMock).toHaveBeenCalledWith(
// sorted, as `queryToSearch` writes it
- expect.objectContaining({ search: "?objectId=42&text=bar" }),
+ ...replacedWith("?objectId=42&text=bar"),
);
});
});
diff --git a/frontend/src/metabase/dashboard/hooks/use-location-sync.ts b/frontend/src/metabase/dashboard/hooks/use-location-sync.ts
index 13efbed0ff7..b1c4b178bde 100644
--- a/frontend/src/metabase/dashboard/hooks/use-location-sync.ts
+++ b/frontend/src/metabase/dashboard/hooks/use-location-sync.ts
@@ -2,9 +2,8 @@ import { useEffect, useMemo } from "react";
import { usePrevious } from "react-use";
import { omit } from "underscore";
-import { useDispatch } from "metabase/redux";
import type { Location } from "metabase/router";
-import { replace } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { parseHashOptions, stringifyHashOptions } from "metabase/utils/browser";
import { isNullOrUndefined } from "metabase/utils/types";
@@ -45,7 +44,7 @@ export const useLocationSync = <
onChange: (value: Value | null) => void;
location: Location;
}) => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const previousValue = usePrevious(value) ?? null;
const hashOptions = parseHashOptions(location.hash);
// Unjustified type cast. FIXME
@@ -85,11 +84,13 @@ export const useLocationSync = <
// The effect reads `location` and replaces it, so a replace that lands on
// the same URL would re-enter it through the resulting location change.
if (hash !== location.hash) {
- dispatch(replace({ ...location, hash }));
+ navigate(
+ { ...location, hash },
+ { replace: true, state: location.state },
+ );
}
}
}, [
- dispatch,
hashOptions,
key,
latestValue,
@@ -97,5 +98,6 @@ export const useLocationSync = <
onChange,
previousValue,
value,
+ navigate,
]);
};
diff --git a/frontend/src/metabase/data-studio/data-model/components/TablePicker/wrappers.tsx b/frontend/src/metabase/data-studio/data-model/components/TablePicker/wrappers.tsx
index 83204801ca9..6a5c818289a 100644
--- a/frontend/src/metabase/data-studio/data-model/components/TablePicker/wrappers.tsx
+++ b/frontend/src/metabase/data-studio/data-model/components/TablePicker/wrappers.tsx
@@ -1,7 +1,6 @@
import { useCallback, useEffect, useState } from "react";
-import { useDispatch } from "metabase/redux";
-import { replace } from "metabase/router";
+import { useNavigate } from "metabase/router";
import * as Urls from "metabase/urls";
import type { RouteParams } from "../../pages/DataModel/types";
@@ -19,7 +18,7 @@ export function RouterTablePicker({
setOnUpdateCallback,
...props
}: Props) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [value, setValue] = useState(props);
const {
databaseId: propDatabaseId,
@@ -30,9 +29,9 @@ export function RouterTablePicker({
const onChange = useCallback(
(value: TreePath) => {
setValue(value);
- dispatch(replace(Urls.dataStudioData(value)));
+ navigate(Urls.dataStudioData(value), { replace: true });
},
- [dispatch],
+ [navigate],
);
useEffect(() => {
diff --git a/frontend/src/metabase/data-studio/data-model/components/TableSection/TableSection.tsx b/frontend/src/metabase/data-studio/data-model/components/TableSection/TableSection.tsx
index ed932b4e28b..9bedfb57430 100644
--- a/frontend/src/metabase/data-studio/data-model/components/TableSection/TableSection.tsx
+++ b/frontend/src/metabase/data-studio/data-model/components/TableSection/TableSection.tsx
@@ -22,8 +22,8 @@ import {
PLUGIN_LIBRARY,
PLUGIN_REMOTE_SYNC,
} from "metabase/plugins";
-import { useDispatch, useSelector } from "metabase/redux";
-import { push } from "metabase/router";
+import { useSelector } from "metabase/redux";
+import { useNavigate } from "metabase/router";
import {
Box,
Button,
@@ -97,7 +97,7 @@ const TableSectionBase = ({
});
};
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const handleTabChange = useCallback(
(tab: DataStudioTableMetadataTab | null) => {
@@ -105,18 +105,16 @@ const TableSectionBase = ({
return;
}
- dispatch(
- push(
- Urls.dataStudioData({
- databaseId: table.db_id,
- schemaName: table.schema,
- tableId: table.id,
- tab,
- }),
- ),
+ navigate(
+ Urls.dataStudioData({
+ databaseId: table.db_id,
+ schemaName: table.schema,
+ tableId: table.id,
+ tab,
+ }),
);
},
- [dispatch, table.db_id, table.schema, table.id],
+ [table.db_id, table.schema, table.id, navigate],
);
const handleNameChange = async (name: string) => {
diff --git a/frontend/src/metabase/data-studio/measures/hooks/use-data-model-measure-page.ts b/frontend/src/metabase/data-studio/measures/hooks/use-data-model-measure-page.ts
index d799464b8a6..c2dcf0560d4 100644
--- a/frontend/src/metabase/data-studio/measures/hooks/use-data-model-measure-page.ts
+++ b/frontend/src/metabase/data-studio/measures/hooks/use-data-model-measure-page.ts
@@ -8,8 +8,7 @@ import {
} from "metabase/api";
import { useLoadTableWithMetadata } from "metabase/common/data-studio/hooks/use-load-table-with-metadata";
import { useMetadataToasts } from "metabase/metadata/hooks";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import * as Urls from "metabase/urls";
import { getSchemaName } from "metabase-lib/v1/metadata/utils/schema";
@@ -25,7 +24,7 @@ type DataModelMeasurePageParams = {
export function useDataModelMeasurePage(
params: Partial<DataModelMeasurePageParams>,
) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const { sendSuccessToast, sendErrorToast } = useMetadataToasts();
const [updateMeasure] = useUpdateMeasureMutation();
@@ -63,15 +62,13 @@ export function useDataModelMeasurePage(
sendErrorToast(t`Failed to remove measure`);
} else {
sendSuccessToast(t`Measure removed`);
- dispatch(
- push(
- Urls.dataStudioData({
- databaseId,
- schemaName,
- tableId,
- tab: "measures",
- }),
- ),
+ navigate(
+ Urls.dataStudioData({
+ databaseId,
+ schemaName,
+ tableId,
+ tab: "measures",
+ }),
);
}
}, [
@@ -80,9 +77,9 @@ export function useDataModelMeasurePage(
schemaName,
databaseId,
updateMeasure,
- dispatch,
sendSuccessToast,
sendErrorToast,
+ navigate,
]);
const isLoading = isLoadingMeasure || isLoadingTable;
diff --git a/frontend/src/metabase/data-studio/measures/hooks/use-published-table-measure-page.ts b/frontend/src/metabase/data-studio/measures/hooks/use-published-table-measure-page.ts
index c76e632d279..1be0bc36b38 100644
--- a/frontend/src/metabase/data-studio/measures/hooks/use-published-table-measure-page.ts
+++ b/frontend/src/metabase/data-studio/measures/hooks/use-published-table-measure-page.ts
@@ -8,8 +8,7 @@ import {
} from "metabase/api";
import { useLoadTableWithMetadata } from "metabase/common/data-studio/hooks/use-load-table-with-metadata";
import { useToast } from "metabase/common/hooks/use-toast";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import * as Urls from "metabase/urls";
import type { MeasureTabUrls } from "../types";
@@ -22,7 +21,7 @@ type PublishedTableMeasurePageParams = {
export function usePublishedTableMeasurePage(
params: Partial<PublishedTableMeasurePageParams>,
) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [sendToast] = useToast();
const [updateMeasure] = useUpdateMeasureMutation();
@@ -58,9 +57,9 @@ export function usePublishedTableMeasurePage(
sendToast({ icon: "warning", message: t`Failed to remove measure` });
} else {
sendToast({ icon: "check", message: t`Measure removed` });
- dispatch(push(Urls.dataStudioTableMeasures(tableId)));
+ navigate(Urls.dataStudioTableMeasures(tableId));
}
- }, [measure, tableId, updateMeasure, dispatch, sendToast]);
+ }, [measure, tableId, updateMeasure, sendToast, navigate]);
const isLoading = isLoadingMeasure || isLoadingTable;
const error = measureError ?? tableError;
diff --git a/frontend/src/metabase/data-studio/measures/pages/NewMeasurePage/NewMeasurePage.tsx b/frontend/src/metabase/data-studio/measures/pages/NewMeasurePage/NewMeasurePage.tsx
index fc140ba8970..99a592b0200 100644
--- a/frontend/src/metabase/data-studio/measures/pages/NewMeasurePage/NewMeasurePage.tsx
+++ b/frontend/src/metabase/data-studio/measures/pages/NewMeasurePage/NewMeasurePage.tsx
@@ -8,8 +8,8 @@ import { trackMeasureCreated } from "metabase/common/data-studio/analytics";
import { PageContainer } from "metabase/common/data-studio/components/PageContainer";
import { getDatasetQueryPreviewUrl } from "metabase/data-studio/common/utils/get-dataset-query-preview-url";
import { useMetadataToasts } from "metabase/metadata/hooks";
-import { useDispatch, useSelector } from "metabase/redux";
-import { push } from "metabase/router";
+import { useSelector } from "metabase/redux";
+import { useNavigate } from "metabase/router";
import { getMetadataWithHiddenTables } from "metabase/selectors/metadata";
import { Button } from "metabase/ui";
import * as Lib from "metabase-lib";
@@ -31,7 +31,7 @@ export function NewMeasurePage({
breadcrumbs,
getSuccessUrl,
}: NewMeasurePageProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const metadata = useSelector(getMetadataWithHiddenTables);
const { sendSuccessToast, sendErrorToast } = useMetadataToasts();
@@ -99,9 +99,9 @@ export function NewMeasurePage({
useEffect(() => {
if (savedMeasure) {
- dispatch(push(getSuccessUrl(savedMeasure)));
+ navigate(getSuccessUrl(savedMeasure));
}
- }, [savedMeasure, dispatch, getSuccessUrl]);
+ }, [savedMeasure, getSuccessUrl, navigate]);
return (
<PageContainer data-testid="new-measure-page" gap="xl">
diff --git a/frontend/src/metabase/data-studio/segments/hooks/use-data-model-segment-page.ts b/frontend/src/metabase/data-studio/segments/hooks/use-data-model-segment-page.ts
index ee695fa5da1..3e6ae1a7ba8 100644
--- a/frontend/src/metabase/data-studio/segments/hooks/use-data-model-segment-page.ts
+++ b/frontend/src/metabase/data-studio/segments/hooks/use-data-model-segment-page.ts
@@ -8,8 +8,7 @@ import {
} from "metabase/api";
import { useLoadTableWithMetadata } from "metabase/common/data-studio/hooks/use-load-table-with-metadata";
import { useMetadataToasts } from "metabase/metadata/hooks";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import * as Urls from "metabase/urls";
import { getSchemaName } from "metabase-lib/v1/metadata/utils/schema";
@@ -25,7 +24,7 @@ type DataModelSegmentPageParams = {
export function useDataModelSegmentPage(
params: Partial<DataModelSegmentPageParams>,
) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const { sendSuccessToast, sendErrorToast } = useMetadataToasts();
const [updateSegment] = useUpdateSegmentMutation();
@@ -63,15 +62,13 @@ export function useDataModelSegmentPage(
sendErrorToast(t`Failed to remove segment`);
} else {
sendSuccessToast(t`Segment removed`);
- dispatch(
- push(
- Urls.dataStudioData({
- databaseId,
- schemaName,
- tableId,
- tab: "segments",
- }),
- ),
+ navigate(
+ Urls.dataStudioData({
+ databaseId,
+ schemaName,
+ tableId,
+ tab: "segments",
+ }),
);
}
}, [
@@ -80,9 +77,9 @@ export function useDataModelSegmentPage(
schemaName,
databaseId,
updateSegment,
- dispatch,
sendSuccessToast,
sendErrorToast,
+ navigate,
]);
const isLoading = isLoadingSegment || isLoadingTable;
diff --git a/frontend/src/metabase/data-studio/segments/hooks/use-published-table-segment-page.ts b/frontend/src/metabase/data-studio/segments/hooks/use-published-table-segment-page.ts
index f744de3eb78..14565cd5909 100644
--- a/frontend/src/metabase/data-studio/segments/hooks/use-published-table-segment-page.ts
+++ b/frontend/src/metabase/data-studio/segments/hooks/use-published-table-segment-page.ts
@@ -8,8 +8,7 @@ import {
} from "metabase/api";
import { useLoadTableWithMetadata } from "metabase/common/data-studio/hooks/use-load-table-with-metadata";
import { useToast } from "metabase/common/hooks/use-toast";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import * as Urls from "metabase/urls";
import type { SegmentTabUrls } from "../types";
@@ -22,7 +21,7 @@ type PublishedTableSegmentPageParams = {
export function usePublishedTableSegmentPage(
params: Partial<PublishedTableSegmentPageParams>,
) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [sendToast] = useToast();
const [updateSegment] = useUpdateSegmentMutation();
@@ -58,9 +57,9 @@ export function usePublishedTableSegmentPage(
sendToast({ icon: "warning", message: t`Failed to remove segment` });
} else {
sendToast({ icon: "check", message: t`Segment removed` });
- dispatch(push(Urls.dataStudioTableSegments(tableId)));
+ navigate(Urls.dataStudioTableSegments(tableId));
}
- }, [segment, tableId, updateSegment, dispatch, sendToast]);
+ }, [segment, tableId, updateSegment, sendToast, navigate]);
const isLoading = isLoadingSegment || isLoadingTable;
const error = segmentError ?? tableError;
diff --git a/frontend/src/metabase/data-studio/segments/pages/NewSegmentPage/NewSegmentPage.tsx b/frontend/src/metabase/data-studio/segments/pages/NewSegmentPage/NewSegmentPage.tsx
index fc926d2f291..497ccdde701 100644
--- a/frontend/src/metabase/data-studio/segments/pages/NewSegmentPage/NewSegmentPage.tsx
+++ b/frontend/src/metabase/data-studio/segments/pages/NewSegmentPage/NewSegmentPage.tsx
@@ -8,8 +8,8 @@ import { trackSegmentCreated } from "metabase/common/data-studio/analytics";
import { PageContainer } from "metabase/common/data-studio/components/PageContainer";
import { getDatasetQueryPreviewUrl } from "metabase/data-studio/common/utils/get-dataset-query-preview-url";
import { useMetadataToasts } from "metabase/metadata/hooks";
-import { useDispatch, useSelector } from "metabase/redux";
-import { push } from "metabase/router";
+import { useSelector } from "metabase/redux";
+import { useNavigate } from "metabase/router";
import { getMetadataWithHiddenTables } from "metabase/selectors/metadata";
import { Button } from "metabase/ui";
import * as Lib from "metabase-lib";
@@ -31,7 +31,7 @@ export function NewSegmentPage({
breadcrumbs,
getSuccessUrl,
}: NewSegmentPageProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const metadata = useSelector(getMetadataWithHiddenTables);
const { sendSuccessToast, sendErrorToast } = useMetadataToasts();
@@ -95,9 +95,9 @@ export function NewSegmentPage({
useEffect(() => {
if (savedSegment) {
- dispatch(push(getSuccessUrl(savedSegment)));
+ navigate(getSuccessUrl(savedSegment));
}
- }, [savedSegment, dispatch, getSuccessUrl]);
+ }, [savedSegment, getSuccessUrl, navigate]);
return (
<PageContainer data-testid="new-segment-page" gap="xl">
diff --git a/frontend/src/metabase/documents/actions.ts b/frontend/src/metabase/documents/actions.ts
index 38fbbe802a9..5e11cc216a9 100644
--- a/frontend/src/metabase/documents/actions.ts
+++ b/frontend/src/metabase/documents/actions.ts
@@ -1,13 +1,12 @@
import { openUrl } from "metabase/redux/app";
import { NAVIGATE_TO_NEW_CARD } from "metabase/redux/dashboard";
import type { Dispatch } from "metabase/redux/store";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import type { Document } from "metabase-types/api";
-export const navigateBackToDocument =
- (documentId: number) => (dispatch: Dispatch) => {
- dispatch(push(`/document/${documentId}`));
- };
+export const navigateBackToDocument = (documentId: number) => () => {
+ navigate(`/document/${documentId}`);
+};
export const navigateToCardFromDocument =
(url: string, document?: Document | null) => (dispatch: Dispatch) => {
diff --git a/frontend/src/metabase/documents/components/CommentsSidesheet/CommentsSidesheet.tsx b/frontend/src/metabase/documents/components/CommentsSidesheet/CommentsSidesheet.tsx
index c39e4364b6a..fce114c2e82 100644
--- a/frontend/src/metabase/documents/components/CommentsSidesheet/CommentsSidesheet.tsx
+++ b/frontend/src/metabase/documents/components/CommentsSidesheet/CommentsSidesheet.tsx
@@ -184,7 +184,7 @@ export const CommentsSidesheet = ({ params, onClose }: Props) => {
message: t`Failed to send comment`,
});
} else {
- deleteNewParamFromURLIfNeeded(location, dispatch);
+ deleteNewParamFromURLIfNeeded(location);
}
};
diff --git a/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx b/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx
index 6ac64f14430..4d48403a3fb 100644
--- a/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx
+++ b/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx
@@ -7,12 +7,13 @@ import { useSetArchive } from "metabase/archive/hooks";
import { useSetCollection } from "metabase/common/hooks";
import { useDispatch, useSelector } from "metabase/redux";
import { addUndo } from "metabase/redux/undo";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { getCurrentDocument } from "../selectors";
export const DocumentArchivedEntityBanner = () => {
const dispatch = useDispatch();
+ const navigate = useNavigate();
const archive = useSetArchive();
const setCollection = useSetCollection();
const document = useSelector(getCurrentDocument);
@@ -38,7 +39,7 @@ export const DocumentArchivedEntityBanner = () => {
}
onDeletePermanently={async () => {
await deleteDocument({ id: document.id }).unwrap();
- dispatch(push("/trash"));
+ navigate("/trash");
dispatch(
addUndo({ message: t`This item has been permanently deleted.` }),
);
diff --git a/frontend/src/metabase/documents/components/DocumentPage.tsx b/frontend/src/metabase/documents/components/DocumentPage.tsx
index 1bb26539b5f..75483d9fcae 100644
--- a/frontend/src/metabase/documents/components/DocumentPage.tsx
+++ b/frontend/src/metabase/documents/components/DocumentPage.tsx
@@ -38,7 +38,7 @@ import { useCallbackEffect } from "metabase/common/hooks/use-callback-effect";
import { usePageTitle } from "metabase/hooks/use-page-title";
import { useDispatch, useSelector } from "metabase/redux";
import { setErrorPage } from "metabase/redux/app";
-import { Outlet, push, replace, useLocation, useParams } from "metabase/router";
+import { Outlet, useLocation, useNavigate, useParams } from "metabase/router";
import { Box } from "metabase/ui";
import { extractEntityId } from "metabase/urls";
import * as Urls from "metabase/urls";
@@ -121,6 +121,7 @@ export const DocumentPage = () => {
const previousLocationKey = usePrevious(location.key);
const forceUpdate = useForceUpdate();
const dispatch = useDispatch();
+ const navigate = useNavigate();
const selectedQuestionId = useSelector(getSelectedQuestionId);
const selectedEmbedIndex = useSelector(getSelectedEmbedIndex);
@@ -362,7 +363,7 @@ export const DocumentPage = () => {
const _document = response.data;
trackDocumentUpdated(_document);
scheduleNavigation(() => {
- dispatch(push(Urls.document(_document)));
+ navigate(Urls.document(_document));
});
}
return response;
@@ -376,7 +377,7 @@ export const DocumentPage = () => {
const _document = response.data;
trackDocumentCreated(_document);
scheduleNavigation(() => {
- dispatch(replace(Urls.document(_document)));
+ navigate(Urls.document(_document), { replace: true });
});
}
return response;
@@ -414,6 +415,7 @@ export const DocumentPage = () => {
scheduleNavigation,
dispatch,
sendToast,
+ navigate,
],
);
@@ -584,7 +586,7 @@ export const DocumentPage = () => {
onSaved={(document) => {
setDuplicateModalMode(null);
scheduleNavigation(() => {
- dispatch(push(Urls.document(document)));
+ navigate(Urls.document(document));
});
}}
entityObject={documentData}
diff --git a/frontend/src/metabase/embedding/components/ReturnToSetupGuideModal/ReturnToSetupGuideModal.tsx b/frontend/src/metabase/embedding/components/ReturnToSetupGuideModal/ReturnToSetupGuideModal.tsx
index c6cedd59886..5f2b5909727 100644
--- a/frontend/src/metabase/embedding/components/ReturnToSetupGuideModal/ReturnToSetupGuideModal.tsx
+++ b/frontend/src/metabase/embedding/components/ReturnToSetupGuideModal/ReturnToSetupGuideModal.tsx
@@ -1,7 +1,6 @@
import { t } from "ttag";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Button, Group, Modal, Stack, Text } from "metabase/ui";
// Path to the admin embedding setup guide. Inlined here (rather than
@@ -26,7 +25,7 @@ export const ReturnToSetupGuideModal = ({
title,
message,
}: ReturnToSetupGuideModalProps) => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
return (
<Modal opened={opened} onClose={onClose} title={title} size="md">
@@ -38,7 +37,7 @@ export const ReturnToSetupGuideModal = ({
</Button>
<Button
variant="filled"
- onClick={() => dispatch(push(EMBEDDING_SETUP_GUIDE_PATH))}
+ onClick={() => navigate(EMBEDDING_SETUP_GUIDE_PATH)}
>
{t`Return to the setup guide`}
</Button>
diff --git a/frontend/src/metabase/embedding/interactive-embedding/initialize.ts b/frontend/src/metabase/embedding/interactive-embedding/initialize.ts
index e689f7df167..37370de52cf 100644
--- a/frontend/src/metabase/embedding/interactive-embedding/initialize.ts
+++ b/frontend/src/metabase/embedding/interactive-embedding/initialize.ts
@@ -3,7 +3,7 @@ import _ from "underscore";
import CS from "metabase/css/core/index.css";
import { setInitialUrlOptions } from "metabase/redux/embed";
import type { Dispatch } from "metabase/redux/store";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import { isWithinIframe } from "metabase/utils/iframe";
export type FrameSpec = {
@@ -37,7 +37,7 @@ export function initializeInteractiveEmbedding(dispatch: Dispatch) {
window.addEventListener("message", (e) => {
if (e.source === window.parent && e.data.metabase) {
if (e.data.metabase.type === "location") {
- dispatch(push(getLocationWithoutBasename(e.data.metabase.location)));
+ navigate(getLocationWithoutBasename(e.data.metabase.location));
}
}
});
diff --git a/frontend/src/metabase/home/components/HomePage/HomePage.tsx b/frontend/src/metabase/home/components/HomePage/HomePage.tsx
index 828c43f3f0d..4c447d13d8f 100644
--- a/frontend/src/metabase/home/components/HomePage/HomePage.tsx
+++ b/frontend/src/metabase/home/components/HomePage/HomePage.tsx
@@ -5,7 +5,7 @@ import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErr
import { useHomepageDashboard } from "metabase/home/use-homepage-dashboard";
import { useDispatch, useSelector } from "metabase/redux";
import { addUndo } from "metabase/redux/undo";
-import { replace } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { getHasDismissedCustomHomePageToast } from "metabase/selectors/app";
import { useUpdateSettingMutation } from "metabase/settings";
@@ -29,18 +29,17 @@ const useDashboardRedirect = () => {
const { dashboardId, dashboard, isLoading } = useHomepageDashboard();
const hasDismissedToast = useSelector(getHasDismissedCustomHomePageToast);
const dispatch = useDispatch();
+ const navigate = useNavigate();
const [updateSetting] = useUpdateSettingMutation();
// This redirect must live inside a useLayoutEffect to prevent the browser from painting a frame of <HomeContent>
// before firing the redirect (metabase#69917)
useLayoutEffect(() => {
if (dashboardId && !isLoading && !dashboard?.archived) {
- dispatch(
- replace({
- pathname: `/dashboard/${dashboardId}`,
- state: { preserveNavbarState: true },
- }),
- );
+ navigate(`/dashboard/${dashboardId}`, {
+ replace: true,
+ state: { preserveNavbarState: true },
+ });
if (!hasDismissedToast) {
dispatch(
@@ -64,6 +63,7 @@ const useDashboardRedirect = () => {
dashboardId,
hasDismissedToast,
dispatch,
+ navigate,
updateSetting,
dashboard?.archived,
isLoading,
diff --git a/frontend/src/metabase/metabot/components/MetabotAsk/MetabotAsk.tsx b/frontend/src/metabase/metabot/components/MetabotAsk/MetabotAsk.tsx
index 1385dd42e67..e81e1ee4f89 100644
--- a/frontend/src/metabase/metabot/components/MetabotAsk/MetabotAsk.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotAsk/MetabotAsk.tsx
@@ -9,9 +9,8 @@ import {
useMetabotAgent,
useUserMetabotPermissions,
} from "metabase/metabot/hooks";
-import { useDispatch } from "metabase/redux";
import type { SuggestionModel } from "metabase/rich_text_editing/tiptap/extensions/shared/types";
-import { push, replace } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Box, Flex } from "metabase/ui";
import * as Urls from "metabase/urls";
@@ -33,7 +32,7 @@ const askConfig: MetabotConfig = {
};
export const MetabotAsk = () => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const { setVisible: setSidebarVisible } = useMetabotAgent("omnibot");
const askAgent = useMetabotAgent("ask");
const { messages, isDoingScience, conversationId } = askAgent;
@@ -50,10 +49,10 @@ export const MetabotAsk = () => {
useEffect(
function navigateToConversationOnFirstMessage() {
if (isAskPage && messages.length > 0 && conversationId) {
- dispatch(replace(Urls.metabotConversation(conversationId)));
+ navigate(Urls.metabotConversation(conversationId), { replace: true });
}
},
- [isAskPage, messages.length, conversationId, dispatch],
+ [isAskPage, messages.length, conversationId, navigate],
);
const showGreeting = messages.length === 0 && !isDoingScience;
@@ -63,9 +62,7 @@ export const MetabotAsk = () => {
<MetabotConversationHistory
profileId={askAgent.profile}
activeConversationId={conversationId}
- onConversationSelect={(id) =>
- dispatch(push(Urls.metabotConversation(id)))
- }
+ onConversationSelect={(id) => navigate(Urls.metabotConversation(id))}
/>
) : undefined;
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotAgentSuggestionMessage.tsx b/frontend/src/metabase/metabot/components/MetabotChat/MetabotAgentSuggestionMessage.tsx
index 2dc1863c8f0..b11f3a375a0 100644
--- a/frontend/src/metabase/metabot/components/MetabotChat/MetabotAgentSuggestionMessage.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotAgentSuggestionMessage.tsx
@@ -1,6 +1,5 @@
import { unifiedMergeView } from "@codemirror/merge";
import { useDisclosure } from "@mantine/hooks";
-import type { UnknownAction } from "@reduxjs/toolkit";
import cx from "classnames";
import { useContext, useMemo, useState } from "react";
import { useLocation, useMount } from "react-use";
@@ -20,7 +19,7 @@ import {
import { useMetadataToasts } from "metabase/metadata/hooks";
import EditorS from "metabase/querying/components/CodeMirrorEditor/CodeMirrorEditor.module.css";
import { useDispatch, useSelector } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { getMetadata } from "metabase/selectors/metadata";
import {
Button,
@@ -119,6 +118,7 @@ export const AgentSuggestionMessage = ({
readonly?: boolean;
}) => {
const dispatch = useDispatch();
+ const navigate = useNavigate();
const metadata = useSelector(getMetadata);
const { suggestionActions } = useContext(MetabotContext);
const { sendErrorToast } = useMetadataToasts();
@@ -190,8 +190,7 @@ export const AgentSuggestionMessage = ({
return;
}
- // Unjustified type cast. FIXME
- dispatch(push(getTransformUrl(suggestedTransform)) as UnknownAction);
+ navigate(getTransformUrl(suggestedTransform));
};
return (
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotInlineChart.tsx b/frontend/src/metabase/metabot/components/MetabotChat/MetabotInlineChart.tsx
index fbee2a94516..f825e5391c0 100644
--- a/frontend/src/metabase/metabot/components/MetabotChat/MetabotInlineChart.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotInlineChart.tsx
@@ -18,7 +18,7 @@ import { serializeChartClipboard } from "metabase/common/utils/chart-clipboard";
import { getSavedChartCardId, markChartSaved } from "metabase/metabot/state";
import { useDispatch, useSelector } from "metabase/redux";
import { addUndo } from "metabase/redux/undo";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { useSetting } from "metabase/settings";
import {
ActionIcon,
@@ -189,6 +189,7 @@ function SaveChartAction({
readonly: boolean;
}) {
const dispatch = useDispatch();
+ const navigate = useNavigate();
const [saveMetabotEntity] = useSaveMetabotEntityMutation();
const [isSaveModalOpen, setIsSaveModalOpen] = useState(false);
@@ -212,7 +213,7 @@ function SaveChartAction({
message: t`Saved`,
extraAction: {
label: t`View`,
- action: () => dispatch(push(Urls.question(savedQuestion))),
+ action: () => navigate(Urls.question(savedQuestion)),
},
}),
);
diff --git a/frontend/src/metabase/metabot/components/MetabotQuickLinks.tsx b/frontend/src/metabase/metabot/components/MetabotQuickLinks.tsx
index aba4aad7f2d..1683b73fca1 100644
--- a/frontend/src/metabase/metabot/components/MetabotQuickLinks.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotQuickLinks.tsx
@@ -4,8 +4,7 @@ import {
useMetabotAgent,
useUserMetabotPermissions,
} from "metabase/metabot/hooks";
-import { useDispatch } from "metabase/redux";
-import { Route, replace, useSearchParams } from "metabase/router";
+import { Route, useNavigate, useSearchParams } from "metabase/router";
import { Loader } from "metabase/ui";
function MetabotNewRoute() {
@@ -13,7 +12,7 @@ function MetabotNewRoute() {
const { canUseMetabot, isLoading } = useUserMetabotPermissions();
const { submitInput } = useMetabotAgent("omnibot");
const prompt = searchParams.get("q") ?? "";
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [hasSubmitted, setHasSubmitted] = useState(false);
useEffect(() => {
@@ -21,13 +20,13 @@ function MetabotNewRoute() {
return;
}
- dispatch(replace("/"));
+ navigate("/", { replace: true });
if (prompt && canUseMetabot) {
void submitInput(prompt, { focusInput: true });
setHasSubmitted(true);
}
- }, [isLoading, canUseMetabot, prompt, submitInput, dispatch, hasSubmitted]);
+ }, [isLoading, canUseMetabot, prompt, submitInput, hasSubmitted, navigate]);
return <Loader m="5rem auto" display="block" size="xl" />;
}
diff --git a/frontend/src/metabase/metabot/components/SlackConnectSuccess.tsx b/frontend/src/metabase/metabot/components/SlackConnectSuccess.tsx
index 1d31250af3e..61e2e555d34 100644
--- a/frontend/src/metabase/metabot/components/SlackConnectSuccess.tsx
+++ b/frontend/src/metabase/metabot/components/SlackConnectSuccess.tsx
@@ -3,10 +3,11 @@ import { t } from "ttag";
import { useDispatch } from "metabase/redux";
import { addUndo } from "metabase/redux/undo";
-import { replace } from "metabase/router";
+import { useNavigate } from "metabase/router";
export const SlackConnectSuccess = () => {
const dispatch = useDispatch();
+ const navigate = useNavigate();
useMount(() => {
dispatch(
@@ -15,7 +16,7 @@ export const SlackConnectSuccess = () => {
icon: "check",
}),
);
- dispatch(replace("/"));
+ navigate("/", { replace: true });
});
return null;
diff --git a/frontend/src/metabase/metabot/state/actions.ts b/frontend/src/metabase/metabot/state/actions.ts
index a3e8c3ec320..4aa66abc1b6 100644
--- a/frontend/src/metabase/metabot/state/actions.ts
+++ b/frontend/src/metabase/metabot/state/actions.ts
@@ -21,7 +21,7 @@ import { setIsNativeEditorOpen } from "metabase/redux/query-builder";
import type { Dispatch, State } from "metabase/redux/store";
import { addUndo } from "metabase/redux/undo";
import { createAsyncThunk } from "metabase/redux/utils";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import { getUser } from "metabase/selectors/user";
import { getSetting } from "metabase/settings";
import * as Urls from "metabase/urls";
@@ -599,8 +599,7 @@ export const sendAgentRequest = createAsyncThunk<
return;
}
- // Unjustified type cast. FIXME
- dispatchToConvo(push(path) as UnknownAction);
+ navigate(path);
})
.with({ type: "data-entity_saved" }, (part) => {
dispatch(
@@ -965,7 +964,7 @@ export const forkConversation = createAsyncThunk(
);
if (agentId === "ask") {
- dispatch(push(Urls.metabotConversation(conversation.conversation_id)));
+ navigate(Urls.metabotConversation(conversation.conversation_id));
}
return conversation;
diff --git a/frontend/src/metabase/metadata/pages/DataModelV1/components/TablePicker/wrappers.tsx b/frontend/src/metabase/metadata/pages/DataModelV1/components/TablePicker/wrappers.tsx
index f0117f37cdd..a613df91977 100644
--- a/frontend/src/metabase/metadata/pages/DataModelV1/components/TablePicker/wrappers.tsx
+++ b/frontend/src/metabase/metadata/pages/DataModelV1/components/TablePicker/wrappers.tsx
@@ -1,14 +1,13 @@
import { useCallback, useEffect, useState } from "react";
-import { useDispatch } from "metabase/redux";
-import { push, replace, useLocation } from "metabase/router";
+import { useLocation, useNavigate } from "metabase/router";
import * as Urls from "metabase/urls";
import { TablePicker } from "./components";
import type { ChangeOptions, TreePath } from "./types";
export function RouterTablePicker(props: TreePath) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [value, setValue] = useState(props);
const location = useLocation();
const isSegments = location.pathname?.startsWith("/admin/datamodel/segment");
@@ -25,14 +24,14 @@ export function RouterTablePicker(props: TreePath) {
if (options?.isAutomatic) {
// prevent auto-navigation from table-picker when Segments tab is open
if (!isSegments) {
- dispatch(replace(Urls.dataModel(value)));
+ navigate(Urls.dataModel(value), { replace: true });
}
} else {
- dispatch(push(Urls.dataModel(value)));
+ navigate(Urls.dataModel(value));
}
}
},
- [dispatch, isSegments, props],
+ [isSegments, props, navigate],
);
useEffect(() => {
diff --git a/frontend/src/metabase/metrics-viewer/hooks/use-viewer-url.ts b/frontend/src/metabase/metrics-viewer/hooks/use-viewer-url.ts
index b3b01baac9b..3f38e733ce9 100644
--- a/frontend/src/metabase/metrics-viewer/hooks/use-viewer-url.ts
+++ b/frontend/src/metabase/metrics-viewer/hooks/use-viewer-url.ts
@@ -2,9 +2,8 @@ import { useEffect, useRef } from "react";
import { t } from "ttag";
import { useToast } from "metabase/common/hooks";
-import { useDispatch } from "metabase/redux";
import type { Location } from "metabase/router";
-import { push, replace } from "metabase/router";
+import { useNavigate } from "metabase/router";
import * as Urls from "metabase/urls";
import type { MeasureId } from "metabase-types/api";
import type { MetricId } from "metabase-types/api/metric";
@@ -42,7 +41,7 @@ export function useViewerUrl(
) => void,
setInitialLoadComplete: (initialLoadComplete: boolean) => void,
): void {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [sendToast] = useToast();
const lastHashRef = useRef<string | null>(null);
@@ -151,7 +150,6 @@ export function useViewerUrl(
}
}, [
location,
- dispatch,
initialize,
onLoadSources,
setFormulaEntities,
@@ -189,10 +187,10 @@ export function useViewerUrl(
lastHashRef.current = hash;
const url = Urls.metricsViewer(hash);
if (!window.location.hash) {
- dispatch(replace(url));
+ navigate(url, { replace: true });
} else {
- dispatch(push(url));
+ navigate(url);
}
}
- }, [state, dispatch]);
+ }, [state, navigate]);
}
diff --git a/frontend/src/metabase/metrics/components/MetricDimensionGrid/MetricDimensionGrid.tsx b/frontend/src/metabase/metrics/components/MetricDimensionGrid/MetricDimensionGrid.tsx
index 13352d6e0f6..462b073bc3f 100644
--- a/frontend/src/metabase/metrics/components/MetricDimensionGrid/MetricDimensionGrid.tsx
+++ b/frontend/src/metabase/metrics/components/MetricDimensionGrid/MetricDimensionGrid.tsx
@@ -9,8 +9,7 @@ import {
} from "metabase/common/metrics/utils/dimension-types";
import { trackMetricPageShowMoreClicked } from "metabase/metrics/analytics";
import { useMetricDimensionQuery } from "metabase/metrics/common/hooks";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
Button,
Flex,
@@ -149,7 +148,7 @@ function MetricDimensionCard({
dimension,
displayType,
}: MetricDimensionCardProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const { data } = useMetricDimensionQuery(definition, dimension.dimensionId);
const rawSeries = useMemo(
@@ -158,18 +157,16 @@ function MetricDimensionCard({
);
const handleClick = useCallback(() => {
- dispatch(
- push(
- Urls.exploreMetricDimension({
- metricId,
- dimensionId: dimension.dimensionId,
- dimensionType: dimension.dimensionType,
- displayType,
- label: dimension.label,
- }),
- ),
+ navigate(
+ Urls.exploreMetricDimension({
+ metricId,
+ dimensionId: dimension.dimensionId,
+ dimensionType: dimension.dimensionType,
+ displayType,
+ label: dimension.label,
+ }),
);
- }, [dispatch, metricId, dimension, displayType]);
+ }, [metricId, dimension, displayType, navigate]);
return (
<Paper withBorder shadow="none" className={S.card} onClick={handleClick}>
diff --git a/frontend/src/metabase/metrics/components/MetricHeader/MetricToolbar/MetricToolbar.tsx b/frontend/src/metabase/metrics/components/MetricHeader/MetricToolbar/MetricToolbar.tsx
index 5f8cfbb08a2..81a076b77b4 100644
--- a/frontend/src/metabase/metrics/components/MetricHeader/MetricToolbar/MetricToolbar.tsx
+++ b/frontend/src/metabase/metrics/components/MetricHeader/MetricToolbar/MetricToolbar.tsx
@@ -22,7 +22,7 @@ import { CardCopyModal } from "metabase/questions/components/CardCopyModal";
import { MoveCardModal } from "metabase/questions/components/MoveCardModal";
import { useDispatch, useSelector } from "metabase/redux";
import { openUrl } from "metabase/redux/app";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { getMetadata } from "metabase/selectors/metadata";
import { canManageSubscriptions as canManageSubscriptionsSelector } from "metabase/selectors/user";
import { ActionIcon, Icon, Menu } from "metabase/ui";
@@ -233,10 +233,10 @@ interface MetricModalProps {
}
function MetricModal({ card, urls, modalType, onClose }: MetricModalProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const handleCopy = (newCard: Card) => {
- dispatch(push(urls.about(newCard.id)));
+ navigate(urls.about(newCard.id));
};
switch (modalType) {
@@ -253,7 +253,7 @@ function MetricModal({ card, urls, modalType, onClose }: MetricModalProps) {
<AddToDashSelectDashModal
card={card}
onClose={onClose}
- onChangeLocation={(location) => dispatch(push(location))}
+ onChangeLocation={(location) => navigate(location)}
/>
);
case "alert":
diff --git a/frontend/src/metabase/metrics/components/MetricPageShell/MetricPageShell.tsx b/frontend/src/metabase/metrics/components/MetricPageShell/MetricPageShell.tsx
index 0febe4b1c61..2d1c3544a3f 100644
--- a/frontend/src/metabase/metrics/components/MetricPageShell/MetricPageShell.tsx
+++ b/frontend/src/metabase/metrics/components/MetricPageShell/MetricPageShell.tsx
@@ -7,7 +7,7 @@ import type { CollectionPickerValueItem } from "metabase/common/components/Picke
import type { MetricUrls } from "metabase/common/metrics/types";
import { useDispatch } from "metabase/redux";
import { addUndo } from "metabase/redux/undo";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import type { Card } from "metabase-types/api";
import { CollectionBreadcrumbs } from "../CollectionBreadcrumbs";
@@ -33,6 +33,7 @@ export function MetricPageShell({
const [updateCard] = useUpdateCardMutation();
const [deleteCard] = useDeleteCardMutation();
const dispatch = useDispatch();
+ const navigate = useNavigate();
return (
<>
@@ -54,7 +55,7 @@ export function MetricPageShell({
onDeletePermanently={async () => {
try {
await deleteCard(card.id).unwrap();
- dispatch(push("/trash"));
+ navigate("/trash");
dispatch(
addUndo({
message: t`This item has been permanently deleted.`,
diff --git a/frontend/src/metabase/metrics/pages/MetricOverviewPage/MetricOverviewPage.tsx b/frontend/src/metabase/metrics/pages/MetricOverviewPage/MetricOverviewPage.tsx
index 6dca5056e6e..7d9a48ec932 100644
--- a/frontend/src/metabase/metrics/pages/MetricOverviewPage/MetricOverviewPage.tsx
+++ b/frontend/src/metabase/metrics/pages/MetricOverviewPage/MetricOverviewPage.tsx
@@ -8,8 +8,7 @@ import type {
MetricPageProps,
MetricUrls,
} from "metabase/common/metrics/types";
-import { useDispatch } from "metabase/redux";
-import { replace, useParams } from "metabase/router";
+import { useNavigate, useParams } from "metabase/router";
import { Center } from "metabase/ui";
import type { Card } from "metabase-types/api";
@@ -53,7 +52,7 @@ function MetricOverviewPageBody({
showAppSwitcher,
showDataStudioLink,
}: MetricOverviewPageBodyProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const { data: metric, isLoading: isMetricLoading } = useGetMetricQuery(
card.id,
);
@@ -62,9 +61,9 @@ function MetricOverviewPageBody({
useEffect(() => {
if (!isMetricLoading && !hasDimensions) {
- dispatch(replace(urls.about(card.id)));
+ navigate(urls.about(card.id), { replace: true });
}
- }, [card.id, isMetricLoading, hasDimensions, dispatch, urls]);
+ }, [card.id, isMetricLoading, hasDimensions, urls, navigate]);
if (isMetricLoading) {
return (
diff --git a/frontend/src/metabase/metrics/pages/NewMetricPage/NewMetricPage.tsx b/frontend/src/metabase/metrics/pages/NewMetricPage/NewMetricPage.tsx
index 17199ae60b1..2aa45058d03 100644
--- a/frontend/src/metabase/metrics/pages/NewMetricPage/NewMetricPage.tsx
+++ b/frontend/src/metabase/metrics/pages/NewMetricPage/NewMetricPage.tsx
@@ -15,8 +15,8 @@ import type { MetricUrls } from "metabase/common/metrics/types";
import { MetricQueryEditor } from "metabase/metrics/components/MetricQueryEditor";
import { NAME_MAX_LENGTH } from "metabase/metrics/constants";
import { getInitialUiState } from "metabase/querying/editor/components/QueryEditor";
-import { useDispatch, useSelector } from "metabase/redux";
-import { goBack, push, useLocation } from "metabase/router";
+import { useSelector } from "metabase/redux";
+import { useLocation, useNavigate } from "metabase/router";
import { getMetadata } from "metabase/selectors/metadata";
import { Breadcrumbs, Card, Icon } from "metabase/ui";
import * as Urls from "metabase/urls";
@@ -55,7 +55,7 @@ export function NewMetricPage({
new URLSearchParams(location.search).get("collectionId") ?? undefined,
);
const defaultCollectionId = useGetDefaultCollectionId();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const query = useMemo(
() => getQuery(datasetQuery, metadata),
@@ -82,7 +82,7 @@ export function NewMetricPage({
);
const handleCreate = (card: CardApiType) => {
- dispatch(push(urls.about(card.id)));
+ navigate(urls.about(card.id));
};
const handleChangeQuery = (query: Lib.Query) => {
@@ -93,7 +93,7 @@ export function NewMetricPage({
};
const handleCancel = () => {
- dispatch(goBack());
+ navigate(-1);
};
return (
diff --git a/frontend/src/metabase/models/containers/ModelActions/ModelActions.tsx b/frontend/src/metabase/models/containers/ModelActions/ModelActions.tsx
index 73638ffbcaf..3e19a9ad19f 100644
--- a/frontend/src/metabase/models/containers/ModelActions/ModelActions.tsx
+++ b/frontend/src/metabase/models/containers/ModelActions/ModelActions.tsx
@@ -15,8 +15,7 @@ import { loadMetadataForCard } from "metabase/questions/actions";
import { connect, useSelector } from "metabase/redux";
import type { State } from "metabase/redux/store";
import { fetchTableForeignKeys } from "metabase/redux/tables";
-import type { LocationDescriptor } from "metabase/router";
-import { Outlet, replace, useParams } from "metabase/router";
+import { Outlet, useNavigate, useParams } from "metabase/router";
import { getMetadata } from "metabase/selectors/metadata";
import * as Urls from "metabase/urls";
import * as Lib from "metabase-lib";
@@ -35,7 +34,6 @@ type EntityLoadersProps = {
type DispatchProps = {
loadMetadataForCard: (card: Card) => void;
fetchTableForeignKeys: (params: { id: Table["id"] }) => void;
- onChangeLocation: (location: LocationDescriptor) => void;
};
type Props = EntityLoadersProps & DispatchProps;
@@ -43,15 +41,14 @@ type Props = EntityLoadersProps & DispatchProps;
const mapDispatchToProps = {
loadMetadataForCard,
fetchTableForeignKeys,
- onChangeLocation: replace,
};
function ModelActions({
model,
loadMetadataForCard,
fetchTableForeignKeys,
- onChangeLocation,
}: Props) {
+ const navigate = useNavigate();
useListDatabasesQuery();
const { data: actions = [] } = useListActionsQuery({
"model-id": model.id(),
@@ -86,7 +83,7 @@ function ModelActions({
loadMetadataForCard(card);
}
} else {
- onChangeLocation(Urls.card(card));
+ navigate(Urls.card(card), { replace: true });
}
});
diff --git a/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobTriggersSidebar.tsx b/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobTriggersSidebar.tsx
index d2298d7fbe3..1ddb91584cd 100644
--- a/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobTriggersSidebar.tsx
+++ b/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobTriggersSidebar.tsx
@@ -2,8 +2,7 @@ import { Fragment } from "react";
import { t } from "ttag";
import { useGetTasksInfoQuery } from "metabase/api";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { ActionIcon, Divider, Flex, Icon, Stack, Text } from "metabase/ui";
import * as Urls from "metabase/urls";
import { EMPTY_CELL_PLACEHOLDER } from "metabase/utils/constants";
@@ -17,13 +16,13 @@ type JobTriggersSidebarProps = {
export const JobTriggersSidebar = ({ jobKey }: JobTriggersSidebarProps) => {
const { data } = useGetTasksInfoQuery();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const job = data?.jobs.find((job) => job.key === jobKey);
const triggers = job?.triggers ?? [];
const handleClose = () => {
- dispatch(push(Urls.monitorJobs()));
+ navigate(Urls.monitorJobs());
};
return (
diff --git a/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobsTable.tsx b/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobsTable.tsx
index 5a1792c8cc4..8d869d10c1d 100644
--- a/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobsTable.tsx
+++ b/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobsTable.tsx
@@ -4,8 +4,7 @@ import { t } from "ttag";
import { MonitorEmptyState } from "metabase/monitor/components/MonitorEmptyState";
import { MonitorTableCard } from "metabase/monitor/components/MonitorTableCard";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
Ellipsified,
LoadingOverlay,
@@ -28,7 +27,7 @@ type JobsTableProps = {
};
export const JobsTable = ({ isFetching, isLoading, jobs }: JobsTableProps) => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const rows: JobRow[] = useMemo(
() => jobs.map((job) => ({ ...job, id: job.key })),
@@ -38,9 +37,9 @@ export const JobsTable = ({ isFetching, isLoading, jobs }: JobsTableProps) => {
const handleRowActivate = useCallback(
(row: Row<JobRow>) => {
- dispatch(push(Urls.monitorJobTriggers(row.original.key)));
+ navigate(Urls.monitorJobTriggers(row.original.key));
},
- [dispatch],
+ [navigate],
);
const treeTableInstance = useTreeTableInstance<JobRow>({
diff --git a/frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobs.tsx b/frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobs.tsx
index 6089179ade4..4f98a251e5f 100644
--- a/frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobs.tsx
+++ b/frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobs.tsx
@@ -17,8 +17,7 @@ import { MonitorEmptyState } from "metabase/monitor/components/MonitorEmptyState
import { MonitorHeaderTitle } from "metabase/monitor/components/MonitorHeaderTitle";
import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
import { MonitorTableCard } from "metabase/monitor/components/MonitorTableCard";
-import { useDispatch } from "metabase/redux";
-import { Outlet, push } from "metabase/router";
+import { Outlet, useNavigate } from "metabase/router";
import {
ActionIcon,
Center,
@@ -43,7 +42,7 @@ const PAGE_SIZE = 20;
const COLUMN_WIDTHS = [0.22, 0.16, 0.28, 0.14, 0.14, 0.06];
export function ModelPersistenceLogJobs() {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [refreshModelCache] = useRefreshModelCacheMutation();
const { page, handleNextPage, handlePreviousPage } = usePagination();
@@ -71,9 +70,9 @@ export function ModelPersistenceLogJobs() {
const handleRowActivate = useCallback(
(row: Row<ModelCacheRefreshStatus>) => {
const { card_id, card_name } = row.original;
- dispatch(push(Urls.model({ id: card_id, name: card_name })));
+ navigate(Urls.model({ id: card_id, name: card_name }));
},
- [dispatch],
+ [navigate],
);
const treeTableInstance = useTreeTableInstance<ModelCacheRefreshStatus>({
diff --git a/frontend/src/metabase/monitor/tools/components/TaskListPage/TasksTable.tsx b/frontend/src/metabase/monitor/tools/components/TaskListPage/TasksTable.tsx
index b0d9e091c01..e64b776dafe 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskListPage/TasksTable.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TaskListPage/TasksTable.tsx
@@ -8,8 +8,7 @@ import { useScrollToTop, useSortingStateChange } from "metabase/common/hooks";
import { MonitorEmptyState } from "metabase/monitor/components/MonitorEmptyState";
import { MonitorTableCard } from "metabase/monitor/components/MonitorTableCard";
import { TaskStatusBadge } from "metabase/monitor/tools/components/TaskStatusBadge";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
Ellipsified,
LoadingOverlay,
@@ -53,7 +52,7 @@ export const TasksTable = ({
tasks,
onSortingOptionsChange,
}: Props) => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const databaseByID: Record<number, Database> = useMemo(
() => _.indexBy(databases, "id"),
@@ -70,9 +69,9 @@ export const TasksTable = ({
const handleRowActivate = useCallback(
(row: Row<Task>) => {
- dispatch(push(Urls.monitorTaskDetails(row.original.id)));
+ navigate(Urls.monitorTaskDetails(row.original.id));
},
- [dispatch],
+ [navigate],
);
const treeTableInstance = useTreeTableInstance<Task>({
diff --git a/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.tsx b/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.tsx
index 95260108eab..bfe088fb74c 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.tsx
@@ -11,8 +11,7 @@ import CS from "metabase/css/core/index.css";
import { MonitorHeaderTitle } from "metabase/monitor/components/MonitorHeaderTitle";
import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
import { MonitorPageContent } from "metabase/monitor/components/MonitorPageContent";
-import { useDispatch } from "metabase/redux";
-import { push, useParams } from "metabase/router";
+import { useNavigate, useParams } from "metabase/router";
import { Anchor, Box, Flex, Grid, Stack, Text, Tooltip } from "metabase/ui";
import * as Urls from "metabase/urls";
import { EMPTY_CELL_PLACEHOLDER } from "metabase/utils/constants";
@@ -33,10 +32,10 @@ import S from "./TaskRunDetailsPage.module.css";
export const TaskRunDetailsPage = () => {
const { runId } = useParams();
const { data: taskRun, error, isLoading } = useGetTaskRunQuery(Number(runId));
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const onClickTask = (task: Task) => {
- dispatch(push(Urls.monitorTaskDetails(task.id)));
+ navigate(Urls.monitorTaskDetails(task.id));
};
if (!taskRun || error || isLoading) {
diff --git a/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsTable.tsx b/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsTable.tsx
index d0d7233456f..561d7f026e2 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsTable.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsTable.tsx
@@ -6,8 +6,7 @@ import { DateTime } from "metabase/common/components/DateTime";
import { useScrollToTop, useSortingStateChange } from "metabase/common/hooks";
import { MonitorEmptyState } from "metabase/monitor/components/MonitorEmptyState";
import { MonitorTableCard } from "metabase/monitor/components/MonitorTableCard";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
Ellipsified,
LoadingOverlay,
@@ -51,7 +50,7 @@ export const TaskRunsTable = ({
taskRuns,
onSortingOptionsChange,
}: TaskRunsTableProps) => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const columns = useMemo(() => getColumns(), []);
const { sortingState, onSortingChange } = useSortingStateChange({
@@ -63,9 +62,9 @@ export const TaskRunsTable = ({
const handleRowActivate = useCallback(
(row: Row<TaskRun>) => {
- dispatch(push(Urls.monitorTaskRunDetails(row.original.id)));
+ navigate(Urls.monitorTaskRunDetails(row.original.id));
},
- [dispatch],
+ [navigate],
);
const treeTableInstance = useTreeTableInstance<TaskRun>({
diff --git a/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/SidebarHeader.tsx b/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/SidebarHeader.tsx
index 8840c2947fc..7c04eb0f8de 100644
--- a/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/SidebarHeader.tsx
+++ b/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/SidebarHeader.tsx
@@ -2,7 +2,7 @@ import { t } from "ttag";
import { useDispatch } from "metabase/redux";
import { addUndo } from "metabase/redux/undo";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
ActionIcon,
Flex,
@@ -39,6 +39,7 @@ export const SidebarHeader = ({
}: SidebarHeaderProps) => {
const cardName = notification?.payload?.card?.name ?? t`Untitled question`;
const dispatch = useDispatch();
+ const navigate = useNavigate();
const isEditDisabled =
notification == null || isQuestionLoading || isBulkLoading;
@@ -52,7 +53,7 @@ export const SidebarHeader = ({
const handleNavigate = (id: NotificationId | undefined) => {
if (id !== undefined) {
trackAlertsManagementAlertOpened(id, "sidebar_navigation");
- dispatch(push(Urls.monitorNotificationDetail(id)));
+ navigate(Urls.monitorNotificationDetail(id));
}
};
diff --git a/frontend/src/metabase/monitor/tools/notifications/NotificationsAdminPage/NotificationsAdminPage.tsx b/frontend/src/metabase/monitor/tools/notifications/NotificationsAdminPage/NotificationsAdminPage.tsx
index aafaafa1478..b21be388e35 100644
--- a/frontend/src/metabase/monitor/tools/notifications/NotificationsAdminPage/NotificationsAdminPage.tsx
+++ b/frontend/src/metabase/monitor/tools/notifications/NotificationsAdminPage/NotificationsAdminPage.tsx
@@ -23,7 +23,7 @@ import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
import { Sidebar } from "metabase/monitor/components/MonitorLayout/Sidebar";
import { useDispatch } from "metabase/redux";
import { addUndo } from "metabase/redux/undo";
-import { push, useLocation, useParams } from "metabase/router";
+import { useLocation, useNavigate, useParams } from "metabase/router";
import { Flex } from "metabase/ui";
import * as Urls from "metabase/urls";
import type { NotificationId, UserId } from "metabase-types/api";
@@ -57,6 +57,7 @@ export const NotificationsAdminPage = () => {
const notificationId = Urls.extractEntityId(notificationIdParam);
const { ref: containerRef, width: containerWidth } = useElementSize();
const dispatch = useDispatch();
+ const navigate = useNavigate();
const [urlState, { patchUrlState }] = useUrlState(location, urlStateConfig);
const [rowSelection, setRowSelection] = useState<RowSelectionState>({});
const clearSelected = useCallback(() => setRowSelection({}), []);
@@ -161,7 +162,7 @@ export const NotificationsAdminPage = () => {
const handleRowClick = (id: NotificationId) => {
trackAlertsManagementAlertOpened(id, "table_row");
- dispatch(push(Urls.monitorNotificationDetail(id)));
+ navigate(Urls.monitorNotificationDetail(id));
};
const handleSearchChange = (query: string) => {
@@ -172,8 +173,8 @@ export const NotificationsAdminPage = () => {
};
const handleSidebarClose = useCallback(() => {
- dispatch(push(Urls.monitorNotifications()));
- }, [dispatch]);
+ navigate(Urls.monitorNotifications());
+ }, [navigate]);
const deleteNotifications = useCallback(
async (
@@ -198,7 +199,7 @@ export const NotificationsAdminPage = () => {
notificationId !== undefined &&
notificationIds.includes(notificationId)
) {
- dispatch(push(Urls.monitorNotifications()));
+ navigate(Urls.monitorNotifications());
}
} catch {
trackAlertsManagementAlertsDeleted(triggeredFrom, "failure", count);
@@ -210,7 +211,7 @@ export const NotificationsAdminPage = () => {
);
}
},
- [bulkAction, clearSelected, dispatch, notificationId],
+ [bulkAction, clearSelected, dispatch, notificationId, navigate],
);
const handleDeleteBulk = useCallback(() => {
diff --git a/frontend/src/metabase/nav/components/AdminNavbar/AdminNavbar.tsx b/frontend/src/metabase/nav/components/AdminNavbar/AdminNavbar.tsx
index 7d581b6cc16..c3527c38c9c 100644
--- a/frontend/src/metabase/nav/components/AdminNavbar/AdminNavbar.tsx
+++ b/frontend/src/metabase/nav/components/AdminNavbar/AdminNavbar.tsx
@@ -6,9 +6,9 @@ import { Link } from "metabase/common/components/Link";
import { LogoIcon } from "metabase/common/components/LogoIcon";
import { useRegisterShortcut } from "metabase/palette/hooks/useRegisterShortcut";
import { PLUGIN_SECURITY_CENTER } from "metabase/plugins";
-import { useDispatch, useSelector } from "metabase/redux";
+import { useSelector } from "metabase/redux";
import type { AdminPath } from "metabase/redux/store";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { getIsPaidPlan } from "metabase/selectors/settings";
import { getUserIsAdmin } from "metabase/selectors/user";
import { Box, Button, Flex, Group, Icon } from "metabase/ui";
@@ -32,7 +32,7 @@ export const AdminNavbar = ({
}: AdminNavbarProps) => {
const isPaidPlan = useSelector(getIsPaidPlan);
const isAdmin = useSelector(getUserIsAdmin);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
useRegisterShortcut(
[
@@ -46,7 +46,7 @@ export const AdminNavbar = ({
const path = adminPaths[key - 1]?.path;
if (path) {
- dispatch(push(path));
+ navigate(path);
}
},
},
diff --git a/frontend/src/metabase/nav/components/search/RecentsList/RecentsList.tsx b/frontend/src/metabase/nav/components/search/RecentsList/RecentsList.tsx
index 237ee1b1d21..0a7fbd3a77e 100644
--- a/frontend/src/metabase/nav/components/search/RecentsList/RecentsList.tsx
+++ b/frontend/src/metabase/nav/components/search/RecentsList/RecentsList.tsx
@@ -1,7 +1,6 @@
import { useListRecentsQuery } from "metabase/api";
import { RecentsListContent } from "metabase/nav/components/search/RecentsList/RecentsListContent";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Paper } from "metabase/ui";
import { getName } from "metabase/utils/name";
import type {
@@ -25,12 +24,12 @@ export const RecentsList = ({ onClick, className }: RecentsListProps) => {
{ refetchOnMountOrArgChange: true },
);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const onChangeLocation = (item: RecentItem) => {
const url = getItemUrl(item);
if (url) {
- dispatch(push(url));
+ navigate(url);
}
};
diff --git a/frontend/src/metabase/nav/components/search/SearchBar/SearchBar.tsx b/frontend/src/metabase/nav/components/search/SearchBar/SearchBar.tsx
index d7e17a8c5bd..14bc13340df 100644
--- a/frontend/src/metabase/nav/components/search/SearchBar/SearchBar.tsx
+++ b/frontend/src/metabase/nav/components/search/SearchBar/SearchBar.tsx
@@ -20,12 +20,12 @@ import {
import { RecentsList } from "metabase/nav/components/search/RecentsList";
import { SearchResultsDropdown } from "metabase/nav/components/search/SearchResultsDropdown";
import { APP_BAR_HEIGHT } from "metabase/nav/constants";
-import { useDispatch, useSelector } from "metabase/redux";
+import { useSelector } from "metabase/redux";
import type { LocationDescriptorObject } from "metabase/router";
import {
- push,
queryToSearch,
useLocation,
+ useNavigate,
useNavigationType,
} from "metabase/router";
import { getSetting } from "metabase/settings";
@@ -78,14 +78,13 @@ function SearchBar({
const previousLocation = usePrevious(location);
const container = useRef<HTMLDivElement>(null);
const searchInput = useRef<HTMLInputElement>(null);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const hasSearchText = searchText.trim().length > 0;
const onChangeLocation = useCallback(
- (nextLocation: LocationDescriptorObject | string) =>
- dispatch(push(nextLocation)),
- [dispatch],
+ (nextLocation: LocationDescriptorObject | string) => navigate(nextLocation),
+ [navigate],
);
const onInputContainerClick = useCallback(() => {
@@ -161,7 +160,7 @@ function SearchBar({
...filters,
};
onChangeLocation({
- pathname: "search",
+ pathname: "/search",
search: queryToSearch(query),
});
}, [onChangeLocation, previousLocation, searchFilters, searchText]);
diff --git a/frontend/src/metabase/nav/components/search/SearchResults/SearchResults.tsx b/frontend/src/metabase/nav/components/search/SearchResults/SearchResults.tsx
index 89d323e3b28..26e92551aa8 100644
--- a/frontend/src/metabase/nav/components/search/SearchResults/SearchResults.tsx
+++ b/frontend/src/metabase/nav/components/search/SearchResults/SearchResults.tsx
@@ -8,8 +8,7 @@ import { EmptyState } from "metabase/common/components/EmptyState";
import { SearchResult } from "metabase/common/components/SearchResult/SearchResult";
import { useListKeyboardNavigation } from "metabase/common/hooks/use-list-keyboard-navigation";
import type { SearchFilters } from "metabase/common/search/types";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import { Box, Loader, Stack, rem } from "metabase/ui";
import { modelToUrl } from "metabase/urls";
import {
@@ -73,8 +72,6 @@ export const SearchResults = ({
onFooterSelect,
context,
}: SearchResultsProps) => {
- const dispatch = useDispatch();
-
const [debouncedSearchText, setDebouncedSearchText] = useState<string>();
const isWaitingForDebounce = searchText !== debouncedSearchText;
@@ -134,7 +131,7 @@ export const SearchResults = ({
if (onEntitySelect) {
onEntitySelect(item);
} else if (item && modelToUrl(item)) {
- dispatch(push(modelToUrl(item)));
+ navigate(modelToUrl(item));
}
}
};
diff --git a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbar.tsx b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbar.tsx
index ae24efcb413..f89561f64db 100644
--- a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbar.tsx
+++ b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbar.tsx
@@ -9,8 +9,7 @@ import { NavbarPromoSlot } from "metabase/nav/components/NavbarPromoSlot";
import { connect } from "metabase/redux";
import { closeNavbar, openNavbar } from "metabase/redux/app";
import type { State } from "metabase/redux/store";
-import type { LocationDescriptor } from "metabase/router";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import * as Urls from "metabase/urls";
import Question from "metabase-lib/v1/Question";
import type { CollectionId } from "metabase-types/api";
@@ -39,14 +38,10 @@ interface StateProps {
collectionId?: CollectionId | null;
}
-interface DispatchProps extends MainNavbarDispatchProps {
- onChangeLocation: (location: LocationDescriptor) => void;
-}
-
type Props = MainNavbarOwnProps &
EntityLoaderProps &
StateProps &
- DispatchProps;
+ MainNavbarDispatchProps;
function mapStateToProps(state: State, props: MainNavbarOwnProps) {
return {
@@ -58,7 +53,6 @@ function mapStateToProps(state: State, props: MainNavbarOwnProps) {
const mapDispatchToProps = {
openNavbar,
closeNavbar,
- onChangeLocation: push,
};
function MainNavbarInner({
@@ -70,9 +64,9 @@ function MainNavbarInner({
dashboard,
openNavbar,
closeNavbar,
- onChangeLocation,
...props
}: Props) {
+ const navigate = useNavigate();
const { currentData: card } = useGetCardQuery(
questionId
? {
@@ -130,7 +124,7 @@ function MainNavbarInner({
selectedItems={selectedItems}
openNavbar={openNavbar}
closeNavbar={closeNavbar}
- onChangeLocation={onChangeLocation}
+ onChangeLocation={navigate}
{...props}
/>
<NavbarPromoSlot />
diff --git a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/AddDataModal/Panels/DatabasesPanel.tsx b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/AddDataModal/Panels/DatabasesPanel.tsx
index 8de33d6e52c..3a056c3a07a 100644
--- a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/AddDataModal/Panels/DatabasesPanel.tsx
+++ b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/AddDataModal/Panels/DatabasesPanel.tsx
@@ -1,7 +1,6 @@
import { DatabaseEngineList } from "metabase/databases/components/DatabaseEngineList";
import { RETURN_TO_SETUP_GUIDE_PARAM } from "metabase/embedding/constants";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { trackDatabaseSelect } from "../analytics";
@@ -14,7 +13,7 @@ export const DatabasesPanel = ({
canSeeContent: boolean;
fromEmbeddingSetupGuide?: boolean;
}) => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const handleDatabaseSelect = (key: string) => {
trackDatabaseSelect(key);
@@ -22,7 +21,7 @@ export const DatabasesPanel = ({
if (fromEmbeddingSetupGuide) {
params.set(RETURN_TO_SETUP_GUIDE_PARAM, "true");
}
- dispatch(push(`/admin/databases/create?${params.toString()}`));
+ navigate(`/admin/databases/create?${params.toString()}`);
};
return canSeeContent ? (
diff --git a/frontend/src/metabase/new/components/NewModals/NewModals.tsx b/frontend/src/metabase/new/components/NewModals/NewModals.tsx
index b4d67e683c9..c86eb9fa3d3 100644
--- a/frontend/src/metabase/new/components/NewModals/NewModals.tsx
+++ b/frontend/src/metabase/new/components/NewModals/NewModals.tsx
@@ -20,7 +20,7 @@ import { useDispatch, useSelector } from "metabase/redux";
import type { State } from "metabase/redux/store";
import type { ModalState } from "metabase/redux/store/modal";
import { closeModal, setOpenModal } from "metabase/redux/ui";
-import { push, useLocation, useParams } from "metabase/router";
+import { useLocation, useNavigate, useParams } from "metabase/router";
import { Modal, PREVENT_AUTOCOMPLETE_CLIPPING_MODAL_PROPS } from "metabase/ui";
import * as Urls from "metabase/urls";
import type { WritebackAction } from "metabase-types/api";
@@ -37,15 +37,16 @@ export const NewModals = () => {
getCurrentOpenModalState<CreateCollectionModalOwnProps>,
);
const dispatch = useDispatch();
+ const navigate = useNavigate();
const collectionId =
useInitialCollectionId({ location, params }) ?? undefined;
const handleActionCreated = useCallback(
(action: WritebackAction) => {
const nextLocation = Urls.modelDetail({ id: action.model_id }, "actions");
- dispatch(push(nextLocation));
+ navigate(nextLocation);
},
- [dispatch],
+ [navigate],
);
const handleModalClose = useCallback(() => {
diff --git a/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx b/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx
index 69e4da6f52b..4a4a1efb345 100644
--- a/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx
+++ b/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx
@@ -18,7 +18,7 @@ import {
setOpenModal,
setOpenModalWithProps,
} from "metabase/redux/ui";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import {
canUserCreateNativeQueries,
canUserCreateQueries,
@@ -78,6 +78,7 @@ export const useCommandPaletteBasicActions = ({
isLoggedIn: boolean;
}) => {
const dispatch = useDispatch();
+ const navigate = useNavigate();
const collectionId = useInitialCollectionId(props) ?? undefined;
const { data: databases = [] } = useDatabaseListQuery({
@@ -125,15 +126,13 @@ export const useCommandPaletteBasicActions = ({
icon: "insight",
perform: () => {
dispatch(closeModal());
- dispatch(
- push(
- Urls.newQuestion({
- mode: "notebook",
- creationType: "custom_question",
- cardType: "question",
- collectionId,
- }),
- ),
+ navigate(
+ Urls.newQuestion({
+ mode: "notebook",
+ creationType: "custom_question",
+ cardType: "question",
+ collectionId,
+ }),
);
},
});
@@ -147,14 +146,12 @@ export const useCommandPaletteBasicActions = ({
icon: "sql",
perform: () => {
dispatch(closeModal());
- dispatch(
- push(
- Urls.newQuestion({
- DEPRECATED_RAW_MBQL_type: "native",
- creationType: "native_question",
- cardType: "question",
- }),
- ),
+ navigate(
+ Urls.newQuestion({
+ DEPRECATED_RAW_MBQL_type: "native",
+ creationType: "native_question",
+ cardType: "question",
+ }),
);
},
});
@@ -176,7 +173,7 @@ export const useCommandPaletteBasicActions = ({
section: "basic",
icon: "document",
perform: () => {
- dispatch(push(Urls.newDocument()));
+ navigate(Urls.newDocument());
},
});
@@ -198,7 +195,7 @@ export const useCommandPaletteBasicActions = ({
icon: "model",
perform: () => {
dispatch(closeModal());
- dispatch(push("model/new"));
+ navigate("/model/new");
},
});
}
@@ -212,7 +209,7 @@ export const useCommandPaletteBasicActions = ({
perform: () => {
trackMetricCreateStarted("command_palette");
dispatch(closeModal());
- dispatch(push(Urls.newMetric({ collectionId })));
+ navigate(Urls.newMetric({ collectionId }));
},
});
}
@@ -232,7 +229,7 @@ export const useCommandPaletteBasicActions = ({
if (isAdmin) {
actions.push({
id: "navigate-admin-settings",
- perform: () => dispatch(push("/admin/settings")),
+ perform: () => navigate("/admin/settings"),
});
}
@@ -253,7 +250,7 @@ export const useCommandPaletteBasicActions = ({
if (personalCollectionId) {
actions.push({
id: "navigate-personal-collection",
- perform: () => dispatch(push(`/collection/${personalCollectionId}`)),
+ perform: () => navigate(`/collection/${personalCollectionId}`),
});
}
@@ -262,17 +259,17 @@ export const useCommandPaletteBasicActions = ({
id: "navigate-user-settings",
section: "basic",
icon: "person",
- perform: () => dispatch(push("/account/profile")),
+ perform: () => navigate("/account/profile"),
},
{
id: "navigate-trash",
- perform: () => dispatch(push("/trash")),
+ perform: () => navigate("/trash"),
},
{
id: "navigate-home",
section: "basic",
icon: "home",
- perform: () => dispatch(push("/")),
+ perform: () => navigate("/"),
},
);
@@ -281,7 +278,7 @@ export const useCommandPaletteBasicActions = ({
id: "navigate-data-studio",
section: "basic",
icon: "table",
- perform: () => dispatch(push("/data-studio")),
+ perform: () => navigate("/data-studio"),
});
}
@@ -292,7 +289,7 @@ export const useCommandPaletteBasicActions = ({
section: "basic",
icon: "model",
perform: () => {
- dispatch(push("/browse/models"));
+ navigate("/browse/models");
},
},
{
@@ -301,7 +298,7 @@ export const useCommandPaletteBasicActions = ({
section: "basic",
icon: "database",
perform: () => {
- dispatch(push("/browse/databases"));
+ navigate("/browse/databases");
},
},
{
@@ -310,7 +307,7 @@ export const useCommandPaletteBasicActions = ({
section: "basic",
icon: "metric",
perform: () => {
- dispatch(push("/browse/metrics"));
+ navigate("/browse/metrics");
},
},
];
@@ -329,6 +326,7 @@ export const useCommandPaletteBasicActions = ({
openNewModalWithProps,
isAdmin,
personalCollectionId,
+ navigate,
]);
useRegisterShortcut(initialActions, [initialActions]);
diff --git a/frontend/src/metabase/plugins/oss/permissions.ts b/frontend/src/metabase/plugins/oss/permissions.ts
index 27b54a26cfd..e9e5815cdaa 100644
--- a/frontend/src/metabase/plugins/oss/permissions.ts
+++ b/frontend/src/metabase/plugins/oss/permissions.ts
@@ -37,11 +37,11 @@ export interface PermissionAction {
label: string;
icon: IconName;
iconColor: ColorName;
- actionCreator: (
+ onSelect: (
entityId: PermissionEntityId | undefined,
groupId: GroupId,
view: "database" | "group",
- ) => Action;
+ ) => void;
}
export interface PermissionConfirmationProps {
diff --git a/frontend/src/metabase/public/hooks/use-set-embed-font.unit.spec.tsx b/frontend/src/metabase/public/hooks/use-set-embed-font.unit.spec.tsx
index f82f9c4c76f..588eebfd503 100644
--- a/frontend/src/metabase/public/hooks/use-set-embed-font.unit.spec.tsx
+++ b/frontend/src/metabase/public/hooks/use-set-embed-font.unit.spec.tsx
@@ -11,7 +11,7 @@ import { getStore } from "metabase/store";
import { useSetEmbedFont } from "./use-set-embed-font";
const setup = ({ location }: { location: Location }) => {
- const store = getStore(mainReducers, undefined, createMockState());
+ const store = getStore(mainReducers, createMockState());
const Wrapper = ({ children }: PropsWithChildren) => (
<MetabaseReduxProvider store={store}>{children}</MetabaseReduxProvider>
diff --git a/frontend/src/metabase/query_builder/actions/core/initializeQB.ts b/frontend/src/metabase/query_builder/actions/core/initializeQB.ts
index 6bbe30e0e49..1b896460f5d 100644
--- a/frontend/src/metabase/query_builder/actions/core/initializeQB.ts
+++ b/frontend/src/metabase/query_builder/actions/core/initializeQB.ts
@@ -21,7 +21,7 @@ import type {
} from "metabase/redux/store";
import { fetchTableMetadataAndForeignKeys } from "metabase/redux/tables";
import type { Location } from "metabase/router";
-import { replace } from "metabase/router";
+import { navigate } from "metabase/router";
import { FieldSchema } from "metabase/schema";
import { getMetadata } from "metabase/selectors/metadata";
import { canUserCreateQueries, getUser } from "metabase/selectors/user";
@@ -336,7 +336,7 @@ async function handleQBInit(
if (uiControls.queryBuilderMode === "notebook") {
if (!canUserCreateQueries(getState())) {
- dispatch(replace(Urls.unauthorized()));
+ navigate(Urls.unauthorized(), { replace: true });
return;
}
}
diff --git a/frontend/src/metabase/query_builder/actions/models.ts b/frontend/src/metabase/query_builder/actions/models.ts
index 117035e7ed0..ad373a17218 100644
--- a/frontend/src/metabase/query_builder/actions/models.ts
+++ b/frontend/src/metabase/query_builder/actions/models.ts
@@ -7,7 +7,7 @@ import type {
GetState,
} from "metabase/redux/store";
import { addUndo } from "metabase/redux/undo";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import { getQuestion } from "../selectors";
@@ -26,8 +26,8 @@ export const setDatasetEditorTab =
dispatch(runDirtyQuestionQuery());
};
-export const onCancelCreateNewModel = () => async (dispatch: Dispatch) => {
- await dispatch(push("/"));
+export const onCancelCreateNewModel = () => async () => {
+ navigate("/");
};
export const turnQuestionIntoModel =
diff --git a/frontend/src/metabase/query_builder/actions/url.ts b/frontend/src/metabase/query_builder/actions/url.ts
index 34918e5f351..39c1a28c220 100644
--- a/frontend/src/metabase/query_builder/actions/url.ts
+++ b/frontend/src/metabase/query_builder/actions/url.ts
@@ -3,7 +3,7 @@ import { parse as parseUrl } from "url";
import { isEqualCard } from "metabase/common/utils/card";
import { createThunkAction } from "metabase/redux";
import type { LocationDescriptor } from "metabase/router";
-import { push, replace } from "metabase/router";
+import { navigate } from "metabase/router";
import { getBasename } from "metabase/utils/basename";
import * as Lib from "metabase-lib";
import type Question from "metabase-lib/v1/Question";
@@ -144,17 +144,18 @@ export const updateUrl = createThunkAction(
// this is necessary because we can't get the state from history.state
dispatch(setCurrentState(newState));
+ const { state, ...to } = locationDescriptor;
+
try {
if (replaceState) {
- const replaceDescriptor = preserveNavbarState
- ? {
- ...locationDescriptor,
- state: { ...locationDescriptor.state, preserveNavbarState },
- }
- : locationDescriptor;
- dispatch(replace(replaceDescriptor));
+ navigate(to, {
+ replace: true,
+ state: preserveNavbarState
+ ? { ...state, preserveNavbarState }
+ : state,
+ });
} else {
- dispatch(push(locationDescriptor));
+ navigate(to, { state });
}
} catch (e) {
// saving the location state can exceed the session storage quota (metabase#25312)
diff --git a/frontend/src/metabase/query_builder/actions/url.unit.spec.ts b/frontend/src/metabase/query_builder/actions/url.unit.spec.ts
index 7ae08ca2e85..81106d7e09e 100644
--- a/frontend/src/metabase/query_builder/actions/url.unit.spec.ts
+++ b/frontend/src/metabase/query_builder/actions/url.unit.spec.ts
@@ -1,10 +1,9 @@
// Characterization test for the navigation PRODUCER seam.
//
-// This pins updateUrl -> dispatch(push/replace, { ..., state }), the QB side that
-// decides which router action to emit and what card state to carry on it. It is a
-// lock-down net for the react-router migration and is complementary to
-// redux/routing-contract.unit.spec.ts, which pins the transport side (how the
-// dispatched push/replace action drives history navigation).
+// This pins updateUrl -> navigate(to, { replace, state }), the QB side that
+// decides whether to add or replace a history entry and what card state to carry
+// on it. Complementary to router/navigate-contract.unit.spec.tsx, which pins the
+// other side: how `navigate` drives the router.
import { createMockEntitiesState } from "__support__/store";
import {
@@ -12,6 +11,7 @@ import {
createMockQueryBuilderUIControlsState,
createMockState,
} from "metabase/redux/store/mocks";
+import { type NavigateOptions, type To, navigate } from "metabase/router";
import { getMetadata } from "metabase/selectors/metadata";
import * as Urls from "metabase/urls";
import { checkNotNull } from "metabase/utils/types";
@@ -31,7 +31,10 @@ import { updateUrl } from "./url";
registerVisualizations();
-const CALL_HISTORY_METHOD = "@@router/CALL_HISTORY_METHOD";
+jest.mock("metabase/router", () => ({
+ ...jest.requireActual("metabase/router"),
+ navigate: jest.fn(),
+}));
type UpdateUrlOptions = Parameters<typeof updateUrl>[1];
@@ -52,15 +55,27 @@ function buildPristineTableQuestion(): Question {
return checkNotNull(metadata.table(ORDERS_ID)).newQuestion();
}
-function getDispatchedNavigation(dispatch: jest.Mock) {
- const call = dispatch.mock.calls.find(
- ([action]) => action?.type === CALL_HISTORY_METHOD,
- );
+// Re-presents the `navigate(to, options)` call as the descriptor the assertions
+// below were written against: `state` rides in the options, and replacing vs
+// adding a history entry is the `replace` flag rather than a method name.
+function getDispatchedNavigation() {
+ // `navigate` is overloaded, so `jest.mocked` records its calls as the delta
+ // form. `updateUrl` only ever uses the target form.
+ const calls = jest.mocked(navigate).mock.calls as unknown as Array<
+ [To, NavigateOptions | undefined]
+ >;
+ const call = calls.at(-1);
if (!call) {
return null;
}
- const { method, args } = call[0].payload;
- return { method, descriptor: args[0] };
+ const [to, options] = call;
+ return {
+ method: options?.replace ? "replace" : "push",
+ descriptor: {
+ ...(typeof to === "string" ? {} : to),
+ state: options?.state,
+ },
+ };
}
function dispatchedSetCurrentState(dispatch: jest.Mock) {
@@ -101,6 +116,7 @@ async function setup({
describe("QB Actions > updateUrl (navigation producer contract)", () => {
beforeEach(() => {
+ jest.mocked(navigate).mockClear();
jest.spyOn(console, "warn").mockImplementation(() => {});
window.history.replaceState({}, "", "/");
});
@@ -113,12 +129,12 @@ describe("QB Actions > updateUrl (navigation producer contract)", () => {
const card = createSavedStructuredCard();
const question = buildSavedQuestion(card);
- const { dispatch } = await setup({
+ await setup({
question,
options: { dirty: true, replaceState: false },
});
- const navigation = getDispatchedNavigation(dispatch);
+ const navigation = getDispatchedNavigation();
expect(navigation).not.toBeNull();
expect(navigation?.descriptor.state).toEqual({
card: question.card(),
@@ -132,38 +148,38 @@ describe("QB Actions > updateUrl (navigation producer contract)", () => {
const card = createSavedStructuredCard();
const question = buildSavedQuestion(card);
- const { dispatch } = await setup({
+ await setup({
question,
options: { dirty: false },
currentState: { card: question.card(), serializedCard: "" },
});
- expect(getDispatchedNavigation(dispatch)?.method).toBe("replace");
+ expect(getDispatchedNavigation()?.method).toBe("replace");
});
it("forces replace when replaceState is explicitly true", async () => {
const card = createSavedStructuredCard();
const question = buildSavedQuestion(card);
- const { dispatch } = await setup({
+ await setup({
question,
options: { dirty: true, replaceState: true },
});
- expect(getDispatchedNavigation(dispatch)?.method).toBe("replace");
+ expect(getDispatchedNavigation()?.method).toBe("replace");
});
it("forces push when replaceState is explicitly false", async () => {
const card = createSavedStructuredCard();
const question = buildSavedQuestion(card);
- const { dispatch } = await setup({
+ await setup({
question,
options: { dirty: false, replaceState: false },
currentState: { card: question.card(), serializedCard: "" },
});
- expect(getDispatchedNavigation(dispatch)?.method).toBe("push");
+ expect(getDispatchedNavigation()?.method).toBe("push");
});
});
@@ -172,12 +188,11 @@ describe("QB Actions > updateUrl (navigation producer contract)", () => {
const question = buildSavedQuestion(card);
// First run: observe the descriptor the question produces.
- const first = await setup({
+ await setup({
question,
options: { dirty: false },
});
- const descriptor = getDispatchedNavigation(first.dispatch)?.descriptor;
- expect(descriptor).toBeDefined();
+ const descriptor = checkNotNull(getDispatchedNavigation()).descriptor;
// Align window.location with the descriptor so isSameURL becomes true, and
// set currentState.card to the same card so isSameCard becomes true.
@@ -189,13 +204,17 @@ describe("QB Actions > updateUrl (navigation producer contract)", () => {
`${descriptor.pathname}${search}${hash}`,
);
+ // `navigate` is a module mock, so the first run's call would otherwise still
+ // be the latest one.
+ jest.mocked(navigate).mockClear();
+
const { dispatch } = await setup({
question,
options: { dirty: false },
currentState: { card: question.card(), serializedCard: "" },
});
- expect(getDispatchedNavigation(dispatch)).toBeNull();
+ expect(getDispatchedNavigation()).toBeNull();
expect(dispatchedSetCurrentState(dispatch)).toBeUndefined();
});
@@ -204,12 +223,12 @@ describe("QB Actions > updateUrl (navigation producer contract)", () => {
const card = createSavedStructuredCard();
const question = buildSavedQuestion(card);
- const { dispatch } = await setup({
+ await setup({
question,
options: { dirty: true, replaceState: true, preserveNavbarState: true },
});
- const navigation = getDispatchedNavigation(dispatch);
+ const navigation = getDispatchedNavigation();
expect(navigation?.method).toBe("replace");
expect(navigation?.descriptor.state).toEqual({
card: question.card(),
@@ -223,7 +242,7 @@ describe("QB Actions > updateUrl (navigation producer contract)", () => {
const card = createSavedStructuredCard();
const question = buildSavedQuestion(card);
- const { dispatch } = await setup({
+ await setup({
question,
options: {
dirty: true,
@@ -232,7 +251,7 @@ describe("QB Actions > updateUrl (navigation producer contract)", () => {
},
});
- const navigation = getDispatchedNavigation(dispatch);
+ const navigation = getDispatchedNavigation();
expect(navigation?.method).toBe("push");
expect(navigation?.descriptor.state).not.toHaveProperty(
"preserveNavbarState",
@@ -244,14 +263,12 @@ describe("QB Actions > updateUrl (navigation producer contract)", () => {
const card = createSavedStructuredCard();
const question = buildSavedQuestion(card);
- const { dispatch } = await setup({
+ await setup({
question,
options: { dirty: true, replaceState: false, objectId: "42" },
});
- expect(getDispatchedNavigation(dispatch)?.descriptor.state.objectId).toBe(
- "42",
- );
+ expect(getDispatchedNavigation()?.descriptor.state.objectId).toBe("42");
});
describe("table route preservation", () => {
@@ -264,12 +281,12 @@ describe("QB Actions > updateUrl (navigation producer contract)", () => {
window.history.replaceState({}, "", "/table/anything");
- const { dispatch } = await setup({
+ await setup({
question,
options: { queryBuilderMode: "view" },
});
- const navigation = getDispatchedNavigation(dispatch);
+ const navigation = getDispatchedNavigation();
expect(navigation?.descriptor.pathname).toBe(expectedUrl);
expect(navigation?.descriptor.pathname).toBe(
getTableUrlForPristineQuestion(question),
@@ -281,12 +298,12 @@ describe("QB Actions > updateUrl (navigation producer contract)", () => {
window.history.replaceState({}, "", "/question");
- const { dispatch } = await setup({
+ await setup({
question,
options: { queryBuilderMode: "view" },
});
- const pathname = getDispatchedNavigation(dispatch)?.descriptor.pathname;
+ const pathname = getDispatchedNavigation()?.descriptor.pathname;
expect(pathname).toBe("/question");
expect(pathname).not.toMatch(/^\/table\//);
});
@@ -296,14 +313,14 @@ describe("QB Actions > updateUrl (navigation producer contract)", () => {
window.history.replaceState({}, "", "/table/anything");
- const { dispatch } = await setup({
+ await setup({
question,
options: { queryBuilderMode: "view", objectId: "5" },
});
- expect(
- getDispatchedNavigation(dispatch)?.descriptor.pathname,
- ).not.toMatch(/^\/table\//);
+ expect(getDispatchedNavigation()?.descriptor.pathname).not.toMatch(
+ /^\/table\//,
+ );
});
});
});
diff --git a/frontend/src/metabase/query_builder/components/QueryModals/QueryModals.tsx b/frontend/src/metabase/query_builder/components/QueryModals/QueryModals.tsx
index 5055943e9fe..9d16c0e3e1e 100644
--- a/frontend/src/metabase/query_builder/components/QueryModals/QueryModals.tsx
+++ b/frontend/src/metabase/query_builder/components/QueryModals/QueryModals.tsx
@@ -27,7 +27,7 @@ import { ArchiveCardModal } from "metabase/questions/components/ArchiveCardModal
import { MoveCardModal } from "metabase/questions/components/MoveCardModal";
import { useDispatch, useSelector } from "metabase/redux";
import type { QueryBuilderMode } from "metabase/redux/store";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Modal, Text } from "metabase/ui";
import * as Urls from "metabase/urls";
import Question from "metabase-lib/v1/Question";
@@ -69,6 +69,7 @@ export function QueryModals({
onChangeLocation,
}: QueryModalsProps) {
const dispatch = useDispatch();
+ const navigate = useNavigate();
const [sendToast] = useToast();
const initialCollectionId = useGetDefaultCollectionId();
@@ -121,9 +122,9 @@ export function QueryModals({
{ id: dashboardId, name: "", ...question.dashboard(), ...dashboard },
{ editMode: true, scrollToDashcard: dashcard?.id, tabId },
);
- dispatch(push(url));
+ navigate(url);
},
- [dispatch],
+ [dispatch, navigate],
);
const handleSaveModalCreate = useCallback(
diff --git a/frontend/src/metabase/query_builder/containers/QueryBuilder.tsx b/frontend/src/metabase/query_builder/containers/QueryBuilder.tsx
index 63d81b26831..932868759c0 100644
--- a/frontend/src/metabase/query_builder/containers/QueryBuilder.tsx
+++ b/frontend/src/metabase/query_builder/containers/QueryBuilder.tsx
@@ -52,8 +52,8 @@ import {
import type { QueryBuilderUIControls, State } from "metabase/redux/store";
import {
type Location,
- push,
useLocation,
+ useNavigate,
useNavigationType,
useParams,
} from "metabase/router";
@@ -337,7 +337,6 @@ const mapDispatchToProps = {
// other
closeNavbar,
- onChangeLocation: push,
};
const connector = connect(mapStateToProps, mapDispatchToProps);
@@ -347,6 +346,7 @@ type QueryBuilderInnerProps = ReduxProps;
function QueryBuilderInner(props: QueryBuilderInnerProps) {
const location = useLocation();
+ const navigate = useNavigate();
const params = useParams();
useFavicon({ favicon: props.pageFavicon ?? null });
const navigationType = useNavigationType();
@@ -621,6 +621,7 @@ function QueryBuilderInner(props: QueryBuilderInnerProps) {
<>
<View
{...props}
+ onChangeLocation={navigate}
modal={uiControls.modal}
recentlySaved={uiControls.recentlySaved}
onOpenModal={openModal}
diff --git a/frontend/src/metabase/questions/components/MoveCardModal/MoveCardModal.tsx b/frontend/src/metabase/questions/components/MoveCardModal/MoveCardModal.tsx
index 968a401fcb4..4cbe2a74a37 100644
--- a/frontend/src/metabase/questions/components/MoveCardModal/MoveCardModal.tsx
+++ b/frontend/src/metabase/questions/components/MoveCardModal/MoveCardModal.tsx
@@ -17,7 +17,7 @@ import { MoveModal } from "metabase/common/components/Pickers";
import { useDispatch } from "metabase/redux";
import { API_UPDATE_QUESTION } from "metabase/redux/query-builder";
import { addUndo } from "metabase/redux/undo";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Box, Icon, Radio, Title } from "metabase/ui";
import * as Urls from "metabase/urls";
import type { Card } from "metabase-types/api";
@@ -36,6 +36,7 @@ type ConfirmationTypes =
export const MoveCardModal = ({ card, onClose }: MoveCardModalProps) => {
const dispatch = useDispatch();
+ const navigate = useNavigate();
const [updateCard] = useUpdateCardMutation();
@@ -101,7 +102,7 @@ export const MoveCardModal = ({ card, onClose }: MoveCardModalProps) => {
{ id: destination.id, name: "", ...dashboard },
{ editMode: true, scrollToDashcard: dashcard?.id },
);
- dispatch(push(url));
+ navigate(url);
}
onClose();
diff --git a/frontend/src/metabase/redux/app.ts b/frontend/src/metabase/redux/app.ts
index 266bea2d297..c77417a8dd3 100644
--- a/frontend/src/metabase/redux/app.ts
+++ b/frontend/src/metabase/redux/app.ts
@@ -7,12 +7,11 @@ import {
import { combineReducers, handleActions } from "metabase/redux";
import type {
DetailViewState,
- Dispatch,
TempStorage,
TempStorageKey,
TempStorageValue,
} from "metabase/redux/store";
-import { LOCATION_CHANGE, push } from "metabase/router";
+import { LOCATION_CHANGE, navigate } from "metabase/router";
import { isSmallScreen, openInBlankWindow } from "metabase/utils/dom";
import { shouldOpenInBlankWindow } from "metabase/visualizations/lib/open-url";
@@ -45,11 +44,11 @@ export function resetErrorPage() {
};
}
-export const openUrl = (url: string) => (dispatch: Dispatch) => {
+export const openUrl = (url: string) => () => {
if (shouldOpenInBlankWindow(url)) {
openInBlankWindow(url);
} else {
- dispatch(push(url));
+ navigate(url);
}
};
diff --git a/frontend/src/metabase/redux/auth.ts b/frontend/src/metabase/redux/auth.ts
index 9c3c5bb2c61..65b87e47909 100644
--- a/frontend/src/metabase/redux/auth.ts
+++ b/frontend/src/metabase/redux/auth.ts
@@ -13,7 +13,7 @@ import {
} from "metabase/api/session";
import { openNavbar } from "metabase/redux/app";
import { createAsyncThunk } from "metabase/redux/utils";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import { getUser } from "metabase/selectors/user";
import { getSetting, refetchSiteSettings } from "metabase/settings";
import * as Urls from "metabase/urls";
@@ -153,7 +153,7 @@ export const logout = createAsyncThunk(
await deleteSession(dispatch);
await dispatch(refreshLocale()).unwrap();
- dispatch(push(Urls.login()));
+ navigate(Urls.login());
dispatch(Api.util.resetApiState());
reload(); // clears redux state and browser caches
}
diff --git a/frontend/src/metabase/redux/routing-contract.unit.spec.tsx b/frontend/src/metabase/redux/routing-contract.unit.spec.tsx
deleted file mode 100644
index 61e098a5aa7..00000000000
--- a/frontend/src/metabase/redux/routing-contract.unit.spec.tsx
+++ /dev/null
@@ -1,121 +0,0 @@
-import { act, renderWithProviders, waitFor } from "__support__/ui";
-import { Route, goBack, push, replace } from "metabase/router";
-
-// Keystone characterization test for the navigation TRANSPORT seam.
-//
-// `metabase/router` owns the `push`/`replace`/`goBack` action creators, the
-// `routerMiddleware`, and the redux bridge that drives the router. This test
-// pins the observable contract that survives retiring the `routing` slice:
-//
-// dispatch(push/replace/goBack) -> router navigation
-//
-// It wires up the same transport `app.js` uses, isolated from the rest of the
-// app graph. The location is read off the router rather than the store, since it
-// is no longer mirrored into redux.
-
-const setup = () => {
- const { store, history } = renderWithProviders(
- <Route path="*" element={null} />,
- {
- withRouter: true,
- initialRoute: "/",
- },
- );
-
- const location = () => history?.getCurrentLocation();
-
- const navigate = async (action: unknown) => {
- await act(async () => {
- // The transport actions are typed against the app's dispatch, not the
- // test store's inferred action union.
- store.dispatch(action as never);
- });
- };
-
- return { store, location, navigate };
-};
-
-describe("routing transport contract", () => {
- it("starts at the initial location on mount", async () => {
- const { location } = setup();
- await waitFor(() => expect(location()?.pathname).toBe("/"));
- });
-
- it("push(string) updates pathname, search and hash", async () => {
- const { location, navigate } = setup();
-
- await navigate(push("/question/42?x=1#hash"));
-
- expect(location()?.pathname).toBe("/question/42");
- expect(location()?.search).toBe("?x=1");
- expect(location()?.hash).toBe("#hash");
- });
-
- it("push(descriptor) round-trips location.state (the QB card-state case)", async () => {
- // query_builder/actions/url.ts dispatches push() with the serialized card on
- // `state`, so the transport must forward it.
- const { location, navigate } = setup();
- const cardState = {
- card: { id: 7, name: "Q" },
- cardId: 7,
- objectId: undefined,
- };
-
- await navigate(
- push({
- pathname: "/question",
- search: "?y=2",
- hash: "#abc",
- state: cardState,
- }),
- );
-
- expect(location()?.pathname).toBe("/question");
- expect(location()?.state).toEqual(cardState);
- });
-
- it("preserves the preserveNavbarState flag on location.state", async () => {
- const { location, navigate } = setup();
-
- await navigate(
- push({ pathname: "/question/1", state: { preserveNavbarState: true } }),
- );
-
- expect(location()?.state).toEqual({ preserveNavbarState: true });
- });
-
- it("push adds a history entry, replace does not", async () => {
- const { location, navigate } = setup();
-
- await navigate(push("/a"));
- await navigate(replace("/b"));
- expect(location()?.pathname).toBe("/b");
-
- // `/b` replaced `/a`, so going back lands on the entry before it.
- await navigate(goBack());
- expect(location()?.pathname).toBe("/");
- });
-
- it("goBack returns to the previous entry", async () => {
- const { location, navigate } = setup();
-
- await navigate(push("/first"));
- await navigate(push("/second"));
- expect(location()?.pathname).toBe("/second");
-
- await navigate(goBack());
- expect(location()?.pathname).toBe("/first");
- });
-
- it("routes every navigation through the transport", async () => {
- const { location, navigate } = setup();
-
- const seen: string[] = [];
- await navigate(push("/one"));
- seen.push(location()?.pathname ?? "");
- await navigate(push("/two"));
- seen.push(location()?.pathname ?? "");
-
- expect(seen).toEqual(["/one", "/two"]);
- });
-});
diff --git a/frontend/src/metabase/reference/databases/DatabaseDetail.tsx b/frontend/src/metabase/reference/databases/DatabaseDetail.tsx
index 24df4e62e82..cca70342cde 100644
--- a/frontend/src/metabase/reference/databases/DatabaseDetail.tsx
+++ b/frontend/src/metabase/reference/databases/DatabaseDetail.tsx
@@ -10,7 +10,6 @@ import Detail from "metabase/reference/components/Detail";
import { EditHeader } from "metabase/reference/components/EditHeader";
import EditableReferenceHeader from "metabase/reference/components/EditableReferenceHeader";
import * as actions from "metabase/reference/reference";
-import { push } from "metabase/router";
import { getShallowFields as getFields } from "metabase/selectors/metadata";
import type { User } from "metabase-types/api";
@@ -52,7 +51,6 @@ const mapDispatchToProps = {
...metadataActions,
...actions,
onSubmit: actions.rUpdateDatabaseDetail,
- onChangeLocation: push,
};
interface DatabaseDetailProps {
diff --git a/frontend/src/metabase/reference/databases/FieldDetail.tsx b/frontend/src/metabase/reference/databases/FieldDetail.tsx
index 920f09dd203..5cb0a563195 100644
--- a/frontend/src/metabase/reference/databases/FieldDetail.tsx
+++ b/frontend/src/metabase/reference/databases/FieldDetail.tsx
@@ -13,7 +13,6 @@ import EditableReferenceHeader from "metabase/reference/components/EditableRefer
import FieldTypeDetail from "metabase/reference/components/FieldTypeDetail";
import UsefulQuestions from "metabase/reference/components/UsefulQuestions";
import * as actions from "metabase/reference/reference";
-import { push } from "metabase/router";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type { FieldId, User } from "metabase-types/api";
@@ -113,7 +112,6 @@ const mapDispatchToProps = {
...metadataActions,
...actions,
onSubmit: actions.rUpdateFieldDetail,
- onChangeLocation: push,
};
interface FieldDetailProps {
diff --git a/frontend/src/metabase/reference/databases/TableDetail.tsx b/frontend/src/metabase/reference/databases/TableDetail.tsx
index b69abb14b6c..f4ebf659ac4 100644
--- a/frontend/src/metabase/reference/databases/TableDetail.tsx
+++ b/frontend/src/metabase/reference/databases/TableDetail.tsx
@@ -12,7 +12,6 @@ import { EditHeader } from "metabase/reference/components/EditHeader";
import EditableReferenceHeader from "metabase/reference/components/EditableReferenceHeader";
import UsefulQuestions from "metabase/reference/components/UsefulQuestions";
import * as actions from "metabase/reference/reference";
-import { push } from "metabase/router";
import {
getShallowFields as getFields,
getMetadata,
@@ -87,7 +86,6 @@ const mapDispatchToProps = {
...metadataActions,
...actions,
onSubmit: actions.rUpdateTableDetail,
- onChangeLocation: push,
};
interface TableDetailProps {
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedNode.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedNode.tsx
index dacb479af46..6744e52e812 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedNode.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedNode.tsx
@@ -24,7 +24,7 @@ import {
MAX_GROUP_SIZE,
} from "metabase/rich_text_editing/tiptap/extensions/shared/constants";
import { DropZone } from "metabase/rich_text_editing/tiptap/extensions/shared/dnd/DropZone";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { getMetadata } from "metabase/selectors/metadata";
import {
Box,
@@ -177,6 +177,7 @@ export const CardEmbedComponent = memo(
: "";
const { id, name } = node.attrs;
const dispatch = useDispatch();
+ const navigate = useNavigate();
const canWrite = editor.options.editable;
const {
@@ -575,7 +576,7 @@ export const CardEmbedComponent = memo(
variant={isOpen ? "filled" : "default"}
unresolvedCommentsCount={unresolvedCommentsCount}
onClick={() => {
- dispatch(push(commentsPath));
+ navigate(commentsPath);
}}
/>
</Box>
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/SupportingText/SupportingText.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/SupportingText/SupportingText.tsx
index 930a03c961d..34a6acfe977 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/SupportingText/SupportingText.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/SupportingText/SupportingText.tsx
@@ -13,11 +13,11 @@ import {
import cx from "classnames";
import { t } from "ttag";
-import { useDispatch, useSelector } from "metabase/redux/hooks";
+import { useSelector } from "metabase/redux/hooks";
import { useEditorHost } from "metabase/rich_text_editing/tiptap/EditorHost";
import { DropZone } from "metabase/rich_text_editing/tiptap/extensions/shared/dnd/DropZone";
import { useDndHelpers } from "metabase/rich_text_editing/tiptap/extensions/shared/dnd/use-dnd-helpers";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Box } from "metabase/ui";
import { isWithinIframe } from "metabase/utils/iframe";
@@ -144,7 +144,7 @@ const SupportingTextComponent = ({
const commentsPath = document
? `/document/${document.id}/comments/${_id}`
: "";
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const canWrite = editor.options.editable;
@@ -236,12 +236,10 @@ const SupportingTextComponent = ({
unresolvedCommentsCount={unresolvedCommentsCount}
onClick={(e) => {
e.preventDefault();
- dispatch(
- push(
- unresolvedCommentsCount > 0
- ? commentsPath
- : `${commentsPath}?new=true`,
- ),
+ navigate(
+ unresolvedCommentsCount > 0
+ ? commentsPath
+ : `${commentsPath}?new=true`,
);
}}
/>
diff --git a/frontend/src/metabase/router/AppShell.tsx b/frontend/src/metabase/router/AppShell.tsx
index 18f1b7f5276..3ef086ce528 100644
--- a/frontend/src/metabase/router/AppShell.tsx
+++ b/frontend/src/metabase/router/AppShell.tsx
@@ -7,13 +7,12 @@ import { RouteLeaveGuards } from "./route-leave-guards";
/**
* The element of the host's pathless layout route.
*
- * It registers the router's `navigate` for the redux navigator adapter, so
- * `dispatch(push(...))` drives the router. Registering from here rather than
- * from the router object matters for a relative target: `router.navigate`
+ * It registers the router's `navigate` for the module-level `navigate`, the
+ * hatch that non-component code navigates through. Registering from here rather
+ * than from the router object matters for a relative target: `router.navigate`
* resolves it against the deepest matched route, while this route contributes no
- * path and so resolves from the root. Redux navigation carries no route context
- * of its own, and history@3 resolved a relative push against the root, so root
- * is the behavior to keep (`SearchBar` pushes `{ pathname: "search" }`).
+ * path and so resolves from the root. That hatch carries no route context of its
+ * own, so the root is the only sensible base.
*
* It also owns the router's single blocker, which the route-leave guards share.
*/
diff --git a/frontend/src/metabase/router/create-router.tsx b/frontend/src/metabase/router/create-router.tsx
index 7efb17765e9..3bf9ae12b9a 100644
--- a/frontend/src/metabase/router/create-router.tsx
+++ b/frontend/src/metabase/router/create-router.tsx
@@ -6,6 +6,7 @@ import {
} from "react-router";
import { AppShell } from "./AppShell";
+import { setRouterExpected } from "./navigator";
export type MemoryTestRouter = DataRouter;
@@ -23,6 +24,10 @@ export type MemoryTestRouterHolder = { current: MemoryTestRouter | null };
* seat for anything the app shell needs above the route tree.
*/
function withAppShell(routes: RouteObject[]): RouteObject[] {
+ // Every router this module builds gets an `AppShell`, and every `AppShell`
+ // registers a `navigate`. That is what lets the navigator hold a navigation
+ // made before the registration, knowing one is coming.
+ setRouterExpected(true);
return [{ element: <AppShell />, children: routes }];
}
diff --git a/frontend/src/metabase/router/index.ts b/frontend/src/metabase/router/index.ts
index 808be80b198..d77a31fff81 100644
--- a/frontend/src/metabase/router/index.ts
+++ b/frontend/src/metabase/router/index.ts
@@ -8,13 +8,11 @@ export {
Route,
useInRouterContext,
useLocation,
- useNavigate,
useNavigationType,
useParams,
useSearchParams,
} from "react-router";
-export * from "./middleware";
-export * from "./navigation";
+export * from "./use-navigate";
export * from "./redirect";
export * from "./to-route-objects";
export * from "./location-change";
@@ -30,7 +28,7 @@ export {
export { queryToSearch, toFacadeLocation } from "./location";
export { createLocationMirror, type LocationMirror } from "./location-mirror";
export {
- createRouterNavigator,
+ navigate,
notifyLocationListeners,
subscribeLocation,
toNavigateArgs,
diff --git a/frontend/src/metabase/router/middleware.ts b/frontend/src/metabase/router/middleware.ts
deleted file mode 100644
index 1fc4439944d..00000000000
--- a/frontend/src/metabase/router/middleware.ts
+++ /dev/null
@@ -1,52 +0,0 @@
-import type { Middleware } from "@reduxjs/toolkit";
-import { match } from "ts-pattern";
-
-import {
- CALL_HISTORY_METHOD,
- type CallHistoryMethodAction,
-} from "./navigation";
-import type { History } from "./types";
-
-/**
- * The slice of `history` the middleware drives. v3's `History` satisfies it, and
- * the v7 navigator adapter implements exactly these, so the middleware is engine
- * agnostic and the engine swap only changes which navigator is passed in.
- */
-export type RouterNavigator = Pick<
- History,
- "push" | "replace" | "go" | "goBack" | "goForward"
->;
-
-function isCallHistoryMethod(
- action: unknown,
-): action is CallHistoryMethodAction {
- return (
- typeof action === "object" &&
- action !== null &&
- "type" in action &&
- action.type === CALL_HISTORY_METHOD
- );
-}
-
-/**
- * Re-owned equivalent of react-router-redux's `routerMiddleware`.
- *
- * Holds the `history` ref, intercepts CALL_HISTORY_METHOD actions, and applies
- * the matching method to history. These actions never reach the reducers, just
- * like the package it replaces.
- */
-export function routerMiddleware(navigator: RouterNavigator): Middleware {
- return () => (next) => (action) => {
- if (!isCallHistoryMethod(action)) {
- return next(action);
- }
-
- match(action.payload)
- .with({ method: "push" }, ({ args }) => navigator.push(args[0]))
- .with({ method: "replace" }, ({ args }) => navigator.replace(args[0]))
- .with({ method: "go" }, ({ args }) => navigator.go(args[0]))
- .with({ method: "goBack" }, () => navigator.goBack())
- .with({ method: "goForward" }, () => navigator.goForward())
- .exhaustive();
- };
-}
diff --git a/frontend/src/metabase/router/navigate-contract.unit.spec.tsx b/frontend/src/metabase/router/navigate-contract.unit.spec.tsx
new file mode 100644
index 00000000000..34518c7db84
--- /dev/null
+++ b/frontend/src/metabase/router/navigate-contract.unit.spec.tsx
@@ -0,0 +1,111 @@
+import { act, renderWithProviders, waitFor } from "__support__/ui";
+import { Route, navigate } from "metabase/router";
+
+// Characterization test for the module-level `navigate`, the escape hatch that
+// non-component code uses instead of a hook. It is the last navigation path with
+// no component to anchor it, so the contract it has to keep is pinned here:
+//
+// navigate(to, options) -> router navigation
+//
+// The location is read off the router rather than the store, since it is not
+// mirrored into redux.
+
+const setup = () => {
+ const { history } = renderWithProviders(<Route path="*" element={null} />, {
+ withRouter: true,
+ initialRoute: "/",
+ });
+
+ const location = () => history?.getCurrentLocation();
+
+ const go = async (run: () => void) => {
+ await act(async () => {
+ run();
+ });
+ };
+
+ return { location, go };
+};
+
+describe("navigate contract", () => {
+ it("starts at the initial location on mount", async () => {
+ const { location } = setup();
+ await waitFor(() => expect(location()?.pathname).toBe("/"));
+ });
+
+ it("navigate(string) updates pathname, search and hash", async () => {
+ const { location, go } = setup();
+
+ await go(() => navigate("/question/42?x=1#hash"));
+
+ expect(location()?.pathname).toBe("/question/42");
+ expect(location()?.search).toBe("?x=1");
+ expect(location()?.hash).toBe("#hash");
+ });
+
+ it("carries location.state across (the QB card-state case)", async () => {
+ // query_builder/actions/url.ts navigates with the serialized card on
+ // `state`, so the hatch must forward it.
+ const { location, go } = setup();
+ const cardState = {
+ card: { id: 7, name: "Q" },
+ cardId: 7,
+ objectId: undefined,
+ };
+
+ await go(() =>
+ navigate(
+ { pathname: "/question", search: "?y=2", hash: "#abc" },
+ { state: cardState },
+ ),
+ );
+
+ expect(location()?.pathname).toBe("/question");
+ expect(location()?.state).toEqual(cardState);
+ });
+
+ it("preserves the preserveNavbarState flag on location.state", async () => {
+ const { location, go } = setup();
+
+ await go(() =>
+ navigate("/question/1", { state: { preserveNavbarState: true } }),
+ );
+
+ expect(location()?.state).toEqual({ preserveNavbarState: true });
+ });
+
+ it("adds a history entry, and does not when replacing", async () => {
+ const { location, go } = setup();
+
+ await go(() => navigate("/a"));
+ await go(() => navigate("/b", { replace: true }));
+ expect(location()?.pathname).toBe("/b");
+
+ // `/b` replaced `/a`, so going back lands on the entry before it.
+ await go(() => navigate(-1));
+ expect(location()?.pathname).toBe("/");
+ });
+
+ it("a negative delta returns to the previous entry", async () => {
+ const { location, go } = setup();
+
+ await go(() => navigate("/first"));
+ await go(() => navigate("/second"));
+ expect(location()?.pathname).toBe("/second");
+
+ await go(() => navigate(-1));
+ expect(location()?.pathname).toBe("/first");
+ });
+
+ it("routes every navigation through the hatch", async () => {
+ const { location, go } = setup();
+
+ const seen: string[] = [];
+ await go(() => navigate("/one"));
+ seen.push(location()?.pathname ?? "");
+ await go(() => navigate("/two"));
+ seen.push(location()?.pathname ?? "");
+
+ expect(seen).toEqual(["/one", "/two"]);
+ });
+});
diff --git a/frontend/src/metabase/router/navigation.ts b/frontend/src/metabase/router/navigation.ts
deleted file mode 100644
index 3c1b22a7809..00000000000
--- a/frontend/src/metabase/router/navigation.ts
+++ /dev/null
@@ -1,72 +0,0 @@
-import type { LocationDescriptor } from "./types";
-
-/**
- * Re-owned equivalent of react-router-redux's navigation action creators.
- *
- * `push`/`replace`/`go`/`goBack`/`goForward` dispatch a CALL_HISTORY_METHOD
- * action that `routerMiddleware` intercepts and applies to the history
- * ref. The action type string is preserved so the transport stays byte-identical
- * with the package we are shadowing.
- */
-export const CALL_HISTORY_METHOD = "@@router/CALL_HISTORY_METHOD";
-
-export type HistoryPushAction = {
- type: typeof CALL_HISTORY_METHOD;
- payload: { method: "push"; args: [LocationDescriptor] };
-};
-
-export type HistoryReplaceAction = {
- type: typeof CALL_HISTORY_METHOD;
- payload: { method: "replace"; args: [LocationDescriptor] };
-};
-
-export type HistoryGoAction = {
- type: typeof CALL_HISTORY_METHOD;
- payload: { method: "go"; args: [number] };
-};
-
-export type HistoryGoBackAction = {
- type: typeof CALL_HISTORY_METHOD;
- payload: { method: "goBack"; args: [] };
-};
-
-export type HistoryGoForwardAction = {
- type: typeof CALL_HISTORY_METHOD;
- payload: { method: "goForward"; args: [] };
-};
-
-export type CallHistoryMethodAction =
- | HistoryPushAction
- | HistoryReplaceAction
- | HistoryGoAction
- | HistoryGoBackAction
- | HistoryGoForwardAction;
-
-export const push = (location: LocationDescriptor): HistoryPushAction => ({
- type: CALL_HISTORY_METHOD,
- payload: { method: "push", args: [location] },
-});
-
-export const replace = (
- location: LocationDescriptor,
-): HistoryReplaceAction => ({
- type: CALL_HISTORY_METHOD,
- payload: { method: "replace", args: [location] },
-});
-
-export const go = (n: number): HistoryGoAction => ({
- type: CALL_HISTORY_METHOD,
- payload: { method: "go", args: [n] },
-});
-
-export const goBack = (): HistoryGoBackAction => ({
- type: CALL_HISTORY_METHOD,
- payload: { method: "goBack", args: [] },
-});
-
-export const goForward = (): HistoryGoForwardAction => ({
- type: CALL_HISTORY_METHOD,
- payload: { method: "goForward", args: [] },
-});
-
-export const routerActions = { push, replace, go, goBack, goForward };
diff --git a/frontend/src/metabase/router/navigator.ts b/frontend/src/metabase/router/navigator.ts
index 934a22e99f7..2ea99efe82f 100644
--- a/frontend/src/metabase/router/navigator.ts
+++ b/frontend/src/metabase/router/navigator.ts
@@ -1,28 +1,48 @@
import type { NavigateFunction, NavigateOptions, To } from "react-router";
-import type { RouterNavigator } from "./middleware";
import type { Location as HistoryLocation, LocationDescriptor } from "./types";
/**
- * The live v7 `navigate`, registered by the host's `AppShell` once the router mounts.
- * The redux navigator adapter is built at store creation, before the router
- * exists, so it reads `navigate` through this holder rather than capturing it.
+ * The live `navigate`, registered by the host's `AppShell` once the router
+ * mounts. Non-component callers reach it through `navigate` below, which reads
+ * this holder rather than capturing it: they run outside React, and much of the
+ * app is constructed before the router exists.
*/
let currentNavigate: NavigateFunction | null = null;
/**
- * Navigations requested before the router registered its `navigate`. On v3 the
- * history existed at store creation, so a `dispatch(replace(...))` from a mount
- * `useLayoutEffect` (e.g. a guard redirect) took effect immediately. v7's
- * `navigate` only registers in an effect, which runs after descendant layout
- * effects, so buffer these and flush them once it does rather than dropping them.
+ * Navigations requested before the router registered its `navigate`. A
+ * navigation from a mount `useLayoutEffect` (e.g. a guard redirect) is requested
+ * before `AppShell`'s effect runs, since layout effects run first, so hold these
+ * and flush them on registration rather than dropping them.
+ *
+ * They are held as a queue, not as a single latest value, so the history stack
+ * ends up the way it would have without the registration gap. Collapsing a push
+ * and a following replace into just the replace would overwrite the entry the
+ * user arrived on rather than the intermediate one.
*/
let pendingNavigations: Array<(navigate: NavigateFunction) => void> = [];
+/**
+ * Whether a router is on its way. `createAppRouter` and `createMemoryAppRouter`
+ * set this, because both put an `AppShell` above the tree and so guarantee a
+ * registration.
+ *
+ * A host that builds no router never registers a `navigate`, so anything held
+ * for it is held for the life of the page. The SDK is such a host and runs for a
+ * long time. Holding nothing until a router is on its way keeps that queue from
+ * retaining every closure, and the `state` each one captures.
+ */
+let isRouterExpected = false;
+
+export function setRouterExpected(expected: boolean): void {
+ isRouterExpected = expected;
+}
+
export function setRouterNavigate(navigate: NavigateFunction | null): void {
currentNavigate = navigate;
if (!navigate) {
- // The router unmounted. Anything still buffered was meant for it, not for
+ // The router unmounted. Anything still held was meant for it, not for
// whatever router mounts next, so drop it rather than replay it later.
pendingNavigations = [];
return;
@@ -60,8 +80,8 @@ export function notifyLocationListeners(location: HistoryLocation): void {
/**
* Turn a `LocationDescriptor` (string or `{ pathname, search, hash, state }`)
- * into v7 `navigate(to, options)` arguments. Shared by the imperative-router
- * shim and the redux navigator so both map descriptors the same way.
+ * into `navigate(to, options)` arguments. Used by the test harness, whose
+ * `history` handle still takes descriptors.
*/
export function toNavigateArgs(
location: LocationDescriptor,
@@ -81,28 +101,31 @@ export function toNavigateArgs(
}
/**
- * A `RouterNavigator` (the subset of `history` that `routerMiddleware` drives)
- * backed by the live v7 `navigate`. Passed to the store on v7 so
- * `dispatch(push(...))` navigates the v7 router. A call before the router mounts
- * is buffered and flushed on registration, so a mount-time redirect is not lost.
+ * `useNavigate`, for code that cannot call a hook: thunks, redux middleware,
+ * reducers, and the permission and visualization config objects. Same signature
+ * and same behaviour, with two differences that follow from having no component
+ * to anchor to.
+ *
+ * A relative target resolves from the root, because `AppShell` sits on a
+ * pathless layout route (see there). A component's `useNavigate` resolves
+ * against its own deepest match instead, so a caller moving between the two must
+ * spell an absolute path.
+ *
+ * A call before the router mounts is held and flushed on registration, so a
+ * mount-time redirect is not lost. Where the host builds no router at all, the
+ * call is a no-op and nothing is retained.
+ *
+ * Prefer `useNavigate` wherever there is a component to hold it.
*/
-export function createRouterNavigator(): RouterNavigator {
- const navigate = (to: To | number, options?: NavigateOptions) => {
- const run = (fn: NavigateFunction) =>
- typeof to === "number" ? fn(to) : fn(to, options);
- if (currentNavigate) {
- run(currentNavigate);
- } else {
- pendingNavigations.push(run);
- }
- };
+export function navigate(to: To, options?: NavigateOptions): void;
+export function navigate(delta: number): void;
+export function navigate(to: To | number, options?: NavigateOptions): void {
+ const run = (fn: NavigateFunction) =>
+ typeof to === "number" ? fn(to) : fn(to, options);
- return {
- push: (location) => navigate(...toNavigateArgs(location)),
- replace: (location) =>
- navigate(...toNavigateArgs(location, { replace: true })),
- go: (n) => navigate(n),
- goBack: () => navigate(-1),
- goForward: () => navigate(1),
- };
+ if (currentNavigate) {
+ run(currentNavigate);
+ } else if (isRouterExpected) {
+ pendingNavigations.push(run);
+ }
}
diff --git a/frontend/src/metabase/router/navigator.unit.spec.ts b/frontend/src/metabase/router/navigator.unit.spec.ts
index c951cbad343..2ece098cd7e 100644
--- a/frontend/src/metabase/router/navigator.unit.spec.ts
+++ b/frontend/src/metabase/router/navigator.unit.spec.ts
@@ -1,5 +1,6 @@
import {
- createRouterNavigator,
+ navigate,
+ setRouterExpected,
setRouterNavigate,
toNavigateArgs,
} from "./navigator";
@@ -35,44 +36,98 @@ describe("toNavigateArgs", () => {
});
});
-// The redux navigator is built at store creation, before the router mounts and
-// registers its `navigate`. A navigation dispatched in that window (a guard
-// redirecting from a mount layout effect) must not be lost, but it also must not
-// leak into a later router once this one is gone.
-describe("createRouterNavigator pre-mount buffering", () => {
+// Non-component callers navigate before the router mounts and registers its
+// `navigate`. A navigation made in that window (a guard redirecting from a mount
+// layout effect) must not be lost, but it also must not leak into a later router
+// once this one is gone.
+describe("navigate pre-mount buffering", () => {
+ beforeEach(() => {
+ // `createAppRouter` does this for the app. These tests drive the navigator
+ // directly, so they say it themselves.
+ setRouterExpected(true);
+ });
+
afterEach(() => {
setRouterNavigate(null);
+ setRouterExpected(false);
+ });
+
+ it("replays the navigations in order, so the history stack is unchanged", () => {
+ // Collapsing these to the last one would apply the replace to the entry the
+ // user arrived on, and lose `/pushed` from the stack.
+ navigate("/pushed");
+ navigate("/replaced", { replace: true });
+
+ const routerNavigate = jest.fn();
+ setRouterNavigate(routerNavigate);
+
+ expect(routerNavigate.mock.calls).toEqual([
+ ["/pushed", undefined],
+ ["/replaced", { replace: true }],
+ ]);
});
it("buffers a navigation made before the router mounts and flushes it on register", () => {
- const navigator = createRouterNavigator();
- navigator.replace("/target");
+ navigate("/target", { replace: true });
- const navigate = jest.fn();
- setRouterNavigate(navigate);
+ const routerNavigate = jest.fn();
+ setRouterNavigate(routerNavigate);
- expect(navigate).toHaveBeenCalledWith("/target", { replace: true });
+ expect(routerNavigate).toHaveBeenCalledWith("/target", { replace: true });
});
it("navigates immediately once the router is registered", () => {
- const navigate = jest.fn();
- setRouterNavigate(navigate);
+ const routerNavigate = jest.fn();
+ setRouterNavigate(routerNavigate);
+
+ navigate("/now");
+
+ expect(routerNavigate).toHaveBeenCalledTimes(1);
+ });
+
+ it("passes a delta straight through", () => {
+ const routerNavigate = jest.fn();
+ setRouterNavigate(routerNavigate);
- createRouterNavigator().push("/now");
+ navigate(-1);
- expect(navigate).toHaveBeenCalledTimes(1);
+ expect(routerNavigate).toHaveBeenCalledWith(-1);
});
it("drops a buffered navigation when the router unmounts before it flushes", () => {
- const navigator = createRouterNavigator();
- navigator.replace("/stale");
+ navigate("/stale", { replace: true });
// Router unmounts without ever registering; the next one must not inherit it.
setRouterNavigate(null);
- const navigate = jest.fn();
- setRouterNavigate(navigate);
+ const routerNavigate = jest.fn();
+ setRouterNavigate(routerNavigate);
+
+ expect(routerNavigate).not.toHaveBeenCalled();
+ });
+});
+
+// A host that builds no router never registers a `navigate`, so anything the
+// navigator holds for it is held for the life of the page. The SDK is such a
+// host and runs for a long time, so it must hold nothing at all.
+describe("navigate with no router on the way", () => {
+ beforeEach(() => {
+ setRouterExpected(false);
+ });
+
+ afterEach(() => {
+ setRouterNavigate(null);
+ });
+
+ it("retains nothing, however many navigations it is given", () => {
+ for (let i = 0; i < 100; i++) {
+ navigate(`/question/${i}`, { state: { card: "a card" } });
+ }
+
+ // Registering is the only way to observe what was held. Nothing should be.
+ const routerNavigate = jest.fn();
+ setRouterNavigate(routerNavigate);
- expect(navigate).not.toHaveBeenCalled();
+ expect(routerNavigate).not.toHaveBeenCalled();
});
});
diff --git a/frontend/src/metabase/router/route-leave-scope.unit.spec.tsx b/frontend/src/metabase/router/route-leave-scope.unit.spec.tsx
index ec895e25a42..d0a5627eb9a 100644
--- a/frontend/src/metabase/router/route-leave-scope.unit.spec.tsx
+++ b/frontend/src/metabase/router/route-leave-scope.unit.spec.tsx
@@ -2,7 +2,7 @@ import { renderWithProviders, screen } from "__support__/ui";
import {
Outlet,
Route,
- push,
+ navigate,
useLocation,
useRouteLeaveBlocker,
} from "metabase/router";
@@ -40,26 +40,26 @@ const tree = (
// under the guarded layout is allowed, and only leaving the layout is blocked.
describe("route-scoped leave hook", () => {
it("allows navigation that stays within the guarded route", async () => {
- const { store } = renderWithProviders(tree, {
+ renderWithProviders(tree, {
withRouter: true,
initialRoute: "/section/a",
});
expect(await screen.findByTestId("a")).toBeInTheDocument();
- store.dispatch(push("/section/b"));
+ navigate("/section/b");
expect(await screen.findByTestId("b")).toBeInTheDocument();
expect(screen.getByTestId("location")).toHaveTextContent("/section/b");
});
it("blocks navigation that leaves the guarded route", async () => {
- const { store } = renderWithProviders(tree, {
+ renderWithProviders(tree, {
withRouter: true,
initialRoute: "/section/a",
});
expect(await screen.findByTestId("a")).toBeInTheDocument();
- store.dispatch(push("/other"));
+ navigate("/other");
await new Promise((resolve) => setTimeout(resolve, 30));
expect(screen.queryByTestId("other")).not.toBeInTheDocument();
diff --git a/frontend/src/metabase/router/router-engine.unit.spec.tsx b/frontend/src/metabase/router/router-engine.unit.spec.tsx
index 67a4e19becb..1c05505606a 100644
--- a/frontend/src/metabase/router/router-engine.unit.spec.tsx
+++ b/frontend/src/metabase/router/router-engine.unit.spec.tsx
@@ -4,7 +4,7 @@ import { renderWithProviders, screen } from "__support__/ui";
import {
Outlet,
Route,
- push,
+ navigate,
useLocation,
useNavigate,
useParams,
@@ -73,13 +73,13 @@ describe("v7 engine (facade over real react-router v7)", () => {
expect(screen.getByTestId("splat")).toHaveTextContent("undefined");
});
- // Redux navigation carries no route context, and history@3 resolved a pathname
- // without a leading slash against the root. Resolving it against the deepest
+ // The module-level `navigate` carries no route context, so a pathname without
+ // a leading slash resolves against the root. Resolving it against the deepest
// match instead would send `{ pathname: "other" }` to `/things/other`.
- it("resolves a relative redux push from the root", async () => {
- const { store } = setup("/things/42");
+ it("resolves a relative navigate() from the root", async () => {
+ setup("/things/42");
- store.dispatch(push({ pathname: "other" }));
+ navigate({ pathname: "other" });
expect(await screen.findByTestId("other")).toBeInTheDocument();
});
diff --git a/frontend/src/metabase/router/router-listen.unit.spec.tsx b/frontend/src/metabase/router/router-listen.unit.spec.tsx
index ebc413c951e..c09c3ab6a87 100644
--- a/frontend/src/metabase/router/router-listen.unit.spec.tsx
+++ b/frontend/src/metabase/router/router-listen.unit.spec.tsx
@@ -1,7 +1,7 @@
import { useEffect, useState } from "react";
import { renderWithProviders, screen } from "__support__/ui";
-import { Outlet, Route, push, subscribeLocation } from "metabase/router";
+import { Outlet, Route, navigate, subscribeLocation } from "metabase/router";
// `subscribeLocation` fires a callback on every location change and returns an
// unsubscribe function, standing in for v3's `router.listen`.
@@ -30,14 +30,14 @@ const tree = (
describe("subscribeLocation", () => {
it("fires the callback on navigation and stops after unsubscribe", async () => {
- const { store } = renderWithProviders(tree, {
+ renderWithProviders(tree, {
withRouter: true,
initialRoute: "/",
});
await screen.findByTestId("seen");
- store.dispatch(push("/other"));
+ navigate("/other");
await screen.findByText("other");
expect(screen.getByTestId("seen")).toHaveTextContent("/other");
diff --git a/frontend/src/metabase/router/use-navigate.ts b/frontend/src/metabase/router/use-navigate.ts
new file mode 100644
index 00000000000..bc163589827
--- /dev/null
+++ b/frontend/src/metabase/router/use-navigate.ts
@@ -0,0 +1,29 @@
+import { useContext } from "react";
+import {
+ UNSAFE_NavigationContext,
+ useNavigate as useRouterNavigate,
+} from "react-router";
+
+import { navigate } from "./navigator";
+import type { NavigateFunction } from "./types";
+
+/**
+ * Like react-router's `useNavigate`, but falls back to the module-level
+ * `navigate` when rendered outside a router instead of throwing.
+ *
+ * Much of the app is shared with the SDK, which mounts no router (see
+ * `useMaybeLocation`, which exists for the same reason). Navigation used to run
+ * through redux, which had no opinion on whether a router was mounted, so
+ * components rendered in both places never had to care. Keeping that means a
+ * router-less render is a no-op rather than a crash.
+ */
+export function useNavigate(): NavigateFunction {
+ const hasRouter = useContext(UNSAFE_NavigationContext) != null;
+
+ // react-router's hook throws when there is no router, so it can only be called
+ // on the branch that has one. Safe despite the rule: a router appearing above
+ // a mounted component would change the tree shape and remount it, so
+ // `hasRouter` cannot flip between renders of the same mount.
+ // eslint-disable-next-line react-hooks/rules-of-hooks
+ return hasRouter ? useRouterNavigate() : navigate;
+}
diff --git a/frontend/src/metabase/search/containers/SearchApp.tsx b/frontend/src/metabase/search/containers/SearchApp.tsx
index b71234994ec..615138b68ee 100644
--- a/frontend/src/metabase/search/containers/SearchApp.tsx
+++ b/frontend/src/metabase/search/containers/SearchApp.tsx
@@ -18,9 +18,8 @@ import {
} from "metabase/common/search/constants";
import type { URLSearchFilterQueryParams } from "metabase/common/search/types";
import { usePageTitle } from "metabase/hooks/use-page-title";
-import { useDispatch } from "metabase/redux";
import type { Location, LocationDescriptorObject } from "metabase/router";
-import { push, queryToSearch, useLocation } from "metabase/router";
+import { queryToSearch, useLocation, useNavigate } from "metabase/router";
import { SearchSidebar } from "metabase/search/components/SearchSidebar";
import {
SearchBody,
@@ -41,7 +40,7 @@ const getPageFromLocation = (location: Location) => {
export function SearchApp() {
const location = useLocation();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
usePageTitle(t`Search`);
@@ -72,14 +71,14 @@ export function SearchApp() {
} as SearchRequest;
const onChangeLocation = useCallback(
- (nextLocation: LocationDescriptorObject) => dispatch(push(nextLocation)),
- [dispatch],
+ (nextLocation: LocationDescriptorObject) => navigate(nextLocation),
+ [navigate],
);
const onFilterChange = useCallback(
(newFilters: URLSearchFilterQueryParams) => {
onChangeLocation({
- pathname: "search",
+ pathname: "/search",
search: queryToSearch({ q: searchText.trim(), ...newFilters }),
});
},
@@ -88,7 +87,7 @@ export function SearchApp() {
const advancePage = (howMany = 1) => {
onChangeLocation({
- pathname: "search",
+ pathname: "/search",
search: queryToSearch({
q: searchText.trim(),
...searchFilters,
diff --git a/frontend/src/metabase/store.ts b/frontend/src/metabase/store.ts
index cf36ab509ea..044f81bf9d6 100644
--- a/frontend/src/metabase/store.ts
+++ b/frontend/src/metabase/store.ts
@@ -8,14 +8,12 @@ import {
import { Api } from "metabase/api";
import { PLUGIN_REDUX_MIDDLEWARES } from "metabase/plugins";
import type { State } from "metabase/redux/store";
-import { type RouterNavigator, routerMiddleware } from "metabase/router";
// Each app passes its own reducer map, so per-slice types can't be known here.
type AnySliceReducer = Reducer<any, any>;
export function getStore(
reducers: Record<string, AnySliceReducer>,
- navigator?: RouterNavigator | null,
initialState?: Partial<State> | Record<string, unknown>,
extraMiddlewares: Middleware[] = [],
) {
@@ -28,7 +26,6 @@ export function getStore(
const middlewares: Middleware[] = [
Api.middleware,
- ...(navigator ? [routerMiddleware(navigator)] : []),
...PLUGIN_REDUX_MIDDLEWARES,
...extraMiddlewares,
];
diff --git a/frontend/src/metabase/timelines/collections/containers/DeleteEventModal/DeleteEventModal.tsx b/frontend/src/metabase/timelines/collections/containers/DeleteEventModal/DeleteEventModal.tsx
index 3c879cc5a79..b987786d9a0 100644
--- a/frontend/src/metabase/timelines/collections/containers/DeleteEventModal/DeleteEventModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/DeleteEventModal/DeleteEventModal.tsx
@@ -6,14 +6,13 @@ import {
} from "metabase/api";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import type { ModalComponentProps } from "metabase/common/components/ModalRoute";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import DeleteEventModal from "metabase/timelines/common/components/DeleteEventModal";
import * as Urls from "metabase/urls";
import type { Timeline, TimelineEvent } from "metabase-types/api";
function DeleteEventModalContainer({ params, onClose }: ModalComponentProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const timelineId = Urls.extractEntityId(params.timelineId);
const eventId = Urls.extractEntityId(params.timelineEventId);
const {
@@ -32,7 +31,7 @@ function DeleteEventModalContainer({ params, onClose }: ModalComponentProps) {
const onSubmit = async (event: TimelineEvent, timeline: Timeline) => {
await deleteTimelineEvent(event.id).unwrap();
- dispatch(push(Urls.timelineArchiveInCollection(timeline)));
+ navigate(Urls.timelineArchiveInCollection(timeline));
};
const isLoading = isTimelineLoading || isEventLoading;
diff --git a/frontend/src/metabase/timelines/collections/containers/DeleteTimelineModal/DeleteTimelineModal.tsx b/frontend/src/metabase/timelines/collections/containers/DeleteTimelineModal/DeleteTimelineModal.tsx
index c6994bb85f1..3ce8f1cfda1 100644
--- a/frontend/src/metabase/timelines/collections/containers/DeleteTimelineModal/DeleteTimelineModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/DeleteTimelineModal/DeleteTimelineModal.tsx
@@ -5,8 +5,7 @@ import {
} from "metabase/api";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import type { ModalComponentProps } from "metabase/common/components/ModalRoute";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import DeleteTimelineModal from "metabase/timelines/common/components/DeleteTimelineModal";
import * as Urls from "metabase/urls";
import type { Timeline } from "metabase-types/api";
@@ -15,7 +14,7 @@ function DeleteTimelineModalContainer({
params,
...props
}: ModalComponentProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [deleteTimeline] = useDeleteTimelineMutation();
const id = Urls.extractEntityId(params.timelineId);
const {
@@ -32,7 +31,7 @@ function DeleteTimelineModalContainer({
const handleSubmit = async (timeline: Timeline) => {
await deleteTimeline(timeline.id).unwrap();
- dispatch(push(Urls.timelinesArchiveInCollection(timeline.collection)));
+ navigate(Urls.timelinesArchiveInCollection(timeline.collection));
};
return (
diff --git a/frontend/src/metabase/timelines/collections/containers/EditEventModal/EditEventModal.tsx b/frontend/src/metabase/timelines/collections/containers/EditEventModal/EditEventModal.tsx
index ad4853caf08..4c265114226 100644
--- a/frontend/src/metabase/timelines/collections/containers/EditEventModal/EditEventModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/EditEventModal/EditEventModal.tsx
@@ -6,8 +6,7 @@ import {
} from "metabase/api";
import { useSetArchive } from "metabase/archive/hooks";
import type { ModalComponentProps } from "metabase/common/components/ModalRoute";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import EditEventModal from "metabase/timelines/common/components/EditEventModal";
import * as Urls from "metabase/urls";
import type { Timeline, TimelineEvent } from "metabase-types/api";
@@ -15,7 +14,7 @@ import type { Timeline, TimelineEvent } from "metabase-types/api";
import LoadingAndErrorWrapper from "../../components/LoadingAndErrorWrapper";
function EditEventModalContainer({ params, onClose }: ModalComponentProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const archive = useSetArchive();
const timelineId = Urls.extractEntityId(params.timelineId);
const eventId = Urls.extractEntityId(params.timelineEventId);
@@ -36,14 +35,14 @@ function EditEventModalContainer({ params, onClose }: ModalComponentProps) {
const onSubmit = async (event: TimelineEvent, timeline?: Timeline) => {
await updateTimelineEvent(event).unwrap();
if (timeline) {
- dispatch(push(Urls.timelineInCollection(timeline)));
+ navigate(Urls.timelineInCollection(timeline));
}
};
const onArchive = async (event: TimelineEvent, timeline?: Timeline) => {
await archive({ id: event.id, model: "timeline-event" }, true);
if (timeline) {
- dispatch(push(Urls.timelineInCollection(timeline)));
+ navigate(Urls.timelineInCollection(timeline));
}
};
diff --git a/frontend/src/metabase/timelines/collections/containers/EditTimelineModal/EditTimelineModal.tsx b/frontend/src/metabase/timelines/collections/containers/EditTimelineModal/EditTimelineModal.tsx
index 14fe796e9bf..769527dc4aa 100644
--- a/frontend/src/metabase/timelines/collections/containers/EditTimelineModal/EditTimelineModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/EditTimelineModal/EditTimelineModal.tsx
@@ -5,8 +5,7 @@ import {
} from "metabase/api";
import { useSetArchive } from "metabase/archive/hooks";
import type { ModalComponentProps } from "metabase/common/components/ModalRoute";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import EditTimelineModal from "metabase/timelines/common/components/EditTimelineModal";
import * as Urls from "metabase/urls";
import type { Timeline } from "metabase-types/api";
@@ -14,7 +13,7 @@ import type { Timeline } from "metabase-types/api";
import LoadingAndErrorWrapper from "../../components/LoadingAndErrorWrapper";
function EditTimelineModalContainer({ params, ...props }: ModalComponentProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const archive = useSetArchive();
const [updateTimeline] = useUpdateTimelineMutation();
const id = Urls.extractEntityId(params.timelineId);
@@ -32,12 +31,12 @@ function EditTimelineModalContainer({ params, ...props }: ModalComponentProps) {
const handleSubmit = async (timeline: Timeline) => {
await updateTimeline(timeline).unwrap();
- dispatch(push(Urls.timelineInCollection(timeline)));
+ navigate(Urls.timelineInCollection(timeline));
};
const handleArchive = async (timeline: Timeline) => {
await archive({ id: timeline.id, model: "timeline" }, true);
- dispatch(push(Urls.timelinesInCollection(timeline.collection)));
+ navigate(Urls.timelinesInCollection(timeline.collection));
};
return (
diff --git a/frontend/src/metabase/timelines/collections/containers/MoveEventModal/MoveEventModal.tsx b/frontend/src/metabase/timelines/collections/containers/MoveEventModal/MoveEventModal.tsx
index 28e38d269fa..3e0a50ce8b8 100644
--- a/frontend/src/metabase/timelines/collections/containers/MoveEventModal/MoveEventModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/MoveEventModal/MoveEventModal.tsx
@@ -4,8 +4,7 @@ import {
useGetTimelineEventQuery,
useListTimelinesQuery,
} from "metabase/api";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import MoveEventModal, {
type MoveEventModalProps,
} from "metabase/timelines/common/components/MoveEventModal";
@@ -29,7 +28,7 @@ type ContainerProps = Omit<
function MoveEventModalContainer({ params, ...props }: ContainerProps) {
const setTimeline = useSetTimeline();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const eventId = Urls.extractEntityId(params.timelineEventId);
const collectionId = Urls.extractCollectionId(params.slug);
const {
@@ -59,7 +58,7 @@ function MoveEventModalContainer({ params, ...props }: ContainerProps) {
await setTimeline(event, newTimeline);
}
if (oldTimeline) {
- dispatch(push(Urls.timelineInCollection(oldTimeline)));
+ navigate(Urls.timelineInCollection(oldTimeline));
}
};
diff --git a/frontend/src/metabase/timelines/collections/containers/MoveTimelineModal/MoveTimelineModal.tsx b/frontend/src/metabase/timelines/collections/containers/MoveTimelineModal/MoveTimelineModal.tsx
index 489a4d6cfbc..7ffd2b4fde8 100644
--- a/frontend/src/metabase/timelines/collections/containers/MoveTimelineModal/MoveTimelineModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/MoveTimelineModal/MoveTimelineModal.tsx
@@ -10,7 +10,7 @@ import type { ModalComponentProps } from "metabase/common/components/ModalRoute"
import { useSetCollection } from "metabase/common/hooks";
import { getDefaultTimelineName } from "metabase/common/utils/timelines";
import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import MoveTimelineModal from "metabase/timelines/common/components/MoveTimelineModal";
import * as Urls from "metabase/urls";
import type { CollectionId, Timeline } from "metabase-types/api";
@@ -19,6 +19,7 @@ import LoadingAndErrorWrapper from "../../components/LoadingAndErrorWrapper";
function MoveTimelineModalContainer({ params, ...props }: ModalComponentProps) {
const dispatch = useDispatch();
+ const navigate = useNavigate();
const setCollection = useSetCollection();
const id = Urls.extractEntityId(params.timelineId);
const {
@@ -49,19 +50,17 @@ function MoveTimelineModalContainer({ params, ...props }: ModalComponentProps) {
const { data: collection } = await dispatch(
collectionApi.endpoints.getCollection.initiate({ id: collectionId }),
);
- dispatch(
- push(
- Urls.timelineInCollection({
- ...timeline,
- collection_id:
- typeof collectionId === "number" ? collectionId : null,
- collection,
- }),
- ),
+ navigate(
+ Urls.timelineInCollection({
+ ...timeline,
+ collection_id:
+ typeof collectionId === "number" ? collectionId : null,
+ collection,
+ }),
);
})();
},
- [dispatch, setCollection, sourceCollection],
+ [dispatch, setCollection, sourceCollection, navigate],
);
if (isLoading || error || !timeline) {
diff --git a/frontend/src/metabase/timelines/collections/containers/NewEventModal/NewEventModal.tsx b/frontend/src/metabase/timelines/collections/containers/NewEventModal/NewEventModal.tsx
index 41379c5b18d..d251b1403dc 100644
--- a/frontend/src/metabase/timelines/collections/containers/NewEventModal/NewEventModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/NewEventModal/NewEventModal.tsx
@@ -4,8 +4,7 @@ import {
useGetTimelineQuery,
} from "metabase/api";
import type { ModalComponentProps } from "metabase/common/components/ModalRoute";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import NewEventModal from "metabase/timelines/common/components/NewEventModal";
import * as Urls from "metabase/urls";
import type {
@@ -17,7 +16,7 @@ import type {
import LoadingAndErrorWrapper from "../../components/LoadingAndErrorWrapper";
function NewEventModalContainer({ params, onClose }: ModalComponentProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [createTimelineEvent] = useCreateTimelineEventMutation();
const id = Urls.extractEntityId(params.timelineId);
const {
@@ -40,7 +39,7 @@ function NewEventModalContainer({ params, onClose }: ModalComponentProps) {
// Unjustified type cast. FIXME
await createTimelineEvent(values as CreateTimelineEventRequest).unwrap();
if (timeline) {
- dispatch(push(Urls.timelineInCollection(timeline)));
+ navigate(Urls.timelineInCollection(timeline));
}
};
diff --git a/frontend/src/metabase/timelines/collections/containers/NewEventWithTimelineModal/NewEventWithTimelineModal.tsx b/frontend/src/metabase/timelines/collections/containers/NewEventWithTimelineModal/NewEventWithTimelineModal.tsx
index 77eb3c9d28d..af587b41af6 100644
--- a/frontend/src/metabase/timelines/collections/containers/NewEventWithTimelineModal/NewEventWithTimelineModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/NewEventWithTimelineModal/NewEventWithTimelineModal.tsx
@@ -5,8 +5,7 @@ import {
useGetCollectionQuery,
} from "metabase/api";
import { getDefaultTimeline } from "metabase/common/utils/timelines";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import NewEventModal from "metabase/timelines/common/components/NewEventModal";
import * as Urls from "metabase/urls";
import type {
@@ -27,7 +26,7 @@ interface NewEventWithTimelineModalContainerProps {
function NewEventWithTimelineModalContainer(
props: NewEventWithTimelineModalContainerProps,
) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [createTimeline] = useCreateTimelineMutation();
const [createTimelineEvent] = useCreateTimelineEventMutation();
const collectionId = Urls.extractCollectionId(props.params.slug);
@@ -55,7 +54,7 @@ function NewEventWithTimelineModalContainer(
...values,
timeline_id: timeline.id,
} as CreateTimelineEventRequest).unwrap();
- dispatch(push(Urls.timelinesInCollection(collection)));
+ navigate(Urls.timelinesInCollection(collection));
};
if (isLoading || error || !collection) {
diff --git a/frontend/src/metabase/timelines/collections/containers/NewTimelineModal/NewTimelineModal.tsx b/frontend/src/metabase/timelines/collections/containers/NewTimelineModal/NewTimelineModal.tsx
index 69c28560779..d7ac1e4f21a 100644
--- a/frontend/src/metabase/timelines/collections/containers/NewTimelineModal/NewTimelineModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/NewTimelineModal/NewTimelineModal.tsx
@@ -3,8 +3,7 @@ import {
useCreateTimelineMutation,
useGetCollectionQuery,
} from "metabase/api";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import NewTimelineModal from "metabase/timelines/common/components/NewTimelineModal";
import * as Urls from "metabase/urls";
import type { CreateTimelineRequest, Timeline } from "metabase-types/api";
@@ -18,7 +17,7 @@ interface NewTimelineModalContainerProps {
}
function NewTimelineModalContainer(props: NewTimelineModalContainerProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [createTimeline] = useCreateTimelineMutation();
const collectionId = Urls.extractCollectionId(props.params.slug);
const {
@@ -34,7 +33,7 @@ function NewTimelineModalContainer(props: NewTimelineModalContainerProps) {
// Unjustified type cast. FIXME
values as CreateTimelineRequest,
).unwrap();
- dispatch(push(Urls.timelineInCollection(timeline)));
+ navigate(Urls.timelineInCollection(timeline));
};
if (isLoading || error || !collection) {
diff --git a/frontend/src/metabase/timelines/collections/containers/TimelineArchiveModal/TimelineArchiveModal.tsx b/frontend/src/metabase/timelines/collections/containers/TimelineArchiveModal/TimelineArchiveModal.tsx
index 1745ceeb388..db73079942e 100644
--- a/frontend/src/metabase/timelines/collections/containers/TimelineArchiveModal/TimelineArchiveModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/TimelineArchiveModal/TimelineArchiveModal.tsx
@@ -1,8 +1,7 @@
import { skipToken, useGetTimelineQuery } from "metabase/api";
import { useSetArchive } from "metabase/archive/hooks";
import type { ModalComponentProps } from "metabase/common/components/ModalRoute";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import * as Urls from "metabase/urls";
import type { Timeline, TimelineEvent } from "metabase-types/api";
@@ -13,7 +12,7 @@ function TimelineArchiveModalContainer({
params,
...props
}: ModalComponentProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const archive = useSetArchive();
const id = Urls.extractEntityId(params.timelineId);
const {
@@ -34,7 +33,7 @@ function TimelineArchiveModalContainer({
archive({ id: event.id, model: "timeline-event" }, false);
const handleGoBack = (timeline: Timeline) => {
- dispatch(push(Urls.timelineInCollection(timeline)));
+ navigate(Urls.timelineInCollection(timeline));
};
return (
diff --git a/frontend/src/metabase/timelines/collections/containers/TimelineDetailsModal/TimelineDetailsModal.tsx b/frontend/src/metabase/timelines/collections/containers/TimelineDetailsModal/TimelineDetailsModal.tsx
index 72336ffa2c6..de5172d20d0 100644
--- a/frontend/src/metabase/timelines/collections/containers/TimelineDetailsModal/TimelineDetailsModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/TimelineDetailsModal/TimelineDetailsModal.tsx
@@ -4,8 +4,7 @@ import {
useListCollectionTimelinesQuery,
} from "metabase/api";
import { useSetArchive } from "metabase/archive/hooks";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import * as Urls from "metabase/urls";
import type { Timeline, TimelineEvent } from "metabase-types/api";
@@ -22,7 +21,7 @@ function TimelineDetailsModalContainer({
params,
...props
}: TimelineDetailsModalContainerProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const archive = useSetArchive();
const id = Urls.extractEntityId(params.timelineId);
const collectionId = Urls.extractCollectionId(params.slug);
@@ -52,7 +51,7 @@ function TimelineDetailsModalContainer({
archive({ id: event.id, model: "timeline-event" }, true);
const handleGoBack = (timeline: Timeline) => {
- dispatch(push(Urls.timelinesInCollection(timeline.collection)));
+ navigate(Urls.timelinesInCollection(timeline.collection));
};
return (
diff --git a/frontend/src/metabase/timelines/collections/containers/TimelineListArchiveModal/TimelineListArchiveModal.tsx b/frontend/src/metabase/timelines/collections/containers/TimelineListArchiveModal/TimelineListArchiveModal.tsx
index a2476b57ab1..6d60808072e 100644
--- a/frontend/src/metabase/timelines/collections/containers/TimelineListArchiveModal/TimelineListArchiveModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/TimelineListArchiveModal/TimelineListArchiveModal.tsx
@@ -4,8 +4,7 @@ import {
useListCollectionTimelinesQuery,
} from "metabase/api";
import { useSetArchive } from "metabase/archive/hooks";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import * as Urls from "metabase/urls";
import type { Collection, Timeline } from "metabase-types/api";
@@ -22,7 +21,7 @@ function TimelineListArchiveModalContainer({
params,
...props
}: TimelineListArchiveModalContainerProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const archive = useSetArchive();
const collectionId = Urls.extractCollectionId(params.slug);
const {
@@ -55,7 +54,7 @@ function TimelineListArchiveModalContainer({
archive({ id: timeline.id, model: "timeline" }, false);
const onGoBack = (collection: Collection) => {
- dispatch(push(Urls.timelinesInCollection(collection)));
+ navigate(Urls.timelinesInCollection(collection));
};
return (
diff --git a/frontend/src/metabase/transforms/components/DetailedViewSwitch/DetailedViewSwitch.tsx b/frontend/src/metabase/transforms/components/DetailedViewSwitch/DetailedViewSwitch.tsx
index 1e5bfee3672..180ff50f7ee 100644
--- a/frontend/src/metabase/transforms/components/DetailedViewSwitch/DetailedViewSwitch.tsx
+++ b/frontend/src/metabase/transforms/components/DetailedViewSwitch/DetailedViewSwitch.tsx
@@ -1,7 +1,6 @@
import { t } from "ttag";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { trackTransformRunsViewToggled } from "metabase/transforms/analytics";
import { Switch } from "metabase/ui";
import * as Urls from "metabase/urls";
@@ -17,17 +16,15 @@ export function DetailedViewSwitch({
detailed,
params,
}: DetailedViewSwitchProps) {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const handleChange = () => {
const nextView = detailed ? "grouped" : "detailed";
trackTransformRunsViewToggled({ view: nextView });
- dispatch(
- push(
- detailed
- ? Urls.transformGraphRunList(params)
- : Urls.transformRunList(params),
- ),
+ navigate(
+ detailed
+ ? Urls.transformGraphRunList(params)
+ : Urls.transformRunList(params),
);
};
diff --git a/frontend/src/metabase/transforms/components/JobEditor/TransformsSection/TransformsSection.tsx b/frontend/src/metabase/transforms/components/JobEditor/TransformsSection/TransformsSection.tsx
index 241868f4e5d..ab407b5a5b4 100644
--- a/frontend/src/metabase/transforms/components/JobEditor/TransformsSection/TransformsSection.tsx
+++ b/frontend/src/metabase/transforms/components/JobEditor/TransformsSection/TransformsSection.tsx
@@ -7,8 +7,7 @@ import { ListEmptyState } from "metabase/common/components/ListEmptyState";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { TitleSection } from "metabase/common/data-studio/components/TitleSection";
import CS from "metabase/css/core/index.css";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { Card, TreeTable, useTreeTableInstance } from "metabase/ui";
import * as Urls from "metabase/urls";
import type {
@@ -71,13 +70,13 @@ export function TransformTable({
() => getColumns(transformRunByTransformId),
[transformRunByTransformId],
);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const handleRowActivate = useCallback(
(row: Row<Transform>) => {
- dispatch(push(Urls.transform(row.original.id)));
+ navigate(Urls.transform(row.original.id));
},
- [dispatch],
+ [navigate],
);
const treeTableInstance = useTreeTableInstance<Transform>({
diff --git a/frontend/src/metabase/transforms/components/JobMoreMenu/JobMoreMenu.tsx b/frontend/src/metabase/transforms/components/JobMoreMenu/JobMoreMenu.tsx
index e902cdbc9f6..8e193a1fd29 100644
--- a/frontend/src/metabase/transforms/components/JobMoreMenu/JobMoreMenu.tsx
+++ b/frontend/src/metabase/transforms/components/JobMoreMenu/JobMoreMenu.tsx
@@ -3,8 +3,7 @@ import { t } from "ttag";
import { useUpdateTransformJobMutation } from "metabase/api";
import { useMetadataToasts } from "metabase/metadata/hooks";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { ActionIcon, Icon, Menu } from "metabase/ui";
import * as Urls from "metabase/urls";
import type { TransformJob } from "metabase-types/api";
@@ -96,11 +95,11 @@ type JobModalProps = {
function JobModal({ job, modalType, onClose }: JobModalProps) {
const { sendSuccessToast } = useMetadataToasts();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const handleDelete = () => {
sendSuccessToast(t`Job deleted`);
- dispatch(push(Urls.transformJobList()));
+ navigate(Urls.transformJobList());
onClose();
};
diff --git a/frontend/src/metabase/transforms/components/TransformHeader/TransformMoreMenu/TransformMoreMenu.tsx b/frontend/src/metabase/transforms/components/TransformHeader/TransformMoreMenu/TransformMoreMenu.tsx
index 9419e08db45..13e11412967 100644
--- a/frontend/src/metabase/transforms/components/TransformHeader/TransformMoreMenu/TransformMoreMenu.tsx
+++ b/frontend/src/metabase/transforms/components/TransformHeader/TransformMoreMenu/TransformMoreMenu.tsx
@@ -2,8 +2,7 @@ import { type MouseEvent, useState } from "react";
import { t } from "ttag";
import { useMetadataToasts } from "metabase/metadata/hooks";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import { ActionIcon, Icon, Menu } from "metabase/ui";
import * as Urls from "metabase/urls";
import type { Transform } from "metabase-types/api";
@@ -114,11 +113,11 @@ function TransformModal({
onClose,
}: TransformModalProps) {
const { sendSuccessToast } = useMetadataToasts();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const handleDelete = () => {
sendSuccessToast(t`Transform deleted`);
- dispatch(push(Urls.transformList()));
+ navigate(Urls.transformList());
onClose();
};
diff --git a/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.tsx b/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.tsx
index b14aa81229a..144a0c110b8 100644
--- a/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.tsx
+++ b/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.tsx
@@ -9,8 +9,8 @@ import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErr
import { DataStudioBreadcrumbs } from "metabase/common/data-studio/components/DataStudioBreadcrumbs";
import { PageContainer } from "metabase/common/data-studio/components/PageContainer";
import { PaneHeader } from "metabase/common/data-studio/components/PaneHeader";
-import { useDispatch, useSelector } from "metabase/redux";
-import { push } from "metabase/router";
+import { useSelector } from "metabase/redux";
+import { useNavigate } from "metabase/router";
import { getUserIsAdmin } from "metabase/selectors/user";
import { useSetting } from "metabase/settings";
import { LockedTransformsBanner } from "metabase/transforms/components/LockedTransformsBanner/LockedTransformsBanner";
@@ -35,7 +35,7 @@ import { JobListMoreMenu } from "../../components/JobListMoreMenu";
import { JobMoreMenu } from "../../components/JobMoreMenu";
export const JobListPage = () => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [searchQuery, setSearchQuery] = useState("");
const isAdmin = useSelector(getUserIsAdmin);
@@ -44,9 +44,9 @@ export const JobListPage = () => {
const handleRowActivate = useCallback(
(row: { original: TransformJob }) => {
- dispatch(push(Urls.transformJob(row.original.id)));
+ navigate(Urls.transformJob(row.original.id));
},
- [dispatch],
+ [navigate],
);
const isMeterLocked = useSetting("transforms-meter-locked");
diff --git a/frontend/src/metabase/transforms/pages/JobRunListPage/JobRunListPage.tsx b/frontend/src/metabase/transforms/pages/JobRunListPage/JobRunListPage.tsx
index 9456433557a..5ff521606ac 100644
--- a/frontend/src/metabase/transforms/pages/JobRunListPage/JobRunListPage.tsx
+++ b/frontend/src/metabase/transforms/pages/JobRunListPage/JobRunListPage.tsx
@@ -11,8 +11,7 @@ import {
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { PaginationControls } from "metabase/common/components/PaginationControls";
import { usePageTitle } from "metabase/hooks/use-page-title";
-import { useDispatch } from "metabase/redux";
-import { replace, useLocation, useParams } from "metabase/router";
+import { useLocation, useNavigate, useParams } from "metabase/router";
import { POLLING_INTERVAL } from "metabase/transforms/constants";
import { useJobHeaderState } from "metabase/transforms/hooks/use-job-header-state";
import { formatRunMethod, formatStatus } from "metabase/transforms/utils";
@@ -54,7 +53,7 @@ export function JobRunListPage() {
TransformJobRunId | undefined
>();
const [isPolling, setIsPolling] = useState(false);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const { data: job } = useGetTransformJobQuery(jobId ?? skipToken);
const { readOnly, onNameChange } = useJobHeaderState(jobId);
@@ -100,10 +99,10 @@ export function JobRunListPage() {
const handleParamsChange = useCallback(
(newParams: Urls.TransformJobRunListParams) => {
if (jobId != null) {
- dispatch(replace(Urls.transformJobRuns(jobId, newParams)));
+ navigate(Urls.transformJobRuns(jobId, newParams), { replace: true });
}
},
- [dispatch, jobId],
+ [jobId, navigate],
);
const handleStatusChange = useCallback(
diff --git a/frontend/src/metabase/transforms/pages/NewJobPage/NewJobPage.tsx b/frontend/src/metabase/transforms/pages/NewJobPage/NewJobPage.tsx
index 22d8d63f77f..c799676a50b 100644
--- a/frontend/src/metabase/transforms/pages/NewJobPage/NewJobPage.tsx
+++ b/frontend/src/metabase/transforms/pages/NewJobPage/NewJobPage.tsx
@@ -9,8 +9,7 @@ import {
import { LeaveRouteConfirmModal } from "metabase/common/components/LeaveConfirmModal";
import { PaneHeaderActions } from "metabase/common/data-studio/components/PaneHeader";
import { useMetadataToasts } from "metabase/metadata/hooks";
-import { useDispatch } from "metabase/redux";
-import { push } from "metabase/router";
+import { useNavigate } from "metabase/router";
import * as Urls from "metabase/urls";
import type { ScheduleDisplayType, TransformTagId } from "metabase-types/api";
@@ -25,7 +24,7 @@ export function NewJobPage() {
useCreateTransformJobMutation();
const [fetchJob, { isFetching }] = useLazyGetTransformJobQuery();
const { sendSuccessToast, sendErrorToast } = useMetadataToasts();
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const isSaving = isCreating || isFetching;
const handleNameChange = (name: string) => {
@@ -54,12 +53,12 @@ export function NewJobPage() {
// prefetch the job to avoid the loader on the job details page
await fetchJob(newJob.id);
sendSuccessToast(t`New job created`);
- dispatch(push(Urls.transformJob(newJob.id)));
+ navigate(Urls.transformJob(newJob.id));
}
};
const handleCancel = () => {
- dispatch(push(Urls.transformJobList()));
+ navigate(Urls.transformJobList());
};
return (
diff --git a/frontend/src/metabase/transforms/pages/NewTransformPage/NewTransformPage.tsx b/frontend/src/metabase/transforms/pages/NewTransformPage/NewTransformPage.tsx
index c638a5a64d1..eafee4be407 100644
--- a/frontend/src/metabase/transforms/pages/NewTransformPage/NewTransformPage.tsx
+++ b/frontend/src/metabase/transforms/pages/NewTransformPage/NewTransformPage.tsx
@@ -16,8 +16,8 @@ import {
} from "metabase/common/data-studio/components/PaneHeader";
import { PLUGIN_REMOTE_SYNC, PLUGIN_TRANSFORMS_PYTHON } from "metabase/plugins";
import { getInitialUiState } from "metabase/querying/editor/components/QueryEditor";
-import { useDispatch, useSelector } from "metabase/redux";
-import { type Location, push, useParams } from "metabase/router";
+import { useSelector } from "metabase/redux";
+import { type Location, useNavigate, useParams } from "metabase/router";
import { getMetadata } from "metabase/selectors/metadata";
import { useRegisterMetabotTransformContext } from "metabase/transforms/hooks/use-register-transform-metabot-context";
import { useTransformPermissions } from "metabase/transforms/hooks/use-transform-permissions";
@@ -115,7 +115,7 @@ function NewTransformPageBody({
const [isModalOpened, { open: openModal, close: closeModal }] =
useDisclosure();
const [isLeaveWarningOpen, setIsLeaveWarningOpen] = useState(false);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [dryRunError, setDryRunError] = useState<string | undefined>(undefined);
useRegisterMetabotTransformContext(undefined, source, dryRunError);
@@ -129,11 +129,11 @@ function NewTransformPageBody({
const handleCreate = (transform: Transform) => {
isSavedRef.current = true;
- dispatch(push(Urls.transform(transform.id)));
+ navigate(Urls.transform(transform.id));
};
const handleCancel = () => {
- dispatch(push(Urls.transformList()));
+ navigate(Urls.transformList());
};
const isLocationAllowed = useCallback(
diff --git a/frontend/src/metabase/transforms/pages/RunListPage/RunListPage.tsx b/frontend/src/metabase/transforms/pages/RunListPage/RunListPage.tsx
index 866bb5d6fcd..c18e9ec85ed 100644
--- a/frontend/src/metabase/transforms/pages/RunListPage/RunListPage.tsx
+++ b/frontend/src/metabase/transforms/pages/RunListPage/RunListPage.tsx
@@ -11,8 +11,7 @@ import {
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { DataStudioBreadcrumbs } from "metabase/common/data-studio/components/DataStudioBreadcrumbs";
import { PaneHeader } from "metabase/common/data-studio/components/PaneHeader";
-import { useDispatch } from "metabase/redux";
-import { replace, useLocation } from "metabase/router";
+import { useLocation, useNavigate } from "metabase/router";
import { useSetting } from "metabase/settings";
import { DetailedViewSwitch } from "metabase/transforms/components/DetailedViewSwitch";
import { LockedTransformsBanner } from "metabase/transforms/components/LockedTransformsBanner/LockedTransformsBanner";
@@ -52,7 +51,7 @@ export function RunListPage() {
TransformRunId | undefined
>();
const [isPolling, setIsPolling] = useState(false);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const {
data,
@@ -113,9 +112,9 @@ export function RunListPage() {
const handleParamsChange = useCallback(
(newParams: Urls.TransformRunListParams) => {
- dispatch(replace(Urls.transformRunList(newParams)));
+ navigate(Urls.transformRunList(newParams), { replace: true });
},
- [dispatch],
+ [navigate],
);
const handleFilterOptionsChange = useCallback(
diff --git a/frontend/src/metabase/transforms/pages/TransformGraphRunListPage/TransformGraphRunListPage.tsx b/frontend/src/metabase/transforms/pages/TransformGraphRunListPage/TransformGraphRunListPage.tsx
index 8a2447874b8..a6f99cdda46 100644
--- a/frontend/src/metabase/transforms/pages/TransformGraphRunListPage/TransformGraphRunListPage.tsx
+++ b/frontend/src/metabase/transforms/pages/TransformGraphRunListPage/TransformGraphRunListPage.tsx
@@ -11,8 +11,7 @@ import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErr
import { PaginationControls } from "metabase/common/components/PaginationControls";
import { DataStudioBreadcrumbs } from "metabase/common/data-studio/components/DataStudioBreadcrumbs";
import { PaneHeader } from "metabase/common/data-studio/components/PaneHeader";
-import { useDispatch } from "metabase/redux";
-import { replace, useLocation } from "metabase/router";
+import { useLocation, useNavigate } from "metabase/router";
import { DetailedViewSwitch } from "metabase/transforms/components/DetailedViewSwitch";
import { POLLING_INTERVAL } from "metabase/transforms/constants";
import { isActiveRunStatus } from "metabase/transforms/utils";
@@ -48,7 +47,7 @@ export function TransformGraphRunListPage() {
useDisclosure();
const [selectedRun, setSelectedRun] = useState<TransformGraphRun>();
const [isPolling, setIsPolling] = useState(false);
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const {
data,
@@ -95,9 +94,9 @@ export function TransformGraphRunListPage() {
const handleParamsChange = useCallback(
(newParams: Urls.TransformGraphRunListParams) => {
- dispatch(replace(Urls.transformGraphRunList(newParams)));
+ navigate(Urls.transformGraphRunList(newParams), { replace: true });
},
- [dispatch],
+ [navigate],
);
const handleFilterOptionsChange = useCallback(
diff --git a/frontend/src/metabase/transforms/pages/TransformListPage/CreateTransformMenu/CreateTransformMenu.tsx b/frontend/src/metabase/transforms/pages/TransformListPage/CreateTransformMenu/CreateTransformMenu.tsx
index 165795b054c..d1d8c9b919b 100644
--- a/frontend/src/metabase/transforms/pages/TransformListPage/CreateTransformMenu/CreateTransformMenu.tsx
+++ b/frontend/src/metabase/transforms/pages/TransformListPage/CreateTransformMenu/CreateTransformMenu.tsx
@@ -11,8 +11,8 @@ import {
useUserMetabotPermissions,
} from "metabase/metabot/hooks";
import { PLUGIN_REMOTE_SYNC } from "metabase/plugins";
-import { useDispatch, useSelector } from "metabase/redux";
-import { push } from "metabase/router";
+import { useSelector } from "metabase/redux";
+import { useNavigate } from "metabase/router";
import { getShouldShowPythonTransformsUpsell } from "metabase/transforms/selectors";
import { Button, Center, Icon, Loader, Menu, Tooltip } from "metabase/ui";
import * as Urls from "metabase/urls";
@@ -23,7 +23,7 @@ import { CreateTransformCollectionModal } from "../../../components/CreateTransf
import { shouldDisableItem } from "./utils";
export const CreateTransformMenu = () => {
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const [isPickerOpened, { open: openPicker, close: closePicker }] =
useDisclosure();
const [
@@ -56,7 +56,7 @@ export const CreateTransformMenu = () => {
};
const handlePythonClick = () => {
- dispatch(push(Urls.newPythonTransform())); // Route will show upsell modal if feature is not enabled
+ navigate(Urls.newPythonTransform()); // Route will show upsell modal if feature is not enabled
if (hasPythonTransformsFeature) {
trackTransformCreate({ creationType: "python" });
@@ -112,7 +112,7 @@ export const CreateTransformMenu = () => {
leftSection={<Icon name="notebook" />}
onClick={() => {
trackTransformCreate({ creationType: "query" });
- dispatch(push(Urls.newQueryTransform()));
+ navigate(Urls.newQueryTransform());
}}
>
{t`Query builder`}
@@ -121,7 +121,7 @@ export const CreateTransformMenu = () => {
leftSection={<Icon name="sql" />}
onClick={() => {
trackTransformCreate({ creationType: "native" });
- dispatch(push(Urls.newNativeTransform()));
+ navigate(Urls.newNativeTransform());
}}
>
{t`SQL query`}
@@ -165,7 +165,7 @@ export const CreateTransformMenu = () => {
models={["card", "dataset"]}
isDisabledItem={(item) => shouldDisableItem(item, databases?.data)}
onChange={(item) => {
- dispatch(push(Urls.newTransformFromCard(item.id)));
+ navigate(Urls.newTransformFromCard(item.id));
closePicker();
}}
onClose={closePicker}
diff --git a/frontend/src/metabase/transforms/pages/TransformQueryPage/TransformQueryPage.tsx b/frontend/src/metabase/transforms/pages/TransformQueryPage/TransformQueryPage.tsx
index e658b2a6278..c96830665b4 100644
--- a/frontend/src/metabase/transforms/pages/TransformQueryPage/TransformQueryPage.tsx
+++ b/frontend/src/metabase/transforms/pages/TransformQueryPage/TransformQueryPage.tsx
@@ -17,8 +17,8 @@ import { PageContainer } from "metabase/common/data-studio/components/PageContai
import { useMetadataToasts } from "metabase/metadata/hooks";
import { PLUGIN_REMOTE_SYNC, PLUGIN_TRANSFORMS_PYTHON } from "metabase/plugins";
import { getInitialUiState } from "metabase/querying/editor/components/QueryEditor";
-import { useDispatch, useSelector } from "metabase/redux";
-import { push, useLocation, useParams } from "metabase/router";
+import { useSelector } from "metabase/redux";
+import { useLocation, useNavigate, useParams } from "metabase/router";
import { getMetadata } from "metabase/selectors/metadata";
import { useRegisterMetabotTransformContext } from "metabase/transforms/hooks/use-register-transform-metabot-context";
import { useTransformPermissions } from "metabase/transforms/hooks/use-transform-permissions";
@@ -113,7 +113,7 @@ function TransformQueryPageBody({
transformId: transform.id,
initialSource: transform.source,
});
- const dispatch = useDispatch();
+ const navigate = useNavigate();
const metadata = useSelector(getMetadata);
const isRemoteSyncReadOnly = useSelector(
PLUGIN_REMOTE_SYNC.getIsRemoteSyncReadOnly,
@@ -161,9 +161,9 @@ function TransformQueryPageBody({
useEffect(() => {
if (isEditMode && isRemoteSyncReadOnly) {
// If remote sync is set up to read-only mode, user can't edit transforms
- dispatch(push(Urls.transform(transform.id)));
+ navigate(Urls.transform(transform.id));
}
- }, [isRemoteSyncReadOnly, isEditMode, dispatch, transform.id]);
+ }, [isRemoteSyncReadOnly, isEditMode, transform.id, navigate]);
const handleSave = async (request: UpdateTransformRequest) => {
const { error } = await updateTransform(request);
@@ -178,7 +178,7 @@ function TransformQueryPageBody({
sendSuccessToast(t`Transform query updated`);
if (isEditMode) {
- dispatch(push(Urls.transform(transform.id)));
+ navigate(Urls.transform(transform.id));
}
}
};
@@ -212,7 +212,7 @@ function TransformQueryPageBody({
const handleCancel = () => {
if (isEditMode) {
- dispatch(push(Urls.transform(transform.id)));
+ navigate(Urls.transform(transform.id));
}
};
diff --git a/frontend/src/metabase/visualizations/lib/action.ts b/frontend/src/metabase/visualizations/lib/action.ts
index eedeacd15bd..d4c3464b60a 100644
--- a/frontend/src/metabase/visualizations/lib/action.ts
+++ b/frontend/src/metabase/visualizations/lib/action.ts
@@ -2,7 +2,7 @@ import _ from "underscore";
import type { Dispatch } from "metabase/redux/store";
import type { LocationDescriptorObject } from "metabase/router";
-import { push } from "metabase/router";
+import { navigate } from "metabase/router";
import type Question from "metabase-lib/v1/Question";
import type {
@@ -49,7 +49,7 @@ export function performAction(
if (props.onSameOriginNavigation) {
props.onSameOriginNavigation(location);
} else {
- dispatch(push(location));
+ navigate(location);
}
},
ignoreSiteUrl,
diff --git a/frontend/src/metabase/visualizations/lib/action.unit.spec.ts b/frontend/src/metabase/visualizations/lib/action.unit.spec.ts
index 6e368fd0db2..8d3b388cf11 100644
--- a/frontend/src/metabase/visualizations/lib/action.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/lib/action.unit.spec.ts
@@ -1,3 +1,4 @@
+import { navigate } from "metabase/router";
import MetabaseSettings from "metabase/utils/settings";
import type {
QuestionChangeClickAction,
@@ -7,7 +8,16 @@ import Question from "metabase-lib/v1/Question";
import { performAction } from "./action";
+jest.mock("metabase/router", () => ({
+ ...jest.requireActual("metabase/router"),
+ navigate: jest.fn(),
+}));
+
describe("performAction", () => {
+ beforeEach(() => {
+ jest.mocked(navigate).mockClear();
+ });
+
it('should redirect using router if a "relative" url has been passed', () => {
MetabaseSettings.set("site-url", "http://localhost");
const action: UrlClickAction = {
@@ -27,19 +37,11 @@ describe("performAction", () => {
expect(action.url).toHaveBeenCalledTimes(1);
- expect(extraProps.dispatch).toHaveBeenCalledTimes(1);
- expect(extraProps.dispatch).toHaveBeenCalledWith({
- payload: {
- args: [
- {
- hash: "",
- pathname: "/auto/dashboard/adhoc/123Abc",
- search: "",
- },
- ],
- method: "push",
- },
- type: "@@router/CALL_HISTORY_METHOD",
+ expect(navigate).toHaveBeenCalledTimes(1);
+ expect(navigate).toHaveBeenCalledWith({
+ hash: "",
+ pathname: "/auto/dashboard/adhoc/123Abc",
+ search: "",
});
});
@@ -90,19 +92,11 @@ describe("performAction", () => {
expect(action.url).toHaveBeenCalledTimes(1);
- expect(extraProps.dispatch).toHaveBeenCalledTimes(1);
- expect(extraProps.dispatch).toHaveBeenCalledWith({
- payload: {
- args: [
- {
- hash: "",
- pathname: url,
- search: "",
- },
- ],
- method: "push",
- },
- type: "@@router/CALL_HISTORY_METHOD",
+ expect(navigate).toHaveBeenCalledTimes(1);
+ expect(navigate).toHaveBeenCalledWith({
+ hash: "",
+ pathname: url,
+ search: "",
});
},
);
@@ -128,19 +122,11 @@ describe("performAction", () => {
expect(action.url).toHaveBeenCalledTimes(1);
- expect(extraProps.dispatch).toHaveBeenCalledTimes(1);
- expect(extraProps.dispatch).toHaveBeenCalledWith({
- payload: {
- args: [
- {
- hash: "",
- pathname: "/" + url,
- search: "",
- },
- ],
- method: "push",
- },
- type: "@@router/CALL_HISTORY_METHOD",
+ expect(navigate).toHaveBeenCalledTimes(1);
+ expect(navigate).toHaveBeenCalledWith({
+ hash: "",
+ pathname: "/" + url,
+ search: "",
});
},
);
@@ -167,19 +153,11 @@ describe("performAction", () => {
expect(action.url).toHaveBeenCalledTimes(1);
- expect(extraProps.dispatch).toHaveBeenCalledTimes(1);
- expect(extraProps.dispatch).toHaveBeenCalledWith({
- payload: {
- args: [
- {
- hash: "",
- pathname: "/auto/dashboard/adhoc/123Abc",
- search: "",
- },
- ],
- method: "push",
- },
- type: "@@router/CALL_HISTORY_METHOD",
+ expect(navigate).toHaveBeenCalledTimes(1);
+ expect(navigate).toHaveBeenCalledWith({
+ hash: "",
+ pathname: "/auto/dashboard/adhoc/123Abc",
+ search: "",
});
});
@@ -205,20 +183,12 @@ describe("performAction", () => {
expect(action.url).toHaveBeenCalledTimes(1);
- expect(extraProps.dispatch).toHaveBeenCalledTimes(1);
- expect(extraProps.dispatch).toHaveBeenCalledWith({
- payload: {
- args: [
- {
- hash: "",
- pathname:
- "/invalid_protocol://localhost/metabase/auto/dashboard/adhoc/123Abc",
- search: "",
- },
- ],
- method: "push",
- },
- type: "@@router/CALL_HISTORY_METHOD",
+ expect(navigate).toHaveBeenCalledTimes(1);
+ expect(navigate).toHaveBeenCalledWith({
+ hash: "",
+ pathname:
+ "/invalid_protocol://localhost/metabase/auto/dashboard/adhoc/123Abc",
+ search: "",
});
});
});
diff --git a/frontend/test/__support__/ui.tsx b/frontend/test/__support__/ui.tsx
index e4240babbfe..53b371ce01b 100644
--- a/frontend/test/__support__/ui.tsx
+++ b/frontend/test/__support__/ui.tsx
@@ -48,8 +48,6 @@ import {
type RouteObject,
RouterProviderMemory,
createLocationMirror,
- createRouterNavigator,
- routerMiddleware,
toFacadeLocation,
toNavigateArgs,
toRouteObjects,
@@ -242,11 +240,7 @@ export function getTestStoreAndWrapper({
reducers = { ...reducers, ...customReducers };
}
- const routerNavigator = withRouter ? createRouterNavigator() : undefined;
- const storeMiddleware = _.compact([
- Api.middleware,
- routerNavigator && routerMiddleware(routerNavigator),
- ]);
+ const storeMiddleware = [Api.middleware];
// Unjustified type cast. FIXME
const store = getStore(