Skip to content

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

Fix bar chart dimension click behavior on dashboards (#74094)

Anderson258dbb310b40
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.ts
index 94d9a75f107..03f174b8ad0 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
@@ -250,3 +250,123 @@ describe("issue 64368", () => {
.should("contain.text", "Doohickey");
});
});
+
+describe("issue 73448", () => {
+ const productCategories = ["Doohickey", "Gadget", "Gizmo", "Widget"];
+
+ const categoryParameter = createMockActionParameter({
+ id: "category",
+ name: "Category",
+ slug: "category",
+ type: "string/=",
+ sectionId: "string",
+ });
+
+ const questionDetails: StructuredQuestionDetails = {
+ name: "Orders by Category",
+ display: "bar",
+ query: {
+ "source-table": ORDERS_ID,
+ aggregation: [["count"]],
+ breakout: [
+ [
+ "field",
+ PRODUCTS.CATEGORY,
+ { "base-type": "type/Text", "source-field": ORDERS.PRODUCT_ID },
+ ],
+ ],
+ limit: 5,
+ },
+ };
+
+ beforeEach(() => {
+ H.restore();
+ cy.signInAsAdmin();
+ });
+
+ it("updates a dashboard filter from a bar chart dimension click behavior (#73448)", () => {
+ H.createQuestionAndDashboard({
+ questionDetails,
+ dashboardDetails: {
+ parameters: [categoryParameter],
+ },
+ }).then(({ body: dashcard }) => {
+ H.addOrUpdateDashboardCard({
+ dashboard_id: dashcard.dashboard_id,
+ card_id: dashcard.card_id,
+ card: {
+ id: dashcard.id,
+ parameter_mappings: [
+ {
+ card_id: dashcard.card_id,
+ parameter_id: categoryParameter.id,
+ target: [
+ "dimension",
+ [
+ "field",
+ PRODUCTS.CATEGORY,
+ {
+ "base-type": "type/Text",
+ "source-field": ORDERS.PRODUCT_ID,
+ },
+ ],
+ ],
+ },
+ ],
+ visualization_settings: {
+ column_settings: {
+ '["name","CATEGORY"]': {
+ click_behavior: {
+ type: "crossfilter",
+ parameterMapping: {
+ [categoryParameter.id]: {
+ id: categoryParameter.id,
+ source: {
+ type: "column",
+ id: "CATEGORY",
+ name: "Product → Category",
+ },
+ target: {
+ type: "parameter",
+ id: categoryParameter.id,
+ },
+ },
+ },
+ },
+ },
+ },
+ },
+ },
+ });
+
+ H.visitDashboard(dashcard.dashboard_id);
+ });
+
+ cy.location("pathname").as("dashboardPath");
+
+ H.chartPathWithFillColor("#509EE3")
+ .should("have.length", 4)
+ .first()
+ .click();
+
+ cy.log("dashboard filter updates with the clicked category value");
+ H.filterWidget()
+ .invoke("text")
+ .should((text) => {
+ expect(
+ productCategories.some((category) => text.includes(category)),
+ ).to.equal(true);
+ });
+ cy.location("search").should((search) => {
+ expect(new URLSearchParams(search).get("category")).to.be.oneOf(
+ productCategories,
+ );
+ });
+
+ cy.log("drill-through popover is not shown and navigation stays put");
+ cy.get(H.POPOVER_ELEMENT).should("not.exist");
+ cy.get("@dashboardPath").then((dashboardPath) => {
+ cy.location("pathname").should("eq", dashboardPath);
+ });
+ });
+});
diff --git a/frontend/src/metabase/dashboard/utils/dashboard-click-drill.unit.spec.js b/frontend/src/metabase/dashboard/utils/dashboard-click-drill.unit.spec.js
new file mode 100644
index 00000000000..9f4a20acccb
--- /dev/null
+++ b/frontend/src/metabase/dashboard/utils/dashboard-click-drill.unit.spec.js
@@ -0,0 +1,112 @@
+import { DashboardClickAction } from "../../visualizations/click-actions/actions/DashboardClickAction";
+import { getClickBehavior } from "../../visualizations/click-actions/lib/dashboard-click-drill";
+
+const rootClickBehavior = { type: "link", linkType: "url" };
+const metricClickBehavior = { type: "actionMenu" };
+const dimensionClickBehavior = { type: "crossfilter" };
+
+const metricColumn = { name: "count" };
+const dimensionColumn = { name: "CATEGORY" };
+
+function buildSettings({ columns = {}, root } = {}) {
+ const column_settings = Object.fromEntries(
+ Object.entries(columns).map(([name, click_behavior]) => [
+ JSON.stringify(["name", name]),
+ { click_behavior },
+ ]),
+ );
+ const settings = {
+ column_settings,
+ // Computed column() does NOT surface click_behavior (#73448). Returning the
+ // formatter-only shape mirrors the production behavior we have to handle.
+ column: () => ({}),
+ };
+ if (root) {
+ settings.click_behavior = root;
+ }
+ return settings;
+}
+
+describe("getClickBehavior", () => {
+ it("uses click behavior configured on the clicked column", () => {
+ const clickBehavior = getClickBehavior({
+ column: metricColumn,
+ settings: buildSettings({ columns: { count: metricClickBehavior } }),
+ });
+
+ expect(clickBehavior).toBe(metricClickBehavior);
+ });
+
+ it("falls back to the click behavior configured on a clicked dimension (#73448)", () => {
+ const clickBehavior = getClickBehavior({
+ column: metricColumn,
+ dimensions: [{ column: dimensionColumn, value: "Gadget" }],
+ settings: buildSettings({
+ columns: { CATEGORY: dimensionClickBehavior },
+ }),
+ });
+
+ expect(clickBehavior).toBe(dimensionClickBehavior);
+ });
+
+ it("prefers a clicked column behavior over a dimension behavior", () => {
+ const clickBehavior = getClickBehavior({
+ column: metricColumn,
+ dimensions: [{ column: dimensionColumn, value: "Gadget" }],
+ settings: buildSettings({
+ columns: {
+ count: metricClickBehavior,
+ CATEGORY: dimensionClickBehavior,
+ },
+ }),
+ });
+
+ expect(clickBehavior).toBe(metricClickBehavior);
+ });
+
+ it("falls back to the root click behavior when neither column nor dimension has one", () => {
+ const clickBehavior = getClickBehavior({
+ column: metricColumn,
+ dimensions: [{ column: dimensionColumn, value: "Gadget" }],
+ settings: buildSettings({ root: rootClickBehavior }),
+ });
+
+ expect(clickBehavior).toBe(rootClickBehavior);
+ });
+});
+
+describe("DashboardClickAction", () => {
+ it("creates a click-behavior action for a chart click with a dimension-scoped behavior (#73448)", () => {
+ const actions = DashboardClickAction({
+ question: {},
+ clicked: {
+ column: metricColumn,
+ dimensions: [{ column: dimensionColumn, value: "Gadget" }],
+ extraData: { dashboard: {}, parameters: [] },
+ },
+ settings: buildSettings({
+ columns: { CATEGORY: { type: "crossfilter", parameterMapping: {} } },
+ }),
+ });
+
+ expect(actions).toHaveLength(1);
+ expect(actions[0]).toMatchObject({
+ name: "click_behavior",
+ defaultAlways: true,
+ });
+ });
+
+ it("returns no action when no click behavior is configured for the clicked target", () => {
+ const actions = DashboardClickAction({
+ question: {},
+ clicked: {
+ column: metricColumn,
+ dimensions: [{ column: dimensionColumn, value: "Gadget" }],
+ extraData: { dashboard: {}, parameters: [] },
+ },
+ settings: buildSettings(),
+ });
+
+ expect(actions).toHaveLength(0);
+ });
+});
diff --git a/frontend/src/metabase/embedding-sdk/lib/links.ts b/frontend/src/metabase/embedding-sdk/lib/links.ts
index 1c3cac193f9..d99b267a955 100644
--- a/frontend/src/metabase/embedding-sdk/lib/links.ts
+++ b/frontend/src/metabase/embedding-sdk/lib/links.ts
@@ -1,4 +1,4 @@
-import type { VisualizationSettings } from "metabase-types/api";
+import type { ClickBehavior, VisualizationSettings } from "metabase-types/api";
/**
* In modular embedding (react sdk and embed-js) we disable internal click behaviors
@@ -7,18 +7,63 @@ import type { VisualizationSettings } from "metabase-types/api";
*/
export function removeInternalClickBehaviors(
computedSettings: VisualizationSettings,
-) {
+): VisualizationSettings {
+ const { click_behavior, column_settings } = computedSettings;
+
+ const nextClickBehavior = stripIfInternal(click_behavior);
+ const nextColumnSettings = mapColumnSettings(column_settings);
+
if (
- computedSettings.click_behavior &&
- computedSettings.click_behavior.type === "link" &&
- computedSettings.click_behavior.linkType !== "url"
+ nextClickBehavior === click_behavior &&
+ nextColumnSettings === column_settings
) {
- return {
- ...computedSettings,
- click_behavior: undefined,
- };
+ return computedSettings;
+ }
+
+ return {
+ ...computedSettings,
+ click_behavior: nextClickBehavior,
+ column_settings: nextColumnSettings,
+ };
+}
+
+function mapColumnSettings(
+ columnSettings: VisualizationSettings["column_settings"],
+): VisualizationSettings["column_settings"] {
+ if (!columnSettings) {
+ return columnSettings;
}
- return computedSettings;
+
+ const entries = Object.entries(columnSettings);
+ const hasInternal = entries.some(([, settings]) =>
+ isInternalLinkClickBehavior(settings.click_behavior),
+ );
+
+ if (!hasInternal) {
+ return columnSettings;
+ }
+
+ return Object.fromEntries(
+ entries.map(([key, settings]) => {
+ if (!isInternalLinkClickBehavior(settings.click_behavior)) {
+ return [key, settings];
+ }
+
+ return [key, { ...settings, click_behavior: undefined }];
+ }),
+ );
+}
+
+function stripIfInternal(clickBehavior: ClickBehavior | undefined) {
+ return isInternalLinkClickBehavior(clickBehavior) ? undefined : clickBehavior;
+}
+
+function isInternalLinkClickBehavior(clickBehavior: ClickBehavior | undefined) {
+ return (
+ clickBehavior?.type === "link" &&
+ "linkType" in clickBehavior &&
+ clickBehavior.linkType !== "url"
+ );
}
/**
diff --git a/frontend/src/metabase/embedding-sdk/lib/links.unit.spec.ts b/frontend/src/metabase/embedding-sdk/lib/links.unit.spec.ts
new file mode 100644
index 00000000000..13d2b41cad4
--- /dev/null
+++ b/frontend/src/metabase/embedding-sdk/lib/links.unit.spec.ts
@@ -0,0 +1,57 @@
+import { removeInternalClickBehaviors } from "./links";
+
+describe("removeInternalClickBehaviors", () => {
+ it("keeps the same settings reference when there are no internal link click behaviors", () => {
+ const settings = {
+ click_behavior: {
+ type: "link",
+ linkType: "url",
+ linkTemplate: "https://metabase.com",
+ },
+ column_settings: {
+ '["name","TOTAL"]': {
+ click_behavior: {
+ type: "link",
+ linkType: "url",
+ linkTemplate: "https://metabase.com",
+ },
+ },
+ },
+ } as const;
+
+ expect(removeInternalClickBehaviors(settings)).toBe(settings);
+ });
+
+ it("removes internal link click behaviors from column settings", () => {
+ const result = removeInternalClickBehaviors({
+ column_settings: {
+ '["name","TOTAL"]': {
+ click_behavior: {
+ type: "link",
+ linkType: "dashboard",
+ targetId: 1,
+ },
+ },
+ '["name","SUBTOTAL"]': {
+ click_behavior: {
+ type: "link",
+ linkType: "url",
+ linkTemplate: "https://metabase.com",
+ },
+ },
+ },
+ });
+
+ expect(result.column_settings?.['["name","TOTAL"]'].click_behavior).toBe(
+ undefined,
+ );
+ expect(result.column_settings?.['["name","SUBTOTAL"]'].click_behavior)
+ .toMatchInlineSnapshot(`
+ {
+ "linkTemplate": "https://metabase.com",
+ "linkType": "url",
+ "type": "link",
+ }
+ `);
+ });
+});
diff --git a/frontend/src/metabase/visualizations/click-actions/actions/DashboardClickAction.tsx b/frontend/src/metabase/visualizations/click-actions/actions/DashboardClickAction.tsx
index 991c4e001b5..c3de49f7639 100644
--- a/frontend/src/metabase/visualizations/click-actions/actions/DashboardClickAction.tsx
+++ b/frontend/src/metabase/visualizations/click-actions/actions/DashboardClickAction.tsx
@@ -91,9 +91,14 @@ function getAction(
export const DashboardClickAction: LegacyDrill = ({
question,
+ settings,
clicked = {},
}): AlwaysDefaultClickAction[] => {
- const type = getDashboardDrillType(clicked);
+ const clickObject: ClickObject = clicked.settings
+ ? clicked
+ : { ...clicked, settings };
+ const type = getDashboardDrillType(clickObject);
+
if (!type) {
return [];
}
@@ -102,7 +107,7 @@ export const DashboardClickAction: LegacyDrill = ({
{
name: "click_behavior",
defaultAlways: true,
- ...getAction(type, question, clicked),
+ ...getAction(type, question, clickObject),
},
];
};
diff --git a/frontend/src/metabase/visualizations/click-actions/lib/dashboard-click-drill.js b/frontend/src/metabase/visualizations/click-actions/lib/dashboard-click-drill.js
index e0e0110daf9..689fe04d1ee 100644
--- a/frontend/src/metabase/visualizations/click-actions/lib/dashboard-click-drill.js
+++ b/frontend/src/metabase/visualizations/click-actions/lib/dashboard-click-drill.js
@@ -12,6 +12,7 @@ import * as Urls from "metabase/urls";
import { renderLinkURLForClick } from "metabase/visualizations/lib/formatting/link";
import * as Lib from "metabase-lib";
import Question from "metabase-lib/v1/Question";
+import { getObjectColumnSettings } from "metabase-lib/v1/queries/utils/column-key";
import { isDate } from "metabase-lib/v1/types/utils/isa";
import { getStructuredQuestionUrlWithParameters } from "./question-url";
@@ -163,14 +164,26 @@ export function getDashboardDrillQuestionUrl(question, clicked) {
export function getClickBehavior(clicked) {
const settings = (clicked && clicked.settings) || {};
- const columnSettings =
- (clicked &&
- clicked.column &&
- settings.column &&
- settings.column(clicked.column)) ||
- {};
-
- return columnSettings.click_behavior || settings.click_behavior;
+ const columnClickBehavior = getColumnClickBehavior(settings, clicked?.column);
+ if (columnClickBehavior) {
+ return columnClickBehavior;
+ }
+
+ const dimensionClickBehavior = (clicked?.dimensions || [])
+ .map((dimension) => getColumnClickBehavior(settings, dimension.column))
+ .find(Boolean);
+
+ return dimensionClickBehavior || settings.click_behavior;
+}
+
+function getColumnClickBehavior(settings, column) {
+ if (!column) {
+ return undefined;
+ }
+ return (
+ getObjectColumnSettings(settings.column_settings, column)?.click_behavior ??
+ settings.column?.(column)?.click_behavior
+ );
}
export function getClickBehaviorData(clicked, clickBehavior) {
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts
index c5f2c9a9c1b..c848e8d780d 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts
@@ -137,7 +137,7 @@ export const getEventDimensions = (
? dimensionModel.columnByCardId[seriesModel.cardId]
: dimensionModel.column;
- const hasDimensionValue = sameCardDatumColumns.includes(dimensionColumn);
+ const hasDimensionValue = sameCardDatumColumns.length > 0;
const dimensions: ClickObjectDimension[] = [];
if (hasDimensionValue) {
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.unit.spec.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.unit.spec.ts
index f95fa9c8621..6da493a0168 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.unit.spec.ts
@@ -209,6 +209,56 @@ describe("getEventDimensions", () => {
{ column: sourceColumn, value: "Affiliate" },
]);
});
+
+ it("includes the x-axis breakout when clicking a bar with only metric data (#73448)", () => {
+ const categoryColumn = createMockColumn({
+ name: "CATEGORY",
+ display_name: "Product → Category",
+ source: "breakout",
+ base_type: "type/Text",
+ effective_type: "type/Text",
+ });
+ const countColumn = createMockColumn({
+ name: "count",
+ display_name: "Count",
+ source: "aggregation",
+ base_type: "type/BigInteger",
+ effective_type: "type/BigInteger",
+ });
+ const countKey = `${CARD_ID}:count`;
+ const datum: Datum = {
+ [X_AXIS_DATA_KEY]: "Doohickey",
+ [countKey]: 3976,
+ };
+ const chartModel = createMockCartesianChartModel({
+ columnByDataKey: {
+ [countKey]: countColumn,
+ },
+ });
+ const categoryDimensionModel: DimensionModel = {
+ column: categoryColumn,
+ columnIndex: 0,
+ columnByCardId: { [CARD_ID]: categoryColumn },
+ };
+ const seriesModel = createMockSeriesModel({
+ dataKey: countKey,
+ column: countColumn,
+ columnIndex: 1,
+ cardId: CARD_ID,
+ vizSettingsKey: "count",
+ });
+
+ const dimensions = getEventDimensions(
+ chartModel,
+ datum,
+ categoryDimensionModel,
+ seriesModel,
+ );
+
+ expect(dimensions).toEqual([
+ { column: categoryColumn, value: "Doohickey" },
+ ]);
+ });
});
describe("getTimelineEventsForEvent", () => {