Skip to content

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

Resolve card UI parameter fields from param_fields for saved cards (#80569)

Alexander Polyankin54d059982c65
diff --git a/frontend/src/metabase-lib/v1/Question.unit.spec.ts b/frontend/src/metabase-lib/v1/Question.unit.spec.ts
index a4aef6e76bb..347e0e93dac 100644
--- a/frontend/src/metabase-lib/v1/Question.unit.spec.ts
+++ b/frontend/src/metabase-lib/v1/Question.unit.spec.ts
@@ -652,6 +652,9 @@ describe("Question", () => {
it("should return the template tags of a native question", () => {
const nativeQuestionWithTemplateTags = {
...native_orders_count_card,
+ param_fields: {
+ bbb: [createMockField({ id: PRODUCTS.CATEGORY })],
+ },
dataset_query: {
...native_orders_count_card.dataset_query,
native: {
diff --git a/frontend/src/metabase-lib/v1/parameters/utils/cards.ts b/frontend/src/metabase-lib/v1/parameters/utils/cards.ts
index cb05188d82a..4631e504e24 100644
--- a/frontend/src/metabase-lib/v1/parameters/utils/cards.ts
+++ b/frontend/src/metabase-lib/v1/parameters/utils/cards.ts
@@ -1,3 +1,6 @@
+import _ from "underscore";
+
+import { isNotNull } from "metabase/utils/types";
import Question from "metabase-lib/v1/Question";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type {
@@ -7,13 +10,18 @@ import type {
import { getValuePopulatedParameters } from "metabase-lib/v1/parameters/utils/parameter-values";
import { getParameterTargetField } from "metabase-lib/v1/parameters/utils/targets";
import { getParametersFromCard } from "metabase-lib/v1/parameters/utils/template-tags";
-import type { Card, Parameter, ParameterTarget } from "metabase-types/api";
+import type {
+ Card,
+ Parameter,
+ ParameterTarget,
+ ParameterValuesMap,
+} from "metabase-types/api";
import { isDimensionTarget } from "metabase-types/guards";
export function getCardUiParameters(
card: Card,
metadata: Metadata,
- parameterValues: { [key: string]: any } = {},
+ parameterValues: ParameterValuesMap = {},
parameters = getParametersFromCard(card, metadata),
): UiParameter[] {
if (!card) {
@@ -25,14 +33,69 @@ export function getCardUiParameters(
parameters,
values: parameterValues,
});
+
+ return hasParamFields(card)
+ ? getSavedCardUiParameters(card, metadata, valuePopulatedParameters)
+ : getUnsavedCardUiParameters(card, metadata, valuePopulatedParameters);
+}
+
+/**
+ * A question opened from a dashboard shows the dashboard's parameters, which
+ * the card's own `param_fields` do not cover.
+ */
+function hasParamFields(card: Card) {
+ return card.id != null && card.dashboardId == null;
+}
+
+/**
+ * Saved cards carry `param_fields` hydrated by the backend, so parameter
+ * fields are resolved from them rather than from the query, which can be
+ * stripped (public and static-embed payloads) or require metadata the
+ * frontend does not have.
+ */
+function getSavedCardUiParameters(
+ card: Card,
+ metadata: Metadata,
+ parameters: Parameter[] | ParameterWithTarget[],
+): UiParameter[] {
+ return parameters.map((parameter) => {
+ const target = getParameterTarget(parameter);
+ const parameterFields = (card.param_fields?.[parameter.id] ?? [])
+ .map((field) => metadata.field(field.id))
+ .filter(isNotNull);
+ const fields = _.uniq(parameterFields, (field) => field.id);
+ if (fields.length > 0) {
+ return {
+ ...parameter,
+ fields,
+ hasVariableTemplateTagTarget: false,
+ };
+ }
+
+ return {
+ ...parameter,
+ hasVariableTemplateTagTarget: !isDimensionTarget(target),
+ };
+ });
+}
+
+/**
+ * Unsaved cards have no `param_fields`, so parameter targets are resolved
+ * against the query.
+ */
+function getUnsavedCardUiParameters(
+ card: Card,
+ metadata: Metadata,
+ parameters: Parameter[] | ParameterWithTarget[],
+): UiParameter[] {
const question = new Question(card, metadata);
- return valuePopulatedParameters.map((parameter) => {
- // Unjustified type cast. FIXME
- const target: ParameterTarget | undefined = (
- parameter as ParameterWithTarget
- ).target;
- const field = getParameterTargetField(question, parameter, target);
+ return parameters.map((parameter) => {
+ const target = getParameterTarget(parameter);
+ const field =
+ target != null
+ ? getParameterTargetField(question, parameter, target)
+ : null;
if (field) {
return {
...parameter,
@@ -47,3 +110,9 @@ export function getCardUiParameters(
};
});
}
+
+function getParameterTarget(
+ parameter: Parameter | ParameterWithTarget,
+): ParameterTarget | undefined {
+ return "target" in parameter ? parameter.target : undefined;
+}
diff --git a/frontend/src/metabase-lib/v1/parameters/utils/cards.unit.spec.ts b/frontend/src/metabase-lib/v1/parameters/utils/cards.unit.spec.ts
new file mode 100644
index 00000000000..f17f8a8623f
--- /dev/null
+++ b/frontend/src/metabase-lib/v1/parameters/utils/cards.unit.spec.ts
@@ -0,0 +1,205 @@
+import { createMockMetadata } from "__support__/metadata";
+import * as Lib from "metabase-lib";
+import { SAMPLE_METADATA, SAMPLE_PROVIDER } from "metabase-lib/test-helpers";
+import {
+ createMockCard,
+ createMockField,
+ createMockParameter,
+} from "metabase-types/api/mocks";
+import { ORDERS } from "metabase-types/api/mocks/presets";
+
+import { getCardUiParameters } from "./cards";
+
+describe("parameters/utils/cards", () => {
+ describe("getCardUiParameters", () => {
+ const dateParameter = createMockParameter({
+ id: "param-1",
+ name: "Created At",
+ slug: "created_at",
+ type: "date/single",
+ target: ["dimension", ["template-tag", "created_at"]],
+ });
+ const variableParameter = createMockParameter({
+ id: "param-2",
+ name: "Limit",
+ slug: "limit",
+ type: "number/=",
+ target: ["variable", ["template-tag", "limit"]],
+ });
+ const quantityTagQuery = Lib.createTestJsNativeQuery(SAMPLE_PROVIDER, {
+ query: "SELECT * FROM ORDERS WHERE {{quantity}}",
+ templateTags: {
+ quantity: {
+ id: "tag-id",
+ type: "dimension",
+ dimension: ORDERS.QUANTITY,
+ "widget-type": "number/=",
+ },
+ },
+ });
+
+ describe("saved cards", () => {
+ it("should get parameter fields from param_fields via metadata", () => {
+ const metadata = createMockMetadata({
+ fields: [createMockField({ id: 1 }), createMockField({ id: 2 })],
+ });
+ const card = createMockCard({
+ id: 1,
+ parameters: [dateParameter, variableParameter],
+ param_fields: {
+ [dateParameter.id]: [
+ createMockField({ id: 1 }),
+ createMockField({ id: 2 }),
+ createMockField({ id: 1 }),
+ ],
+ },
+ });
+
+ const [dateUiParameter, variableUiParameter] = getCardUiParameters(
+ card,
+ metadata,
+ );
+
+ expect(dateUiParameter).toMatchObject({
+ id: dateParameter.id,
+ fields: [metadata.field(1), metadata.field(2)],
+ hasVariableTemplateTagTarget: false,
+ });
+ expect(variableUiParameter).toMatchObject({
+ id: variableParameter.id,
+ hasVariableTemplateTagTarget: true,
+ });
+ expect(variableUiParameter).not.toHaveProperty("fields");
+ });
+
+ it("should ignore fields missing from metadata", () => {
+ const metadata = createMockMetadata({ fields: [] });
+ const card = createMockCard({
+ id: 1,
+ parameters: [dateParameter],
+ param_fields: {
+ [dateParameter.id]: [createMockField({ id: 1 })],
+ },
+ });
+
+ const [dateUiParameter] = getCardUiParameters(card, metadata);
+
+ expect(dateUiParameter).toMatchObject({
+ id: dateParameter.id,
+ hasVariableTemplateTagTarget: false,
+ });
+ expect(dateUiParameter).not.toHaveProperty("fields");
+ });
+
+ it("should not resolve parameter fields from the query", () => {
+ const card = createMockCard({
+ id: 1,
+ parameters: [],
+ param_fields: {},
+ dataset_query: quantityTagQuery,
+ });
+
+ const [quantityUiParameter] = getCardUiParameters(
+ card,
+ SAMPLE_METADATA,
+ );
+
+ expect(quantityUiParameter).toMatchObject({
+ id: "tag-id",
+ hasVariableTemplateTagTarget: false,
+ });
+ expect(quantityUiParameter).not.toHaveProperty("fields");
+ });
+
+ it("should populate parameter values", () => {
+ const metadata = createMockMetadata({ fields: [] });
+ const card = createMockCard({
+ id: 1,
+ parameters: [dateParameter],
+ param_fields: {},
+ });
+
+ const [dateUiParameter] = getCardUiParameters(card, metadata, {
+ [dateParameter.id]: "2026-01-01",
+ });
+
+ expect(dateUiParameter).toMatchObject({
+ id: dateParameter.id,
+ value: "2026-01-01",
+ });
+ });
+ });
+
+ describe("saved cards opened from a dashboard", () => {
+ it("should resolve parameter fields from the query", () => {
+ const card = createMockCard({
+ id: 1,
+ dashboardId: 1,
+ parameters: [],
+ param_fields: {},
+ dataset_query: quantityTagQuery,
+ });
+
+ const [quantityUiParameter] = getCardUiParameters(
+ card,
+ SAMPLE_METADATA,
+ );
+
+ expect(quantityUiParameter).toMatchObject({
+ id: "tag-id",
+ fields: [SAMPLE_METADATA.field(ORDERS.QUANTITY)],
+ hasVariableTemplateTagTarget: false,
+ });
+ });
+ });
+
+ describe("unsaved cards", () => {
+ it("should resolve parameter fields from the query", () => {
+ const card = createMockCard({
+ id: undefined,
+ parameters: [],
+ dataset_query: quantityTagQuery,
+ });
+
+ const [quantityUiParameter] = getCardUiParameters(
+ card,
+ SAMPLE_METADATA,
+ );
+
+ expect(quantityUiParameter).toMatchObject({
+ id: "tag-id",
+ fields: [SAMPLE_METADATA.field(ORDERS.QUANTITY)],
+ hasVariableTemplateTagTarget: false,
+ });
+ });
+
+ it("should ignore param_fields", () => {
+ const metadata = createMockMetadata({
+ fields: [createMockField({ id: 1 })],
+ });
+ const card = createMockCard({
+ id: undefined,
+ parameters: [dateParameter],
+ param_fields: {
+ [dateParameter.id]: [createMockField({ id: 1 })],
+ },
+ });
+
+ const [dateUiParameter] = getCardUiParameters(card, metadata);
+
+ expect(dateUiParameter).toMatchObject({
+ id: dateParameter.id,
+ hasVariableTemplateTagTarget: false,
+ });
+ expect(dateUiParameter).not.toHaveProperty("fields");
+ });
+ });
+
+ it("should handle cards without parameters or param_fields", () => {
+ const metadata = createMockMetadata({});
+ const card = createMockCard({ parameters: undefined });
+
+ expect(getCardUiParameters(card, metadata)).toEqual([]);
+ });
+ });
+});