Skip to content

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

Move viz sensibility into viz folder (#74130)

Fraseree4fba0ef3a9
diff --git a/frontend/lint/module-boundaries.mjs b/frontend/lint/module-boundaries.mjs
index 3a0bf78c2d8..e6c20c1572b 100644
--- a/frontend/lint/module-boundaries.mjs
+++ b/frontend/lint/module-boundaries.mjs
@@ -69,6 +69,7 @@ const elements = [
createElement({ type: "shared", name: "data-studio", enforceOutgoing: true }),
createElement({ type: "shared", name: "databases", enforceOutgoing: true }),
createElement({ type: "shared", name: "detail-view", enforceOutgoing: true }),
+ createElement({ type: "shared", name: "documents", enforceOutgoing: true }),
createElement({ type: "shared", name: "forms", enforceOutgoing: true }),
createElement({ type: "shared", name: "history", enforceOutgoing: true }),
createElement({ type: "shared", name: "hoc", enforceOutgoing: true }),
diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/hooks/use-sensible-visualizations.ts b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/hooks/use-sensible-visualizations.ts
index c49f381bf1d..97894b015dc 100644
--- a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/hooks/use-sensible-visualizations.ts
+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/hooks/use-sensible-visualizations.ts
@@ -1,6 +1,6 @@
import { useMemo, useRef } from "react";
-import { getSensibleVisualizations } from "metabase/query_builder/components/chart-type-selector";
+import { getSensibleVisualizations } from "metabase/visualizations/lib/sensibility";
import type { CardDisplayType } from "metabase-types/api";
import { useSdkQuestionContext } from "../context";
diff --git a/frontend/src/metabase/documents/utils/visualizationUtils.ts b/frontend/src/metabase/documents/utils/visualizationUtils.ts
index 41f925d4d09..68829f43832 100644
--- a/frontend/src/metabase/documents/utils/visualizationUtils.ts
+++ b/frontend/src/metabase/documents/utils/visualizationUtils.ts
@@ -1,9 +1,9 @@
import { useMemo } from "react";
-import { getSensibleVisualizations } from "metabase/query_builder/components/chart-type-selector/use-question-visualization-state";
import type { IconName } from "metabase/ui";
import { isNotNull } from "metabase/utils/types";
import visualizations from "metabase/visualizations";
+import { getSensibleVisualizations } from "metabase/visualizations/lib/sensibility";
import type { Dataset, VisualizationDisplay } from "metabase-types/api";
export interface VisualizationItem {
diff --git a/frontend/src/metabase/query_builder/components/chart-type-selector/ChartTypeList/ChartTypeList.unit.spec.tsx b/frontend/src/metabase/query_builder/components/chart-type-selector/ChartTypeList/ChartTypeList.unit.spec.tsx
index 42c022f6dc0..407bbff9cd3 100644
--- a/frontend/src/metabase/query_builder/components/chart-type-selector/ChartTypeList/ChartTypeList.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/chart-type-selector/ChartTypeList/ChartTypeList.unit.spec.tsx
@@ -1,10 +1,9 @@
import { renderWithProviders, screen, within } from "__support__/ui";
import { checkNotNull } from "metabase/utils/types";
import visualizations from "metabase/visualizations";
+import { DEFAULT_VIZ_ORDER } from "metabase/visualizations/lib/viz-order";
import registerVisualizations from "metabase/visualizations/register";
-import { DEFAULT_VIZ_ORDER } from "../viz-order";
-
import { ChartTypeList, type ChartTypeListProps } from "./ChartTypeList";
registerVisualizations();
diff --git a/frontend/src/metabase/query_builder/components/chart-type-selector/index.ts b/frontend/src/metabase/query_builder/components/chart-type-selector/index.ts
index ecba5a1ca8e..291bd6b3e27 100644
--- a/frontend/src/metabase/query_builder/components/chart-type-selector/index.ts
+++ b/frontend/src/metabase/query_builder/components/chart-type-selector/index.ts
@@ -1,6 +1,4 @@
-export * from "./sensibility-grouping";
export * from "./ChartTypeList";
export * from "./ChartTypeOption";
export * from "./ChartTypeSettings";
export * from "./use-question-visualization-state";
-export * from "./viz-order";
diff --git a/frontend/src/metabase/query_builder/components/chart-type-selector/use-question-visualization-state.ts b/frontend/src/metabase/query_builder/components/chart-type-selector/use-question-visualization-state.ts
index f4b5061ed91..363d3ce9677 100644
--- a/frontend/src/metabase/query_builder/components/chart-type-selector/use-question-visualization-state.ts
+++ b/frontend/src/metabase/query_builder/components/chart-type-selector/use-question-visualization-state.ts
@@ -1,19 +1,8 @@
import { useCallback } from "react";
-import _ from "underscore";
import visualizations from "metabase/visualizations";
-import { sanitizeResultData } from "metabase/visualizations/shared/utils/data";
import type Question from "metabase-lib/v1/Question";
-import {
- type Dataset,
- type QueryVisualizationDisplayType,
- type VisualizationDisplay,
- isCardDisplayType,
-} from "metabase-types/api";
-import { isCustomVizDisplay } from "metabase-types/guards/visualization";
-
-import { groupVisualizationsBySensibility } from "./sensibility-grouping";
-import { DEFAULT_VIZ_ORDER } from "./viz-order";
+import type { VisualizationDisplay } from "metabase-types/api";
export type UseQuestionVisualizationStateProps = {
question?: Question;
@@ -49,53 +38,3 @@ export const useQuestionVisualizationState = ({
updateQuestionVisualization,
};
};
-
-export type GetSensibleVisualizationsProps = {
- result: Dataset | null;
-};
-
-const isSupportedVisualization = (
- display: string,
-): display is QueryVisualizationDisplayType =>
- isCardDisplayType(display) || isCustomVizDisplay(display);
-
-export const getSensibleVisualizations = ({
- result,
-}: GetSensibleVisualizationsProps) => {
- const availableVizTypes = Array.from(visualizations.entries()).reduce<
- QueryVisualizationDisplayType[]
- >((types, [vizType, config]) => {
- if (!config.hidden && isSupportedVisualization(vizType)) {
- types.push(vizType);
- }
-
- return types;
- }, []);
-
- const orderedVizTypes = _.union(DEFAULT_VIZ_ORDER, availableVizTypes);
-
- if (result?.data) {
- const sanitizedData = sanitizeResultData(result.data);
-
- const { recommended, sensible, nonsensible } =
- groupVisualizationsBySensibility({
- orderedVizTypes,
- data: sanitizedData,
- });
-
- return {
- sensibleVisualizations: recommended,
- nonSensibleVisualizations: [...sensible, ...nonsensible],
- };
- }
-
- const [sensibleVisualizations, nonSensibleVisualizations] = _.partition(
- orderedVizTypes,
- (vizType) => {
- const viz = visualizations.get(vizType);
- return Boolean(viz?.isSensible);
- },
- );
-
- return { sensibleVisualizations, nonSensibleVisualizations };
-};
diff --git a/frontend/src/metabase/query_builder/components/view/sidebars/ChartTypeSidebar/ChartTypeSidebar.tsx b/frontend/src/metabase/query_builder/components/view/sidebars/ChartTypeSidebar/ChartTypeSidebar.tsx
index c506e5a0a25..764acf3198f 100644
--- a/frontend/src/metabase/query_builder/components/view/sidebars/ChartTypeSidebar/ChartTypeSidebar.tsx
+++ b/frontend/src/metabase/query_builder/components/view/sidebars/ChartTypeSidebar/ChartTypeSidebar.tsx
@@ -9,9 +9,7 @@ import { PLUGIN_CUSTOM_VIZ } from "metabase/plugins";
import { updateQuestion } from "metabase/query_builder/actions";
import {
ChartTypeSettings,
- type GetSensibleVisualizationsProps,
type UseQuestionVisualizationStateProps,
- getSensibleVisualizations,
useQuestionVisualizationState,
} from "metabase/query_builder/components/chart-type-selector";
import { useDispatch } from "metabase/redux";
@@ -20,6 +18,10 @@ import {
onOpenChartSettings,
setUIControls,
} from "metabase/redux/query-builder";
+import {
+ type GetSensibleVisualizationsProps,
+ getSensibleVisualizations,
+} from "metabase/visualizations/lib/sensibility";
import * as Lib from "metabase-lib";
import type Question from "metabase-lib/v1/Question";
import type { VisualizationDisplay } from "metabase-types/api";
diff --git a/frontend/src/metabase/query_builder/components/chart-type-selector/sensibility-grouping.ts b/frontend/src/metabase/visualizations/lib/sensibility.ts
similarity index 74%
rename from frontend/src/metabase/query_builder/components/chart-type-selector/sensibility-grouping.ts
rename to frontend/src/metabase/visualizations/lib/sensibility.ts
index bd98bd7317f..274a1a6f302 100644
--- a/frontend/src/metabase/query_builder/components/chart-type-selector/sensibility-grouping.ts
+++ b/frontend/src/metabase/visualizations/lib/sensibility.ts
@@ -1,6 +1,7 @@
import _ from "underscore";
import visualizations from "metabase/visualizations";
+import { sanitizeResultData } from "metabase/visualizations/shared/utils/data";
import {
hasLatitudeAndLongitudeColumns,
isCountry,
@@ -13,10 +14,14 @@ import {
} from "metabase-lib/v1/types/utils/isa";
import {
type CardDisplayType,
+ type Dataset,
type DatasetData,
type QueryVisualizationDisplayType,
isCardDisplayType,
} from "metabase-types/api";
+import { isCustomVizDisplay } from "metabase-types/guards/visualization";
+
+import { DEFAULT_VIZ_ORDER } from "./viz-order";
const MAX_RECOMMENDED = 12;
@@ -160,3 +165,53 @@ function getRecommendedVisualizations(
}
return recommended;
}
+
+export type GetSensibleVisualizationsProps = {
+ result: Dataset | null;
+};
+
+const isSupportedVisualization = (
+ display: string,
+): display is QueryVisualizationDisplayType =>
+ isCardDisplayType(display) || isCustomVizDisplay(display);
+
+export const getSensibleVisualizations = ({
+ result,
+}: GetSensibleVisualizationsProps) => {
+ const availableVizTypes = Array.from(visualizations.entries()).reduce<
+ QueryVisualizationDisplayType[]
+ >((types, [vizType, config]) => {
+ if (!config.hidden && isSupportedVisualization(vizType)) {
+ types.push(vizType);
+ }
+
+ return types;
+ }, []);
+
+ const orderedVizTypes = _.union(DEFAULT_VIZ_ORDER, availableVizTypes);
+
+ if (result?.data) {
+ const sanitizedData = sanitizeResultData(result.data);
+
+ const { recommended, sensible, nonsensible } =
+ groupVisualizationsBySensibility({
+ orderedVizTypes,
+ data: sanitizedData,
+ });
+
+ return {
+ sensibleVisualizations: recommended,
+ nonSensibleVisualizations: [...sensible, ...nonsensible],
+ };
+ }
+
+ const [sensibleVisualizations, nonSensibleVisualizations] = _.partition(
+ orderedVizTypes,
+ (vizType) => {
+ const viz = visualizations.get(vizType);
+ return Boolean(viz?.isSensible);
+ },
+ );
+
+ return { sensibleVisualizations, nonSensibleVisualizations };
+};
diff --git a/frontend/src/metabase/query_builder/components/chart-type-selector/sensibility-grouping.unit.spec.ts b/frontend/src/metabase/visualizations/lib/sensibility.unit.spec.ts
similarity index 98%
rename from frontend/src/metabase/query_builder/components/chart-type-selector/sensibility-grouping.unit.spec.ts
rename to frontend/src/metabase/visualizations/lib/sensibility.unit.spec.ts
index adef15b415e..22f8a2cc024 100644
--- a/frontend/src/metabase/query_builder/components/chart-type-selector/sensibility-grouping.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/lib/sensibility.unit.spec.ts
@@ -8,7 +8,7 @@ import {
createMockNumericColumn,
} from "metabase-types/api/mocks";
-import { groupVisualizationsBySensibility } from "./sensibility-grouping";
+import { groupVisualizationsBySensibility } from "./sensibility";
import { DEFAULT_VIZ_ORDER } from "./viz-order";
registerVisualizations();
diff --git a/frontend/src/metabase/query_builder/components/chart-type-selector/viz-order.ts b/frontend/src/metabase/visualizations/lib/viz-order.ts
similarity index 100%
rename from frontend/src/metabase/query_builder/components/chart-type-selector/viz-order.ts
rename to frontend/src/metabase/visualizations/lib/viz-order.ts