Skip to content

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

chore: Convert dashboard click drill to ts (#79626)

Andrei Chernykhcab11e6bcc7b
diff --git a/frontend/src/embedding-sdk-bundle/lib/modes/EmbeddingSdkMode.ts b/frontend/src/embedding-sdk-bundle/lib/modes/EmbeddingSdkMode.ts
index fbde07d13ec..ee459a593bc 100644
--- a/frontend/src/embedding-sdk-bundle/lib/modes/EmbeddingSdkMode.ts
+++ b/frontend/src/embedding-sdk-bundle/lib/modes/EmbeddingSdkMode.ts
@@ -5,6 +5,7 @@ import {
getParameterIdValuePairs,
getParameterValuesBySlug,
} from "metabase/dashboard/click-behavior/dashboard-click-drill";
+import type { ParameterIdValuePair } from "metabase/dashboard/click-behavior/types";
import type { ParameterValues } from "metabase/embedding-sdk/types/dashboard";
import { CombineColumnsAction } from "metabase/visualizations/click-actions/actions/CombineColumnsAction";
import { ExtractColumnAction } from "metabase/visualizations/click-actions/actions/ExtractColumnAction";
@@ -15,11 +16,9 @@ import type {
LegacyDrill,
QueryClickActionsMode,
} from "metabase/visualizations/types";
-import type { DashboardTabId, ParameterValueOrArray } from "metabase-types/api";
+import type { CardId, DashboardId, DashboardTabId } from "metabase-types/api";
export type ClickBehaviorTarget = {
- type: "dashboard" | "question";
- id: number;
name: string;
parameters: ParameterValues;
/**
@@ -27,9 +26,11 @@ export type ClickBehaviorTarget = {
* Used for same-dashboard click behaviors that need to dispatch per-id
* setParameterValue actions (mirrors core app DashboardClickAction).
*/
- parameterIdValuePairs: [string, ParameterValueOrArray | null][];
- tabId?: DashboardTabId;
-};
+ parameterIdValuePairs: ParameterIdValuePair[];
+} & (
+ | { type: "dashboard"; id: DashboardId; tabId?: DashboardTabId }
+ | { type: "question"; id: CardId }
+);
const getClickBehaviorTarget = (
clicked: ClickObject,
@@ -42,7 +43,10 @@ const getClickBehaviorTarget = (
const { linkType, targetId, extraData, parameterMapping, data, tabId } =
getClickBehaviorData(clicked, clickBehavior);
- if (linkType !== "dashboard" && linkType !== "question") {
+ if (
+ (linkType !== "dashboard" && linkType !== "question") ||
+ targetId == null
+ ) {
return null;
}
@@ -54,35 +58,49 @@ const getClickBehaviorTarget = (
})
: {};
- // Unjustified type cast. FIXME
- const parameterIdValuePairs = (
- parameterMapping
- ? getParameterIdValuePairs(parameterMapping, {
- data,
- extraData,
- clickBehavior,
- })
- : []
- ) as [string, ParameterValueOrArray | null][];
-
- const entitiesMap =
- linkType === "dashboard" ? extraData?.dashboards : extraData?.questions;
- const target = entitiesMap?.[targetId];
-
- if (!target) {
+ const parameterIdValuePairs = parameterMapping
+ ? getParameterIdValuePairs(parameterMapping, {
+ data,
+ extraData,
+ clickBehavior,
+ })
+ : [];
+
+ if (linkType === "dashboard") {
+ const dashboard = extraData?.dashboards?.[targetId];
+
+ if (!dashboard) {
+ console.warn(
+ `[SDK Navigation] Could not find dashboard with id ${targetId}`,
+ );
+ return null;
+ }
+
+ return {
+ type: "dashboard",
+ id: dashboard.id,
+ name: dashboard.name,
+ parameters,
+ parameterIdValuePairs,
+ tabId,
+ };
+ }
+
+ const question = extraData?.questions?.[targetId];
+
+ if (!question) {
console.warn(
- `[SDK Navigation] Could not find ${linkType} with id ${targetId}`,
+ `[SDK Navigation] Could not find question with id ${targetId}`,
);
return null;
}
return {
- type: linkType,
- id: target.id,
- name: target.name,
+ type: "question",
+ id: question.id,
+ name: question.name,
parameters,
parameterIdValuePairs,
- tabId,
};
};
diff --git a/frontend/src/metabase/dashboard/click-behavior/DashboardClickAction.tsx b/frontend/src/metabase/dashboard/click-behavior/DashboardClickAction.tsx
index 1519c46b3c6..b219469d321 100644
--- a/frontend/src/metabase/dashboard/click-behavior/DashboardClickAction.tsx
+++ b/frontend/src/metabase/dashboard/click-behavior/DashboardClickAction.tsx
@@ -17,16 +17,10 @@ import {
getDashboardDrillType,
getDashboardDrillUrl,
} from "./dashboard-click-drill";
-
-type DashboardDrillType =
- | "link-url"
- | "question-url"
- | "dashboard-url"
- | "dashboard-filter"
- | "dashboard-reset";
+import type { DashboardDrillType, ParameterIdValuePair } from "./types";
type SetOrUnsetParameterValues = (
- parameterIdValuePairs: [string, ParameterValueOrArray | null][],
+ parameterIdValuePairs: ParameterIdValuePair[],
) => (dispatch: Dispatch) => void;
type SetParameterValue = (
@@ -44,7 +38,7 @@ function getAction(
// "dashboard-filter" and "dashboard-reset" drill types are produced.
const setOrUnsetParameterValues = clicked.extraData
?.setOrUnsetParameterValues as SetOrUnsetParameterValues;
- // Unjustified type cast. FIXME
+ // Also injected via extraData by the useClickBehaviorData hook.
const setParameterValue = clicked.extraData
?.setParameterValue as SetParameterValue;
@@ -65,10 +59,7 @@ function getAction(
case "dashboard-filter":
return {
action: () => {
- // Unjustified type cast. FIXME
- const parameterIdValuePairs = getDashboardDrillParameters(
- clicked,
- ) as [string, ParameterValueOrArray | null][];
+ const parameterIdValuePairs = getDashboardDrillParameters(clicked);
return setOrUnsetParameterValues(parameterIdValuePairs);
},
};
@@ -81,10 +72,7 @@ function getAction(
dispatch(selectTab({ tabId }));
}
- // Unjustified type cast. FIXME
- const parameterIdValuePairs = getDashboardDrillParameters(
- clicked,
- ) as [string, ParameterValueOrArray | null][];
+ const parameterIdValuePairs = getDashboardDrillParameters(clicked);
parameterIdValuePairs
.map(([id, value]) => setParameterValue(id, value))
.forEach((action) => dispatch(action));
diff --git a/frontend/src/metabase/dashboard/click-behavior/dashboard-click-drill.js b/frontend/src/metabase/dashboard/click-behavior/dashboard-click-drill.js
deleted file mode 100644
index 3d8ce4fb851..00000000000
--- a/frontend/src/metabase/dashboard/click-behavior/dashboard-click-drill.js
+++ /dev/null
@@ -1,256 +0,0 @@
-import querystring from "querystring";
-
-import { getIn } from "icepick";
-import _ from "underscore";
-
-import {
- formatSourceForTarget,
- getTargetForQueryParams,
-} from "metabase/dashboard/utils/click-behavior";
-import * as Urls from "metabase/urls";
-import {
- getDataFromClicked,
- renderLinkURLForClick,
-} from "metabase/value-formatting";
-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";
-
-export function getDashboardDrillType(clicked) {
- const clickBehavior = getClickBehavior(clicked);
- if (clickBehavior == null) {
- return null;
- }
-
- const { type, linkType, targetId, extraData } = getClickBehaviorData(
- clicked,
- clickBehavior,
- );
- if (!hasLinkTargetData(clickBehavior, extraData)) {
- return null;
- }
-
- if (type === "crossfilter") {
- return "dashboard-filter";
- } else if (type === "link") {
- if (linkType === "url") {
- return "link-url";
- } else if (linkType === "dashboard") {
- if (extraData.dashboard.id === targetId) {
- return "dashboard-reset";
- } else {
- return "dashboard-url";
- }
- } else if (linkType === "question" && extraData && extraData.questions) {
- return "question-url";
- }
- }
-
- return null;
-}
-
-export function getDashboardDrillTab(clicked) {
- const clickBehavior = getClickBehavior(clicked);
- const { tabId } = getClickBehaviorData(clicked, clickBehavior);
-
- return tabId;
-}
-
-export function getDashboardDrillParameters(clicked) {
- const clickBehavior = getClickBehavior(clicked);
- const { data, parameterMapping, extraData } = getClickBehaviorData(
- clicked,
- clickBehavior,
- );
-
- return getParameterIdValuePairs(parameterMapping, {
- data,
- extraData,
- clickBehavior,
- });
-}
-
-export function getDashboardDrillLinkUrl(clicked) {
- const clickBehavior = getClickBehavior(clicked);
- const { data } = getClickBehaviorData(clicked, clickBehavior);
-
- return renderLinkURLForClick(clickBehavior.linkTemplate || "", data);
-}
-
-export function getDashboardDrillUrl(clicked) {
- const clickBehavior = getClickBehavior(clicked);
- const { data, extraData, parameterMapping, targetId } = getClickBehaviorData(
- clicked,
- clickBehavior,
- );
-
- const targetDashboard = extraData.dashboards[targetId];
- const targetDefaultParameters = Object.fromEntries(
- targetDashboard.parameters.map((parameter) => [
- parameter.slug,
- parameter.default ?? "",
- ]),
- );
-
- const baseQueryParams = getParameterValuesBySlug(parameterMapping, {
- data,
- extraData,
- clickBehavior,
- });
-
- const tabParams =
- typeof clickBehavior.tabId === "undefined"
- ? {}
- : { tab: clickBehavior.tabId };
-
- const queryParams = {
- ...targetDefaultParameters,
- ...baseQueryParams,
- ...tabParams,
- };
-
- const path = Urls.dashboard({ id: targetId });
- return `${path}?${querystring.stringify(queryParams)}`;
-}
-
-export function getDashboardDrillQuestionUrl(question, clicked) {
- const clickBehavior = getClickBehavior(clicked);
- const { data, extraData, parameterMapping, targetId } = getClickBehaviorData(
- clicked,
- clickBehavior,
- );
-
- const baseQuestion = new Question(
- extraData.questions[targetId],
- question.metadata(),
- ).lockDisplay();
- const targetQuestion =
- // Pivot tables cannot work when there is an extra stage added on top of breakouts and aggregations
- baseQuestion.display() === "pivot"
- ? baseQuestion
- : baseQuestion.setQuery(Lib.ensureFilterStage(baseQuestion.query()));
-
- const parameters = _.chain(parameterMapping)
- .values()
- .map(({ target, id, source }) => ({
- target: target.dimension,
- id,
- slug: id,
- type: getTypeForSource(source, data, extraData),
- }))
- .value();
-
- const queryParams = getParameterValuesBySlug(parameterMapping, {
- data,
- extraData,
- clickBehavior,
- });
-
- const isTargetQuestionNative = Lib.queryDisplayInfo(
- targetQuestion.query(),
- ).isNative;
- const originalQuestion = targetQuestion;
-
- return !isTargetQuestionNative
- ? getStructuredQuestionUrlWithParameters(
- targetQuestion,
- originalQuestion,
- parameters,
- queryParams,
- )
- : Urls.question(targetQuestion, { query: queryParams });
-}
-
-export function getClickBehavior(clicked) {
- const settings = (clicked && clicked.settings) || {};
- 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) {
- const data = getDataFromClicked(clicked);
- const { type, linkType, parameterMapping, tabId, targetId } = clickBehavior;
- const { extraData } = clicked || {};
-
- return { type, linkType, data, extraData, parameterMapping, tabId, targetId };
-}
-
-export function getParameterIdValuePairs(
- parameterMapping,
- { data, extraData, clickBehavior },
-) {
- return _.values(parameterMapping).map(({ source, target, id }) => {
- return [
- id,
- formatSourceForTarget(source, target, {
- data,
- extraData,
- clickBehavior,
- }),
- ];
- });
-}
-
-export function getParameterValuesBySlug(
- parameterMapping,
- { data, extraData, clickBehavior },
-) {
- return Object.fromEntries(
- Object.values(parameterMapping)
- .map(({ source, target }) => [
- getTargetForQueryParams(target, { extraData, clickBehavior }),
- formatSourceForTarget(source, target, {
- data,
- extraData,
- clickBehavior,
- }),
- ])
- .filter(([key, value]) => key != null && value != null),
- );
-}
-
-function getTypeForSource(source, data, extraData) {
- if (source.type === "parameter") {
- const parameters = getIn(extraData, ["dashboard", "parameters"]) || [];
- const { type = "text" } = parameters.find((p) => p.id === source.id) || {};
- return type;
- }
-
- const datum = data[source.type][source.id.toLowerCase()] || [];
- if (datum.column && isDate(datum.column)) {
- return "date";
- }
-
- return "text";
-}
-
-function hasLinkTargetData(clickBehavior, extraData) {
- const { linkType, targetId } = clickBehavior;
- if (linkType === "question") {
- return getIn(extraData, ["questions", targetId]) != null;
- } else if (linkType === "dashboard") {
- return getIn(extraData, ["dashboards", targetId]) != null;
- }
- return true;
-}
diff --git a/frontend/src/metabase/dashboard/click-behavior/dashboard-click-drill.ts b/frontend/src/metabase/dashboard/click-behavior/dashboard-click-drill.ts
new file mode 100644
index 00000000000..6af01b12b9d
--- /dev/null
+++ b/frontend/src/metabase/dashboard/click-behavior/dashboard-click-drill.ts
@@ -0,0 +1,305 @@
+import querystring from "querystring";
+
+import type { ClickBehaviorExtraData } from "metabase/dashboard/utils/click-behavior";
+import {
+ formatSourceForTarget,
+ getTargetForQueryParams,
+} from "metabase/dashboard/utils/click-behavior";
+import * as Urls from "metabase/urls";
+import { checkNotNull } from "metabase/utils/types";
+import type { ValueAndColumnForColumnNameDate } from "metabase/value-formatting";
+import {
+ getDataFromClicked,
+ renderLinkURLForClick,
+} from "metabase/value-formatting";
+import type {
+ ClickObject,
+ ComputedVisualizationSettings,
+} from "metabase/visualizations/types";
+import * as Lib from "metabase-lib";
+import Question from "metabase-lib/v1/Question";
+import type { ParameterWithTarget } from "metabase-lib/v1/parameters/types";
+import { getObjectColumnSettings } from "metabase-lib/v1/queries/utils/column-key";
+import { isDate } from "metabase-lib/v1/types/utils/isa";
+import type {
+ ClickBehavior,
+ ClickBehaviorParameterMapping,
+ ClickBehaviorSource,
+ DatasetColumn,
+ ParameterValueOrArray,
+} from "metabase-types/api";
+
+import { getStructuredQuestionUrlWithParameters } from "./question-url";
+import type {
+ ClickBehaviorClickObject,
+ ClickBehaviorDataOptions,
+ ClickBehaviorProperties,
+ DashboardDrillType,
+ DrillExtraData,
+ ParameterIdValuePair,
+} from "./types";
+
+export function getDashboardDrillType(
+ clicked: ClickObject,
+): DashboardDrillType | null {
+ const clickBehavior = getClickBehavior(clicked);
+ if (clickBehavior == null) {
+ return null;
+ }
+
+ const { type, linkType, targetId, extraData } = getClickBehaviorData(
+ clicked,
+ clickBehavior,
+ );
+
+ if (!hasLinkTargetData(clickBehavior, extraData)) {
+ return null;
+ }
+
+ if (type === "crossfilter") {
+ return "dashboard-filter";
+ } else if (type === "link") {
+ if (linkType === "url") {
+ return "link-url";
+ } else if (linkType === "dashboard") {
+ if (extraData?.dashboard?.id === targetId) {
+ return "dashboard-reset";
+ } else {
+ return "dashboard-url";
+ }
+ } else if (linkType === "question" && extraData && extraData.questions) {
+ return "question-url";
+ }
+ }
+
+ return null;
+}
+
+export function getDashboardDrillTab(clicked: ClickObject) {
+ const clickBehavior = checkNotNull(getClickBehavior(clicked));
+ const { tabId } = getClickBehaviorData(clicked, clickBehavior);
+
+ return tabId;
+}
+
+export function getDashboardDrillParameters(clicked: ClickObject) {
+ const clickBehavior = checkNotNull(getClickBehavior(clicked));
+ const { data, parameterMapping, extraData } = getClickBehaviorData(
+ clicked,
+ clickBehavior,
+ );
+
+ return getParameterIdValuePairs(parameterMapping, {
+ data,
+ extraData,
+ clickBehavior,
+ });
+}
+
+export function getDashboardDrillLinkUrl(clicked: ClickObject) {
+ const clickBehavior = checkNotNull(getClickBehavior(clicked));
+ const { data, linkTemplate } = getClickBehaviorData(clicked, clickBehavior);
+
+ return renderLinkURLForClick(linkTemplate || "", data);
+}
+
+export function getDashboardDrillUrl(clicked: ClickObject) {
+ const clickBehavior = checkNotNull(getClickBehavior(clicked));
+ const { data, extraData, linkType, parameterMapping, tabId, targetId } =
+ getClickBehaviorData(clicked, clickBehavior);
+
+ const targetDashboardId = checkNotNull(
+ linkType === "dashboard" ? targetId : undefined,
+ );
+ const targetDashboard = checkNotNull(
+ extraData?.dashboards?.[targetDashboardId],
+ );
+ const targetDefaultParameters = Object.fromEntries(
+ checkNotNull(targetDashboard.parameters).map((parameter) => [
+ parameter.slug,
+ parameter.default ?? "",
+ ]),
+ );
+
+ const baseQueryParams = getParameterValuesBySlug(parameterMapping, {
+ data,
+ extraData,
+ clickBehavior,
+ });
+
+ const tabParams = typeof tabId === "undefined" ? {} : { tab: tabId };
+
+ const queryParams = {
+ ...targetDefaultParameters,
+ ...baseQueryParams,
+ ...tabParams,
+ };
+
+ const path = Urls.dashboard({ id: targetDashboardId });
+ return `${path}?${querystring.stringify(queryParams)}`;
+}
+
+export function getDashboardDrillQuestionUrl(
+ question: Question,
+ clicked: ClickObject,
+) {
+ const clickBehavior = checkNotNull(getClickBehavior(clicked));
+ const { data, extraData, linkType, parameterMapping, targetId } =
+ getClickBehaviorData(clicked, clickBehavior);
+
+ const targetCardId = checkNotNull(
+ linkType === "question" ? targetId : undefined,
+ );
+ const targetCard = checkNotNull(extraData?.questions?.[targetCardId]);
+ const baseQuestion = new Question(
+ targetCard,
+ question.metadata(),
+ ).lockDisplay();
+ const targetQuestion =
+ // Pivot tables cannot work when there is an extra stage added on top of breakouts and aggregations
+ baseQuestion.display() === "pivot"
+ ? baseQuestion
+ : baseQuestion.setQuery(Lib.ensureFilterStage(baseQuestion.query()));
+
+ // The cast covers what `ParameterWithTarget` requires, but these entries
+ // lack: `name` (never read by URL building) and a target on non-dimension mappings.
+ const parameters = Object.values(parameterMapping ?? {}).map(
+ ({ target, id, source }) => ({
+ target: target.type === "dimension" ? target.dimension : undefined,
+ id,
+ slug: id,
+ type: getTypeForSource(source, data, extraData),
+ }),
+ ) as ParameterWithTarget[];
+
+ const queryParams = getParameterValuesBySlug(parameterMapping, {
+ data,
+ extraData,
+ clickBehavior,
+ });
+
+ const isTargetQuestionNative = Lib.queryDisplayInfo(
+ targetQuestion.query(),
+ ).isNative;
+ const originalQuestion = targetQuestion;
+
+ return !isTargetQuestionNative
+ ? getStructuredQuestionUrlWithParameters(
+ targetQuestion,
+ originalQuestion,
+ parameters,
+ queryParams,
+ )
+ : Urls.question(targetQuestion, { query: queryParams });
+}
+
+export function getClickBehavior(
+ clicked: ClickBehaviorClickObject,
+): ClickBehavior | undefined {
+ const settings: ComputedVisualizationSettings = clicked?.settings || {};
+ 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: ComputedVisualizationSettings,
+ column: DatasetColumn | undefined,
+): ClickBehavior | undefined {
+ if (!column) {
+ return undefined;
+ }
+ return (
+ getObjectColumnSettings(settings.column_settings, column)?.click_behavior ??
+ settings.column?.(column)?.click_behavior
+ );
+}
+
+export function getClickBehaviorData(
+ clicked: ClickBehaviorClickObject,
+ clickBehavior: ClickBehaviorProperties,
+) {
+ // The spread (vs picking fields) preserves the linkType discrimination, so
+ // callers can narrow targetId.
+ return {
+ ...clickBehavior,
+ data: getDataFromClicked(clicked),
+ extraData: clicked.extraData,
+ };
+}
+
+export function getParameterIdValuePairs(
+ parameterMapping: ClickBehaviorParameterMapping | undefined,
+ { data, extraData, clickBehavior }: ClickBehaviorDataOptions,
+): ParameterIdValuePair[] {
+ return Object.values(parameterMapping ?? {}).map(({ source, target, id }) => {
+ return [
+ id,
+ formatSourceForTarget(source, target, {
+ data,
+ extraData: extraData ?? {},
+ clickBehavior,
+ }),
+ ];
+ });
+}
+
+export function getParameterValuesBySlug(
+ parameterMapping: ClickBehaviorParameterMapping | undefined,
+ { data, extraData, clickBehavior }: ClickBehaviorDataOptions,
+): Record<string, ParameterValueOrArray> {
+ return Object.fromEntries(
+ Object.values(parameterMapping ?? {})
+ .map(({ source, target }) => [
+ getTargetForQueryParams(target, {
+ extraData: extraData ?? {},
+ clickBehavior,
+ }),
+ formatSourceForTarget(source, target, {
+ data,
+ extraData: extraData ?? {},
+ clickBehavior,
+ }),
+ ])
+ .filter(([key, value]) => key != null && value != null),
+ );
+}
+
+function getTypeForSource(
+ source: ClickBehaviorSource,
+ data: ValueAndColumnForColumnNameDate,
+ extraData: ClickBehaviorExtraData | undefined,
+): string {
+ if (source.type === "parameter") {
+ const parameters = extraData?.dashboard?.parameters ?? [];
+ const parameter = parameters.find((p) => p.id === source.id);
+ return parameter?.type ?? "text";
+ }
+
+ const datum = data[source.type][source.id.toLowerCase()] || [];
+ if (datum.column && isDate(datum.column)) {
+ return "date";
+ }
+
+ return "text";
+}
+
+function hasLinkTargetData(
+ clickBehavior: ClickBehaviorProperties,
+ extraData: DrillExtraData | undefined,
+) {
+ const { linkType, targetId } = clickBehavior;
+ if (linkType === "question") {
+ return targetId != null && extraData?.questions?.[targetId] != null;
+ } else if (linkType === "dashboard") {
+ return targetId != null && extraData?.dashboards?.[targetId] != null;
+ }
+ return true;
+}
diff --git a/frontend/src/metabase/dashboard/click-behavior/dashboard-click-drill.unit.spec.js b/frontend/src/metabase/dashboard/click-behavior/dashboard-click-drill.unit.spec.js
deleted file mode 100644
index d93832bdb1e..00000000000
--- a/frontend/src/metabase/dashboard/click-behavior/dashboard-click-drill.unit.spec.js
+++ /dev/null
@@ -1,112 +0,0 @@
-import { DashboardClickAction } from "./DashboardClickAction";
-import { getClickBehavior } from "./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/dashboard/click-behavior/dashboard-click-drill.unit.spec.ts b/frontend/src/metabase/dashboard/click-behavior/dashboard-click-drill.unit.spec.ts
new file mode 100644
index 00000000000..5355141cdcc
--- /dev/null
+++ b/frontend/src/metabase/dashboard/click-behavior/dashboard-click-drill.unit.spec.ts
@@ -0,0 +1,319 @@
+import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
+import Question from "metabase-lib/v1/Question";
+import type { ClickBehavior } from "metabase-types/api";
+import {
+ createMockCard,
+ createMockColumn,
+ createMockDashboard,
+ createMockParameter,
+} from "metabase-types/api/mocks";
+
+import { DashboardClickAction } from "./DashboardClickAction";
+import {
+ getClickBehavior,
+ getDashboardDrillLinkUrl,
+ getDashboardDrillParameters,
+ getDashboardDrillTab,
+ getDashboardDrillType,
+ getDashboardDrillUrl,
+} from "./dashboard-click-drill";
+
+const rootClickBehavior: ClickBehavior = {
+ type: "link",
+ linkType: "url",
+ linkTemplate: "",
+};
+const metricClickBehavior: ClickBehavior = { type: "actionMenu" };
+const dimensionClickBehavior: ClickBehavior = { type: "crossfilter" };
+
+const metricColumn = createMockColumn({ name: "count" });
+const dimensionColumn = createMockColumn({ name: "CATEGORY" });
+
+function buildSettings({
+ columns = {},
+ root,
+}: {
+ columns?: Record<string, ClickBehavior>;
+ root?: ClickBehavior;
+} = {}): ComputedVisualizationSettings {
+ const column_settings = Object.fromEntries(
+ Object.entries(columns).map(([name, click_behavior]) => [
+ JSON.stringify(["name", name]),
+ { click_behavior },
+ ]),
+ );
+ const settings: ComputedVisualizationSettings = {
+ 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);
+ });
+});
+
+const stateColumn = createMockColumn({ name: "STATE" });
+
+const targetDashboard = createMockDashboard({
+ id: 2,
+ parameters: [
+ createMockParameter({
+ id: "target-param",
+ name: "State",
+ slug: "state",
+ type: "category",
+ }),
+ createMockParameter({
+ id: "size-param",
+ name: "Size",
+ slug: "size",
+ type: "category",
+ default: "L",
+ }),
+ ],
+});
+
+const dashboardLink: ClickBehavior = {
+ type: "link",
+ linkType: "dashboard",
+ targetId: 2,
+ tabId: 7,
+ parameterMapping: {
+ "target-param": {
+ id: "target-param",
+ source: { type: "column", id: "STATE", name: "State" },
+ target: { type: "parameter", id: "target-param" },
+ },
+ },
+};
+
+const drillExtraData = {
+ dashboard: createMockDashboard({ id: 1 }),
+ dashboards: { 2: targetDashboard },
+ questions: { 5: createMockCard({ id: 5 }) },
+ parameters: [],
+};
+
+describe("getDashboardDrillType", () => {
+ it("resolves a URL link", () => {
+ const type = getDashboardDrillType({
+ settings: buildSettings({
+ root: { type: "link", linkType: "url", linkTemplate: "https://x" },
+ }),
+ });
+
+ expect(type).toBe("link-url");
+ });
+
+ it("resolves a link to another dashboard", () => {
+ const type = getDashboardDrillType({
+ settings: buildSettings({ root: dashboardLink }),
+ extraData: drillExtraData,
+ });
+
+ expect(type).toBe("dashboard-url");
+ });
+
+ it("resolves a link to the current dashboard as a reset", () => {
+ const type = getDashboardDrillType({
+ settings: buildSettings({
+ root: {
+ type: "link",
+ linkType: "dashboard",
+ targetId: 1,
+ parameterMapping: {},
+ },
+ }),
+ extraData: {
+ dashboard: createMockDashboard({ id: 1 }),
+ dashboards: { 1: createMockDashboard({ id: 1 }) },
+ },
+ });
+
+ expect(type).toBe("dashboard-reset");
+ });
+
+ it("resolves a question link", () => {
+ const type = getDashboardDrillType({
+ settings: buildSettings({
+ root: {
+ type: "link",
+ linkType: "question",
+ targetId: 5,
+ parameterMapping: {},
+ },
+ }),
+ extraData: drillExtraData,
+ });
+
+ expect(type).toBe("question-url");
+ });
+
+ it("resolves no drill when the link target is not loaded in extraData", () => {
+ const type = getDashboardDrillType({
+ settings: buildSettings({ root: dashboardLink }),
+ extraData: { dashboard: createMockDashboard({ id: 1 }) },
+ });
+
+ expect(type).toBeNull();
+ });
+});
+
+describe("getDashboardDrillTab", () => {
+ it("returns the tab targeted by a dashboard link", () => {
+ const tabId = getDashboardDrillTab({
+ settings: buildSettings({ root: dashboardLink }),
+ extraData: drillExtraData,
+ });
+
+ expect(tabId).toBe(7);
+ });
+});
+
+describe("getDashboardDrillParameters", () => {
+ it("pairs mapped parameter ids with clicked values", () => {
+ const pairs = getDashboardDrillParameters({
+ settings: buildSettings({
+ root: {
+ type: "crossfilter",
+ parameterMapping: {
+ "current-param": {
+ id: "current-param",
+ source: { type: "column", id: "STATE", name: "State" },
+ target: { type: "parameter", id: "current-param" },
+ },
+ },
+ },
+ }),
+ data: [{ col: stateColumn, value: "CA" }],
+ extraData: {
+ dashboard: createMockDashboard({ id: 1 }),
+ parameters: [
+ createMockParameter({
+ id: "current-param",
+ name: "State",
+ slug: "state",
+ type: "category",
+ }),
+ ],
+ },
+ });
+
+ expect(pairs).toEqual([["current-param", "CA"]]);
+ });
+});
+
+describe("getDashboardDrillUrl", () => {
+ it("builds the target dashboard URL with defaults, mapped values, and tab", () => {
+ const url = getDashboardDrillUrl({
+ settings: buildSettings({ root: dashboardLink }),
+ data: [{ col: stateColumn, value: "CA" }],
+ extraData: drillExtraData,
+ });
+
+ expect(url).toBe("/dashboard/2?state=CA&size=L&tab=7");
+ });
+});
+
+describe("getDashboardDrillLinkUrl", () => {
+ it("renders the link template with clicked values", () => {
+ const url = getDashboardDrillLinkUrl({
+ settings: buildSettings({
+ root: {
+ type: "link",
+ linkType: "url",
+ linkTemplate: "https://metabase.test/{{count}}",
+ },
+ }),
+ data: [{ col: createMockColumn({ name: "count" }), value: 42 }],
+ });
+
+ expect(url).toBe("https://metabase.test/42");
+ });
+});
+
+describe("DashboardClickAction", () => {
+ it("creates a click-behavior action for a chart click with a dimension-scoped behavior (#73448)", () => {
+ const actions = DashboardClickAction({
+ question: new Question(createMockCard()),
+ 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: new Question(createMockCard()),
+ clicked: {
+ column: metricColumn,
+ dimensions: [{ column: dimensionColumn, value: "Gadget" }],
+ extraData: { dashboard: {}, parameters: [] },
+ },
+ settings: buildSettings(),
+ });
+
+ expect(actions).toHaveLength(0);
+ });
+});
diff --git a/frontend/src/metabase/dashboard/click-behavior/types.ts b/frontend/src/metabase/dashboard/click-behavior/types.ts
new file mode 100644
index 00000000000..3031619959e
--- /dev/null
+++ b/frontend/src/metabase/dashboard/click-behavior/types.ts
@@ -0,0 +1,80 @@
+import type { ClickBehaviorExtraData } from "metabase/dashboard/utils/click-behavior";
+import type { ValueAndColumnForColumnNameDate } from "metabase/value-formatting";
+import type {
+ ClickObject,
+ ComputedVisualizationSettings,
+} from "metabase/visualizations/types";
+import type {
+ Card,
+ CardId,
+ ClickBehavior,
+ ClickBehaviorParameterMapping,
+ ClickBehaviorType,
+ DashboardId,
+ DashboardTabId,
+ ParameterId,
+ ParameterValueOrArray,
+} from "metabase-types/api";
+
+export type DashboardDrillType =
+ | "link-url"
+ | "question-url"
+ | "dashboard-url"
+ | "dashboard-filter"
+ | "dashboard-reset";
+
+export interface DrillExtraData extends ClickBehaviorExtraData {
+ questions?: Record<CardId, Card>;
+}
+
+// ClickObject with the shapes dashboards put in its untyped settings/extraData.
+export interface ClickBehaviorClickObject extends Omit<
+ ClickObject,
+ "settings" | "extraData"
+> {
+ settings?: ComputedVisualizationSettings;
+ extraData?: DrillExtraData;
+}
+
+type ClickBehaviorPropertiesBase = {
+ type: ClickBehaviorType;
+ parameterMapping?: ClickBehaviorParameterMapping;
+};
+
+// ClickBehavior flattened for uniform destructuring, discriminated on linkType
+// so targetId narrows to the matching id type.
+export type ClickBehaviorProperties = ClickBehaviorPropertiesBase &
+ (
+ | {
+ linkType?: never;
+ linkTemplate?: never;
+ tabId?: never;
+ targetId?: never;
+ }
+ | {
+ linkType: "url";
+ linkTemplate?: string;
+ tabId?: never;
+ targetId?: never;
+ }
+ | {
+ linkType: "question";
+ linkTemplate?: never;
+ tabId?: never;
+ targetId?: CardId;
+ }
+ | {
+ linkType: "dashboard";
+ linkTemplate?: never;
+ tabId?: DashboardTabId;
+ targetId?: DashboardId;
+ }
+ );
+
+export type ClickBehaviorDataOptions = {
+ data: ValueAndColumnForColumnNameDate;
+ extraData: ClickBehaviorExtraData | undefined;
+ clickBehavior: ClickBehavior;
+};
+
+export type ParameterIdValuePair = [ParameterId, ParameterValueOrArray | null];
diff --git a/frontend/src/metabase/dashboard/utils/click-behavior.ts b/frontend/src/metabase/dashboard/utils/click-behavior.ts
index 9e1c7fe92e0..9a170c29f90 100644
--- a/frontend/src/metabase/dashboard/utils/click-behavior.ts
+++ b/frontend/src/metabase/dashboard/utils/click-behavior.ts
@@ -48,7 +48,7 @@ interface SourceFilters {
userAttribute: (userAttribute: string) => boolean;
}
-interface ExtraData {
+export interface ClickBehaviorExtraData {
dashboard?: Dashboard;
parameters?: Parameter[];
dashboards?: Record<Dashboard["id"], Dashboard>;
@@ -273,7 +273,7 @@ export function formatSourceForTarget(
clickBehavior,
}: {
data: ValueAndColumnForColumnNameDate;
- extraData: ExtraData;
+ extraData: ClickBehaviorExtraData;
clickBehavior: ClickBehavior;
},
) {
@@ -364,7 +364,7 @@ export function getTargetForQueryParams(
extraData,
clickBehavior,
}: {
- extraData: ExtraData;
+ extraData: ClickBehaviorExtraData;
clickBehavior: ClickBehavior;
},
) {
@@ -381,7 +381,7 @@ function getParameter(
extraData,
clickBehavior,
}: {
- extraData: ExtraData;
+ extraData: ClickBehaviorExtraData;
clickBehavior: ClickBehavior;
},
): Parameter | undefined {