Skip to content

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

fix: add correct valueFormat for DateInput (GIT-8486, #65480) (#66298)

Egor Grushinb0a44b283b7b
diff --git a/frontend/src/metabase/parameters/components/FormattedParameterValue/FormattedParameterValue.tsx b/frontend/src/metabase/parameters/components/FormattedParameterValue/FormattedParameterValue.tsx
index 0f6583df78a..fc01b4533bf 100644
--- a/frontend/src/metabase/parameters/components/FormattedParameterValue/FormattedParameterValue.tsx
+++ b/frontend/src/metabase/parameters/components/FormattedParameterValue/FormattedParameterValue.tsx
@@ -30,6 +30,7 @@ export type FormattedParameterValueProps = {
dashboardId?: DashboardId;
placeholder?: string;
isPopoverOpen?: boolean;
+ dataTestId?: string;
};
function FormattedParameterValue({
diff --git a/frontend/src/metabase/querying/filters/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePickerBody/DateRangePickerBody.tsx b/frontend/src/metabase/querying/filters/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePickerBody/DateRangePickerBody.tsx
index 7144724216f..521a8c01e61 100644
--- a/frontend/src/metabase/querying/filters/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePickerBody/DateRangePickerBody.tsx
+++ b/frontend/src/metabase/querying/filters/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePickerBody/DateRangePickerBody.tsx
@@ -20,12 +20,14 @@ interface DateRangePickerBodyProps {
value: [Date, Date];
hasTime: boolean;
onChange: (value: [Date, Date]) => void;
+ valueFormat?: string;
}
export function DateRangePickerBody({
value,
hasTime,
onChange,
+ valueFormat = "LL",
}: DateRangePickerBodyProps) {
const [startDate, endDate] = value;
const [inProgressDateRange, setInProgressDateRange] =
@@ -85,6 +87,7 @@ export function DateRangePickerBody({
<DateInput
className={S.FlexDateInput}
value={startDate}
+ valueFormat={valueFormat}
popoverProps={{ opened: false }}
aria-label={t`Start date`}
onChange={(val) => val && handleStartDateChange(dayjs(val).toDate())}
@@ -93,6 +96,7 @@ export function DateRangePickerBody({
<DateInput
className={S.FlexDateInput}
value={endDate}
+ valueFormat={valueFormat}
popoverProps={{ opened: false }}
aria-label={t`End date`}
onChange={(val) => val && handleEndDateChange(dayjs(val).toDate())}
diff --git a/frontend/src/metabase/querying/filters/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePickerBody/DateRangePickerBody.unit.spec.tsx b/frontend/src/metabase/querying/filters/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePickerBody/DateRangePickerBody.unit.spec.tsx
index e90c7ec0884..50457f28188 100644
--- a/frontend/src/metabase/querying/filters/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePickerBody/DateRangePickerBody.unit.spec.tsx
+++ b/frontend/src/metabase/querying/filters/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePickerBody/DateRangePickerBody.unit.spec.tsx
@@ -1,6 +1,7 @@
import userEvent from "@testing-library/user-event";
import { render, screen } from "__support__/ui";
+import { setLocalization } from "metabase/lib/i18n";
import { DateRangePickerBody } from "./DateRangePickerBody";
@@ -84,4 +85,39 @@ describe("DateRangePickerBody", () => {
expect(screen.queryByText("January 2020")).not.toBeInTheDocument();
});
});
+
+ describe("locale-dependent formatting", () => {
+ afterAll(() => jest.resetModules());
+
+ it.each([
+ {
+ locale: "en",
+ expectedStart: "January 2, 2025",
+ expectedEnd: "February 3, 2025",
+ },
+ {
+ locale: "de",
+ expectedStart: "2. Januar 2025",
+ expectedEnd: "3. Februar 2025",
+ },
+ ])(
+ "should display localized start/end date inputs for $locale",
+ ({ locale, expectedStart, expectedEnd }) => {
+ setLocalization({
+ headers: {
+ language: locale,
+ "plural-forms": "nplurals=2; plural=(n != 1);",
+ },
+ translations: { "": {} },
+ });
+
+ setup({
+ value: [new Date(2025, 0, 2), new Date(2025, 1, 3)],
+ });
+
+ expect(screen.getByLabelText("Start date")).toHaveValue(expectedStart);
+ expect(screen.getByLabelText("End date")).toHaveValue(expectedEnd);
+ },
+ );
+ });
});
diff --git a/frontend/src/metabase/querying/filters/utils/dates.ts b/frontend/src/metabase/querying/filters/utils/dates.ts
index 607846b8146..e4eee2f7aa9 100644
--- a/frontend/src/metabase/querying/filters/utils/dates.ts
+++ b/frontend/src/metabase/querying/filters/utils/dates.ts
@@ -322,10 +322,8 @@ export function getDateFilterDisplayName(
.exhaustive();
}
-function formatDate(date: Date, hasTime: boolean) {
- return hasTime
- ? dayjs(date).format("MMMM D, YYYY hh:mm A")
- : dayjs(date).format("MMMM D, YYYY");
+export function formatDate(date: Date, hasTime: boolean) {
+ return hasTime ? dayjs(date).format("LL hh:mm A") : dayjs(date).format("LL");
}
function formatMonth(month: number, year: number) {
diff --git a/frontend/src/metabase/querying/filters/utils/dates.unit.spec.ts b/frontend/src/metabase/querying/filters/utils/dates.unit.spec.ts
index bbd988fa0d5..30aab95ea61 100644
--- a/frontend/src/metabase/querying/filters/utils/dates.unit.spec.ts
+++ b/frontend/src/metabase/querying/filters/utils/dates.unit.spec.ts
@@ -1,8 +1,13 @@
+import { setLocalization } from "metabase/lib/i18n";
import type { DateFilterValue } from "metabase/querying/filters/types";
import * as Lib from "metabase-lib";
import { columnFinder, createQuery } from "metabase-lib/test-helpers";
-import { getDateFilterClause, getDateFilterDisplayName } from "./dates";
+import {
+ formatDate,
+ getDateFilterClause,
+ getDateFilterDisplayName,
+} from "./dates";
type DateFilterClauseCase = {
value: DateFilterValue;
@@ -321,3 +326,30 @@ describe("getDateFilterDisplayName", () => {
},
);
});
+
+describe("formatDate", () => {
+ afterAll(() => jest.resetModules());
+
+ describe.each([{ hasTime: false }, { hasTime: true }])(
+ "with hasTime=$hasTime",
+ ({ hasTime }) => {
+ it.each([
+ { locale: "en", expectedDate: "January 2, 2025" },
+ { locale: "de", expectedDate: "2. Januar 2025" },
+ ])("respects locale $locale", ({ locale, expectedDate }) => {
+ setLocalization({
+ headers: {
+ language: locale,
+ "plural-forms": "nplurals=2; plural=(n != 1);",
+ },
+ translations: { "": {} },
+ });
+
+ const date = new Date(2025, 0, 2, 0, 0);
+ const expectedTime = hasTime ? " 12:00 AM" : "";
+ const expected = `${expectedDate}${expectedTime}`;
+ expect(formatDate(date, hasTime)).toBe(expected);
+ });
+ },
+ );
+});