Skip to content

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

[AI Analytics] Date filters respect retention period (#74441)

Sloan Sparger4d39883cd782
diff --git a/enterprise/backend/src/metabase_enterprise/metabot/settings.clj b/enterprise/backend/src/metabase_enterprise/metabot/settings.clj
index 6dd7213a472..739f7c2d116 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot/settings.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot/settings.clj
@@ -79,9 +79,9 @@
(nil? env-var-value)
default-retention-days
- ;; Treat 0 as an alias for infinity
+ ;; Treat 0 as an alias for infinite retention
(zero? env-var-value)
- ##Inf
+ nil
(< env-var-value min-retention-days)
(do
@@ -93,10 +93,12 @@
(defsetting ai-usage-max-retention-days
(deferred-tru "Number of days to retain rows in the ai_usage_log table. Minimum value is 30; set to 0 to retain data indefinitely.")
- :visibility :internal
+ :type :integer
+ :visibility :admin
:setter :none
:audit :never
- :export? false
+ :export? true
+ :encryption :no
:getter #'-ai-usage-max-retention-days
:doc "Sets the maximum number of days Metabase preserves rows in the `ai_usage_log` table.
diff --git a/enterprise/backend/src/metabase_enterprise/metabot/task/ai_usage_trimmer.clj b/enterprise/backend/src/metabase_enterprise/metabot/task/ai_usage_trimmer.clj
index 8fff23e108c..ff87bb2d8c0 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot/task/ai_usage_trimmer.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot/task/ai_usage_trimmer.clj
@@ -20,7 +20,7 @@
(defn- trim-old-usage-data!
[]
(let [retention-days (metabot.settings/ai-usage-max-retention-days)]
- (if (infinite? retention-days)
+ (if (nil? retention-days)
(log/info "Skipping AI usage log cleanup; ai-usage-max-retention-days is 0 (infinite retention).")
(do
(log/infof "Trimming AI usage log rows older than %d days." (long retention-days))
diff --git a/enterprise/backend/test/metabase_enterprise/metabot/settings_test.clj b/enterprise/backend/test/metabase_enterprise/metabot/settings_test.clj
index f930f0c7197..20d7e843b71 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot/settings_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot/settings_test.clj
@@ -15,7 +15,7 @@
(deftest ai-usage-max-retention-days-infinite-test
(testing "0 is an alias for infinite retention"
(mt/with-temp-env-var-value! [mb-ai-usage-max-retention-days 0]
- (is (= ##Inf (metabot.settings/ai-usage-max-retention-days))))))
+ (is (nil? (metabot.settings/ai-usage-max-retention-days))))))
(deftest ai-usage-max-retention-days-passthrough-test
(testing "values at or above the minimum pass through unchanged"
diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationFilters/ConversationFilters.tsx b/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationFilters/ConversationFilters.tsx
index defc2fcdcb0..0952a7700a2 100644
--- a/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationFilters/ConversationFilters.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationFilters/ConversationFilters.tsx
@@ -1,38 +1,80 @@
+import dayjs from "dayjs";
import { useMemo, useState } from "react";
import { P, match } from "ts-pattern";
import { t } from "ttag";
+import { useSetting } from "metabase/common/hooks";
import { getOperatorDefaultValue } from "metabase/querying/common/components/DatePicker/SpecificDatePicker/utils";
-import type { DatePickerOperator } from "metabase/querying/common/types";
+import type {
+ DatePickerOperator,
+ RelativeIntervalDirection,
+} from "metabase/querying/common/types";
+import { getDateFilterDisplayName } from "metabase/querying/common/utils/dates";
import { DateAllOptionsWidget } from "metabase/querying/parameters/components/DateAllOptionsWidget";
-import { serializeDateParameterValue } from "metabase/querying/parameters/utils/parsing";
+import {
+ deserializeDateParameterValue,
+ serializeDateParameterValue,
+} from "metabase/querying/parameters/utils/parsing";
import { Flex, Icon, Popover, Select } from "metabase/ui";
// width needed to show Previous 12 months option w/ clipping
const FILTER_WIDTH = 205;
const DATE_OPERATORS: DatePickerOperator[] = ["=", ">", "<", "between"];
-const FIXED_TYPE_VALUE = "__date_filter_fixed__" as const;
+const RELATIVE_DIRECTIONS: RelativeIntervalDirection[] = ["past", "current"];
+const SPECIFIC_TYPE_VALUE = "__date_filter_specific__" as const;
const RELATIVE_TYPE_VALUE = "__date_filter_relative__" as const;
-type ActiveDropdown = "default" | "fixed" | "relative";
+type ActiveDropdown = "default" | "specific" | "relative";
+
+const CUSTOM_RANGE_DEFAULT: Record<
+ Exclude<ActiveDropdown, "default">,
+ string
+> = {
+ specific: serializeDateParameterValue(getOperatorDefaultValue("between")),
+ relative: "past30days~",
+};
type ConversationDateFilterProps = {
value: string | null;
onChange: (val: string) => void;
};
+function getShortcutStartDate(value: string): dayjs.Dayjs | null {
+ const parsed = deserializeDateParameterValue(value);
+ if (parsed?.type !== "relative") {
+ return null;
+ }
+ return dayjs()
+ .add(parsed.offsetValue ?? 0, parsed.offsetUnit ?? "day")
+ .add(Math.min(parsed.value, 0), parsed.unit)
+ .startOf(parsed.unit);
+}
+
function ConversationDateFilter({
value,
onChange,
}: ConversationDateFilterProps) {
const [activeDropdown, setActiveDropdown] =
useState<ActiveDropdown>("default");
+ const retentionDays = useSetting("ai-usage-max-retention-days");
+ const retentionCutoff = useMemo(
+ () =>
+ retentionDays == null
+ ? null
+ : dayjs().subtract(retentionDays, "day").startOf("day"),
+ [retentionDays],
+ );
+ const todayCutoff = useMemo(() => dayjs().endOf("day"), []);
// `~` includes the current period by incrementing the day count, so `pastNdays~` spans N+1 days.
// To get an N-day window ending today, use `past(N-1)days~`.
- const data = useMemo(
- () => [
+ const data = useMemo(() => {
+ const withinRetention = (item: { value: string }) =>
+ !retentionCutoff ||
+ !getShortcutStartDate(item.value)?.isBefore(retentionCutoff);
+
+ return [
{
group: "",
items: [
@@ -40,7 +82,7 @@ function ConversationDateFilter({
{ label: t`Yesterday`, value: "past1days" },
{ label: t`Last 7 days`, value: "past6days~" },
{ label: t`Last 30 days`, value: "past29days~" },
- ],
+ ].filter(withinRetention),
},
{
group: "",
@@ -48,34 +90,66 @@ function ConversationDateFilter({
{ label: t`Previous month`, value: "past1months" },
{ label: t`Previous 3 months`, value: "past3months" },
{ label: t`Previous 12 months`, value: "past12months" },
- ],
+ ].filter(withinRetention),
},
{
group: "",
items: [
- { label: t`Fixed date range…`, value: FIXED_TYPE_VALUE },
+ { label: t`Fixed date range…`, value: SPECIFIC_TYPE_VALUE },
{ label: t`Relative date range…`, value: RELATIVE_TYPE_VALUE },
],
},
- ],
- [],
- );
+ ].filter((group) => group.items.length > 0);
+ }, [retentionCutoff]);
+
+ // when `value` is a specific / relative range, we want to show the item
+ // as highlighted and make sure the correct value is populated in the inner
+ // dropdowns, all while presenting this as the expanded time range to the user
+ // in the input label (e.g. March 15 2026 - March 19 2026)
+ const parsedValue = value ? deserializeDateParameterValue(value) : null;
+ const isKnownItem =
+ value != null &&
+ data.some((group) => group.items.some((item) => item.value === value));
+
+ const selectValue = match({
+ hasValue: value != null,
+ isKnownItem,
+ parsedType: parsedValue?.type,
+ })
+ .with({ hasValue: false }, () => null)
+ .with({ isKnownItem: true }, () => value)
+ .with({ parsedType: "specific" }, () => SPECIFIC_TYPE_VALUE)
+ .with({ parsedType: "relative" }, () => RELATIVE_TYPE_VALUE)
+ .otherwise(() => null);
+
+ const customDisplayName =
+ !isKnownItem && parsedValue
+ ? (getDateFilterDisplayName(parsedValue) ?? undefined)
+ : undefined;
+ const displayLabel =
+ customDisplayName ??
+ data
+ .flatMap((group) => group.items)
+ .find((item) => item.value === selectValue)?.label;
const handleSelect = (val: string | null) => {
match(val)
- .with(FIXED_TYPE_VALUE, () => setActiveDropdown("fixed"))
+ .with(SPECIFIC_TYPE_VALUE, () => setActiveDropdown("specific"))
.with(RELATIVE_TYPE_VALUE, () => setActiveDropdown("relative"))
.with(P.string, onChange)
.with(null, () => {})
.exhaustive();
};
- const customRangeSeed = match(activeDropdown)
- .with("fixed", () =>
- serializeDateParameterValue(getOperatorDefaultValue("between")),
- )
- .with("relative", () => "past30days~")
- .with("default", () => null)
+ const customRangeValue = match({
+ activeDropdown,
+ parsedType: parsedValue?.type,
+ })
+ .with({ activeDropdown: "default" }, () => null)
+ .with({ activeDropdown: "specific", parsedType: "specific" }, () => value)
+ .with({ activeDropdown: "relative", parsedType: "relative" }, () => value)
+ .with({ activeDropdown: "specific" }, () => CUSTOM_RANGE_DEFAULT.specific)
+ .with({ activeDropdown: "relative" }, () => CUSTOM_RANGE_DEFAULT.relative)
.exhaustive();
return (
@@ -91,21 +165,28 @@ function ConversationDateFilter({
<Popover.Target>
<Select
data={data}
- value={value}
- onChange={handleSelect}
+ value={selectValue}
+ searchValue={customDisplayName}
+ onChange={() => {}}
+ onSearchChange={() => {}}
+ onOptionSubmit={handleSelect}
onDropdownOpen={() => setActiveDropdown("default")}
w={FILTER_WIDTH}
bdrs="sm"
allowDeselect={false}
leftSection={<Icon name="calendar" />}
+ title={displayLabel}
data-testid="conversation-filters-date-select"
/>
</Popover.Target>
<Popover.Dropdown>
<DateAllOptionsWidget
key={activeDropdown}
- value={customRangeSeed}
+ value={customRangeValue}
availableOperators={DATE_OPERATORS}
+ availableDirections={RELATIVE_DIRECTIONS}
+ minDate={retentionCutoff?.toDate()}
+ maxDate={todayCutoff.toDate()}
onChange={(val) => {
onChange(val);
setActiveDropdown("default");
diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationFilters/ConversationFilters.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationFilters/ConversationFilters.unit.spec.tsx
new file mode 100644
index 00000000000..3e0d7f45f36
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationFilters/ConversationFilters.unit.spec.tsx
@@ -0,0 +1,159 @@
+import userEvent from "@testing-library/user-event";
+
+import { setupEnterprisePlugins } from "__support__/enterprise";
+import { mockSettings } from "__support__/settings";
+import { renderWithProviders, screen, within } from "__support__/ui";
+import { createMockState } from "metabase/redux/store/mocks";
+
+import { ConversationFilters } from "./ConversationFilters";
+
+function setup({
+ retentionDays,
+ date = null,
+}: {
+ retentionDays: number | null;
+ date?: string | null;
+}) {
+ setupEnterprisePlugins();
+ renderWithProviders(
+ <ConversationFilters
+ date={date}
+ onDateChange={() => undefined}
+ user={null}
+ onUserChange={() => undefined}
+ group={null}
+ onGroupChange={() => undefined}
+ groupNoFilterValue="all"
+ tenant={null}
+ onTenantChange={() => undefined}
+ userOptions={[]}
+ groupOptions={[]}
+ tenantOptions={[]}
+ hasTenants={false}
+ />,
+ {
+ storeInitialState: createMockState({
+ settings: mockSettings({
+ "ai-usage-max-retention-days": retentionDays,
+ }),
+ }),
+ },
+ );
+}
+
+async function getDropdownLabels() {
+ await userEvent.click(screen.getByTestId("conversation-filters-date-select"));
+ const dropdown = await screen.findByRole("listbox");
+ return within(dropdown)
+ .getAllByRole("option")
+ .map((el) => el.textContent ?? "");
+}
+
+describe("ConversationFilters date dropdown", () => {
+ it("hides shortcuts that go past the configured retention window", async () => {
+ setup({ retentionDays: 180 });
+ const labels = await getDropdownLabels();
+ expect(labels).toEqual(
+ expect.arrayContaining([
+ "Today",
+ "Yesterday",
+ "Last 7 days",
+ "Last 30 days",
+ "Previous month",
+ "Previous 3 months",
+ "Fixed date range…",
+ "Relative date range…",
+ ]),
+ );
+ expect(labels).not.toContain("Previous 12 months");
+ });
+
+ it("hides every multi-month shortcut when retention is at the 30-day minimum", async () => {
+ setup({ retentionDays: 30 });
+ const labels = await getDropdownLabels();
+ expect(labels).toEqual(
+ expect.arrayContaining([
+ "Today",
+ "Yesterday",
+ "Last 7 days",
+ "Last 30 days",
+ "Fixed date range…",
+ "Relative date range…",
+ ]),
+ );
+ expect(labels).not.toContain("Previous month");
+ expect(labels).not.toContain("Previous 3 months");
+ expect(labels).not.toContain("Previous 12 months");
+ });
+
+ it("shows every shortcut when retention is infinite", async () => {
+ setup({ retentionDays: null });
+ const labels = await getDropdownLabels();
+ expect(labels).toEqual(
+ expect.arrayContaining([
+ "Today",
+ "Yesterday",
+ "Last 7 days",
+ "Last 30 days",
+ "Previous month",
+ "Previous 3 months",
+ "Previous 12 months",
+ "Fixed date range…",
+ "Relative date range…",
+ ]),
+ );
+ });
+
+ it("renders the human-readable label for a custom date range value", () => {
+ setup({
+ retentionDays: 180,
+ date: "2026-01-02~2026-03-15",
+ });
+ const input = screen.getByTestId(
+ "conversation-filters-date-select",
+ ) as HTMLInputElement;
+ expect(input.value).toMatch(/January 2, 2026.*March 15, 2026/);
+ expect(input.title).toMatch(/January 2, 2026.*March 15, 2026/);
+ });
+
+ it("highlights the Fixed date range option when a custom range is active", async () => {
+ setup({
+ retentionDays: 180,
+ date: "2026-01-02~2026-03-15",
+ });
+ await userEvent.click(
+ screen.getByTestId("conversation-filters-date-select"),
+ );
+ const dropdown = await screen.findByRole("listbox");
+ const fixedOption = within(dropdown).getByRole("option", {
+ name: /Fixed date range/,
+ });
+ expect(fixedOption).toHaveAttribute("aria-selected", "true");
+ });
+
+ it("highlights the relative date range option with a custom relative range value", async () => {
+ setup({ retentionDays: 180, date: "past5days~" });
+ await userEvent.click(
+ screen.getByTestId("conversation-filters-date-select"),
+ );
+ const dropdown = await screen.findByRole("listbox");
+ const relativeOption = within(dropdown).getByRole("option", {
+ name: /Relative date range/,
+ });
+ expect(relativeOption).toHaveAttribute("aria-selected", "true");
+ });
+
+ it("reuses the current specific range when reopening the fixed picker", async () => {
+ setup({ retentionDays: 180, date: "2026-01-02~2026-03-15" });
+ await userEvent.click(
+ screen.getByTestId("conversation-filters-date-select"),
+ );
+ await userEvent.click(
+ await screen.findByRole("option", { name: /Fixed date range/ }),
+ );
+ expect(await screen.findByLabelText("Start date")).toHaveValue(
+ "January 2, 2026",
+ );
+ expect(screen.getByLabelText("End date")).toHaveValue("March 15, 2026");
+ });
+});
diff --git a/frontend/src/metabase-types/api/mocks/settings.ts b/frontend/src/metabase-types/api/mocks/settings.ts
index aaa745922a0..0a54c56573f 100644
--- a/frontend/src/metabase-types/api/mocks/settings.ts
+++ b/frontend/src/metabase-types/api/mocks/settings.ts
@@ -383,6 +383,7 @@ export const createMockSettings = (
"metabot-limit-unit": "tokens",
"metabot-limit-reset-rate": "monthly",
"metabot-quota-reached-message": null,
+ "ai-usage-max-retention-days": 180,
"metabot-chat-system-prompt": null,
"metabot-nlq-system-prompt": null,
"metabot-sql-system-prompt": null,
diff --git a/frontend/src/metabase-types/api/settings.ts b/frontend/src/metabase-types/api/settings.ts
index 45433654cb3..631726d2a8e 100644
--- a/frontend/src/metabase-types/api/settings.ts
+++ b/frontend/src/metabase-types/api/settings.ts
@@ -621,6 +621,7 @@ interface PublicSettings {
"metabot-limit-unit": MetabotLimitType;
"metabot-limit-reset-rate": MetabotLimitPeriod;
"metabot-quota-reached-message": string | null;
+ "ai-usage-max-retention-days": number | null;
"metabot-chat-system-prompt": string | null;
"metabot-nlq-system-prompt": string | null;
"metabot-sql-system-prompt": string | null;
diff --git a/frontend/src/metabase/querying/common/components/DatePicker/DatePicker.tsx b/frontend/src/metabase/querying/common/components/DatePicker/DatePicker.tsx
index c788db0bde8..221c974748c 100644
--- a/frontend/src/metabase/querying/common/components/DatePicker/DatePicker.tsx
+++ b/frontend/src/metabase/querying/common/components/DatePicker/DatePicker.tsx
@@ -27,6 +27,8 @@ type DatePickerProps = {
availableShortcuts?: DatePickerShortcut[];
availableUnits?: DatePickerUnit[];
availableDirections?: RelativeIntervalDirection[];
+ minDate?: Date;
+ maxDate?: Date;
renderSubmitButton?: (props: DatePickerSubmitButtonProps) => ReactNode;
renderBackButton?: () => ReactNode;
onChange: (value: DatePickerValue) => void;
@@ -39,6 +41,8 @@ export function DatePicker({
availableShortcuts = DATE_PICKER_SHORTCUTS,
availableUnits = DATE_PICKER_UNITS,
availableDirections = DATE_PICKER_DIRECTIONS,
+ minDate,
+ maxDate,
renderSubmitButton = renderDefaultSubmitButton,
renderBackButton,
onChange,
@@ -57,6 +61,8 @@ export function DatePicker({
value={value?.type === type ? value : undefined}
availableOperators={availableOperators}
availableUnits={availableUnits}
+ minDate={minDate}
+ maxDate={maxDate}
renderSubmitButton={renderSubmitButton}
onChange={onChange}
onBack={handleBack}
@@ -69,6 +75,8 @@ export function DatePicker({
value={value?.type === type ? value : undefined}
availableUnits={availableUnits}
availableDirections={availableDirections}
+ minDate={minDate}
+ maxDate={maxDate}
renderSubmitButton={renderSubmitButton}
onChange={onChange}
onBack={handleBack}
diff --git a/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateIntervalPicker/DateIntervalPicker.tsx b/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateIntervalPicker/DateIntervalPicker.tsx
index 8059b9c9c49..723332a151c 100644
--- a/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateIntervalPicker/DateIntervalPicker.tsx
+++ b/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateIntervalPicker/DateIntervalPicker.tsx
@@ -24,6 +24,7 @@ import {
formatDateRange,
getInterval,
getUnitOptions,
+ isOutOfBounds,
setInterval,
} from "../utils";
@@ -32,6 +33,8 @@ import { setDefaultOffset, setUnit } from "./utils";
interface DateIntervalPickerProps {
value: RelativeDatePickerValue;
availableUnits: DatePickerUnit[];
+ minDate?: Date;
+ maxDate?: Date;
renderSubmitButton?: (props: DatePickerSubmitButtonProps) => ReactNode;
onChange: (value: RelativeDatePickerValue) => void;
onSubmit: () => void;
@@ -40,6 +43,8 @@ interface DateIntervalPickerProps {
export function DateIntervalPicker({
value,
availableUnits,
+ minDate,
+ maxDate,
renderSubmitButton = renderDefaultSubmitButton,
onChange,
onSubmit,
@@ -47,6 +52,7 @@ export function DateIntervalPicker({
const interval = getInterval(value);
const unitOptions = getUnitOptions(value, availableUnits);
const dateRangeText = formatDateRange(value);
+ const outOfBounds = isOutOfBounds(value, minDate, maxDate);
const handleIntervalChange = (inputValue: number | string) => {
if (typeof inputValue === "number") {
@@ -67,6 +73,9 @@ export function DateIntervalPicker({
const handleSubmit = (event: FormEvent) => {
event.preventDefault();
+ if (outOfBounds) {
+ return;
+ }
onSubmit();
};
@@ -110,7 +119,7 @@ export function DateIntervalPicker({
<Icon name="calendar" />
<Text c="inherit">{dateRangeText}</Text>
</Group>
- {renderSubmitButton({ value, isDisabled: false })}
+ {renderSubmitButton({ value, isDisabled: outOfBounds })}
</Group>
</form>
);
diff --git a/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateIntervalPicker/DateIntervalPicker.unit.spec.tsx b/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateIntervalPicker/DateIntervalPicker.unit.spec.tsx
index eddfb854d17..99ac862b872 100644
--- a/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateIntervalPicker/DateIntervalPicker.unit.spec.tsx
+++ b/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateIntervalPicker/DateIntervalPicker.unit.spec.tsx
@@ -26,12 +26,16 @@ function getDefaultValue(
interface SetupOpts {
value: RelativeDatePickerValue;
availableUnits?: DatePickerUnit[];
+ minDate?: Date;
+ maxDate?: Date;
renderSubmitButton?: (props: DatePickerSubmitButtonProps) => ReactNode;
}
function setup({
value,
availableUnits = DATE_PICKER_UNITS,
+ minDate,
+ maxDate,
renderSubmitButton,
}: SetupOpts) {
const onChange = jest.fn();
@@ -41,6 +45,8 @@ function setup({
<DateIntervalPicker
value={value}
availableUnits={availableUnits}
+ minDate={minDate}
+ maxDate={maxDate}
renderSubmitButton={renderSubmitButton}
onChange={onChange}
onSubmit={onSubmit}
@@ -231,6 +237,30 @@ describe("DateIntervalPicker", () => {
isDisabled: false,
});
});
+
+ it("should disable submit when the range falls outside the bounds", () => {
+ const renderSubmitButton = jest.fn().mockReturnValue(null);
+ setup({
+ value: defaultValue,
+ minDate: direction === "past" ? new Date(2020, 0, 1) : undefined,
+ maxDate: direction === "future" ? new Date(2020, 0, 2) : undefined,
+ renderSubmitButton,
+ });
+ expect(renderSubmitButton).toHaveBeenLastCalledWith({
+ value: defaultValue,
+ isDisabled: true,
+ });
+ });
+
+ it("should not submit when the range falls outside the bounds", async () => {
+ const { onSubmit } = setup({
+ value: defaultValue,
+ minDate: direction === "past" ? new Date(2020, 0, 1) : undefined,
+ maxDate: direction === "future" ? new Date(2020, 0, 2) : undefined,
+ });
+ await userEvent.type(screen.getByLabelText("Interval"), "{enter}");
+ expect(onSubmit).not.toHaveBeenCalled();
+ });
},
);
});
diff --git a/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateOffsetIntervalPicker/DateOffsetIntervalPicker.tsx b/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateOffsetIntervalPicker/DateOffsetIntervalPicker.tsx
index 8492c0f2589..56c97644479 100644
--- a/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateOffsetIntervalPicker/DateOffsetIntervalPicker.tsx
+++ b/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateOffsetIntervalPicker/DateOffsetIntervalPicker.tsx
@@ -14,6 +14,7 @@ import {
formatDateRange,
getInterval,
getUnitOptions,
+ isOutOfBounds,
setInterval,
} from "../utils";
@@ -31,6 +32,8 @@ import {
interface DateOffsetIntervalPickerProps {
value: RelativeDatePickerValue;
availableUnits: DatePickerUnit[];
+ minDate?: Date;
+ maxDate?: Date;
renderSubmitButton?: (props: DatePickerSubmitButtonProps) => ReactNode;
onChange: (value: RelativeDatePickerValue) => void;
onSubmit: () => void;
@@ -39,6 +42,8 @@ interface DateOffsetIntervalPickerProps {
export function DateOffsetIntervalPicker({
value,
availableUnits,
+ minDate,
+ maxDate,
renderSubmitButton = renderDefaultSubmitButton,
onChange,
onSubmit,
@@ -49,6 +54,7 @@ export function DateOffsetIntervalPicker({
const offsetUnitOptions = getOffsetUnitOptions(value, availableUnits);
const directionText = getDirectionText(value);
const dateRangeText = formatDateRange(value);
+ const outOfBounds = isOutOfBounds(value, minDate, maxDate);
const handleIntervalChange = (inputValue: number | string) => {
if (typeof inputValue === "number") {
@@ -82,6 +88,9 @@ export function DateOffsetIntervalPicker({
const handleSubmit = (event: FormEvent) => {
event.preventDefault();
+ if (outOfBounds) {
+ return;
+ }
onSubmit();
};
@@ -143,7 +152,7 @@ export function DateOffsetIntervalPicker({
<Icon name="calendar" />
<Text c="inherit">{dateRangeText}</Text>
</Group>
- {renderSubmitButton({ value })}
+ {renderSubmitButton({ value, isDisabled: outOfBounds })}
</Group>
</form>
);
diff --git a/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateOffsetIntervalPicker/DateOffsetIntervalPicker.unit.spec.tsx b/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateOffsetIntervalPicker/DateOffsetIntervalPicker.unit.spec.tsx
index b0fe5edbe50..fd1c6630326 100644
--- a/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateOffsetIntervalPicker/DateOffsetIntervalPicker.unit.spec.tsx
+++ b/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/DateOffsetIntervalPicker/DateOffsetIntervalPicker.unit.spec.tsx
@@ -32,12 +32,16 @@ const userEvent = _userEvent.setup({
interface SetupOpts {
value: RelativeDatePickerValue;
availableUnits?: DatePickerUnit[];
+ minDate?: Date;
+ maxDate?: Date;
renderSubmitButton?: (props: DatePickerSubmitButtonProps) => ReactNode;
}
function setup({
value,
availableUnits = DATE_PICKER_UNITS,
+ minDate,
+ maxDate,
renderSubmitButton,
}: SetupOpts) {
const onChange = jest.fn();
@@ -47,6 +51,8 @@ function setup({
<DateOffsetIntervalPicker
value={value}
availableUnits={availableUnits}
+ minDate={minDate}
+ maxDate={maxDate}
renderSubmitButton={renderSubmitButton}
onChange={onChange}
onSubmit={onSubmit}
@@ -335,8 +341,33 @@ describe("DateOffsetIntervalPicker", () => {
setup({ value: defaultValue, renderSubmitButton });
expect(renderSubmitButton).toHaveBeenCalledWith({
value: defaultValue,
+ isDisabled: false,
});
});
+
+ it("should disable submit when the range falls outside the bounds", () => {
+ const renderSubmitButton = jest.fn().mockReturnValue(null);
+ setup({
+ value: defaultValue,
+ minDate: direction === "past" ? new Date(2020, 0, 1) : undefined,
+ maxDate: direction === "future" ? new Date(2020, 0, 2) : undefined,
+ renderSubmitButton,
+ });
+ expect(renderSubmitButton).toHaveBeenLastCalledWith({
+ value: defaultValue,
+ isDisabled: true,
+ });
+ });
+
+ it("should not submit when the range falls outside the bounds", async () => {
+ const { onSubmit } = setup({
+ value: defaultValue,
+ minDate: direction === "past" ? new Date(2020, 0, 1) : undefined,
+ maxDate: direction === "future" ? new Date(2020, 0, 2) : undefined,
+ });
+ await userEvent.type(screen.getByLabelText("Interval"), "{enter}");
+ expect(onSubmit).not.toHaveBeenCalled();
+ });
},
);
});
diff --git a/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/RelativeDatePicker.tsx b/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/RelativeDatePicker.tsx
index 4e1a2f3e849..b4e2a9a0171 100644
--- a/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/RelativeDatePicker.tsx
+++ b/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/RelativeDatePicker.tsx
@@ -27,6 +27,8 @@ interface RelativeDatePickerProps {
value: RelativeDatePickerValue | undefined;
availableUnits: DatePickerUnit[];
availableDirections: RelativeIntervalDirection[];
+ minDate?: Date;
+ maxDate?: Date;
renderSubmitButton?: (props: DatePickerSubmitButtonProps) => ReactNode;
onChange: (value: RelativeDatePickerValue) => void;
onBack: () => void;
@@ -37,6 +39,8 @@ export function RelativeDatePicker({
value: initialValue,
availableUnits,
availableDirections,
+ minDate,
+ maxDate,
renderSubmitButton = renderDefaultSubmitButton,
onChange,
onBack,
@@ -85,6 +89,8 @@ export function RelativeDatePicker({
<DateOffsetIntervalPicker
value={value}
availableUnits={availableUnits}
+ minDate={minDate}
+ maxDate={maxDate}
renderSubmitButton={renderSubmitButton}
onChange={setValue}
onSubmit={handleSubmit}
@@ -93,6 +99,8 @@ export function RelativeDatePicker({
<DateIntervalPicker
value={value}
availableUnits={availableUnits}
+ minDate={minDate}
+ maxDate={maxDate}
renderSubmitButton={renderSubmitButton}
onChange={setValue}
onSubmit={handleSubmit}
diff --git a/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/utils.ts b/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/utils.ts
index 0051fc5c5f0..098a0c7184d 100644
--- a/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/utils.ts
+++ b/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/utils.ts
@@ -1,3 +1,5 @@
+import dayjs from "dayjs";
+
import { DATE_PICKER_TRUNCATION_UNITS } from "metabase/querying/common/constants";
import type {
DatePickerTruncationUnit,
@@ -135,6 +137,19 @@ export function formatDateRange({
});
}
+export function isOutOfBounds(
+ { value, unit, offsetValue, offsetUnit }: RelativeDatePickerValue,
+ minDate?: Date,
+ maxDate?: Date,
+): boolean {
+ const base = dayjs().add(offsetValue ?? 0, offsetUnit ?? "day");
+ const start = base.add(Math.min(value, 0), unit).startOf(unit).toDate();
+ const end = base.add(Math.max(value, 0), unit).endOf(unit).toDate();
+ return (
+ (minDate != null && start < minDate) || (maxDate != null && end > maxDate)
+ );
+}
+
export function getDefaultValue(
availableDirections: RelativeIntervalDirection[],
) {
diff --git a/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/utils.unit.spec.ts b/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/utils.unit.spec.ts
index 1c2c0840eb6..5c67f42c88a 100644
--- a/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/utils.unit.spec.ts
+++ b/frontend/src/metabase/querying/common/components/DatePicker/RelativeDatePicker/utils.unit.spec.ts
@@ -6,7 +6,12 @@ import type {
import { CURRENT_TAB, LAST_TAB, NEXT_TAB } from "./constants";
import type { Tab } from "./types";
-import { getAvailableTabs, getDefaultValue, setDirection } from "./utils";
+import {
+ getAvailableTabs,
+ getDefaultValue,
+ isOutOfBounds,
+ setDirection,
+} from "./utils";
describe("setDirection", () => {
describe("current", () => {
@@ -204,3 +209,54 @@ describe("getAvailableTabs", () => {
},
);
});
+
+describe("isOutOfBounds", () => {
+ const past = (days: number): RelativeDatePickerValue => ({
+ type: "relative",
+ value: -days,
+ unit: "day",
+ });
+ const future = (days: number): RelativeDatePickerValue => ({
+ type: "relative",
+ value: days,
+ unit: "day",
+ });
+
+ beforeAll(() => {
+ jest.useFakeTimers();
+ jest.setSystemTime(new Date(2026, 0, 31));
+ });
+
+ it("is in bounds when no min or max is set", () => {
+ expect(isOutOfBounds(past(365))).toBe(false);
+ });
+
+ it("is out of bounds when a past range starts before minDate", () => {
+ expect(isOutOfBounds(past(365), new Date(2026, 0, 1))).toBe(true);
+ });
+
+ it("is in bounds when a past range starts on or after minDate", () => {
+ expect(isOutOfBounds(past(7), new Date(2026, 0, 1))).toBe(false);
+ });
+
+ it("is out of bounds when a future range ends after maxDate", () => {
+ expect(isOutOfBounds(future(365), undefined, new Date(2026, 1, 1))).toBe(
+ true,
+ );
+ });
+
+ it("is in bounds when a future range ends on or before maxDate", () => {
+ expect(isOutOfBounds(future(7), undefined, new Date(2026, 2, 1))).toBe(
+ false,
+ );
+ });
+
+ it("respects offsetValue and offsetUnit when checking minDate", () => {
+ expect(
+ isOutOfBounds(
+ { ...past(7), offsetValue: -365, offsetUnit: "day" },
+ new Date(2026, 0, 1),
+ ),
+ ).toBe(true);
+ });
+});
diff --git a/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePicker.tsx b/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePicker.tsx
index 1016da14fea..5b6229fbfac 100644
--- a/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePicker.tsx
+++ b/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePicker.tsx
@@ -12,6 +12,8 @@ import type { DateRangePickerValue } from "./types";
export type DateRangePickerProps = {
value: DateRangePickerValue;
hasTimeToggle: boolean;
+ minDate?: Date;
+ maxDate?: Date;
renderSubmitButton?: () => ReactNode;
onChange: (value: DateRangePickerValue) => void;
onSubmit: () => void;
@@ -20,6 +22,8 @@ export type DateRangePickerProps = {
export function DateRangePicker({
value,
hasTimeToggle,
+ minDate,
+ maxDate,
renderSubmitButton = renderDefaultSubmitButton,
onChange,
onSubmit,
@@ -49,6 +53,8 @@ export function DateRangePicker({
<DateRangePickerBody
value={dateRange}
hasTime={hasTime}
+ minDate={minDate}
+ maxDate={maxDate}
onChange={handleDateRangeChange}
/>
</Box>
diff --git a/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePickerBody/DateRangePickerBody.tsx b/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePickerBody/DateRangePickerBody.tsx
index 25ad40c12eb..d94821b608f 100644
--- a/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePickerBody/DateRangePickerBody.tsx
+++ b/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/DateRangePicker/DateRangePickerBody/DateRangePickerBody.tsx
@@ -19,6 +19,8 @@ import S from "./DateRangePickerBody.module.css";
interface DateRangePickerBodyProps {
value: [Date, Date];
hasTime: boolean;
+ minDate?: Date;
+ maxDate?: Date;
onChange: (value: [Date, Date]) => void;
valueFormat?: string;
}
@@ -26,6 +28,8 @@ interface DateRangePickerBodyProps {
export function DateRangePickerBody({
value,
hasTime,
+ minDate,
+ maxDate,
onChange,
valueFormat = "LL",
}: DateRangePickerBodyProps) {
@@ -88,6 +92,8 @@ export function DateRangePickerBody({
className={S.FlexDateInput}
value={startDate}
valueFormat={valueFormat}
+ minDate={minDate}
+ maxDate={maxDate}
popoverProps={{ opened: false }}
aria-label={t`Start date`}
onChange={(val) => val && handleStartDateChange(dayjs(val).toDate())}
@@ -97,6 +103,8 @@ export function DateRangePickerBody({
className={S.FlexDateInput}
value={endDate}
valueFormat={valueFormat}
+ minDate={minDate}
+ maxDate={maxDate}
popoverProps={{ opened: false }}
aria-label={t`End date`}
onChange={(val) => val && handleEndDateChange(dayjs(val).toDate())}
@@ -123,6 +131,8 @@ export function DateRangePickerBody({
type="range"
value={inProgressDateRange ?? value}
date={displayedDate}
+ minDate={minDate}
+ maxDate={maxDate}
numberOfColumns={2}
allowSingleDateInRange
onChange={handleRangeChange}
diff --git a/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/SingleDatePicker/SingleDatePicker.tsx b/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/SingleDatePicker/SingleDatePicker.tsx
index cff6c5b60a1..b83e0eeaf23 100644
--- a/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/SingleDatePicker/SingleDatePicker.tsx
+++ b/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/SingleDatePicker/SingleDatePicker.tsx
@@ -12,6 +12,8 @@ import type { SingleDatePickerValue } from "./types";
interface SingleDatePickerProps {
value: SingleDatePickerValue;
hasTimeToggle: boolean;
+ minDate?: Date;
+ maxDate?: Date;
renderSubmitButton?: () => ReactNode;
onChange: (value: SingleDatePickerValue) => void;
onSubmit: () => void;
@@ -20,6 +22,8 @@ interface SingleDatePickerProps {
export function SingleDatePicker({
value,
hasTimeToggle,
+ minDate,
+ maxDate,
renderSubmitButton = renderDefaultSubmitButton,
onChange,
onSubmit,
@@ -45,6 +49,8 @@ export function SingleDatePicker({
<SingleDatePickerBody
value={date}
hasTime={hasTime}
+ minDate={minDate}
+ maxDate={maxDate}
onChange={handleDateChange}
/>
</Box>
diff --git a/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/SingleDatePicker/SingleDatePickerBody/SingleDatePickerBody.tsx b/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/SingleDatePicker/SingleDatePickerBody/SingleDatePickerBody.tsx
index fb537763685..3bb284bd327 100644
--- a/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/SingleDatePicker/SingleDatePickerBody/SingleDatePickerBody.tsx
+++ b/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/SingleDatePicker/SingleDatePickerBody/SingleDatePickerBody.tsx
@@ -10,12 +10,16 @@ import { setDatePart, setTimePart } from "../../utils";
interface SingleDatePickerBodyProps {
value: Date;
hasTime: boolean;
+ minDate?: Date;
+ maxDate?: Date;
onChange: (value: Date) => void;
}
export function SingleDatePickerBody({
value,
hasTime,
+ minDate,
+ maxDate,
onChange,
}: SingleDatePickerBodyProps) {
const [date, setDate] = useState<Date>(value);
@@ -37,6 +41,8 @@ export function SingleDatePickerBody({
<DateInput
value={value}
date={date}
+ minDate={minDate}
+ maxDate={maxDate}
popoverProps={{ opened: false }}
aria-label={t`Date`}
onChange={handleDateChange}
@@ -52,6 +58,8 @@ export function SingleDatePickerBody({
<DatePicker
value={value}
date={date}
+ minDate={minDate}
+ maxDate={maxDate}
onChange={handleDateChange}
onDateChange={(val) => val && setDate(dayjs(val).toDate())}
/>
diff --git a/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/SpecificDatePicker.tsx b/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/SpecificDatePicker.tsx
index 79d8078ce35..4177d9ae65b 100644
--- a/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/SpecificDatePicker.tsx
+++ b/frontend/src/metabase/querying/common/components/DatePicker/SpecificDatePicker/SpecificDatePicker.tsx
@@ -32,6 +32,8 @@ interface SpecificDatePickerProps {
value?: SpecificDatePickerValue;
availableOperators: DatePickerOperator[];
availableUnits: DatePickerUnit[];
+ minDate?: Date;
+ maxDate?: Date;
renderSubmitButton?: (props: DatePickerSubmitButtonProps) => ReactNode;
onChange: (value: SpecificDatePickerValue) => void;
onBack: () => void;
@@ -42,6 +44,8 @@ export function SpecificDatePicker({
value: initialValue,
availableOperators,
availableUnits,
+ minDate,
+ maxDate,
renderSubmitButton = renderDefaultSubmitButton,
onChange,
onBack,
@@ -98,6 +102,8 @@ export function SpecificDatePicker({
<DateRangePicker
value={{ dateRange: value.values, hasTime: value.hasTime }}
hasTimeToggle={hasTimeToggle}
+ minDate={minDate}
+ maxDate={maxDate}
renderSubmitButton={() =>
renderSubmitButton({ value: coercedValue })
}
@@ -108,6 +114,8 @@ export function SpecificDatePicker({
<SingleDatePicker
value={{ date: getDate(value), hasTime: value.hasTime }}
hasTimeToggle={hasTimeToggle}
+ minDate={minDate}
+ maxDate={maxDate}
renderSubmitButton={() =>
renderSubmitButton({ value: coercedValue })
}
diff --git a/frontend/src/metabase/querying/parameters/components/DateAllOptionsWidget/DateAllOptionsWidget.tsx b/frontend/src/metabase/querying/parameters/components/DateAllOptionsWidget/DateAllOptionsWidget.tsx
index d579028c1bf..906702a9512 100644
--- a/frontend/src/metabase/querying/parameters/components/DateAllOptionsWidget/DateAllOptionsWidget.tsx
+++ b/frontend/src/metabase/querying/parameters/components/DateAllOptionsWidget/DateAllOptionsWidget.tsx
@@ -21,6 +21,8 @@ type DateAllOptionsWidgetProps = {
availableOperators?: DatePickerOperator[];
availableShortcuts?: DatePickerShortcut[];
availableDirections?: RelativeIntervalDirection[];
+ minDate?: Date;
+ maxDate?: Date;
submitButtonLabel?: string;
onChange: (value: string) => void;
};
@@ -29,6 +31,8 @@ export function DateAllOptionsWidget({
value,
availableOperators,
availableDirections,
+ minDate,
+ maxDate,
submitButtonLabel = t`Apply`,
onChange,
availableShortcuts,
@@ -45,6 +49,8 @@ export function DateAllOptionsWidget({
availableOperators={availableOperators}
availableShortcuts={availableShortcuts}
availableDirections={availableDirections}
+ minDate={minDate}
+ maxDate={maxDate}
renderSubmitButton={({ isDisabled }) => (
<Button type="submit" variant="filled" disabled={isDisabled}>
{submitButtonLabel}
diff --git a/test_resources/serialization_baseline/settings.yaml b/test_resources/serialization_baseline/settings.yaml
index bcb5dd453e9..92f02afead7 100644
--- a/test_resources/serialization_baseline/settings.yaml
+++ b/test_resources/serialization_baseline/settings.yaml
@@ -1,6 +1,7 @@
agent-api-enabled?: null
aggregated-query-row-limit: null
ai-features-enabled?: null
+ai-usage-max-retention-days: null
allowed-iframe-hosts: null
analytics-pii-retention-enabled: null
application-colors: null