Skip to content

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

Apply field settings to parameter field widget (#67428)

Fraser23eae39c3c78
diff --git a/frontend/src/metabase-types/api/field.ts b/frontend/src/metabase-types/api/field.ts
index b82072bef7a..6b7be5e35bd 100644
--- a/frontend/src/metabase-types/api/field.ts
+++ b/frontend/src/metabase-types/api/field.ts
@@ -116,6 +116,7 @@ export interface Field {
export interface FieldFormattingSettings {
currency?: string;
+ number_separators?: string;
}
export interface GetFieldRequest {
diff --git a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidget.tsx b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidget.tsx
index a7509367f04..bbfa6e1b667 100644
--- a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidget.tsx
+++ b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidget.tsx
@@ -113,9 +113,11 @@ export function ParameterFieldWidget({
fields={fields}
autoFocus={index === 0}
multi={supportsMultipleValues}
- formatOptions={
- operator && getFilterArgumentFormatOptions(operator, index)
- }
+ formatOptions={{
+ ...(operator &&
+ getFilterArgumentFormatOptions(operator, index)),
+ ...fields?.[0]?.settings,
+ }}
color="brand"
minWidth={300}
maxWidth={400}
diff --git a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidget.unit.spec.tsx b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidget.unit.spec.tsx
index 36beebd7701..6a122dfeca0 100644
--- a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidget.unit.spec.tsx
+++ b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidget.unit.spec.tsx
@@ -4,20 +4,34 @@ import {
setupParameterSearchValuesEndpoint,
setupParameterValuesEndpoints,
} from "__support__/server-mocks";
+import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen } from "__support__/ui";
+import { getMetadata } from "metabase/selectors/metadata";
import type Field from "metabase-lib/v1/metadata/Field";
import { createMockUiParameter } from "metabase-lib/v1/parameters/mock";
import type { UiParameter } from "metabase-lib/v1/parameters/types";
-import type { ParameterValues } from "metabase-types/api";
-import { createMockParameterValues } from "metabase-types/api/mocks";
+import type { Field as FieldType, ParameterValues } from "metabase-types/api";
+import {
+ createMockField,
+ createMockParameterValues,
+} from "metabase-types/api/mocks";
+import {
+ REVIEWS_ID,
+ createReviewsTable,
+ createSampleDatabase,
+} from "metabase-types/api/mocks/presets";
+import { createMockState } from "metabase-types/store/mocks";
import { ParameterFieldWidget } from "./ParameterFieldWidget";
+const FIELD_ID = 100;
+
type SetupOpts = {
parameter?: UiParameter;
fields?: Field[];
parameterValues?: ParameterValues;
parameterSearchValues?: Record<string, ParameterValues>;
+ fieldSettings?: Partial<FieldType>;
};
function setup({
@@ -25,19 +39,45 @@ function setup({
fields = [],
parameterValues = createMockParameterValues(),
parameterSearchValues = {},
+ fieldSettings,
}: SetupOpts = {}) {
setupParameterValuesEndpoints(parameterValues);
Object.entries(parameterSearchValues).forEach(([query, values]) => {
setupParameterSearchValuesEndpoint(query, values);
});
+ const database = createSampleDatabase({
+ tables: [
+ createReviewsTable({
+ fields: [
+ createMockField({
+ id: FIELD_ID,
+ table_id: REVIEWS_ID,
+ ...fieldSettings,
+ }),
+ ],
+ }),
+ ],
+ });
+
+ const storeInitialState = createMockState({
+ entities: createMockEntitiesState({
+ databases: [database],
+ }),
+ });
+
+ const metadata = getMetadata(storeInitialState);
+ const field = metadata.field(FIELD_ID);
+ const fieldsToUse = field ? [field] : fields;
+
const setValue = jest.fn();
renderWithProviders(
<ParameterFieldWidget
parameter={parameter}
- fields={fields}
+ fields={fieldsToUse}
setValue={setValue}
/>,
+ { storeInitialState },
);
return { setValue };
@@ -254,4 +294,57 @@ describe("ParameterFieldWidget", () => {
expect(setValue).not.toHaveBeenCalled();
});
});
+
+ describe("field formatting", () => {
+ const numericFieldParameter = createMockUiParameter({
+ values_query_type: "list",
+ values_source_type: "static-list",
+ values_source_config: {
+ values: [[1000], [2000], [3000]],
+ },
+ });
+
+ const numericFieldValues = createMockParameterValues({
+ values: [[1000], [2000], [3000]],
+ });
+
+ const numericFieldSettings = {
+ display_name: "Amount",
+ base_type: "type/BigInteger",
+ effective_type: "type/BigInteger",
+ has_field_values: "list",
+ values: [[1000], [2000], [3000]],
+ } satisfies Partial<FieldType>;
+
+ it("should format numbers with default separators when no custom settings", async () => {
+ setup({
+ parameter: numericFieldParameter,
+ parameterValues: numericFieldValues,
+ fieldSettings: numericFieldSettings,
+ });
+
+ // need to wait for the settings to load
+ expect(await screen.findByText("1,000")).toBeInTheDocument();
+ expect(screen.getByText("2,000")).toBeInTheDocument();
+ expect(screen.getByText("3,000")).toBeInTheDocument();
+ });
+
+ it("should apply custom field formatting settings", async () => {
+ setup({
+ parameter: numericFieldParameter,
+ parameterValues: numericFieldValues,
+ fieldSettings: {
+ ...numericFieldSettings,
+ settings: { number_separators: "." },
+ },
+ });
+
+ // need to wait for the settings to load
+ expect(await screen.findByText("1000")).toBeInTheDocument();
+ expect(screen.getByText("2000")).toBeInTheDocument();
+ expect(screen.getByText("3000")).toBeInTheDocument();
+
+ expect(screen.queryByText("1,000")).not.toBeInTheDocument();
+ });
+ });
});