The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
UXW-1852 Reset filter to default for specific click behavior (#67220)
Denis Berezin75f3c9fc01bf
diff --git a/e2e/test/scenarios/dashboard-cards/click-behavior-reproductions.cy.spec.ts b/e2e/test/scenarios/dashboard-cards/click-behavior-reproductions.cy.spec.tsindex f9e3d00d26a..94d9a75f107 100644--- a/e2e/test/scenarios/dashboard-cards/click-behavior-reproductions.cy.spec.ts+++ b/e2e/test/scenarios/dashboard-cards/click-behavior-reproductions.cy.spec.ts@@ -2,8 +2,9 @@ const { H } = cy;import { SAMPLE_DATABASE } from "e2e/support/cypress_sample_database";import type { StructuredQuestionDetails } from "e2e/support/helpers";+import { createMockActionParameter } from "metabase-types/api/mocks";-const { PRODUCTS_ID, PRODUCTS } = SAMPLE_DATABASE;+const { PRODUCTS_ID, PRODUCTS, ORDERS_ID, ORDERS } = SAMPLE_DATABASE;describe("issue 59049", () => {const questionDetails: StructuredQuestionDetails = {@@ -133,3 +134,119 @@ describe("issue 59049", () => {H.assertTableRowsCount(200);});});++describe("issue 64368", () => {+ beforeEach(() => {+ H.restore();+ cy.signInAsAdmin();+ });++ it("should reset to default value when unsetting a required filter with a default through click behavior (metabase#64368)", () => {+ const DASHBOARD_FILTER_REQUIRED_WITH_DEFAULT = createMockActionParameter({+ id: "5",+ name: "Required Filter",+ slug: "required-filter",+ type: "string/=",+ sectionId: "string",+ default: "Doohickey",+ required: true,+ });++ const testQuestionDetails = {+ name: "Orders by Category",+ display: "table",+ query: {+ "source-table": ORDERS_ID,+ aggregation: [["count"]],+ breakout: [+ [+ "field",+ PRODUCTS.CATEGORY,+ { "base-type": "type/Text", "source-field": ORDERS.PRODUCT_ID },+ ],+ ],+ limit: 5,+ },+ };++ const dashboardDetails = {+ parameters: [DASHBOARD_FILTER_REQUIRED_WITH_DEFAULT],+ };++ H.createQuestionAndDashboard({+ questionDetails: testQuestionDetails,+ dashboardDetails,+ }).then(({ body: dashcard }) => {+ H.addOrUpdateDashboardCard({+ dashboard_id: dashcard.dashboard_id,+ card_id: dashcard.card_id,+ card: {+ parameter_mappings: [+ {+ card_id: dashcard.card_id,+ parameter_id: DASHBOARD_FILTER_REQUIRED_WITH_DEFAULT.id,+ target: [+ "dimension",+ [+ "field",+ PRODUCTS.CATEGORY,+ {+ "base-type": "type/Text",+ "source-field": ORDERS.PRODUCT_ID,+ },+ ],+ ],+ },+ ],+ },+ });+ H.visitDashboard(dashcard.dashboard_id);+ cy.location().then(({ pathname }) => {+ cy.wrap(pathname).as("originalPathname");+ });+ });++ cy.log("Verify initial state with default filter value");+ cy.findAllByTestId("parameter-widget")+ .should("have.length", 1)+ .should("contain.text", "Doohickey");++ cy.log("Configure click behavior to update dashboard filter");+ H.editDashboard();++ H.clickBehaviorSidebar().within(() => {+ cy.findByText("Product → Category").click();+ cy.findByText("Update a dashboard filter").click();+ cy.findByText(DASHBOARD_FILTER_REQUIRED_WITH_DEFAULT.name).click();+ });++ H.popover().within(() => {+ cy.findByText("Product → Category").should("exist").click();+ });++ cy.findByTestId("click-behavior-sidebar").button("Done").click();++ H.saveDashboard({ waitMs: 250 });++ cy.log("Set dashboard filter to contain all values");+ cy.findAllByTestId("parameter-widget").click();+ H.popover().within(() => {+ cy.findByText("Select all").click();+ cy.findByText("Update filter").click();+ });++ cy.log("Click on a category row to set filter value to Gadget");+ H.getDashboardCard().findByText("Gadget").click();+ cy.findAllByTestId("parameter-widget")+ .should("have.length", 1)+ .should("contain.text", "Gadget");++ cy.log(+ "Click same category again to unset - should reset to default value Doohickey, not blank",+ );+ H.getDashboardCard().findByText("Gadget").click();+ cy.findAllByTestId("parameter-widget")+ .should("have.length", 1)+ .should("contain.text", "Doohickey");+ });+});diff --git a/frontend/src/metabase/dashboard/actions/parameters.tsx b/frontend/src/metabase/dashboard/actions/parameters.tsxindex 97bfd7220e4..3a99f80025b 100644--- a/frontend/src/metabase/dashboard/actions/parameters.tsx+++ b/frontend/src/metabase/dashboard/actions/parameters.tsx@@ -994,7 +994,23 @@ export const setOrUnsetParameterValues =_.isEqual(value, parameterValues[id]),);parameterIdValuePairs- .map(([id, value]) => setParameterValue(id, areAllSet ? null : value))+ .map(([id, value]) => {+ let valueToSet = value;++ if (areAllSet) {+ // unsetting value from parameter custom click behavior (Update a dashboard filter)+ const parameter = getParameters(getState()).find(+ ({ id: itemId }) => id === itemId,+ );++ valueToSet =+ parameter?.default && parameter?.required+ ? parameter.default || null+ : null;+ }++ return setParameterValue(id, valueToSet);+ }).forEach(dispatch);};diff --git a/frontend/src/metabase/dashboard/actions/parameters.unit.spec.ts b/frontend/src/metabase/dashboard/actions/parameters.unit.spec.tsindex 3f05305ea3d..70b8d96abee 100644--- a/frontend/src/metabase/dashboard/actions/parameters.unit.spec.ts+++ b/frontend/src/metabase/dashboard/actions/parameters.unit.spec.ts@@ -18,6 +18,7 @@ import {import {REMOVE_PARAMETER,removeParameter,+ setOrUnsetParameterValues,setParameterIsMultiSelect,setParameterType,} from "./parameters";@@ -213,3 +214,63 @@ describe("removeParameter", () => {});});});++describe("setOrUnsetParameterValues", () => {+ it("should set parameter value to default when parameter is required and has a default value", async () => {+ const store = setup(+ createMockState({+ dashboard: createMockDashboardState({+ dashboardId: 1,+ dashboards: {+ "1": createMockStoreDashboard({+ id: 1,+ parameters: [+ createMockParameter({+ id: "123",+ default: "default-value",+ required: true,+ }),+ ],+ }),+ },+ parameterValues: {+ "123": "current-value",+ },+ }),+ }),+ );++ await store.dispatch(setOrUnsetParameterValues([["123", "current-value"]]));++ const state = store.getState();+ expect(state.dashboard.parameterValues["123"]).toBe("default-value");+ });++ it("should set parameter to provided value when parameter does not have a default value", async () => {+ const store = setup(+ createMockState({+ dashboard: createMockDashboardState({+ dashboardId: 1,+ dashboards: {+ "1": createMockStoreDashboard({+ id: 1,+ parameters: [+ createMockParameter({+ id: "123",+ }),+ ],+ }),+ },+ parameterValues: {+ "123": "current-value",+ },+ }),+ }),+ );++ await store.dispatch(setOrUnsetParameterValues([["123", "current-value"]]));++ const state = store.getState();+ expect(state.dashboard.parameterValues["123"]).toBe(null);+ });+});