Skip to content

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

Explore further from brush filter (#78144)

Kevin Kelleher637e1b43444c
diff --git a/e2e/test/scenarios/explorations/explorations.cy.spec.ts b/e2e/test/scenarios/explorations/explorations.cy.spec.ts
index f7028b102d5..ba959b8c831 100644
--- a/e2e/test/scenarios/explorations/explorations.cy.spec.ts
+++ b/e2e/test/scenarios/explorations/explorations.cy.spec.ts
@@ -599,6 +599,22 @@ function visitExplorationUntilSettled(
awaitThreadCompletion(0);
}
+/**
+ * The FE polls every 2s while the new thread's queries are in flight, then
+ * toasts once its first page lands. Timing is covered by
+ * ExplorationPage.unit.spec.tsx — here we just wait for the real BE.
+ * Scoped to the toast container so we don't match the thread name in the
+ * sidebar.
+ */
+function openExploreFurtherToast(threadName: string): void {
+ H.undoToastListContainer().within(() => {
+ cy.findByText(`Added ${threadName}`, { timeout: 60000 }).should(
+ "be.visible",
+ );
+ cy.findByRole("button", { name: "View" }).click();
+ });
+}
+
describe("scenarios > explorations > sidebar triage", () => {
const sidebar = () => cy.findByTestId("exploration-page-sidebar");
const filterToggle = () => cy.findByTestId("exploration-show-hidden-toggle");
@@ -986,10 +1002,12 @@ describe("scenarios > explorations > chart click-through", () => {
expect(request.body.explore_filters).to.be.an("array").and.not.be
.empty;
expect(request.body.explore_filters[0]).to.include.keys(
+ "operator",
"field_ref",
"value",
"display_value",
);
+ expect(request.body.explore_filters[0].operator).to.eq("=");
// Unjustified type cast. FIXME
const threads = (response?.body as Exploration).threads ?? [];
@@ -1000,19 +1018,10 @@ describe("scenarios > explorations > chart click-through", () => {
cy.wrap(newThread!.name).as("newThreadName");
});
- // The FE polls every 2s while the new thread's queries are in flight,
- // then toasts once its first page lands. Timing is covered by
- // ExplorationPage.unit.spec.tsx — here we just wait for the real BE.
- cy.get("@newThreadName").then((name) => {
- // Scoped to the toast container — an unscoped text query could
- // match the thread name rendered in the sidebar instead.
- H.undoToastListContainer()
- .findByText(`Added ${name}`, { timeout: 60000 })
- .should("be.visible");
+ cy.get<string>("@newThreadName").then((name) => {
+ openExploreFurtherToast(name);
});
- cy.findByRole("button", { name: "View" }).click();
-
cy.location("pathname").should(
"include",
`/question/research/${explorationId}/page/`,
@@ -1035,6 +1044,125 @@ describe("scenarios > explorations > chart click-through", () => {
});
});
});
+
+ it("brushing a timeseries cartesian chart opens Explore further only, posts between explore_filters, and navigates from the new-thread toast", () => {
+ cy.request<GetExplorationDataResponse>(
+ "GET",
+ "/api/exploration/dimensions",
+ ).then(({ body: data }) => {
+ const ordersMetric = data.metrics.find(
+ (metric) => metric.name === ORDERS_COUNT_METRIC_NAME,
+ );
+ expect(
+ ordersMetric,
+ `"${ORDERS_COUNT_METRIC_NAME}" metric is exposed by /api/exploration/dimensions`,
+ ).to.exist;
+ const dimsById = new Map(
+ data.dimension_groups.flatMap((group) =>
+ group.dimensions.map((dim) => [dim.id, dim] as const),
+ ),
+ );
+ const temporalDimension = ordersMetric!.dimension_ids
+ .map((id) => dimsById.get(id))
+ .find((dim) => dim != null && dim.effective_type.includes("Date"));
+ expect(
+ temporalDimension,
+ "orders metric exposes at least one temporal dimension",
+ ).to.exist;
+
+ H.createExplorationViaApi({
+ name: "Chart brush explore-further fixture",
+ metricCardIds: [ordersMetric!.id],
+ dimensionIds: [temporalDimension!.id],
+ }).then((explorationId) => {
+ let initialThreadIds: number[] = [];
+
+ cy.intercept(
+ "POST",
+ `/api/exploration/${explorationId}/explore-further`,
+ ).as("exploreFurther");
+
+ visitExplorationUntilSettled(explorationId, 1);
+
+ cy.request<Exploration>(
+ "GET",
+ `/api/exploration/${explorationId}`,
+ ).then(({ body: exploration }) => {
+ initialThreadIds = (exploration.threads ?? []).map(
+ (thread) => thread.id,
+ );
+ });
+
+ cy.findByTestId("exploration-page-sidebar").within(() => {
+ cy.findByRole("group", { name: ordersMetric!.name }).then(
+ ($group) => {
+ if ($group.attr("aria-expanded") !== "true") {
+ cy.wrap($group).click();
+ }
+ },
+ );
+ cy.findByRole("treeitem", {
+ // Anchor on end so we don't match e.g. "Hour of day".
+ name: new RegExp(`${temporalDimension!.display_name}$`),
+ }).click();
+ });
+
+ H.ensureEchartsContainerHasSvg();
+ H.applyBrush(120, 280);
+
+ cy.findByTestId("click-actions-view").within(() => {
+ cy.findByRole("button", { name: /Explore further/i }).should(
+ "be.visible",
+ );
+ cy.findByRole("button", { name: /Add comment/i }).should("not.exist");
+ });
+
+ cy.findByTestId("click-actions-view")
+ .findByRole("button", { name: /Explore further/i })
+ .click();
+
+ cy.wait("@exploreFurther").then(({ request, response }) => {
+ expect(request.body.explore_filters)
+ .to.be.an("array")
+ .and.have.length(1);
+ expect(request.body.explore_filters[0]).to.include.keys(
+ "operator",
+ "field_ref",
+ "values",
+ "display_value",
+ );
+ expect(request.body.explore_filters[0].operator).to.eq("between");
+ expect(request.body.explore_filters[0].values)
+ .to.be.an("array")
+ .and.have.length(2);
+
+ // Cypress does not type intercept response bodies.
+ const threads = (response?.body as Exploration).threads ?? [];
+ const newThread = threads.find(
+ (thread) => !initialThreadIds.includes(thread.id),
+ );
+ expect(newThread, "explore-further adds a new thread").to.exist;
+ cy.wrap(newThread!.name).as("newThreadName");
+ });
+
+ cy.get<string>("@newThreadName").then((name) => {
+ openExploreFurtherToast(name);
+ });
+
+ cy.location("pathname").should(
+ "include",
+ `/question/research/${explorationId}/page/`,
+ );
+
+ // Temporal ranges use an en-dash (e.g. "Feb 2020 – Mar 2020"); exact
+ // bounds depend on brush pixel coords, so just assert range formatting.
+ cy.findByTestId("filter-pill")
+ .should("be.visible")
+ .invoke("text")
+ .should("match", /–/);
+ });
+ });
+ });
});
describe("scenarios > explorations > collection placement + archive", () => {
diff --git a/frontend/src/metabase-lib/query/types.ts b/frontend/src/metabase-lib/query/types.ts
index 4bc4dff34d3..32df24dcdb6 100644
--- a/frontend/src/metabase-lib/query/types.ts
+++ b/frontend/src/metabase-lib/query/types.ts
@@ -589,6 +589,18 @@ export interface ClickObjectDataRow {
value: RowValue;
}
+export type BrushRange =
+ | {
+ type: "temporal";
+ start: string;
+ end: string;
+ }
+ | {
+ type: "numeric";
+ start: number;
+ end: number;
+ };
+
export interface ClickObject {
value?: RowValue;
column?: DatasetColumn;
@@ -606,8 +618,23 @@ export interface ClickObject {
};
extraData?: Record<string, unknown>;
data?: ClickObjectDataRow[];
+ brushRange?: BrushRange;
}
+export interface BrushClickObject extends ClickObject {
+ brushRange: BrushRange;
+ column: DatasetColumn;
+ event: MouseEvent;
+}
+
+export const isBrushClickObject = (
+ clicked: ClickObject | null | undefined,
+): clicked is BrushClickObject =>
+ clicked != null &&
+ clicked.brushRange != null &&
+ clicked.column != null &&
+ clicked.event != null;
+
export interface FieldValuesSearchInfo {
fieldId: FieldId | null;
searchField: ColumnMetadata | null;
diff --git a/frontend/src/metabase-lib/v1/queries/drills/types.ts b/frontend/src/metabase-lib/v1/queries/drills/types.ts
index 9309d8a4bfa..d2573812182 100644
--- a/frontend/src/metabase-lib/v1/queries/drills/types.ts
+++ b/frontend/src/metabase-lib/v1/queries/drills/types.ts
@@ -3,11 +3,15 @@ import type Question from "metabase-lib/v1/Question";
import type { VisualizationSettings } from "metabase-types/api";
export type {
+ BrushClickObject,
+ BrushRange,
ClickObject,
ClickObjectDataRow,
ClickObjectDimension,
} from "metabase-lib";
+export { isBrushClickObject } from "metabase-lib";
+
export type ClickActionProps = {
question: Question;
clicked?: ClickObject;
diff --git a/frontend/src/metabase-types/api/exploration.ts b/frontend/src/metabase-types/api/exploration.ts
index fd91239f569..3ce36045b16 100644
--- a/frontend/src/metabase-types/api/exploration.ts
+++ b/frontend/src/metabase-types/api/exploration.ts
@@ -130,12 +130,25 @@ export interface CreateExplorationRequest {
}[];
}
-export type ExplorationExploreFilter = {
+type BaseExplorationExploreFilter = {
field_ref: DimensionReference;
- value: RowValue;
display_value: string;
};
+export type ExplorationExploreEqualityFilter = BaseExplorationExploreFilter & {
+ operator: "=";
+ value: RowValue;
+};
+
+export type ExplorationExploreBetweenFilter = BaseExplorationExploreFilter & {
+ operator: "between";
+ values: [string, string] | [number, number];
+};
+
+export type ExplorationExploreFilter =
+ | ExplorationExploreEqualityFilter
+ | ExplorationExploreBetweenFilter;
+
export type HydratedExplorationExploreFilter = ExplorationExploreFilter & {
dimension_name?: string | null;
};
diff --git a/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationGroupVisualization.tsx b/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationGroupVisualization.tsx
index d09441c5180..451989fd45c 100644
--- a/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationGroupVisualization.tsx
+++ b/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationGroupVisualization.tsx
@@ -28,6 +28,7 @@ import { getComputedSettingsForSeries } from "metabase/visualizations/lib/settin
import type {
ClickActionsMode,
HighlightedObject,
+ OnBrush,
} from "metabase/visualizations/types";
import type {
Comment,
@@ -483,6 +484,13 @@ function ExplorationCartesianChart({
selectedTimelineEventIds,
onSeeAllEvents,
}: ExplorationCartesianChartProps) {
+ const handleBrush = useCallback<OnBrush>(
+ ({ clickObject, openClickActions }) => {
+ openClickActions(clickObject);
+ },
+ [],
+ );
+
return (
<ExplorationVisualization
rawSeries={series}
@@ -492,6 +500,7 @@ function ExplorationCartesianChart({
highlighted={highlighted}
selectedTimelineEventIds={selectedTimelineEventIds}
onSeeAllEvents={onSeeAllEvents}
+ onBrush={handleBrush}
/>
);
}
@@ -593,6 +602,7 @@ interface ExplorationVisualizationProps {
highlighted?: HighlightedObject | null;
selectedTimelineEventIds?: TimelineEventId[];
onSeeAllEvents?: (events: TimelineEvent[]) => void;
+ onBrush?: OnBrush;
}
export function ExplorationVisualization({
@@ -603,6 +613,7 @@ export function ExplorationVisualization({
highlighted,
selectedTimelineEventIds,
onSeeAllEvents,
+ onBrush,
}: ExplorationVisualizationProps) {
const [warnings, setWarnings] = useState<string[]>([]);
@@ -619,6 +630,7 @@ export function ExplorationVisualization({
highlighted={highlighted}
selectedTimelineEventIds={selectedTimelineEventIds}
onSeeAllEvents={onSeeAllEvents}
+ onBrush={onBrush}
/>
</Box>
);
diff --git a/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationGroupVisualization.unit.spec.tsx b/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationGroupVisualization.unit.spec.tsx
index 4b54cd0384a..3316e1fd2bb 100644
--- a/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationGroupVisualization.unit.spec.tsx
+++ b/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationGroupVisualization.unit.spec.tsx
@@ -458,6 +458,7 @@ describe("ExplorationGroupVisualization", () => {
datasets: new Map([[101, makeTimeseriesDataset()]]),
exploreFilters: [
{
+ operator: "=",
field_ref: ["field", 1, null],
value: "TX",
display_value: "TX",
@@ -822,13 +823,14 @@ describe("ExplorationGroupVisualization", () => {
datasets: new Map([[101, makeTimeseriesDataset()]]),
};
- it("passes mode, highlighted, and onChangeCardAndRun to Visualization", () => {
+ it("passes mode, highlighted, onBrush, and onChangeCardAndRun to Visualization", () => {
setup(timeseriesSetup);
const stub = screen.getByTestId("visualization-stub");
expect(stub).toHaveAttribute("data-has-on-change-card-and-run", "true");
expect(lastVisualizationProps?.mode).toBeDefined();
expect(lastVisualizationProps?.highlighted).toBeNull();
+ expect(typeof lastVisualizationProps?.onBrush).toBe("function");
});
it("includes explore further for eligible metric blocks", () => {
diff --git a/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationVisualizationHeader.tsx b/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationVisualizationHeader.tsx
index 2ab2f60012b..d6247ebd391 100644
--- a/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationVisualizationHeader.tsx
+++ b/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationVisualizationHeader.tsx
@@ -5,7 +5,6 @@ import { ToolbarButton } from "metabase/common/components/ToolbarButton";
import { FilterPill } from "metabase/querying/filters/components/FilterPanel/FilterPill";
import { type Path, useLocation, useNavigate } from "metabase/router";
import { Ellipsified, Group, Indicator, Stack } from "metabase/ui";
-import { NULL_DISPLAY_VALUE } from "metabase/utils/constants";
import type {
ExplorationId,
ExplorationPageNodeId,
@@ -96,13 +95,10 @@ export function ExplorationVisualizationHeader({
function getExploreFilterPillLabel(
filter: HydratedExplorationExploreFilter,
): string {
- const value =
- filter.display_value ??
- (filter.value == null ? NULL_DISPLAY_VALUE : String(filter.value));
if (filter.dimension_name) {
- return `${filter.dimension_name}: ${value}`;
+ return `${filter.dimension_name}: ${filter.display_value}`;
}
- return value;
+ return filter.display_value;
}
function getNextCommentsUrl(location: Pick<Path, "pathname" | "search">) {
diff --git a/frontend/src/metabase/explorations/components/ExplorationVisualization/utils.ts b/frontend/src/metabase/explorations/components/ExplorationVisualization/utils.ts
index 9c390b67a7a..f13cb1b4878 100644
--- a/frontend/src/metabase/explorations/components/ExplorationVisualization/utils.ts
+++ b/frontend/src/metabase/explorations/components/ExplorationVisualization/utils.ts
@@ -1,3 +1,4 @@
+import dayjs from "dayjs";
import { t } from "ttag";
import { createSeriesCard } from "metabase/common/utils/series";
@@ -8,16 +9,21 @@ import { NULL_DISPLAY_VALUE } from "metabase/utils/constants";
import { isCartesianChart } from "metabase/visualizations";
import { getSeriesVizSettingsKey } from "metabase/visualizations/echarts/cartesian/model/series";
import { formatValue } from "metabase/visualizations/lib/formatting";
+import { formatDateTimeRangeWithUnit } from "metabase/visualizations/lib/formatting/date";
import type {
+ BrushClickObject,
+ BrushRange,
ClickObject,
ComputedVisualizationSettings,
HighlightedObject,
} from "metabase/visualizations/types";
+import { isBrushClickObject } from "metabase/visualizations/types";
import { getColorplethColorScale } from "metabase/visualizations/visualizations/Map/map-color-scale";
import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
import {
isCountry,
isDate,
+ isDateWithoutTime,
isNumeric,
isState,
} from "metabase-lib/v1/types/utils/isa";
@@ -26,6 +32,7 @@ import type {
ColumnSettings,
Dataset,
DatasetColumn,
+ DateTimeAbsoluteUnit,
ExplorationBlockNodeType,
ExplorationExploreFilter,
ExplorationQuery,
@@ -37,6 +44,7 @@ import type {
VisualizationDisplay,
VisualizationSettings,
} from "metabase-types/api";
+import { isAbsoluteDateTimeUnit } from "metabase-types/guards/date-time";
const SHOULD_STACK_CUTOFF = 8;
const MIN_SEGMENTS_TO_SHOW_HEATMAP = 4;
@@ -438,13 +446,146 @@ export function formatColumnValue(
return String(formatValue(value ?? NULL_DISPLAY_VALUE, settings));
}
+function getClickedColumnSettings(
+ clicked: ClickObject,
+ column: DatasetColumn,
+): ColumnSettings {
+ // Brush clicks stash ComputedVisualizationSettings on ClickObject.settings
+ // (typed as a loose record on the shared ClickObject shape).
+ const settings = clicked.settings as
+ | ComputedVisualizationSettings
+ | undefined;
+ return settings?.column?.(column) ?? { column };
+}
+
+/** Same clamp as Lib.updateTemporalFilter: keep only unit buckets whose dots fall inside the brush. */
+function clampTemporalBrushRange(
+ start: string,
+ end: string,
+ unit: DateTimeAbsoluteUnit,
+ column: DatasetColumn,
+): { start: string; end: string } | null {
+ const dateFormat = isDateWithoutTime(column)
+ ? "YYYY-MM-DD"
+ : "YYYY-MM-DDTHH:mm:ss";
+ const clampedStart = dayjs(start)
+ .add(1, unit)
+ .startOf(unit)
+ .format(dateFormat);
+ const clampedEnd = dayjs(end).startOf(unit).format(dateFormat);
+ if (dayjs(clampedStart).isAfter(dayjs(clampedEnd))) {
+ return null;
+ }
+ return { start: clampedStart, end: clampedEnd };
+}
+
+function formatBrushRangeDisplayValue(
+ brushRange: BrushRange,
+ column: DatasetColumn,
+ columnSettings: ColumnSettings,
+): string {
+ if (
+ brushRange.type === "temporal" &&
+ column.unit != null &&
+ isAbsoluteDateTimeUnit(column.unit)
+ ) {
+ return String(
+ formatDateTimeRangeWithUnit(
+ [brushRange.start, brushRange.end],
+ column.unit,
+ columnSettings,
+ ),
+ );
+ }
+
+ return `${formatColumnValue(brushRange.start, column, columnSettings)} - ${formatColumnValue(brushRange.end, column, columnSettings)}`;
+}
+
+function getBrushExploreFurtherFilters(
+ clicked: BrushClickObject,
+): ExplorationExploreFilter[] {
+ const { column, brushRange } = clicked;
+ if (column.field_ref == null) {
+ return [];
+ }
+
+ const columnSettings = getClickedColumnSettings(clicked, column);
+
+ if (brushRange.type === "temporal") {
+ const clamped =
+ column.unit != null && isAbsoluteDateTimeUnit(column.unit)
+ ? clampTemporalBrushRange(
+ brushRange.start,
+ brushRange.end,
+ column.unit,
+ column,
+ )
+ : { start: brushRange.start, end: brushRange.end };
+ if (clamped == null) {
+ return [];
+ }
+
+ const clampedRange: BrushRange = {
+ type: "temporal",
+ start: clamped.start,
+ end: clamped.end,
+ };
+
+ if (clamped.start === clamped.end) {
+ return [
+ {
+ operator: "=",
+ field_ref: column.field_ref,
+ value: clamped.start,
+ display_value: formatColumnValue(
+ clamped.start,
+ column,
+ columnSettings,
+ ),
+ },
+ ];
+ }
+
+ return [
+ {
+ operator: "between",
+ field_ref: column.field_ref,
+ values: [clamped.start, clamped.end],
+ display_value: formatBrushRangeDisplayValue(
+ clampedRange,
+ column,
+ columnSettings,
+ ),
+ },
+ ];
+ }
+
+ return [
+ {
+ operator: "between",
+ field_ref: column.field_ref,
+ values: [brushRange.start, brushRange.end],
+ display_value: formatBrushRangeDisplayValue(
+ brushRange,
+ column,
+ columnSettings,
+ ),
+ },
+ ];
+}
+
export function getExploreFurtherFilters(
clicked: ClickObject,
): ExplorationExploreFilter[] {
+ if (isBrushClickObject(clicked)) {
+ return getBrushExploreFurtherFilters(clicked);
+ }
+
return (clicked.dimensions ?? []).flatMap(({ column, value }) =>
column.field_ref != null
? [
{
+ operator: "=" as const,
field_ref: column.field_ref,
value,
display_value: formatColumnValue(value, column),
@@ -459,15 +600,20 @@ export function canExploreFurther(
blockType: ExplorationBlockNodeType,
queryType: ExplorationQueryType,
): boolean {
- const dimensions = clicked.dimensions ?? [];
- if (dimensions.length === 0) {
- return false;
- }
// disable for dimension blocks - every query in a dimension block is cut by the same dimension
// so filtering on a single dimension value doesn't provide a new view of the data
if (blockType === "dimension") {
return false;
}
+
+ if (isBrushClickObject(clicked)) {
+ return getExploreFurtherFilters(clicked).length > 0;
+ }
+
+ const dimensions = clicked.dimensions ?? [];
+ if (dimensions.length === 0) {
+ return false;
+ }
// OTHER_BUCKET_LABEL is not a real dimension value, so filtering on it won't return anything
if (
queryType === "top-n-other" &&
diff --git a/frontend/src/metabase/explorations/components/ExplorationVisualization/utils.unit.spec.ts b/frontend/src/metabase/explorations/components/ExplorationVisualization/utils.unit.spec.ts
index 209162a35eb..b28b73df98a 100644
--- a/frontend/src/metabase/explorations/components/ExplorationVisualization/utils.unit.spec.ts
+++ b/frontend/src/metabase/explorations/components/ExplorationVisualization/utils.unit.spec.ts
@@ -17,6 +17,7 @@ import {
createMockColumn,
createMockDataset,
createMockDatasetData,
+ createMockDatetimeColumn,
} from "metabase-types/api/mocks";
import {
@@ -231,6 +232,50 @@ describe("canExploreFurther", () => {
),
).toBe(true);
});
+
+ it("returns true for brush clicks with a field_ref on metric blocks", () => {
+ expect(
+ canExploreFurther(
+ {
+ brushRange: {
+ type: "temporal",
+ start: "2020-01-01T00:00:00",
+ end: "2020-03-01T00:00:00",
+ },
+ column: createMockDatetimeColumn({
+ name: "CREATED_AT",
+ field_ref: ["field", 20, null],
+ }),
+ event: new MouseEvent("click"),
+ settings: {},
+ },
+ "metric",
+ "default",
+ ),
+ ).toBe(true);
+ });
+
+ it("returns false for brush clicks on dimension blocks", () => {
+ expect(
+ canExploreFurther(
+ {
+ brushRange: {
+ type: "numeric",
+ start: 1,
+ end: 4,
+ },
+ column: createMockColumn({
+ name: "PRICE",
+ field_ref: ["field", 21, null],
+ }),
+ event: new MouseEvent("click"),
+ settings: {},
+ },
+ "dimension",
+ "default",
+ ),
+ ).toBe(false);
+ });
});
describe("getExploreFurtherFilters", () => {
@@ -258,11 +303,13 @@ describe("getExploreFurtherFilters", () => {
expect(getExploreFurtherFilters(clicked)).toEqual([
{
+ operator: "=",
field_ref: ["field", 10, null],
value: "Gadget",
display_value: "Gadget",
},
{
+ operator: "=",
field_ref: ["field", 11, null],
value: "Affiliate",
display_value: "Affiliate",
@@ -286,12 +333,128 @@ describe("getExploreFurtherFilters", () => {
expect(getExploreFurtherFilters(clicked)).toEqual([
{
+ operator: "=",
field_ref: ["field", 10, null],
value: null,
display_value: NULL_DISPLAY_VALUE,
},
]);
});
+
+ it("clamps a temporal brush range to the dots inside the brush", () => {
+ const column = createMockDatetimeColumn({
+ name: "CREATED_AT",
+ source: "breakout",
+ unit: "month",
+ field_ref: ["field", 20, { "temporal-unit": "month" }],
+ });
+ // Brush from mid-Jan to mid-Mar: Jan's dot (Jan 1) is outside, so the
+ // filter clamps to Feb 1 – Mar 1 (same as Lib.updateTemporalFilter).
+ const clicked: ClickObject = {
+ brushRange: {
+ type: "temporal",
+ start: "2020-01-15T14:30:00",
+ end: "2020-03-10T09:05:00",
+ },
+ column,
+ event: new MouseEvent("click"),
+ settings: {
+ column: () => ({ column, date_abbreviate: true }),
+ },
+ };
+
+ expect(getExploreFurtherFilters(clicked)).toEqual([
+ {
+ operator: "between",
+ field_ref: ["field", 20, { "temporal-unit": "month" }],
+ values: ["2020-02-01T00:00:00", "2020-03-01T00:00:00"],
+ display_value: "Feb 2020 – Mar 2020",
+ },
+ ]);
+ });
+
+ it("returns an equality filter when a temporal brush covers a single dot", () => {
+ const column = createMockDatetimeColumn({
+ name: "CREATED_AT",
+ source: "breakout",
+ unit: "month",
+ field_ref: ["field", 20, { "temporal-unit": "month" }],
+ });
+ const clicked: ClickObject = {
+ brushRange: {
+ type: "temporal",
+ // After clamp: start = Feb 1, end = Feb 1
+ start: "2020-01-15T14:30:00",
+ end: "2020-02-20T09:05:00",
+ },
+ column,
+ event: new MouseEvent("click"),
+ settings: {
+ column: () => ({ column, date_abbreviate: true }),
+ },
+ };
+
+ expect(getExploreFurtherFilters(clicked)).toEqual([
+ {
+ operator: "=",
+ field_ref: ["field", 20, { "temporal-unit": "month" }],
+ value: "2020-02-01T00:00:00",
+ display_value: "Feb 2020",
+ },
+ ]);
+ });
+
+ it("returns no filters when a temporal brush covers no dots", () => {
+ const column = createMockDatetimeColumn({
+ name: "CREATED_AT",
+ source: "breakout",
+ unit: "month",
+ field_ref: ["field", 20, { "temporal-unit": "month" }],
+ });
+ const clicked: ClickObject = {
+ brushRange: {
+ type: "temporal",
+ // Entirely within January after the Jan 1 dot
+ start: "2020-01-15T14:30:00",
+ end: "2020-01-20T09:05:00",
+ },
+ column,
+ event: new MouseEvent("click"),
+ settings: {},
+ };
+
+ expect(getExploreFurtherFilters(clicked)).toEqual([]);
+ expect(canExploreFurther(clicked, "metric", "default")).toBe(false);
+ });
+
+ it("projects a numeric brush range into a between explore filter", () => {
+ const column = createMockColumn({
+ name: "PRICE",
+ source: "breakout",
+ base_type: "type/Integer",
+ effective_type: "type/Integer",
+ field_ref: ["field", 21, null],
+ });
+ const clicked: ClickObject = {
+ brushRange: {
+ type: "numeric",
+ start: 1,
+ end: 4,
+ },
+ column,
+ event: new MouseEvent("click"),
+ settings: {},
+ };
+
+ expect(getExploreFurtherFilters(clicked)).toEqual([
+ {
+ operator: "between",
+ field_ref: ["field", 21, null],
+ values: [1, 4],
+ display_value: "1 - 4",
+ },
+ ]);
+ });
});
describe("getCommentLabel", () => {
diff --git a/frontend/src/metabase/explorations/hooks/useExplorationClickActionsMode.tsx b/frontend/src/metabase/explorations/hooks/useExplorationClickActionsMode.tsx
index 22f537d4abc..b2a37781f23 100644
--- a/frontend/src/metabase/explorations/hooks/useExplorationClickActionsMode.tsx
+++ b/frontend/src/metabase/explorations/hooks/useExplorationClickActionsMode.tsx
@@ -15,6 +15,7 @@ import type {
ClickObject,
HighlightedObject,
} from "metabase/visualizations/types";
+import { isBrushClickObject } from "metabase/visualizations/types";
import type {
DocumentContent,
ExplorationBlockNodeType,
@@ -96,60 +97,62 @@ export function useExplorationClickActionsMode({
});
}
- const handleAddComment = async (
- content: DocumentContent,
- onClose: () => void,
- ) => {
- const highlighted: HighlightedObject = {
- cardId: clicked.cardId,
- columnName: clicked.column?.name,
- dimensions: clicked.dimensions?.map((d) => ({
- value: d.value,
- columnName: d.column.name,
- })),
- };
- const { error } = await createComment({
- target_id: explorationId,
- target_type: "exploration",
- child_target_id: String(pageId),
- parent_comment_id: null,
- content,
- context: {
- highlighted,
- },
- });
- if (error) {
- sendToast({
- icon: "warning_triangle_filled",
- iconColor: "warning",
- message: t`Failed to add comment`,
+ if (!isBrushClickObject(clicked)) {
+ const handleAddComment = async (
+ content: DocumentContent,
+ onClose: () => void,
+ ) => {
+ const highlighted: HighlightedObject = {
+ cardId: clicked.cardId,
+ columnName: clicked.column?.name,
+ dimensions: clicked.dimensions?.map((d) => ({
+ value: d.value,
+ columnName: d.column.name,
+ })),
+ };
+ const { error } = await createComment({
+ target_id: explorationId,
+ target_type: "exploration",
+ child_target_id: String(pageId),
+ parent_comment_id: null,
+ content,
+ context: {
+ highlighted,
+ },
});
- } else {
- trackExplorationCommentCreated(explorationId, "chart_click");
- onClose();
- }
- };
+ if (error) {
+ sendToast({
+ icon: "warning_triangle_filled",
+ iconColor: "warning",
+ message: t`Failed to add comment`,
+ });
+ } else {
+ trackExplorationCommentCreated(explorationId, "chart_click");
+ onClose();
+ }
+ };
- const CommentEditor = ({ onClose }: ClickActionPopoverProps) => {
- return (
- <ExplorationCommentEditor
- commentDrafts={commentDraftsRef.current}
- setCommentDrafts={setCommentDrafts}
- pageId={String(pageId)}
- onAddComment={(content) => handleAddComment(content, onClose)}
- placeholder={t`Comment on this…`}
- />
- );
- };
+ const CommentEditor = ({ onClose }: ClickActionPopoverProps) => {
+ return (
+ <ExplorationCommentEditor
+ commentDrafts={commentDraftsRef.current}
+ setCommentDrafts={setCommentDrafts}
+ pageId={String(pageId)}
+ onAddComment={(content) => handleAddComment(content, onClose)}
+ placeholder={t`Comment on this…`}
+ />
+ );
+ };
- actions.push({
- name: "add-comment",
- section: "custom",
- title: t`Add comment`,
- buttonType: "horizontal",
- icon: "add_comment",
- popover: CommentEditor,
- });
+ actions.push({
+ name: "add-comment",
+ section: "custom",
+ title: t`Add comment`,
+ buttonType: "horizontal",
+ icon: "add_comment",
+ popover: CommentEditor,
+ });
+ }
return actions;
},
diff --git a/frontend/src/metabase/explorations/hooks/useExplorationClickActionsMode.unit.spec.tsx b/frontend/src/metabase/explorations/hooks/useExplorationClickActionsMode.unit.spec.tsx
index f6e212f4557..888f7692e70 100644
--- a/frontend/src/metabase/explorations/hooks/useExplorationClickActionsMode.unit.spec.tsx
+++ b/frontend/src/metabase/explorations/hooks/useExplorationClickActionsMode.unit.spec.tsx
@@ -168,6 +168,7 @@ describe("useExplorationClickActionsMode", () => {
page_id: 7,
explore_filters: [
{
+ operator: "=",
field_ref: ["field", 1, null],
value: "Gadget",
display_value: "Gadget",
@@ -181,6 +182,26 @@ describe("useExplorationClickActionsMode", () => {
);
});
+ it("shows only explore further for brush click objects", () => {
+ const { result } = renderMode();
+ const actions = result.current.actionsForClick({
+ brushRange: {
+ type: "temporal",
+ start: "2020-01-01T00:00:00",
+ end: "2020-03-01T00:00:00",
+ },
+ column: createMockColumn({
+ name: "CREATED_AT",
+ source: "breakout",
+ field_ref: ["field", 20, { "temporal-unit": "month" }],
+ }),
+ event: new MouseEvent("click"),
+ settings: {},
+ });
+
+ expect(actions.map((action) => action.name)).toEqual(["explore-further"]);
+ });
+
it("shows an error toast when explore further fails", async () => {
exploreFurtherMock.mockResolvedValue({ error: { status: 500 } });
const { result } = renderMode();
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricsViewerDimensionBreakoutContent/MetricsViewerDimensionBreakoutContent.tsx b/frontend/src/metabase/metrics-viewer/components/MetricsViewerDimensionBreakoutContent/MetricsViewerDimensionBreakoutContent.tsx
index 5c52cac48d5..943c3483fe9 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricsViewerDimensionBreakoutContent/MetricsViewerDimensionBreakoutContent.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricsViewerDimensionBreakoutContent/MetricsViewerDimensionBreakoutContent.tsx
@@ -1,3 +1,4 @@
+import dayjs from "dayjs";
import { useCallback, useMemo } from "react";
import {
@@ -16,8 +17,10 @@ import {
import type { MetricSlot } from "metabase/metrics-viewer/utils/metric-slots";
import { Box, Flex, Stack } from "metabase/ui";
import { getObjectKeys } from "metabase/utils/objects";
+import type { OnBrush } from "metabase/visualizations/types";
import type { DimensionMetadata, MetricDefinition } from "metabase-lib/metric";
import * as LibMetric from "metabase-lib/metric";
+import { isDateWithoutTime } from "metabase-lib/v1/types/utils/isa";
export function MetricsViewerDimensionBreakoutContent() {
const {
@@ -103,8 +106,13 @@ export function MetricsViewerDimensionBreakoutContent() {
[dimensionItems, metricSlots],
);
- const handleBrush = useCallback(
- ({ start, end }: { start: number; end: number }) => {
+ const handleBrush = useCallback<OnBrush>(
+ ({ clickObject }) => {
+ const { brushRange, column } = clickObject;
+ if (brushRange.type !== "temporal") {
+ return;
+ }
+
updateActiveDimensionBreakout((prev) => ({
...prev,
projectionConfig: {
@@ -112,8 +120,11 @@ export function MetricsViewerDimensionBreakoutContent() {
dimensionFilter: {
type: "specific-date",
operator: "between",
- values: [new Date(start), new Date(end)],
- hasTime: true,
+ values: [
+ dayjs(brushRange.start).toDate(),
+ dayjs(brushRange.end).toDate(),
+ ],
+ hasTime: !isDateWithoutTime(column),
},
},
}));
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricsViewerVisualization/MetricsViewerVisualization.tsx b/frontend/src/metabase/metrics-viewer/components/MetricsViewerVisualization/MetricsViewerVisualization.tsx
index 085d8b6f662..4a9c44b3e71 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricsViewerVisualization/MetricsViewerVisualization.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricsViewerVisualization/MetricsViewerVisualization.tsx
@@ -15,6 +15,7 @@ import { MetricsViewerClickActionsMode } from "metabase/metrics-viewer/utils/Met
import { getGridColumns } from "metabase/metrics-viewer/utils/grid-columns";
import { Center, Flex, SimpleGrid, Stack, useElementSize } from "metabase/ui";
import Visualization from "metabase/visualizations/components/Visualization";
+import type { OnBrush } from "metabase/visualizations/types";
import { datasetContainsNoResults } from "metabase-lib/v1/queries/utils/dataset";
import type { CardId } from "metabase-types/api";
@@ -23,7 +24,7 @@ import { useMetricsViewerContext } from "../../context";
import S from "./MetricsViewerVisualization.module.css";
type MetricsViewerVisualizationProps = {
- onBrush?: (range: { start: number; end: number }) => void;
+ onBrush?: OnBrush;
chartColumnLabelsByEntityIndex?: Map<number, DimensionPillBarItem>;
};
diff --git a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
index 3529730bb23..2999a0ede55 100644
--- a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
+++ b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
@@ -55,6 +55,7 @@ import {
type ClickObject,
type HighlightedObject,
type HoveredObject,
+ type OnBrush,
type QueryClickActionsMode,
type VisualizationDefinition,
type VisualizationGridSize,
@@ -177,7 +178,7 @@ type VisualizationOwnProps = {
showSidebarTitle?: boolean;
}) => void;
onChangeCardAndRun?: ((opts: OnChangeCardAndRunOpts) => void) | null;
- onBrush?: ((range: { start: number; end: number }) => void) | null;
+ onBrush?: OnBrush | null;
onHeaderColumnReorder?: (columnIndex: number) => void;
onChangeLocation?: (location: Location) => void;
onUpdateQuestion?: (question: Question) => void;
diff --git a/frontend/src/metabase/visualizations/types/click-actions.ts b/frontend/src/metabase/visualizations/types/click-actions.ts
index 206b5dd23ca..b1888a3d9ba 100644
--- a/frontend/src/metabase/visualizations/types/click-actions.ts
+++ b/frontend/src/metabase/visualizations/types/click-actions.ts
@@ -19,10 +19,14 @@ export type ClickActionModeGetter = (data: {
}) => QueryClickActionsMode | ClickActionsMode;
export type {
+ BrushClickObject,
+ BrushRange,
ClickActionProps,
ClickObject,
} from "metabase-lib/v1/queries/drills/types";
+export { isBrushClickObject } from "metabase-lib/v1/queries/drills/types";
+
type Dispatcher = (dispatch: Dispatch, getState: GetState) => void;
export type ClickActionButtonType =
diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.ts
index 96deba637f9..5687bc306a2 100644
--- a/frontend/src/metabase/visualizations/types/visualization.ts
+++ b/frontend/src/metabase/visualizations/types/visualization.ts
@@ -18,6 +18,7 @@ import type {
QueryClickActionsMode,
} from "metabase/visualizations/types";
import type * as Lib from "metabase-lib";
+import type { BrushClickObject } from "metabase-lib/query/types";
import type Question from "metabase-lib/v1/Question";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type {
@@ -120,6 +121,11 @@ export type OnChangeCardAndRunOpts = {
export type OnChangeCardAndRun = (opts: OnChangeCardAndRunOpts) => void;
+export type OnBrush = (options: {
+ clickObject: BrushClickObject;
+ openClickActions: (clicked: ClickObject | null) => void;
+}) => void;
+
export type ComputedVisualizationSettings = VisualizationSettings & {
column?: (col: RemappingHydratedDatasetColumn) => ColumnSettings;
series?: (key: LegacySeriesSettingsObjectKey) => SeriesSettings;
@@ -198,7 +204,7 @@ export interface VisualizationProps {
onRenderError: (error?: string) => void;
onActionDismissal: () => void;
onChangeCardAndRun?: OnChangeCardAndRun | null;
- onBrush?: ((range: { start: number; end: number }) => void) | null;
+ onBrush?: OnBrush | null;
onHoverChange: (hoverObject?: HoveredObject | null) => void;
onVisualizationClick: (clickObject: ClickObject | null) => void;
onUpdateVisualizationSettings: (
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts
index d47d39379a7..9e351790078 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts
@@ -29,6 +29,7 @@ import {
} from "metabase/visualizations/echarts/cartesian/constants/dataset";
import {
isBreakoutSeries,
+ isNumericAxis,
isQuarterInterval,
isTimeSeriesAxis,
} from "metabase/visualizations/echarts/cartesian/model/guards";
@@ -45,9 +46,10 @@ import type {
StackModel,
} from "metabase/visualizations/echarts/cartesian/model/types";
import { getMarkerColorClass } from "metabase/visualizations/echarts/tooltip";
-import type {
- EChartsSeriesBrushEndEvent,
- EChartsSeriesMouseEvent,
+import {
+ type EChartsSeriesBrushEndEvent,
+ type EChartsSeriesMouseEvent,
+ isLineXBrushRange,
} from "metabase/visualizations/echarts/types";
import { computeChange } from "metabase/visualizations/lib/numeric";
import {
@@ -58,14 +60,20 @@ import { dimensionIsTimeseries } from "metabase/visualizations/lib/timeseries";
import type {
ComputedVisualizationSettings,
DataPoint,
+ OnBrush,
OnChangeCardAndRun,
} from "metabase/visualizations/types";
-import type { ClickObject, ClickObjectDimension } from "metabase-lib";
+import type {
+ BrushClickObject,
+ BrushRange,
+ ClickObject,
+ ClickObjectDimension,
+} from "metabase-lib";
import * as Lib from "metabase-lib";
import Question from "metabase-lib/v1/Question";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
-import { isDate } from "metabase-lib/v1/types/utils/isa";
+import { isDate, isDateWithoutTime } from "metabase-lib/v1/types/utils/isa";
import type {
CardDisplayType,
CardId,
@@ -310,7 +318,7 @@ export const canBrush = (
settings: ComputedVisualizationSettings,
dimensionColumn: DatasetColumn | undefined,
onChangeCardAndRun?: OnChangeCardAndRun | null,
- onBrush?: ((range: { start: number; end: number }) => void) | null,
+ onBrush?: OnBrush | null,
) => {
const hasBrushableDimension =
settings["graph.x_axis.scale"] != null &&
@@ -941,6 +949,63 @@ export const getSeriesClickData = (
};
};
+export const getBrushClickObject = (
+ chartModel: BaseCartesianChartModel,
+ event: EChartsSeriesBrushEndEvent,
+ chartElement: HTMLElement,
+ settings: ComputedVisualizationSettings,
+): BrushClickObject | null => {
+ const area = event.areas[0];
+ const coordRange = area?.coordRange;
+ const pixelRange = area?.range;
+ if (
+ !isLineXBrushRange(coordRange) ||
+ !isLineXBrushRange(pixelRange) ||
+ coordRange.length < 2 ||
+ pixelRange.length < 2
+ ) {
+ return null;
+ }
+
+ const [rawStart, rawEnd] = [
+ Number(coordRange[0]),
+ Number(coordRange[1]),
+ ].sort((a, b) => a - b);
+ const { xAxisModel, dimensionModel } = chartModel;
+ const column = dimensionModel.column;
+
+ let brushRange: BrushRange;
+ if (isTimeSeriesAxis(xAxisModel)) {
+ const dateFormat = isDateWithoutTime(column)
+ ? "YYYY-MM-DD"
+ : "YYYY-MM-DDTHH:mm:ss";
+ brushRange = {
+ type: "temporal",
+ start: xAxisModel.fromEChartsAxisValue(rawStart).format(dateFormat),
+ end: xAxisModel.fromEChartsAxisValue(rawEnd).format(dateFormat),
+ };
+ } else if (isNumericAxis(xAxisModel)) {
+ brushRange = {
+ type: "numeric",
+ start: xAxisModel.fromEChartsAxisValue(rawStart),
+ end: xAxisModel.fromEChartsAxisValue(rawEnd),
+ };
+ } else {
+ return null;
+ }
+
+ const chartBounds = chartElement.getBoundingClientRect();
+ const clientX = chartBounds.left + Math.max(pixelRange[0], pixelRange[1]);
+ const clientY = chartBounds.top + chartBounds.height / 2;
+
+ return {
+ brushRange,
+ column,
+ event: new MouseEvent("click", { clientX, clientY }),
+ settings,
+ };
+};
+
export const getBrushData = (
rawSeries: RawSeries,
metadata: Metadata | undefined,
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.unit.spec.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.unit.spec.ts
index 9a0bdec10f1..9da2c1ad36c 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.unit.spec.ts
@@ -1,3 +1,5 @@
+import dayjs from "dayjs";
+
import {
createMockBreakoutSeriesModel,
createMockCartesianChartModel,
@@ -12,7 +14,10 @@ import type {
Datum,
DimensionModel,
} from "metabase/visualizations/echarts/cartesian/model/types";
-import type { EChartsSeriesMouseEvent } from "metabase/visualizations/echarts/types";
+import type {
+ EChartsSeriesBrushEndEvent,
+ EChartsSeriesMouseEvent,
+} from "metabase/visualizations/echarts/types";
import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
import {
createMockColumn,
@@ -22,6 +27,7 @@ import {
import {
canBrush,
+ getBrushClickObject,
getEventDimensions,
getSeriesClickData,
normalizeDimensionValue,
@@ -505,3 +511,106 @@ describe("canBrush", () => {
).toBe(true);
});
});
+
+describe("getBrushClickObject", () => {
+ // mock element
+ const chartElement = {
+ getBoundingClientRect: () => ({
+ left: 100,
+ top: 50,
+ width: 400,
+ height: 200,
+ right: 500,
+ bottom: 250,
+ x: 100,
+ y: 50,
+ toJSON: () => ({}),
+ }),
+ } as HTMLElement;
+
+ it("builds a temporal brush click object with naive wall-clock strings and sorted bounds", () => {
+ const chartModel = createMockCartesianChartModel({
+ dimensionModel: {
+ column: createdAtColumn,
+ columnIndex: 0,
+ columnByCardId: { [CARD_ID]: createdAtColumn },
+ },
+ xAxisModel: {
+ axisType: "time",
+ toEChartsAxisValue: (value) => String(value),
+ fromEChartsAxisValue: (value) => dayjs.utc(value),
+ interval: { unit: "month", count: 1 },
+ intervalsCount: 12,
+ range: [dayjs.utc("2020-01-01"), dayjs.utc("2020-12-01")],
+ formatter: String,
+ },
+ });
+ // mock event
+ const event = {
+ areas: [
+ {
+ brushType: "lineX",
+ coordRange: [Date.UTC(2020, 2, 1), Date.UTC(2020, 0, 1)],
+ range: [40, 180],
+ },
+ ],
+ } as EChartsSeriesBrushEndEvent;
+
+ const clicked = getBrushClickObject(chartModel, event, chartElement, {});
+
+ expect(clicked?.brushRange).toEqual({
+ type: "temporal",
+ start: "2020-01-01T00:00:00",
+ end: "2020-03-01T00:00:00",
+ });
+ expect(clicked?.column).toBe(createdAtColumn);
+ expect(clicked?.event.clientX).toBe(280);
+ expect(clicked?.event.clientY).toBe(150);
+ });
+
+ it("builds a numeric brush click object with sorted bounds", () => {
+ const priceColumn = createMockColumn({
+ name: "PRICE",
+ source: "breakout",
+ base_type: "type/Integer",
+ effective_type: "type/Integer",
+ });
+ const chartModel = createMockCartesianChartModel({
+ dimensionModel: {
+ column: priceColumn,
+ columnIndex: 0,
+ columnByCardId: { [CARD_ID]: priceColumn },
+ },
+ xAxisModel: {
+ axisType: "value",
+ toEChartsAxisValue: (value) =>
+ typeof value === "number" ? value : null,
+ fromEChartsAxisValue: (value) => value,
+ extent: [0, 10],
+ interval: 1,
+ intervalsCount: 10,
+ isPadded: false,
+ formatter: String,
+ },
+ });
+ // mock event
+ const event = {
+ areas: [
+ {
+ brushType: "lineX",
+ coordRange: [4, 1],
+ range: [20, 90],
+ },
+ ],
+ } as EChartsSeriesBrushEndEvent;
+
+ const clicked = getBrushClickObject(chartModel, event, chartElement, {});
+
+ expect(clicked?.brushRange).toEqual({
+ type: "numeric",
+ start: 1,
+ end: 4,
+ });
+ expect(clicked?.column).toBe(priceColumn);
+ });
+});
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts
index d0ad9e15e93..b91baadd692 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts
@@ -30,6 +30,7 @@ import type {
import type { EChartsEventHandler } from "metabase/visualizations/types/echarts";
import {
canBrush,
+ getBrushClickObject,
getBrushData,
getGoalLineHoverData,
getSeriesClickData,
@@ -48,6 +49,29 @@ function getSplitPanelGrids(option: EChartsOption) {
return Array.isArray(grid) && grid.length > 1 ? grid : null;
}
+function clearBrush(
+ chart: EChartsType | undefined,
+ option: EChartsOption | undefined,
+) {
+ if (!chart) {
+ return;
+ }
+
+ const grids = option != null ? getSplitPanelGrids(option) : null;
+ if (grids) {
+ chart.setOption(
+ { graphic: buildClearBrushMirrorGraphics(grids.length) },
+ false,
+ );
+ }
+
+ chart.dispatchAction({
+ type: "brush",
+ command: "clear",
+ areas: [],
+ });
+}
+
export const useChartEvents = (
chartRef: React.MutableRefObject<EChartsType | undefined>,
containerRef: React.RefObject<HTMLDivElement>,
@@ -114,6 +138,8 @@ export const useChartEvents = (
const optionRef = useLatest(option);
+ const keepBrushForClickActionsRef = useRef(false);
+
const eventHandlers: EChartsEventHandler[] = useMemo(
() => [
{
@@ -188,16 +214,30 @@ export const useChartEvents = (
{
eventName: "brushEnd",
handler: (event: EChartsSeriesBrushEndEvent) => {
- const grids = getSplitPanelGrids(optionRef.current);
- if (grids) {
- const graphics = buildClearBrushMirrorGraphics(grids.length);
- chartRef.current?.setOption({ graphic: graphics }, false);
- }
+ let openedClickActions = false;
if (onBrush) {
- const range = event.areas[0]?.coordRange;
- if (range) {
- onBrush({ start: Number(range[0]), end: Number(range[1]) });
+ const chartElement = chartRef.current?.getDom();
+ if (chartElement) {
+ const clickObject = getBrushClickObject(
+ chartModel,
+ event,
+ chartElement,
+ settings,
+ );
+ if (clickObject) {
+ onBrush({
+ clickObject,
+ openClickActions: (clicked) => {
+ if (!visualizationIsClickable(clicked)) {
+ return;
+ }
+ openedClickActions = true;
+ keepBrushForClickActionsRef.current = true;
+ onVisualizationClick(clicked);
+ },
+ });
+ }
}
} else {
const eventData = getBrushData(
@@ -211,11 +251,9 @@ export const useChartEvents = (
}
}
- chartRef.current?.dispatchAction({
- type: "brush",
- command: "clear",
- areas: [],
- });
+ if (!openedClickActions) {
+ clearBrush(chartRef.current, optionRef.current);
+ }
},
},
],
@@ -239,6 +277,13 @@ export const useChartEvents = (
],
);
+ useEffect(() => {
+ if (clicked == null && keepBrushForClickActionsRef.current) {
+ keepBrushForClickActionsRef.current = false;
+ clearBrush(chartRef.current, optionRef.current);
+ }
+ }, [clicked, chartRef, optionRef]);
+
useEffect(
function handleHoverStates() {
const chart = chartRef.current;
diff --git a/src/metabase/explorations/api.clj b/src/metabase/explorations/api.clj
index ccd2d46e55b..33712081a27 100644
--- a/src/metabase/explorations/api.clj
+++ b/src/metabase/explorations/api.clj
@@ -302,12 +302,12 @@
dimensions))
(defn- format-explore-filter-for-thread-name
- [{:keys [dimension_name display_value value]}]
- (let [value-str (or (some-> display_value str/trim not-empty)
- (some-> value str))]
- (if (and dimension_name (not (str/blank? value-str)))
- (str dimension_name ": " value-str)
- value-str)))
+ "Format one explore filter for a thread name. `:display_value` is FE-authored and is the
+ sole source of truth for the value label."
+ [{:keys [dimension_name display_value]}]
+ (if dimension_name
+ (str dimension_name ": " display_value)
+ display_value))
(defn- explore-further-thread-name
"Build the sidebar name for an \"Explore further\" thread from enriched `explore_filters`.
@@ -315,7 +315,7 @@
nested follow-ups use only the formatted filters."
[card-name enriched-filters top-level-follow-up?]
(let [formatted (->> enriched-filters
- (keep format-explore-filter-for-thread-name)
+ (map format-explore-filter-for-thread-name)
(str/join ", ")
not-empty)]
(cond
@@ -330,6 +330,26 @@
;;; ----------------------------------------- schemas -----------------------------------------
+(def ^:private ExploreFilterSpec
+ "One segment filter stamped onto a block metric selection's `:explore_filters` vector.
+ `:display_value` is required — the FE formats it at click time and both the thread name
+ and filter pills read it as-is."
+ [:multi {:dispatch :operator}
+ ["="
+ [:map
+ [:operator [:= "="]]
+ [:field_ref [:sequential :any]]
+ [:value :any]
+ [:display_value ms/NonBlankString]
+ [:dimension_name {:optional true} [:maybe :string]]]]
+ ["between"
+ [:map
+ [:operator [:= "between"]]
+ [:field_ref [:sequential :any]]
+ [:values [:tuple :any :any]]
+ [:display_value ms/NonBlankString]
+ [:dimension_name {:optional true} [:maybe :string]]]]])
+
(def ^:private MetricSelection
;; Mapping objects are decoded from the snake_case wire shape to the internal kebab-case shape
;; at the `defendpoint` edge by the wire-annotated schema (see [[metabase.metrics.core]]);
@@ -414,12 +434,7 @@
[:name [:maybe :string]]
[:position ms/IntGreaterThanOrEqualToZero]
[:explore_filters {:optional true}
- [:maybe [:sequential
- [:map
- [:field_ref [:sequential :any]]
- [:value :any]
- [:display_value {:optional true} [:maybe :string]]
- [:dimension_name {:optional true} [:maybe :string]]]]]]
+ [:maybe [:sequential ExploreFilterSpec]]]
[:pages [:sequential ::ExplorationPageNode]]])
(mr/def ::HydratedThread
@@ -525,14 +540,6 @@
[:blocks {:optional true} [:maybe [:sequential BlockSelection]]]
[:timeline_ids {:optional true} [:maybe [:sequential ms/PositiveInt]]]])
-(def ^:private ExploreFilterSpec
- "One segment filter stamped onto a block metric selection's `:explore_filters` vector."
- [:map
- [:field_ref [:sequential :any]]
- [:value :any]
- [:display_value {:optional true} [:maybe :string]]
- [:dimension_name {:optional true} [:maybe :string]]])
-
(def ^:private ExploreFurther
"Body schema for `POST /api/exploration/:id/explore-further`. `page_id` is the clicked chart's
page — its block (metric selection + dimensions) is copied verbatim so the new thread re-runs
diff --git a/src/metabase/explorations/query_plan/context.clj b/src/metabase/explorations/query_plan/context.clj
index 1aafc92df52..ee4be0f256a 100644
--- a/src/metabase/explorations/query_plan/context.clj
+++ b/src/metabase/explorations/query_plan/context.clj
@@ -320,9 +320,24 @@
dimension-name (assoc :dimension_name dimension-name))))
explore-filters)))
+(defn- explore-filter-clause
+ "Build the Lib filter clause for one explore-filter spec. Equality filters use `lib/=`;
+ range filters use `lib/between` with ordered bounds."
+ [fref {:keys [operator value values] :as filter-spec}]
+ (case operator
+ "="
+ (lib/= fref value)
+
+ "between"
+ (let [[min-v max-v] (sort values)]
+ (lib/between fref min-v max-v))
+
+ (throw (ex-info "Unknown explore filter operator"
+ {:operator operator :filter-spec filter-spec}))))
+
(defn- apply-single-explore-filter
- "Apply one `{:field_ref ... :value ...}` filter spec to `card`'s `dataset_query`."
- [mp card {:keys [field_ref value] :as filter-spec}]
+ "Apply one explore-filter spec to `card`'s `dataset_query`."
+ [mp card {:keys [field_ref] :as filter-spec}]
(when-not field_ref
(throw (ex-info "Explore filter missing :field_ref" {:filter-spec filter-spec})))
(let [base (lib/query mp (:dataset_query card))
@@ -332,15 +347,15 @@
(throw (ex-info "Could not resolve explore filter field ref on metric query"
{:field-ref field_ref})))
fref (filter-ref-from-click ref-clause col)
- filtered (lib/filter base (lib/= fref value))]
+ filtered (lib/filter base (explore-filter-clause fref filter-spec))]
(assoc card :dataset_query filtered)))
(defn- apply-explore-filters
"When the block's metric selection carries `:explore_filters` (added by the \"Explore further\"
- chart drill), scope the metric Card's `dataset_query` to each `[<bucketed dimension> = <value>]`
- in order so *every* variant built from it inherits the segment — a single injection point, since
- all the variant builders re-wrap `(lib/query mp (:dataset_query card))`. Returns `card` untouched
- when there are no filters."
+ chart drill), scope the metric Card's `dataset_query` to each explore filter in order so
+ *every* variant built from it inherits the segment — a single injection point, since all the
+ variant builders re-wrap `(lib/query mp (:dataset_query card))`. Returns `card` untouched when
+ there are no filters."
[mp card explore-filters]
(reduce (fn [card' ef]
(apply-single-explore-filter mp card' ef))
diff --git a/test/metabase/explorations/api_test.clj b/test/metabase/explorations/api_test.clj
index 6035fcf4e18..10776ada309 100644
--- a/test/metabase/explorations/api_test.clj
+++ b/test/metabase/explorations/api_test.clj
@@ -1428,8 +1428,9 @@
page-id (some :id (filter #(str/includes? (:name %) "Price")
(-> created :threads first :blocks first :pages)))
explore-body {:page_id page-id
- :explore_filters [{:field_ref field-ref
- :value filter-value
+ :explore_filters [{:operator "="
+ :field_ref field-ref
+ :value filter-value
:display_value "2"}]}
hydrated (explore-further-and-hydrate! u expl-id page-id (:explore_filters explore-body))
threads (sort-by :position (:threads hydrated))
@@ -1456,11 +1457,12 @@
(testing "filtered blocks expose explore_filters on the block node and unprefixed page names"
(let [price-page (some #(when (str/includes? (:name %) "Price") %) (:pages new-block))]
(is (some? price-page))
- (is (= [{:field_ref field-ref
+ (is (= [{:operator "="
+ :field_ref field-ref
:value filter-value
:dimension_name "Price"
:display_value "2"}]
- (map #(select-keys % [:field_ref :value :dimension_name :display_value])
+ (map #(select-keys % [:operator :field_ref :value :dimension_name :display_value])
(:explore_filters new-block)))
"block node echoes persisted explore_filters")
(is (str/includes? (:name price-page) "Price")
@@ -1496,8 +1498,10 @@
page-id (some :id (filter #(str/includes? (:name %) "Price")
(-> src :blocks first :pages)))
drill {:page_id page-id
- :explore_filters [{:field_ref ["field" {} (mt/id :venues :price)]
- :value 2 :display_value "2"}]}]
+ :explore_filters [{:operator "="
+ :field_ref ["field" {} (mt/id :venues :price)]
+ :value 2
+ :display_value "2"}]}]
(testing "control: drilling a thread the caller can see succeeds"
(is (map? (mt/user-http-request u :post 200
(format "exploration/%d/explore-further" expl-id) drill))))
@@ -1529,10 +1533,11 @@
page-id (some :id (filter #(str/includes? (:name %) "Price")
(-> created :threads first :blocks first :pages)))
enqueued (atom [])]
- (with-redefs [explorations.queues/start-thread! (fn [tid] (swap! enqueued conj tid))]
+ (mt/with-dynamic-fn-redefs [explorations.queues/start-thread! (fn [tid] (swap! enqueued conj tid))]
(mt/user-http-request u :post 200 (format "exploration/%d/explore-further" expl-id)
{:page_id page-id
- :explore_filters [{:field_ref ["field" {} (mt/id :venues :price)]
+ :explore_filters [{:operator "="
+ :field_ref ["field" {} (mt/id :venues :price)]
:value 2
:display_value "2"}]}))
(let [new-thread-id (->> (t2/select :model/ExplorationThread
@@ -1555,7 +1560,10 @@
expl-id (:id resp)
page-id (-> resp :threads first :blocks first :pages first :id)
body {:page_id page-id
- :explore_filters [{:field_ref ["field" {} (mt/id :venues :category_id)] :value 1}]}]
+ :explore_filters [{:operator "="
+ :field_ref ["field" {} (mt/id :venues :category_id)]
+ :value 1
+ :display_value "1"}]}]
(mt/user-http-request other :post 403 (format "exploration/%d/explore-further" expl-id) body)
(mt/user-http-request owner :post 404 (format "exploration/%d/explore-further" expl-id)
(assoc body :page_id 9999999))
@@ -1678,11 +1686,13 @@
(deftest blocks-tree-explore-further-naming-test
(testing "filtered blocks expose explore_filters on the block node with unprefixed page names"
- (let [filters [{:field_ref ["field" {} 1]
+ (let [filters [{:operator "="
+ :field_ref ["field" {} 1]
:value "texas"
:dimension_name "State"
:display_value "Texas"}
- {:field_ref ["field" {} 2]
+ {:operator "="
+ :field_ref ["field" {} 2]
:value "2024"
:dimension_name "Year"
:display_value "2024"}]
@@ -2164,8 +2174,10 @@
:metrics [{:card_id (:id metric)}]}
a (insert-explore-fixture! common)
b (insert-explore-fixture! common)
- body {:explore_filters [{:field_ref ["field" {} (mt/id :venues :name)]
- :value "Texas"}]}]
+ body {:explore_filters [{:operator "="
+ :field_ref ["field" {} (mt/id :venues :name)]
+ :value "Texas"
+ :display_value "Texas"}]}]
(testing "cross-exploration page is rejected"
(mt/user-http-request :crowberto :post 404
(str "exploration/" (:exploration-id a) "/explore-further")
@@ -2175,6 +2187,48 @@
(str "exploration/" (:exploration-id a) "/explore-further")
(assoc body :page_id (:page-id a)))))))))
+(deftest explore-further-with-between-filter-test
+ (testing "POST /:id/explore-further accepts a between explore filter and persists it"
+ (mt/with-temp [:model/Collection coll {}
+ :model/Card metric {:name "Number of venues"
+ :type :metric
+ :dataset_query (lib/->legacy-MBQL
+ (let [mp (mt/metadata-provider)]
+ (-> (lib/query mp (lib.metadata/table mp (mt/id :venues)))
+ (lib/aggregate (lib/count)))))}]
+ (let [src (insert-explore-fixture!
+ {:creator-id (mt/user->id :crowberto)
+ :collection-id (:id coll)
+ :card-id (:id metric)
+ :database-id (mt/id)
+ :dimension-id "price"
+ :metrics [{:card_id (:id metric)
+ :dimension_mappings (venues-dimension-mappings)}]
+ :dimensions [{:dimension_id "price" :display_name "Price"}]})
+ filter-spec {:operator "between"
+ :field_ref ["field" {} (mt/id :venues :price)]
+ :values [1 3]
+ :display_value "1 - 3"}
+ hydrated (explore-further-and-hydrate! :crowberto
+ (:exploration-id src)
+ (:page-id src)
+ [filter-spec])
+ new-thread (->> hydrated :threads (sort-by :position) last)
+ new-block (-> new-thread :blocks first)
+ persisted (t2/select-one :model/ExplorationBlock
+ :exploration_thread_id (:id new-thread))]
+ (is (= "Number of venues → Price: 1 - 3" (:name new-thread)))
+ (is (= [{:operator "between"
+ :field_ref ["field" {} (mt/id :venues :price)]
+ :values [1 3]
+ :display_value "1 - 3"
+ :dimension_name "Price"}]
+ (map #(select-keys % [:operator :field_ref :values :display_value :dimension_name])
+ (:explore_filters new-block))))
+ (testing "the operator survives the round-trip to the persisted block"
+ (is (= "between"
+ (get-in persisted [:metrics 0 :explore_filters 0 :operator]))))))))
+
(deftest explore-further-preserves-prior-filter-on-compound-drill-test
(testing "POST /:id/explore-further keeps the source block's existing explore filters and appends the new one —"
(testing "so drilling within an already-drilled thread doesn't silently drop the earlier segment scope"
@@ -2185,8 +2239,14 @@
(let [mp (mt/metadata-provider)]
(-> (lib/query mp (lib.metadata/table mp (mt/id :venues)))
(lib/aggregate (lib/count)))))}]
- (let [prior {:field_ref ["field" {} (mt/id :venues :name)] :value "Texas"}
- new-f {:field_ref ["field" {} (mt/id :venues :price)] :value 2}
+ (let [prior {:operator "="
+ :field_ref ["field" {} (mt/id :venues :name)]
+ :value "Texas"
+ :display_value "Texas"}
+ new-f {:operator "="
+ :field_ref ["field" {} (mt/id :venues :price)]
+ :value 2
+ :display_value "2"}
src (insert-explore-fixture!
{:creator-id (mt/user->id :crowberto)
:collection-id (:id coll)
@@ -2207,7 +2267,7 @@
first)
filters (:explore_filters (first (:metrics new-block)))]
(is (= [prior new-f]
- (mapv #(select-keys % [:field_ref :value]) filters))
+ (mapv #(select-keys % [:operator :field_ref :value :display_value]) filters))
"both the prior (Texas) and the newly clicked (price) filter are present, in drill order"))))))
(deftest explore-further-nested-thread-name-omits-metric-prefix-test
@@ -2234,8 +2294,9 @@
(mt/user-http-request :crowberto :post 200
(str "exploration/" (:exploration-id src) "/explore-further")
{:page_id (:page-id src)
- :explore_filters [{:field_ref ["field" {} (mt/id :venues :price)]
- :value 2
+ :explore_filters [{:operator "="
+ :field_ref ["field" {} (mt/id :venues :price)]
+ :value 2
:display_value "2"}]})
(let [new-thread (t2/select-one :model/ExplorationThread
:exploration_id (:exploration-id src)
@@ -2266,10 +2327,14 @@
(mt/user-http-request :crowberto :post 200
(str "exploration/" (:exploration-id src) "/explore-further")
{:page_id (:page-id src)
- :explore_filters [{:field_ref ["field" {} (mt/id :venues :category_id)]
- :value "gadget"}
- {:field_ref ["field" {} (mt/id :venues :price)]
- :value 2}]})
+ :explore_filters [{:operator "="
+ :field_ref ["field" {} (mt/id :venues :category_id)]
+ :value "gadget"
+ :display_value "gadget"}
+ {:operator "="
+ :field_ref ["field" {} (mt/id :venues :price)]
+ :value 2
+ :display_value "2"}]})
(let [new-thread (t2/select-one :model/ExplorationThread
:exploration_id (:exploration-id src)
{:order-by [[:position :desc] [:id :desc]]})]
@@ -2300,15 +2365,15 @@
:target ["field" {} orders-field]}]}]
:dimensions [{:dimension_id users-created :display_name "Created At"}
{:dimension_id orders-created :display_name "Created At"}]}
- created (create-exploration! u body)
- expl-id (:id created)
- page-id (->> created :threads first :blocks first :pages
- (some #(when (= "Users → Created At" (:name %)) (:id %))))
- _ (is (some? page-id) "find the users-created page by its disambiguated name")
- filter {:field_ref ["field" {} users-field] :value 40.7 :display_value "40.7"}
- hydrated (explore-further-and-hydrate! u expl-id page-id [filter])
- new-thread (->> hydrated :threads (sort-by :position) last)
- persisted (t2/select-one :model/ExplorationBlock :exploration_thread_id (:id new-thread))]
+ created (create-exploration! u body)
+ expl-id (:id created)
+ page-id (->> created :threads first :blocks first :pages
+ (some #(when (= "Users → Created At" (:name %)) (:id %))))
+ _ (is (some? page-id) "find the users-created page by its disambiguated name")
+ filter-spec {:operator "=" :field_ref ["field" {} users-field] :value 40.7 :display_value "40.7"}
+ hydrated (explore-further-and-hydrate! u expl-id page-id [filter-spec])
+ new-thread (->> hydrated :threads (sort-by :position) last)
+ persisted (t2/select-one :model/ExplorationBlock :exploration_thread_id (:id new-thread))]
(is (= "Revenue → Users → Created At: 40.7" (:name new-thread))
"thread name uses the group-qualified filter dimension label")
(is (= "Users → Created At"
@@ -2375,8 +2440,10 @@
expl-id (:id resp)
page-id (-> resp :threads first :blocks first :pages first :id)
body {:page_id page-id
- :explore_filters [{:field_ref ["field" {} (mt/id :venues :category_id)]
- :value 1}]}
+ :explore_filters [{:operator "="
+ :field_ref ["field" {} (mt/id :venues :category_id)]
+ :value 1
+ :display_value "1"}]}
threads-before (t2/count :model/ExplorationThread :exploration_id expl-id)]
(perms/revoke-collection-permissions! (perms-group/all-users) (:id hidden))
(testing "an unreadable card is a 403"
diff --git a/test/metabase/explorations/query_plan/context_test.clj b/test/metabase/explorations/query_plan/context_test.clj
index 0856bef3daa..11e82fc75c3 100644
--- a/test/metabase/explorations/query_plan/context_test.clj
+++ b/test/metabase/explorations/query_plan/context_test.clj
@@ -174,7 +174,8 @@
(:id t) cid
{:metrics [{:card_id cid
:dimension_mappings mappings
- :explore_filters [{:field_ref ["field" {} (mt/id :venues :price)]
+ :explore_filters [{:operator "="
+ :field_ref ["field" {} (mt/id :venues :price)]
:value 2}]}]
:dimensions [{:dimension-id "d1" :display-name "Price"
:effective-type "type/Number"}]}
@@ -185,6 +186,70 @@
(is (some #(and (str/includes? % "Price") (str/includes? % "2"))
(card-filter-display-names (:card ctx))))))))
+(deftest build-row-context-applies-numeric-between-explore-filter-test
+ (testing "build-row-context applies a numeric between explore filter with ordered bounds"
+ (mt/with-temp [:model/Card metric {:type :metric :dataset_query (count-metric-query)}
+ :model/Exploration e {:name "x"}
+ :model/ExplorationThread t {:exploration_id (:id e)}]
+ (let [cid (:id metric)
+ mappings [{:dimension-id "d1" :table-id (mt/id :venues)
+ :target ["field" {} (mt/id :venues :price)]}]
+ page-id (insert-block-page-row!
+ (:id t) cid
+ {:metrics [{:card_id cid
+ :dimension_mappings mappings
+ :explore_filters [{:operator "between"
+ :field_ref ["field" {} (mt/id :venues :price)]
+ :values [4 1]
+ :display_value "1 - 4"}]}]
+ :dimensions [{:dimension-id "d1" :display-name "Price"
+ :effective-type "type/Number"}]}
+ "d1")
+ ctx (qp.context/build-row-context {:card_id cid :dimension_id "d1"
+ :page_id page-id :params {}})
+ q (lib/query (mt/metadata-provider) (:dataset_query (:card ctx)))
+ clause (first (lib/filters q))]
+ (is (some? ctx))
+ (is (= :between (first clause)))
+ (is (= 1 (nth clause 3)))
+ (is (= 4 (nth clause 4)))
+ (is (some #(and (str/includes? % "Price")
+ (str/includes? % "1")
+ (str/includes? % "4"))
+ (card-filter-display-names (:card ctx))))))))
+
+(deftest build-row-context-applies-temporal-between-explore-filter-test
+ (testing "build-row-context applies a temporal between explore filter and preserves the click bucket"
+ (mt/with-temp [:model/Card metric {:type :metric :dataset_query (orders-count-metric-query)}
+ :model/Exploration e {:name "x"}
+ :model/ExplorationThread t {:exploration_id (:id e)}]
+ (let [cid (:id metric)
+ created-at (mt/id :orders :created_at)
+ mappings [{:dimension-id "d1" :table-id (mt/id :orders)
+ :target ["field" {} created-at]}]
+ page-id (insert-block-page-row!
+ (:id t) cid
+ {:metrics [{:card_id cid
+ :dimension_mappings mappings
+ :explore_filters [{:operator "between"
+ :field_ref ["field" {:temporal-unit :month} created-at]
+ :values ["2020-03-01T00:00:00"
+ "2020-01-01T00:00:00"]
+ :display_value "Jan 2020 - Mar 2020"}]}]
+ :dimensions [{:dimension-id "d1" :display-name "Created At"
+ :effective-type "type/DateTimeWithLocalTZ"}]}
+ "d1")
+ ctx (qp.context/build-row-context {:card_id cid :dimension_id "d1"
+ :page_id page-id :params {}})
+ q (lib/query (mt/metadata-provider) (:dataset_query (:card ctx)))
+ clause (first (lib/filters q))
+ lhs (nth clause 2)]
+ (is (some? ctx))
+ (is (= :between (first clause)))
+ (is (= :month (lib/raw-temporal-bucket lhs)))
+ (is (= "2020-01-01T00:00:00" (nth clause 3)))
+ (is (= "2020-03-01T00:00:00" (nth clause 4)))))))
+
(deftest build-row-context-applies-multiple-explore-filters-test
(testing "build-row-context reduces multiple explore_filters onto the metric Card in order"
(mt/with-temp [:model/Card metric {:type :metric :dataset_query (count-metric-query)}
@@ -199,9 +264,11 @@
(:id t) cid
{:metrics [{:card_id cid
:dimension_mappings mappings
- :explore_filters [{:field_ref ["field" {} (mt/id :venues :price)]
+ :explore_filters [{:operator "="
+ :field_ref ["field" {} (mt/id :venues :price)]
:value 2}
- {:field_ref ["field" {} (mt/id :venues :name)]
+ {:operator "="
+ :field_ref ["field" {} (mt/id :venues :name)]
:value "Smallville"}]}]
:dimensions [{:dimension-id "d1" :display-name "Price"
:effective-type "type/Number"}
@@ -228,7 +295,8 @@
(:id t) cid
{:metrics [{:card_id cid
:dimension_mappings mappings
- :explore_filters [{:field_ref ["field" {:temporal-unit :month} created-at]
+ :explore_filters [{:operator "="
+ :field_ref ["field" {:temporal-unit :month} created-at]
:value "2020-01-01T00:00:00Z"}]}]
:dimensions [{:dimension-id "d1" :display-name "Created At"
:effective-type "type/DateTimeWithLocalTZ"}]}
@@ -259,7 +327,8 @@
(:id t) cid
{:metrics [{:card_id cid
:dimension_mappings mappings
- :explore_filters [{:field_ref ["field" {:temporal-unit unit} created-at]
+ :explore_filters [{:operator "="
+ :field_ref ["field" {:temporal-unit unit} created-at]
:value value}]}]
:dimensions [{:dimension-id "d1" :display-name "Created At"
:effective-type "type/DateTimeWithLocalTZ"}]}
@@ -284,7 +353,8 @@
(:id t) cid
{:metrics [{:card_id cid
:dimension_mappings mappings
- :explore_filters [{:field_ref ["field" {:binning {:strategy :default}} price-id]
+ :explore_filters [{:operator "="
+ :field_ref ["field" {:binning {:strategy :default}} price-id]
:value 10}]}]
:dimensions [{:dimension-id "d1" :display-name "Price"
:effective-type "type/Number"}]}
@@ -323,8 +393,8 @@
:target ["field" {} users-field]}
{:dimension-id orders-created :table-id (mt/id :venues)
:target ["field" {} orders-field]}]}
- filter {:field_ref ["field" {} users-field] :value 40.7}
- [enriched] (qp.context/enrich-explore-filters mp metric block metric-selection [filter])]
+ filter-spec {:operator "=" :field_ref ["field" {} users-field] :value 40.7}
+ [enriched] (qp.context/enrich-explore-filters mp metric block metric-selection [filter-spec])]
(is (= "Users → Created At" (:dimension_name enriched))
"the clicked filter is labeled with the dim's group when the display_name is shared"))))))
@@ -349,7 +419,8 @@
{:metrics [{:card_id cid
:dimension_mappings mappings
;; a column from another table — not resolvable on this query
- :explore_filters [{:field_ref ["field" {} (mt/id :orders :total)]
+ :explore_filters [{:operator "="
+ :field_ref ["field" {} (mt/id :orders :total)]
:value 10}]}]
:dimensions [{:dimension-id "d1" :display-name "Name"
:effective-type "type/Text"}]}
@@ -373,7 +444,7 @@
block {:metrics [metric-sel]
:dimensions [{:dimension-id "d1" :display-name "Name"
:effective-type "type/Text"}]}
- filters [{:field_ref ["expression" "Name"] :value "Smallville"}]
+ filters [{:operator "=" :field_ref ["expression" "Name"] :value "Smallville"}]
[enriched] (qp.context/enrich-explore-filters (mt/metadata-provider) metric block metric-sel filters)]
(testing "field_ref no longer references the synthetic expression"
(is (not (contains? #{"expression" :expression} (first (:field_ref enriched))))))
@@ -398,7 +469,7 @@
(let [metric-sel {:card_id (:id metric) :dimension_mappings []}
block {:metrics [metric-sel]
:dimensions [{:dimension-id "d1" :display-name "Name"}]}
- filters [{:field_ref ["expression" "Nonexistent"] :value "x"}]
+ filters [{:operator "=" :field_ref ["expression" "Nonexistent"] :value "x"}]
enriched (qp.context/enrich-explore-filters (mt/metadata-provider) metric block metric-sel filters)]
(is (= 1 (count enriched)))
(is (nil? (:dimension_name (first enriched))) "no label resolved, but no exception thrown")
@@ -415,7 +486,7 @@
:model/Exploration e {:name "x"}
:model/ExplorationThread t {:exploration_id (:id e)}]
(let [cid (:id metric)
- filters [{:field_ref ["field" {} (mt/id :venues :name)] :value "foo"}]
+ filters [{:operator "=" :field_ref ["field" {} (mt/id :venues :name)] :value "foo"}]
mappings [{:dimension-id "d1" :table-id (mt/id :venues)
:target ["field" {} (mt/id :venues :name)]}]
page-id (insert-block-page-row!
diff --git a/test/metabase/explorations/query_plan/variants_test.clj b/test/metabase/explorations/query_plan/variants_test.clj
index bde1ea56543..52ed46fb1cd 100644
--- a/test/metabase/explorations/query_plan/variants_test.clj
+++ b/test/metabase/explorations/query_plan/variants_test.clj
@@ -277,7 +277,7 @@
(def ^:private widget-explore-filters
"The `:explore_filters` chain that produced a Widget-scoped card — what the ctx carries and the
discovery cache keys on."
- [{:field_ref ["field" {} 4242] :value "Widget"}])
+ [{:operator "=" :field_ref ["field" {} 4242] :value "Widget"}])
(deftest cached-discovery-isolates-filtered-queries-test
(testing "cached-discovery keys on the :explore-filters chain so segments don't share top-N results"