Skip to content

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

Constraint available relative directions in the DatePicker for transforms (#63893)

Alexander Polyankin1cacd1f51094
diff --git a/e2e/test/scenarios/admin/transforms.cy.spec.ts b/e2e/test/scenarios/admin/transforms.cy.spec.ts
index f23faf13440..cfbf3ea414e 100644
--- a/e2e/test/scenarios/admin/transforms.cy.spec.ts
+++ b/e2e/test/scenarios/admin/transforms.cy.spec.ts
@@ -2334,7 +2334,7 @@ function getLastRunAtFilterWidget() {
}
function getNextRunFilterWidget() {
- return cy.findByRole("group", { name: "Next run" });
+ return cy.findByRole("group", { name: "Next run at" });
}
function getStatusFilterWidget() {
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/TimeFilterWidget/TimeFilterWidget.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/TimeFilterWidget/TimeFilterWidget.tsx
index 6a5dba71415..4a51eced8ed 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms/components/TimeFilterWidget/TimeFilterWidget.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/TimeFilterWidget/TimeFilterWidget.tsx
@@ -1,23 +1,30 @@
import { useDisclosure } from "@mantine/hooks";
-import type { DatePickerShortcut } from "metabase/querying/filters/types";
+import type {
+ DatePickerShortcut,
+ RelativeIntervalDirection,
+} from "metabase/querying/filters/types";
import { SearchFilterDateDisplay } from "metabase/search/components/SearchFilterDateDisplay";
import { SearchFilterDatePicker } from "metabase/search/components/SearchFilterDatePicker";
import { Popover } from "metabase/ui";
import { FilterFieldSet } from "../FilterFieldSet";
+type TimeFilterWidgetProps = {
+ label: string;
+ value: string | undefined;
+ availableShortcuts?: DatePickerShortcut[];
+ availableDirections?: RelativeIntervalDirection[];
+ onChange: (value: string | undefined) => void;
+};
+
export function TimeFilterWidget({
label,
value,
onChange,
availableShortcuts,
-}: {
- label: string;
- value: string | undefined;
- onChange: (value: string | undefined) => void;
- availableShortcuts?: DatePickerShortcut[];
-}) {
+ availableDirections,
+}: TimeFilterWidgetProps) {
const [isOpened, { toggle, close }] = useDisclosure();
function handleRemove() {
@@ -49,6 +56,7 @@ export function TimeFilterWidget({
value={value ?? null}
onChange={handleChange}
availableShortcuts={availableShortcuts}
+ availableDirections={availableDirections}
/>
</Popover.Dropdown>
</Popover>
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/JobListPage/JobFilterList/JobFilterList.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/JobListPage/JobFilterList/JobFilterList.tsx
index 8961e8a34ac..1eaf8130c91 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms/pages/JobListPage/JobFilterList/JobFilterList.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/JobListPage/JobFilterList/JobFilterList.tsx
@@ -2,7 +2,7 @@ import { replace } from "react-router-redux";
import { t } from "ttag";
import { useDispatch } from "metabase/lib/redux";
-import type { DatePickerShortcut } from "metabase/querying/filters/types";
+import type { RelativeIntervalDirection } from "metabase/querying/filters/types";
import { Group } from "metabase/ui";
import { getJobListUrl } from "metabase-enterprise/transforms/urls";
import type { TransformTag, TransformTagId } from "metabase-types/api";
@@ -12,13 +12,21 @@ import { TimeFilterWidget } from "../../../components/TimeFilterWidget";
import type { JobListParams } from "../../../types";
type FilterListProps = {
- tags: TransformTag[];
params: JobListParams;
+ tags: TransformTag[];
};
-const NO_SHORTCUTS: DatePickerShortcut[] = [];
+const PAST_INTERVAL_DIRECTIONS: RelativeIntervalDirection[] = [
+ "last",
+ "current",
+];
+
+const FUTURE_INTERVAL_DIRECTIONS: RelativeIntervalDirection[] = [
+ "current",
+ "next",
+];
-export function JobFilterList({ tags, params }: FilterListProps) {
+export function JobFilterList({ params, tags }: FilterListProps) {
const dispatch = useDispatch();
const handleLastRunStartTimeChange = (lastRunStartTime?: string) => {
@@ -38,13 +46,14 @@ export function JobFilterList({ tags, params }: FilterListProps) {
<TimeFilterWidget
label={t`Last run at`}
value={params.lastRunStartTime}
+ availableDirections={PAST_INTERVAL_DIRECTIONS}
onChange={handleLastRunStartTimeChange}
/>
<TimeFilterWidget
- label={t`Next run`}
+ label={t`Next run at`}
value={params.nextRunStartTime}
+ availableDirections={FUTURE_INTERVAL_DIRECTIONS}
onChange={handleNextRunStartTimeChange}
- availableShortcuts={NO_SHORTCUTS}
/>
<TagFilterWidget
tagIds={params.transformTagIds ?? []}
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/JobListPage/JobFilterList/JobFilterList.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/JobListPage/JobFilterList/JobFilterList.unit.spec.tsx
new file mode 100644
index 00000000000..96d0aff6326
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/JobListPage/JobFilterList/JobFilterList.unit.spec.tsx
@@ -0,0 +1,44 @@
+import userEvent from "@testing-library/user-event";
+
+import { renderWithProviders, screen } from "__support__/ui";
+import type { JobListParams } from "metabase-enterprise/transforms/types";
+import type { TransformTag } from "metabase-types/api";
+
+import { JobFilterList } from "./JobFilterList";
+
+type SetupOpts = {
+ params?: JobListParams;
+ tags?: TransformTag[];
+};
+
+function setup({ params = {}, tags = [] }: SetupOpts = {}) {
+ renderWithProviders(<JobFilterList params={params} tags={tags} />);
+}
+
+describe("JobFilterList", () => {
+ it("should allow only past or current date options for the last run filter", async () => {
+ setup();
+
+ await userEvent.click(screen.getByText("Last run at"));
+ expect(await screen.findByText("Today")).toBeInTheDocument();
+ expect(screen.getByText("Yesterday")).toBeInTheDocument();
+
+ await userEvent.click(screen.getByText("Relative date range…"));
+ expect(await screen.findByText("Previous")).toBeInTheDocument();
+ expect(screen.getByText("Current")).toBeInTheDocument();
+ expect(screen.queryByText("Next")).not.toBeInTheDocument();
+ });
+
+ it("should allow only current or future date options for the next run filter", async () => {
+ setup();
+
+ await userEvent.click(screen.getByText("Next run at"));
+ expect(await screen.findByText("Today")).toBeInTheDocument();
+ expect(screen.queryByText("Yesterday")).not.toBeInTheDocument();
+
+ await userEvent.click(screen.getByText("Relative date range…"));
+ expect(await screen.findByText("Current")).toBeInTheDocument();
+ expect(screen.getByText("Next")).toBeInTheDocument();
+ expect(screen.queryByText("Previous")).not.toBeInTheDocument();
+ });
+});
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/index.ts b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/index.ts
deleted file mode 100644
index fde24ace38f..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export * from "./FilterList";
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/FilterList.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/RunFilterList.tsx
similarity index 86%
rename from enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/FilterList.tsx
rename to enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/RunFilterList.tsx
index eba3559e037..0423dafd056 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/FilterList.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/RunFilterList.tsx
@@ -2,6 +2,7 @@ import { replace } from "react-router-redux";
import { t } from "ttag";
import { useDispatch } from "metabase/lib/redux";
+import type { RelativeIntervalDirection } from "metabase/querying/filters/types";
import { Group } from "metabase/ui";
import { getRunListUrl } from "metabase-enterprise/transforms/urls";
import type {
@@ -21,13 +22,22 @@ import { RunMethodFilterWidget } from "./RunMethodFilterWidget";
import { StatusFilterWidget } from "./StatusFilterWidget";
import { TransformFilterWidget } from "./TransformFilterWidget";
-type FilterListProps = {
+const PAST_INTERVAL_DIRECTIONS: RelativeIntervalDirection[] = [
+ "last",
+ "current",
+];
+
+type RunFilterListProps = {
+ params: RunListParams;
transforms: Transform[];
tags: TransformTag[];
- params: RunListParams;
};
-export function FilterList({ transforms, tags, params }: FilterListProps) {
+export function RunFilterList({
+ params,
+ transforms,
+ tags,
+}: RunFilterListProps) {
const dispatch = useDispatch();
const handleTransformsChange = (transformIds: TransformId[]) => {
@@ -73,11 +83,13 @@ export function FilterList({ transforms, tags, params }: FilterListProps) {
<TimeFilterWidget
label={t`Start at`}
value={params.startTime}
+ availableDirections={PAST_INTERVAL_DIRECTIONS}
onChange={handleStartTimeChange}
/>
<TimeFilterWidget
label={t`End at`}
value={params.endTime}
+ availableDirections={PAST_INTERVAL_DIRECTIONS}
onChange={handleEndTimeChange}
/>
<RunMethodFilterWidget
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/RunFilterList.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/RunFilterList.unit.spec.tsx
new file mode 100644
index 00000000000..116d31d8e8d
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/RunFilterList.unit.spec.tsx
@@ -0,0 +1,37 @@
+import userEvent from "@testing-library/user-event";
+
+import { renderWithProviders, screen } from "__support__/ui";
+import type { RunListParams } from "metabase-enterprise/transforms/types";
+import type { Transform, TransformTag } from "metabase-types/api";
+
+import { RunFilterList } from "./RunFilterList";
+
+type SetupOpts = {
+ params?: RunListParams;
+ transforms?: Transform[];
+ tags?: TransformTag[];
+};
+
+function setup({ params = {}, transforms = [], tags = [] }: SetupOpts = {}) {
+ renderWithProviders(
+ <RunFilterList params={params} transforms={transforms} tags={tags} />,
+ );
+}
+
+describe("RunFilterList", () => {
+ it.each(["Start at", "End at"])(
+ "should allow only past or current date options for start and end date filters",
+ async (label) => {
+ setup();
+
+ await userEvent.click(screen.getByText(label));
+ expect(await screen.findByText("Today")).toBeInTheDocument();
+ expect(screen.getByText("Yesterday")).toBeInTheDocument();
+
+ await userEvent.click(screen.getByText("Relative date range…"));
+ expect(await screen.findByText("Previous")).toBeInTheDocument();
+ expect(screen.getByText("Current")).toBeInTheDocument();
+ expect(screen.queryByText("Next")).not.toBeInTheDocument();
+ },
+ );
+});
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/RunMethodFilterWidget/RunMethodFilterWidget.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/RunMethodFilterWidget/RunMethodFilterWidget.tsx
similarity index 100%
rename from enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/RunMethodFilterWidget/RunMethodFilterWidget.tsx
rename to enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/RunMethodFilterWidget/RunMethodFilterWidget.tsx
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/RunMethodFilterWidget/index.ts b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/RunMethodFilterWidget/index.ts
similarity index 100%
rename from enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/RunMethodFilterWidget/index.ts
rename to enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/RunMethodFilterWidget/index.ts
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/StatusFilterWidget/StatusFilterWidget.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/StatusFilterWidget/StatusFilterWidget.tsx
similarity index 100%
rename from enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/StatusFilterWidget/StatusFilterWidget.tsx
rename to enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/StatusFilterWidget/StatusFilterWidget.tsx
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/StatusFilterWidget/index.ts b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/StatusFilterWidget/index.ts
similarity index 100%
rename from enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/StatusFilterWidget/index.ts
rename to enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/StatusFilterWidget/index.ts
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/TransformFilterWidget/TransformFilterWidget.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/TransformFilterWidget/TransformFilterWidget.tsx
similarity index 100%
rename from enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/TransformFilterWidget/TransformFilterWidget.tsx
rename to enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/TransformFilterWidget/TransformFilterWidget.tsx
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/TransformFilterWidget/index.ts b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/TransformFilterWidget/index.ts
similarity index 100%
rename from enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/FilterList/TransformFilterWidget/index.ts
rename to enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/TransformFilterWidget/index.ts
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/index.ts b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/index.ts
new file mode 100644
index 00000000000..5221d90b22c
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunFilterList/index.ts
@@ -0,0 +1 @@
+export * from "./RunFilterList";
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunListPage.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunListPage.tsx
index f82434bc666..f1dee9d6536 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunListPage.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunListPage.tsx
@@ -14,7 +14,7 @@ import type { TransformRun } from "metabase-types/api";
import type { RunListParams } from "../../types";
-import { FilterList } from "./FilterList";
+import { RunFilterList } from "./RunFilterList";
import { RunList } from "./RunList";
import { PAGE_SIZE } from "./constants";
import { getParsedParams } from "./utils";
@@ -98,7 +98,7 @@ function RunListPageBody({ params }: RunListPageBodyProps) {
}
return (
<Stack data-testid="run-list-page">
- <FilterList transforms={transforms} tags={tags} params={params} />
+ <RunFilterList transforms={transforms} tags={tags} params={params} />
<RunList runs={data.data} totalCount={data.total} params={params} />
</Stack>
);
diff --git a/frontend/src/metabase/querying/filters/components/DatePicker/DatePicker.tsx b/frontend/src/metabase/querying/filters/components/DatePicker/DatePicker.tsx
index 2f08f6c40fd..0443864be21 100644
--- a/frontend/src/metabase/querying/filters/components/DatePicker/DatePicker.tsx
+++ b/frontend/src/metabase/querying/filters/components/DatePicker/DatePicker.tsx
@@ -1,6 +1,7 @@
import { type ReactNode, useState } from "react";
import {
+ DATE_PICKER_DIRECTIONS,
DATE_PICKER_OPERATORS,
DATE_PICKER_SHORTCUTS,
DATE_PICKER_UNITS,
@@ -10,6 +11,7 @@ import type {
DatePickerShortcut,
DatePickerUnit,
DatePickerValue,
+ RelativeIntervalDirection,
} from "metabase/querying/filters/types";
import { DateShortcutPicker } from "./DateShortcutPicker";
@@ -24,6 +26,7 @@ type DatePickerProps = {
availableOperators?: DatePickerOperator[];
availableShortcuts?: DatePickerShortcut[];
availableUnits?: DatePickerUnit[];
+ availableDirections?: RelativeIntervalDirection[];
renderSubmitButton?: (props: DatePickerSubmitButtonProps) => ReactNode;
renderBackButton?: () => ReactNode;
onChange: (value: DatePickerValue) => void;
@@ -35,6 +38,7 @@ export function DatePicker({
availableOperators = DATE_PICKER_OPERATORS,
availableShortcuts = DATE_PICKER_SHORTCUTS,
availableUnits = DATE_PICKER_UNITS,
+ availableDirections = DATE_PICKER_DIRECTIONS,
renderSubmitButton = renderDefaultSubmitButton,
renderBackButton,
onChange,
@@ -64,6 +68,7 @@ export function DatePicker({
<RelativeDatePicker
value={value?.type === type ? value : undefined}
availableUnits={availableUnits}
+ availableDirections={availableDirections}
renderSubmitButton={renderSubmitButton}
onChange={onChange}
onBack={handleBack}
@@ -87,6 +92,7 @@ export function DatePicker({
<DateShortcutPicker
availableOperators={availableOperators}
availableShortcuts={availableShortcuts}
+ availableDirections={availableDirections}
renderBackButton={renderBackButton}
onChange={onChange}
onSelectType={setType}
diff --git a/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/DateShortcutPicker.tsx b/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/DateShortcutPicker.tsx
index 15db6995386..486ba92930c 100644
--- a/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/DateShortcutPicker.tsx
+++ b/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/DateShortcutPicker.tsx
@@ -5,6 +5,7 @@ import type {
DatePickerShortcut,
DatePickerValueType,
RelativeDatePickerValue,
+ RelativeIntervalDirection,
} from "metabase/querying/filters/types";
import { Box, Button, Divider } from "metabase/ui";
@@ -16,6 +17,7 @@ import { getShortcutOptionGroups, getTypeOptions } from "./utils";
interface DateShortcutPickerProps {
availableOperators: DatePickerOperator[];
availableShortcuts: DatePickerShortcut[];
+ availableDirections: RelativeIntervalDirection[];
renderBackButton?: () => ReactNode;
onChange: (value: RelativeDatePickerValue) => void;
onSelectType: (type: DatePickerValueType) => void;
@@ -24,13 +26,14 @@ interface DateShortcutPickerProps {
export function DateShortcutPicker({
availableOperators,
availableShortcuts,
+ availableDirections,
renderBackButton,
onChange,
onSelectType,
}: DateShortcutPickerProps) {
const shortcutGroups = useMemo(() => {
- return getShortcutOptionGroups(availableShortcuts);
- }, [availableShortcuts]);
+ return getShortcutOptionGroups(availableShortcuts, availableDirections);
+ }, [availableShortcuts, availableDirections]);
const typeOptions = useMemo(() => {
return getTypeOptions(availableOperators);
diff --git a/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/DateShortcutPicker.unit.spec.tsx b/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/DateShortcutPicker.unit.spec.tsx
index 04a78b161f7..3a744542898 100644
--- a/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/DateShortcutPicker.unit.spec.tsx
+++ b/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/DateShortcutPicker.unit.spec.tsx
@@ -2,12 +2,14 @@ import userEvent from "@testing-library/user-event";
import { renderWithProviders, screen } from "__support__/ui";
import {
+ DATE_PICKER_DIRECTIONS,
DATE_PICKER_OPERATORS,
DATE_PICKER_SHORTCUTS,
} from "metabase/querying/filters/constants";
import type {
DatePickerOperator,
DatePickerShortcut,
+ RelativeIntervalDirection,
} from "metabase/querying/filters/types";
import { DateShortcutPicker } from "./DateShortcutPicker";
@@ -15,11 +17,13 @@ import { DateShortcutPicker } from "./DateShortcutPicker";
interface SetupOpts {
availableOperators?: DatePickerOperator[];
availableShortcuts?: DatePickerShortcut[];
+ availableDirections?: RelativeIntervalDirection[];
}
function setup({
availableOperators = DATE_PICKER_OPERATORS,
availableShortcuts = DATE_PICKER_SHORTCUTS,
+ availableDirections = DATE_PICKER_DIRECTIONS,
}: SetupOpts = {}) {
const onChange = jest.fn();
const onSelectType = jest.fn();
@@ -28,6 +32,7 @@ function setup({
<DateShortcutPicker
availableOperators={availableOperators}
availableShortcuts={availableShortcuts}
+ availableDirections={availableDirections}
onChange={onChange}
onSelectType={onSelectType}
/>,
@@ -52,4 +57,28 @@ describe("DateShortcutPicker", () => {
await userEvent.click(screen.getByText("Fixed date range…"));
expect(onSelectType).toHaveBeenCalledWith("specific");
});
+
+ it("should be able to filter shortcuts based on current interval directions", () => {
+ setup({ availableDirections: ["current"] });
+ expect(screen.getByText("Today")).toBeInTheDocument();
+ expect(screen.queryByText("Yesterday")).not.toBeInTheDocument();
+ expect(screen.queryByText("Previous week")).not.toBeInTheDocument();
+ expect(screen.queryByText("Previous month")).not.toBeInTheDocument();
+ });
+
+ it("should be able to filter shortcuts based on current and future interval directions", () => {
+ setup({ availableDirections: ["current", "next"] });
+ expect(screen.getByText("Today")).toBeInTheDocument();
+ expect(screen.queryByText("Yesterday")).not.toBeInTheDocument();
+ expect(screen.queryByText("Previous week")).not.toBeInTheDocument();
+ expect(screen.queryByText("Previous month")).not.toBeInTheDocument();
+ });
+
+ it("should be able to filter shortcuts based on past and current interval directions", () => {
+ setup({ availableDirections: ["last", "current"] });
+ expect(screen.getByText("Today")).toBeInTheDocument();
+ expect(screen.getByText("Yesterday")).toBeInTheDocument();
+ expect(screen.getByText("Previous week")).toBeInTheDocument();
+ expect(screen.getByText("Previous month")).toBeInTheDocument();
+ });
});
diff --git a/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/constants.ts b/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/constants.ts
index 58c7195345d..a1c05138146 100644
--- a/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/constants.ts
+++ b/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/constants.ts
@@ -10,6 +10,7 @@ const DAY_WEEK_SHORTCUT_OPTIONS: ShortcutOption[] = [
return t`Today`;
},
shortcut: "today",
+ direction: "current",
value: {
type: "relative",
value: 0,
@@ -21,6 +22,7 @@ const DAY_WEEK_SHORTCUT_OPTIONS: ShortcutOption[] = [
return t`Yesterday`;
},
shortcut: "yesterday",
+ direction: "last",
value: {
type: "relative",
value: -1,
@@ -32,6 +34,7 @@ const DAY_WEEK_SHORTCUT_OPTIONS: ShortcutOption[] = [
return t`Previous week`;
},
shortcut: "previous-week",
+ direction: "last",
value: {
type: "relative",
value: -1,
@@ -43,6 +46,7 @@ const DAY_WEEK_SHORTCUT_OPTIONS: ShortcutOption[] = [
return t`Previous 7 days`;
},
shortcut: "previous-7-days",
+ direction: "last",
value: {
type: "relative",
value: -7,
@@ -54,6 +58,7 @@ const DAY_WEEK_SHORTCUT_OPTIONS: ShortcutOption[] = [
return t`Previous 30 days`;
},
shortcut: "previous-30-days",
+ direction: "last",
value: {
type: "relative",
value: -30,
@@ -68,6 +73,7 @@ const MONTH_SHORTCUT_OPTIONS: ShortcutOption[] = [
return t`Previous month`;
},
shortcut: "previous-month",
+ direction: "last",
value: {
type: "relative",
value: -1,
@@ -79,6 +85,7 @@ const MONTH_SHORTCUT_OPTIONS: ShortcutOption[] = [
return t`Previous 3 months`;
},
shortcut: "previous-3-months",
+ direction: "last",
value: {
type: "relative",
value: -3,
@@ -90,6 +97,7 @@ const MONTH_SHORTCUT_OPTIONS: ShortcutOption[] = [
return t`Previous 12 months`;
},
shortcut: "previous-12-months",
+ direction: "last",
value: {
type: "relative",
value: -12,
diff --git a/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/index.ts b/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/index.ts
index ad602a8dac2..8c735c19817 100644
--- a/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/index.ts
+++ b/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/index.ts
@@ -1,2 +1 @@
export * from "./DateShortcutPicker";
-export { getShortcutOptions } from "./utils";
diff --git a/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/utils.ts b/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/utils.ts
index fa77c49b935..34c09e98f3f 100644
--- a/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/utils.ts
+++ b/frontend/src/metabase/querying/filters/components/DatePicker/DateShortcutPicker/utils.ts
@@ -1,23 +1,23 @@
import type {
DatePickerOperator,
DatePickerShortcut,
+ RelativeIntervalDirection,
ShortcutOption,
} from "metabase/querying/filters/types";
import { SHORTCUT_OPTION_GROUPS, TYPE_OPTIONS } from "./constants";
import type { TypeOption } from "./types";
-export function getShortcutOptions(
- availableShortcuts: DatePickerShortcut[],
-): ShortcutOption[] {
- return getShortcutOptionGroups(availableShortcuts).flat();
-}
-
export function getShortcutOptionGroups(
availableShortcuts: DatePickerShortcut[],
+ availableDirections: RelativeIntervalDirection[],
): ShortcutOption[][] {
return SHORTCUT_OPTION_GROUPS.map((options) =>
- options.filter((option) => availableShortcuts.includes(option.shortcut)),
+ options.filter(
+ (option) =>
+ availableShortcuts.includes(option.shortcut) &&
+ availableDirections.includes(option.direction),
+ ),
).filter((options) => options.length > 0);
}
diff --git a/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/RelativeDatePicker.tsx b/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/RelativeDatePicker.tsx
index 0886316a57c..af5b3c7b388 100644
--- a/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/RelativeDatePicker.tsx
+++ b/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/RelativeDatePicker.tsx
@@ -3,6 +3,7 @@ import { type ReactNode, useState } from "react";
import type {
DatePickerUnit,
RelativeDatePickerValue,
+ RelativeIntervalDirection,
} from "metabase/querying/filters/types";
import { Box, Divider, Flex, PopoverBackButton, Tabs } from "metabase/ui";
@@ -13,8 +14,9 @@ import { CurrentDatePicker } from "./CurrentDatePicker";
import { DateIntervalPicker } from "./DateIntervalPicker";
import { DateOffsetIntervalPicker } from "./DateOffsetIntervalPicker";
import S from "./RelativeDatePicker.module.css";
-import { DEFAULT_VALUE, TABS } from "./constants";
import {
+ getAvailableTabs,
+ getDefaultValue,
getDirection,
isIntervalValue,
isOffsetIntervalValue,
@@ -24,6 +26,7 @@ import {
interface RelativeDatePickerProps {
value: RelativeDatePickerValue | undefined;
availableUnits: DatePickerUnit[];
+ availableDirections: RelativeIntervalDirection[];
renderSubmitButton?: (props: DatePickerSubmitButtonProps) => ReactNode;
onChange: (value: RelativeDatePickerValue) => void;
onBack: () => void;
@@ -33,18 +36,20 @@ interface RelativeDatePickerProps {
export function RelativeDatePicker({
value: initialValue,
availableUnits,
+ availableDirections,
renderSubmitButton = renderDefaultSubmitButton,
onChange,
onBack,
readOnly,
}: RelativeDatePickerProps) {
- const [value, setValue] = useState<RelativeDatePickerValue | undefined>(
- initialValue ?? DEFAULT_VALUE,
+ const [value, setValue] = useState(
+ initialValue ?? getDefaultValue(availableDirections),
);
+ const tabs = getAvailableTabs(initialValue, availableDirections);
const direction = getDirection(value);
const handleTabChange = (tabValue: string | null) => {
- const tab = TABS.find((tab) => tab.direction === tabValue);
+ const tab = tabs.find((tab) => tab.direction === tabValue);
if (tab) {
setValue(setDirection(value, tab.direction));
}
@@ -66,7 +71,7 @@ export function RelativeDatePicker({
withArrow={!readOnly}
/>
<Tabs.List className={S.TabList}>
- {TABS.map((tab) => (
+ {tabs.map((tab) => (
<Tabs.Tab key={tab.direction} value={tab.direction}>
{tab.label}
</Tabs.Tab>
@@ -74,7 +79,7 @@ export function RelativeDatePicker({
</Tabs.List>
</Flex>
<Divider />
- {TABS.map((tab) => (
+ {tabs.map((tab) => (
<Tabs.Panel key={tab.direction} value={tab.direction}>
{value != null && isOffsetIntervalValue(value) ? (
<DateOffsetIntervalPicker
diff --git a/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/RelativeDatePicker.unit.spec.tsx b/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/RelativeDatePicker.unit.spec.tsx
index d53b0abf781..d5a578ca400 100644
--- a/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/RelativeDatePicker.unit.spec.tsx
+++ b/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/RelativeDatePicker.unit.spec.tsx
@@ -1,10 +1,14 @@
import userEvent from "@testing-library/user-event";
import { renderWithProviders, screen } from "__support__/ui";
-import { DATE_PICKER_UNITS } from "metabase/querying/filters/constants";
+import {
+ DATE_PICKER_DIRECTIONS,
+ DATE_PICKER_UNITS,
+} from "metabase/querying/filters/constants";
import type {
DatePickerUnit,
RelativeDatePickerValue,
+ RelativeIntervalDirection,
} from "metabase/querying/filters/types";
import { RelativeDatePicker } from "./RelativeDatePicker";
@@ -17,9 +21,14 @@ const TAB_CASES = TABS.flatMap((fromTab) =>
interface SetupOpts {
value?: RelativeDatePickerValue;
availableUnits?: DatePickerUnit[];
+ availableDirections?: RelativeIntervalDirection[];
}
-function setup({ value, availableUnits = DATE_PICKER_UNITS }: SetupOpts = {}) {
+function setup({
+ value,
+ availableUnits = DATE_PICKER_UNITS,
+ availableDirections = DATE_PICKER_DIRECTIONS,
+}: SetupOpts = {}) {
const onChange = jest.fn();
const onBack = jest.fn();
@@ -27,6 +36,7 @@ function setup({ value, availableUnits = DATE_PICKER_UNITS }: SetupOpts = {}) {
<RelativeDatePicker
value={value}
availableUnits={availableUnits}
+ availableDirections={availableDirections}
onChange={onChange}
onBack={onBack}
/>,
diff --git a/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/constants.ts b/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/constants.ts
index d5621bde932..1744664ed62 100644
--- a/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/constants.ts
+++ b/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/constants.ts
@@ -2,26 +2,28 @@ import { t } from "ttag";
import type { Tab } from "./types";
-export const TABS: Tab[] = [
- {
- get label() {
- return t`Previous`;
- },
- direction: "last",
+export const LAST_TAB: Tab = {
+ get label() {
+ return t`Previous`;
},
- {
- get label() {
- return t`Current`;
- },
- direction: "current",
+ direction: "last",
+};
+
+export const CURRENT_TAB: Tab = {
+ get label() {
+ return t`Current`;
},
- {
- get label() {
- return t`Next`;
- },
- direction: "next",
+ direction: "current",
+};
+
+export const NEXT_TAB: Tab = {
+ get label() {
+ return t`Next`;
},
-];
+ direction: "next",
+};
+
+export const TABS = [LAST_TAB, CURRENT_TAB, NEXT_TAB];
export const DEFAULT_VALUE = {
type: "relative",
diff --git a/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/utils.ts b/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/utils.ts
index fa59fbca350..e01b4acbf19 100644
--- a/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/utils.ts
+++ b/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/utils.ts
@@ -8,7 +8,7 @@ import type {
} from "metabase/querying/filters/types";
import * as Lib from "metabase-lib";
-import { DEFAULT_VALUE } from "./constants";
+import { DEFAULT_VALUE, TABS } from "./constants";
export function isRelativeValue(
value: DatePickerValue | undefined,
@@ -134,3 +134,28 @@ export function formatDateRange({
includeCurrent: options?.includeCurrent,
});
}
+
+export function getDefaultValue(
+ availableDirections: RelativeIntervalDirection[],
+) {
+ if (availableDirections.length === 0) {
+ return DEFAULT_VALUE;
+ }
+
+ return setDirection(DEFAULT_VALUE, availableDirections[0]);
+}
+
+export function getAvailableTabs(
+ initialValue: RelativeDatePickerValue | undefined,
+ availableDirections: RelativeIntervalDirection[],
+) {
+ const initialDirection = getDirection(
+ initialValue ?? getDefaultValue(availableDirections),
+ );
+
+ return TABS.filter(
+ (tab) =>
+ tab.direction === initialDirection ||
+ availableDirections.includes(tab.direction),
+ );
+}
diff --git a/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/utils.unit.spec.ts b/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/utils.unit.spec.ts
index 43012bfb0d0..cb383361632 100644
--- a/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/utils.unit.spec.ts
+++ b/frontend/src/metabase/querying/filters/components/DatePicker/RelativeDatePicker/utils.unit.spec.ts
@@ -1,9 +1,12 @@
import type {
DatePickerTruncationUnit,
RelativeDatePickerValue,
+ RelativeIntervalDirection,
} from "metabase/querying/filters/types";
-import { setDirection } from "./utils";
+import { CURRENT_TAB, LAST_TAB, NEXT_TAB } from "./constants";
+import type { Tab } from "./types";
+import { getAvailableTabs, getDefaultValue, setDirection } from "./utils";
describe("setDirection", () => {
describe("current", () => {
@@ -117,3 +120,87 @@ describe("setDirection", () => {
});
});
});
+
+type GetDefaultValueTestCase = {
+ availableDirections: RelativeIntervalDirection[];
+ expectedValue: RelativeDatePickerValue | undefined;
+};
+
+describe("getDefaultValue", () => {
+ it.each<GetDefaultValueTestCase>([
+ {
+ availableDirections: [],
+ expectedValue: { type: "relative", value: -30, unit: "day" },
+ },
+ {
+ availableDirections: ["last", "current", "next"],
+ expectedValue: { type: "relative", value: -30, unit: "day" },
+ },
+ {
+ availableDirections: ["last", "current"],
+ expectedValue: { type: "relative", value: -30, unit: "day" },
+ },
+ {
+ availableDirections: ["current", "current"],
+ expectedValue: undefined,
+ },
+ ])(
+ "should compute the default value based on available directions",
+ ({ availableDirections, expectedValue }) => {
+ expect(getDefaultValue(availableDirections)).toEqual(expectedValue);
+ },
+ );
+});
+
+type GetAvailableTabsTestCase = {
+ initialValue: RelativeDatePickerValue | undefined;
+ availableDirections: RelativeIntervalDirection[];
+ expectedTabs: Tab[];
+};
+
+describe("getAvailableTabs", () => {
+ it.each<GetAvailableTabsTestCase>([
+ {
+ initialValue: undefined,
+ availableDirections: [],
+ expectedTabs: [LAST_TAB],
+ },
+ {
+ initialValue: undefined,
+ availableDirections: ["current", "next"],
+ expectedTabs: [CURRENT_TAB, NEXT_TAB],
+ },
+ {
+ initialValue: undefined,
+ availableDirections: ["last", "current", "next"],
+ expectedTabs: [LAST_TAB, CURRENT_TAB, NEXT_TAB],
+ },
+ {
+ initialValue: { type: "relative", value: 0, unit: "day" },
+ availableDirections: ["current", "next"],
+ expectedTabs: [CURRENT_TAB, NEXT_TAB],
+ },
+ {
+ initialValue: { type: "relative", value: 30, unit: "day" },
+ availableDirections: ["current", "next"],
+ expectedTabs: [CURRENT_TAB, NEXT_TAB],
+ },
+ {
+ initialValue: { type: "relative", value: -30, unit: "day" },
+ availableDirections: ["current", "next"],
+ expectedTabs: [LAST_TAB, CURRENT_TAB, NEXT_TAB],
+ },
+ {
+ initialValue: { type: "relative", value: -30, unit: "day" },
+ availableDirections: ["last", "current"],
+ expectedTabs: [LAST_TAB, CURRENT_TAB],
+ },
+ ])(
+ "should compute the default value based on available directions",
+ ({ initialValue, availableDirections, expectedTabs }) => {
+ expect(getAvailableTabs(initialValue, availableDirections)).toEqual(
+ expectedTabs,
+ );
+ },
+ );
+});
diff --git a/frontend/src/metabase/querying/filters/constants.ts b/frontend/src/metabase/querying/filters/constants.ts
index 8ae0b4d7618..9ead449ca47 100644
--- a/frontend/src/metabase/querying/filters/constants.ts
+++ b/frontend/src/metabase/querying/filters/constants.ts
@@ -48,3 +48,9 @@ export const DATE_PICKER_UNITS = [
...DATE_PICKER_TRUNCATION_UNITS,
...DATE_PICKER_EXTRACTION_UNITS,
];
+
+export const DATE_PICKER_DIRECTIONS = [
+ "last" as const,
+ "current" as const,
+ "next" as const,
+];
diff --git a/frontend/src/metabase/querying/filters/types.ts b/frontend/src/metabase/querying/filters/types.ts
index cb787cc24e9..631d807e526 100644
--- a/frontend/src/metabase/querying/filters/types.ts
+++ b/frontend/src/metabase/querying/filters/types.ts
@@ -1,6 +1,7 @@
import type * as Lib from "metabase-lib";
import type {
+ DATE_PICKER_DIRECTIONS,
DATE_PICKER_EXTRACTION_UNITS,
DATE_PICKER_SHORTCUTS,
DATE_PICKER_TRUNCATION_UNITS,
@@ -74,11 +75,12 @@ export type DatePickerValue =
export type DatePickerValueType = DatePickerValue["type"];
-export type RelativeIntervalDirection = "last" | "current" | "next";
+export type RelativeIntervalDirection = (typeof DATE_PICKER_DIRECTIONS)[number];
export interface ShortcutOption {
label: string;
shortcut: DatePickerShortcut;
+ direction: RelativeIntervalDirection;
value: RelativeDatePickerValue;
}
diff --git a/frontend/src/metabase/querying/parameters/components/DateAllOptionsWidget/DateAllOptionsWidget.tsx b/frontend/src/metabase/querying/parameters/components/DateAllOptionsWidget/DateAllOptionsWidget.tsx
index 2394b507d5d..95787b3eee7 100644
--- a/frontend/src/metabase/querying/parameters/components/DateAllOptionsWidget/DateAllOptionsWidget.tsx
+++ b/frontend/src/metabase/querying/parameters/components/DateAllOptionsWidget/DateAllOptionsWidget.tsx
@@ -7,6 +7,7 @@ import type {
DatePickerOperator,
DatePickerShortcut,
DatePickerValue,
+ RelativeIntervalDirection,
} from "metabase/querying/filters/types";
import {
deserializeDateParameterValue,
@@ -19,6 +20,7 @@ type DateAllOptionsWidgetProps = {
value: ParameterValueOrArray | null | undefined;
availableOperators?: DatePickerOperator[];
availableShortcuts?: DatePickerShortcut[];
+ availableDirections?: RelativeIntervalDirection[];
submitButtonLabel?: string;
onChange: (value: string) => void;
};
@@ -26,6 +28,7 @@ type DateAllOptionsWidgetProps = {
export function DateAllOptionsWidget({
value,
availableOperators,
+ availableDirections,
submitButtonLabel = t`Apply`,
onChange,
availableShortcuts,
@@ -41,6 +44,7 @@ export function DateAllOptionsWidget({
value={pickerValue}
availableOperators={availableOperators}
availableShortcuts={availableShortcuts}
+ availableDirections={availableDirections}
renderSubmitButton={({ isDisabled }) => (
<Button type="submit" variant="filled" disabled={isDisabled}>
{submitButtonLabel}
diff --git a/frontend/src/metabase/search/components/SearchFilterDatePicker/SearchFilterDatePicker.tsx b/frontend/src/metabase/search/components/SearchFilterDatePicker/SearchFilterDatePicker.tsx
index b5a914506d6..6f8e7dd4410 100644
--- a/frontend/src/metabase/search/components/SearchFilterDatePicker/SearchFilterDatePicker.tsx
+++ b/frontend/src/metabase/search/components/SearchFilterDatePicker/SearchFilterDatePicker.tsx
@@ -1,26 +1,32 @@
import type {
DatePickerOperator,
DatePickerShortcut,
+ RelativeIntervalDirection,
} from "metabase/querying/filters/types";
import { DateAllOptionsWidget } from "metabase/querying/parameters/components/DateAllOptionsWidget";
const OPERATORS: DatePickerOperator[] = ["=", ">", "<", "between"];
+type SearchFilterDatePickerProps = {
+ value: string | null;
+ onChange: (value: string | null) => void;
+ availableShortcuts?: DatePickerShortcut[];
+ availableDirections?: RelativeIntervalDirection[];
+};
+
export const SearchFilterDatePicker = ({
value,
onChange,
availableShortcuts,
-}: {
- value: string | null;
- onChange: (value: string | null) => void;
- availableShortcuts?: DatePickerShortcut[];
-}) => {
+ availableDirections,
+}: SearchFilterDatePickerProps) => {
return (
<DateAllOptionsWidget
value={value ?? undefined}
availableOperators={OPERATORS}
onChange={onChange}
availableShortcuts={availableShortcuts}
+ availableDirections={availableDirections}
/>
);
};