Skip to content

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

Adjust parameter_mappings for a text dashcard when its variable is removed (#64463)

Timofey Kachalov8137d490b39c
diff --git a/e2e/test/scenarios/dashboard-filters/parameters.cy.spec.js b/e2e/test/scenarios/dashboard-filters/parameters.cy.spec.js
index 4485fba5a37..0f684ba9375 100644
--- a/e2e/test/scenarios/dashboard-filters/parameters.cy.spec.js
+++ b/e2e/test/scenarios/dashboard-filters/parameters.cy.spec.js
@@ -10,6 +10,8 @@ import {
createMockDashboardCard,
createMockHeadingDashboardCard,
createMockParameter,
+ createMockTextDashboardCard,
+ createMockVirtualCard,
} from "metabase-types/api/mocks";
const { ORDERS_ID, ORDERS, PRODUCTS, PRODUCTS_ID, PEOPLE, PEOPLE_ID } =
@@ -1420,6 +1422,69 @@ describe("scenarios > dashboard > parameters", () => {
.should("exist");
});
+ it("should not display a parameter widget if there are no linked with it cards after a text card variable is removed (UXW-751)", () => {
+ H.createDashboard({
+ parameters: [categoryParameter, countParameter],
+ }).then(({ body: dashboard }) => {
+ const virtualCard = createMockVirtualCard({
+ display: "text",
+ });
+
+ H.updateDashboardCards({
+ dashboard_id: dashboard.id,
+ cards: [
+ createMockTextDashboardCard({
+ card: virtualCard,
+ text: "Value {{VAR1}} and {{VAR2}}",
+ size_x: 3,
+ size_y: 3,
+ parameter_mappings: [
+ {
+ parameter_id: categoryParameter.id,
+ card_id: virtualCard.id,
+ target: ["text-tag", "VAR1"],
+ },
+ {
+ parameter_id: countParameter.id,
+ card_id: virtualCard.id,
+ target: ["text-tag", "VAR2"],
+ },
+ ],
+ }),
+ ],
+ });
+ H.visitDashboard(dashboard.id);
+ });
+
+ H.filterWidget({ isEditing: false }).contains("Category").should("exist");
+ H.filterWidget({ isEditing: false }).contains("Category").should("exist");
+
+ H.editDashboard();
+
+ H.getDashboardCard(0).click();
+ H.getDashboardCard(0).within(() => {
+ cy.get("textarea").clear();
+ cy.get("textarea").type("Value {{}{{}VAR1}}");
+ });
+
+ H.saveDashboard();
+
+ H.filterWidget({ isEditing: false }).contains("Category").should("exist");
+ cy.findByTestId("parameter-widget").contains("Count").should("not.exist");
+
+ H.editDashboard();
+
+ H.getDashboardCard(0).click();
+ H.getDashboardCard(0).within(() => {
+ cy.get("textarea").clear();
+ cy.get("textarea").type("Value null");
+ });
+
+ H.saveDashboard();
+
+ cy.findByTestId("parameter-widget").should("not.exist");
+ });
+
it("should work correctly in public dashboards", () => {
H.createQuestionAndDashboard({
questionDetails: ordersCountByCategory,
diff --git a/frontend/src/metabase-lib/v1/parameters/utils/targets.ts b/frontend/src/metabase-lib/v1/parameters/utils/targets.ts
index fbf53d6c6ae..2fc32952788 100644
--- a/frontend/src/metabase-lib/v1/parameters/utils/targets.ts
+++ b/frontend/src/metabase-lib/v1/parameters/utils/targets.ts
@@ -42,6 +42,14 @@ export function getTemplateTagFromTarget(target: ParameterTarget) {
return type === "template-tag" ? tag : null;
}
+export function getTextTagFromTarget(target: ParameterTarget) {
+ if (!target?.[1] || target?.[0] !== "text-tag") {
+ return null;
+ }
+
+ return target[1];
+}
+
/**
* Returns only real DB fields and not all mapped columns.
* Use getMappingOptionByTarget for columns.
diff --git a/frontend/src/metabase-lib/v1/parameters/utils/targets.unit.spec.ts b/frontend/src/metabase-lib/v1/parameters/utils/targets.unit.spec.ts
index 4efea358528..d4b9ed4b7d7 100644
--- a/frontend/src/metabase-lib/v1/parameters/utils/targets.unit.spec.ts
+++ b/frontend/src/metabase-lib/v1/parameters/utils/targets.unit.spec.ts
@@ -15,6 +15,7 @@ import {
getParameterColumns,
getParameterTargetField,
getTemplateTagFromTarget,
+ getTextTagFromTarget,
isParameterVariableTarget,
} from "metabase-lib/v1/parameters/utils/targets";
import type {
@@ -210,6 +211,18 @@ describe("parameters/utils/targets", () => {
});
});
+ describe("getTextTagFromTarget", () => {
+ it("should return the tag of a text tag target", () => {
+ expect(getTextTagFromTarget(["text-tag", "foo"])).toBe("foo");
+ });
+
+ it("should return null for targets that are not text tags", () => {
+ expect(getTextTagFromTarget(["dimension", ["field", 123, null]])).toBe(
+ null,
+ );
+ });
+ });
+
describe("getParameterTargetField", () => {
it("should return null when the target is not a dimension", () => {
const question = db.nativeQuestion({
diff --git a/frontend/src/metabase/dashboard/actions/parameters.tsx b/frontend/src/metabase/dashboard/actions/parameters.tsx
index 680c8b613e2..97bfd7220e4 100644
--- a/frontend/src/metabase/dashboard/actions/parameters.tsx
+++ b/frontend/src/metabase/dashboard/actions/parameters.tsx
@@ -16,6 +16,7 @@ import { createAction, createThunkAction } from "metabase/lib/redux";
import {
type NewParameterOpts,
createParameter,
+ getFilteredParameterMappingsForDashcardText,
setParameterName as setParamName,
setParameterType as setParamType,
} from "metabase/parameters/utils/dashboards";
@@ -447,6 +448,39 @@ export const setParameterMapping = createThunkAction(
},
);
+export const UPDATE_PARAMETER_MAPPINGS_FOR_DASHCARD_TEXT =
+ "metabase/dashboard/UPDATE_PARAMETER_MAPPINGS_FOR_DASHCARD_TEXT";
+export const updateParameterMappingsForDashcardText = createThunkAction(
+ UPDATE_PARAMETER_MAPPINGS_FOR_DASHCARD_TEXT,
+ (dashcardId: DashCardId) => {
+ return (dispatch, getState) => {
+ const dashcard = getDashCardById(getState(), dashcardId);
+ const parameterMappings = dashcard?.parameter_mappings;
+ const text = dashcard?.visualization_settings?.text;
+
+ if (typeof text !== "string") {
+ return;
+ }
+
+ const filteredParameterMappings =
+ getFilteredParameterMappingsForDashcardText(parameterMappings, text);
+
+ if (!filteredParameterMappings) {
+ return;
+ }
+
+ dispatch(
+ setDashCardAttributes({
+ id: dashcardId,
+ attributes: {
+ parameter_mappings: filteredParameterMappings,
+ },
+ }),
+ );
+ };
+ },
+);
+
export const RESET_PARAMETER_MAPPINGS =
"metabase/dashboard/RESET_PARAMETER_MAPPINGS";
export const resetParameterMapping = createThunkAction(
diff --git a/frontend/src/metabase/parameters/utils/dashboards.ts b/frontend/src/metabase/parameters/utils/dashboards.ts
index 897df3e8eb6..c3932388276 100644
--- a/frontend/src/metabase/parameters/utils/dashboards.ts
+++ b/frontend/src/metabase/parameters/utils/dashboards.ts
@@ -1,5 +1,6 @@
import _ from "underscore";
+import { tag_names } from "cljs/metabase.parameters.shared";
import { isQuestionCard, isQuestionDashCard } from "metabase/dashboard/utils";
import { slugify } from "metabase/lib/formatting";
import { isNotNull } from "metabase/lib/types";
@@ -13,6 +14,7 @@ import type {
import { isFieldFilterParameter } from "metabase-lib/v1/parameters/utils/parameter-type";
import {
getParameterTargetField,
+ getTextTagFromTarget,
isParameterVariableTarget,
} from "metabase-lib/v1/parameters/utils/targets";
import type {
@@ -324,3 +326,27 @@ export function getFilteringParameterValuesMap(
return filteringParameterValues;
}
+
+export const getFilteredParameterMappingsForDashcardText = (
+ parameterMappings: DashboardCard["parameter_mappings"],
+ dashcardText: string,
+) => {
+ if (!parameterMappings) {
+ return parameterMappings;
+ }
+
+ const tagNames = tag_names(dashcardText);
+
+ return parameterMappings.filter((mapping) => {
+ const target = mapping.target;
+
+ const textTag = getTextTagFromTarget(target);
+
+ // A different tag type (not a text-tag) or no tag at all means we keep the mapping
+ if (!textTag) {
+ return true;
+ }
+
+ return tagNames.includes(textTag);
+ });
+};
diff --git a/frontend/src/metabase/visualizations/visualizations/Text/Text.jsx b/frontend/src/metabase/visualizations/visualizations/Text/Text.jsx
index 59643c71efa..331f09fc98b 100644
--- a/frontend/src/metabase/visualizations/visualizations/Text/Text.jsx
+++ b/frontend/src/metabase/visualizations/visualizations/Text/Text.jsx
@@ -1,6 +1,6 @@
/* eslint-disable react/prop-types */
import cx from "classnames";
-import { useEffect, useMemo, useState } from "react";
+import { useCallback, useEffect, useMemo, useState } from "react";
import ReactMarkdown from "react-markdown";
import rehypeExternalLinks from "rehype-external-links";
import remarkGfm from "remark-gfm";
@@ -8,9 +8,10 @@ import { t } from "ttag";
import { useToggle } from "metabase/common/hooks/use-toggle";
import CS from "metabase/css/core/index.css";
+import { updateParameterMappingsForDashcardText } from "metabase/dashboard/actions";
import { getParameterValues } from "metabase/dashboard/selectors";
import { useTranslateContent } from "metabase/i18n/hooks";
-import { useSelector } from "metabase/lib/redux";
+import { useDispatch, useSelector } from "metabase/lib/redux";
import { isEmpty } from "metabase/lib/validate";
import { fillParametersInText } from "metabase/visualizations/shared/utils/parameter-substitution";
@@ -43,6 +44,7 @@ export function Text({
isEditing,
isMobile,
}) {
+ const dispatch = useDispatch();
const parameterValues = useSelector(getParameterValues);
const justAdded = useMemo(() => dashcard?.justAdded || false, [dashcard]);
const [textValue, setTextValue] = useState(settings.text);
@@ -75,6 +77,14 @@ export function Text({
[dashcard, dashboard, parameterValues, translatedText],
);
+ const updateParameterMappings = useCallback(() => {
+ if (!dashcard.id) {
+ return;
+ }
+
+ dispatch(updateParameterMappingsForDashcardText(dashcard?.id));
+ }, [dashcard?.id, dispatch]);
+
const hasContent = !isEmpty(settings.text);
const placeholder = t`You can use Markdown here, and include variables {{like_this}}`;
@@ -126,6 +136,7 @@ export function Text({
if (settings.text !== textValue) {
onUpdateVisualizationSettings({ text: textValue });
+ updateParameterMappings();
}
}}
isMobile={isMobile}