Skip to content

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

Move metabase/utils/click-behavior helpers into metabase/dashboard (#72512)

Romeo Van Snick4730f8aa9234
diff --git a/frontend/src/metabase-lib/v1/parameters/utils/click-behavior.unit.spec.ts b/frontend/src/metabase-lib/v1/parameters/utils/click-behavior.unit.spec.ts
index e82ec9aba0f..f6dbcc6fcad 100644
--- a/frontend/src/metabase-lib/v1/parameters/utils/click-behavior.unit.spec.ts
+++ b/frontend/src/metabase-lib/v1/parameters/utils/click-behavior.unit.spec.ts
@@ -87,7 +87,7 @@ const emptyData = {
userAttribute: {},
};
-describe("metabase/utils/click-behavior", () => {
+describe("metabase-lib/v1/parameters/utils/click-behavior", () => {
describe("getDataFromClicked", () => {
it("should pull out column values from data", () => {
const column = createMockColumn({ name: "price" });
diff --git a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/ClickBehaviorSidebar.tsx b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/ClickBehaviorSidebar.tsx
index 47f7c447d88..9059d3e5ad8 100644
--- a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/ClickBehaviorSidebar.tsx
+++ b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/ClickBehaviorSidebar.tsx
@@ -8,7 +8,7 @@ import {
type DashboardContextReturned,
useDashboardContext,
} from "metabase/dashboard/context";
-import { isTableDisplay } from "metabase/utils/click-behavior";
+import { isTableDisplay } from "metabase/dashboard/utils";
import {
canSaveClickBehavior,
clickBehaviorIsValid,
diff --git a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/ClickBehaviorSidebarContent.tsx b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/ClickBehaviorSidebarContent.tsx
index 642051a6d0e..e8389ccb2f4 100644
--- a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/ClickBehaviorSidebarContent.tsx
+++ b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/ClickBehaviorSidebarContent.tsx
@@ -2,7 +2,7 @@ import { getIn } from "icepick";
import { useMemo } from "react";
import { getDashcardData } from "metabase/dashboard/selectors";
-import { isTableDisplay } from "metabase/utils/click-behavior";
+import { isTableDisplay } from "metabase/dashboard/utils";
import { useSelector } from "metabase/utils/redux";
import type { UiParameter } from "metabase-lib/v1/parameters/types";
import type {
diff --git a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/ClickBehaviorSidebarHeader/ClickBehaviorSidebarHeader.tsx b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/ClickBehaviorSidebarHeader/ClickBehaviorSidebarHeader.tsx
index 80ea89d009c..ccbd3ab0eb0 100644
--- a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/ClickBehaviorSidebarHeader/ClickBehaviorSidebarHeader.tsx
+++ b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/ClickBehaviorSidebarHeader/ClickBehaviorSidebarHeader.tsx
@@ -1,7 +1,7 @@
import { jt, t } from "ttag";
+import { isTableDisplay } from "metabase/dashboard/utils";
import { Box, Icon } from "metabase/ui";
-import { isTableDisplay } from "metabase/utils/click-behavior";
import type { DashboardCard, DatasetColumn } from "metabase-types/api";
import S from "../ClickBehaviorSidebar.module.css";
diff --git a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/LinkOptions/CustomURLPicker.tsx b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/LinkOptions/CustomURLPicker.tsx
index cb9479933b6..1091dd673e4 100644
--- a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/LinkOptions/CustomURLPicker.tsx
+++ b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/LinkOptions/CustomURLPicker.tsx
@@ -4,6 +4,7 @@ import { useCallback, useState } from "react";
import { t } from "ttag";
import CS from "metabase/css/core/index.css";
+import { isTableDisplay } from "metabase/dashboard/utils";
import {
Button,
Flex,
@@ -12,7 +13,6 @@ import {
Text,
TextInputBlurChange,
} from "metabase/ui";
-import { isTableDisplay } from "metabase/utils/click-behavior";
import type { UiParameter } from "metabase-lib/v1/parameters/types";
import { clickBehaviorIsValid } from "metabase-lib/v1/parameters/utils/click-behavior";
import type {
diff --git a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/LinkOptions/LinkOptions.tsx b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/LinkOptions/LinkOptions.tsx
index 5797dc292f6..cd312d36143 100644
--- a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/LinkOptions/LinkOptions.tsx
+++ b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/LinkOptions/LinkOptions.tsx
@@ -3,8 +3,8 @@ import { useCallback } from "react";
import { t } from "ttag";
import CS from "metabase/css/core/index.css";
+import { isTableDisplay } from "metabase/dashboard/utils";
import type { IconName } from "metabase/ui";
-import { isTableDisplay } from "metabase/utils/click-behavior";
import type { UiParameter } from "metabase-lib/v1/parameters/types";
import type {
ArbitraryCustomDestinationClickBehavior,
diff --git a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/TableClickBehaviorView/TableClickBehaviorView.tsx b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/TableClickBehaviorView/TableClickBehaviorView.tsx
index f9594564544..60e7e88e5d3 100644
--- a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/TableClickBehaviorView/TableClickBehaviorView.tsx
+++ b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/TableClickBehaviorView/TableClickBehaviorView.tsx
@@ -4,7 +4,6 @@ import { t } from "ttag";
import _ from "underscore";
import CS from "metabase/css/core/index.css";
-import { hasActionsMenu } from "metabase/utils/click-behavior";
import type {
ClickBehavior,
ClickBehaviorType,
@@ -12,6 +11,8 @@ import type {
DatasetColumn,
} from "metabase-types/api";
+import { hasActionsMenu } from "../../../utils";
+
import { Column } from "./Column";
const COLUMN_SORTING_ORDER_BY_CLICK_BEHAVIOR_TYPE = [
diff --git a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/hooks.ts b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/hooks.ts
index db5ca393611..bb902024156 100644
--- a/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/hooks.ts
+++ b/frontend/src/metabase/dashboard/components/ClickBehaviorSidebar/hooks.ts
@@ -1,10 +1,11 @@
import { t } from "ttag";
import { getApplicationName } from "metabase/selectors/whitelabel";
-import { hasActionsMenu } from "metabase/utils/click-behavior";
import { useSelector } from "metabase/utils/redux";
import type { ClickBehaviorType, DashboardCard } from "metabase-types/api";
+import { hasActionsMenu } from "../../utils";
+
export function useClickBehaviorOptionName(
value: ClickBehaviorType,
dashcard: DashboardCard,
diff --git a/frontend/src/metabase/dashboard/components/DashCard/ClickBehaviorSidebarOverlay/ClickBehaviorSidebarOverlay.tsx b/frontend/src/metabase/dashboard/components/DashCard/ClickBehaviorSidebarOverlay/ClickBehaviorSidebarOverlay.tsx
index 7c7953e79c7..161c5754040 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/ClickBehaviorSidebarOverlay/ClickBehaviorSidebarOverlay.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/ClickBehaviorSidebarOverlay/ClickBehaviorSidebarOverlay.tsx
@@ -3,9 +3,10 @@ import { useCallback } from "react";
import { t } from "ttag";
import { Box, Flex, Icon } from "metabase/ui";
-import { getClickBehaviorDescription } from "metabase/utils/click-behavior";
import type { DashboardCard, QuestionDashboardCard } from "metabase-types/api";
+import { getClickBehaviorDescription } from "../../../utils";
+
import S from "./ClickBehaviorSidebarOverlay.module.css";
interface Props {
diff --git a/frontend/src/metabase/dashboard/hooks/use-click-behavior-data.ts b/frontend/src/metabase/dashboard/hooks/use-click-behavior-data.ts
index 0adf45079a3..a0bd5a73c01 100644
--- a/frontend/src/metabase/dashboard/hooks/use-click-behavior-data.ts
+++ b/frontend/src/metabase/dashboard/hooks/use-click-behavior-data.ts
@@ -11,13 +11,19 @@ import {
getParameterValuesBySlugMap,
getParameters,
} from "metabase/dashboard/selectors";
+import { Dashboards } from "metabase/entities/dashboards";
+import { Questions } from "metabase/entities/questions";
import type { State } from "metabase/redux/store";
import { getUserAttributes } from "metabase/selectors/user";
-import { getLinkTargets } from "metabase/utils/click-behavior";
import { useStore } from "metabase/utils/redux";
import type { ClickObject } from "metabase/visualizations/types";
import Question from "metabase-lib/v1/Question";
-import type { DashCardId } from "metabase-types/api";
+import type {
+ ClickBehavior,
+ DashCardId,
+ EntityCustomDestinationClickBehavior,
+ VisualizationSettings,
+} from "metabase-types/api";
type EntityObject = {
id: number | string;
@@ -123,3 +129,42 @@ export const useClickBehaviorData = ({
return { getExtraDataForClick };
};
+
+export function getLinkTargets(settings?: VisualizationSettings) {
+ const { click_behavior, column_settings = {} } = settings || {};
+ return [
+ click_behavior,
+ ...Object.values(column_settings).map(
+ (settings) => settings.click_behavior,
+ ),
+ ]
+ .filter(hasLinkedQuestionOrDashboard)
+ .map(mapLinkedEntityToEntityQuery);
+}
+
+function hasLinkedQuestionOrDashboard({
+ type,
+ linkType,
+}: {
+ type?: ClickBehavior["type"];
+ linkType?: EntityCustomDestinationClickBehavior["linkType"];
+} = {}) {
+ if (type === "link") {
+ return linkType === "question" || linkType === "dashboard";
+ }
+ return false;
+}
+
+function mapLinkedEntityToEntityQuery({
+ linkType,
+ targetId,
+}: {
+ linkType: EntityCustomDestinationClickBehavior["linkType"];
+ targetId: EntityCustomDestinationClickBehavior["targetId"];
+}) {
+ return {
+ entity: linkType === "question" ? Questions : Dashboards,
+ entityType: linkType,
+ entityId: targetId,
+ };
+}
diff --git a/frontend/src/metabase/dashboard/utils.ts b/frontend/src/metabase/dashboard/utils.ts
index 79d1144e5f4..68c0a41adfc 100644
--- a/frontend/src/metabase/dashboard/utils.ts
+++ b/frontend/src/metabase/dashboard/utils.ts
@@ -1,4 +1,6 @@
import type { Location } from "history";
+import { getIn } from "icepick";
+import { msgid, ngettext, t } from "ttag";
import _ from "underscore";
import type { SelectedTabId } from "metabase/redux/store";
@@ -26,12 +28,15 @@ import type {
CacheableDashboard,
Card,
CardId,
+ ClickBehavior,
+ ColumnSettings,
DashCardDataMap,
Dashboard,
DashboardCard,
DashboardCardLayoutAttrs,
Database,
Dataset,
+ DatasetQuery,
EmbedDataset,
Parameter,
ParameterId,
@@ -523,3 +528,72 @@ export function setDashboardHeaderParameterIndex(
result.splice(targetIndex, 0, movedParam);
return result;
}
+
+export function getClickBehaviorDescription(dashcard: DashboardCard) {
+ const noBehaviorMessage = hasActionsMenu(dashcard)
+ ? t`Open the drill-through menu`
+ : t`Do nothing`;
+ if (isTableDisplay(dashcard)) {
+ const columnSettings: Record<string, ColumnSettings> =
+ getIn(dashcard, ["visualization_settings", "column_settings"]) || {};
+
+ const count = Object.values(columnSettings).filter(
+ (settings) => settings.click_behavior != null,
+ ).length;
+
+ if (count === 0) {
+ return noBehaviorMessage;
+ }
+ return ngettext(
+ msgid`${count} column has custom behavior`,
+ `${count} columns have custom behavior`,
+ count,
+ );
+ }
+
+ if (
+ dashcard.visualization_settings == null ||
+ dashcard.visualization_settings.click_behavior == null
+ ) {
+ return noBehaviorMessage;
+ }
+
+ const clickBehavior = dashcard.visualization_settings
+ .click_behavior as ClickBehavior;
+
+ if (clickBehavior.type === "link") {
+ const { linkType } = clickBehavior;
+ return linkType == null
+ ? t`Go to...`
+ : linkType === "dashboard"
+ ? t`Go to dashboard`
+ : linkType === "question"
+ ? t`Go to question`
+ : t`Go to url`;
+ }
+
+ return t`Filter this dashboard`;
+}
+
+function isEmptyDatasetQuery(
+ datasetQuery: DatasetQuery | Record<string, never> | undefined | null,
+): datasetQuery is Record<string, never> | undefined {
+ return datasetQuery == null || Object.keys(datasetQuery).length === 0;
+}
+
+export function hasActionsMenu(dashcard: DashboardCard) {
+ if (isEmptyDatasetQuery(dashcard.card.dataset_query)) {
+ return false;
+ }
+
+ // This seems to work, but it isn't the right logic.
+ // The right thing to do would be to check for any drills. However, we'd need a "clicked" object for that.
+ const question = Question.create({
+ dataset_query: dashcard.card.dataset_query,
+ });
+ return !question.isNative();
+}
+
+export function isTableDisplay(dashcard: DashboardCard) {
+ return dashcard?.card?.display === "table";
+}
diff --git a/frontend/src/metabase/utils/click-behavior.js b/frontend/src/metabase/utils/click-behavior.js
deleted file mode 100644
index 8853f90b9f2..00000000000
--- a/frontend/src/metabase/utils/click-behavior.js
+++ /dev/null
@@ -1,84 +0,0 @@
-import { getIn } from "icepick";
-import { msgid, ngettext, t } from "ttag";
-
-import { Dashboards } from "metabase/entities/dashboards";
-import { Questions } from "metabase/entities/questions";
-import Question from "metabase-lib/v1/Question";
-
-export function getClickBehaviorDescription(dashcard) {
- const noBehaviorMessage = hasActionsMenu(dashcard)
- ? t`Open the drill-through menu`
- : t`Do nothing`;
- if (isTableDisplay(dashcard)) {
- const count = Object.values(
- getIn(dashcard, ["visualization_settings", "column_settings"]) || {},
- ).filter((settings) => settings.click_behavior != null).length;
- if (count === 0) {
- return noBehaviorMessage;
- }
- return ngettext(
- msgid`${count} column has custom behavior`,
- `${count} columns have custom behavior`,
- count,
- );
- }
- const { click_behavior: clickBehavior } = dashcard.visualization_settings;
- if (clickBehavior == null) {
- return noBehaviorMessage;
- }
- if (clickBehavior.type === "link") {
- const { linkType } = clickBehavior;
- return linkType == null
- ? t`Go to...`
- : linkType === "dashboard"
- ? t`Go to dashboard`
- : linkType === "question"
- ? t`Go to question`
- : t`Go to url`;
- }
-
- return t`Filter this dashboard`;
-}
-
-export function hasActionsMenu(dashcard) {
- if (!dashcard.card.dataset_query) {
- return false;
- }
- // This seems to work, but it isn't the right logic.
- // The right thing to do would be to check for any drills. However, we'd need a "clicked" object for that.
- const question = Question.create({
- dataset_query: dashcard.card.dataset_query,
- });
- return !question.isNative();
-}
-
-export function isTableDisplay(dashcard) {
- return dashcard?.card?.display === "table";
-}
-
-export function getLinkTargets(settings) {
- const { click_behavior, column_settings = {} } = settings || {};
- return [
- click_behavior,
- ...Object.values(column_settings).map(
- (settings) => settings.click_behavior,
- ),
- ]
- .filter(hasLinkedQuestionOrDashboard)
- .map(mapLinkedEntityToEntityQuery);
-}
-
-function hasLinkedQuestionOrDashboard({ type, linkType } = {}) {
- if (type === "link") {
- return linkType === "question" || linkType === "dashboard";
- }
- return false;
-}
-
-function mapLinkedEntityToEntityQuery({ linkType, targetId }) {
- return {
- entity: linkType === "question" ? Questions : Dashboards,
- entityType: linkType,
- entityId: targetId,
- };
-}