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
chore: convert column settings to typescript (#70302)
Uladzimir Havenchyka1909a240b52
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetFieldMetadataSidebar/DatasetFieldMetadataSidebar.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetFieldMetadataSidebar/DatasetFieldMetadataSidebar.tsxindex d217f1d75c9..c8bb3d72b73 100644--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetFieldMetadataSidebar/DatasetFieldMetadataSidebar.tsx+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetFieldMetadataSidebar/DatasetFieldMetadataSidebar.tsx@@ -30,6 +30,7 @@ import { Box, Radio, Stack, Tabs } from "metabase/ui";import { color } from "metabase/ui/colors";import {ColumnSettings,+ type ColumnSettingsProps,hasColumnSettingsWidgets,} from "metabase/visualizations/components/ColumnSettings";import { getGlobalSettingsForColumn } from "metabase/visualizations/lib/settings/column";@@ -162,14 +163,13 @@ function DatasetFieldMetadataSidebarInner({[onFieldMetadataChange],);- const columnSettingsProps = useMemo(+ const columnSettingsProps = useMemo<ColumnSettingsProps>(() => ({column: field,value: field.settings,onChangeSetting: handleFormattingSettingsChange,inheritedSettings: getGlobalSettingsForColumn(),variant: "form-field",- style: undefined,}),[field, handleFormattingSettingsChange],);diff --git a/frontend/src/metabase/visualizations/components/ChartSettingsWidget.tsx b/frontend/src/metabase/visualizations/components/ChartSettingsWidget.tsxindex 4fafe89a436..a2cd9ebeab5 100644--- a/frontend/src/metabase/visualizations/components/ChartSettingsWidget.tsx+++ b/frontend/src/metabase/visualizations/components/ChartSettingsWidget.tsx@@ -8,6 +8,8 @@ import { Box, Group, Icon, Text, Tooltip } from "metabase/ui";import { Root } from "./ChartSettingsWidget.styled";+export type ChartSettingsWidgetVariant = "default" | "form-field";+type Props = {title?: string;description?: string;@@ -16,7 +18,7 @@ type Props = {widget?: string | ComponentType<{ id: string }> | WidgetMount;inline?: boolean;props?: Record<string, unknown>;- variant?: "default" | "form-field";+ variant?: ChartSettingsWidgetVariant;dataTestId?: string;id: string;style?: CSSProperties;diff --git a/frontend/src/metabase/visualizations/components/ColumnSettings.jsx b/frontend/src/metabase/visualizations/components/ColumnSettings.tsxsimilarity index 59%rename from frontend/src/metabase/visualizations/components/ColumnSettings.jsxrename to frontend/src/metabase/visualizations/components/ColumnSettings.tsxindex 554b3844e1f..1261e250258 100644--- a/frontend/src/metabase/visualizations/components/ColumnSettings.jsx+++ b/frontend/src/metabase/visualizations/components/ColumnSettings.tsx@@ -1,12 +1,45 @@-/* eslint-disable react/prop-types */import { t } from "ttag";import NoResults from "assets/img/no_results.svg";import { EmptyState } from "metabase/common/components/EmptyState";-import ChartSettingsWidget from "metabase/visualizations/components/ChartSettingsWidget";+import ChartSettingsWidget, {+ type ChartSettingsWidgetVariant,+} from "metabase/visualizations/components/ChartSettingsWidget";import { getComputedSettings } from "metabase/visualizations/lib/settings";import { getSettingDefinitionsForColumn } from "metabase/visualizations/lib/settings/column";import { getSettingsWidgets } from "metabase/visualizations/lib/widgets";+import type {+ FormattableColumn,+ SettingsExtra,+} from "metabase/visualizations/types";+import type {+ ColumnSettings as ApiColumnSettings,+ Series,+ VisualizationSettings,+} from "metabase-types/api";++type CommonProps = {+ column: FormattableColumn;+ inheritedSettings?: ApiColumnSettings;+ onChange?: (settings: ApiColumnSettings) => void;+ onChangeSetting?: (settings: Partial<VisualizationSettings>) => void;+ allowlist?: ReadonlySet<string>;+ denylist?: ReadonlySet<string>;+ extraData?: Omit<SettingsExtra, "series">;+};++type GetWidgetsProps = CommonProps & {+ storedSettings: ApiColumnSettings;+};++type HasColumnSettingsWidgetsProps = CommonProps & {+ value?: ApiColumnSettings | null;+};++export type ColumnSettingsProps = HasColumnSettingsWidgetsProps & {+ style?: React.CSSProperties;+ variant?: ChartSettingsWidgetVariant;+};function getWidgets({column,@@ -17,20 +50,19 @@ function getWidgets({allowlist,denylist,extraData,-}) {+}: GetWidgetsProps) {// fake series- const series = [{ card: {}, data: { rows: [], cols: [] } }];+ const series: Series = [];// add a "unit" to make certain settings work- if (column.unit == null) {- column = { ...column, unit: "default" };- }+ const columnWithUnit: FormattableColumn =+ column.unit != null ? column : { ...column, unit: "default" };- const settingsDefs = getSettingDefinitionsForColumn(series, column);+ const settingsDefs = getSettingDefinitionsForColumn(series, columnWithUnit);const computedSettings = getComputedSettings(settingsDefs,- column,+ columnWithUnit,{ ...inheritedSettings, ...storedSettings },{ series, ...extraData },);@@ -39,7 +71,7 @@ function getWidgets({settingsDefs,storedSettings,computedSettings,- column,+ columnWithUnit,(changedSettings) => {if (onChange) {onChange({ ...storedSettings, ...changedSettings });@@ -58,8 +90,11 @@ function getWidgets({);}-export function hasColumnSettingsWidgets({ value, ...props }) {- const storedSettings = value || {};+export function hasColumnSettingsWidgets({+ value,+ ...props+}: HasColumnSettingsWidgetsProps) {+ const storedSettings = value ?? {};return getWidgets({ storedSettings, ...props }).length > 0;}@@ -68,8 +103,8 @@ export const ColumnSettings = ({value,variant = "default",...props-}) => {- const storedSettings = value || {};+}: ColumnSettingsProps) => {+ const storedSettings = value ?? {};const widgets = getWidgets({ storedSettings, ...props });return (@@ -79,7 +114,6 @@ export const ColumnSettings = ({<ChartSettingsWidgetkey={widget.id}{...widget}- unset={storedSettings[widget.id] === undefined}style={{marginLeft: 0,marginRight: 0,diff --git a/frontend/src/metabase/visualizations/components/ColumnSettings.unit.spec.tsx b/frontend/src/metabase/visualizations/components/ColumnSettings.unit.spec.tsxnew file mode 100644index 00000000000..f0b71e5a017--- /dev/null+++ b/frontend/src/metabase/visualizations/components/ColumnSettings.unit.spec.tsx@@ -0,0 +1,79 @@+import { renderWithProviders, screen } from "__support__/ui";+import { registerVisualizations } from "metabase/visualizations/register";+import {+ createMockDatetimeColumn,+ createMockField,+} from "metabase-types/api/mocks";++import { ColumnSettings, hasColumnSettingsWidgets } from "./ColumnSettings";++registerVisualizations();++describe("hasColumnSettingsWidgets", () => {+ it("returns true for a date DatasetColumn", () => {+ expect(+ hasColumnSettingsWidgets({ column: createMockDatetimeColumn() }),+ ).toBe(true);+ });++ describe("prove a raw Field flows through the same pipeline as a DatasetColumn", () => {+ it("returns true for a number Field", () => {+ expect(+ hasColumnSettingsWidgets({+ column: createMockField({+ base_type: "type/Integer",+ effective_type: "type/Integer",+ }),+ }),+ ).toBe(true);+ });+ });+});++describe("ColumnSettings", () => {+ it("renders formatting widgets for a number Field", () => {+ renderWithProviders(+ <ColumnSettings+ column={createMockField({+ base_type: "type/Integer",+ effective_type: "type/Integer",+ })}+ value={{}}+ />,+ );++ expect(screen.getByTestId("column-settings")).toBeInTheDocument();+ expect(+ screen.queryByText("No formatting settings"),+ ).not.toBeInTheDocument();+ });++ it("includes the default visualization's column settings for a number Field", () => {+ renderWithProviders(+ <ColumnSettings+ column={createMockField({+ base_type: "type/Integer",+ effective_type: "type/Integer",+ })}+ value={{}}+ />,+ );++ expect(screen.getByText("Show a mini bar chart")).toBeInTheDocument();+ });++ it("includes the default visualization's column settings for a string Field", () => {+ renderWithProviders(+ <ColumnSettings+ column={createMockField({+ base_type: "type/Text",+ effective_type: "type/Text",+ semantic_type: null,+ })}+ value={{}}+ />,+ );++ expect(screen.getByText("Display as")).toBeInTheDocument();+ });+});diff --git a/frontend/src/metabase/visualizations/lib/settings/column.ts b/frontend/src/metabase/visualizations/lib/settings/column.tsindex f6685525a24..f6e690e9d29 100644--- a/frontend/src/metabase/visualizations/lib/settings/column.ts+++ b/frontend/src/metabase/visualizations/lib/settings/column.ts@@ -13,7 +13,7 @@ import {} from "metabase/utils/formatting";import { hasHour } from "metabase/utils/formatting/datetime-utils";import MetabaseSettings from "metabase/utils/settings";-import { getVisualizationRaw } from "metabase/visualizations";+import { getVisualization, getVisualizationRaw } from "metabase/visualizations";import {getDateFormatFromStyle,getDateStyleOptionsForUnit,@@ -29,6 +29,7 @@ import {} from "metabase/visualizations/shared/settings/column";import type {ComputedVisualizationSettings,+ FormattableColumn,VisualizationSettingsDefinitions,} from "metabase/visualizations/types";import {@@ -348,7 +349,7 @@ export const NUMBER_COLUMN_SETTINGS: VisualizationSettingsDefinitions = {}return (settings.number_style !== "currency" ||- series[0].card.display !== "table"+ series[0]?.card.display !== "table");},readDependencies: ["number_style"],@@ -472,9 +473,12 @@ const COMMON_COLUMN_SETTINGS: VisualizationSettingsDefinitions = {export function getSettingDefinitionsForColumn(series: Series,- column: DatasetColumn,+ column: FormattableColumn,) {- const visualization = getVisualizationRaw(series);+ // ColumnSettings passes an empty fake series when formatting outside a viz;+ // fall back to the default visualization's column settings in that case+ const visualization =+ series.length > 0 ? getVisualizationRaw(series) : getVisualization(null);const extraColumnSettings =typeof visualization?.columnSettings === "function"? visualization.columnSettings(column)diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.tsindex 6bd44e75e04..083faab27e2 100644--- a/frontend/src/metabase/visualizations/types/visualization.ts+++ b/frontend/src/metabase/visualizations/types/visualization.ts@@ -28,6 +28,7 @@ import type {DashboardId,DatasetColumn,DatasetData,+ Field,IconName,RawSeries,RowValue,@@ -416,6 +417,14 @@ export type DatasetColumnSettingDefinition<TProps extends Record<string, unknown> = Record<string, unknown>,> = VisualizationSettingDefinition<DatasetColumn, TValue, TProps>;+/**+ * current we work with DatasetColumn and Field, but their shapes are different+ */+export type FormattableColumn = Omit<DatasetColumn, "id" | "source"> & {+ id?: DatasetColumn["id"] | Field["id"];+ source?: DatasetColumn["source"];+};+export type SeriesSettingDefinition<TValue = unknown,TProps extends Record<string, unknown> = Record<string, unknown>,@@ -670,7 +679,7 @@ export type VisualizationDefinition = {isSensible?: (data: DatasetData) => boolean;columnSettings?:| VisualizationSettingsDefinitions- | ((column: DatasetColumn) => VisualizationSettingsDefinitions);+ | ((column: FormattableColumn) => VisualizationSettingsDefinitions);// checkRenderable throws an error if a visualization is not renderablecheckRenderable: (series: Series,diff --git a/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx b/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsxindex d8799173097..db460563b1b 100644--- a/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx+++ b/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx@@ -13,6 +13,7 @@ import {} from "metabase/visualizations/shared/utils/sizes";import type {ColumnSettingDefinition,+ FormattableColumn,VisualizationDefinition,VisualizationPassThroughProps,VisualizationProps,@@ -105,7 +106,7 @@ const vizDefinition: VisualizationDefinition = {},// TODO Unify with the same code in Table viz- columnSettings: (column: DatasetColumn) => {+ columnSettings: (column: FormattableColumn) => {const settings: Record<string,ColumnSettingDefinition<unknown, unknown>diff --git a/frontend/src/metabase/visualizations/visualizations/Table/definition.ts b/frontend/src/metabase/visualizations/visualizations/Table/definition.tsindex 8d000ec2b63..0bdc5878317 100644--- a/frontend/src/metabase/visualizations/visualizations/Table/definition.ts+++ b/frontend/src/metabase/visualizations/visualizations/Table/definition.ts@@ -28,6 +28,7 @@ import {import type {ColumnSettingDefinition,ComputedVisualizationSettings,+ FormattableColumn,VisualizationDefinition,} from "metabase/visualizations/types";import {@@ -43,7 +44,6 @@ import {} from "metabase-lib/v1/types/utils/isa";import type {ColumnSettings,- DatasetColumn,Series,VisualizationSettings,} from "metabase-types/api";@@ -273,7 +273,7 @@ export const TABLE_DEFINITION = {},},- columnSettings: (column: DatasetColumn) => {+ columnSettings: (column: FormattableColumn) => {const settings: Record<string,ColumnSettingDefinition<unknown, unknown>@@ -370,18 +370,8 @@ export const TABLE_DEFINITION = {getHidden: (_, settings) =>settings["view_as"] !== "link" && settings["view_as"] !== "email_link",readDependencies: ["view_as"],- getProps: (- column,- settings,- onChange,- {- series: [- {- data: { cols },- },- ],- },- ) => {+ getProps: (column, settings, onChange, { series }) => {+ const cols = series[0]?.data.cols ?? [];return {options: cols.map((column) => column.name),placeholder: t`Link to {{bird_id}}`,@@ -396,18 +386,8 @@ export const TABLE_DEFINITION = {getDefault: () => null,getHidden: (_, settings) => settings["view_as"] !== "link",readDependencies: ["view_as"],- getProps: (- column,- settings,- onChange,- {- series: [- {- data: { cols },- },- ],- },- ) => {+ getProps: (column, settings, onChange, { series }) => {+ const cols = series[0]?.data.cols ?? [];return {options: cols.map((column) => column.name),placeholder: t`http://toucan.example/{{bird_id}}`,