Skip to content

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

Move the public question and the expression editor off the Metadata object (#82313)

Romeo Van Snick548573f22dee
diff --git a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/testMocks.spec.ts b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/testMocks.spec.ts
index 1409ae4a0a3..190d3cc9ae5 100644
--- a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/testMocks.spec.ts
+++ b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/testMocks.spec.ts
@@ -1,6 +1,6 @@
+import { createMockMetadata } from "__support__/metadata";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
-import { getMetadata } from "metabase/metadata-store";
import {
createMockField,
createMockFieldDimension,
@@ -10,7 +10,6 @@ import {
PRODUCTS,
REVIEWS_ID,
createOrdersTable,
- createPeoplePasswordField,
createPeopleTable,
createProductsTable,
createReviewsTable,
@@ -130,26 +129,4 @@ export const state = createMockState({
}),
});
-export const metadata = getMetadata(state);
-
-const stateWithSearchValuesField = createMockState({
- entities: createMockEntitiesState({
- databases: [
- createSampleDatabase({
- tables: [
- createPeopleTable({
- fields: [
- createPeoplePasswordField({
- has_field_values: "search",
- }),
- ],
- }),
- ],
- }),
- ],
- }),
-});
-
-export const metadataWithSearchValuesField = getMetadata(
- stateWithSearchValuesField,
-);
+export const metadata = createMockMetadata({ databases: [database] });
diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion.tsx b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion.tsx
index abe961e0677..97a4653da4b 100644
--- a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion.tsx
+++ b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion.tsx
@@ -1,5 +1,5 @@
import { useCallback, useEffect, useState } from "react";
-import { useLatest, useMount } from "react-use";
+import { useMount } from "react-use";
import { embedApi, publicApi } from "metabase/api";
import { runRtkEndpoint } from "metabase/api/utils/run-rtk-endpoint";
@@ -8,9 +8,9 @@ import { fetchDataOrError } from "metabase/dashboard/utils";
import { LocaleProvider } from "metabase/embedding/LocaleProvider";
import { EmbeddingEntityContextProvider } from "metabase/embedding/context";
import {
- getMetadata,
paramFieldsFetched,
- selectQuestionFromCardBuilder,
+ selectQuestionFromCard,
+ useQuestionFromCard,
} from "metabase/metadata-store";
import { getParameterValuesByIdFromQueryParams } from "metabase/parameters/utils/parameter-parsing";
import { useEmbedFrameOptions } from "metabase/public/hooks";
@@ -22,9 +22,7 @@ import { setErrorPage } from "metabase/redux/app";
import { useLocation, useParams } from "metabase/router";
import { getCanWhitelabel } from "metabase/selectors/whitelabel";
import { parseSearchQuery } from "metabase/utils/browser";
-import { getCardUiParameters } from "metabase-lib/v1/parameters/utils/cards";
import { getParameterValuesBySlug } from "metabase-lib/v1/parameters/utils/parameter-values";
-import { getParametersFromCard } from "metabase-lib/v1/parameters/utils/template-tags";
import type {
Card,
Dataset,
@@ -41,9 +39,7 @@ export const PublicOrEmbeddedQuestion = () => {
const dispatch = useDispatch();
const store = useStore();
- const metadata = useSelector(getMetadata);
- // we cannot use `metadata` directly otherwise hooks will re-run on every metadata change
- const metadataRef = useLatest(metadata);
+ const buildQuestion = useQuestionFromCard();
const [initialized, setInitialized] = useState(false);
@@ -85,12 +81,10 @@ export const PublicOrEmbeddedQuestion = () => {
await dispatch(paramFieldsFetched(card.param_fields));
}
- const parameters = getCardUiParameters(
+ const parameters = selectQuestionFromCard(
+ store.getState(),
card,
- metadataRef.current,
- {},
- card.parameters || undefined,
- );
+ ).parameters();
const parameterValuesById = getParameterValuesByIdFromQueryParams(
parameters,
parseSearchQuery(location.search),
@@ -125,8 +119,13 @@ export const PublicOrEmbeddedQuestion = () => {
return;
}
- const parameters =
- card.parameters || getParametersFromCard(card, metadataRef.current);
+ // This page loads its card from `GET /api/public/card/:uuid` or from
+ // `GET /api/embed/card/:token`. Both fold the native query's template tags
+ // into `parameters`, then blank the `dataset_query` they return. So
+ // `parameters` is always the complete set, and deriving it from the query
+ // would find nothing left to read.
+ const parameters = card.parameters ?? [];
+ const question = selectQuestionFromCard(store.getState(), card);
try {
setResult(null);
@@ -138,7 +137,7 @@ export const PublicOrEmbeddedQuestion = () => {
// embeds apply parameter values server-side
resultPromise = runQuery(
embedApi.endpoints.getEmbedCardQuery,
- selectQuestionFromCardBuilder(store.getState())(card),
+ question,
{
token,
parameters: JSON.stringify(
@@ -157,7 +156,7 @@ export const PublicOrEmbeddedQuestion = () => {
);
resultPromise = runQuery(
publicApi.endpoints.getPublicCardQuery,
- selectQuestionFromCardBuilder(store.getState())(card),
+ question,
{
uuid,
parameters: JSON.stringify(datasetQuery.parameters),
@@ -183,7 +182,7 @@ export const PublicOrEmbeddedQuestion = () => {
console.error("error", error);
dispatch(setErrorPage(error));
}
- }, [card, metadataRef, store, dispatch, parameterValues, token, uuid]);
+ }, [card, store, dispatch, parameterValues, token, uuid]);
useEffect(() => {
run();
@@ -194,12 +193,7 @@ export const PublicOrEmbeddedQuestion = () => {
return [];
}
- return getCardUiParameters(
- card,
- metadataRef.current,
- {},
- card.parameters || undefined,
- );
+ return buildQuestion(card).parameters();
};
return (
@@ -211,7 +205,6 @@ export const PublicOrEmbeddedQuestion = () => {
<PublicOrEmbeddedQuestionView
initialized={initialized}
card={card}
- metadata={metadata}
result={result}
getParameters={getParameters}
parameterValues={parameterValues}
diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/tests/PublicOrEmbeddedQuestion.common.unit.spec.tsx b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/tests/PublicOrEmbeddedQuestion.common.unit.spec.tsx
index 80a6fc5c26b..7d917b87bb8 100644
--- a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/tests/PublicOrEmbeddedQuestion.common.unit.spec.tsx
+++ b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/tests/PublicOrEmbeddedQuestion.common.unit.spec.tsx
@@ -1,7 +1,10 @@
import userEvent from "@testing-library/user-event";
+import fetchMock from "fetch-mock";
import { setupLastDownloadFormatEndpoints } from "__support__/server-mocks";
import { screen, waitForLoaderToBeRemoved } from "__support__/ui";
+import { createMockParameter } from "metabase-types/api/mocks";
+import { PRODUCTS } from "metabase-types/api/mocks/presets";
import { type SetupOpts, setup } from "./setup";
@@ -42,4 +45,30 @@ describe("PublicOrEmbeddedQuestion", () => {
JSON.stringify({ foo: "bar" }),
);
});
+
+ it("should show the card's parameters and run the query with their values from the URL", async () => {
+ const parameter = createMockParameter({
+ id: "category-id",
+ name: "Category",
+ slug: "category",
+ type: "string/=",
+ target: ["dimension", ["field", PRODUCTS.CATEGORY, null]],
+ });
+ await setupCommon({
+ card: { parameters: [parameter] },
+ search: { category: "Gizmo" },
+ });
+
+ const widget = await screen.findByTestId("parameter-widget");
+ expect(widget).toHaveTextContent("Category");
+ expect(widget).toHaveTextContent("Gizmo");
+
+ const queryUrl = fetchMock.callHistory.lastCall(
+ `path:/api/public/card/${FAKE_UUID}/query`,
+ )?.url;
+ const parameters = new URL(String(queryUrl)).searchParams.get("parameters");
+ expect(JSON.parse(String(parameters))).toEqual([
+ { id: "category-id", value: ["Gizmo"] },
+ ]);
+ });
});
diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/tests/setup.tsx b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/tests/setup.tsx
index 68108d651b9..cd429976553 100644
--- a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/tests/setup.tsx
+++ b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/tests/setup.tsx
@@ -15,7 +15,7 @@ import {
import { Route } from "metabase/router";
import { registerStaticVisualizations } from "metabase/static-viz/register";
import type { VisualizationProps } from "metabase/visualizations/types";
-import type { TokenFeatures } from "metabase-types/api";
+import type { PublicCard, TokenFeatures } from "metabase-types/api";
import {
createMockEmbedDataset,
createMockPublicCard,
@@ -63,6 +63,8 @@ jest.mock(
export type SetupOpts = {
hash?: Record<string, string>;
+ search?: Record<string, string>;
+ card?: Partial<PublicCard>;
tokenFeatures?: TokenFeatures;
questionName: string;
uuid: string;
@@ -72,6 +74,8 @@ export type SetupOpts = {
export async function setup(
{
hash = {},
+ search = {},
+ card,
tokenFeatures = createMockTokenFeatures(),
questionName,
uuid,
@@ -88,7 +92,7 @@ export async function setup(
setupPublicQuestionEndpoints(
uuid,
- createMockPublicCard({ name: questionName }),
+ createMockPublicCard({ ...card, name: questionName }),
);
setupPublicCardQueryEndpoints(
uuid,
@@ -105,7 +109,7 @@ export async function setup(
{
storeInitialState: createMockState({ settings }),
withRouter: true,
- initialRoute: `public/question/${uuid}${_.isEmpty(hash) ? "" : `#${new URLSearchParams(hash)}`}`,
+ initialRoute: `public/question/${uuid}${_.isEmpty(search) ? "" : `?${new URLSearchParams(search)}`}${_.isEmpty(hash) ? "" : `#${new URLSearchParams(hash)}`}`,
},
);
expect(await screen.findByText(questionName)).toBeInTheDocument();
diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.stories.tsx b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.stories.tsx
index 7edb51e9f20..38fb8ebeb91 100644
--- a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.stories.tsx
+++ b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.stories.tsx
@@ -6,7 +6,6 @@ import { HttpResponse, http } from "msw";
import type { ComponentProps } from "react";
import { getPublicStore } from "__support__/entities-store";
-import { createMockMetadata } from "__support__/metadata";
import { createMockSettingsState, createMockState } from "__support__/state";
import { createWaitForResizeToStopDecorator } from "__support__/storybook";
import { getNextId } from "__support__/utils";
@@ -95,7 +94,6 @@ const defaultArgs: Partial<
ComponentProps<typeof PublicOrEmbeddedQuestionView>
> = {
card: createMockCard({ id: CARD_BAR_ID, name: "Bar", display: "bar" }),
- metadata: createMockMetadata({}),
titled: true,
bordered: true,
getParameters: () => [],
diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.tsx b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.tsx
index baf6d2af4ee..a2796940643 100644
--- a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.tsx
+++ b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.tsx
@@ -6,11 +6,11 @@ import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErr
import { PLUGIN_CONTENT_TRANSLATION } from "metabase/content-translation/plugins";
import CS from "metabase/css/core/index.css";
import type { DisplayTheme } from "metabase/embedding/types";
+import { useQuestionFromCard } from "metabase/metadata-store";
import { EmbedFrame } from "metabase/public/components/EmbedFrame";
import { PublicOrEmbeddedQuestionDownloadPopover } from "metabase/query_builder";
import Visualization from "metabase/visualizations/components/Visualization";
import Question from "metabase-lib/v1/Question";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type { UiParameter } from "metabase-lib/v1/parameters/types";
import type {
Card,
@@ -27,7 +27,6 @@ import { publicClickActionMode } from "../../PublicMode";
export interface PublicOrEmbeddedQuestionViewProps {
initialized: boolean;
card: Card | null;
- metadata: Metadata;
result: Dataset | null;
getParameters: () => UiParameter[];
parameterValues: ParameterValuesMap;
@@ -43,7 +42,6 @@ export interface PublicOrEmbeddedQuestionViewProps {
export function PublicOrEmbeddedQuestionView({
card,
- metadata,
result,
getParameters,
parameterValues,
@@ -56,7 +54,9 @@ export function PublicOrEmbeddedQuestionView({
setCard,
downloadsEnabled,
}: PublicOrEmbeddedQuestionViewProps) {
- const question = new Question(card, metadata);
+ const buildQuestion = useQuestionFromCard();
+ // EmbedFrame lays out a question frame before the card loads.
+ const question = card ? buildQuestion(card) : new Question(null);
const isTable = question.display() === "table";
const downloadInFooter = !titled && isTable;
diff --git a/frontend/src/metabase/querying/components/expressions/Editor/Editor.tsx b/frontend/src/metabase/querying/components/expressions/Editor/Editor.tsx
index 04a18cc877e..58f9074c7ba 100644
--- a/frontend/src/metabase/querying/components/expressions/Editor/Editor.tsx
+++ b/frontend/src/metabase/querying/components/expressions/Editor/Editor.tsx
@@ -11,7 +11,7 @@ import {
CodeMirror,
type CodeMirrorRef,
} from "metabase/common/components/CodeMirror";
-import { getMetadata } from "metabase/metadata-store";
+import { getShallowDatabases } from "metabase/metadata-store";
import {
type ExpressionError,
diagnoseAndCompile,
@@ -22,8 +22,8 @@ import { tokenAtPos } from "metabase/querying/expressions";
import { COMMA, GROUP } from "metabase/querying/expressions/pratt";
import { useSelector } from "metabase/redux";
import { Button, Tooltip as ButtonTooltip, Flex, Icon } from "metabase/ui";
-import type * as Lib from "metabase-lib";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import * as Lib from "metabase-lib";
+import type { Database } from "metabase-types/api";
import { FunctionBrowser } from "../FunctionBrowser";
import { LayoutMain, LayoutSidebar } from "../Layout";
@@ -85,7 +85,10 @@ export function Editor(props: EditorProps) {
} = props;
const ref = useRef<CodeMirrorRef>(null);
- const metadata = useSelector(getMetadata);
+ const databaseId = Lib.databaseID(query);
+ const database = useSelector((state) =>
+ databaseId != null ? getShallowDatabases(state)[databaseId] : undefined,
+ );
const [isFunctionBrowserOpen, { toggle: toggleFunctionBrowser }] =
useDisclosure();
@@ -99,7 +102,7 @@ export function Editor(props: EditorProps) {
isValidated,
} = useExpression({
...props,
- metadata,
+ database,
error,
});
@@ -113,7 +116,7 @@ export function Editor(props: EditorProps) {
<Tooltip
query={query}
stageIndex={stageIndex}
- metadata={metadata}
+ database={database}
reportTimezone={reportTimezone}
expressionMode={expressionMode}
{...props}
@@ -127,7 +130,7 @@ export function Editor(props: EditorProps) {
stageIndex,
availableColumns,
availableMetrics,
- metadata,
+ database,
extensions: [customTooltip],
});
@@ -256,11 +259,11 @@ function useExpression({
query,
availableColumns,
availableMetrics,
- metadata,
+ database,
onChange,
initialClause,
}: EditorProps & {
- metadata: Metadata;
+ database: Pick<Database, "features"> | undefined;
}) {
const [source, setSource] = useState("");
const [initialSource, setInitialSource] = useState("");
@@ -326,7 +329,7 @@ function useExpression({
query,
stageIndex,
expressionIndex,
- metadata,
+ database,
availableColumns,
availableMetrics,
});
@@ -342,7 +345,7 @@ function useExpression({
stageIndex,
expressionMode,
expressionIndex,
- metadata,
+ database,
handleChange,
debouncedOnChange,
availableColumns,
diff --git a/frontend/src/metabase/querying/components/expressions/Editor/HelpText/HelpText.stories.tsx b/frontend/src/metabase/querying/components/expressions/Editor/HelpText/HelpText.stories.tsx
index 6ce2a11643f..058da8e2e16 100644
--- a/frontend/src/metabase/querying/components/expressions/Editor/HelpText/HelpText.stories.tsx
+++ b/frontend/src/metabase/querying/components/expressions/Editor/HelpText/HelpText.stories.tsx
@@ -1,12 +1,6 @@
import type { StoryFn } from "@storybook/react";
-import { createMockMetadata } from "__support__/metadata";
import { ReduxProvider } from "__support__/storybook";
-import * as Lib from "metabase-lib";
-import {
- DEFAULT_TEST_QUERY,
- createMetadataProvider,
-} from "metabase-lib/test-helpers";
import { createMockDatabase } from "metabase-types/api/mocks";
import { HelpText } from "./HelpText";
@@ -18,18 +12,11 @@ export default {
const Template: StoryFn<typeof HelpText> = () => {
const database = createMockDatabase();
- const metadata = createMockMetadata({ databases: [database] });
- const provider = createMetadataProvider({
- databaseId: database.id,
- metadata,
- });
- const query = Lib.createTestQuery(provider, DEFAULT_TEST_QUERY);
return (
<ReduxProvider>
<HelpText
- query={query}
- metadata={metadata}
+ database={database}
enclosingFunction={{
name: "datetime-diff",
arg: null,
diff --git a/frontend/src/metabase/querying/components/expressions/Editor/HelpText/HelpText.tsx b/frontend/src/metabase/querying/components/expressions/Editor/HelpText/HelpText.tsx
index 3a6918d8207..25d064de5af 100644
--- a/frontend/src/metabase/querying/components/expressions/Editor/HelpText/HelpText.tsx
+++ b/frontend/src/metabase/querying/components/expressions/Editor/HelpText/HelpText.tsx
@@ -19,8 +19,8 @@ import {
getHelpText,
} from "metabase/querying/expressions";
import { Box, Flex, Icon, UnstyledButton } from "metabase/ui";
-import * as Lib from "metabase-lib";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type * as Lib from "metabase-lib";
+import type { Database } from "metabase-types/api";
import {
HighlightExpressionParts,
@@ -46,17 +46,11 @@ export type HelpTextProps = {
index: number;
} | null;
} | null;
- query: Lib.Query;
- metadata: Metadata;
+ database: Pick<Database, "engine" | "features"> | undefined;
reportTimezone?: string;
expressionMode: Lib.ExpressionMode;
};
-function getDatabase(query: Lib.Query, metadata: Metadata) {
- const databaseId = Lib.databaseID(query);
- return metadata.database(databaseId);
-}
-
const components = {
code(props: { children: ReactNode }) {
const children = Children.toArray(props.children);
@@ -78,12 +72,10 @@ export function HelpText({
open = true,
onToggle,
enclosingFunction,
- query,
- metadata,
+ database,
reportTimezone,
expressionMode,
}: HelpTextProps) {
- const database = getDatabase(query, metadata);
const helpText =
enclosingFunction && database
? getHelpText(enclosingFunction.name, database, reportTimezone)
diff --git a/frontend/src/metabase/querying/components/expressions/Editor/HelpText/tests/setup.tsx b/frontend/src/metabase/querying/components/expressions/Editor/HelpText/tests/setup.tsx
index a3c07c7a0a0..b7a7a6ddda7 100644
--- a/frontend/src/metabase/querying/components/expressions/Editor/HelpText/tests/setup.tsx
+++ b/frontend/src/metabase/querying/components/expressions/Editor/HelpText/tests/setup.tsx
@@ -1,21 +1,13 @@
import { setupEnterpriseOnlyPlugin } from "__support__/enterprise";
-import { createMockMetadata } from "__support__/metadata";
import { mockSettings } from "__support__/settings";
import { createMockState } from "__support__/state";
import { renderWithProviders, screen, waitFor } from "__support__/ui";
import { getHelpText } from "metabase/querying/expressions";
import { checkNotNull } from "metabase/utils/types";
-import * as Lib from "metabase-lib";
-import {
- DEFAULT_TEST_QUERY,
- createMetadataProvider,
-} from "metabase-lib/test-helpers";
+import type * as Lib from "metabase-lib";
import type { TokenFeatures } from "metabase-types/api";
import { createMockTokenFeatures } from "metabase-types/api/mocks";
-import {
- SAMPLE_DB_ID,
- createSampleDatabase,
-} from "metabase-types/api/mocks/presets";
+import { createSampleDatabase } from "metabase-types/api/mocks/presets";
import { HelpText, type HelpTextProps } from "../HelpText";
@@ -44,13 +36,7 @@ export async function setup({
}),
});
- const metadata = createMockMetadata({ databases: [createSampleDatabase()] });
- const provider = createMetadataProvider({
- databaseId: SAMPLE_DB_ID,
- metadata,
- });
- const database = checkNotNull(metadata.database(SAMPLE_DB_ID));
- const query = Lib.createTestQuery(provider, DEFAULT_TEST_QUERY);
+ const database = createSampleDatabase();
const props: HelpTextProps = {
enclosingFunction: {
@@ -58,8 +44,7 @@ export async function setup({
name: "concat",
...enclosingFunction,
},
- query,
- metadata,
+ database,
reportTimezone,
expressionMode,
};
@@ -85,5 +70,5 @@ export async function setup({
reportTimezone,
);
- return { database, metadata, helpText };
+ return { database, helpText };
}
diff --git a/frontend/src/metabase/querying/components/expressions/Editor/Tooltip/Tooltip.tsx b/frontend/src/metabase/querying/components/expressions/Editor/Tooltip/Tooltip.tsx
index bcd05dccea0..c28a7e698f2 100644
--- a/frontend/src/metabase/querying/components/expressions/Editor/Tooltip/Tooltip.tsx
+++ b/frontend/src/metabase/querying/components/expressions/Editor/Tooltip/Tooltip.tsx
@@ -11,7 +11,7 @@ import {
import { enclosingFunction } from "metabase/querying/expressions";
import { Popover } from "metabase/ui";
import type * as Lib from "metabase-lib";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { Database } from "metabase-types/api";
import { HelpText } from "../HelpText";
import { Listbox, useCompletions } from "../Listbox";
@@ -21,7 +21,7 @@ import S from "./Tooltip.module.css";
export function Tooltip({
query,
stageIndex,
- metadata,
+ database,
reportTimezone,
tooltipRef,
expressionMode,
@@ -31,7 +31,7 @@ export function Tooltip({
}: {
query: Lib.Query;
stageIndex: number;
- metadata: Metadata;
+ database: Pick<Database, "engine" | "features"> | undefined;
reportTimezone?: string;
expressionMode: Lib.ExpressionMode;
@@ -101,8 +101,7 @@ export function Tooltip({
<div className={S.tooltip} ref={tooltipRef}>
<HelpText
enclosingFunction={enclosingFn}
- query={query}
- metadata={metadata}
+ database={database}
reportTimezone={reportTimezone}
open={shouldShowHelpText}
onToggle={handleToggleHelpText}
diff --git a/frontend/src/metabase/querying/components/expressions/Editor/extensions.ts b/frontend/src/metabase/querying/components/expressions/Editor/extensions.ts
index 2abfc09030b..e297c4f13f9 100644
--- a/frontend/src/metabase/querying/components/expressions/Editor/extensions.ts
+++ b/frontend/src/metabase/querying/components/expressions/Editor/extensions.ts
@@ -5,7 +5,7 @@ import { useMemo } from "react";
import { suggestions } from "metabase/querying/expressions";
import { isNotNull } from "metabase/utils/types";
import type * as Lib from "metabase-lib";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { Database } from "metabase-types/api";
import S from "./Editor.module.css";
import { customExpression } from "./language";
@@ -16,7 +16,7 @@ type Options = {
stageIndex: number;
availableColumns: Lib.ColumnMetadata[];
availableMetrics?: Lib.MetricMetadata[];
- metadata: Metadata;
+ database: Pick<Database, "features"> | undefined;
extensions?: Extension[];
};
@@ -40,7 +40,7 @@ export function useExtensions(options: Options): Extension[] {
stageIndex,
availableColumns,
availableMetrics,
- metadata,
+ database,
extensions: extra = [],
} = options;
@@ -52,7 +52,7 @@ export function useExtensions(options: Options): Extension[] {
stageIndex,
availableColumns,
availableMetrics,
- metadata,
+ database,
}),
expander(),
suggestions({
@@ -61,7 +61,7 @@ export function useExtensions(options: Options): Extension[] {
expressionMode,
availableColumns,
availableMetrics,
- metadata,
+ database,
}),
tooltips({
position: "fixed",
@@ -77,7 +77,7 @@ export function useExtensions(options: Options): Extension[] {
query,
stageIndex,
availableColumns,
- metadata,
+ database,
// eslint-disable-next-line react-hooks/exhaustive-deps
...extra,
]);
diff --git a/frontend/src/metabase/querying/components/expressions/Editor/language.ts b/frontend/src/metabase/querying/components/expressions/Editor/language.ts
index bff77a522b2..e4e938b8cf9 100644
--- a/frontend/src/metabase/querying/components/expressions/Editor/language.ts
+++ b/frontend/src/metabase/querying/components/expressions/Editor/language.ts
@@ -8,7 +8,7 @@ import {
} from "metabase/querying/expressions";
import { parser } from "metabase/querying/expressions/tokenizer/parser";
import type * as Lib from "metabase-lib";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { Database } from "metabase-types/api";
import { DEBOUNCE_VALIDATION_MS } from "./constants";
import { hasActiveSnippet } from "./utils";
@@ -24,7 +24,7 @@ type LintOptions = {
stageIndex: number;
availableColumns: Lib.ColumnMetadata[];
availableMetrics?: Lib.MetricMetadata[];
- metadata: Metadata;
+ database: Pick<Database, "features"> | undefined;
};
const lint = (options: LintOptions) =>
diff --git a/frontend/src/metabase/querying/components/expressions/ExpressionWidget/ExpressionWidget.unit.spec.tsx b/frontend/src/metabase/querying/components/expressions/ExpressionWidget/ExpressionWidget.unit.spec.tsx
index 87a61b1ff4b..3b933356b78 100644
--- a/frontend/src/metabase/querying/components/expressions/ExpressionWidget/ExpressionWidget.unit.spec.tsx
+++ b/frontend/src/metabase/querying/components/expressions/ExpressionWidget/ExpressionWidget.unit.spec.tsx
@@ -1,8 +1,12 @@
import userEvent from "@testing-library/user-event";
+import { createMockState } from "__support__/state";
+import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen, waitFor } from "__support__/ui";
import * as Lib from "metabase-lib";
import { DEFAULT_TEST_QUERY, SAMPLE_PROVIDER } from "metabase-lib/test-helpers";
+import type { DatabaseFeature } from "metabase-types/api";
+import { createSampleDatabase } from "metabase-types/api/mocks/presets";
import type { ExpressionWidgetProps } from "./ExpressionWidget";
import { ExpressionWidget } from "./ExpressionWidget";
@@ -161,9 +165,40 @@ describe("ExpressionWidget", () => {
await screen.findByText('Expecting operator but got "test" instead');
});
});
+
+ describe("functions the query's database supports", () => {
+ const expression = "Percentile([Total], 0.5)";
+
+ it("should accept a function when the database has its feature", async () => {
+ await setup({ expressionMode: "aggregation" }, [
+ "percentile-aggregations",
+ ]);
+
+ await userEvent.paste(expression);
+ await userEvent.tab();
+
+ const doneButton = screen.getByRole("button", { name: "Done" });
+ await waitFor(() => expect(doneButton).toBeEnabled());
+ });
+
+ it("should reject a function when the database lacks its feature", async () => {
+ await setup({ expressionMode: "aggregation" }, []);
+
+ await userEvent.paste(expression);
+ await userEvent.tab();
+
+ const doneButton = screen.getByRole("button", { name: "Done" });
+ expect(doneButton).toBeDisabled();
+
+ await screen.findByText("Unsupported function Percentile");
+ });
+ });
});
-async function setup(additionalProps?: Partial<ExpressionWidgetProps>) {
+async function setup(
+ additionalProps?: Partial<ExpressionWidgetProps>,
+ databaseFeatures?: DatabaseFeature[],
+) {
const query = Lib.createTestQuery(SAMPLE_PROVIDER, DEFAULT_TEST_QUERY);
const stageIndex = 0;
const availableColumns = Lib.expressionableColumns(query, stageIndex);
@@ -192,6 +227,13 @@ async function setup(additionalProps?: Partial<ExpressionWidgetProps>) {
onClose={onClose}
{...additionalProps}
/>,
+ databaseFeatures && {
+ storeInitialState: createMockState({
+ entities: createMockEntitiesState({
+ databases: [createSampleDatabase({ features: databaseFeatures })],
+ }),
+ }),
+ },
);
await waitFor(() =>
expect(screen.getByTestId("custom-expression-query-editor")).toHaveProperty(
diff --git a/frontend/src/metabase/querying/expressions/diagnostics/diagnostics.ts b/frontend/src/metabase/querying/expressions/diagnostics/diagnostics.ts
index fbeb8b7ed60..1915224e088 100644
--- a/frontend/src/metabase/querying/expressions/diagnostics/diagnostics.ts
+++ b/frontend/src/metabase/querying/expressions/diagnostics/diagnostics.ts
@@ -1,5 +1,5 @@
import type * as Lib from "metabase-lib";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { Database } from "metabase-types/api";
import { compileExpression } from "../compile-expression";
import type { ExpressionError } from "../errors";
@@ -16,7 +16,7 @@ type Options = {
expressionIndex?: number;
availableColumns: Lib.ColumnMetadata[];
availableMetrics?: Lib.MetricMetadata[];
- metadata?: Metadata;
+ database?: Pick<Database, "features">;
};
export type SyntaxDiagnoser = (tokens: Token[]) => void;
diff --git a/frontend/src/metabase/querying/expressions/diagnostics/diagnostics.unit.spec.ts b/frontend/src/metabase/querying/expressions/diagnostics/diagnostics.unit.spec.ts
index 88049880fa5..d358e15ec85 100644
--- a/frontend/src/metabase/querying/expressions/diagnostics/diagnostics.unit.spec.ts
+++ b/frontend/src/metabase/querying/expressions/diagnostics/diagnostics.unit.spec.ts
@@ -1,6 +1,5 @@
-import { createMockMetadata } from "__support__/metadata";
import * as Lib from "metabase-lib";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { Database } from "metabase-types/api";
import { createSampleDatabase } from "metabase-types/api/mocks/presets";
import { query, stageIndex } from "../test/shared";
@@ -12,11 +11,11 @@ describe("diagnostics", () => {
function setup({
expression,
expressionMode = "expression",
- metadata,
+ database,
}: {
expression: string;
expressionMode?: Lib.ExpressionMode;
- metadata?: Metadata;
+ database?: Pick<Database, "features">;
}) {
return diagnose({
source: expression,
@@ -24,16 +23,16 @@ describe("diagnostics", () => {
query,
stageIndex,
availableColumns: Lib.expressionableColumns(query, stageIndex),
- metadata,
+ database,
});
}
function err(
expression: string,
expressionMode: Lib.ExpressionMode = "expression",
- metadata?: Metadata,
+ database?: Pick<Database, "features">,
) {
- return setup({ expression, expressionMode, metadata })?.message;
+ return setup({ expression, expressionMode, database })?.message;
}
it("should catch mismatched parentheses after function", () => {
@@ -272,34 +271,20 @@ describe("diagnostics", () => {
});
it("should reject unsupported function (metabase#39773)", () => {
- const metadata = createMockMetadata({
- databases: [
- createSampleDatabase({
- id: 1,
- features: ["left-join"],
- }),
- ],
- });
+ const database = createSampleDatabase({ features: ["left-join"] });
- expect(err(`percentile(1, 2)`, "expression", metadata)).toBe(
+ expect(err(`percentile(1, 2)`, "expression", database)).toBe(
"Unsupported function Percentile",
);
});
it("should correctly pass along the position of the error", () => {
- const metadata = createMockMetadata({
- databases: [
- createSampleDatabase({
- id: 1,
- features: ["left-join"],
- }),
- ],
- });
+ const database = createSampleDatabase({ features: ["left-join"] });
const error = setup({
expression: `10 + percentile(1, 2)`,
expressionMode: "expression",
- metadata,
+ database,
});
expect(error?.pos).toBe(5);
diff --git a/frontend/src/metabase/querying/expressions/diagnostics/expression/check-supported-functions.ts b/frontend/src/metabase/querying/expressions/diagnostics/expression/check-supported-functions.ts
index 31f99c31807..28e6ebc149a 100644
--- a/frontend/src/metabase/querying/expressions/diagnostics/expression/check-supported-functions.ts
+++ b/frontend/src/metabase/querying/expressions/diagnostics/expression/check-supported-functions.ts
@@ -2,27 +2,19 @@ import { t } from "ttag";
import { hasRequiredFeature } from "metabase/databases";
import * as Lib from "metabase-lib";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { Database } from "metabase-types/api";
import { getClauseDefinition } from "../../clause";
-import { getDatabase } from "../../utils";
import { visit } from "../../visitor";
import { error } from "../utils";
export function checkSupportedFunctions({
expressionParts,
- query,
- metadata,
+ database,
}: {
expressionParts: Lib.ExpressionParts | Lib.ExpressionArg;
- query: Lib.Query;
- metadata?: Metadata;
+ database?: Pick<Database, "features">;
}) {
- if (!metadata) {
- return;
- }
-
- const database = getDatabase(query, metadata);
if (!database) {
return;
}
diff --git a/frontend/src/metabase/querying/expressions/diagnostics/expression/index.ts b/frontend/src/metabase/querying/expressions/diagnostics/expression/index.ts
index 04cb3e566f7..9e1a8e5499d 100644
--- a/frontend/src/metabase/querying/expressions/diagnostics/expression/index.ts
+++ b/frontend/src/metabase/querying/expressions/diagnostics/expression/index.ts
@@ -1,5 +1,5 @@
import type * as Lib from "metabase-lib";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { Database } from "metabase-types/api";
import { checkArgCount } from "./check-arg-count";
import { checkArgValidators } from "./check-arg-validators";
@@ -28,7 +28,7 @@ export function diagnoseExpression(options: {
expressionClause: Lib.ExpressionClause;
expressionParts: Lib.ExpressionParts | Lib.ExpressionArg;
expressionIndex?: number;
- metadata?: Metadata;
+ database?: Pick<Database, "features">;
}) {
expressionChecks.forEach((check) => check(options));
}
diff --git a/frontend/src/metabase/querying/expressions/suggestions/aggregations.ts b/frontend/src/metabase/querying/expressions/suggestions/aggregations.ts
index 7fac05c5515..71e54e9b859 100644
--- a/frontend/src/metabase/querying/expressions/suggestions/aggregations.ts
+++ b/frontend/src/metabase/querying/expressions/suggestions/aggregations.ts
@@ -1,12 +1,11 @@
import type { CompletionContext } from "@codemirror/autocomplete";
import type * as Lib from "metabase-lib";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { Database } from "metabase-types/api";
import { getSupportedClauses } from "../clause";
import { tokenAtPos } from "../position";
import { GROUP } from "../pratt";
-import { getDatabase } from "../utils";
import {
expressionClauseCompletion,
@@ -16,21 +15,15 @@ import {
} from "./util";
export type Options = {
- query: Lib.Query;
expressionMode: Lib.ExpressionMode;
- metadata: Metadata;
+ database: Pick<Database, "features"> | undefined;
};
-export function suggestAggregations({
- expressionMode,
- query,
- metadata,
-}: Options) {
+export function suggestAggregations({ expressionMode, database }: Options) {
if (expressionMode !== "aggregation") {
return null;
}
- const database = getDatabase(query, metadata);
const aggregations = getSupportedClauses({ expressionMode, database }).map(
(agg) => expressionClauseCompletion(agg, { type: "aggregation" }),
);
diff --git a/frontend/src/metabase/querying/expressions/suggestions/aggregations.unit.spec.ts b/frontend/src/metabase/querying/expressions/suggestions/aggregations.unit.spec.ts
index aa803934b06..32cacdf2cec 100644
--- a/frontend/src/metabase/querying/expressions/suggestions/aggregations.unit.spec.ts
+++ b/frontend/src/metabase/querying/expressions/suggestions/aggregations.unit.spec.ts
@@ -1,9 +1,3 @@
-import { createMockMetadata } from "__support__/metadata";
-import * as Lib from "metabase-lib";
-import {
- DEFAULT_TEST_QUERY,
- createMetadataProvider,
-} from "metabase-lib/test-helpers";
import type { DatabaseFeature } from "metabase-types/api";
import { createSampleDatabase } from "metabase-types/api/mocks/presets";
@@ -17,19 +11,9 @@ describe("suggestAggregations", () => {
}: Partial<Options> & {
features?: DatabaseFeature[];
}) {
- const metadata = createMockMetadata({
- databases: [
- createSampleDatabase({
- features,
- }),
- ],
- });
- const provider = createMetadataProvider({ metadata });
- const query = Lib.createTestQuery(provider, DEFAULT_TEST_QUERY);
const source = suggestAggregations({
expressionMode,
- query,
- metadata,
+ database: createSampleDatabase({ features }),
});
return function (doc: string) {
diff --git a/frontend/src/metabase/querying/expressions/suggestions/functions.ts b/frontend/src/metabase/querying/expressions/suggestions/functions.ts
index e7ee5d2a68d..f3ba06decb6 100644
--- a/frontend/src/metabase/querying/expressions/suggestions/functions.ts
+++ b/frontend/src/metabase/querying/expressions/suggestions/functions.ts
@@ -1,7 +1,7 @@
import type { CompletionContext } from "@codemirror/autocomplete";
import type * as Lib from "metabase-lib";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { Database } from "metabase-types/api";
import { getSupportedClauses } from "../clause";
import { tokenAtPos } from "../position";
@@ -12,7 +12,6 @@ import {
LOGICAL_OR,
type Token,
} from "../pratt";
-import { getDatabase } from "../utils";
import {
expressionClauseCompletion,
@@ -23,16 +22,14 @@ import {
export type Options = {
expressionMode: Lib.ExpressionMode;
- query: Lib.Query;
- metadata: Metadata;
+ database: Pick<Database, "features"> | undefined;
};
-export function suggestFunctions({ expressionMode, query, metadata }: Options) {
+export function suggestFunctions({ expressionMode, database }: Options) {
if (expressionMode !== "expression" && expressionMode !== "filter") {
return null;
}
- const database = getDatabase(query, metadata);
const functions = getSupportedClauses({ expressionMode, database }).map(
(func) => expressionClauseCompletion(func, { type: "function" }),
);
diff --git a/frontend/src/metabase/querying/expressions/suggestions/functions.unit.spec.ts b/frontend/src/metabase/querying/expressions/suggestions/functions.unit.spec.ts
index ea94322a615..9ab03dfc994 100644
--- a/frontend/src/metabase/querying/expressions/suggestions/functions.unit.spec.ts
+++ b/frontend/src/metabase/querying/expressions/suggestions/functions.unit.spec.ts
@@ -1,9 +1,3 @@
-import { createMockMetadata } from "__support__/metadata";
-import * as Lib from "metabase-lib";
-import {
- DEFAULT_TEST_QUERY,
- createMetadataProvider,
-} from "metabase-lib/test-helpers";
import type { DatabaseFeature } from "metabase-types/api";
import { createSampleDatabase } from "metabase-types/api/mocks/presets";
@@ -17,19 +11,9 @@ describe("suggestFunctions", () => {
}: Partial<Options> & {
features?: DatabaseFeature[];
}) {
- const metadata = createMockMetadata({
- databases: [
- createSampleDatabase({
- features,
- }),
- ],
- });
- const provider = createMetadataProvider({ metadata });
- const query = Lib.createTestQuery(provider, DEFAULT_TEST_QUERY);
const source = suggestFunctions({
expressionMode,
- query,
- metadata,
+ database: createSampleDatabase({ features }),
});
return function (doc: string) {
diff --git a/frontend/src/metabase/querying/expressions/suggestions/suggest.ts b/frontend/src/metabase/querying/expressions/suggestions/suggest.ts
index 269a33e8579..28a3e3f1f0e 100644
--- a/frontend/src/metabase/querying/expressions/suggestions/suggest.ts
+++ b/frontend/src/metabase/querying/expressions/suggestions/suggest.ts
@@ -2,12 +2,12 @@ import { autocompletion } from "@codemirror/autocomplete";
import { isNotNull } from "metabase/utils/types";
import type * as Lib from "metabase-lib";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { Database } from "metabase-types/api";
export type SuggestOptions = {
query: Lib.Query;
stageIndex: number;
- metadata: Metadata;
+ database: Pick<Database, "features"> | undefined;
expressionMode: Lib.ExpressionMode;
availableColumns: Lib.ColumnMetadata[];
availableMetrics?: Lib.MetricMetadata[];
diff --git a/frontend/src/metabase/querying/expressions/utils.ts b/frontend/src/metabase/querying/expressions/utils.ts
index 19acb8aaabf..d28cedb49d4 100644
--- a/frontend/src/metabase/querying/expressions/utils.ts
+++ b/frontend/src/metabase/querying/expressions/utils.ts
@@ -1,18 +1,6 @@
-import * as Lib from "metabase-lib";
-import type Database from "metabase-lib/v1/metadata/Database";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
-
import { CompileError } from "./errors";
import type { Node } from "./pratt";
-export function getDatabase(
- query: Lib.Query,
- metadata?: Metadata,
-): Database | null {
- const databaseId = Lib.databaseID(query);
- return metadata?.database(databaseId) ?? null;
-}
-
/**
* Assert compiler invariants and assumptions.
* Throws a non-friendly error if the condition is false.
diff --git a/frontend/test/__support__/custom-viz-fixtures/CalendarHeatmap.question.stories.tsx b/frontend/test/__support__/custom-viz-fixtures/CalendarHeatmap.question.stories.tsx
index f1eb034c5e2..4a66a80b20a 100644
--- a/frontend/test/__support__/custom-viz-fixtures/CalendarHeatmap.question.stories.tsx
+++ b/frontend/test/__support__/custom-viz-fixtures/CalendarHeatmap.question.stories.tsx
@@ -4,7 +4,6 @@ import type { StoryFn } from "@storybook/react";
import { type ReactNode, useEffect, useMemo } from "react";
import { getStore } from "__support__/entities-store";
-import { createMockMetadata } from "__support__/metadata";
import { createMockSettingsState, createMockState } from "__support__/state";
import { getNextId } from "__support__/utils";
import { AppColorSchemeProvider } from "metabase/AppColorSchemeProvider";
@@ -79,7 +78,6 @@ const Template: StoryFn<{ theme: "light" | "dark" }> = ({ theme }) => {
const questionProps: PublicOrEmbeddedQuestionViewProps = {
initialized: true,
card: HEATMAP_CARD,
- metadata: createMockMetadata({}),
titled: true,
bordered: true,
theme: questionTheme,