Skip to content

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

Return a question from the card hook, not a builder (#82602)

Romeo Van Snicka3b46fdd3c04
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/TableOverview.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/TableOverview.tsx
index 8bfa95798ea..38b08188825 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/TableOverview.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/TableOverview.tsx
@@ -3,7 +3,7 @@ import { useMemo } from "react";
import { OverviewVisualization } from "metabase/common/data-studio/components/OverviewVisualization";
import {
useMetadataProvider,
- useQuestionFromOpts,
+ useQuestionFromOptsBuilder,
} from "metabase/metadata-store";
import { Flex, Stack } from "metabase/ui";
import * as Lib from "metabase-lib";
@@ -18,7 +18,7 @@ type TableOverviewProps = {
export function TableOverview({ table }: TableOverviewProps) {
const metadataProvider = useMetadataProvider(table.db_id);
- const buildQuestion = useQuestionFromOpts();
+ const buildQuestion = useQuestionFromOptsBuilder();
const card = useMemo(
() => getCard(table, metadataProvider, buildQuestion),
[table, metadataProvider, buildQuestion],
@@ -38,7 +38,7 @@ export function TableOverview({ table }: TableOverviewProps) {
function getCard(
table: Table,
metadataProvider: Lib.MetadataProvider,
- buildQuestion: ReturnType<typeof useQuestionFromOpts>,
+ buildQuestion: ReturnType<typeof useQuestionFromOptsBuilder>,
) {
const tableMetadata = Lib.tableOrCardMetadata(metadataProvider, table.id);
if (tableMetadata == null) {
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationDetailPage/ConversationDetailPage.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationDetailPage/ConversationDetailPage.tsx
index 2e29c23c8cf..0ffbf9459a7 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationDetailPage/ConversationDetailPage.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationDetailPage/ConversationDetailPage.tsx
@@ -18,7 +18,7 @@ import type {
MetabotMessage,
} from "metabase/metabot/state/types";
import { convertSlackMessage } from "metabase/metabot/utils/slack-mrkdwn";
-import { useQuestionFromCard } from "metabase/metadata-store";
+import { useQuestionFromCardBuilder } from "metabase/metadata-store";
import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
import { Sidebar } from "metabase/monitor/components/MonitorLayout/Sidebar";
import { Notebook } from "metabase/querying/notebook/components/Notebook";
@@ -331,7 +331,7 @@ export function GeneratedQueryCard({ query }: { query: GeneratedQuery }) {
}
function SqlGeneratedQueryCard({ query }: { query: GeneratedQuery }) {
- const buildQuestion = useQuestionFromCard();
+ const buildQuestion = useQuestionFromCardBuilder();
const runUrl = useMemo(() => {
if (query.database_id == null || !query.sql) {
@@ -401,7 +401,7 @@ function NotebookGeneratedQueryCard({
const { isLoading, isError } = useGetAdhocQueryMetadataQuery(
mbql.database != null ? mbql : skipToken,
);
- const buildQuestion = useQuestionFromCard();
+ const buildQuestion = useQuestionFromCardBuilder();
const reportTimezone = useSelector((state) =>
getSetting(state, "report-timezone-long"),
);
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 b4de5988f20..ea504de46fe 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
@@ -2,7 +2,7 @@ import { useCallback, useEffect, useMemo } from "react";
import {
useMetadataProvider,
- useQuestionFromOpts,
+ useQuestionFromOptsBuilder,
} from "metabase/metadata-store";
import { useDispatch } from "metabase/redux";
import { fetchTableMetadata } from "metabase/redux/tables";
@@ -24,7 +24,7 @@ export const useAdHocTableQuery = ({
databaseId,
location,
}: UseAdHocTableQueryProps) => {
- const buildQuestion = useQuestionFromOpts();
+ const buildQuestion = useQuestionFromOptsBuilder();
const dispatch = useDispatch();
const navigate = useNavigate();
diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Editor.tsx b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Editor.tsx
index 90a676ab83d..42c0f880e96 100644
--- a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Editor.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Editor.tsx
@@ -51,15 +51,7 @@ export const Editor = ({
queryQuestion,
} = useSdkQuestionContext();
- const buildQuestion = useQuestionFromCard();
-
- const question = useMemo(() => {
- if (!rawQuestion) {
- return rawQuestion;
- }
-
- return buildQuestion(rawQuestion?.card());
- }, [rawQuestion, buildQuestion]);
+ const question = useQuestionFromCard(rawQuestion?.card());
const isDirty = useMemo(() => {
return isQuestionDirty(question, originalQuestion);
diff --git a/frontend/src/metabase/common/components/MetadataInfo/TableInfo/ConnectedTables.tsx b/frontend/src/metabase/common/components/MetadataInfo/TableInfo/ConnectedTables.tsx
index 1bca96d3f83..30421a6e574 100644
--- a/frontend/src/metabase/common/components/MetadataInfo/TableInfo/ConnectedTables.tsx
+++ b/frontend/src/metabase/common/components/MetadataInfo/TableInfo/ConnectedTables.tsx
@@ -1,6 +1,7 @@
+import { useMemo } from "react";
import { t } from "ttag";
-import { useQuestionFromOpts } from "metabase/metadata-store";
+import { useQuestionFromOptsBuilder } from "metabase/metadata-store";
import * as Urls from "metabase/urls";
import type { NormalizedTable } from "metabase-types/api";
@@ -58,17 +59,21 @@ function ConnectedTableButton({
}
function ConnectedTableLink({ table }: { table: ConnectedTable }) {
- const buildQuestion = useQuestionFromOpts();
- const question = buildQuestion({
- dataset_query: {
- database: table.db_id,
- type: "query",
- query: { "source-table": table.id },
- },
- }).setDefaultDisplay();
+ const buildQuestion = useQuestionFromOptsBuilder();
+ const url = useMemo(() => {
+ const question = buildQuestion({
+ dataset_query: {
+ database: table.db_id,
+ type: "query",
+ query: { "source-table": table.id },
+ },
+ }).setDefaultDisplay();
+
+ return Urls.question(question);
+ }, [buildQuestion, table.db_id, table.id]);
return (
- <LabelLink to={Urls.question(question)}>
+ <LabelLink to={url}>
<InteractiveTableLabel table={table} />
</LabelLink>
);
diff --git a/frontend/src/metabase/common/data-studio/components/OverviewVisualization/OverviewVisualization.tsx b/frontend/src/metabase/common/data-studio/components/OverviewVisualization/OverviewVisualization.tsx
index a94cc29d775..9685413754e 100644
--- a/frontend/src/metabase/common/data-studio/components/OverviewVisualization/OverviewVisualization.tsx
+++ b/frontend/src/metabase/common/data-studio/components/OverviewVisualization/OverviewVisualization.tsx
@@ -22,8 +22,7 @@ export function MetricCardVisualization({
isLoading,
className,
}: MetricCardVisualizationProps) {
- const buildQuestion = useQuestionFromCard();
- const question = useMemo(() => buildQuestion(card), [card, buildQuestion]);
+ const question = useQuestionFromCard(card);
const rawSeries = useMemo(
() => (data ? [{ card, data: data.data }] : null),
diff --git a/frontend/src/metabase/dashboard/components/ActionViz/Action.tsx b/frontend/src/metabase/dashboard/components/ActionViz/Action.tsx
index 79deafdb34e..fd5df9cae0f 100644
--- a/frontend/src/metabase/dashboard/components/ActionViz/Action.tsx
+++ b/frontend/src/metabase/dashboard/components/ActionViz/Action.tsx
@@ -62,11 +62,7 @@ const ActionComponent = ({
const { data: card } = useGetCardQuery(
dashcard.action?.model_id ? { id: dashcard.action.model_id } : skipToken,
);
- const buildQuestion = useQuestionFromCard();
- const model = useMemo(
- () => (card ? buildQuestion(card) : undefined),
- [card, buildQuestion],
- );
+ const model = useQuestionFromCard(card);
const actionSettings = dashcard.action?.visualization_settings;
const actionDisplayType =
diff --git a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/LinkOptions/LinkedEntityPicker/LinkedEntityPicker.tsx b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/LinkOptions/LinkedEntityPicker/LinkedEntityPicker.tsx
index 9997335c5b0..69399073693 100644
--- a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/LinkOptions/LinkedEntityPicker/LinkedEntityPicker.tsx
+++ b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/LinkOptions/LinkedEntityPicker/LinkedEntityPicker.tsx
@@ -1,4 +1,4 @@
-import { useCallback, useEffect, useMemo, useState } from "react";
+import { useCallback, useEffect, useState } from "react";
import { t } from "ttag";
import { skipToken, useGetCardQuery, useGetDashboardQuery } from "metabase/api";
@@ -145,10 +145,7 @@ function TargetClickMappings({
? { id: clickBehavior.targetId }
: skipToken,
);
- const buildQuestion = useQuestionFromCard();
- const question = useMemo(() => {
- return card ? buildQuestion(card) : undefined;
- }, [card, buildQuestion]);
+ const question = useQuestionFromCard(card);
const object = isDashboard ? dashboard : question;
const isLoading = isDashboard ? dashboardIsLoading : cardIsLoading;
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCard.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCard.tsx
index a7f65b315ed..ffb8467c5ee 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCard.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCard.tsx
@@ -337,10 +337,10 @@ function DashCardInner({
? onEditVisualizationClick
: undefined;
- const buildQuestion = useQuestionFromCard();
- const question = useMemo(() => {
- return isQuestionCard(dashcard.card) ? buildQuestion(dashcard.card) : null;
- }, [dashcard.card, buildQuestion]);
+ const question =
+ useQuestionFromCard(
+ isQuestionCard(dashcard.card) ? dashcard.card : undefined,
+ ) ?? null;
return (
<ErrorBoundary>
diff --git a/frontend/src/metabase/dashboard/components/DashCard/PublicOrEmbeddedDashCardMenu.tsx b/frontend/src/metabase/dashboard/components/DashCard/PublicOrEmbeddedDashCardMenu.tsx
index 29b3e822130..a4c44433173 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/PublicOrEmbeddedDashCardMenu.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/PublicOrEmbeddedDashCardMenu.tsx
@@ -1,5 +1,5 @@
import { useDisclosure } from "@mantine/hooks";
-import { useMemo, useState } from "react";
+import { useState } from "react";
import { t } from "ttag";
import { QuestionDownloadWidget } from "metabase/common/components/QuestionDownloadWidget";
@@ -38,11 +38,7 @@ export const PublicOrEmbeddedDashCardMenu = ({
},
});
- const buildQuestion = useQuestionFromCard();
- const question = useMemo(
- () => buildQuestion(dashcard.card),
- [dashcard.card, buildQuestion],
- );
+ const question = useQuestionFromCard(dashcard.card);
// by the time we reach this code, dashboardId really should not be null.
const [{ loading: isDownloadingData }, handleDownload] = useDownloadData({
diff --git a/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/CardEmbedNode.tsx b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/CardEmbedNode.tsx
index d052778a8db..93fc7496469 100644
--- a/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/CardEmbedNode.tsx
+++ b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/CardEmbedNode.tsx
@@ -18,7 +18,7 @@ import { ExplicitSizeRefreshModeContext } from "metabase/common/components/Expli
import { QuestionPickerModal } from "metabase/common/components/Pickers";
import type { QuestionPickerValueItem } from "metabase/common/components/Pickers/QuestionPicker/types";
import { useDownloadData } from "metabase/common/components/QuestionDownloadWidget/use-download-data";
-import { useQuestionFromCard } from "metabase/metadata-store";
+import { useQuestionFromCardBuilder } from "metabase/metadata-store";
import { useDispatch, useSelector } from "metabase/redux";
import { CommentsButton } from "metabase/rich_text_editing/tiptap/components/CommentsButton";
import { CardEmbedLoadingState } from "metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedLoadingState";
@@ -327,7 +327,7 @@ export const CardEmbedComponent = memo(
host.useReportPrefetchLoading(_id, isLoading);
- const buildQuestion = useQuestionFromCard();
+ const buildQuestion = useQuestionFromCardBuilder();
const datasetError = dataset && getDatasetError(dataset);
const [isEditingTitle, setIsEditingTitle] = useState(false);
const [editedTitle, setEditedTitle] = useState(name || "");
diff --git a/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/ExternalDocumentCardMenu.tsx b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/ExternalDocumentCardMenu.tsx
index 5a1222d979c..1246e116073 100644
--- a/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/ExternalDocumentCardMenu.tsx
+++ b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/ExternalDocumentCardMenu.tsx
@@ -1,6 +1,6 @@
import { useDisclosure } from "@mantine/hooks";
import cx from "classnames";
-import { useMemo, useState } from "react";
+import { useState } from "react";
import { t } from "ttag";
import { QuestionDownloadWidget } from "metabase/common/components/QuestionDownloadWidget";
@@ -30,8 +30,7 @@ export const ExternalDocumentCardMenu = ({
},
});
- const buildQuestion = useQuestionFromCard();
- const question = useMemo(() => buildQuestion(card), [card, buildQuestion]);
+ const question = useQuestionFromCard(card);
const [{ loading: isDownloadingData }, handleDownload] = useDownloadData({
question: question,
diff --git a/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/ModifyQuestionModal.tsx b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/ModifyQuestionModal.tsx
index b0d5da0750d..a44ee9112fc 100644
--- a/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/ModifyQuestionModal.tsx
+++ b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/ModifyQuestionModal.tsx
@@ -4,7 +4,7 @@ import _ from "underscore";
import {
selectQuestionFromCard,
- useQuestionFromCard,
+ useQuestionFromCardBuilder,
} from "metabase/metadata-store";
import { Notebook } from "metabase/querying/notebook/components/Notebook";
import { useDispatch, useSelector, useStore } from "metabase/redux";
@@ -33,7 +33,7 @@ export const ModifyQuestionModal = ({
const store = useStore();
const dispatch = useDispatch();
const host = useEditorHost();
- const buildQuestion = useQuestionFromCard();
+ const buildQuestion = useQuestionFromCardBuilder();
const reportTimezone = useSelector((state) =>
getSetting(state, "report-timezone-long"),
);
diff --git a/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/NativeQueryModal.tsx b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/NativeQueryModal.tsx
index 408e2b7b962..c80eca4b0a5 100644
--- a/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/NativeQueryModal.tsx
+++ b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/NativeQueryModal.tsx
@@ -8,7 +8,7 @@ import { getErrorMessage as getResponseErrorMessage } from "metabase/api/utils";
import { ErrorMessage } from "metabase/common/components/ErrorMessage";
import { useUserMetabotPermissions } from "metabase/metabot/hooks";
import { getMetabotVisible } from "metabase/metabot/state";
-import { useQuestionFromCard } from "metabase/metadata-store";
+import { useQuestionFromCardBuilder } from "metabase/metadata-store";
import { defaultClickActionMode } from "metabase/querying/click-actions/lib/modes";
import { DataReference } from "metabase/querying/components/DataReference/DataReference";
import type { DataReferenceItem } from "metabase/querying/components/DataReference/types";
@@ -111,7 +111,7 @@ export const NativeQueryModal = ({
}: NativeQueryModalProps) => {
const dispatch = useDispatch();
const host = useEditorHost();
- const buildQuestion = useQuestionFromCard();
+ const buildQuestion = useQuestionFromCardBuilder();
const [modifiedQuestion, setModifiedQuestion] = useState<Question | null>(
null,
diff --git a/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/use-update-card-operations.ts b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/use-update-card-operations.ts
index 9ce0c09876d..7234409c937 100644
--- a/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/use-update-card-operations.ts
+++ b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/use-update-card-operations.ts
@@ -1,7 +1,7 @@
import type { NodeViewProps } from "@tiptap/core";
import { useCallback } from "react";
-import { useQuestionFromCard } from "metabase/metadata-store";
+import { useQuestionFromCardBuilder } from "metabase/metadata-store";
import { useDispatch } from "metabase/redux";
import {
type UseCardDataResult,
@@ -32,7 +32,7 @@ export const useUpdateCardOperations = ({
}) => {
const host = useEditorHost();
const dispatch = useDispatch();
- const buildQuestion = useQuestionFromCard();
+ const buildQuestion = useQuestionFromCardBuilder();
const { card, draftCard, regularDataset } = regularCardData;
diff --git a/frontend/src/metabase/documents/hooks/use-card-data.ts b/frontend/src/metabase/documents/hooks/use-card-data.ts
index 692bbcd6464..56ca50d11bd 100644
--- a/frontend/src/metabase/documents/hooks/use-card-data.ts
+++ b/frontend/src/metabase/documents/hooks/use-card-data.ts
@@ -5,7 +5,7 @@ import {
useGetAdhocPivotQueryQuery,
useGetAdhocQueryQuery,
} from "metabase/api/dataset";
-import { useQuestionFromCard } from "metabase/metadata-store";
+import { useQuestionFromCardBuilder } from "metabase/metadata-store";
import { useSelector } from "metabase/redux";
import type { UseCardDataResult } from "metabase/rich_text_editing/tiptap/EditorHost";
import { getPivotOptions } from "metabase-lib/v1/queries/utils/pivot-options";
@@ -104,7 +104,7 @@ export function useCardData({
const cardToUse = cardWithDraft ?? card;
- const buildQuestion = useQuestionFromCard();
+ const buildQuestion = useQuestionFromCardBuilder();
const isPivotTable = cardToUse?.display === "pivot";
diff --git a/frontend/src/metabase/documents/hooks/use-external-card-data.ts b/frontend/src/metabase/documents/hooks/use-external-card-data.ts
index 7b16fbff636..84bd7242114 100644
--- a/frontend/src/metabase/documents/hooks/use-external-card-data.ts
+++ b/frontend/src/metabase/documents/hooks/use-external-card-data.ts
@@ -1,5 +1,3 @@
-import { useMemo } from "react";
-
import { skipToken, useGetPublicDocumentCardQueryQuery } from "metabase/api";
import { useQuestionFromCard } from "metabase/metadata-store";
import type { UseCardDataResult } from "metabase/rich_text_editing/tiptap/EditorHost";
@@ -22,7 +20,6 @@ export function useExternalCardDataLoader(
{ skip = false }: { skip?: boolean } = {},
): UseCardDataResult {
const context = useExternalCardData();
- const buildQuestion = useQuestionFromCard();
const card = context?.cards?.[cardId];
const documentUuid = context?.documentUuid;
@@ -37,10 +34,7 @@ export function useExternalCardDataLoader(
shouldSkip ? skipToken : { uuid: documentUuid, cardId },
);
- const question = useMemo(
- () => (card ? buildQuestion(card) : undefined),
- [card, buildQuestion],
- );
+ const question = useQuestionFromCard(card);
if (!context) {
return {
diff --git a/frontend/src/metabase/embedding/components/QuestionEmbedWidget/QuestionEmbedWidget.tsx b/frontend/src/metabase/embedding/components/QuestionEmbedWidget/QuestionEmbedWidget.tsx
index 3b560291503..00c9f7995d1 100644
--- a/frontend/src/metabase/embedding/components/QuestionEmbedWidget/QuestionEmbedWidget.tsx
+++ b/frontend/src/metabase/embedding/components/QuestionEmbedWidget/QuestionEmbedWidget.tsx
@@ -15,7 +15,7 @@ type QuestionEmbedWidgetProps = {
export const QuestionEmbedWidget = (props: QuestionEmbedWidgetProps) => {
const { card, onBack, onClose } = props;
- const buildQuestion = useQuestionFromCard();
+ const question = useQuestionFromCard(card);
const [updateEnableEmbedding] = useUpdateCardEnableEmbeddingMutation();
const [updateEmbeddingParams] = useUpdateCardEmbeddingParamsMutation();
@@ -25,7 +25,7 @@ export const QuestionEmbedWidget = (props: QuestionEmbedWidgetProps) => {
opened={true}
resource={card}
resourceType="question"
- resourceParameters={buildQuestion(card).parameters()}
+ resourceParameters={question.parameters()}
onUpdateEnableEmbedding={(enable_embedding) =>
updateEnableEmbedding({
id: card.id,
diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-available-parameters.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-available-parameters.ts
index e05df78686f..9437f72164e 100644
--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-available-parameters.ts
+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-available-parameters.ts
@@ -4,7 +4,7 @@ import { usePrevious } from "react-use";
import type { SdkIframeEmbedSetupExperience } from "metabase/embedding/embedding-iframe-sdk-setup/types";
import {
paramFieldsFetched,
- useQuestionFromCard,
+ useQuestionFromCardBuilder,
} from "metabase/metadata-store";
import { getSavedDashboardUiParameters } from "metabase/parameters/utils/dashboards";
import { useDispatch } from "metabase/redux";
@@ -20,7 +20,7 @@ export const useAvailableParameters = ({
resource,
}: UseParameterListProps) => {
const dispatch = useDispatch();
- const buildQuestion = useQuestionFromCard();
+ const buildQuestion = useQuestionFromCardBuilder();
// We need initial available parameters to display the `discard changes` button
// and reset user selected parameters back to initial parameters
diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-available-parameters.unit.spec.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-available-parameters.unit.spec.ts
index c997caf8066..0aaf1b9f28b 100644
--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-available-parameters.unit.spec.ts
+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/hooks/use-available-parameters.unit.spec.ts
@@ -25,7 +25,7 @@ jest.mock("metabase/parameters/utils/dashboards", () => ({
const mockCardParameters = jest.fn();
jest.mock("metabase/metadata-store", () => ({
- useQuestionFromCard: () => () => ({ parameters: mockCardParameters }),
+ useQuestionFromCardBuilder: () => () => ({ parameters: mockCardParameters }),
paramFieldsFetched: jest.fn((paramFields) => ({
type: "metabase/entities/UPDATE",
payload: paramFields,
diff --git a/frontend/src/metabase/metadata-store/index.ts b/frontend/src/metabase/metadata-store/index.ts
index b35047c5852..0465a09c834 100644
--- a/frontend/src/metabase/metadata-store/index.ts
+++ b/frontend/src/metabase/metadata-store/index.ts
@@ -21,7 +21,6 @@ export type { MetadataSelectorOpts, ShallowForeignKey } from "./selectors";
export {
selectMetadataProvider,
- selectMetadataProviderFactory,
selectMetadataProviderUnfiltered,
selectMetricMetadataProvider,
selectQuestionFromCard,
@@ -33,7 +32,8 @@ export {
useMetadataProviderUnfiltered,
useMetricMetadataProvider,
useQuestionFromCard,
- useQuestionFromOpts,
+ useQuestionFromCardBuilder,
+ useQuestionFromOptsBuilder,
} from "./provider";
export type {
CardQuestionBuilder,
diff --git a/frontend/src/metabase/metadata-store/provider-hooks.unit.spec.tsx b/frontend/src/metabase/metadata-store/provider-hooks.unit.spec.tsx
index 7e66ac50234..2551b5a228e 100644
--- a/frontend/src/metabase/metadata-store/provider-hooks.unit.spec.tsx
+++ b/frontend/src/metabase/metadata-store/provider-hooks.unit.spec.tsx
@@ -1,20 +1,24 @@
import { createMockSettingsState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderHookWithProviders } from "__support__/ui";
-import { createMockSettings } from "metabase-types/api/mocks";
+import { createMockCard, createMockSettings } from "metabase-types/api/mocks";
import { createSampleDatabase } from "metabase-types/api/mocks/presets";
-import { useQuestionFromCard, useQuestionFromOpts } from "./provider";
+import {
+ useQuestionFromCard,
+ useQuestionFromCardBuilder,
+ useQuestionFromOptsBuilder,
+} from "./provider";
const storeInitialState = {
entities: createMockEntitiesState({ databases: [createSampleDatabase()] }),
settings: createMockSettingsState(createMockSettings()),
};
-describe("the question hooks", () => {
+describe("the question builder hooks", () => {
it.each([
- ["useQuestionFromCard", useQuestionFromCard],
- ["useQuestionFromOpts", useQuestionFromOpts],
+ ["useQuestionFromCardBuilder", useQuestionFromCardBuilder],
+ ["useQuestionFromOptsBuilder", useQuestionFromOptsBuilder],
])("%s returns a builder that survives a re-render", (_name, useHook) => {
const { result, rerender } = renderHookWithProviders(() => useHook(), {
storeInitialState,
@@ -27,3 +31,28 @@ describe("the question hooks", () => {
expect(result.current === first).toBe(true);
});
});
+
+describe("useQuestionFromCard", () => {
+ it("returns a question that survives a re-render", () => {
+ const card = createMockCard({ id: 1 });
+ const { result, rerender } = renderHookWithProviders(
+ () => useQuestionFromCard(card),
+ { storeInitialState },
+ );
+ const first = result.current;
+
+ rerender();
+
+ expect(result.current).toBe(first);
+ expect(first.id()).toBe(1);
+ });
+
+ it("returns undefined without a card", () => {
+ const { result } = renderHookWithProviders(
+ () => useQuestionFromCard(undefined),
+ { storeInitialState },
+ );
+
+ expect(result.current).toBeUndefined();
+ });
+});
diff --git a/frontend/src/metabase/metadata-store/provider.ts b/frontend/src/metabase/metadata-store/provider.ts
index 8537910edce..e8539931a9d 100644
--- a/frontend/src/metabase/metadata-store/provider.ts
+++ b/frontend/src/metabase/metadata-store/provider.ts
@@ -1,3 +1,5 @@
+import { useMemo } from "react";
+
import { useSelector } from "metabase/redux";
import type { State } from "metabase/redux/store";
import * as Lib from "metabase-lib";
@@ -197,11 +199,41 @@ export const selectQuestionFromCardBuilder = (
return build;
};
-export const useQuestionFromCard = (
+/**
+ * `selectQuestionFromCardBuilder` for components that build at call time: in a
+ * callback, in an effect, or once per item in a list. A component that wants
+ * one question for one card takes `useQuestionFromCard` instead.
+ */
+export const useQuestionFromCardBuilder = (
opts?: MetadataSelectorOpts,
): CardQuestionBuilder =>
useSelector((state) => selectQuestionFromCardBuilder(state, opts));
+/**
+ * The `Question` for a card, or `undefined` when there is no card to build
+ * from. Memoised on the card and on the metadata behind it, so the result
+ * holds one reference for as long as both do.
+ */
+export function useQuestionFromCard(
+ card: UnsavedCard,
+ opts?: MetadataSelectorOpts,
+): Question;
+export function useQuestionFromCard(
+ card: UnsavedCard | null | undefined,
+ opts?: MetadataSelectorOpts,
+): Question | undefined;
+export function useQuestionFromCard(
+ card: UnsavedCard | null | undefined,
+ opts?: MetadataSelectorOpts,
+): Question | undefined {
+ const buildQuestion = useQuestionFromCardBuilder(opts);
+
+ return useMemo(
+ () => (card == null ? undefined : buildQuestion(card)),
+ [buildQuestion, card],
+ );
+}
+
export type DraftQuestionBuilder = (
opts: Omit<QuestionCreatorOpts, "metadata">,
) => Question;
@@ -229,5 +261,9 @@ export const selectQuestionFromOptsBuilder = (
return build;
};
-export const useQuestionFromOpts = (): DraftQuestionBuilder =>
+/**
+ * `selectQuestionFromOptsBuilder` for components. A builder rather than a
+ * question, because a draft's options are assembled at call time.
+ */
+export const useQuestionFromOptsBuilder = (): DraftQuestionBuilder =>
useSelector(selectQuestionFromOptsBuilder);
diff --git a/frontend/src/metabase/metrics/pages/MetricQueryPage/MetricQueryPage.tsx b/frontend/src/metabase/metrics/pages/MetricQueryPage/MetricQueryPage.tsx
index 2327b703ca8..fdc71afba2f 100644
--- a/frontend/src/metabase/metrics/pages/MetricQueryPage/MetricQueryPage.tsx
+++ b/frontend/src/metabase/metrics/pages/MetricQueryPage/MetricQueryPage.tsx
@@ -61,15 +61,16 @@ function MetricQueryPageBody({
showAppSwitcher,
showDataStudioLink,
}: MetricQueryPageBodyProps) {
- const buildQuestion = useQuestionFromCard();
+ const cardQuestion = useQuestionFromCard(card);
const [datasetQuery, setDatasetQuery] = useState(card.dataset_query);
const [uiState, setUiState] = useState(getInitialUiState);
const [updateCard, { isLoading: isSaving }] = useUpdateCardMutation();
const { sendSuccessToast, sendErrorToast } = useMetadataToasts();
- const question = useMemo(() => {
- return buildQuestion(card).setDatasetQuery(datasetQuery);
- }, [card, buildQuestion, datasetQuery]);
+ const question = useMemo(
+ () => cardQuestion.setDatasetQuery(datasetQuery),
+ [cardQuestion, datasetQuery],
+ );
const resultMetadata = useMemo(() => {
return getResultMetadata(
diff --git a/frontend/src/metabase/models/containers/ActionCreatorModal/ActionCreatorModal.tsx b/frontend/src/metabase/models/containers/ActionCreatorModal/ActionCreatorModal.tsx
index 1679efff4d4..6c3a5dbffcc 100644
--- a/frontend/src/metabase/models/containers/ActionCreatorModal/ActionCreatorModal.tsx
+++ b/frontend/src/metabase/models/containers/ActionCreatorModal/ActionCreatorModal.tsx
@@ -1,4 +1,4 @@
-import { useEffect, useMemo } from "react";
+import { useEffect } from "react";
import { skipToken, useGetActionQuery, useGetCardQuery } from "metabase/api";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
@@ -84,11 +84,7 @@ function ActionCreatorModalLoader({ params, onClose }: ModalComponentProps) {
isLoading,
error,
} = useGetCardQuery(modelId != null ? { id: modelId } : skipToken);
- const buildQuestion = useQuestionFromCard();
- const model = useMemo(
- () => (card != null ? buildQuestion(card) : undefined),
- [card, buildQuestion],
- );
+ const model = useQuestionFromCard(card);
if (isLoading || error != null || !model) {
return <LoadingAndErrorWrapper loading={isLoading} error={error} />;
diff --git a/frontend/src/metabase/models/containers/ModelActions/ModelActions.tsx b/frontend/src/metabase/models/containers/ModelActions/ModelActions.tsx
index d6cfe212307..56b16806b35 100644
--- a/frontend/src/metabase/models/containers/ModelActions/ModelActions.tsx
+++ b/frontend/src/metabase/models/containers/ModelActions/ModelActions.tsx
@@ -127,11 +127,7 @@ function ModelActionsLoader(dispatchProps: DispatchProps) {
isLoading,
error,
} = useGetCardQuery(modelId != null ? { id: modelId } : skipToken);
- const buildQuestion = useQuestionFromCard();
- const model = useMemo(
- () => (card != null ? buildQuestion(card) : undefined),
- [card, buildQuestion],
- );
+ const model = useQuestionFromCard(card);
if (!model) {
return <LoadingAndErrorWrapper loading={isLoading} error={error} />;
diff --git a/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx b/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx
index 00662ed22b8..70e8d110fd1 100644
--- a/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx
+++ b/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx
@@ -1,4 +1,4 @@
-import { useEffect, useMemo, useState } from "react";
+import { useEffect, useState } from "react";
import {
skipToken,
@@ -42,7 +42,6 @@ export const NotificationDetailSidebar = ({
}, [notificationId]);
const dispatch = useDispatch();
- const buildQuestion = useQuestionFromCard();
const cardId = notification?.payload?.card_id;
const { currentData: card, isFetching: isCardLoading } = useGetCardQuery(
cardId != null ? { id: cardId } : skipToken,
@@ -54,10 +53,7 @@ export const NotificationDetailSidebar = ({
}
}, [card, dispatch]);
- const question = useMemo(
- () => (card ? buildQuestion(card) : undefined),
- [card, buildQuestion],
- );
+ const question = useQuestionFromCard(card);
return (
<>
diff --git a/frontend/src/metabase/parameters/components/ValuesSourceModal/ValuesSourceTypeModal.tsx b/frontend/src/metabase/parameters/components/ValuesSourceModal/ValuesSourceTypeModal.tsx
index 6fc2f2ed3a3..8177366bc99 100644
--- a/frontend/src/metabase/parameters/components/ValuesSourceModal/ValuesSourceTypeModal.tsx
+++ b/frontend/src/metabase/parameters/components/ValuesSourceModal/ValuesSourceTypeModal.tsx
@@ -723,11 +723,7 @@ function ValuesSourceTypeModalLoader(props: ModalOwnProps) {
isLoading: isCardLoading,
error: cardError,
} = useGetCardQuery(card_id != null ? { id: card_id } : skipToken);
- const buildQuestion = useQuestionFromCard();
- const question = useMemo(
- () => (card != null ? buildQuestion(card) : undefined),
- [card, buildQuestion],
- );
+ const question = useQuestionFromCard(card);
return (
<ModalLoadingAndErrorWrapper
diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion.tsx b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion.tsx
index 97a4653da4b..48d194a9c89 100644
--- a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion.tsx
+++ b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion.tsx
@@ -39,7 +39,6 @@ export const PublicOrEmbeddedQuestion = () => {
const dispatch = useDispatch();
const store = useStore();
- const buildQuestion = useQuestionFromCard();
const [initialized, setInitialized] = useState(false);
@@ -188,12 +187,14 @@ export const PublicOrEmbeddedQuestion = () => {
run();
}, [run]);
+ const question = useQuestionFromCard(card);
+
const getParameters = () => {
- if (!initialized || !card) {
+ if (!initialized || !question) {
return [];
}
- return buildQuestion(card).parameters();
+ return question.parameters();
};
return (
diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.tsx b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.tsx
index a2796940643..b94365adbb8 100644
--- a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.tsx
+++ b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.tsx
@@ -54,9 +54,8 @@ export function PublicOrEmbeddedQuestionView({
setCard,
downloadsEnabled,
}: PublicOrEmbeddedQuestionViewProps) {
- const buildQuestion = useQuestionFromCard();
// EmbedFrame lays out a question frame before the card loads.
- const question = card ? buildQuestion(card) : new Question(null);
+ const question = useQuestionFromCard(card) ?? new Question(null);
const isTable = question.display() === "table";
const downloadInFooter = !titled && isTable;
diff --git a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionDataSource/SourceQuestionBreadcrumbs.tsx b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionDataSource/SourceQuestionBreadcrumbs.tsx
index 7c52582abaa..e3dfa99e730 100644
--- a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionDataSource/SourceQuestionBreadcrumbs.tsx
+++ b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionDataSource/SourceQuestionBreadcrumbs.tsx
@@ -1,4 +1,4 @@
-import { type ReactElement, useMemo } from "react";
+import type { ReactElement } from "react";
import { skipToken, useGetCardQuery } from "metabase/api";
import { useQuestionFromCard } from "metabase/metadata-store";
@@ -26,10 +26,7 @@ export function SourceQuestionBreadcrumbs({
const { data: sourceCard } = useGetCardQuery(
sourceQuestionId != null ? { id: sourceQuestionId } : skipToken,
);
- const buildQuestion = useQuestionFromCard();
- const sourceQuestion = useMemo(() => {
- return sourceCard ? buildQuestion(sourceCard) : undefined;
- }, [sourceCard, buildQuestion]);
+ const sourceQuestion = useQuestionFromCard(sourceCard);
if (!sourceQuestion) {
return null;
diff --git a/frontend/src/metabase/querying/editor/hooks/use-query-question/use-query-question.ts b/frontend/src/metabase/querying/editor/hooks/use-query-question/use-query-question.ts
index d0e1f668e83..183ec0e492d 100644
--- a/frontend/src/metabase/querying/editor/hooks/use-query-question/use-query-question.ts
+++ b/frontend/src/metabase/querying/editor/hooks/use-query-question/use-query-question.ts
@@ -1,6 +1,6 @@
import { useMemo, useState } from "react";
-import { useQuestionFromOpts } from "metabase/metadata-store";
+import { useQuestionFromOptsBuilder } from "metabase/metadata-store";
import * as Lib from "metabase-lib";
import type Question from "metabase-lib/v1/Question";
import type { VisualizationSettings } from "metabase-types/api";
@@ -20,7 +20,7 @@ export function useQueryQuestion(
}: QueryEditorUiOptions = {},
onChangeQuery: (newQuery: Lib.Query) => void,
) {
- const buildQuestion = useQuestionFromOpts();
+ const buildQuestion = useQuestionFromOptsBuilder();
const [parameterValues, setParameterValues] = useState({});
const { question } = useMemo(
diff --git a/frontend/src/metabase/questions/components/AdHocQuestionLoader.tsx b/frontend/src/metabase/questions/components/AdHocQuestionLoader.tsx
index c95b192aa20..45443bdd34d 100644
--- a/frontend/src/metabase/questions/components/AdHocQuestionLoader.tsx
+++ b/frontend/src/metabase/questions/components/AdHocQuestionLoader.tsx
@@ -5,7 +5,7 @@ import { deserializeCardFromUrl } from "metabase/common/utils/card";
import {
type CardQuestionBuilder,
type MetadataSelectorOpts,
- useQuestionFromCard,
+ useQuestionFromCardBuilder,
} from "metabase/metadata-store";
import { loadMetadataForCard } from "metabase/questions/actions";
import { useDispatch } from "metabase/redux";
@@ -167,7 +167,7 @@ export function AdHocQuestionLoader({
children,
}: AdHocQuestionLoaderProps) {
const dispatch = useDispatch();
- const buildQuestion = useQuestionFromCard(
+ const buildQuestion = useQuestionFromCardBuilder(
includeSensitiveFields ? WITH_SENSITIVE_FIELDS : undefined,
);
diff --git a/frontend/src/metabase/questions/components/SavedQuestionLoader.tsx b/frontend/src/metabase/questions/components/SavedQuestionLoader.tsx
index 7b1f74e4f61..d60a086c7c5 100644
--- a/frontend/src/metabase/questions/components/SavedQuestionLoader.tsx
+++ b/frontend/src/metabase/questions/components/SavedQuestionLoader.tsx
@@ -1,5 +1,5 @@
import type { ReactNode } from "react";
-import { useEffect, useMemo } from "react";
+import { useEffect } from "react";
import { skipToken, useGetCardQuery } from "metabase/api";
import { useQuestionFromCard } from "metabase/metadata-store";
@@ -38,7 +38,6 @@ export function SavedQuestionLoader({
questionId,
children,
}: SavedQuestionLoaderProps) {
- const buildQuestion = useQuestionFromCard();
const dispatch = useDispatch();
const {
@@ -55,12 +54,7 @@ export function SavedQuestionLoader({
}
}, [card, dispatch]);
- const question = useMemo(() => {
- if (!card || isFetching) {
- return null;
- }
- return buildQuestion(card);
- }, [card, isFetching, buildQuestion]);
+ const question = useQuestionFromCard(isFetching ? undefined : card) ?? null;
const loading = isCardLoading || isFetching;
const error = cardError;
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.tsx b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.tsx
index 44d42c4d208..82d692c3f82 100644
--- a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.tsx
+++ b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.tsx
@@ -33,9 +33,9 @@ export function ObjectDetail({
}
}, [data.rows, currentObjectIndex]);
- const buildQuestion = useQuestionFromCard();
+ const cardQuestion = useQuestionFromCard(card);
const hasPagination = data?.rows?.length > 1;
- const resolvedQuestion = question ?? (card ? buildQuestion(card) : undefined);
+ const resolvedQuestion = question ?? cardQuestion;
return (
<>
diff --git a/frontend/src/metabase/visualizations/components/PinMap.tsx b/frontend/src/metabase/visualizations/components/PinMap.tsx
index da9b252c6b2..12b6f8c56c1 100644
--- a/frontend/src/metabase/visualizations/components/PinMap.tsx
+++ b/frontend/src/metabase/visualizations/components/PinMap.tsx
@@ -7,7 +7,7 @@ import _ from "underscore";
import CS from "metabase/css/core/index.css";
import DashboardS from "metabase/css/dashboard.module.css";
-import { useQuestionFromCard } from "metabase/metadata-store";
+import { useQuestionFromCardBuilder } from "metabase/metadata-store";
import { Button } from "metabase/ui";
import type { VisualizationProps } from "metabase/visualizations/types";
import { sumMetric, unaggregatedDataWarningMap } from "metabase/viz-core";
@@ -178,7 +178,7 @@ type PinMapChildProps = LeafletMapProps<PinMapPoint> & {
};
export function PinMap(props: PinMapProps) {
- const buildQuestion = useQuestionFromCard();
+ const buildQuestion = useQuestionFromCardBuilder();
const {
className,
settings,
diff --git a/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx b/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx
index a55e20b9059..0af63600d58 100644
--- a/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx
@@ -25,11 +25,7 @@ const ListVizComponent = ({
isDashboard,
onZoomRow,
}: VisualizationProps & VisualizationPassThroughProps) => {
- const buildQuestion = useQuestionFromCard();
- const question = useMemo(
- () => (card ? buildQuestion(card) : null),
- [card, buildQuestion],
- );
+ const question = useQuestionFromCard(card) ?? null;
const { sortedColumnName, sortingDirection } = useMemo(() => {
if (!question) {
diff --git a/frontend/src/metabase/visualizations/visualizations/Table/Table.tsx b/frontend/src/metabase/visualizations/visualizations/Table/Table.tsx
index acfb1bffd87..e7bbd30823e 100644
--- a/frontend/src/metabase/visualizations/visualizations/Table/Table.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Table/Table.tsx
@@ -4,7 +4,7 @@ import { useLatest } from "react-use";
import { t } from "ttag";
import CS from "metabase/css/core/index.css";
-import { useQuestionFromCard } from "metabase/metadata-store";
+import { useQuestionFromCardBuilder } from "metabase/metadata-store";
import { getSubpathSafeUrl } from "metabase/urls";
import {
type VisibleTableData,
@@ -89,7 +89,7 @@ function TableComponent(props: TableProps) {
* query run, which is when fresh metadata actually needs to be picked up.
*/
function useSyncedQuestion(series: VisualizationProps["series"]) {
- const buildQuestionRef = useLatest(useQuestionFromCard());
+ const buildQuestionRef = useLatest(useQuestionFromCardBuilder());
return useMemo(() => {
const [{ card }] = series;
return buildQuestionRef.current(card);