Skip to content

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

Metrics Viewer Dimension Picking Experience Improvements (#74618)

Andersona1144c0aa4c3
diff --git a/e2e/support/helpers/e2e-metrics-viewer-helpers.ts b/e2e/support/helpers/e2e-metrics-viewer-helpers.ts
index 6f3bba3a0f4..36283e1cbbe 100644
--- a/e2e/support/helpers/e2e-metrics-viewer-helpers.ts
+++ b/e2e/support/helpers/e2e-metrics-viewer-helpers.ts
@@ -1,33 +1,33 @@
export const MetricsViewer = {
goToViewer: () => cy.visit("/explore"),
+ formulaInput: () => cy.findByTestId("metrics-formula-input"),
searchInput: () => {
// Click the right edge of the container to focus the CodeMirror input
// without accidentally hitting a pill (which would trigger the swap-metric flow).
- cy.findByTestId("metrics-formula-input").click("right");
+ MetricsViewer.formulaInput().click("right");
return cy.findByTestId("metrics-viewer-search-input");
},
- // Pills commit asynchronously after the formula is run and its @dataset query
- // resolves; on a loaded CI this re-render can exceed the default 4s timeout.
searchBarPills: () =>
- cy.findAllByTestId("metrics-viewer-search-pill", { timeout: 15000 }),
+ cy.get(
+ "[data-testid='metrics-viewer-pill'], [data-testid='metrics-viewer-expression-pill']",
+ ),
searchResults: () => cy.findByTestId("mini-picker"),
breakoutLegend: () => cy.findByTestId("metrics-viewer-breakout-legend"),
getFilterButton: () => cy.findByRole("button", { name: /Filter/ }),
getAllFilterPills: () => cy.findAllByTestId("metrics-viewer-filter-pill"),
- getDimensionPillContainer: () =>
- cy.findByTestId("metrics-viewer-dimension-pill-container"),
- tablist: () => cy.findByRole("tablist"),
- getTab: (tab: string) =>
- MetricsViewer.tablist().findByRole("tab", { name: tab }),
- tabsShouldBe: (tabs: string[]) => {
- tabs.forEach((tab) =>
- MetricsViewer.tablist().findByRole("tab", { name: tab }).should("exist"),
- );
+ getDimensionPillBarContainer: () =>
+ cy.findByTestId("metrics-viewer-dimension-pill-bar"),
+ dimensionPickerSidebar: () =>
+ cy.findByTestId("metrics-viewer-dimension-picker-sidebar"),
+ getColumnPickerButton: () =>
+ MetricsViewer.getMetricControls().findByLabelText("Change column"),
+ openDimensionPickerSidebar: () => {
+ MetricsViewer.getColumnPickerButton().click();
+ return MetricsViewer.dimensionPickerSidebar();
},
- // The visualization re-renders after the @dataset query resolves, which can
- // exceed the default 4s timeout on a loaded CI.
- getMetricVisualization: () =>
- cy.findByTestId("visualization-root", { timeout: 15000 }),
+ closeDimensionPickerSidebar: () =>
+ MetricsViewer.dimensionPickerSidebar().findByLabelText("Close").click(),
+ getMetricVisualization: () => cy.findByTestId("visualization-root"),
getMetricVisualizationDataPoints: () =>
MetricsViewer.getMetricVisualization().get(
"path[fill='hsla(0, 0%, 100%, 1.00)']",
@@ -49,20 +49,10 @@ export const MetricsViewer = {
cy.wrap($el).should("have.attr", "data-viz-ui-name", displayType);
});
},
- getMerticControls: () => cy.findByTestId("metrics-viewer-controls"),
+ getMetricControls: () => cy.findByTestId("metrics-viewer-controls"),
changeVizType: (display: string) =>
- MetricsViewer.getMerticControls()
+ MetricsViewer.getMetricControls()
.findByRole("button", { name: display })
.click(),
- getLayoutControls: () => cy.findByTestId("metrics-viewer-layout-controls"),
- getAllCards: () => cy.findAllByTestId("metrics-viewer-card"),
- getAddDimensionButton: () =>
- cy.findByRole("button", { name: "Add dimension tab" }),
- getRemoveTabButton: (tabLabel: string) =>
- cy.findByRole("button", { name: `Remove ${tabLabel} tab` }),
- openMetricHomePage: (metricName: string) => {
- MetricsViewer.searchBarPills().contains(metricName).rightclick();
- cy.findByText(/Go to metric home page/).click();
- },
runButton: () => cy.findByTestId("run-expression-button"),
};
diff --git a/e2e/test/scenarios/metrics/metrics-explorer.cy.spec.ts b/e2e/test/scenarios/metrics/metrics-explorer.cy.spec.ts
index 434d332fbdb..11e0b153239 100644
--- a/e2e/test/scenarios/metrics/metrics-explorer.cy.spec.ts
+++ b/e2e/test/scenarios/metrics/metrics-explorer.cy.spec.ts
@@ -18,6 +18,19 @@ type StructuredQuestionDetailsWithName = StructuredQuestionDetails & {
name: string;
};
+type CompactMetricsViewerUrlState = {
+ t?: Array<{
+ i?: string;
+ t?: string;
+ l?: string;
+ D?: Array<{
+ i?: number;
+ d?: string;
+ }>;
+ }>;
+ a?: string | null;
+};
+
const ORDERS_SCALAR_METRIC: StructuredQuestionDetailsWithName = {
name: "Count of orders",
type: "metric",
@@ -115,10 +128,24 @@ const ALL_MODELS = [
const SNAPSHOT_NAME = "metrics-explorer-snapshot";
+const getMetricSearchResultMatcher = (name: string) => {
+ if (name === "Count of orders") {
+ return /Count of orders(?!\s+over\s+time)/;
+ }
+
+ return name;
+};
+
// ============================================================================
// Test Helpers
// ============================================================================
+const selectMetricSearchResult = (name: string) => {
+ H.MetricsViewer.searchResults()
+ .contains('[role="menuitem"]', getMetricSearchResultMatcher(name))
+ .click();
+};
+
/**
* Add a metric or measure to the explorer via the search panel
*/
@@ -127,33 +154,56 @@ const addMetric = (name: string, runExpression: boolean = true) => {
H.MetricsViewer.searchInput().type(`{end}, ${name}`, {
waitForAnimations: true,
});
- H.MetricsViewer.searchResults().findByText(name).click();
+ selectMetricSearchResult(name);
if (runExpression) {
- H.MetricsViewer.runButton().click();
+ runFormula();
}
};
const addMetricMath = (
expression: ({ metricName: string } | string)[],
runExpression: boolean = true,
) => {
+ H.MetricsViewer.searchInput().then(($input) => {
+ const text = $input.text().trim();
+ if (
+ text.length > 0 &&
+ !/[,+*/(-]$/.test(text) &&
+ (typeof expression[0] !== "string" || !/[,+*/(-]$/.test(expression[0]))
+ ) {
+ cy.wrap($input).type("{end}, ", {
+ waitForAnimations: true,
+ });
+ }
+ });
+
for (const item of expression) {
if (typeof item === "string") {
- H.MetricsViewer.searchInput().type(`{end}${item}`, {
+ const text = /^[+*/-]$/.test(item) ? ` ${item} ` : item;
+ H.MetricsViewer.searchInput().type(`{end}${text}`, {
waitForAnimations: true,
});
} else {
H.MetricsViewer.searchInput().type(`{end}${item.metricName}`, {
waitForAnimations: true,
});
- H.MetricsViewer.searchResults().findByText(item.metricName).click();
+ selectMetricSearchResult(item.metricName);
}
}
if (runExpression) {
- H.MetricsViewer.runButton().click();
+ runFormula();
}
};
+const runFormula = () => {
+ H.MetricsViewer.runButton().should("not.be.disabled").click();
+};
+
+const runFormulaWithKeyboard = () => {
+ H.MetricsViewer.runButton().should("not.be.disabled");
+ H.MetricsViewer.searchInput().type("{enter}");
+};
+
/**
* Select a breakout dimension
*/
@@ -164,7 +214,7 @@ const selectBreakout = (
binning?: string,
) => {
H.MetricsViewer.searchBarPills().contains(cardname).click();
- H.popover().findByText("Break out").click();
+ H.popover().findByText("Add a series breakout").click();
const breakout = H.popover()
.findAllByText(dimensionName)
.should("have.length.at.least", index)
@@ -184,6 +234,7 @@ const selectBreakout = (
*/
const interceptDatasetQuery = () => {
cy.intercept("POST", "/api/metric/dataset").as("dataset");
+ cy.intercept("POST", "/api/metric/breakout-values").as("breakoutValues");
};
/**
@@ -207,10 +258,85 @@ const openExpressionRename = (pillIndex: number) => {
};
/**
- * Switch to a specific tab
+ * Select a dimension breakout from the sidebar and close it.
*/
-const switchToTab = (tabName: string) => {
- H.MetricsViewer.getTab(tabName).click();
+const selectDimensionBreakout = (
+ dimensionName: string,
+ { seeAll = false }: { seeAll?: boolean } = {},
+) => {
+ H.MetricsViewer.openDimensionPickerSidebar();
+ if (seeAll) {
+ H.MetricsViewer.dimensionPickerSidebar()
+ .findByRole("button", { name: "See all" })
+ .click();
+ }
+ H.MetricsViewer.dimensionPickerSidebar()
+ .findByRole("button", { name: dimensionName })
+ .click();
+ H.MetricsViewer.closeDimensionPickerSidebar();
+};
+
+const showColumnLabels = () => {
+ H.MetricsViewer.getMetricControls()
+ .findByLabelText("Column label options")
+ .click();
+ cy.findByRole("switch", { name: "Show column labels" }).click();
+};
+
+const getMetricsViewerUrlState =
+ (): Cypress.Chainable<CompactMetricsViewerUrlState> => {
+ return cy.location("hash").then((hash) => {
+ return decodeMetricsViewerUrlHash(hash);
+ });
+ };
+
+const decodeMetricsViewerUrlHash = (
+ hash: string,
+): CompactMetricsViewerUrlState => {
+ const encodedHash = hash.replace(/^#/, "");
+ const base64 = encodedHash.replace(/-/g, "+").replace(/_/g, "/");
+ const paddedBase64 = base64.padEnd(Math.ceil(base64.length / 4) * 4, "=");
+ const bytes = Uint8Array.from(atob(paddedBase64), (char) =>
+ char.charCodeAt(0),
+ );
+
+ return JSON.parse(
+ new TextDecoder().decode(bytes),
+ ) as CompactMetricsViewerUrlState;
+};
+
+const waitForSerializedDimensionBreakout = () => {
+ cy.location("hash").should((hash) => {
+ const state = decodeMetricsViewerUrlHash(hash);
+ const [dimensionBreakout] = state.t ?? [];
+
+ expect(state.t).to.have.length(1);
+ expect(state.a).to.equal(dimensionBreakout?.i);
+ expect(dimensionBreakout?.D).to.have.length(2);
+ });
+};
+
+const addOrdersProductsExpression = () => {
+ addMetricMath(
+ [
+ { metricName: "Count of orders" },
+ "+",
+ { metricName: "Count of products" },
+ ],
+ false,
+ );
+ runFormulaWithKeyboard();
+ cy.wait("@dataset");
+};
+
+const openTimeDimensionConfiguration = () => {
+ H.MetricsViewer.dimensionPickerSidebar()
+ .findByRole("button", { name: "Time" })
+ .realHover();
+
+ H.MetricsViewer.dimensionPickerSidebar()
+ .findByRole("button", { name: "Configure Time" })
+ .click();
};
/**
@@ -268,7 +394,7 @@ const assertPillColorsInChart = (pillIndex: number) => {
for (const color of colors) {
H.echartsContainer()
.find(`path[fill="${color}"], path[stroke="${color}"]`)
- .should("exist");
+ .should("be.visible");
}
});
};
@@ -327,7 +453,9 @@ describe("scenarios > metrics > explorer", () => {
it("should show empty state on first load", () => {
H.MetricsViewer.goToViewer();
cy.url().should("include", "/explore");
- cy.findByRole("heading", { name: "Start exploring" }).should("exist");
+ cy.findByRole("heading", { name: "Start exploring" }).should(
+ "be.visible",
+ );
addMetric("Count of products");
@@ -363,7 +491,7 @@ describe("scenarios > metrics > explorer", () => {
H.MetricsViewer.goToViewer();
addMetric("Empty Metric");
- cy.findByRole("heading", { name: "No results!" }).should("exist");
+ cy.findByRole("heading", { name: "No results!" }).should("be.visible");
});
});
@@ -408,26 +536,40 @@ describe("scenarios > metrics > explorer", () => {
});
it("should add metrics and measures from the entity picker", () => {
- H.activateToken("pro-self-hosted");
- createLibraryWithTable();
+ H.activateToken("pro-self-hosted").then(() => {
+ return createLibraryWithTable();
+ });
H.MetricsViewer.goToViewer();
cy.log("Add a metric from the entity picker");
- H.MetricsViewer.searchInput().click();
+ H.MetricsViewer.searchInput().type("Count", { waitForAnimations: true });
H.MetricsViewer.searchResults().findByText("Browse all").click();
+ cy.findByTestId("nested-item-picker").should("be.visible");
H.pickEntity({ path: ["Our analytics", "Count of orders"] });
+ cy.findByTestId("metrics-viewer-search-input").should(
+ "contain.text",
+ "Count of orders",
+ );
cy.log("Add a measure from the entity picker");
- H.MetricsViewer.searchInput().click();
+ H.MetricsViewer.searchInput().type("{end}, Test", {
+ waitForAnimations: true,
+ });
H.MetricsViewer.searchResults().findByText("Browse all").click();
+ cy.findByTestId("nested-item-picker").should("be.visible");
H.pickEntity({ path: ["Library", "Data", "Orders", "Test Measure"] });
+ cy.findByTestId("metrics-viewer-search-input").should(
+ "contain.text",
+ "Test Measure",
+ );
- H.MetricsViewer.runButton().click();
+ runFormula();
verifyMetricCount(2);
- H.MetricsViewer.searchInput().click();
+ H.MetricsViewer.searchInput().type("Sample", { waitForAnimations: true });
H.MetricsViewer.searchResults().findByText("Browse all").click();
+ cy.findByTestId("nested-item-picker").should("be.visible");
H.pickEntity({ path: ["Databases", "Sample Database"] });
cy.log("People is disabled because it doesn't have measures");
@@ -454,12 +596,10 @@ describe("scenarios > metrics > explorer", () => {
H.MetricsViewer.goToViewer();
addMetric("Count of products", false);
- H.MetricsViewer.searchResults().findByText("Count of orders").click();
- H.MetricsViewer.searchResults()
- .findByText("Count of orders over time")
- .click();
- H.MetricsViewer.searchResults().findByText("Orders model metric").click();
- H.MetricsViewer.runButton().click();
+ selectMetricSearchResult("Count of orders");
+ selectMetricSearchResult("Count of orders over time");
+ selectMetricSearchResult("Orders model metric");
+ runFormula();
cy.wait("@dataset");
verifyMetricCount(4);
@@ -528,13 +668,13 @@ describe("scenarios > metrics > explorer", () => {
});
H.MetricsViewer.searchBarPills()
- .contains("[data-testid=metrics-viewer-search-pill]", "Count of orders")
+ .contains("[data-testid=metrics-viewer-pill]", "Count of orders")
.findByTestId("color-indicator-container")
.children()
.should("have.length", 5);
H.MetricsViewer.searchBarPills().contains("Count of orders").click();
- H.popover().findByText("Change breakout").click();
+ H.popover().findByText("Change series breakout").click();
H.popover().findByText("Category").click();
H.MetricsViewer.breakoutLegend()
@@ -542,7 +682,7 @@ describe("scenarios > metrics > explorer", () => {
.should("be.visible");
H.MetricsViewer.searchBarPills().contains("Count of orders").click();
- H.popover().findByText("Remove breakout").click();
+ H.popover().findByText("Remove series breakout").click();
H.MetricsViewer.breakoutLegend().should("not.exist");
});
@@ -582,7 +722,7 @@ describe("scenarios > metrics > explorer", () => {
cy.log("Search pill should cap at 6 color indicators");
H.MetricsViewer.searchBarPills()
- .contains("[data-testid=metrics-viewer-search-pill]", "Count of orders")
+ .contains("[data-testid=metrics-viewer-pill]", "Count of orders")
.findByTestId("color-indicator-container")
.children()
.should("have.length", 6);
@@ -592,7 +732,6 @@ describe("scenarios > metrics > explorer", () => {
cy.log(
"Expand formula editor and create expression with second metric instance",
);
- cy.findByTestId("metrics-formula-input").click();
addMetricMath(
[
{ metricName: "Count of orders" },
@@ -625,7 +764,7 @@ describe("scenarios > metrics > explorer", () => {
cy.log("Apply breakout to first instance of Count of orders");
H.MetricsViewer.searchBarPills().eq(0).click();
- H.popover().findByText("Break out").click();
+ H.popover().findByText("Add a series breakout").click();
H.popover().findByText("Source").click();
cy.wait("@dataset");
@@ -669,7 +808,7 @@ describe("scenarios > metrics > explorer", () => {
cy.log("Apply breakout to second instance of Count of orders");
H.MetricsViewer.searchBarPills().eq(2).click();
- H.popover().findByText("Break out").click();
+ H.popover().findByText("Add a series breakout").click();
H.popover().findByText("Source").click();
cy.wait("@dataset");
@@ -700,7 +839,7 @@ describe("scenarios > metrics > explorer", () => {
cy.log("Remove breakout from first instance");
H.MetricsViewer.searchBarPills().eq(0).click();
- H.popover().findByText("Remove breakout").click();
+ H.popover().findByText("Remove series breakout").click();
cy.log(
"Legend should still be visible because second instance has breakout",
@@ -742,7 +881,7 @@ describe("scenarios > metrics > explorer", () => {
cy.log("Apply breakout to first instance of Count of orders");
H.MetricsViewer.searchBarPills().eq(0).click();
- H.popover().findByText("Break out").click();
+ H.popover().findByText("Add a series breakout").click();
H.popover().findByText("Source").click();
cy.wait("@dataset");
@@ -760,7 +899,7 @@ describe("scenarios > metrics > explorer", () => {
H.MetricsViewer.searchInput().type("Count of products", {
waitForAnimations: true,
});
- H.MetricsViewer.searchResults().findByText("Count of products").click();
+ selectMetricSearchResult("Count of products");
cy.wait("@getMetric");
cy.findByTestId("run-expression-button").click();
@@ -830,151 +969,114 @@ describe("scenarios > metrics > explorer", () => {
cy.findByRole("menuitem", { name: "rename icon Rename" }).should(
"exist",
);
- cy.findByText(/Break out/).should("not.exist");
- cy.findByText(/Change breakout/).should("not.exist");
- cy.findByText(/Remove breakout/).should("not.exist");
+ cy.findByText(/Add a series breakout/).should("not.exist");
+ cy.findByText(/Change series breakout/).should("not.exist");
+ cy.findByText(/Remove series breakout/).should("not.exist");
});
});
+ });
- it("should show an expression dimension pill with per-metric accordion", () => {
- cy.log("Create expression: Count of orders + Count of products");
- cy.findByTestId("metrics-formula-input").click();
-
- addMetricMath([
- { metricName: "Count of orders" },
- "+",
- { metricName: "Count of products" },
- ]);
- cy.wait("@dataset");
-
- cy.log(
- "Dimension pill bar should contain an expression dimension pill with a selected dimension",
- );
- H.MetricsViewer.getDimensionPillContainer().within(() => {
- cy.findByTestId("expression-dimension-pill").should("exist");
- cy.findByTestId("expression-dimension-pill").should(
- "not.contain.text",
- "Select dimensions",
- );
- });
-
- cy.log("Click the expression dimension pill to open the popover");
- H.MetricsViewer.getDimensionPillContainer()
- .findByTestId("expression-dimension-pill")
+ it("should show an expression dimension pill with per-metric accordion", () => {
+ H.MetricsViewer.goToViewer();
+ cy.log("Create expression: Count of orders + Count of products");
+ addOrdersProductsExpression();
+
+ cy.log(
+ "Dimension pill bar should contain a selected expression dimension label",
+ );
+ showColumnLabels();
+ H.MetricsViewer.getDimensionPillBarContainer()
+ .should("be.visible")
+ .and("not.contain.text", "Select dimensions");
+
+ cy.log("Open the sidebar dimension picker");
+ H.MetricsViewer.openDimensionPickerSidebar();
+
+ cy.log(
+ "All fields should show accordion sections for each metric in the expression",
+ );
+ H.MetricsViewer.dimensionPickerSidebar().within(() => {
+ cy.findByRole("button", { name: "See all" }).click();
+ cy.findByRole("heading", { name: "All fields" }).should("be.visible");
+ cy.findByRole("button", { name: "Count of orders" })
+ .should("be.visible")
+ .and("have.attr", "aria-expanded", "true");
+ cy.findByRole("button", { name: "Count of products" })
+ .scrollIntoView()
+ .should("be.visible")
+ .and("have.attr", "aria-expanded", "false")
.click();
-
- cy.log(
- "Popover should show accordion sections for each metric in the expression",
- );
- H.popover().within(() => {
- cy.findAllByTestId("expression-metric-section").should(
- "have.length",
- 2,
- );
- cy.findAllByTestId("expression-metric-header")
- .eq(0)
- .should("contain.text", "Count of orders");
- cy.findAllByTestId("expression-metric-header")
- .eq(1)
- .should("contain.text", "Count of products");
- });
-
- cy.log(
- "Expand the second metric section and verify dimension options are shown",
+ cy.findAllByRole("button", { name: "Category" }).should(
+ "have.length.at.least",
+ 1,
);
- H.popover().findAllByTestId("expression-metric-header").eq(1).click();
-
- H.popover().within(() => {
- cy.findByText("Birth Date").click();
- });
-
- cy.wait("@dataset");
-
- cy.log("Expression dimension pill should now show 'Multiple dimensions'");
- H.MetricsViewer.getDimensionPillContainer()
- .findByTestId("expression-dimension-pill")
- .should("contain.text", "Multiple dimensions");
});
- it("should preserve non-default expression dimensions after page reload", () => {
- cy.log(
- "Create expression with only expression entity: Count of orders + Count of products",
- );
-
- cy.findByTestId("metrics-formula-input").click();
-
- H.MetricsViewer.searchInput().type(" + Count of products", {
- waitForAnimations: true,
- });
- H.MetricsViewer.searchResults().findByText("Count of products").click();
- cy.wait("@getMetric");
-
- cy.findByTestId("run-expression-button").click();
- cy.wait("@dataset");
-
- cy.log(
- "Open the expression dimension pill and pick a non-default dimension for the second metric",
- );
- H.MetricsViewer.getDimensionPillContainer()
- .findByTestId("expression-dimension-pill")
- .click();
-
- // Expand the second metric accordion section
- H.popover().findAllByTestId("expression-metric-header").eq(1).click();
-
- // Pick a non-default dimension (e.g. "Created At" for Products)
- H.popover().within(() => {
- cy.findByText("Birth Date").click();
- });
-
- cy.wait("@dataset");
-
- cy.log("Verify the pill shows 'Multiple dimensions' (non-default state)");
- H.MetricsViewer.getDimensionPillContainer()
- .findByTestId("expression-dimension-pill")
- .should("contain.text", "Multiple dimensions");
+ cy.log(
+ "Configure the shared Time category and select a non-default dimension",
+ );
+ H.MetricsViewer.dimensionPickerSidebar()
+ .findByRole("button", { name: "Back" })
+ .click();
+ openTimeDimensionConfiguration();
+ H.MetricsViewer.dimensionPickerSidebar()
+ .findByLabelText("Select dimension for Count of orders")
+ .click();
+ cy.findByRole("option", { name: /Birth Date/ }).click();
+
+ cy.wait("@dataset");
+
+ cy.log("Expression dimension pill should now show 'Multiple dimensions'");
+ H.MetricsViewer.getDimensionPillBarContainer().should(
+ "contain.text",
+ "Multiple dimensions",
+ );
+ });
- cy.log(
- "Remember the selected dimension index for the first metric before reload",
+ it("should preserve non-default expression dimensions after page reload", () => {
+ H.MetricsViewer.goToViewer();
+ cy.log(
+ "Create expression with only expression entity: Count of orders + Count of products",
+ );
+ addOrdersProductsExpression();
+ showColumnLabels();
+
+ cy.log("Pick a non-default dimension for one metric in the expression");
+ H.MetricsViewer.openDimensionPickerSidebar();
+ openTimeDimensionConfiguration();
+ H.MetricsViewer.dimensionPickerSidebar()
+ .findByLabelText("Select dimension for Count of orders")
+ .click();
+ cy.findByRole("option", { name: /Birth Date/ }).click();
+
+ cy.wait("@dataset");
+
+ cy.log("Verify the pill shows 'Multiple dimensions' (non-default state)");
+ H.MetricsViewer.getDimensionPillBarContainer().should(
+ "contain.text",
+ "Multiple dimensions",
+ );
+ waitForSerializedDimensionBreakout();
+
+ cy.log("Reload the page and verify the dimension choice persists");
+ cy.reload();
+ cy.wait("@getMetric");
+ cy.wait("@dataset");
+
+ cy.log(
+ "Verify the per-metric dimension selections are restored after reload",
+ );
+ H.MetricsViewer.openDimensionPickerSidebar();
+ openTimeDimensionConfiguration();
+ H.MetricsViewer.dimensionPickerSidebar().within(() => {
+ cy.findByLabelText("Select dimension for Count of orders").should(
+ "have.value",
+ "Birth Date",
);
- H.MetricsViewer.getDimensionPillContainer()
- .findByTestId("expression-dimension-pill")
- .click();
-
- H.popover()
- .find("[data-element-id=list-item]")
- .then(($items) => {
- const selectedIndex = $items
- .toArray()
- .findIndex((el) => el.getAttribute("aria-selected") === "true");
- expect(selectedIndex).to.be.gte(0);
- cy.wrap(selectedIndex).as("firstMetricDimensionIndex");
- });
-
- // Close the popover
- cy.realPress("Escape");
-
- cy.log("Reload the page and verify the dimension choice persists");
- cy.reload();
- cy.wait("@getMetric");
- cy.wait("@dataset");
-
- H.MetricsViewer.getDimensionPillContainer()
- .findByTestId("expression-dimension-pill")
- .should("contain.text", "Multiple dimensions")
- .click();
-
- cy.log(
- "Verify the first metric still has the same selected dimension after reload",
+ cy.findByLabelText("Select dimension for Count of products").should(
+ "have.value",
+ "Created At",
);
-
- cy.get<number>("@firstMetricDimensionIndex").then((expectedIndex) => {
- // eslint-disable-next-line metabase/no-unsafe-element-filtering
- H.popover()
- .find("[data-element-id=list-item]")
- .eq(expectedIndex)
- .should("have.attr", "aria-selected", "true");
- });
});
});
@@ -988,6 +1090,7 @@ describe("scenarios > metrics > explorer", () => {
H.MetricsViewer.goToViewer();
addMetric("Count of orders");
cy.wait("@dataset");
+ H.MetricsViewer.getMetricVisualization().should("be.visible");
});
it("should allow setting a custom name on an expression pill", () => {
@@ -1024,7 +1127,7 @@ describe("scenarios > metrics > explorer", () => {
cy.log("Legend should display the custom expression name");
H.MetricsViewer.breakoutLegend().within(() => {
cy.findAllByText("My Custom Expression")
- .should("exist")
+ .should("be.visible")
.should("have.length", 2);
cy.findByText(/Test Measure/).should("not.exist");
});
@@ -1035,7 +1138,7 @@ describe("scenarios > metrics > explorer", () => {
.eq(4)
.trigger("mousemove", { force: true });
H.echartsTooltip().within(() => {
- cy.findByText("My Custom Expression").should("exist");
+ cy.findByText("My Custom Expression").should("be.visible");
cy.findByText(/Test Measure/).should("not.exist");
});
});
@@ -1084,7 +1187,7 @@ describe("scenarios > metrics > explorer", () => {
H.MetricsViewer.breakoutLegend().within(() => {
cy.findByText("Temporary Name").should("not.exist");
cy.findAllByText("Count of orders + Test Measure")
- .should("exist")
+ .should("be.visible")
.should("have.length", 2);
});
@@ -1097,7 +1200,7 @@ describe("scenarios > metrics > explorer", () => {
.trigger("mousemove", { force: true });
H.echartsTooltip().within(() => {
cy.findByText("Temporary Name").should("not.exist");
- cy.findByText("Count of orders + Test Measure").should("exist");
+ cy.findByText("Count of orders + Test Measure").should("be.visible");
});
});
@@ -1137,7 +1240,7 @@ describe("scenarios > metrics > explorer", () => {
.eq(4)
.trigger("mousemove", { force: true });
H.echartsTooltip().within(() => {
- cy.findByText("My Stable Name").should("exist");
+ cy.findByText("My Stable Name").should("be.visible");
cy.findByText(/Test Measure/).should("not.exist");
});
});
@@ -1203,11 +1306,10 @@ describe("scenarios > metrics > explorer", () => {
// ("Count of orders") is untouched and its MetricIdentity (with
// customName) survives.
H.MetricsViewer.searchInput().type(
- "{end}{backspace}{backspace}{backspace}{backspace} * Count of products",
+ "{end}{backspace}{backspace}{backspace}{backspace}",
{ waitForAnimations: true },
);
- H.MetricsViewer.searchResults().findByText("Count of products").click();
- H.MetricsViewer.runButton().click();
+ addMetricMath(["*", { metricName: "Count of products" }]);
cy.wait("@dataset");
cy.log(
@@ -1245,6 +1347,9 @@ describe("scenarios > metrics > explorer", () => {
.should("contain.text", "First Name");
cy.findByTestId("metrics-formula-input").click();
+ H.MetricsViewer.searchInput().type("{end}, ", {
+ waitForAnimations: true,
+ });
addMetricMath([
{ metricName: "Count of orders" },
"+",
@@ -1278,7 +1383,7 @@ describe("scenarios > metrics > explorer", () => {
"{home}{del}{del}{del}{del}{del}{del}{del}",
{ waitForAnimations: true },
);
- H.MetricsViewer.runButton().click();
+ runFormula();
cy.wait("@dataset");
cy.log(
@@ -1294,19 +1399,72 @@ describe("scenarios > metrics > explorer", () => {
});
// ============================================================================
- // Tabs
+ // Dimension picker sidebar
// ============================================================================
- describe("Tabs", () => {
+ describe("Dimension picker sidebar", () => {
beforeEach(() => {
interceptDatasetQuery();
H.MetricsViewer.goToViewer();
addMetric("Count of orders");
cy.wait("@dataset");
+ H.MetricsViewer.getMetricVisualization().should("be.visible");
});
- it("should switch between tabs", () => {
- //should work with metric math as well
+ it("should open and close from the viewer controls", () => {
+ H.MetricsViewer.getMetricVisualization().should("be.visible");
+
+ H.MetricsViewer.openDimensionPickerSidebar().within(() => {
+ cy.findByRole("heading", { name: "Break out" }).should("be.visible");
+ cy.findByLabelText("Search fields").should("be.visible");
+ cy.findByRole("button", { name: "Time" }).should("be.visible");
+ cy.findByRole("button", { name: "Category" }).should("be.visible");
+ cy.findByRole("button", { name: "Totals" }).should("not.exist");
+ });
+
+ H.MetricsViewer.closeDimensionPickerSidebar();
+ H.MetricsViewer.dimensionPickerSidebar().should("not.exist");
+ H.MetricsViewer.getMetricVisualization().should("be.visible");
+ });
+
+ it("should select and reopen the No breakout state from the viewer controls", () => {
+ H.MetricsViewer.openDimensionPickerSidebar().within(() => {
+ cy.findByRole("button", { name: "No breakout" })
+ .should("be.visible")
+ .and("have.attr", "aria-pressed", "false")
+ .click();
+ });
+ cy.wait("@dataset");
+
+ H.MetricsViewer.dimensionPickerSidebar().within(() => {
+ cy.findByRole("button", { name: "No breakout" }).should(
+ "have.attr",
+ "aria-pressed",
+ "true",
+ );
+ });
+ H.MetricsViewer.assertVizType("Number");
+ H.MetricsViewer.breakoutLegend().should("not.exist");
+
+ H.MetricsViewer.closeDimensionPickerSidebar();
+ H.MetricsViewer.dimensionPickerSidebar().should("not.exist");
+
+ H.MetricsViewer.getMetricControls()
+ .findByRole("button", { name: "No breakout" })
+ .should("be.visible")
+ .click();
+
+ H.MetricsViewer.dimensionPickerSidebar().within(() => {
+ cy.findByRole("heading", { name: "Break out" }).should("be.visible");
+ cy.findByRole("button", { name: "No breakout" }).should(
+ "have.attr",
+ "aria-pressed",
+ "true",
+ );
+ });
+ });
+
+ it("should select dimension categories from the sidebar", () => {
addMetricMath([
{ metricName: "Count of orders" },
"+",
@@ -1314,257 +1472,185 @@ describe("scenarios > metrics > explorer", () => {
]);
cy.wait("@dataset");
- H.MetricsViewer.tabsShouldBe([
- "Created At",
- "State",
- "Title",
- "Category",
- "Totals",
- ]);
H.MetricsViewer.assertVizType("Line");
- switchToTab("State");
+ selectDimensionBreakout("State", { seeAll: true });
+ cy.wait("@dataset");
H.expectUnstructuredSnowplowEvent({
- event: "metrics_viewer_dimension_tab_switched",
+ event: "metrics_viewer_dimension_selected",
});
H.MetricsViewer.assertAllVizTypes("Map", 2);
- switchToTab("Category");
+ selectDimensionBreakout("Category");
+ cy.wait("@dataset");
H.MetricsViewer.assertVizType("Bar");
cy.log("should allow changing display types");
H.MetricsViewer.changeVizType("line");
H.MetricsViewer.assertVizType("Line");
+ });
+
+ it("should keep all fields available while selecting dimensions from See all", () => {
+ H.MetricsViewer.openDimensionPickerSidebar().within(() => {
+ cy.findByRole("button", { name: "See all" }).click();
+ cy.findByRole("heading", { name: "All fields" }).should("be.visible");
+ cy.findByRole("button", { name: "Address" }).should("be.visible");
+ cy.findByRole("button", { name: "City" }).should("be.visible");
+ cy.findByRole("button", { name: "Address" }).click();
+ });
+ cy.wait("@dataset");
- switchToTab("Totals");
- H.MetricsViewer.assertAllVizTypes("Number", 2);
+ H.MetricsViewer.dimensionPickerSidebar().within(() => {
+ cy.findByRole("button", { name: "Address" })
+ .scrollIntoView()
+ .should("be.visible");
+ cy.findByRole("button", { name: "City" })
+ .scrollIntoView()
+ .should("be.visible");
+ cy.findByRole("button", { name: "City" }).click();
+ });
+ cy.wait("@dataset");
+
+ H.MetricsViewer.dimensionPickerSidebar().within(() => {
+ cy.findByRole("button", { name: "Address" })
+ .scrollIntoView()
+ .should("be.visible");
+ cy.findByRole("button", { name: "City" })
+ .scrollIntoView()
+ .should("be.visible");
+ });
});
- it("should not show dimensions that are already in tabs in the dimension picker", () => {
- addMetricMath([
- { metricName: "Count of orders" },
- "+",
- { metricName: "Count of products" },
- ]);
+ it("should only show shared dimensions by default for multiple metric sources", () => {
+ addMetric("Count of feedback");
cy.wait("@dataset");
- H.MetricsViewer.tabsShouldBe([
- "Created At",
- "State",
- "Title",
- "Category",
- ]);
+ verifyMetricCount(2);
- H.MetricsViewer.getAddDimensionButton().click();
- H.popover().within(() => {
- cy.findByText("Rating").should("exist");
- // Created At exists on the users table so would be a false positive
- // testing the other tabs is sufficent
- cy.findByText("State").should("not.exist");
- cy.findByText("Title").should("not.exist");
- cy.findByText("Category").should("not.exist");
+ H.MetricsViewer.openDimensionPickerSidebar()
+ .should("contain.text", "Shared dimensions")
+ .and("contain.text", "Time")
+ .and("not.contain.text", "Rating");
- // metric math should not cause dimensions to be repeated
- cy.findAllByText("Birth Date").should("have.length", 1);
+ H.MetricsViewer.dimensionPickerSidebar()
+ .findByRole("button", { name: "See all" })
+ .click();
- cy.findByText("Rating").click();
+ H.MetricsViewer.dimensionPickerSidebar().within(() => {
+ cy.findByRole("heading", { name: "All fields" }).should("be.visible");
+ cy.findAllByRole("button", { name: "Rating" }).should(
+ "have.length.at.least",
+ 1,
+ );
});
+ });
+
+ it("should configure per-metric dimensions for a shared category", () => {
+ addMetric("Count of products");
+ cy.wait("@dataset");
+
+ H.MetricsViewer.openDimensionPickerSidebar()
+ .findByRole("button", { name: "Time" })
+ .realHover();
+
+ H.MetricsViewer.dimensionPickerSidebar()
+ .findByRole("button", { name: "Configure Time" })
+ .click();
- H.MetricsViewer.getDimensionPillContainer().within(() => {
- cy.findAllByText("Product → Rating").should("exist");
- cy.findAllByText("Multiple dimensions").should("not.exist");
+ H.MetricsViewer.dimensionPickerSidebar()
+ .findByLabelText("Select dimension for Count of orders")
+ .click();
+ cy.findByRole("option", { name: /Birth Date/ }).click();
+ cy.wait("@dataset");
+
+ H.MetricsViewer.dimensionPickerSidebar()
+ .findByLabelText("Select dimension for Count of orders")
+ .should("have.value", "Birth Date");
+ H.MetricsViewer.dimensionPickerSidebar()
+ .findByLabelText("Select dimension for Count of products")
+ .should("have.value", "Created At");
+ });
+
+ it("should render column labels as static text", () => {
+ H.MetricsViewer.getMetricControls()
+ .findByLabelText("Column label options")
+ .click();
+ cy.findByRole("switch", { name: "Show column labels" }).click();
+
+ H.MetricsViewer.getDimensionPillBarContainer().within(() => {
+ cy.findByText("Created At").should("be.visible").click();
+ cy.findByRole("button").should("not.exist");
});
+ H.MetricsViewer.dimensionPickerSidebar().should("not.exist");
});
it("should auto-assign dimensions for a newly added metric after running the formula", () => {
cy.log(
- "After adding a second metric, all dimension pills should have a selected dimension",
+ "After adding a second metric, all dimension labels should have a selected dimension",
);
cy.findByTestId("metrics-formula-input").click();
addMetric("Count of products");
cy.wait("@dataset");
- H.MetricsViewer.getDimensionPillContainer().within(() => {
- cy.findAllByText("Select a dimension").should("not.exist");
- });
-
- cy.log(
- "Switch to another tab and verify dimensions are assigned there too",
+ H.MetricsViewer.getColumnPickerButton().should(
+ "not.contain.text",
+ "Select a dimension",
);
- switchToTab("Category");
- H.MetricsViewer.getDimensionPillContainer().within(() => {
- cy.findAllByText("Select a dimension").should("not.exist");
- });
- });
-
- it("should map shared dimensions to all metrics when adding a tab from the picker", () => {
- addMetric("Count of products");
- cy.wait("@dataset");
- H.MetricsViewer.getAddDimensionButton().click();
- H.popover().within(() => {
- cy.findByText("Shared").should("exist");
- cy.findByText("Rating").click();
- });
+ selectDimensionBreakout("Category");
cy.wait("@dataset");
-
- H.MetricsViewer.tablist()
- .findByRole("tab", { name: "Rating" })
- .should("have.attr", "aria-selected", "true");
-
- H.MetricsViewer.getDimensionPillContainer().within(() => {
- cy.findAllByText("Select a dimension").should("not.exist");
- });
+ H.MetricsViewer.getColumnPickerButton().should(
+ "not.contain.text",
+ "Select a dimension",
+ );
});
- it("should remove then re-add the totals tab", () => {
- //should work with metric math as well
+ it("should preserve a selected dimension after page reload", () => {
addMetricMath([
{ metricName: "Count of orders" },
"+",
- { metricName: "Test Measure" },
+ { metricName: "Count of products" },
]);
cy.wait("@dataset");
- // Need to hover the tab so that the remove button is accessible
- H.MetricsViewer.tablist()
- .findByRole("tab", { name: "Totals" })
- .realHover();
- H.MetricsViewer.getRemoveTabButton("Totals").click();
- H.MetricsViewer.tablist()
- .findByRole("tab", { name: "Totals" })
- .should("not.exist");
-
- H.MetricsViewer.getAddDimensionButton().click();
- H.popover().within(() => {
- cy.findAllByText("Totals").click();
- });
+ selectDimensionBreakout("Category");
cy.wait("@dataset");
-
- cy.log("totals tab should be selected and show correct viz type");
- H.MetricsViewer.tablist()
- .findByRole("tab", { name: "Totals" })
- .should("have.attr", "aria-selected", "true");
- H.MetricsViewer.assertAllVizTypes("Number", 2);
- });
-
- it("should add a dimension tab and remove it", () => {
- addMetric("Count of feedback");
- H.MetricsViewer.tabsShouldBe([
- "Created At",
- "State",
- "Title",
+ H.MetricsViewer.getColumnPickerButton().should(
+ "contain.text",
"Category",
- ]);
-
- cy.log("assert that both feedback and order dimensions are available");
- H.MetricsViewer.getAddDimensionButton().click();
- H.popover().within(() => {
- cy.findAllByText(/count of orders/i).should("have.length", 3);
- cy.findAllByText(/count of feedback/i).should("have.length", 2);
- cy.log("add a new dimension tab");
+ );
- cy.findByPlaceholderText(/Find/).should("be.visible");
- cy.findAllByText("Source").should("have.length", 2).eq(0).click();
- });
+ cy.reload();
cy.wait("@dataset");
-
- H.MetricsViewer.tabsShouldBe([
- "Created At",
- "State",
- "Title",
+ H.MetricsViewer.getColumnPickerButton().should(
+ "contain.text",
"Category",
- "Source",
- ]);
-
- H.expectUnstructuredSnowplowEvent({
- event: "metrics_viewer_dimension_tab_added",
- });
-
- cy.log("new tab should be selected and show correct viz type");
- H.MetricsViewer.tablist()
- .findByRole("tab", { name: "Source" })
- .should("have.attr", "aria-selected", "true");
- H.MetricsViewer.assertVizType("Bar");
-
- cy.log("should only show me metrics that share the dimension of the tab");
- H.MetricsViewer.getMetricVisualization().within(() => {
- cy.findByText("Affiliate").should("exist");
- cy.findByText("Facebook").should("exist");
- cy.findByText("Google").should("exist");
- cy.findByText("Organic").should("exist");
- cy.findByText("Twitter").should("exist");
- cy.findByText("Basic").should("not.exist");
- cy.findByText("Business").should("not.exist");
- cy.findByText("Premium").should("not.exist");
- });
- H.MetricsViewer.getDimensionPillContainer().within(() => {
- cy.findByText("User → Source").should("exist");
- cy.findByText("Account → Source").click();
- });
-
- H.popover().findByText("Plan").click();
-
- H.MetricsViewer.getMetricVisualization().within(() => {
- cy.findByText("Affiliate").should("exist");
- cy.findByText("Facebook").should("exist");
- cy.findByText("Google").should("exist");
- cy.findByText("Organic").should("exist");
- cy.findByText("Twitter").should("exist");
- cy.findByText("Basic").should("exist");
- cy.findByText("Business").should("exist");
- cy.findByText("Premium").should("exist");
- });
-
- cy.log("shared dimensions should automatically be added to tabs");
- switchToTab("Created At");
-
- H.MetricsViewer.getDimensionPillContainer().within(() => {
- cy.findByText("Created At").should("exist");
- cy.findByText("Account → Created At").click();
- });
-
- H.popover().findByText("Canceled At").click();
- H.MetricsViewer.getDimensionPillContainer()
- .findByText("Account → Canceled At")
- .should("exist");
+ );
+ });
- cy.log("remove the added tab");
+ it("should serialize only the selected dimension breakout in the URL", () => {
+ selectDimensionBreakout("State", { seeAll: true });
+ cy.wait("@dataset");
- // Need to hover the tab so that the remove button is accessible
- H.MetricsViewer.tablist()
- .findByRole("tab", { name: "Source" })
- .realHover();
- H.MetricsViewer.getRemoveTabButton("Source").click();
- H.MetricsViewer.tablist()
- .findByRole("tab", { name: "Source" })
- .should("not.exist");
- H.MetricsViewer.tabsShouldBe([
- "Created At",
- "State",
- "Title",
- "Category",
- ]);
+ selectDimensionBreakout("Category");
+ cy.wait("@dataset");
- H.expectUnstructuredSnowplowEvent({
- event: "metrics_viewer_dimension_tab_removed",
+ getMetricsViewerUrlState().then((state) => {
+ expect(state.t).to.have.length(1);
+ const [breakout] = state.t ?? [];
+ if (!breakout) {
+ throw new Error("Expected one serialized dimension breakout");
+ }
+ expect(breakout).to.include({ t: "category", l: "Category" });
+ expect(state.a).to.equal(breakout.i);
});
- cy.log("navigating back should undo changes");
-
- cy.go("back");
- H.MetricsViewer.tabsShouldBe([
- "Created At",
- "State",
- "Title",
+ cy.reload();
+ cy.wait("@dataset");
+ H.MetricsViewer.getColumnPickerButton().should(
+ "contain.text",
"Category",
- "Source",
- ]);
- cy.go("back");
- H.MetricsViewer.getDimensionPillContainer().within(() => {
- cy.findByText("Created At").should("exist");
- cy.findByText("Account → Created At").should("exist");
- });
+ );
});
});
@@ -1589,7 +1675,8 @@ describe("scenarios > metrics > explorer", () => {
H.MetricsViewer.getAllMetricVisualizations().should("have.length", 1);
cy.log("bar charts also support multiple series");
- switchToTab("Category");
+ selectDimensionBreakout("Category");
+ cy.wait("@dataset");
H.MetricsViewer.assertVizType("Bar");
H.MetricsViewer.getAllMetricVisualizations().should("have.length", 1);
});
@@ -1615,19 +1702,22 @@ describe("scenarios > metrics > explorer", () => {
H.splitPanelAxisLines().should("have.length", 0);
cy.log("button should not be visible for non-line/area/bar charts");
- switchToTab("State");
+ selectDimensionBreakout("State", { seeAll: true });
+ cy.wait("@dataset");
H.MetricsViewer.assertVizType("Map");
cy.findByTestId("chart-layout-picker").should("not.exist");
});
it("should automatically split for display types that do not support multiple series", () => {
cy.log("with a single series, map shows one visualization");
- switchToTab("State");
+ selectDimensionBreakout("State");
+ cy.wait("@dataset");
H.MetricsViewer.assertVizType("Map");
H.MetricsViewer.getAllMetricVisualizations().should("have.length", 1);
cy.log("add a breakout to create multiple series");
- switchToTab("Created At");
+ selectDimensionBreakout("Time");
+ cy.wait("@dataset");
selectBreakout("Count of orders", "Source");
cy.wait("@dataset");
@@ -1635,7 +1725,8 @@ describe("scenarios > metrics > explorer", () => {
H.MetricsViewer.getAllMetricVisualizations().should("have.length", 1);
cy.log("map does not support multiple series, so should auto-split");
- switchToTab("State");
+ selectDimensionBreakout("State");
+ cy.wait("@dataset");
H.MetricsViewer.getAllMetricVisualizations().should(
"have.length.greaterThan",
1,
@@ -1696,7 +1787,8 @@ describe("scenarios > metrics > explorer", () => {
.should("contain.text", "Gadget")
.should("contain.text", "Gizmo");
- switchToTab("Category");
+ selectDimensionBreakout("Category");
+ cy.wait("@dataset");
H.MetricsViewer.getMetricVisualization().should(
"contain.text",
"Doohickey",
@@ -1705,14 +1797,14 @@ describe("scenarios > metrics > explorer", () => {
cy.log("filter on a per tab level");
- H.MetricsViewer.getMerticControls()
+ H.MetricsViewer.getMetricControls()
.findByRole("button", { name: /All values/ })
.click();
H.popover().findByText("Doohickey").click();
H.popover().findByRole("button", { name: "Add filter" }).click();
- H.MetricsViewer.getMerticControls().findByRole("button", {
+ H.MetricsViewer.getMetricControls().findByRole("button", {
name: /is Doohickey/,
});
H.MetricsViewer.getMetricVisualization().should(
@@ -1730,7 +1822,8 @@ describe("scenarios > metrics > explorer", () => {
});
cy.log("remove filter");
- switchToTab("State");
+ selectDimensionBreakout("State");
+ cy.wait("@dataset");
H.MetricsViewer.getAllMetricVisualizations().should("have.length", 3);
H.MetricsViewer.getAllFilterPills()
@@ -1754,32 +1847,31 @@ describe("scenarios > metrics > explorer", () => {
H.MetricsViewer.getAllMetricVisualizations().should("have.length", 3);
H.MetricsViewer.getAllFilterPills().should("have.length", 1);
- // switch back to category tab
+ cy.log("navigate back to the category dimension");
cy.go("back");
- H.MetricsViewer.getTab("Category").should(
- "have.attr",
- "aria-selected",
- "true",
+ H.MetricsViewer.getColumnPickerButton().should(
+ "contain.text",
+ "Category",
);
- // Remove tab filter
+ cy.log("remove the dimension filter");
cy.go("back");
H.MetricsViewer.getMetricVisualization().should(
"contain.text",
"Doohickey",
);
H.MetricsViewer.getMetricVisualization().should("contain.text", "Gizmo");
- H.MetricsViewer.getMerticControls()
+ H.MetricsViewer.getMetricControls()
.findByRole("button", { name: /All values/ })
- .should("exist");
+ .should("be.visible");
cy.log("navigating forward should re-apply changes");
- // re-apply tab filter
+ cy.log("re-apply the dimension filter");
cy.go("forward");
- H.MetricsViewer.getMerticControls()
+ H.MetricsViewer.getMetricControls()
.findByRole("button", { name: /is Doohickey/ })
- .should("exist");
+ .should("be.visible");
H.MetricsViewer.getMetricVisualization().should(
"contain.text",
"Doohickey",
@@ -1788,15 +1880,11 @@ describe("scenarios > metrics > explorer", () => {
"not.contain.text",
"Gizmo",
);
- // change tab back to state
+ cy.log("change dimension back to State");
cy.go("forward");
- H.MetricsViewer.getTab("State").should(
- "have.attr",
- "aria-selected",
- "true",
- );
+ H.MetricsViewer.getColumnPickerButton().should("contain.text", "State");
H.MetricsViewer.getAllMetricVisualizations().should("have.length", 3);
- // remove global filter
+ cy.log("remove global filter");
cy.go("forward");
H.MetricsViewer.getAllMetricVisualizations().should("have.length", 4);
H.MetricsViewer.getAllFilterPills().should("have.length", 0);
@@ -1804,7 +1892,8 @@ describe("scenarios > metrics > explorer", () => {
it("should allow me to apply filters to each metric individually", () => {
addMetric("Count of products");
- switchToTab("Category");
+ selectDimensionBreakout("Category");
+ cy.wait("@dataset");
H.MetricsViewer.changeVizType("line");
H.MetricsViewer.getMetricVisualizationDataPoints().should(
"have.length",
@@ -1829,15 +1918,16 @@ describe("scenarios > metrics > explorer", () => {
);
cy.log(
- "Should allow me to change time granularity and range on time based tabs",
+ "Should allow me to change time granularity and range on time based dimensions",
);
- switchToTab("Created At");
+ selectDimensionBreakout("Time");
+ cy.wait("@dataset");
H.MetricsViewer.getMetricVisualizationDataPoints().should(
"have.length",
85,
);
- H.MetricsViewer.getMerticControls()
+ H.MetricsViewer.getMetricControls()
.findByRole("button", { name: /by month/i })
.click();
H.popover().findByText("Year").click();
@@ -1845,12 +1935,12 @@ describe("scenarios > metrics > explorer", () => {
"have.length",
9,
);
- H.MetricsViewer.getMerticControls()
+ H.MetricsViewer.getMetricControls()
.findByRole("button", { name: /by year/i })
.click();
H.popover().findByText("Month").click();
- H.MetricsViewer.getMerticControls()
+ H.MetricsViewer.getMetricControls()
.findByRole("button", { name: /All time/i })
.click();
@@ -1873,7 +1963,7 @@ describe("scenarios > metrics > explorer", () => {
);
cy.log("edit the dimension filter to change the date range");
- H.MetricsViewer.getMerticControls()
+ H.MetricsViewer.getMetricControls()
.findByRole("button", { name: /February/i })
.click();
H.popover().within(() => {
@@ -1888,7 +1978,7 @@ describe("scenarios > metrics > explorer", () => {
triggered_from: "dimension_filter",
});
- H.MetricsViewer.getMerticControls()
+ H.MetricsViewer.getMetricControls()
.findByRole("button", { name: /January/i })
.click();
H.popover().findByRole("button", { name: "Clear" }).click();
@@ -1920,7 +2010,7 @@ describe("scenarios > metrics > explorer", () => {
expect(Object.keys(colorsBefore).length).to.be.greaterThan(0);
});
- H.MetricsViewer.getMerticControls()
+ H.MetricsViewer.getMetricControls()
.findByRole("button", { name: /All time/i })
.click();
H.popover()
@@ -1961,15 +2051,14 @@ describe("scenarios > metrics > explorer", () => {
cy.log("Chart series colors should match legend colors");
for (const hex of legendHexColors) {
- H.echartsContainer().find(`path[stroke="${hex}"]`).should("exist");
+ H.echartsContainer()
+ .find(`path[stroke="${hex}"]`)
+ .should("be.visible");
}
cy.log("Search pill color indicator should match legend count");
H.MetricsViewer.searchBarPills()
- .contains(
- "[data-testid=metrics-viewer-search-pill]",
- "Count of orders",
- )
+ .contains("[data-testid=metrics-viewer-pill]", "Count of orders")
.findByTestId("color-indicator-container")
.children()
.should("have.length", legendHexColors.length);
@@ -2058,9 +2147,9 @@ describe("scenarios > metrics > explorer", () => {
});
it("should drill into more granular time dimensions on timeseries chart", () => {
- H.MetricsViewer.getMerticControls()
+ H.MetricsViewer.getMetricControls()
.findByRole("button", { name: /by month/ })
- .should("exist");
+ .should("be.visible");
// this is messy, but adding the metric math expression causes the viz to unmount and dispose the ECharts instance
// if you click on the chart while it's being disposed, the click isn't handled properly
cy.wait(1000);
@@ -2070,9 +2159,9 @@ describe("scenarios > metrics > explorer", () => {
.click();
H.popover().findByText("See this month by week").click();
- H.MetricsViewer.getMerticControls()
+ H.MetricsViewer.getMetricControls()
.findByRole("button", { name: /by week/ })
- .should("exist");
+ .should("be.visible");
H.MetricsViewer.getMetricVisualizationDataPoints().should(
"have.length",
10,
@@ -2133,8 +2222,7 @@ describe("scenarios > metrics > explorer", () => {
});
it("should apply filters and dimensions to individual metric instances within expressions", () => {
- selectBreakout("Count of orders", "Category");
- cy.wait("@dataset");
+ H.MetricsViewer.searchInput().clear();
addMetricMath([
{ metricName: "Count of orders" },
"+",
@@ -2142,38 +2230,36 @@ describe("scenarios > metrics > explorer", () => {
]);
cy.wait("@dataset");
+ selectDimensionBreakout("Category");
+ cy.wait("@dataset");
+
H.MetricsViewer.getFilterButton().click();
H.popover().within(() => {
- cy.findAllByText("Count of orders")
- .should("have.length", 3)
- .eq(1)
+ cy.findAllByRole("button", { name: /Count of orders/ })
+ .should("have.length", 2)
+ .eq(0)
.click();
cy.findByText("Category").click();
cy.findByText("Doohickey").click();
cy.button("Add filter").click();
});
+ cy.wait("@dataset");
H.MetricsViewer.getFilterButton().click();
H.popover().within(() => {
- cy.findAllByText("Count of orders").eq(2).click();
+ cy.findAllByRole("button", { name: /Count of orders/ })
+ .eq(1)
+ .click();
cy.findByText("Category").click();
- cy.findByText("Gadget").click();
+ cy.findByText("Doohickey").click();
cy.button("Add filter").click();
});
- H.MetricsViewer.getMerticControls()
- .findByRole("button", { name: /All time/i })
- .click();
- H.popover().findByText("Previous 12 months").click();
-
+ cy.wait("@dataset");
function assertMetricMath() {
cy.log("breakout is applied");
- H.MetricsViewer.searchBarPills()
- .contains(
- "[data-testid=metrics-viewer-search-pill]",
- "Count of orders",
- )
- .findByTestId("color-indicator-container")
- .children()
- .should("have.length", 4);
+ H.MetricsViewer.getColumnPickerButton().should(
+ "contain.text",
+ "Category",
+ );
cy.log(
"filter pills are in place and show the badge indicating the unique metric instance",
);
@@ -2186,33 +2272,29 @@ describe("scenarios > metrics > explorer", () => {
H.MetricsViewer.getAllFilterPills()
.eq(1)
.findByText("2")
- .should("exist");
+ .should("be.visible");
cy.log("dimension filter is applied");
H.MetricsViewer.getMetricVisualizationDataPoints().should(
"have.length.of.at.most",
60,
);
- switchToTab("Totals");
- cy.log("correct value is calculated from metric math expression");
- H.MetricsViewer.getAllMetricVisualizations()
- .should("have.length", 5)
- .eq(4)
- .contains("8,915");
- switchToTab("Created At");
+ cy.log("metric math expression still renders with the applied state");
+ H.MetricsViewer.getMetricVisualization().should("be.visible");
}
assertMetricMath();
cy.log("refresh and assert again");
cy.reload();
+ cy.wait("@dataset");
assertMetricMath();
cy.log("edit formula and assert again");
H.MetricsViewer.searchInput().type("{end} + 0", {
waitForAnimations: true,
- delay: 100,
});
- H.MetricsViewer.runButton().click();
+ runFormula();
+ cy.wait("@dataset");
assertMetricMath();
});
@@ -2229,19 +2311,15 @@ describe("scenarios > metrics > explorer", () => {
display: "scalar",
});
- cy.log("Add numeric metric '123' as standalone");
- addMetric("123");
- cy.wait("@dataset");
-
cy.log("Sum metric '123' with itself — both selected from dropdown");
- cy.findByTestId("metrics-formula-input").click();
- H.MetricsViewer.searchInput().type(` + ${NUMERIC_METRIC_NAME}`, {
- waitForAnimations: true,
- });
- H.MetricsViewer.searchResults().findByText(NUMERIC_METRIC_NAME).click();
- H.MetricsViewer.runButton().click();
+ H.MetricsViewer.searchInput().clear();
+ addMetricMath([
+ { metricName: NUMERIC_METRIC_NAME },
+ "+",
+ { metricName: NUMERIC_METRIC_NAME },
+ ]);
cy.wait("@dataset");
- H.MetricsViewer.getMetricVisualization().should("exist");
+ H.MetricsViewer.getMetricVisualization().should("be.visible");
cy.log(
"Append literal number 123 — typed without selecting from dropdown",
@@ -2250,22 +2328,23 @@ describe("scenarios > metrics > explorer", () => {
H.MetricsViewer.searchInput().type(" + 123", {
waitForAnimations: true,
});
- H.MetricsViewer.runButton().click();
+ runFormula();
cy.wait("@dataset");
- H.MetricsViewer.getMetricVisualization().should("exist");
+ H.MetricsViewer.getMetricVisualization().should("be.visible");
cy.log("Append metric '123' as standalone — selected from dropdown");
- addMetric("123");
+ H.MetricsViewer.searchInput().type(`{end}, ${NUMERIC_METRIC_NAME}`, {
+ waitForAnimations: true,
+ });
+ selectMetricSearchResult(NUMERIC_METRIC_NAME);
+ runFormula();
cy.wait("@dataset");
- H.MetricsViewer.getMetricVisualization().should("exist");
+ H.MetricsViewer.getAllMetricVisualizations().should("have.length", 2);
cy.log("Verify final pill layout");
- H.MetricsViewer.searchBarPills().should("have.length", 3);
- H.MetricsViewer.searchBarPills()
- .eq(0)
- .should("contain", "Count of orders");
- H.MetricsViewer.searchBarPills().eq(1).should("contain", "123 + 123");
- H.MetricsViewer.searchBarPills().eq(2).should("contain", "123");
+ H.MetricsViewer.searchBarPills().should("have.length", 2);
+ H.MetricsViewer.searchBarPills().eq(0).should("contain", "123 + 123");
+ H.MetricsViewer.searchBarPills().eq(1).should("contain", "123");
});
});
});
diff --git a/frontend/src/metabase-types/api/icon.ts b/frontend/src/metabase-types/api/icon.ts
index 0bda3c41f9e..98d74ce0080 100644
--- a/frontend/src/metabase-types/api/icon.ts
+++ b/frontend/src/metabase-types/api/icon.ts
@@ -240,6 +240,7 @@ export type IconName =
| "sidebar_open"
| "slack"
| "slack_colorized"
+ | "sliders"
| "smartscalar"
| "snail"
| "snippet"
diff --git a/frontend/src/metabase/common/components/SourceColorIndicator/SourceColorIndicator.tsx b/frontend/src/metabase/common/components/SourceColorIndicator/SourceColorIndicator.tsx
index 8a71e1894ab..13c7fd89325 100644
--- a/frontend/src/metabase/common/components/SourceColorIndicator/SourceColorIndicator.tsx
+++ b/frontend/src/metabase/common/components/SourceColorIndicator/SourceColorIndicator.tsx
@@ -25,6 +25,7 @@ export function SourceColorIndicator({
<Box
key={index}
className={S.colorDot}
+ data-testid="color-indicator"
w={size}
h={size}
ml={index === 0 ? 0 : -overlap}
@@ -34,24 +35,29 @@ export function SourceColorIndicator({
</Flex>
);
}
+
const color = colors?.[0] ?? "var(--mb-color-text-primary)";
- if (fallbackIcon) {
- return (
- <Flex align="center" data-testid="color-indicator-container">
- <Icon name={fallbackIcon} size={size} style={{ color }} />
- </Flex>
- );
- }
+
return (
<Flex align="center" data-testid="color-indicator-container">
- <Box
- className={S.colorDot}
- w={size}
- h={size}
- style={{
- backgroundColor: color,
- }}
- />
+ {fallbackIcon ? (
+ <Icon
+ name={fallbackIcon}
+ data-testid="color-indicator"
+ size={size}
+ style={{ color }}
+ />
+ ) : (
+ <Box
+ className={S.colorDot}
+ data-testid="color-indicator"
+ w={size}
+ h={size}
+ style={{
+ backgroundColor: color,
+ }}
+ />
+ )}
</Flex>
);
}
diff --git a/frontend/src/metabase/metrics-viewer/analytics.ts b/frontend/src/metabase/metrics-viewer/analytics.ts
index b8ef4655dbe..3fc6bfffe23 100644
--- a/frontend/src/metabase/metrics-viewer/analytics.ts
+++ b/frontend/src/metabase/metrics-viewer/analytics.ts
@@ -47,21 +47,9 @@ export const trackMetricsViewerFilterRemoved = (
});
};
-export const trackMetricsViewerDimensionTabAdded = () => {
+export const trackMetricsViewerDimensionSelected = () => {
trackSimpleEvent({
- event: "metrics_viewer_dimension_tab_added",
- });
-};
-
-export const trackMetricsViewerDimensionTabSwitched = () => {
- trackSimpleEvent({
- event: "metrics_viewer_dimension_tab_switched",
- });
-};
-
-export const trackMetricsViewerDimensionTabRemoved = () => {
- trackSimpleEvent({
- event: "metrics_viewer_dimension_tab_removed",
+ event: "metrics_viewer_dimension_selected",
});
};
diff --git a/frontend/src/metabase/metrics-viewer/components/BreakoutDimensionPicker/BreakoutDimensionPicker.tsx b/frontend/src/metabase/metrics-viewer/components/BreakoutDimensionPicker/BreakoutDimensionPicker.tsx
index f01bff931f1..be716f3f62e 100644
--- a/frontend/src/metabase/metrics-viewer/components/BreakoutDimensionPicker/BreakoutDimensionPicker.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/BreakoutDimensionPicker/BreakoutDimensionPicker.tsx
@@ -14,7 +14,7 @@ import { Flex, Icon } from "metabase/ui";
import type { MetricDefinition, ProjectionClause } from "metabase-lib/metric";
import * as LibMetric from "metabase-lib/metric";
-import { getDimensionsByType } from "../../utils/tabs";
+import { getDimensionsByType } from "../../utils/dimension-breakouts";
import S from "./BreakoutDimensionPicker.module.css";
import { DimensionBinningPicker } from "./DimensionBinningPicker";
diff --git a/frontend/src/metabase/metrics-viewer/components/BreakoutLegend/BreakoutLegend.tsx b/frontend/src/metabase/metrics-viewer/components/BreakoutLegend/BreakoutLegend.tsx
index 6d2fd505cc5..3df93871bc9 100644
--- a/frontend/src/metabase/metrics-viewer/components/BreakoutLegend/BreakoutLegend.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/BreakoutLegend/BreakoutLegend.tsx
@@ -1,28 +1,16 @@
import { useMemo } from "react";
+import { useMetricsViewerContext } from "metabase/metrics-viewer/context";
import { Box, Flex, Paper, Stack, Text, Title } from "metabase/ui";
-import type {
- MetricSourceId,
- MetricsViewerDefinitionEntry,
- MetricsViewerFormulaEntity,
- SourceBreakoutColorMap,
-} from "../../types/viewer-state";
import { buildLegendGroups } from "../../utils/legend";
import S from "./BreakoutLegend.module.css";
-type BreakoutLegendProps = {
- formulaEntities: MetricsViewerFormulaEntity[];
- definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>;
- activeBreakoutColors: SourceBreakoutColorMap;
-};
+export function BreakoutLegend() {
+ const { formulaEntities, definitions, activeBreakoutColors } =
+ useMetricsViewerContext();
-export function BreakoutLegend({
- formulaEntities,
- definitions,
- activeBreakoutColors,
-}: BreakoutLegendProps) {
const groups = useMemo(
() => buildLegendGroups(formulaEntities, definitions, activeBreakoutColors),
[formulaEntities, definitions, activeBreakoutColors],
@@ -39,7 +27,7 @@ export function BreakoutLegend({
pt="md"
pr="lg"
pb="md"
- pl={0}
+ pl="sm"
data-testid="metrics-viewer-breakout-legend"
>
<Paper withBorder radius="md" p="lg">
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/DimensionPickerSidebar.module.css b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/DimensionPickerSidebar.module.css
new file mode 100644
index 00000000000..2951d9d5aa2
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/DimensionPickerSidebar.module.css
@@ -0,0 +1,58 @@
+.root {
+ display: flex;
+ flex: 0 0 20.5rem;
+ flex-direction: column;
+ width: 20.5rem;
+ min-height: 0;
+ background-color: var(--mb-color-background-primary);
+}
+
+.searchInput {
+ border-radius: var(--mantine-radius-md);
+ font-size: var(--mantine-font-size-md);
+}
+
+.noBreakoutSection {
+ margin-top: 0.5rem;
+ padding-top: 1rem;
+ border-top: 1px solid var(--mb-color-border);
+}
+
+.noBreakoutButton {
+ display: grid;
+ grid-template-columns: 1rem minmax(0, 1fr);
+ gap: 0.5rem;
+ align-items: center;
+ width: 100%;
+ height: 2rem;
+ padding-inline: 0.5rem;
+ border-radius: 0.5rem;
+ color: var(--mb-color-text-primary);
+ font-size: 0.875rem;
+ line-height: 1rem;
+
+ &.selected {
+ background-color: var(--mb-color-background-selected);
+ color: var(--mb-color-text-brand);
+ }
+
+ &:hover,
+ &.selected:hover {
+ background-color: var(--mb-color-background-hover);
+ }
+}
+
+.noBreakoutIcon {
+ color: currentcolor;
+}
+
+.noBreakoutLabel {
+ overflow: hidden;
+ color: currentcolor;
+ font-size: 0.875rem;
+ font-weight: 500;
+ line-height: 1rem;
+ text-align: left;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/DimensionPickerSidebar.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/DimensionPickerSidebar.tsx
new file mode 100644
index 00000000000..7b377ab764d
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/DimensionPickerSidebar.tsx
@@ -0,0 +1,381 @@
+import cx from "classnames";
+import { useCallback, useMemo, useState } from "react";
+import { t } from "ttag";
+
+import { trackMetricsViewerDimensionSelected } from "metabase/metrics-viewer/analytics";
+import { useMetricsViewerContext } from "metabase/metrics-viewer/context";
+import type { MetricsViewerDimensionBreakoutState } from "metabase/metrics-viewer/types";
+import {
+ type DimensionPickerItem,
+ type DimensionPickerSidebarCategory,
+ getComparableDimensionMapping,
+ getDimensionBreakoutConfig,
+ getScalarDimensionBreakoutLabel,
+} from "metabase/metrics-viewer/utils";
+import {
+ ActionIcon,
+ Box,
+ Button,
+ Flex,
+ Icon,
+ ScrollArea,
+ Stack,
+ Text,
+ TextInput,
+ Title,
+ UnstyledButton,
+} from "metabase/ui";
+
+import S from "./DimensionPickerSidebar.module.css";
+import { AllFieldsList } from "./components/AllFieldsList";
+import { CategoryItem } from "./components/CategoryItem";
+import { useDimensionPickerSidebarCategories } from "./hooks/useDimensionPickerSidebarCategories";
+import { useDimensionPickerSidebarSections } from "./hooks/useDimensionPickerSidebarSections";
+import {
+ filterSections,
+ getDimensionBreakoutId,
+ getSelectedCategoryKey,
+ hasMultipleMetricSources,
+ hasSameDimensions,
+ isCategorySelected,
+ isMatchingActiveDimensionBreakout,
+} from "./utils";
+
+type SidebarMode = "default" | "all";
+
+type DimensionPickerSidebarProps = {
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState;
+};
+
+export function DimensionPickerSidebar(props: DimensionPickerSidebarProps) {
+ const { activeDimensionBreakout } = props;
+ const {
+ metricSlots,
+ sourceColors,
+ sourceDataById,
+ selectDimensionBreakout: onSelectDimensionBreakout,
+ updateActiveDimensionBreakout: onUpdateActiveDimensionBreakout,
+ closeSidebar,
+ } = useMetricsViewerContext();
+ const [searchText, setSearchText] = useState("");
+ const [mode, setMode] = useState<SidebarMode>("default");
+ const [expandedCategoryKey, setExpandedCategoryKey] = useState<string | null>(
+ null,
+ );
+
+ const categories = useDimensionPickerSidebarCategories();
+ const sections = useDimensionPickerSidebarSections();
+
+ const filteredSections = useMemo(
+ () => filterSections(sections, searchText),
+ [sections, searchText],
+ );
+
+ const selectedDimensionBreakoutCategoryKey = getSelectedCategoryKey(
+ categories,
+ activeDimensionBreakout,
+ );
+ const showAllFields = mode === "all" || searchText.trim() !== "";
+ const hasAllFields = sections.length > 0;
+ const showSeeAll = !showAllFields && hasAllFields;
+ let defaultEmptyStateText = t`No dimensions found`;
+ let defaultSectionHeader = t`Dimensions`;
+
+ if (hasMultipleMetricSources(metricSlots)) {
+ defaultEmptyStateText = t`No shared dimensions found`;
+ defaultSectionHeader = t`Shared dimensions`;
+ }
+
+ const handleSelect = useCallback(
+ (item: DimensionPickerItem) => {
+ if (hasSameDimensions(item, activeDimensionBreakout)) {
+ return;
+ }
+
+ const dimensionBreakoutConfig = getDimensionBreakoutConfig(
+ item.dimensionBreakoutInfo.type,
+ );
+ if (
+ activeDimensionBreakout.type === item.dimensionBreakoutInfo.type &&
+ dimensionBreakoutConfig.matchMode === "aggregate"
+ ) {
+ onUpdateActiveDimensionBreakout({
+ dimensionMapping: item.dimensionBreakoutInfo.dimensionMapping,
+ label: item.dimensionBreakoutInfo.label,
+ });
+ trackMetricsViewerDimensionSelected();
+ return;
+ }
+
+ onSelectDimensionBreakout(item.dimensionBreakoutInfo);
+ trackMetricsViewerDimensionSelected();
+ },
+ [
+ activeDimensionBreakout,
+ onUpdateActiveDimensionBreakout,
+ onSelectDimensionBreakout,
+ ],
+ );
+
+ const handleAllFieldsSelect = useCallback(
+ (item: DimensionPickerItem) => {
+ if (isMatchingActiveDimensionBreakout(item, activeDimensionBreakout)) {
+ return;
+ }
+
+ const dimensionMapping = getComparableDimensionMapping({
+ item,
+ sections,
+ metricSlots,
+ activeDimensionBreakout,
+ });
+ const dimensionBreakoutId = getDimensionBreakoutId(item);
+ const dimensionBreakoutConfig = getDimensionBreakoutConfig(
+ item.dimensionBreakoutInfo.type,
+ );
+ if (
+ activeDimensionBreakout.type === item.dimensionBreakoutInfo.type &&
+ dimensionBreakoutConfig.matchMode === "aggregate"
+ ) {
+ onUpdateActiveDimensionBreakout({
+ dimensionMapping,
+ label: item.dimensionBreakoutInfo.label,
+ });
+ trackMetricsViewerDimensionSelected();
+ return;
+ }
+
+ onSelectDimensionBreakout({
+ ...item.dimensionBreakoutInfo,
+ ...(dimensionBreakoutId ? { id: dimensionBreakoutId } : {}),
+ dimensionMapping,
+ });
+ trackMetricsViewerDimensionSelected();
+ },
+ [
+ activeDimensionBreakout,
+ onUpdateActiveDimensionBreakout,
+ onSelectDimensionBreakout,
+ sections,
+ metricSlots,
+ ],
+ );
+
+ const handleCategorySelect = useCallback(
+ (category: DimensionPickerSidebarCategory) => {
+ if (expandedCategoryKey !== category.key) {
+ setExpandedCategoryKey(null);
+ }
+
+ if (isCategorySelected(category, activeDimensionBreakout)) {
+ return;
+ }
+
+ handleSelect(category);
+ },
+ [activeDimensionBreakout, expandedCategoryKey, handleSelect],
+ );
+
+ const handleToggleCategorySettings = useCallback(
+ (category: DimensionPickerSidebarCategory) => {
+ setExpandedCategoryKey((currentKey) =>
+ currentKey === category.key ? null : category.key,
+ );
+ },
+ [setExpandedCategoryKey],
+ );
+
+ const handleCategoryDimensionChange = useCallback(
+ (
+ category: DimensionPickerSidebarCategory,
+ slotIndex: number,
+ dimensionId: string,
+ ) => {
+ const isActiveCategory = isCategorySelected(
+ category,
+ activeDimensionBreakout,
+ );
+
+ if (isActiveCategory) {
+ const dimensionMapping = {
+ ...activeDimensionBreakout.dimensionMapping,
+ [slotIndex]: dimensionId,
+ };
+ onUpdateActiveDimensionBreakout({ dimensionMapping });
+ return;
+ }
+
+ const dimensionMapping = {
+ ...category.dimensionBreakoutInfo.dimensionMapping,
+ [slotIndex]: dimensionId,
+ };
+ onSelectDimensionBreakout(
+ {
+ ...category.dimensionBreakoutInfo,
+ dimensionMapping,
+ },
+ { updateExisting: true },
+ );
+ trackMetricsViewerDimensionSelected();
+ },
+ [
+ activeDimensionBreakout,
+ onSelectDimensionBreakout,
+ onUpdateActiveDimensionBreakout,
+ ],
+ );
+
+ const handleBack = () => {
+ setMode("default");
+ setSearchText("");
+ };
+
+ const handleSeeAll = () => {
+ setMode("all");
+ };
+
+ const handleNoBreakout = () => {
+ if (activeDimensionBreakout.type === "scalar") {
+ return;
+ }
+
+ onSelectDimensionBreakout({
+ type: "scalar",
+ label: getScalarDimensionBreakoutLabel(),
+ dimensionMapping: {},
+ });
+ trackMetricsViewerDimensionSelected();
+ };
+
+ const showFieldsByCategory = !showAllFields && categories.length > 0;
+ const showDefaultView = !showAllFields;
+ const isNoBreakoutSelected = activeDimensionBreakout.type === "scalar";
+
+ return (
+ <Box
+ className={S.root}
+ component="aside"
+ data-testid="metrics-viewer-dimension-picker-sidebar"
+ pl="lg"
+ >
+ <Flex align="center" justify="space-between" pt="xs" pb="md">
+ <Flex align="center" gap="sm" miw={0}>
+ {showAllFields && (
+ <ActionIcon
+ aria-label={t`Back`}
+ variant="subtle"
+ onClick={handleBack}
+ >
+ <Icon name="arrow_left" />
+ </ActionIcon>
+ )}
+ <Title order={3} size="h4" fw="bold">
+ {showAllFields ? t`All fields` : t`Break out`}
+ </Title>
+ </Flex>
+ <ActionIcon
+ aria-label={t`Close`}
+ variant="subtle"
+ onClick={closeSidebar}
+ >
+ <Icon name="close" />
+ </ActionIcon>
+ </Flex>
+
+ <Box pb="md">
+ <TextInput
+ aria-label={t`Search fields`}
+ classNames={{ input: S.searchInput }}
+ leftSection={<Icon name="search" size={14} />}
+ onChange={(event) => setSearchText(event.currentTarget.value)}
+ placeholder={t`Search fields`}
+ size="sm"
+ value={searchText}
+ />
+ </Box>
+
+ <ScrollArea pb="lg" offsetScrollbars="present">
+ {showAllFields && (
+ <AllFieldsList
+ activeDimensionBreakout={activeDimensionBreakout}
+ sections={filteredSections}
+ metricSourceDataById={sourceDataById}
+ sourceColors={sourceColors}
+ metricSlots={metricSlots}
+ onSelect={handleAllFieldsSelect}
+ />
+ )}
+ {showDefaultView && (
+ <Stack gap="xs">
+ <Flex align="center" justify="space-between" my="sm">
+ <Text size="md" c="text-secondary">
+ {defaultSectionHeader}
+ </Text>
+ {showSeeAll && (
+ <Button onClick={handleSeeAll} p={0} size="xs" variant="subtle">
+ {t`See all`}
+ </Button>
+ )}
+ </Flex>
+ {showFieldsByCategory ? (
+ <Stack gap="xs">
+ {categories.map((category) => {
+ const isSelected =
+ category.key === selectedDimensionBreakoutCategoryKey;
+ const isExpanded = category.key === expandedCategoryKey;
+
+ return (
+ <CategoryItem
+ key={category.key}
+ category={category}
+ activeDimensionBreakout={activeDimensionBreakout}
+ metricSlots={metricSlots}
+ sourceDataById={sourceDataById}
+ sourceColors={sourceColors}
+ isSelected={isSelected}
+ isExpanded={isExpanded}
+ onCategorySelect={() => handleCategorySelect(category)}
+ onToggleCategorySettings={() =>
+ handleToggleCategorySettings(category)
+ }
+ onDimensionChange={(slotIndex, dimensionId) =>
+ handleCategoryDimensionChange(
+ category,
+ slotIndex,
+ dimensionId,
+ )
+ }
+ />
+ );
+ })}
+ </Stack>
+ ) : (
+ <Text c="text-secondary" ta="center" py="lg">
+ {defaultEmptyStateText}
+ </Text>
+ )}
+ <Box className={S.noBreakoutSection}>
+ <UnstyledButton
+ className={cx(S.noBreakoutButton, {
+ [S.selected]: isNoBreakoutSelected,
+ })}
+ aria-label={t`No breakout`}
+ aria-pressed={isNoBreakoutSelected}
+ onClick={handleNoBreakout}
+ >
+ <Icon
+ className={S.noBreakoutIcon}
+ name="unreferenced"
+ size={16}
+ />
+ <Text className={S.noBreakoutLabel} component="span">
+ {t`No breakout`}
+ </Text>
+ </UnstyledButton>
+ </Box>
+ </Stack>
+ )}
+ </ScrollArea>
+ </Box>
+ );
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/DimensionPickerSidebar.unit.spec.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/DimensionPickerSidebar.unit.spec.tsx
new file mode 100644
index 00000000000..2f2de408f24
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/DimensionPickerSidebar.unit.spec.tsx
@@ -0,0 +1,1375 @@
+import userEvent from "@testing-library/user-event";
+
+import { renderWithProviders, screen, within } from "__support__/ui";
+import { MetricsViewerProvider } from "metabase/metrics-viewer/context";
+import { createMockMetricsViewerResult } from "metabase/metrics-viewer/test-utils";
+import type {
+ MetricSourceId,
+ MetricsViewerDimensionBreakoutState,
+} from "metabase/metrics-viewer/types";
+import type {
+ AvailableDimensionsResult,
+ SourceDisplayInfo,
+} from "metabase/metrics-viewer/utils";
+import type { MetricSlot } from "metabase/metrics-viewer/utils/metric-slots";
+
+import { DimensionPickerSidebar } from "./DimensionPickerSidebar";
+
+const { trackSimpleEvent } = jest.requireMock("metabase/analytics");
+
+const SOURCE_ID: MetricSourceId = "metric:1";
+const SECOND_SOURCE_ID: MetricSourceId = "metric:2";
+
+const activeDimensionBreakout: MetricsViewerDimensionBreakoutState = {
+ id: "dimensionBreakout-category",
+ type: "category",
+ label: "Category",
+ display: "bar",
+ dimensionMapping: { 0: "dim-category" },
+ projectionConfig: {},
+};
+
+const timeDimensionBreakout: MetricsViewerDimensionBreakoutState = {
+ id: "dim-created-at",
+ type: "time",
+ label: "Created At",
+ display: "line",
+ dimensionMapping: { 0: "dim-created-at" },
+ projectionConfig: {},
+};
+
+const scalarDimensionBreakout: MetricsViewerDimensionBreakoutState = {
+ id: "scalar",
+ type: "scalar",
+ label: "Totals",
+ display: "scalar",
+ dimensionMapping: {},
+ projectionConfig: {},
+};
+
+const availableDimensions: AvailableDimensionsResult = {
+ shared: [],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "label",
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Category",
+ dimensionMapping: { 0: "dim-category" },
+ },
+ },
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 0: "dim-created-at" },
+ },
+ },
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Order Date",
+ dimensionMapping: { 0: "dim-order-date" },
+ },
+ },
+ ],
+ },
+};
+
+const sourceDataById: Record<MetricSourceId, SourceDisplayInfo> = {
+ [SOURCE_ID]: { type: "metric", name: "Revenue" },
+};
+
+function setup({
+ dimensionBreakout = activeDimensionBreakout,
+ dimensions = availableDimensions,
+ slots = [{ slotIndex: 0, entityIndex: 0, sourceId: SOURCE_ID }],
+ sourceOrder = [SOURCE_ID],
+ sources = sourceDataById,
+}: {
+ dimensionBreakout?: MetricsViewerDimensionBreakoutState;
+ dimensions?: AvailableDimensionsResult;
+ slots?: MetricSlot[];
+ sourceOrder?: MetricSourceId[];
+ sources?: Record<MetricSourceId, SourceDisplayInfo>;
+} = {}) {
+ const onSelectDimensionBreakout = jest.fn();
+ const onUpdateActiveDimensionBreakout = jest.fn();
+
+ const metricsViewerResult = createMockMetricsViewerResult({
+ activeDimensionBreakout: dimensionBreakout,
+ sidebarAvailableDimensions: dimensions,
+ metricSlots: slots,
+ sourceColors: { 0: ["#509ee3"], 1: ["#f9d45c"] },
+ sourceOrder,
+ sourceDataById: sources,
+ selectDimensionBreakout: onSelectDimensionBreakout,
+ updateActiveDimensionBreakout: onUpdateActiveDimensionBreakout,
+ });
+
+ renderWithProviders(
+ <MetricsViewerProvider value={metricsViewerResult}>
+ <DimensionPickerSidebar activeDimensionBreakout={dimensionBreakout} />
+ </MetricsViewerProvider>,
+ );
+
+ return { onSelectDimensionBreakout, onUpdateActiveDimensionBreakout };
+}
+
+describe("DimensionPickerSidebar", () => {
+ beforeEach(() => {
+ trackSimpleEvent.mockClear();
+ });
+
+ it("renders the active dimension as selected", () => {
+ setup();
+
+ expect(screen.getByText("Break out")).toBeInTheDocument();
+ expect(screen.getByText("Dimensions")).toBeInTheDocument();
+ expect(screen.queryByText("Shared dimensions")).not.toBeInTheDocument();
+ expect(screen.getByPlaceholderText("Search fields")).toBeInTheDocument();
+ expect(screen.getByLabelText("Search fields")).toBeInTheDocument();
+ expect(screen.queryByText("Totals")).not.toBeInTheDocument();
+ expect(screen.getByRole("button", { name: "Category" })).toHaveAttribute(
+ "aria-pressed",
+ "true",
+ );
+ expect(
+ screen.queryByRole("button", { name: "Created At" }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("does not select a swapped multi-metric dimension mapping", async () => {
+ setup({
+ dimensionBreakout: {
+ id: "dimensionBreakout-time",
+ type: "time",
+ label: "Time",
+ display: "line",
+ dimensionMapping: { 0: "dim-created-at", 1: "dim-order-date" },
+ projectionConfig: {},
+ },
+ dimensions: {
+ shared: [],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Swapped dates",
+ dimensionMapping: { 0: "dim-order-date", 1: "dim-created-at" },
+ },
+ },
+ ],
+ },
+ },
+ slots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: SOURCE_ID },
+ ],
+ });
+
+ await userEvent.click(screen.getByRole("button", { name: "See all" }));
+
+ expect(
+ screen.getByRole("button", { name: "Swapped dates" }),
+ ).not.toHaveAttribute("aria-pressed", "true");
+ });
+
+ it("filters dimensions with search", async () => {
+ setup();
+
+ await userEvent.type(
+ screen.getByPlaceholderText("Search fields"),
+ "created",
+ );
+
+ expect(
+ screen.getByRole("button", { name: "Created At" }),
+ ).toBeInTheDocument();
+ expect(screen.getByText("All fields")).toBeInTheDocument();
+ expect(
+ screen.queryByRole("button", { name: "Category" }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("shows all fields from the default view", async () => {
+ setup();
+
+ await userEvent.click(screen.getByRole("button", { name: "See all" }));
+
+ expect(screen.getByText("All fields")).toBeInTheDocument();
+ expect(
+ screen.getByRole("button", { name: "Created At" }),
+ ).toBeInTheDocument();
+ expect(
+ screen.queryByRole("button", { name: "Revenue" }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("selects no breakout and tracks it", async () => {
+ const { onSelectDimensionBreakout, onUpdateActiveDimensionBreakout } =
+ setup();
+
+ await userEvent.click(screen.getByRole("button", { name: "No breakout" }));
+
+ expect(onSelectDimensionBreakout).toHaveBeenCalledWith({
+ type: "scalar",
+ label: "Totals",
+ dimensionMapping: {},
+ });
+ expect(onUpdateActiveDimensionBreakout).not.toHaveBeenCalled();
+ expect(trackSimpleEvent).toHaveBeenCalledWith({
+ event: "metrics_viewer_dimension_selected",
+ });
+ });
+
+ it("marks no breakout as selected", () => {
+ setup({ dimensionBreakout: scalarDimensionBreakout });
+
+ expect(screen.getByRole("button", { name: "No breakout" })).toHaveAttribute(
+ "aria-pressed",
+ "true",
+ );
+ });
+
+ it("hides categories that are not available for multiple metric sources", () => {
+ setup({
+ dimensions: {
+ shared: [
+ {
+ icon: "location",
+ dimensionBreakoutInfo: {
+ type: "geo",
+ label: "Country",
+ dimensionMapping: {
+ 0: "dim-country",
+ 1: "second-dim-country",
+ },
+ },
+ },
+ ],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "location",
+ dimensionBreakoutInfo: {
+ type: "geo",
+ label: "Billing Address Country",
+ dimensionMapping: { 0: "dim-billing-address-country" },
+ },
+ },
+ ],
+ [SECOND_SOURCE_ID]: [],
+ },
+ },
+ slots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: SECOND_SOURCE_ID },
+ ],
+ sourceOrder: [SOURCE_ID, SECOND_SOURCE_ID],
+ sources: {
+ [SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [SECOND_SOURCE_ID]: { type: "metric", name: "Feedback, Count" },
+ },
+ });
+
+ expect(screen.getByText("Shared dimensions")).toBeInTheDocument();
+ expect(screen.queryByText("Dimensions")).not.toBeInTheDocument();
+ expect(screen.getByRole("button", { name: "Country" })).toBeInTheDocument();
+ expect(
+ screen.queryByRole("button", { name: "Billing Address Country" }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("keeps unshared fields available from See all", async () => {
+ setup({
+ dimensions: {
+ shared: [],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "location",
+ dimensionBreakoutInfo: {
+ type: "geo",
+ label: "Billing Address Country",
+ dimensionMapping: { 0: "dim-billing-address-country" },
+ },
+ },
+ ],
+ [SECOND_SOURCE_ID]: [],
+ },
+ },
+ slots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: SECOND_SOURCE_ID },
+ ],
+ sourceOrder: [SOURCE_ID, SECOND_SOURCE_ID],
+ sources: {
+ [SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [SECOND_SOURCE_ID]: { type: "metric", name: "Feedback, Count" },
+ },
+ });
+
+ expect(screen.getByText("No shared dimensions found")).toBeInTheDocument();
+ await userEvent.click(screen.getByRole("button", { name: "See all" }));
+
+ expect(screen.getByText("All fields")).toBeInTheDocument();
+ expect(
+ screen.getByRole("button", { name: "Billing Address Country" }),
+ ).toBeInTheDocument();
+ });
+
+ it("updates the active time dimensionBreakout with the clicked time field from all fields", async () => {
+ const { onSelectDimensionBreakout, onUpdateActiveDimensionBreakout } =
+ setup({ dimensionBreakout: timeDimensionBreakout });
+
+ await userEvent.click(screen.getByRole("button", { name: "See all" }));
+ await userEvent.click(screen.getByRole("button", { name: "Order Date" }));
+
+ expect(onSelectDimensionBreakout).not.toHaveBeenCalled();
+ expect(onUpdateActiveDimensionBreakout).toHaveBeenCalledWith({
+ label: "Order Date",
+ dimensionMapping: { 0: "dim-order-date" },
+ });
+ });
+
+ it("preserves other metric mappings when selecting an aggregate field from See all", async () => {
+ const { onSelectDimensionBreakout, onUpdateActiveDimensionBreakout } =
+ setup({
+ dimensionBreakout: {
+ id: "dim-created-at",
+ type: "time",
+ label: "Created At",
+ display: "line",
+ dimensionMapping: {
+ 0: "dim-created-at",
+ 1: "second-dim-created-at",
+ },
+ projectionConfig: {},
+ },
+ dimensions: {
+ shared: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: {
+ 0: "dim-created-at",
+ 1: "second-dim-created-at",
+ },
+ },
+ },
+ ],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Birth Date",
+ dimensionMapping: { 0: "dim-birth-date" },
+ },
+ },
+ ],
+ [SECOND_SOURCE_ID]: [],
+ },
+ },
+ slots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: SECOND_SOURCE_ID },
+ ],
+ sourceOrder: [SOURCE_ID, SECOND_SOURCE_ID],
+ sources: {
+ [SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [SECOND_SOURCE_ID]: { type: "metric", name: "Total Orders" },
+ },
+ });
+
+ await userEvent.click(screen.getByRole("button", { name: "See all" }));
+ await userEvent.click(screen.getByRole("button", { name: "Birth Date" }));
+
+ expect(onUpdateActiveDimensionBreakout).toHaveBeenCalledWith({
+ label: "Birth Date",
+ dimensionMapping: {
+ 0: "dim-birth-date",
+ 1: "second-dim-created-at",
+ },
+ });
+ expect(onSelectDimensionBreakout).not.toHaveBeenCalled();
+ });
+
+ it("activates the clicked field when its slot is already mapped", async () => {
+ const { onSelectDimensionBreakout, onUpdateActiveDimensionBreakout } =
+ setup({
+ dimensionBreakout: {
+ id: "second-dim-created-at",
+ type: "time",
+ label: "Created At",
+ display: "line",
+ dimensionMapping: {
+ 0: "dim-birth-date",
+ 1: "second-dim-created-at",
+ },
+ projectionConfig: {},
+ },
+ dimensions: {
+ shared: [],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Birth Date",
+ dimensionMapping: { 0: "dim-birth-date" },
+ },
+ },
+ ],
+ [SECOND_SOURCE_ID]: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 1: "second-dim-created-at" },
+ },
+ },
+ ],
+ },
+ },
+ slots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: SECOND_SOURCE_ID },
+ ],
+ sourceOrder: [SOURCE_ID, SECOND_SOURCE_ID],
+ sources: {
+ [SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [SECOND_SOURCE_ID]: { type: "metric", name: "Total Orders" },
+ },
+ });
+
+ await userEvent.click(screen.getByRole("button", { name: "See all" }));
+ await userEvent.click(screen.getByRole("button", { name: "Birth Date" }));
+
+ expect(onUpdateActiveDimensionBreakout).toHaveBeenCalledWith({
+ label: "Birth Date",
+ dimensionMapping: {
+ 0: "dim-birth-date",
+ 1: "second-dim-created-at",
+ },
+ });
+ expect(onSelectDimensionBreakout).not.toHaveBeenCalled();
+ });
+
+ it("selects only the clicked non-comparable field from See all", async () => {
+ const { onSelectDimensionBreakout, onUpdateActiveDimensionBreakout } =
+ setup({
+ dimensionBreakout: {
+ id: "dim-status",
+ type: "category",
+ label: "Status",
+ display: "bar",
+ dimensionMapping: {
+ 0: "dim-user-category",
+ 1: "dim-product-status",
+ },
+ projectionConfig: {},
+ },
+ dimensions: {
+ shared: [],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "label",
+ group: { id: "users", type: "main", displayName: "Users" },
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Status",
+ dimensionMapping: { 0: "dim-user-status" },
+ },
+ },
+ ],
+ [SECOND_SOURCE_ID]: [
+ {
+ icon: "label",
+ group: {
+ id: "products",
+ type: "main",
+ displayName: "Products",
+ },
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Status",
+ dimensionMapping: { 1: "dim-product-status" },
+ },
+ },
+ ],
+ },
+ },
+ slots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: SECOND_SOURCE_ID },
+ ],
+ sourceOrder: [SOURCE_ID, SECOND_SOURCE_ID],
+ sources: {
+ [SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [SECOND_SOURCE_ID]: { type: "metric", name: "Total Orders" },
+ },
+ });
+
+ await userEvent.click(screen.getByRole("button", { name: "See all" }));
+ await userEvent.click(screen.getAllByRole("button", { name: "Status" })[0]);
+
+ expect(onSelectDimensionBreakout).toHaveBeenCalledWith({
+ id: "dim-user-status",
+ type: "category",
+ label: "Status",
+ dimensionMapping: { 0: "dim-user-status", 1: null },
+ });
+ expect(onUpdateActiveDimensionBreakout).not.toHaveBeenCalled();
+ });
+
+ it.each([
+ ["Address", "dim-revenue-user-address"],
+ ["Name", "dim-revenue-user-name"],
+ ])(
+ "does not keep Accounts Email selected when selecting Revenue User %s",
+ async (fieldName, fieldId) => {
+ const { onSelectDimensionBreakout, onUpdateActiveDimensionBreakout } =
+ setup({
+ dimensionBreakout: {
+ id: "dim-accounts-email",
+ type: "category",
+ label: "Email",
+ display: "bar",
+ dimensionMapping: { 1: "dim-accounts-email" },
+ projectionConfig: {},
+ },
+ dimensions: {
+ shared: [],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "label",
+ group: { id: "users", type: "main", displayName: "User" },
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: fieldName,
+ dimensionMapping: { 0: fieldId },
+ },
+ },
+ ],
+ [SECOND_SOURCE_ID]: [
+ {
+ icon: "label",
+ group: {
+ id: "accounts",
+ type: "main",
+ displayName: "Accounts",
+ },
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Email",
+ dimensionMapping: { 1: "dim-accounts-email" },
+ },
+ },
+ ],
+ },
+ },
+ slots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: SECOND_SOURCE_ID },
+ ],
+ sourceOrder: [SOURCE_ID, SECOND_SOURCE_ID],
+ sources: {
+ [SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [SECOND_SOURCE_ID]: { type: "metric", name: "Accounts, Count" },
+ },
+ });
+
+ await userEvent.click(screen.getByRole("button", { name: "See all" }));
+ await userEvent.click(screen.getByRole("button", { name: fieldName }));
+
+ expect(onSelectDimensionBreakout).toHaveBeenCalledWith({
+ id: fieldId,
+ type: "category",
+ label: fieldName,
+ dimensionMapping: { 0: fieldId, 1: null },
+ });
+ expect(onUpdateActiveDimensionBreakout).not.toHaveBeenCalled();
+ },
+ );
+
+ it("marks metric-scoped See all dimensions as selected", async () => {
+ setup({
+ dimensionBreakout: {
+ id: "dim-birth-date",
+ type: "time",
+ label: "Birth Date",
+ display: "line",
+ dimensionMapping: {
+ 0: "dim-birth-date",
+ 1: "second-dim-created-at",
+ },
+ projectionConfig: {},
+ },
+ dimensions: {
+ shared: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: {
+ 0: "dim-created-at",
+ 1: "second-dim-created-at",
+ },
+ },
+ },
+ ],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Birth Date",
+ dimensionMapping: { 0: "dim-birth-date" },
+ },
+ },
+ ],
+ [SECOND_SOURCE_ID]: [],
+ },
+ },
+ slots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: SECOND_SOURCE_ID },
+ ],
+ sourceOrder: [SOURCE_ID, SECOND_SOURCE_ID],
+ sources: {
+ [SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [SECOND_SOURCE_ID]: { type: "metric", name: "Total Orders" },
+ },
+ });
+
+ await userEvent.click(screen.getByRole("button", { name: "See all" }));
+
+ expect(screen.getByRole("button", { name: "Birth Date" })).toHaveAttribute(
+ "data-selected",
+ "true",
+ );
+
+ await userEvent.click(screen.getByRole("button", { name: "Total Orders" }));
+
+ const createdAtButtons = screen.getAllByRole("button", {
+ name: "Created At",
+ });
+ expect(createdAtButtons[0]).not.toHaveAttribute("data-selected");
+ expect(createdAtButtons[1]).toHaveAttribute("data-selected", "true");
+ });
+
+ it("groups all fields by metric when multiple metrics are selected", async () => {
+ setup({
+ dimensions: {
+ shared: [
+ {
+ icon: "string",
+ group: { id: "customers", type: "main", displayName: "Customers" },
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Customer Name",
+ dimensionMapping: {
+ 0: "dim-customer-name",
+ 1: "dim-customer-name",
+ },
+ },
+ },
+ ],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "calendar",
+ group: {
+ id: "subscriptions",
+ type: "main",
+ displayName: "Subscriptions",
+ },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Placed At",
+ dimensionMapping: { 0: "dim-placed-at" },
+ },
+ },
+ ],
+ [SECOND_SOURCE_ID]: [
+ {
+ icon: "label",
+ group: { id: "orders", type: "main", displayName: "Orders" },
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Order Status",
+ dimensionMapping: { 1: "dim-order-status" },
+ },
+ },
+ ],
+ },
+ },
+ slots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: SECOND_SOURCE_ID },
+ ],
+ sourceOrder: [SOURCE_ID, SECOND_SOURCE_ID],
+ sources: {
+ [SOURCE_ID]: { type: "metric", name: "ARR" },
+ [SECOND_SOURCE_ID]: { type: "metric", name: "Total Orders" },
+ },
+ });
+
+ await userEvent.click(screen.getByRole("button", { name: "See all" }));
+
+ expect(screen.getByRole("button", { name: "ARR" })).toHaveAttribute(
+ "aria-expanded",
+ "true",
+ );
+ expect(
+ screen.getByRole("button", { name: "Total Orders" }),
+ ).toHaveAttribute("aria-expanded", "false");
+ expect(screen.getByText("Customers")).toBeInTheDocument();
+ expect(screen.getByText("Subscriptions")).toBeInTheDocument();
+ expect(screen.queryByText("Shared · Customers")).not.toBeInTheDocument();
+
+ await userEvent.click(screen.getByRole("button", { name: "Total Orders" }));
+
+ expect(screen.getByRole("button", { name: "ARR" })).toHaveAttribute(
+ "aria-expanded",
+ "true",
+ );
+ expect(
+ screen.getByRole("button", { name: "Total Orders" }),
+ ).toHaveAttribute("aria-expanded", "true");
+ expect(screen.getByText("Orders")).toBeInTheDocument();
+ expect(
+ screen.getByRole("button", { name: "Order Status" }),
+ ).toBeInTheDocument();
+
+ await userEvent.click(screen.getByRole("button", { name: "ARR" }));
+
+ expect(screen.getByRole("button", { name: "ARR" })).toHaveAttribute(
+ "aria-expanded",
+ "false",
+ );
+ expect(
+ screen.getByRole("button", { name: "Total Orders" }),
+ ).toHaveAttribute("aria-expanded", "true");
+ expect(screen.queryByText("Subscriptions")).not.toBeInTheDocument();
+ expect(
+ screen.getByRole("button", { name: "Order Status" }),
+ ).toBeInTheDocument();
+ });
+
+ it("shows one See all accordion per metric slot when the same metric is selected twice", async () => {
+ setup({
+ dimensions: {
+ shared: [],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "calendar",
+ group: { id: "orders", type: "main", displayName: "Orders" },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: {
+ 0: "dim-created-at",
+ 1: "dim-created-at",
+ },
+ },
+ },
+ ],
+ },
+ },
+ slots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: SOURCE_ID },
+ ],
+ sourceOrder: [SOURCE_ID],
+ sources: {
+ [SOURCE_ID]: { type: "metric", name: "Revenue" },
+ },
+ });
+
+ await userEvent.click(screen.getByRole("button", { name: "See all" }));
+
+ const revenueAccordions = screen.getAllByRole("button", {
+ name: "Revenue",
+ });
+ expect(revenueAccordions).toHaveLength(2);
+ expect(revenueAccordions[0]).toHaveAttribute("aria-expanded", "true");
+ expect(revenueAccordions[1]).toHaveAttribute("aria-expanded", "false");
+
+ await userEvent.click(revenueAccordions[1]);
+
+ expect(revenueAccordions[0]).toHaveAttribute("aria-expanded", "true");
+ expect(revenueAccordions[1]).toHaveAttribute("aria-expanded", "true");
+ });
+
+ it("uses circle indicators for expression metric dropdown rows", async () => {
+ setup({
+ dimensionBreakout: timeDimensionBreakout,
+ dimensions: {
+ shared: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Time",
+ dimensionMapping: {
+ 0: "dim-revenue-created-at",
+ 1: "dim-feedback-created-at",
+ },
+ },
+ },
+ ],
+ bySource: {},
+ },
+ slots: [
+ {
+ slotIndex: 0,
+ entityIndex: 0,
+ sourceId: SOURCE_ID,
+ tokenPosition: 0,
+ },
+ {
+ slotIndex: 1,
+ entityIndex: 0,
+ sourceId: SECOND_SOURCE_ID,
+ tokenPosition: 2,
+ },
+ ],
+ sourceOrder: [SOURCE_ID, SECOND_SOURCE_ID],
+ sources: {
+ [SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [SECOND_SOURCE_ID]: { type: "metric", name: "Feedback, Count" },
+ },
+ });
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Configure Time" }),
+ );
+
+ for (const indicator of screen.getAllByTestId(
+ "color-indicator-container",
+ )) {
+ expect(
+ within(indicator).queryByRole("img", { hidden: true }),
+ ).not.toBeInTheDocument();
+ }
+ });
+
+ it("uses circle indicators for expression metric See all accordions", async () => {
+ setup({
+ dimensions: {
+ shared: [],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 0: "dim-revenue-created-at" },
+ },
+ },
+ ],
+ [SECOND_SOURCE_ID]: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 1: "dim-feedback-created-at" },
+ },
+ },
+ ],
+ },
+ },
+ slots: [
+ {
+ slotIndex: 0,
+ entityIndex: 0,
+ sourceId: SOURCE_ID,
+ tokenPosition: 0,
+ },
+ {
+ slotIndex: 1,
+ entityIndex: 0,
+ sourceId: SECOND_SOURCE_ID,
+ tokenPosition: 2,
+ },
+ ],
+ sourceOrder: [SOURCE_ID, SECOND_SOURCE_ID],
+ sources: {
+ [SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [SECOND_SOURCE_ID]: { type: "metric", name: "Feedback, Count" },
+ },
+ });
+
+ await userEvent.click(screen.getByRole("button", { name: "See all" }));
+
+ expect(screen.getByRole("button", { name: "Revenue" })).toBeInTheDocument();
+ expect(
+ screen.getByRole("button", { name: "Feedback, Count" }),
+ ).toBeInTheDocument();
+ for (const indicator of screen.getAllByTestId(
+ "color-indicator-container",
+ )) {
+ expect(
+ within(indicator).queryByRole("img", { hidden: true }),
+ ).not.toBeInTheDocument();
+ }
+ });
+
+ it("merges shared and metric sections with the same table name", async () => {
+ setup({
+ dimensions: {
+ shared: [
+ {
+ icon: "calendar",
+ group: { id: "products", type: "main", displayName: "Product" },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: {
+ 0: "dim-product-created-at",
+ 1: "dim-product-created-at",
+ },
+ },
+ },
+ ],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "label",
+ group: {
+ id: "products",
+ type: "main",
+ displayName: "Product",
+ },
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Title",
+ dimensionMapping: { 0: "dim-product-title" },
+ },
+ },
+ ],
+ [SECOND_SOURCE_ID]: [],
+ },
+ },
+ slots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: SECOND_SOURCE_ID },
+ ],
+ sourceOrder: [SOURCE_ID, SECOND_SOURCE_ID],
+ sources: {
+ [SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [SECOND_SOURCE_ID]: { type: "metric", name: "Number of Orders" },
+ },
+ });
+
+ await userEvent.click(screen.getByRole("button", { name: "See all" }));
+
+ expect(screen.getAllByText("Product")).toHaveLength(1);
+ expect(
+ screen.getByRole("button", { name: "Created At" }),
+ ).toBeInTheDocument();
+ expect(screen.getByRole("button", { name: "Title" })).toBeInTheDocument();
+ });
+
+ it("shows inline column options from the settings button for one metric", async () => {
+ setup();
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Configure Time" }),
+ );
+
+ expect(
+ screen.queryByLabelText("Select dimension for Revenue"),
+ ).not.toBeInTheDocument();
+ expect(screen.getByRole("button", { name: "Created At" })).toHaveAttribute(
+ "aria-pressed",
+ "false",
+ );
+ expect(
+ screen.getByRole("button", { name: "Order Date" }),
+ ).toBeInTheDocument();
+ });
+
+ it("does not show settings or duplicate options for a category with one exact column", async () => {
+ const { onSelectDimensionBreakout } = setup({
+ dimensionBreakout: scalarDimensionBreakout,
+ dimensions: {
+ shared: [],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "location",
+ dimensionBreakoutInfo: {
+ type: "geo",
+ label: "State",
+ dimensionMapping: { 0: "dim-state" },
+ },
+ },
+ ],
+ },
+ },
+ });
+
+ expect(
+ screen.queryByRole("button", { name: "Configure State" }),
+ ).not.toBeInTheDocument();
+ expect(screen.getAllByRole("button", { name: "State" })).toHaveLength(1);
+
+ await userEvent.click(screen.getByRole("button", { name: "State" }));
+
+ expect(onSelectDimensionBreakout).toHaveBeenCalledWith({
+ type: "geo",
+ label: "State",
+ dimensionMapping: { 0: "dim-state" },
+ });
+ });
+
+ it("does not show settings when every metric has only one exact column", () => {
+ setup({
+ dimensionBreakout: {
+ ...timeDimensionBreakout,
+ label: "Time",
+ dimensionMapping: {
+ 0: "dim-created-at",
+ 1: "dim-second-created-at",
+ },
+ },
+ dimensions: {
+ shared: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Time",
+ dimensionMapping: {
+ 0: "dim-created-at",
+ 1: "dim-second-created-at",
+ },
+ },
+ },
+ ],
+ bySource: {},
+ },
+ slots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: SECOND_SOURCE_ID },
+ ],
+ sourceOrder: [SOURCE_ID, SECOND_SOURCE_ID],
+ sources: {
+ [SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [SECOND_SOURCE_ID]: { type: "metric", name: "Feedback, Count" },
+ },
+ });
+
+ expect(
+ screen.queryByRole("button", { name: "Configure Time" }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("shows per-metric column selects from the settings button for multiple metrics", async () => {
+ setup({
+ dimensionBreakout: {
+ ...timeDimensionBreakout,
+ dimensionMapping: {
+ 0: "dim-created-at",
+ 1: "dim-second-created-at",
+ },
+ },
+ dimensions: {
+ shared: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Time",
+ dimensionMapping: {
+ 0: "dim-created-at",
+ 1: "dim-second-created-at",
+ },
+ },
+ },
+ ],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Order Date",
+ dimensionMapping: { 0: "dim-order-date" },
+ },
+ },
+ ],
+ [SECOND_SOURCE_ID]: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Order Date",
+ dimensionMapping: { 1: "dim-second-order-date" },
+ },
+ },
+ ],
+ },
+ },
+ slots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: SECOND_SOURCE_ID },
+ ],
+ sourceOrder: [SOURCE_ID, SECOND_SOURCE_ID],
+ sources: {
+ [SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [SECOND_SOURCE_ID]: { type: "metric", name: "Feedback, Count" },
+ },
+ });
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Configure Time" }),
+ );
+
+ expect(screen.getByLabelText("Select dimension for Revenue")).toHaveValue(
+ "Time",
+ );
+ expect(
+ screen.getByLabelText("Select dimension for Feedback, Count"),
+ ).toHaveValue("Time");
+ });
+
+ it("uses the active time mapping for column select values", async () => {
+ setup({
+ dimensionBreakout: {
+ ...timeDimensionBreakout,
+ dimensionMapping: { 0: "dim-created-at" },
+ },
+ dimensions: {
+ shared: [],
+ bySource: {
+ [SOURCE_ID]: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Birth Date",
+ dimensionMapping: { 0: "dim-birth-date" },
+ },
+ },
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 0: "dim-created-at" },
+ },
+ },
+ ],
+ },
+ },
+ });
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Configure Time" }),
+ );
+
+ expect(screen.getByRole("button", { name: "Created At" })).toHaveAttribute(
+ "aria-pressed",
+ "true",
+ );
+ });
+
+ it("does not mark category column options as selected when no breakout is active", async () => {
+ setup({ dimensionBreakout: scalarDimensionBreakout });
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Configure Time" }),
+ );
+
+ expect(screen.getByRole("button", { name: "Created At" })).toHaveAttribute(
+ "aria-pressed",
+ "false",
+ );
+ expect(screen.getByRole("button", { name: "Order Date" })).toHaveAttribute(
+ "aria-pressed",
+ "false",
+ );
+ });
+
+ it("does not mark category column options as selected when another category is active", async () => {
+ setup({
+ dimensionBreakout: {
+ id: "dim-name",
+ type: "category",
+ label: "Name",
+ display: "bar",
+ dimensionMapping: { 0: "dim-name" },
+ projectionConfig: {},
+ },
+ dimensions: {
+ shared: [],
+ bySource: {
+ [SOURCE_ID]: [
+ ...availableDimensions.bySource[SOURCE_ID],
+ {
+ icon: "label",
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Name",
+ dimensionMapping: { 0: "dim-name" },
+ },
+ },
+ ],
+ },
+ },
+ });
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Configure Time" }),
+ );
+
+ expect(screen.getByRole("button", { name: "Created At" })).toHaveAttribute(
+ "aria-pressed",
+ "false",
+ );
+ expect(screen.getByRole("button", { name: "Order Date" })).toHaveAttribute(
+ "aria-pressed",
+ "false",
+ );
+ });
+
+ it("selects the clicked inactive aggregate column option", async () => {
+ const { onSelectDimensionBreakout, onUpdateActiveDimensionBreakout } =
+ setup({
+ dimensionBreakout: {
+ id: "dim-name",
+ type: "category",
+ label: "Name",
+ display: "bar",
+ dimensionMapping: { 0: "dim-name" },
+ projectionConfig: {},
+ },
+ dimensions: {
+ shared: [],
+ bySource: {
+ [SOURCE_ID]: [
+ ...availableDimensions.bySource[SOURCE_ID],
+ {
+ icon: "label",
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Name",
+ dimensionMapping: { 0: "dim-name" },
+ },
+ },
+ ],
+ },
+ },
+ });
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Configure Time" }),
+ );
+ await userEvent.click(screen.getByRole("button", { name: "Order Date" }));
+
+ expect(onSelectDimensionBreakout).toHaveBeenCalledWith(
+ {
+ id: "time",
+ type: "time",
+ label: "Time",
+ dimensionMapping: { 0: "dim-order-date" },
+ },
+ { updateExisting: true },
+ );
+ expect(onUpdateActiveDimensionBreakout).not.toHaveBeenCalled();
+ expect(trackSimpleEvent).toHaveBeenCalledWith({
+ event: "metrics_viewer_dimension_selected",
+ });
+ });
+
+ it("does not show column selects when the category row is clicked", async () => {
+ setup();
+
+ await userEvent.click(screen.getByRole("button", { name: "Time" }));
+
+ expect(
+ screen.queryByLabelText("Select dimension for Revenue"),
+ ).not.toBeInTheDocument();
+ });
+
+ it("closes column selects when another category row is clicked", async () => {
+ setup({ dimensionBreakout: timeDimensionBreakout });
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Configure Time" }),
+ );
+ expect(
+ screen.getByRole("button", { name: "Created At" }),
+ ).toBeInTheDocument();
+
+ await userEvent.click(screen.getByRole("button", { name: "Category" }));
+
+ expect(
+ screen.queryByRole("button", { name: "Created At" }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("selects a new dimension breakout and tracks it", async () => {
+ const { onSelectDimensionBreakout } = setup();
+
+ await userEvent.click(screen.getByRole("button", { name: "Time" }));
+
+ expect(onSelectDimensionBreakout).toHaveBeenCalledWith({
+ id: "time",
+ type: "time",
+ label: "Time",
+ dimensionMapping: { 0: "dim-created-at" },
+ });
+ expect(trackSimpleEvent).toHaveBeenCalledWith({
+ event: "metrics_viewer_dimension_selected",
+ });
+ });
+
+ it("does not add or track the already-selected dimension", async () => {
+ const { onSelectDimensionBreakout } = setup();
+
+ await userEvent.click(screen.getByRole("button", { name: "Category" }));
+
+ expect(onSelectDimensionBreakout).not.toHaveBeenCalled();
+ expect(trackSimpleEvent).not.toHaveBeenCalled();
+ });
+
+ it("updates the active dimensionBreakout mapping from a single metric column option", async () => {
+ const { onSelectDimensionBreakout, onUpdateActiveDimensionBreakout } =
+ setup({ dimensionBreakout: timeDimensionBreakout });
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Configure Time" }),
+ );
+ await userEvent.click(screen.getByRole("button", { name: "Order Date" }));
+
+ expect(onUpdateActiveDimensionBreakout).toHaveBeenCalledWith({
+ dimensionMapping: { 0: "dim-order-date" },
+ });
+ expect(onSelectDimensionBreakout).not.toHaveBeenCalled();
+ expect(trackSimpleEvent).not.toHaveBeenCalled();
+ expect(screen.getByText("Break out")).toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/AllFieldsList.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/AllFieldsList.tsx
new file mode 100644
index 00000000000..5889fb9bfa2
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/AllFieldsList.tsx
@@ -0,0 +1,70 @@
+import { t } from "ttag";
+
+import type {
+ MetricSourceId,
+ MetricsViewerDimensionBreakoutState,
+ SourceColorMap,
+} from "metabase/metrics-viewer/types";
+import type {
+ DimensionPickerItem,
+ DimensionPickerSection,
+ SourceDisplayInfo,
+} from "metabase/metrics-viewer/utils";
+import type { MetricSlot } from "metabase/metrics-viewer/utils/metric-slots";
+import { Text } from "metabase/ui";
+
+import { AllFieldsSectionList } from "./AllFieldsSectionList";
+import { MetricAccordionList } from "./MetricAccordionList";
+import { buildAllFieldsMetricGroups } from "./buildAllFieldsMetricGroups";
+
+type AllFieldsListProps = {
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState;
+ sections: DimensionPickerSection[];
+ metricSourceDataById: Record<MetricSourceId, SourceDisplayInfo>;
+ sourceColors: SourceColorMap;
+ metricSlots: MetricSlot[];
+ onSelect: (item: DimensionPickerItem) => void;
+};
+
+export function AllFieldsList({
+ activeDimensionBreakout,
+ sections,
+ metricSourceDataById,
+ sourceColors,
+ metricSlots,
+ onSelect,
+}: AllFieldsListProps) {
+ if (sections.length === 0) {
+ return (
+ <Text c="text-secondary" ta="center" py="lg">{t`No fields found`}</Text>
+ );
+ }
+
+ const metricGroups = buildAllFieldsMetricGroups({
+ sections,
+ sourceDataById: metricSourceDataById,
+ metricSlots,
+ sourceColors,
+ });
+
+ if (metricSlots.length > 1 && metricGroups.length > 1) {
+ return (
+ <MetricAccordionList
+ activeDimensionBreakout={activeDimensionBreakout}
+ defaultExpandedGroupKeys={metricGroups
+ .slice(0, 1)
+ .map((group) => group.key)}
+ groups={metricGroups}
+ onSelect={onSelect}
+ />
+ );
+ }
+
+ return (
+ <AllFieldsSectionList
+ activeDimensionBreakout={activeDimensionBreakout}
+ sections={sections}
+ onSelect={onSelect}
+ />
+ );
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/AllFieldsSectionList.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/AllFieldsSectionList.tsx
new file mode 100644
index 00000000000..a8a22d797b9
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/AllFieldsSectionList.tsx
@@ -0,0 +1,54 @@
+import type { MetricsViewerDimensionBreakoutState } from "metabase/metrics-viewer/types";
+import type {
+ DimensionPickerItem,
+ DimensionPickerSection,
+} from "metabase/metrics-viewer/utils";
+import { Stack, Text } from "metabase/ui";
+
+import { getSidebarSectionName, hasMatchingDimensions } from "../../utils";
+
+import { DimensionButton } from "./DimensionButton";
+
+export function AllFieldsSectionList({
+ activeDimensionBreakout,
+ sections,
+ onSelect,
+}: {
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState;
+ sections: DimensionPickerSection[];
+ onSelect: (item: DimensionPickerItem) => void;
+}) {
+ return (
+ <Stack gap="lg">
+ {sections.map((section, sectionIndex) => {
+ const sectionKey = section.name
+ ? `${section.name}-${sectionIndex}`
+ : `section-${sectionIndex}`;
+ const sectionName = getSidebarSectionName(section.name);
+
+ return (
+ <Stack key={sectionKey} gap="xs">
+ {sectionName && (
+ <Text px="sm" size="sm" c="text-secondary">
+ {sectionName}
+ </Text>
+ )}
+ <Stack gap={0}>
+ {section.items.map((item, itemIndex) => (
+ <DimensionButton
+ key={`${item.dimensionBreakoutInfo.type}-${item.name}-${itemIndex}`}
+ item={item}
+ isSelected={hasMatchingDimensions(
+ item,
+ activeDimensionBreakout,
+ )}
+ onClick={() => onSelect(item)}
+ />
+ ))}
+ </Stack>
+ </Stack>
+ );
+ })}
+ </Stack>
+ );
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/DimensionButton.module.css b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/DimensionButton.module.css
new file mode 100644
index 00000000000..f39507c61b6
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/DimensionButton.module.css
@@ -0,0 +1,42 @@
+.item {
+ display: grid;
+ grid-template-columns: 1rem minmax(0, 1fr);
+ gap: 0.5rem;
+ align-items: center;
+ width: 100%;
+ height: 2rem;
+ padding-inline: 0.5rem;
+ border-radius: 0.375rem;
+ color: var(--mb-color-text-primary);
+ font-size: 0.875rem;
+ line-height: 1rem;
+}
+
+.item:hover {
+ background-color: var(--mb-color-background-hover);
+}
+
+.item[data-selected] {
+ background-color: var(--mb-color-background-selected);
+ border-radius: 0.5rem;
+ color: var(--mb-color-text-brand);
+}
+
+.item[data-selected]:hover {
+ background-color: var(--mb-color-background-hover);
+}
+
+.itemIcon {
+ color: currentcolor;
+}
+
+.itemLabel {
+ overflow: hidden;
+ color: currentcolor;
+ font-size: 0.875rem;
+ font-weight: 500;
+ line-height: 1rem;
+ text-align: left;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/DimensionButton.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/DimensionButton.tsx
new file mode 100644
index 00000000000..67ab11e224a
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/DimensionButton.tsx
@@ -0,0 +1,29 @@
+import type { DimensionPickerItem } from "metabase/metrics-viewer/utils";
+import { Icon, Text, UnstyledButton } from "metabase/ui";
+
+import S from "./DimensionButton.module.css";
+
+export function DimensionButton({
+ item,
+ isSelected,
+ onClick,
+}: {
+ item: DimensionPickerItem;
+ isSelected: boolean;
+ onClick: () => void;
+}) {
+ return (
+ <UnstyledButton
+ className={S.item}
+ data-selected={isSelected || undefined}
+ aria-label={item.name}
+ aria-pressed={isSelected}
+ onClick={onClick}
+ >
+ <Icon className={S.itemIcon} name={item.icon} size={16} />
+ <Text className={S.itemLabel} component="span">
+ {item.name}
+ </Text>
+ </UnstyledButton>
+ );
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/MetricAccordionItem.module.css b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/MetricAccordionItem.module.css
new file mode 100644
index 00000000000..4d7a142efbc
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/MetricAccordionItem.module.css
@@ -0,0 +1,30 @@
+.metricAccordionItem {
+ overflow: hidden;
+ border-radius: 0.5rem;
+}
+
+.metricAccordionControl {
+ align-items: center;
+ background-color: var(--mb-color-background-hover);
+ border-radius: 0.5rem;
+ color: var(--mb-color-text-primary);
+ display: flex;
+ justify-content: space-between;
+ min-height: 2.5rem;
+ padding: 0.5rem 1rem;
+ width: 100%;
+}
+
+.metricAccordionLabel {
+ color: currentcolor;
+ font-size: 0.875rem;
+ font-weight: 500;
+ line-height: 1.25rem;
+ overflow: hidden;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+}
+
+.metricAccordionPanel {
+ padding: 1rem;
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/MetricAccordionItem.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/MetricAccordionItem.tsx
new file mode 100644
index 00000000000..a08762aecf1
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/MetricAccordionItem.tsx
@@ -0,0 +1,54 @@
+import { SourceColorIndicator } from "metabase/common/components/SourceColorIndicator";
+import type { MetricsViewerDimensionBreakoutState } from "metabase/metrics-viewer/types";
+import type { DimensionPickerItem } from "metabase/metrics-viewer/utils";
+import { Box, Flex, Icon, Text, UnstyledButton } from "metabase/ui";
+
+import { AllFieldsSectionList } from "./AllFieldsSectionList";
+import S from "./MetricAccordionItem.module.css";
+import type { AllFieldsMetricGroup } from "./types";
+
+export function MetricAccordionItem({
+ activeDimensionBreakout,
+ group,
+ isExpanded,
+ onToggle,
+ onSelect,
+}: {
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState;
+ group: AllFieldsMetricGroup;
+ isExpanded: boolean;
+ onToggle: () => void;
+ onSelect: (item: DimensionPickerItem) => void;
+}) {
+ return (
+ <Box className={S.metricAccordionItem}>
+ <UnstyledButton
+ className={S.metricAccordionControl}
+ aria-label={group.name}
+ aria-expanded={isExpanded}
+ onClick={onToggle}
+ >
+ <Flex align="center" gap="sm" miw={0}>
+ <SourceColorIndicator
+ colors={group.colors}
+ fallbackIcon={group.isExpressionToken ? undefined : "metric"}
+ size={16}
+ />
+ <Text className={S.metricAccordionLabel} component="span">
+ {group.name}
+ </Text>
+ </Flex>
+ <Icon name={isExpanded ? "chevronup" : "chevrondown"} size={12} />
+ </UnstyledButton>
+ {isExpanded && (
+ <Box className={S.metricAccordionPanel}>
+ <AllFieldsSectionList
+ activeDimensionBreakout={activeDimensionBreakout}
+ sections={group.sections}
+ onSelect={onSelect}
+ />
+ </Box>
+ )}
+ </Box>
+ );
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/MetricAccordionList.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/MetricAccordionList.tsx
new file mode 100644
index 00000000000..e03af8453d2
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/MetricAccordionList.tsx
@@ -0,0 +1,53 @@
+import { useState } from "react";
+
+import type { MetricsViewerDimensionBreakoutState } from "metabase/metrics-viewer/types";
+import type { DimensionPickerItem } from "metabase/metrics-viewer/utils";
+import { Stack } from "metabase/ui";
+
+import { MetricAccordionItem } from "./MetricAccordionItem";
+import type { AllFieldsMetricGroup } from "./types";
+
+type MetricAccordionListProps = {
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState;
+ defaultExpandedGroupKeys: string[];
+ groups: AllFieldsMetricGroup[];
+ onSelect: (item: DimensionPickerItem) => void;
+};
+
+export function MetricAccordionList({
+ activeDimensionBreakout,
+ defaultExpandedGroupKeys,
+ groups,
+ onSelect,
+}: MetricAccordionListProps) {
+ const [expandedGroupKeys, setExpandedGroupKeys] = useState<string[]>(
+ defaultExpandedGroupKeys,
+ );
+
+ const handleToggleAccordion = (sourceId: string) => {
+ setExpandedGroupKeys((currentSourceIds) => {
+ if (currentSourceIds.includes(sourceId)) {
+ return currentSourceIds.filter(
+ (currentSourceId) => currentSourceId !== sourceId,
+ );
+ }
+
+ return [...currentSourceIds, sourceId];
+ });
+ };
+
+ return (
+ <Stack gap="xs">
+ {groups.map((group) => (
+ <MetricAccordionItem
+ key={group.key}
+ activeDimensionBreakout={activeDimensionBreakout}
+ group={group}
+ isExpanded={expandedGroupKeys.includes(group.key)}
+ onToggle={() => handleToggleAccordion(group.key)}
+ onSelect={onSelect}
+ />
+ ))}
+ </Stack>
+ );
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/buildAllFieldsMetricGroups.ts b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/buildAllFieldsMetricGroups.ts
new file mode 100644
index 00000000000..125bd270b41
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/buildAllFieldsMetricGroups.ts
@@ -0,0 +1,187 @@
+import type {
+ MetricSourceId,
+ SourceColorMap,
+} from "metabase/metrics-viewer/types";
+import type {
+ DimensionPickerItem,
+ DimensionPickerSection,
+ SourceDisplayInfo,
+} from "metabase/metrics-viewer/utils";
+import type { MetricSlot } from "metabase/metrics-viewer/utils/metric-slots";
+
+import type { AllFieldsMetricGroup } from "./types";
+
+function getSectionKey(section: DimensionPickerSection) {
+ return section.name;
+}
+
+function getDimensionItemKey(item: DimensionPickerSection["items"][number]) {
+ const entries = Object.entries(item.dimensionBreakoutInfo.dimensionMapping)
+ .sort(([a], [b]) => Number(a) - Number(b))
+ .map(([k, v]) => `${k}=${v}`)
+ .join("|");
+ return `${item.dimensionBreakoutInfo.type}:${entries}`;
+}
+
+function mergeSectionsByName(sections: DimensionPickerSection[]) {
+ const mergedSections: DimensionPickerSection[] = [];
+ const sectionIndexesByKey = new Map<string, number>();
+
+ for (const section of sections) {
+ const sectionKey = getSectionKey(section);
+
+ if (sectionKey == null) {
+ mergedSections.push({ ...section, items: [...section.items] });
+ continue;
+ }
+
+ const sectionIndex = sectionIndexesByKey.get(sectionKey);
+
+ if (sectionIndex == null) {
+ sectionIndexesByKey.set(sectionKey, mergedSections.length);
+ mergedSections.push({ ...section, items: [...section.items] });
+ continue;
+ }
+
+ const mergedSection = mergedSections[sectionIndex];
+ const existingItemKeys = new Set(
+ mergedSection.items.map(getDimensionItemKey),
+ );
+ const newItems = section.items.filter(
+ (item) => !existingItemKeys.has(getDimensionItemKey(item)),
+ );
+
+ if (newItems.length > 0) {
+ mergedSections[sectionIndex] = {
+ ...mergedSection,
+ items: [...mergedSection.items, ...newItems],
+ };
+ }
+ }
+
+ return mergedSections;
+}
+
+function getSourceSlotIndices(
+ metricSlots: MetricSlot[],
+ sourceId: MetricSourceId,
+) {
+ return new Set(
+ metricSlots
+ .filter((slot) => slot.sourceId === sourceId)
+ .map((slot) => slot.slotIndex),
+ );
+}
+
+function getSlotIndices(slotIndex: number) {
+ return new Set([slotIndex]);
+}
+
+function scopeItemToSlotIndices(
+ item: DimensionPickerItem,
+ slotIndices: Set<number>,
+) {
+ const dimensionMapping = Object.fromEntries(
+ Object.entries(item.dimensionBreakoutInfo.dimensionMapping).filter(
+ ([slotIndex]) => slotIndices.has(Number(slotIndex)),
+ ),
+ );
+
+ if (Object.keys(dimensionMapping).length === 0) {
+ return null;
+ }
+
+ return {
+ ...item,
+ dimensionBreakoutInfo: {
+ ...item.dimensionBreakoutInfo,
+ dimensionMapping,
+ },
+ };
+}
+
+function scopeSectionsToSource(
+ sections: DimensionPickerSection[],
+ slotIndices: Set<number>,
+) {
+ return sections
+ .map((section) => ({
+ ...section,
+ items: section.items
+ .map((item) => scopeItemToSlotIndices(item, slotIndices))
+ .filter((item): item is DimensionPickerItem => item != null),
+ }))
+ .filter((section) => section.items.length > 0);
+}
+
+export function buildAllFieldsMetricGroups({
+ sections,
+ sourceDataById,
+ metricSlots,
+ sourceColors,
+}: {
+ sections: DimensionPickerSection[];
+ sourceDataById: Record<MetricSourceId, SourceDisplayInfo>;
+ metricSlots: MetricSlot[];
+ sourceColors: SourceColorMap;
+}): AllFieldsMetricGroup[] {
+ const uniqueSourceIds = [
+ ...new Set(metricSlots.map((slot) => slot.sourceId)),
+ ];
+ const hasRepeatedSources = uniqueSourceIds.length < metricSlots.length;
+
+ if (hasRepeatedSources) {
+ return metricSlots
+ .map((slot) => {
+ const matchingSections = sections.filter(
+ (section) =>
+ section.isShared ||
+ section.sourceId == null ||
+ section.sourceId === slot.sourceId,
+ );
+ const scopedSections = scopeSectionsToSource(
+ matchingSections,
+ getSlotIndices(slot.slotIndex),
+ );
+
+ return {
+ key: `${slot.slotIndex}:${slot.sourceId}`,
+ name: sourceDataById[slot.sourceId]?.name ?? slot.sourceId,
+ colors: sourceColors[slot.entityIndex],
+ isExpressionToken: slot.tokenPosition != null,
+ sections: mergeSectionsByName(scopedSections),
+ };
+ })
+ .filter((group) => group.sections.length > 0);
+ }
+
+ return uniqueSourceIds
+ .map((sourceId) => {
+ const sourceSlots = metricSlots.filter(
+ (slot) => slot.sourceId === sourceId,
+ );
+ const metricSlot = sourceSlots[0];
+ const matchingSections = sections.filter(
+ (section) =>
+ section.isShared ||
+ section.sourceId == null ||
+ section.sourceId === sourceId,
+ );
+ const scopedSections = scopeSectionsToSource(
+ matchingSections,
+ getSourceSlotIndices(metricSlots, sourceId),
+ );
+
+ return {
+ key: sourceId,
+ name: sourceDataById[sourceId]?.name ?? sourceId,
+ colors:
+ metricSlot != null ? sourceColors[metricSlot.entityIndex] : undefined,
+ isExpressionToken: sourceSlots.every(
+ (slot) => slot.tokenPosition != null,
+ ),
+ sections: mergeSectionsByName(scopedSections),
+ };
+ })
+ .filter((group) => group.sections.length > 0);
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/index.ts b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/index.ts
new file mode 100644
index 00000000000..ff873fce95c
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/index.ts
@@ -0,0 +1 @@
+export { AllFieldsList } from "./AllFieldsList";
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/types.ts b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/types.ts
new file mode 100644
index 00000000000..47a4fca1312
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/AllFieldsList/types.ts
@@ -0,0 +1,9 @@
+import type { DimensionPickerSection } from "metabase/metrics-viewer/utils";
+
+export type AllFieldsMetricGroup = {
+ key: string;
+ name: string;
+ colors?: string[];
+ isExpressionToken: boolean;
+ sections: DimensionPickerSection[];
+};
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/CategoryButton.module.css b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/CategoryButton.module.css
new file mode 100644
index 00000000000..892326a956a
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/CategoryButton.module.css
@@ -0,0 +1,75 @@
+.categoryItem {
+ display: grid;
+ grid-template-columns: 1rem minmax(0, 1fr);
+ gap: 0.5rem;
+ align-items: center;
+ flex: 1 1 auto;
+ min-width: 0;
+ width: 100%;
+ height: 2rem;
+ padding-inline: 0.5rem;
+ border-radius: 0.5rem;
+ color: var(--mb-color-text-primary);
+ font-size: 0.875rem;
+ line-height: 1rem;
+}
+
+.settingsButton {
+ display: none;
+ flex: 0 0 2rem;
+ width: 2rem;
+ height: 2rem;
+ border-radius: 0.5rem;
+ background-color: var(--mb-color-background-info);
+ color: var(--mb-color-icon-primary);
+}
+
+.categoryRow {
+ align-items: center;
+ gap: 0.25rem;
+ width: 100%;
+
+ &.selected {
+ .categoryItem {
+ background-color: var(--mb-color-background-selected);
+ color: var(--mb-color-text-brand);
+ }
+ }
+
+ &:not(.selected):hover {
+ .categoryItem {
+ background-color: var(--mb-color-background-hover);
+ }
+ }
+
+ &:hover,
+ &.expanded {
+ .settingsButton {
+ display: inline-flex;
+ }
+ }
+
+ .settingsButton:hover {
+ background-color: var(--mb-color-background-hover);
+ color: var(--mb-color-text-brand);
+ }
+
+ &.expanded .settingsButton {
+ background-color: var(--mb-color-background-selected);
+ }
+}
+
+.itemIcon {
+ color: currentcolor;
+}
+
+.itemLabel {
+ overflow: hidden;
+ color: currentcolor;
+ font-size: 0.875rem;
+ font-weight: 500;
+ line-height: 1rem;
+ text-align: left;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/CategoryButton.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/CategoryButton.tsx
new file mode 100644
index 00000000000..8a9270c960e
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/CategoryButton.tsx
@@ -0,0 +1,57 @@
+import cx from "classnames";
+import { t } from "ttag";
+
+import type { DimensionPickerSidebarCategory } from "metabase/metrics-viewer/utils";
+import { ActionIcon, Flex, Icon, Text, UnstyledButton } from "metabase/ui";
+
+import S from "./CategoryButton.module.css";
+
+type CategoryButtonProps = {
+ item: DimensionPickerSidebarCategory;
+ isSelected: boolean;
+ canConfigure: boolean;
+ isExpanded: boolean;
+ onClick: () => void;
+ onConfigure: () => void;
+};
+
+export function CategoryButton({
+ item,
+ isSelected,
+ canConfigure,
+ isExpanded,
+ onClick,
+ onConfigure,
+}: CategoryButtonProps) {
+ return (
+ <Flex
+ className={cx(S.categoryRow, {
+ [S.expanded]: isExpanded,
+ [S.selected]: isSelected,
+ })}
+ >
+ <UnstyledButton
+ className={S.categoryItem}
+ aria-pressed={isSelected}
+ aria-label={item.name}
+ onClick={onClick}
+ >
+ <Icon className={S.itemIcon} name={item.icon} size={16} />
+ <Text className={S.itemLabel} component="span">
+ {item.name}
+ </Text>
+ </UnstyledButton>
+ {canConfigure && (
+ <ActionIcon
+ className={S.settingsButton}
+ aria-label={t`Configure ${item.name}`}
+ aria-expanded={isExpanded}
+ variant="subtle"
+ onClick={onConfigure}
+ >
+ <Icon name="sliders" />
+ </ActionIcon>
+ )}
+ </Flex>
+ );
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/CategoryItem.module.css b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/CategoryItem.module.css
new file mode 100644
index 00000000000..8e982c47adf
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/CategoryItem.module.css
@@ -0,0 +1,4 @@
+.categorySelectList {
+ padding-block: 0.375rem 0.625rem;
+ padding-left: 2rem;
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/CategoryItem.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/CategoryItem.tsx
new file mode 100644
index 00000000000..9b11f953b06
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/CategoryItem.tsx
@@ -0,0 +1,137 @@
+import type {
+ MetricSourceId,
+ MetricsViewerDimensionBreakoutState,
+ SourceColorMap,
+} from "metabase/metrics-viewer/types";
+import {
+ type DimensionPickerSidebarCategory,
+ type SourceDisplayInfo,
+ buildDimensionPickerSidebarCategorySelectRows,
+} from "metabase/metrics-viewer/utils";
+import type { MetricSlot } from "metabase/metrics-viewer/utils/metric-slots";
+import { Box, Stack } from "metabase/ui";
+
+import { isCategorySelected } from "../utils";
+
+import { CategoryButton } from "./CategoryButton";
+import S from "./CategoryItem.module.css";
+import { MetricDimensionSelect } from "./MetricDimensionSelect";
+import { SingleMetricDimensionList } from "./SingleMetricDimensionList";
+
+export function CategoryItem({
+ category,
+ activeDimensionBreakout,
+ metricSlots,
+ sourceDataById,
+ sourceColors,
+ isSelected,
+ isExpanded,
+ onCategorySelect,
+ onToggleCategorySettings,
+ onDimensionChange,
+}: {
+ category: DimensionPickerSidebarCategory;
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState;
+ metricSlots: MetricSlot[];
+ sourceDataById: Record<MetricSourceId, SourceDisplayInfo>;
+ sourceColors: SourceColorMap;
+ isSelected: boolean;
+ isExpanded: boolean;
+ onCategorySelect: () => void;
+ onToggleCategorySettings: () => void;
+ onDimensionChange: (slotIndex: number, dimensionId: string) => void;
+}) {
+ const categorySelectRows = getCategorySelectRows({
+ category,
+ activeDimensionBreakout,
+ metricSlots,
+ sourceDataById,
+ sourceColors,
+ });
+ const canConfigure =
+ categorySelectRows.length > 0 &&
+ categorySelectRows.some(
+ (row) => row.options.length > 1 || row.isExpressionToken,
+ );
+
+ return (
+ <Box>
+ <CategoryButton
+ item={category}
+ isSelected={isSelected}
+ canConfigure={canConfigure}
+ isExpanded={isExpanded}
+ onClick={onCategorySelect}
+ onConfigure={onToggleCategorySettings}
+ />
+ {isExpanded && canConfigure && (
+ <Stack className={S.categorySelectList} gap="xs">
+ {metricSlots.length === 1 ? (
+ <SingleMetricDimensionList
+ row={categorySelectRows[0]}
+ onChange={(dimensionId) =>
+ onDimensionChange(categorySelectRows[0].slotIndex, dimensionId)
+ }
+ />
+ ) : (
+ categorySelectRows.map((row) => (
+ <MetricDimensionSelect
+ key={row.slotIndex}
+ row={row}
+ onChange={(dimensionId) =>
+ onDimensionChange(row.slotIndex, dimensionId)
+ }
+ />
+ ))
+ )}
+ </Stack>
+ )}
+ </Box>
+ );
+}
+
+function getCategorySelectRows({
+ category,
+ activeDimensionBreakout,
+ metricSlots,
+ sourceDataById,
+ sourceColors,
+}: {
+ category: DimensionPickerSidebarCategory;
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState;
+ metricSlots: MetricSlot[];
+ sourceDataById: Record<MetricSourceId, SourceDisplayInfo>;
+ sourceColors: SourceColorMap;
+}) {
+ const categoryDimensionBreakout = getCategoryDimensionBreakout({
+ category,
+ activeDimensionBreakout,
+ });
+
+ return buildDimensionPickerSidebarCategorySelectRows({
+ category,
+ activeDimensionBreakout: categoryDimensionBreakout,
+ metricSlots,
+ sourceDataById,
+ sourceColors,
+ });
+}
+
+function getCategoryDimensionBreakout({
+ category,
+ activeDimensionBreakout,
+}: {
+ category: DimensionPickerSidebarCategory;
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState;
+}) {
+ if (isCategorySelected(category, activeDimensionBreakout)) {
+ return activeDimensionBreakout;
+ }
+
+ return {
+ ...activeDimensionBreakout,
+ type: category.dimensionBreakoutInfo.type,
+ label: category.dimensionBreakoutInfo.label,
+ dimensionMapping: {},
+ };
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/MetricDimensionSelect.module.css b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/MetricDimensionSelect.module.css
new file mode 100644
index 00000000000..f7e3e0e2d21
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/MetricDimensionSelect.module.css
@@ -0,0 +1,12 @@
+.metricSelectInput {
+ min-height: 2rem;
+ height: 2rem;
+ border-color: var(--mb-color-border);
+ border-radius: 0.5rem;
+ font-size: 0.875rem;
+ line-height: 1rem;
+}
+
+.metricSelectInput:not(:focus) {
+ cursor: pointer;
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/MetricDimensionSelect.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/MetricDimensionSelect.tsx
new file mode 100644
index 00000000000..0eb7d0836c8
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/MetricDimensionSelect.tsx
@@ -0,0 +1,40 @@
+import { t } from "ttag";
+
+import { SourceColorIndicator } from "metabase/common/components/SourceColorIndicator";
+import type { DimensionPickerSidebarCategorySelectRow } from "metabase/metrics-viewer/utils";
+import { Select } from "metabase/ui";
+
+import S from "./MetricDimensionSelect.module.css";
+
+export function MetricDimensionSelect({
+ row,
+ onChange,
+}: {
+ row: DimensionPickerSidebarCategorySelectRow;
+ onChange: (dimensionId: string) => void;
+}) {
+ return (
+ <Select
+ classNames={{ input: S.metricSelectInput }}
+ aria-label={t`Select dimension for ${row.metricName}`}
+ data={row.options}
+ value={row.value}
+ searchable
+ nothingFoundMessage={t`No fields found`}
+ leftSection={
+ <SourceColorIndicator
+ colors={row.colors}
+ fallbackIcon={row.isExpressionToken ? undefined : "metric"}
+ size={14}
+ />
+ }
+ placeholder={t`Select a dimension`}
+ size="sm"
+ onChange={(value) => {
+ if (value) {
+ onChange(value);
+ }
+ }}
+ />
+ );
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/SingleMetricDimensionList.module.css b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/SingleMetricDimensionList.module.css
new file mode 100644
index 00000000000..f2b30b63d24
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/SingleMetricDimensionList.module.css
@@ -0,0 +1,48 @@
+.root {
+ display: flex;
+ flex-direction: column;
+ gap: 0;
+}
+
+.item {
+ display: grid;
+ grid-template-columns: 1rem minmax(0, 1fr);
+ gap: 0.5rem;
+ align-items: center;
+ width: 100%;
+ height: 2rem;
+ padding-inline: 0.5rem;
+ border-radius: 0.375rem;
+ color: var(--mb-color-text-primary);
+ font-size: 0.875rem;
+ line-height: 1rem;
+}
+
+.item:hover {
+ background-color: var(--mb-color-background-hover);
+}
+
+.item[aria-pressed="true"] {
+ background-color: var(--mb-color-background-selected);
+ border-radius: 0.5rem;
+ color: var(--mb-color-text-brand);
+}
+
+.item[aria-pressed="true"]:hover {
+ background-color: var(--mb-color-background-hover);
+}
+
+.itemIcon {
+ color: currentcolor;
+}
+
+.itemLabel {
+ overflow: hidden;
+ color: currentcolor;
+ font-size: 0.875rem;
+ font-weight: 500;
+ line-height: 1rem;
+ text-align: left;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/SingleMetricDimensionList.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/SingleMetricDimensionList.tsx
new file mode 100644
index 00000000000..94865122c24
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/components/SingleMetricDimensionList.tsx
@@ -0,0 +1,35 @@
+import type { DimensionPickerSidebarCategorySelectRow } from "metabase/metrics-viewer/utils";
+import { Icon, Text, UnstyledButton } from "metabase/ui";
+
+import S from "./SingleMetricDimensionList.module.css";
+
+export function SingleMetricDimensionList({
+ row,
+ onChange,
+}: {
+ row: DimensionPickerSidebarCategorySelectRow;
+ onChange: (dimensionId: string) => void;
+}) {
+ return (
+ <div className={S.root}>
+ {row.options.map((option) => {
+ const isSelected = option.value === row.value;
+
+ return (
+ <UnstyledButton
+ key={option.value}
+ className={S.item}
+ aria-label={option.label}
+ aria-pressed={isSelected}
+ onClick={() => onChange(option.value)}
+ >
+ <Icon className={S.itemIcon} name={option.icon} size={16} />
+ <Text className={S.itemLabel} component="span">
+ {option.label}
+ </Text>
+ </UnstyledButton>
+ );
+ })}
+ </div>
+ );
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/hooks/useDimensionPickerSidebarCategories.ts b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/hooks/useDimensionPickerSidebarCategories.ts
new file mode 100644
index 00000000000..50889a499fd
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/hooks/useDimensionPickerSidebarCategories.ts
@@ -0,0 +1,174 @@
+import { t } from "ttag";
+
+import { useMetricsViewerContext } from "metabase/metrics-viewer/context";
+import type { MetricsViewerDimensionBreakoutType } from "metabase/metrics-viewer/types";
+import {
+ type DimensionBreakoutTypeDefinition,
+ type DimensionPickerItem,
+ type DimensionPickerSidebarCategory,
+ getComparableDimensionKey,
+ getDimensionBreakoutConfig,
+} from "metabase/metrics-viewer/utils";
+import type { MetricSlot } from "metabase/metrics-viewer/utils/metric-slots";
+
+import { useDimensionPickerSidebarSections } from "./useDimensionPickerSidebarSections";
+
+export function useDimensionPickerSidebarCategories(): DimensionPickerSidebarCategory[] {
+ const { metricSlots } = useMetricsViewerContext();
+ const sections = useDimensionPickerSidebarSections();
+ const items = sections
+ .flatMap((section) => section.items)
+ .filter(shouldShowInDefaultSidebar);
+ const categories: DimensionPickerSidebarCategory[] = [];
+ const groupedItems = new Map<string, DimensionPickerItem[]>();
+
+ for (const item of items) {
+ const key = getComparableDimensionKey(item);
+ const existing = groupedItems.get(key);
+ if (existing) {
+ existing.push(item);
+ } else {
+ groupedItems.set(key, [item]);
+ }
+ }
+
+ for (const [key, categoryItems] of groupedItems) {
+ const first = categoryItems[0];
+ const category = buildSidebarCategory(
+ key,
+ getSidebarCategoryName(first),
+ categoryItems,
+ );
+
+ if (
+ metricSlots.length === 0 ||
+ hasMappingForEverySlot(category, metricSlots)
+ ) {
+ categories.push(category);
+ }
+ }
+
+ return categories.sort(sortSidebarCategories);
+}
+
+function buildSidebarCategory(
+ key: string,
+ name: string,
+ items: DimensionPickerItem[],
+): DimensionPickerSidebarCategory {
+ const first = items[0];
+ const dimensionBreakoutInfo = {
+ ...first.dimensionBreakoutInfo,
+ label: name,
+ dimensionMapping: mergeDimensionMappings(items),
+ };
+ const config = getDimensionBreakoutConfig(dimensionBreakoutInfo.type);
+ const shouldUseFixedAggregateId = isTypeKeyedAggregateCategory(key, config);
+
+ return {
+ ...first,
+ key,
+ name,
+ targetItems: items,
+ dimensionBreakoutInfo: shouldUseFixedAggregateId
+ ? { ...dimensionBreakoutInfo, id: config.fixedId }
+ : dimensionBreakoutInfo,
+ };
+}
+
+/** Type-keyed aggregate categories reselect their fixed breakout across related fields. */
+function isTypeKeyedAggregateCategory(
+ key: string,
+ config: DimensionBreakoutTypeDefinition,
+): config is Extract<
+ DimensionBreakoutTypeDefinition,
+ { matchMode: "aggregate" }
+> {
+ return config.matchMode === "aggregate" && key.startsWith("type:");
+}
+
+function shouldShowInDefaultSidebar(item: DimensionPickerItem) {
+ if (item.dimensionBreakoutInfo.type === "numeric") {
+ return false;
+ }
+
+ if (item.dimensionBreakoutInfo.type === "category") {
+ return item.isPreferred !== false;
+ }
+
+ return true;
+}
+
+const SIDEBAR_CATEGORY_ORDER: MetricsViewerDimensionBreakoutType[] = [
+ "time",
+ "geo",
+ "category",
+ "boolean",
+ "numeric",
+ "scalar",
+];
+
+function sortSidebarCategories(
+ first: DimensionPickerSidebarCategory,
+ second: DimensionPickerSidebarCategory,
+) {
+ const typeDiff =
+ SIDEBAR_CATEGORY_ORDER.indexOf(first.dimensionBreakoutInfo.type) -
+ SIDEBAR_CATEGORY_ORDER.indexOf(second.dimensionBreakoutInfo.type);
+
+ if (typeDiff !== 0) {
+ return typeDiff;
+ }
+
+ return first.name.localeCompare(second.name);
+}
+
+function getSidebarCategoryName(item: DimensionPickerItem) {
+ const type = item.dimensionBreakoutInfo.type;
+
+ if (type === "time") {
+ return t`Time`;
+ }
+
+ if (type === "geo" && item.geoSubtype === "country") {
+ return t`Country`;
+ }
+
+ return item.name;
+}
+
+function hasMappingForEverySlot(
+ category: DimensionPickerSidebarCategory,
+ metricSlots: MetricSlot[],
+) {
+ return metricSlots.every(
+ (slot) => category.dimensionBreakoutInfo.dimensionMapping[slot.slotIndex],
+ );
+}
+
+function mergeDimensionMappings(items: DimensionPickerItem[]) {
+ const mapping: Record<number, string> = {};
+
+ const preferredItems = [...items].sort(sortPreferredItemsFirst);
+
+ for (const item of preferredItems) {
+ for (const [slotIndex, dimensionId] of Object.entries(
+ item.dimensionBreakoutInfo.dimensionMapping,
+ )) {
+ if (dimensionId != null) {
+ mapping[Number(slotIndex)] ??= dimensionId;
+ }
+ }
+ }
+
+ return mapping;
+}
+
+function sortPreferredItemsFirst(
+ first: DimensionPickerItem,
+ second: DimensionPickerItem,
+) {
+ return (
+ Number(second.isPreferred === true) - Number(first.isPreferred === true)
+ );
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/hooks/useDimensionPickerSidebarCategories.unit.spec.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/hooks/useDimensionPickerSidebarCategories.unit.spec.tsx
new file mode 100644
index 00000000000..aca6cdde892
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/hooks/useDimensionPickerSidebarCategories.unit.spec.tsx
@@ -0,0 +1,474 @@
+import { renderHook } from "@testing-library/react";
+import type { ReactNode } from "react";
+
+import { MetricsViewerProvider } from "metabase/metrics-viewer/context";
+import { createMockMetricsViewerResult } from "metabase/metrics-viewer/test-utils";
+import type {
+ AvailableDimension,
+ AvailableDimensionsResult,
+ MetricSourceId,
+ SourceDisplayInfo,
+} from "metabase/metrics-viewer/types";
+import type { MetricSlot } from "metabase/metrics-viewer/utils/metric-slots";
+
+import { useDimensionPickerSidebarCategories } from "./useDimensionPickerSidebarCategories";
+
+const REVENUE_SOURCE_ID: MetricSourceId = "metric:1";
+const ORDERS_SOURCE_ID: MetricSourceId = "metric:3";
+
+const REVENUE_DIMENSIONS: AvailableDimension[] = [
+ {
+ icon: "int",
+ group: undefined,
+ canListValues: false,
+ isPreferred: undefined,
+ dimensionBreakoutInfo: {
+ type: "numeric",
+ label: "Amount",
+ dimensionMapping: { 0: "dim-amount" },
+ },
+ },
+ {
+ icon: "label",
+ group: undefined,
+ canListValues: false,
+ isPreferred: true,
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Category",
+ dimensionMapping: { 0: "dim-category" },
+ },
+ },
+ {
+ icon: "calendar",
+ group: undefined,
+ canListValues: false,
+ isPreferred: undefined,
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 0: "dim-created-at" },
+ },
+ },
+ {
+ icon: "io",
+ group: undefined,
+ canListValues: true,
+ isPreferred: undefined,
+ dimensionBreakoutInfo: {
+ type: "boolean",
+ label: "Is Active",
+ dimensionMapping: { 0: "dim-is-active" },
+ },
+ },
+];
+
+function setup({
+ availableDimensions,
+ sourceOrder,
+ sourceDataById,
+ metricSlots = [],
+}: {
+ availableDimensions: AvailableDimensionsResult;
+ sourceOrder: MetricSourceId[];
+ sourceDataById: Record<MetricSourceId, SourceDisplayInfo>;
+ metricSlots?: MetricSlot[];
+}) {
+ return renderHook(() => useDimensionPickerSidebarCategories(), {
+ wrapper({ children }: { children: ReactNode }) {
+ return (
+ <MetricsViewerProvider
+ value={createMockMetricsViewerResult({
+ sidebarAvailableDimensions: availableDimensions,
+ sourceOrder,
+ sourceDataById,
+ metricSlots,
+ })}
+ >
+ {children}
+ </MetricsViewerProvider>
+ );
+ },
+ });
+}
+
+describe("useDimensionPickerSidebarCategories", () => {
+ it("uses a canonical time row instead of raw time fields", () => {
+ const { result } = setup({
+ availableDimensions: {
+ shared: [],
+ bySource: {
+ [REVENUE_SOURCE_ID]: REVENUE_DIMENSIONS,
+ },
+ },
+ sourceOrder: [REVENUE_SOURCE_ID],
+ sourceDataById: {
+ [REVENUE_SOURCE_ID]: { type: "metric", name: "Revenue" },
+ },
+ });
+
+ expect(result.current.map((category) => category.name)).toEqual([
+ "Time",
+ "Category",
+ "Is Active",
+ ]);
+ expect(result.current.find((category) => category.name === "Time")).toEqual(
+ expect.objectContaining({
+ dimensionBreakoutInfo: expect.objectContaining({
+ id: "time",
+ type: "time",
+ label: "Time",
+ dimensionMapping: { 0: "dim-created-at" },
+ }),
+ targetItems: [
+ expect.objectContaining({
+ name: "Created At",
+ dimensionBreakoutInfo: REVENUE_DIMENSIONS[2].dimensionBreakoutInfo,
+ }),
+ ],
+ }),
+ );
+ });
+
+ it("excludes non-preferred raw category fields from the default view", () => {
+ const { result } = setup({
+ availableDimensions: {
+ shared: [],
+ bySource: {
+ [REVENUE_SOURCE_ID]: [
+ {
+ icon: "label",
+ isPreferred: false,
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Address",
+ dimensionMapping: { 0: "dim-address" },
+ },
+ },
+ {
+ icon: "label",
+ isPreferred: true,
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Category",
+ dimensionMapping: { 0: "dim-category" },
+ },
+ },
+ ],
+ },
+ },
+ sourceOrder: [REVENUE_SOURCE_ID],
+ sourceDataById: {
+ [REVENUE_SOURCE_ID]: { type: "metric", name: "Revenue" },
+ },
+ });
+
+ expect(result.current.map((category) => category.name)).toEqual([
+ "Category",
+ ]);
+ });
+
+ it("groups time fields across tables when every metric slot has one", () => {
+ const { result } = setup({
+ availableDimensions: {
+ shared: [],
+ bySource: {
+ [REVENUE_SOURCE_ID]: [
+ {
+ icon: "calendar",
+ group: { id: "orders", type: "main", displayName: "Orders" },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 0: "dim-orders-created-at" },
+ },
+ },
+ ],
+ [ORDERS_SOURCE_ID]: [
+ {
+ icon: "calendar",
+ group: { id: "users", type: "main", displayName: "Users" },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Birth Date",
+ dimensionMapping: { 1: "dim-users-birth-date" },
+ },
+ },
+ ],
+ },
+ },
+ sourceOrder: [REVENUE_SOURCE_ID, ORDERS_SOURCE_ID],
+ sourceDataById: {
+ [REVENUE_SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [ORDERS_SOURCE_ID]: { type: "metric", name: "Orders" },
+ },
+ metricSlots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: REVENUE_SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: ORDERS_SOURCE_ID },
+ ],
+ });
+
+ expect(result.current).toEqual([
+ expect.objectContaining({
+ name: "Time",
+ dimensionBreakoutInfo: expect.objectContaining({
+ type: "time",
+ label: "Time",
+ dimensionMapping: {
+ 0: "dim-orders-created-at",
+ 1: "dim-users-birth-date",
+ },
+ }),
+ }),
+ ]);
+ });
+
+ it("prefers default dimensions when building grouped time categories", () => {
+ const { result } = setup({
+ availableDimensions: {
+ shared: [],
+ bySource: {
+ [REVENUE_SOURCE_ID]: [
+ {
+ icon: "calendar",
+ isPreferred: false,
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Updated At",
+ dimensionMapping: { 0: "dim-updated-at" },
+ },
+ },
+ {
+ icon: "calendar",
+ isPreferred: true,
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 0: "dim-created-at" },
+ },
+ },
+ ],
+ },
+ },
+ sourceOrder: [REVENUE_SOURCE_ID],
+ sourceDataById: {
+ [REVENUE_SOURCE_ID]: { type: "metric", name: "Revenue" },
+ },
+ metricSlots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: REVENUE_SOURCE_ID },
+ ],
+ });
+
+ expect(result.current.find((category) => category.name === "Time")).toEqual(
+ expect.objectContaining({
+ dimensionBreakoutInfo: expect.objectContaining({
+ id: "time",
+ dimensionMapping: { 0: "dim-created-at" },
+ }),
+ }),
+ );
+ });
+
+ it("groups country fields across tables when every metric slot has one", () => {
+ const { result } = setup({
+ availableDimensions: {
+ shared: [],
+ bySource: {
+ [REVENUE_SOURCE_ID]: [
+ {
+ icon: "location",
+ geoSubtype: "country",
+ group: { id: "products", type: "main", displayName: "Products" },
+ dimensionBreakoutInfo: {
+ type: "geo",
+ label: "Product Country",
+ dimensionMapping: { 0: "dim-product-country" },
+ },
+ },
+ ],
+ [ORDERS_SOURCE_ID]: [
+ {
+ icon: "location",
+ geoSubtype: "country",
+ group: { id: "users", type: "main", displayName: "Users" },
+ dimensionBreakoutInfo: {
+ type: "geo",
+ label: "User Country",
+ dimensionMapping: { 1: "dim-user-country" },
+ },
+ },
+ ],
+ },
+ },
+ sourceOrder: [REVENUE_SOURCE_ID, ORDERS_SOURCE_ID],
+ sourceDataById: {
+ [REVENUE_SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [ORDERS_SOURCE_ID]: { type: "metric", name: "Orders" },
+ },
+ metricSlots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: REVENUE_SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: ORDERS_SOURCE_ID },
+ ],
+ });
+
+ expect(result.current).toEqual([
+ expect.objectContaining({
+ name: "Country",
+ targetItems: [
+ expect.objectContaining({ name: "Product Country" }),
+ expect.objectContaining({ name: "User Country" }),
+ ],
+ dimensionBreakoutInfo: expect.objectContaining({
+ id: "geo",
+ type: "geo",
+ label: "Country",
+ dimensionMapping: {
+ 0: "dim-product-country",
+ 1: "dim-user-country",
+ },
+ }),
+ }),
+ ]);
+ });
+
+ it("does not show same-named category fields from different tables as shared", () => {
+ const { result } = setup({
+ availableDimensions: {
+ shared: [],
+ bySource: {
+ [REVENUE_SOURCE_ID]: [
+ {
+ icon: "label",
+ group: { id: "users", type: "main", displayName: "Users" },
+ isPreferred: true,
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Name",
+ dimensionMapping: { 0: "dim-user-name" },
+ },
+ },
+ ],
+ [ORDERS_SOURCE_ID]: [
+ {
+ icon: "label",
+ group: { id: "products", type: "main", displayName: "Products" },
+ isPreferred: true,
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Name",
+ dimensionMapping: { 1: "dim-product-name" },
+ },
+ },
+ ],
+ },
+ },
+ sourceOrder: [REVENUE_SOURCE_ID, ORDERS_SOURCE_ID],
+ sourceDataById: {
+ [REVENUE_SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [ORDERS_SOURCE_ID]: { type: "metric", name: "Orders" },
+ },
+ metricSlots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: REVENUE_SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: ORDERS_SOURCE_ID },
+ ],
+ });
+
+ expect(result.current).toEqual([]);
+ });
+
+ it("shows exact same table and column category fields across all metrics", () => {
+ const { result } = setup({
+ availableDimensions: {
+ shared: [],
+ bySource: {
+ [REVENUE_SOURCE_ID]: [
+ {
+ icon: "label",
+ group: { id: "users", type: "main", displayName: "Users" },
+ isPreferred: true,
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Name",
+ dimensionMapping: { 0: "dim-user-name" },
+ },
+ },
+ ],
+ [ORDERS_SOURCE_ID]: [
+ {
+ icon: "label",
+ group: { id: "users", type: "main", displayName: "Users" },
+ isPreferred: true,
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Name",
+ dimensionMapping: { 1: "dim-user-name" },
+ },
+ },
+ ],
+ },
+ },
+ sourceOrder: [REVENUE_SOURCE_ID, ORDERS_SOURCE_ID],
+ sourceDataById: {
+ [REVENUE_SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [ORDERS_SOURCE_ID]: { type: "metric", name: "Orders" },
+ },
+ metricSlots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: REVENUE_SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: ORDERS_SOURCE_ID },
+ ],
+ });
+
+ expect(result.current).toEqual([
+ expect.objectContaining({
+ name: "Name",
+ dimensionBreakoutInfo: expect.objectContaining({
+ type: "category",
+ label: "Name",
+ dimensionMapping: { 0: "dim-user-name", 1: "dim-user-name" },
+ }),
+ }),
+ ]);
+ });
+
+ it("hides categories that do not match every metric slot", () => {
+ const { result } = setup({
+ availableDimensions: {
+ shared: [],
+ bySource: {
+ [REVENUE_SOURCE_ID]: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 0: "dim-created-at" },
+ },
+ },
+ ],
+ [ORDERS_SOURCE_ID]: [
+ {
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Placed At",
+ dimensionMapping: { 1: "dim-placed-at" },
+ },
+ },
+ ],
+ },
+ },
+ sourceOrder: [REVENUE_SOURCE_ID, ORDERS_SOURCE_ID],
+ sourceDataById: {
+ [REVENUE_SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [ORDERS_SOURCE_ID]: { type: "metric", name: "Orders" },
+ },
+ metricSlots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: REVENUE_SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: ORDERS_SOURCE_ID },
+ { slotIndex: 2, entityIndex: 2, sourceId: "metric:4" },
+ ],
+ });
+
+ expect(result.current).toEqual([]);
+ });
+});
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/hooks/useDimensionPickerSidebarSections.ts b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/hooks/useDimensionPickerSidebarSections.ts
new file mode 100644
index 00000000000..e2b9f8c6622
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/hooks/useDimensionPickerSidebarSections.ts
@@ -0,0 +1,132 @@
+import { t } from "ttag";
+
+import { useMetricsViewerContext } from "metabase/metrics-viewer/context";
+import type {
+ AvailableDimension,
+ MetricSourceId,
+} from "metabase/metrics-viewer/types";
+import type { DimensionPickerSection } from "metabase/metrics-viewer/utils";
+
+export function useDimensionPickerSidebarSections(): DimensionPickerSection[] {
+ const {
+ sidebarAvailableDimensions: availableDimensions,
+ sourceOrder,
+ sourceDataById,
+ } = useMetricsViewerContext();
+
+ const sections: DimensionPickerSection[] = [];
+
+ const splitByGroup = (
+ dimensions: AvailableDimension[],
+ sectionName?: string,
+ options: {
+ isShared?: boolean;
+ sourceId?: MetricSourceId;
+ preferGroupName?: boolean;
+ } = {},
+ ) => {
+ const { preferGroupName, isShared, sourceId } = options;
+ const groups = new Map<string | undefined, AvailableDimension[]>();
+ for (const dimension of dimensions) {
+ const groupId = dimension.group?.id;
+ const existing = groups.get(groupId);
+ if (existing) {
+ existing.push(dimension);
+ } else {
+ groups.set(groupId, [dimension]);
+ }
+ }
+
+ if (groups.size <= 1) {
+ const groupName = dimensions[0]?.group?.displayName;
+ sections.push({
+ name: getDimensionPickerSectionName(
+ sectionName,
+ groupName,
+ preferGroupName,
+ ),
+ isShared,
+ sourceId,
+ items: dimensions.map((dimension) => ({
+ ...dimension,
+ name: dimension.dimensionBreakoutInfo.label,
+ })),
+ });
+ return;
+ }
+
+ const sortedGroups = [...groups.values()].sort(sortDimensionGroups);
+
+ for (const groupDimensions of sortedGroups) {
+ const groupName = groupDimensions[0].group?.displayName;
+ sections.push({
+ name: getDimensionPickerSectionName(
+ sectionName,
+ groupName,
+ preferGroupName,
+ ),
+ isShared,
+ sourceId,
+ items: groupDimensions.map((dimension) => ({
+ ...dimension,
+ name: dimension.dimensionBreakoutInfo.label,
+ })),
+ });
+ }
+ };
+
+ const hasMultipleSources = sourceOrder.length > 1;
+
+ if (hasMultipleSources && availableDimensions.shared.length > 0) {
+ splitByGroup(availableDimensions.shared, t`Shared`, {
+ isShared: true,
+ preferGroupName: true,
+ });
+ }
+
+ for (const sourceId of sourceOrder) {
+ const sourceDimensions = availableDimensions.bySource[sourceId];
+ if (!sourceDimensions || sourceDimensions.length === 0) {
+ continue;
+ }
+
+ if (hasMultipleSources) {
+ const sourceName = sourceDataById[sourceId]?.name ?? sourceId;
+ splitByGroup(sourceDimensions, sourceName, {
+ sourceId,
+ preferGroupName: true,
+ });
+ } else {
+ splitByGroup(sourceDimensions);
+ }
+ }
+
+ return sections;
+}
+
+function getDimensionPickerSectionName(
+ sectionName: string | undefined,
+ groupName: string | undefined,
+ preferGroupName = false,
+) {
+ if (preferGroupName && groupName) {
+ return groupName;
+ }
+
+ if (sectionName && groupName) {
+ return `${sectionName} · ${groupName}`;
+ }
+
+ return sectionName ?? groupName;
+}
+
+function sortDimensionGroups(
+ first: AvailableDimension[],
+ second: AvailableDimension[],
+) {
+ return getDimensionGroupPriority(first) - getDimensionGroupPriority(second);
+}
+
+function getDimensionGroupPriority(dimensions: AvailableDimension[]) {
+ return dimensions[0]?.group?.type === "main" ? 0 : 1;
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/hooks/useDimensionPickerSidebarSections.unit.spec.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/hooks/useDimensionPickerSidebarSections.unit.spec.tsx
new file mode 100644
index 00000000000..1613acefcdf
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/hooks/useDimensionPickerSidebarSections.unit.spec.tsx
@@ -0,0 +1,125 @@
+import { renderHook } from "@testing-library/react";
+import type { ReactNode } from "react";
+
+import { MetricsViewerProvider } from "metabase/metrics-viewer/context";
+import { createMockMetricsViewerResult } from "metabase/metrics-viewer/test-utils";
+import type {
+ AvailableDimensionsResult,
+ MetricSourceId,
+ SourceDisplayInfo,
+} from "metabase/metrics-viewer/types";
+
+import { useDimensionPickerSidebarSections } from "./useDimensionPickerSidebarSections";
+
+const REVENUE_SOURCE_ID: MetricSourceId = "metric:1";
+const ORDERS_SOURCE_ID: MetricSourceId = "metric:3";
+
+function setup({
+ availableDimensions,
+ sourceOrder,
+ sourceDataById,
+}: {
+ availableDimensions: AvailableDimensionsResult;
+ sourceOrder: MetricSourceId[];
+ sourceDataById: Record<MetricSourceId, SourceDisplayInfo>;
+}) {
+ return renderHook(() => useDimensionPickerSidebarSections(), {
+ wrapper({ children }: { children: ReactNode }) {
+ return (
+ <MetricsViewerProvider
+ value={createMockMetricsViewerResult({
+ sidebarAvailableDimensions: availableDimensions,
+ sourceOrder,
+ sourceDataById,
+ })}
+ >
+ {children}
+ </MetricsViewerProvider>
+ );
+ },
+ });
+}
+
+describe("useDimensionPickerSidebarSections", () => {
+ it("uses table names without a Shared prefix for grouped shared dimensions", () => {
+ const { result } = setup({
+ availableDimensions: {
+ shared: [
+ {
+ icon: "label",
+ group: { id: "customers", type: "main", displayName: "Customers" },
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Customer Name",
+ dimensionMapping: {
+ 0: "dim-customer-name",
+ 1: "dim-customer-name",
+ },
+ },
+ },
+ {
+ icon: "calendar",
+ group: { id: "orders", type: "main", displayName: "Orders" },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: {
+ 0: "dim-created-at",
+ 1: "dim-created-at",
+ },
+ },
+ },
+ ],
+ bySource: {},
+ },
+ sourceOrder: [REVENUE_SOURCE_ID, ORDERS_SOURCE_ID],
+ sourceDataById: {
+ [REVENUE_SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [ORDERS_SOURCE_ID]: { type: "metric", name: "Orders" },
+ },
+ });
+
+ expect(result.current).toEqual([
+ expect.objectContaining({ name: "Customers", isShared: true }),
+ expect.objectContaining({ name: "Orders", isShared: true }),
+ ]);
+ });
+
+ it("orders main dimension groups before related groups", () => {
+ const { result } = setup({
+ availableDimensions: {
+ shared: [
+ {
+ icon: "label",
+ group: { id: "users", type: "connection", displayName: "Users" },
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "User Name",
+ dimensionMapping: { 0: "dim-user-name", 1: "dim-user-name" },
+ },
+ },
+ {
+ icon: "calendar",
+ group: { id: "orders", type: "main", displayName: "Orders" },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 0: "dim-created-at", 1: "dim-created-at" },
+ },
+ },
+ ],
+ bySource: {},
+ },
+ sourceOrder: [REVENUE_SOURCE_ID, ORDERS_SOURCE_ID],
+ sourceDataById: {
+ [REVENUE_SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [ORDERS_SOURCE_ID]: { type: "metric", name: "Orders" },
+ },
+ });
+
+ expect(result.current.map((section) => section.name)).toEqual([
+ "Orders",
+ "Users",
+ ]);
+ });
+});
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/index.ts b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/index.ts
new file mode 100644
index 00000000000..a20e4122158
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/index.ts
@@ -0,0 +1 @@
+export { DimensionPickerSidebar } from "./DimensionPickerSidebar";
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/utils.ts b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/utils.ts
new file mode 100644
index 00000000000..e3dba2f64ca
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPickerSidebar/utils.ts
@@ -0,0 +1,140 @@
+import { t } from "ttag";
+
+import type {
+ DimensionBreakoutInfo,
+ MetricsViewerDimensionBreakoutState,
+} from "metabase/metrics-viewer/types";
+import type {
+ DimensionPickerItem,
+ DimensionPickerSection,
+ DimensionPickerSidebarCategory,
+} from "metabase/metrics-viewer/utils";
+
+import type { MetricSlot } from "../../utils/metric-slots";
+
+function getDimensionMappingEntries(
+ dimensionBreakoutInfo:
+ | DimensionBreakoutInfo
+ | MetricsViewerDimensionBreakoutState,
+) {
+ return Object.entries(dimensionBreakoutInfo.dimensionMapping).filter(
+ (entry): entry is [string, string] => entry[1] != null,
+ );
+}
+
+export function hasSameDimensions(
+ item: DimensionPickerItem,
+ dimensionBreakout: MetricsViewerDimensionBreakoutState,
+) {
+ if (item.dimensionBreakoutInfo.type !== dimensionBreakout.type) {
+ return false;
+ }
+
+ const itemEntries = getDimensionMappingEntries(item.dimensionBreakoutInfo);
+ const dimensionBreakoutEntries =
+ getDimensionMappingEntries(dimensionBreakout);
+ return (
+ itemEntries.length === dimensionBreakoutEntries.length &&
+ itemEntries.every(
+ ([slotIndex, dimensionId]) =>
+ dimensionBreakout.dimensionMapping[Number(slotIndex)] === dimensionId,
+ )
+ );
+}
+
+export function hasMatchingDimensions(
+ item: DimensionPickerItem,
+ dimensionBreakout: MetricsViewerDimensionBreakoutState,
+) {
+ if (item.dimensionBreakoutInfo.type !== dimensionBreakout.type) {
+ return false;
+ }
+
+ const itemEntries = getDimensionMappingEntries(item.dimensionBreakoutInfo);
+ return (
+ itemEntries.length > 0 &&
+ itemEntries.every(
+ ([slotIndex, dimensionId]) =>
+ dimensionBreakout.dimensionMapping[Number(slotIndex)] === dimensionId,
+ )
+ );
+}
+
+export function filterSections(
+ sections: DimensionPickerSection[],
+ searchText: string,
+): DimensionPickerSection[] {
+ const trimmedSearchText = searchText.trim().toLocaleLowerCase();
+ if (!trimmedSearchText) {
+ return sections;
+ }
+
+ return sections
+ .map((section) => ({
+ ...section,
+ items: section.items.filter((item) =>
+ item.name.toLocaleLowerCase().includes(trimmedSearchText),
+ ),
+ }))
+ .filter((section) => section.items.length > 0);
+}
+
+export function getSidebarSectionName(sectionName?: string) {
+ if (sectionName === t`Shared`) {
+ return t`Shared dimensions`;
+ }
+
+ return sectionName;
+}
+
+export function getSelectedCategoryKey(
+ categories: DimensionPickerSidebarCategory[],
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState,
+) {
+ return categories.find((category) =>
+ isCategorySelected(category, activeDimensionBreakout),
+ )?.key;
+}
+
+export function isCategorySelected(
+ category: DimensionPickerSidebarCategory,
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState,
+) {
+ if (
+ category.dimensionBreakoutInfo.type === "time" &&
+ activeDimensionBreakout.type === "time"
+ ) {
+ return true;
+ }
+
+ return (
+ hasSameDimensions(category, activeDimensionBreakout) ||
+ category.targetItems.some((item) =>
+ hasSameDimensions(item, activeDimensionBreakout),
+ )
+ );
+}
+
+export function hasMultipleMetricSources(metricSlots: MetricSlot[]) {
+ return new Set(metricSlots.map((slot) => slot.sourceId)).size > 1;
+}
+
+export function getDimensionBreakoutId(item: DimensionPickerItem) {
+ return Object.values(item.dimensionBreakoutInfo.dimensionMapping).find(
+ (dimensionId) => dimensionId != null,
+ );
+}
+
+export function isMatchingActiveDimensionBreakout(
+ item: DimensionPickerItem,
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState,
+) {
+ const dimensionBreakoutId = getDimensionBreakoutId(item);
+
+ return (
+ hasMatchingDimensions(item, activeDimensionBreakout) &&
+ item.dimensionBreakoutInfo.label === activeDimensionBreakout.label &&
+ (dimensionBreakoutId == null ||
+ dimensionBreakoutId === activeDimensionBreakout.id)
+ );
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPillBar/DimensionPillBar.module.css b/frontend/src/metabase/metrics-viewer/components/DimensionPillBar/DimensionPillBar.module.css
new file mode 100644
index 00000000000..95c2419a41f
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPillBar/DimensionPillBar.module.css
@@ -0,0 +1,10 @@
+.container {
+ gap: 0.75rem;
+ padding: 0.25rem 0.75rem;
+ border-radius: 1rem;
+}
+
+.label {
+ padding-block: 0.25rem;
+ user-select: none;
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPillBar/DimensionPillBar.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPillBar/DimensionPillBar.tsx
index 5196e9ded32..36aa5bf70fa 100644
--- a/frontend/src/metabase/metrics-viewer/components/DimensionPillBar/DimensionPillBar.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/DimensionPillBar/DimensionPillBar.tsx
@@ -1,12 +1,12 @@
import type { DimensionOption } from "metabase/common/components/DimensionPill";
-import { DimensionPill } from "metabase/common/components/DimensionPill";
-import { Flex } from "metabase/ui";
+import { SourceColorIndicator } from "metabase/common/components/SourceColorIndicator";
+import { Flex, Text } from "metabase/ui";
import type { DimensionMetadata } from "metabase-lib/metric";
import type { IconName } from "metabase-types/api";
-import type { MetricSourceId } from "../../types/viewer-state";
+import type { MetricSourceId } from "../../types";
-import { ExpressionDimensionPill } from "./ExpressionDimensionPill";
+import S from "./DimensionPillBar.module.css";
// ── Standalone metric pill item ──
@@ -53,56 +53,58 @@ export type DimensionPillBarItem =
export interface DimensionPillBarProps {
items: DimensionPillBarItem[];
- onDimensionChange: (slotIndex: number, dimension: DimensionMetadata) => void;
- onDimensionRemove?: (slotIndex: number) => void;
- disabled?: boolean;
}
-export function DimensionPillBar({
- items,
- onDimensionChange,
- onDimensionRemove,
- disabled,
-}: DimensionPillBarProps) {
+export function DimensionPillBar({ items }: DimensionPillBarProps) {
if (items.length === 0) {
return null;
}
return (
<Flex
+ className={S.container}
bg="background-primary"
- p="xs"
- bdrs="xl"
w="100%"
align="center"
justify="center"
- gap="sm"
wrap="wrap"
- data-testid="metrics-viewer-dimension-pill-container"
+ data-testid="metrics-viewer-dimension-pill-bar"
>
- {items.map((item) =>
- item.type === "expression" ? (
- <ExpressionDimensionPill
- key={`expr-${item.id}`}
- item={item}
- onDimensionChange={onDimensionChange}
- disabled={disabled}
- />
- ) : (
- <DimensionPill
- key={item.id}
- label={item.label}
- icon={item.icon}
- colors={item.colors}
- options={item.availableOptions}
- onSelect={(dimension) => onDimensionChange(item.id, dimension)}
- onRemove={
- onDimensionRemove ? () => onDimensionRemove(item.id) : undefined
- }
- disabled={disabled}
- />
- ),
- )}
+ {items.map((item) => (
+ <DimensionLabel
+ key={item.type === "expression" ? `expr-${item.id}` : item.id}
+ label={item.label}
+ icon={item.icon}
+ colors={item.colors}
+ />
+ ))}
+ </Flex>
+ );
+}
+
+function DimensionLabel({
+ label,
+ icon,
+ colors,
+}: {
+ label?: string;
+ icon?: IconName;
+ colors?: string[];
+}) {
+ if (!label) {
+ return null;
+ }
+
+ return (
+ <Flex align="center" gap="xs" className={S.label}>
+ <SourceColorIndicator
+ colors={colors}
+ fallbackIcon={icon ?? "add"}
+ size={12}
+ />
+ <Text size="sm" lh="1rem" c="text-primary">
+ {label}
+ </Text>
</Flex>
);
}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPillBar/ExpressionDimensionPill.module.css b/frontend/src/metabase/metrics-viewer/components/DimensionPillBar/ExpressionDimensionPill.module.css
deleted file mode 100644
index 2441366f3df..00000000000
--- a/frontend/src/metabase/metrics-viewer/components/DimensionPillBar/ExpressionDimensionPill.module.css
+++ /dev/null
@@ -1,25 +0,0 @@
-.dropdown {
- display: flex;
- flex-direction: column;
- overflow-y: auto;
-}
-
-.dimensionList {
- max-width: 100%;
- color: var(--mb-color-brand);
-}
-
-.accordionItem {
- &:not(:last-child) {
- border-bottom: 1px solid var(--mb-color-border);
- }
-}
-
-.accordionControl {
- padding-block: 0.875rem;
- cursor: pointer;
-}
-
-.accordionControlExpanded {
- padding-bottom: 0.375rem;
-}
diff --git a/frontend/src/metabase/metrics-viewer/components/DimensionPillBar/ExpressionDimensionPill.tsx b/frontend/src/metabase/metrics-viewer/components/DimensionPillBar/ExpressionDimensionPill.tsx
deleted file mode 100644
index e28b065c927..00000000000
--- a/frontend/src/metabase/metrics-viewer/components/DimensionPillBar/ExpressionDimensionPill.tsx
+++ /dev/null
@@ -1,294 +0,0 @@
-import cx from "classnames";
-import { useCallback, useMemo, useState } from "react";
-import { t } from "ttag";
-
-import {
- AccordionList,
- type Section,
-} from "metabase/common/components/AccordionList";
-import type { DimensionOption } from "metabase/common/components/DimensionPill";
-import DPS from "metabase/common/components/DimensionPill/DimensionPill.module.css";
-import { groupIntoSections } from "metabase/common/components/DimensionPill/utils";
-import { SourceColorIndicator } from "metabase/common/components/SourceColorIndicator";
-import {
- Badge,
- Box,
- Flex,
- Icon,
- Popover,
- Text,
- UnstyledButton,
-} from "metabase/ui";
-import type { DimensionMetadata } from "metabase-lib/metric";
-
-import type {
- ExpressionDimensionItem,
- ExpressionMetricSource,
-} from "./DimensionPillBar";
-import S from "./ExpressionDimensionPill.module.css";
-
-const SINGLE_METRIC_LIST_WIDTH = "15rem";
-const MULTI_METRIC_LIST_WIDTH = "20rem";
-
-interface ExpressionDimensionPillProps {
- item: ExpressionDimensionItem;
- onDimensionChange: (slotIndex: number, dimension: DimensionMetadata) => void;
- disabled?: boolean;
-}
-
-function renderItemName(item: DimensionOption) {
- return item.displayName;
-}
-
-function renderItemIcon(item: DimensionOption) {
- return <Icon name={item.icon} />;
-}
-
-function itemIsSelected(item: DimensionOption) {
- return item.selected ?? false;
-}
-
-/**
- * A dimension pill for expression entities. Renders a single pill that, when
- * clicked, opens a popover with per-metric accordion sections so the user can
- * independently pick dimensions for each metric token in the expression.
- *
- * When the expression contains only one metric, the popover shows a flat
- * dimension list (same as a regular DimensionPill).
- */
-export function ExpressionDimensionPill({
- item,
- onDimensionChange,
- disabled,
-}: ExpressionDimensionPillProps) {
- const [isOpen, setIsOpen] = useState(false);
- const [expandedSlots, setExpandedSlots] = useState<number[]>(() =>
- item.metricSources.length > 0 ? [item.metricSources[0].slotIndex] : [],
- );
-
- const hasOptions = item.metricSources.some(
- (s) => s.availableOptions.length > 0,
- );
- const isSingleMetric = item.metricSources.length === 1;
- const isPlaceholder = !item.label;
- const isEmpty = isPlaceholder && !hasOptions;
- const canOpenPopover = hasOptions && !disabled;
-
- const handleToggleExpanded = useCallback((slotIndex: number) => {
- setExpandedSlots((prev) =>
- prev.includes(slotIndex)
- ? prev.filter((s) => s !== slotIndex)
- : [...prev, slotIndex],
- );
- }, []);
-
- let pillLabel: string;
- if (isEmpty) {
- pillLabel = t`No compatible dimensions`;
- } else if (isPlaceholder) {
- pillLabel = t`Select dimensions`;
- } else {
- pillLabel = item.label ?? "";
- }
-
- return (
- <Popover
- opened={isOpen}
- onChange={setIsOpen}
- position="top-start"
- disabled={!canOpenPopover}
- >
- <Popover.Target>
- <Flex
- className={cx(DPS.pill, canOpenPopover && DPS.interactive)}
- align="center"
- gap="xs"
- opacity={disabled || isEmpty ? 0.6 : undefined}
- onClick={canOpenPopover ? () => setIsOpen(true) : undefined}
- data-testid="expression-dimension-pill"
- >
- <SourceColorIndicator colors={item.colors} fallbackIcon={item.icon} />
- <Text size="sm" lh={1} c={isEmpty ? "text-tertiary" : undefined}>
- {pillLabel}
- </Text>
- </Flex>
- </Popover.Target>
- <Popover.Dropdown
- px={0}
- py="xs"
- w={isSingleMetric ? SINGLE_METRIC_LIST_WIDTH : MULTI_METRIC_LIST_WIDTH}
- mah={300}
- className={S.dropdown}
- >
- {isSingleMetric ? (
- <SingleMetricContent
- source={item.metricSources[0]}
- onDimensionChange={onDimensionChange}
- onClose={() => setIsOpen(false)}
- />
- ) : (
- <MultiMetricContent
- sources={item.metricSources}
- expandedSlots={expandedSlots}
- onToggleExpanded={handleToggleExpanded}
- onDimensionChange={onDimensionChange}
- onClose={() => setIsOpen(false)}
- />
- )}
- </Popover.Dropdown>
- </Popover>
- );
-}
-
-// ── Single metric: flat dimension list ──
-
-interface SingleMetricContentProps {
- source: ExpressionMetricSource;
- onDimensionChange: (slotIndex: number, dimension: DimensionMetadata) => void;
- onClose: () => void;
-}
-
-function SingleMetricContent({
- source,
- onDimensionChange,
- onClose,
-}: SingleMetricContentProps) {
- const sections = useMemo(
- () => groupIntoSections(source.availableOptions),
- [source.availableOptions],
- );
-
- const handleSelect = useCallback(
- (option: DimensionOption) => {
- onDimensionChange(source.slotIndex, option.dimension);
- onClose();
- },
- [onDimensionChange, source.slotIndex, onClose],
- );
-
- return (
- <AccordionList
- className={S.dimensionList}
- sections={sections}
- onChange={handleSelect}
- renderItemName={renderItemName}
- renderItemIcon={renderItemIcon}
- itemIsSelected={itemIsSelected}
- alwaysExpanded
- maxHeight={Infinity}
- width={SINGLE_METRIC_LIST_WIDTH}
- />
- );
-}
-
-// ── Multiple metrics: accordion sections ──
-
-interface MultiMetricContentProps {
- sources: ExpressionMetricSource[];
- expandedSlots: number[];
- onToggleExpanded: (slotIndex: number) => void;
- onDimensionChange: (slotIndex: number, dimension: DimensionMetadata) => void;
- onClose: () => void;
-}
-
-function MultiMetricContent({
- sources,
- expandedSlots,
- onToggleExpanded,
- onDimensionChange,
- onClose,
-}: MultiMetricContentProps) {
- return (
- <Box>
- {sources.map((source) => {
- const isExpanded = expandedSlots.includes(source.slotIndex);
- const hasDimensions = source.availableOptions.length > 0;
- const showDimensions = isExpanded && hasDimensions;
-
- return (
- <MetricAccordionItem
- key={source.slotIndex}
- source={source}
- isExpanded={isExpanded}
- showDimensions={showDimensions}
- onToggle={() => onToggleExpanded(source.slotIndex)}
- onDimensionChange={onDimensionChange}
- onClose={onClose}
- />
- );
- })}
- </Box>
- );
-}
-
-interface MetricAccordionItemProps {
- source: ExpressionMetricSource;
- isExpanded: boolean;
- showDimensions: boolean;
- onToggle: () => void;
- onDimensionChange: (slotIndex: number, dimension: DimensionMetadata) => void;
- onClose: () => void;
-}
-
-function MetricAccordionItem({
- source,
- isExpanded,
- showDimensions,
- onToggle,
- onDimensionChange,
- onClose,
-}: MetricAccordionItemProps) {
- const sections: Section<DimensionOption>[] = useMemo(
- () => groupIntoSections(source.availableOptions),
- [source.availableOptions],
- );
-
- const handleSelect = useCallback(
- (option: DimensionOption) => {
- onDimensionChange(source.slotIndex, option.dimension);
- onClose();
- },
- [onDimensionChange, source.slotIndex, onClose],
- );
-
- return (
- <Box className={S.accordionItem} data-testid="expression-metric-section">
- <UnstyledButton
- className={cx(S.accordionControl, {
- [S.accordionControlExpanded]: showDimensions,
- })}
- onClick={onToggle}
- w="100%"
- data-testid="expression-metric-header"
- >
- <Flex align="center" gap="sm" px="md">
- <SourceColorIndicator colors={source.colors} size={16} />
- <Flex align="center" gap="xs" fw={700} style={{ flex: 1 }}>
- <span>{source.metricName}</span>
- {(source.metricCount ?? 0) > 1 && (
- <Badge circle c="text-hover">
- {source.metricCount}
- </Badge>
- )}
- </Flex>
- <Icon name={isExpanded ? "chevronup" : "chevrondown"} size={12} />
- </Flex>
- </UnstyledButton>
- {showDimensions && (
- <Box pb="sm">
- <AccordionList
- className={S.dimensionList}
- sections={sections}
- onChange={handleSelect}
- renderItemName={renderItemName}
- renderItemIcon={renderItemIcon}
- itemIsSelected={itemIsSelected}
- alwaysExpanded
- maxHeight={Infinity}
- width="100%"
- />
- </Box>
- )}
- </Box>
- );
-}
diff --git a/frontend/src/metabase/metrics-viewer/components/EmptyState/MetricViewerEmptyState.tsx b/frontend/src/metabase/metrics-viewer/components/EmptyState/MetricViewerEmptyState.tsx
index bf9e0b54de3..325a5768b03 100644
--- a/frontend/src/metabase/metrics-viewer/components/EmptyState/MetricViewerEmptyState.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/EmptyState/MetricViewerEmptyState.tsx
@@ -43,7 +43,7 @@ export function MetricsViewerEmptyState(): JSX.Element {
);
}
-export function MetricsViewerNoTabsEmptyState(): JSX.Element {
+export function MetricsViewerNoDimensionBreakoutEmptyState(): JSX.Element {
return (
<MetricsViewerEmptyStateLayout
title={t`Select a dimension to explore`}
diff --git a/frontend/src/metabase/metrics-viewer/components/EmptyState/index.ts b/frontend/src/metabase/metrics-viewer/components/EmptyState/index.ts
index cd8572dad54..704de6d11d1 100644
--- a/frontend/src/metabase/metrics-viewer/components/EmptyState/index.ts
+++ b/frontend/src/metabase/metrics-viewer/components/EmptyState/index.ts
@@ -1,4 +1,4 @@
export {
MetricsViewerEmptyState,
- MetricsViewerNoTabsEmptyState,
+ MetricsViewerNoDimensionBreakoutEmptyState,
} from "./MetricViewerEmptyState";
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricControls/BinningButton/BinningButton.tsx b/frontend/src/metabase/metrics-viewer/components/MetricControls/BinningButton/BinningButton.tsx
index d4d9775bf0c..6225cde8854 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricControls/BinningButton/BinningButton.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricControls/BinningButton/BinningButton.tsx
@@ -1,7 +1,7 @@
import { useMemo, useState } from "react";
import { t } from "ttag";
-import { Box, Button, DefaultSelectItem, Icon, Popover } from "metabase/ui";
+import { Box, Button, DefaultSelectItem, Popover } from "metabase/ui";
import type {
DimensionMetadata,
MetricDefinition,
@@ -10,6 +10,7 @@ import type {
import * as LibMetric from "metabase-lib/metric";
import { UNBINNED } from "../../../constants";
+import S from "../MetricControls.module.css";
const MIN_WIDTH = "11.25rem";
@@ -72,12 +73,14 @@ export function BinningButton({
<Popover opened={isOpen} onChange={setIsOpen}>
<Popover.Target>
<Button
- fw="bold"
- py="xs"
- px="sm"
+ className={S.controlButton}
+ h="2rem"
+ fw={400}
+ py={0}
+ px="md"
+ bdrs="md"
variant="subtle"
color="text-primary"
- rightSection={<Icon name="chevrondown" size={12} />}
onClick={() => setIsOpen(!isOpen)}
>
{displayLabel}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricControls/BucketButton/BucketButton.tsx b/frontend/src/metabase/metrics-viewer/components/MetricControls/BucketButton/BucketButton.tsx
index 95c64ae16c9..000694d670b 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricControls/BucketButton/BucketButton.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricControls/BucketButton/BucketButton.tsx
@@ -3,7 +3,7 @@ import { t } from "ttag";
import { TemporalBucketPicker } from "metabase/metrics/components/TemporalBucketPicker";
import type { DimensionWithDefinition } from "metabase/metrics/types";
-import { Button, Icon, Popover } from "metabase/ui";
+import { Button, Popover } from "metabase/ui";
import * as Lib from "metabase-lib";
import type {
DimensionMetadata,
@@ -13,6 +13,8 @@ import type {
import * as LibMetric from "metabase-lib/metric";
import type { TemporalUnit } from "metabase-types/api";
+import S from "../MetricControls.module.css";
+
type BucketButtonProps = {
definition: MetricDefinition;
dimension: DimensionMetadata;
@@ -54,14 +56,15 @@ export function BucketButton({
<Popover opened={isOpen} onChange={setIsOpen}>
<Popover.Target>
<Button
- w={184}
+ className={S.controlButton}
justify="space-between"
- fw="bold"
- py="xs"
- px="sm"
+ h="2rem"
+ fw={400}
+ py={0}
+ px="md"
+ bdrs="md"
variant="subtle"
color="text-primary"
- rightSection={<Icon name="chevrondown" size={12} />}
onClick={() => setIsOpen(!isOpen)}
>
{currentUnit
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/ChartLayoutPicker.module.css b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/ChartLayoutPicker.module.css
index a1ac75000c6..5108f8e181e 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/ChartLayoutPicker.module.css
+++ b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/ChartLayoutPicker.module.css
@@ -1,3 +1,11 @@
+.root button {
+ min-height: 1.5rem;
+}
+
+.root button:not(.selected):hover {
+ background-color: rgba(7, 23, 34, 0.05);
+}
+
.selected {
box-shadow: 0 1px 2px var(--mb-color-shadow);
}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/ChartLayoutPicker.tsx b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/ChartLayoutPicker.tsx
index e78c42b699d..55708eed54a 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/ChartLayoutPicker.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/ChartLayoutPicker.tsx
@@ -16,6 +16,7 @@ export function ChartLayoutPicker({
}: ChartLayoutPickerProps) {
return (
<Flex
+ className={S.root}
gap="xs"
bg="background-secondary"
p="xs"
@@ -25,6 +26,7 @@ export function ChartLayoutPicker({
<Tooltip label={t`Default layout`}>
<ActionIcon
w="2rem"
+ h="1.5rem"
variant={!isStacked ? "filled" : "subtle"}
bg={!isStacked ? "background-primary" : undefined}
onClick={() => onToggle(false)}
@@ -40,6 +42,7 @@ export function ChartLayoutPicker({
<Tooltip label={t`Stack layout`}>
<ActionIcon
w="2rem"
+ h="1.5rem"
variant={isStacked ? "filled" : "subtle"}
bg={isStacked ? "background-primary" : undefined}
onClick={() => {
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartTypePicker/ChartTypePicker.module.css b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartTypePicker/ChartTypePicker.module.css
index a1ac75000c6..5108f8e181e 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartTypePicker/ChartTypePicker.module.css
+++ b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartTypePicker/ChartTypePicker.module.css
@@ -1,3 +1,11 @@
+.root button {
+ min-height: 1.5rem;
+}
+
+.root button:not(.selected):hover {
+ background-color: rgba(7, 23, 34, 0.05);
+}
+
.selected {
box-shadow: 0 1px 2px var(--mb-color-shadow);
}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartTypePicker/ChartTypePicker.tsx b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartTypePicker/ChartTypePicker.tsx
index bf34264ed3d..248a1522e48 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartTypePicker/ChartTypePicker.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartTypePicker/ChartTypePicker.tsx
@@ -1,7 +1,7 @@
import { ActionIcon, Flex, Icon } from "metabase/ui";
import type { MetricsViewerDisplayType } from "../../../types/viewer-state";
-import type { ChartTypeOption } from "../../../utils/tab-config";
+import type { ChartTypeOption } from "../../../utils/dimension-breakout-config";
import S from "./ChartTypePicker.module.css";
@@ -17,10 +17,17 @@ export function ChartTypePicker({
onChange,
}: ChartTypePickerProps) {
return (
- <Flex gap="xs" bg="background-secondary" p="xs" bdrs="md">
+ <Flex
+ className={S.root}
+ gap="xs"
+ bg="background-secondary"
+ p="xs"
+ bdrs="md"
+ >
{chartTypes.map(({ type, icon }) => (
<ActionIcon
w="2rem"
+ h="1.5rem"
key={type}
variant={value === type ? "filled" : "subtle"}
bg={value === type ? "background-primary" : undefined}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartTypePicker/index.ts b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartTypePicker/index.ts
index 6f5a9434e03..b33f2c7a814 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartTypePicker/index.ts
+++ b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartTypePicker/index.ts
@@ -1,2 +1,2 @@
export { ChartTypePicker } from "./ChartTypePicker";
-export type { ChartTypeOption } from "../../../utils/tab-config";
+export type { ChartTypeOption } from "../../../utils/dimension-breakout-config";
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricControls/DimensionFilterButton/DimensionFilterButton.tsx b/frontend/src/metabase/metrics-viewer/components/MetricControls/DimensionFilterButton/DimensionFilterButton.tsx
index b2ca2902e35..57766515672 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricControls/DimensionFilterButton/DimensionFilterButton.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricControls/DimensionFilterButton/DimensionFilterButton.tsx
@@ -7,7 +7,7 @@ import {
trackMetricsViewerFilterEdited,
trackMetricsViewerFilterRemoved,
} from "metabase/metrics-viewer/analytics";
-import { Button, Icon, Popover } from "metabase/ui";
+import { Button, Popover } from "metabase/ui";
import type {
DimensionMetadata,
FilterClause,
@@ -20,6 +20,7 @@ import {
buildDimensionFilterClause,
parseFilter,
} from "../../../utils/dimension-filters";
+import S from "../MetricControls.module.css";
import { getFilterDisplayName } from "./utils";
@@ -85,14 +86,15 @@ export function DimensionFilterButton({
<Popover opened={isOpen} onChange={setIsOpen}>
<Popover.Target>
<Button
- w={184}
+ className={S.controlButton}
justify="space-between"
- fw="bold"
- py="xs"
- px="sm"
+ h="2rem"
+ fw={400}
+ py={0}
+ px="md"
+ bdrs="md"
variant="subtle"
color="text-primary"
- rightSection={<Icon name="chevrondown" size={12} />}
onClick={() => setIsOpen(!isOpen)}
>
{filterName}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricControls/MetricControls.module.css b/frontend/src/metabase/metrics-viewer/components/MetricControls/MetricControls.module.css
index 3ed5ad630fe..71c2d22ca90 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricControls/MetricControls.module.css
+++ b/frontend/src/metabase/metrics-viewer/components/MetricControls/MetricControls.module.css
@@ -1,3 +1,68 @@
-.divider {
- align-self: stretch;
+.root {
+ --control-hover-color: rgba(7, 23, 34, 0.05);
+ --ellipsis-button-size: 2rem;
+
+ position: relative;
+ width: 100%;
+ height: 2.5rem;
+}
+
+.leftControls {
+ position: absolute;
+ top: 0.25rem;
+ left: 0;
+}
+
+.centerCluster {
+ left: 50%;
+ max-width: 100%;
+ position: absolute;
+ top: 0;
+ transform: translateX(-50%);
+}
+
+.centerControls {
+ background: var(--mb-color-background-primary);
+ border-radius: 0.75rem;
+ border: 1px solid var(--mb-color-border);
+ box-sizing: border-box;
+ height: 2.5rem;
+ overflow: hidden;
+}
+
+.controlSection {
+ display: flex;
+ align-items: center;
+ padding: 0.25rem;
+}
+
+.controlSection + .controlSection {
+ border-left: 1px solid var(--mb-color-border);
+}
+
+.controlButton {
+ height: 2rem;
+ padding-inline: 1rem;
+ border-radius: 0.5rem;
+
+ &.controlButton:hover {
+ color: var(--mb-color-text-primary);
+ background-color: var(--control-hover-color);
+ }
+}
+
+.ellipsisMenuButton {
+ border-radius: 0.5rem;
+ height: var(--ellipsis-button-size);
+ position: absolute;
+ /** Make the container be centered without taking the ellipsis menu button into consideration */
+ right: calc(
+ -1 * calc(var(--mantine-spacing-sm) + var(--ellipsis-button-size))
+ );
+ top: 0.25rem;
+ width: var(--ellipsis-button-size);
+
+ &.ellipsisMenuButton:hover {
+ background-color: var(--control-hover-color);
+ }
}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricControls/MetricControls.tsx b/frontend/src/metabase/metrics-viewer/components/MetricControls/MetricControls.tsx
index dc244f83b11..7bc44125864 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricControls/MetricControls.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricControls/MetricControls.tsx
@@ -1,16 +1,22 @@
-import { useMemo } from "react";
-
-import { Divider, Flex } from "metabase/ui";
-import type { DimensionMetadata, MetricDefinition } from "metabase-lib/metric";
-import type { TemporalUnit, VisualizationSettings } from "metabase-types/api";
+import type { ReactNode } from "react";
+import { useCallback, useMemo } from "react";
+import { t } from "ttag";
+import { useMetricsViewerContext } from "metabase/metrics-viewer/context";
import type {
+ MetricsViewerDimensionBreakoutProjectionConfig,
+ MetricsViewerDimensionBreakoutType,
MetricsViewerDisplayType,
- MetricsViewerTabType,
-} from "../../types/viewer-state";
-import { getProjectionInfo } from "../../utils/definition-builder";
-import type { DimensionFilterValue } from "../../utils/dimension-filters";
-import { getTabConfig } from "../../utils/tab-config";
+} from "metabase/metrics-viewer/types";
+import {
+ type DimensionFilterValue,
+ getDimensionBreakoutConfig,
+ getDimensionIcon,
+ getProjectionInfo,
+} from "metabase/metrics-viewer/utils";
+import { ActionIcon, Box, Button, Flex, Icon, Menu, Switch } from "metabase/ui";
+import type { DimensionMetadata, MetricDefinition } from "metabase-lib/metric";
+import type { TemporalUnit, VisualizationSettings } from "metabase-types/api";
import { BinningButton } from "./BinningButton";
import { BucketButton } from "./BucketButton";
@@ -19,50 +25,118 @@ import { ChartTypePicker } from "./ChartTypePicker";
import { DimensionFilterButton } from "./DimensionFilterButton";
import S from "./MetricControls.module.css";
-function isValidDisplayTypeForTab(
+function isValidDisplayTypeForDimensionBreakout(
displayType: MetricsViewerDisplayType,
- tabType: MetricsViewerTabType,
+ dimensionBreakoutType: MetricsViewerDimensionBreakoutType,
): boolean {
- const config = getTabConfig(tabType);
+ const config = getDimensionBreakoutConfig(dimensionBreakoutType);
return config.availableDisplayTypes.some((t) => t.type === displayType);
}
type MetricControlsProps = {
definition: MetricDefinition;
- displayType: MetricsViewerDisplayType;
- tabType: MetricsViewerTabType;
- dimensionFilter?: DimensionFilterValue;
allFilterDimensions?: DimensionMetadata[];
- onDisplayTypeChange: (displayType: MetricsViewerDisplayType) => void;
- onDimensionFilterChange: (value: DimensionFilterValue | undefined) => void;
- onTemporalUnitChange: (unit: TemporalUnit | undefined) => void;
- onBinningChange: (binningStrategy: string | undefined) => void;
showStackSeries?: boolean;
- visualizationSettings?: Partial<VisualizationSettings>;
- onVisualizationSettingsChange?: (
- updates: Partial<VisualizationSettings>,
- ) => void;
+ canToggleColumnLabels?: boolean;
};
+function ControlSection({ children }: { children: ReactNode }) {
+ return <Box className={S.controlSection}>{children}</Box>;
+}
+
export function MetricControls({
definition,
- displayType,
- tabType,
- dimensionFilter,
allFilterDimensions,
- onDisplayTypeChange,
- onDimensionFilterChange,
- onTemporalUnitChange,
- onBinningChange,
showStackSeries,
- visualizationSettings,
- onVisualizationSettingsChange,
+ canToggleColumnLabels,
}: MetricControlsProps) {
+ const {
+ activeDimensionBreakout: dimensionBreakout,
+ availableDimensions,
+ sourceOrder,
+ showColumnLabels,
+ setShowColumnLabels,
+ updateActiveDimensionBreakout: onDimensionBreakoutUpdate,
+ openSidebar,
+ } = useMetricsViewerContext();
+
+ const updateProjectionConfig = useCallback(
+ (updates: Partial<MetricsViewerDimensionBreakoutProjectionConfig>) => {
+ onDimensionBreakoutUpdate({
+ projectionConfig: {
+ ...dimensionBreakout?.projectionConfig,
+ ...updates,
+ },
+ });
+ },
+ [onDimensionBreakoutUpdate, dimensionBreakout?.projectionConfig],
+ );
+
+ const handleDisplayTypeChange = useCallback(
+ (display: MetricsViewerDisplayType) => {
+ onDimensionBreakoutUpdate({ display });
+ },
+ [onDimensionBreakoutUpdate],
+ );
+
+ const handleDimensionFilterChange = useCallback(
+ (value: DimensionFilterValue | undefined) => {
+ updateProjectionConfig({ dimensionFilter: value });
+ },
+ [updateProjectionConfig],
+ );
+
+ const handleTemporalUnitChange = useCallback(
+ (unit: TemporalUnit | undefined) => {
+ updateProjectionConfig({ temporalUnit: unit });
+ },
+ [updateProjectionConfig],
+ );
+
+ const handleBinningChange = useCallback(
+ (binningStrategy: string | undefined) => {
+ updateProjectionConfig({ binningStrategy });
+ },
+ [updateProjectionConfig],
+ );
+
+ const handleShowColumnLabelsChange = useCallback(
+ (showColumnLabels: boolean) => {
+ setShowColumnLabels(showColumnLabels);
+ },
+ [setShowColumnLabels],
+ );
+
+ const handleVisualizationSettingsChange = useCallback(
+ (updates: Partial<VisualizationSettings>) => {
+ onDimensionBreakoutUpdate({
+ visualizationSettings: {
+ ...dimensionBreakout?.visualizationSettings,
+ ...updates,
+ },
+ });
+ },
+ [onDimensionBreakoutUpdate, dimensionBreakout?.visualizationSettings],
+ );
+
const projectionInfo = useMemo(
() => getProjectionInfo(definition),
[definition],
);
+ if (!dimensionBreakout) {
+ return null;
+ }
+
+ const {
+ type: dimensionBreakoutType,
+ label: dimensionBreakoutLabel,
+ display: displayType,
+ projectionConfig,
+ visualizationSettings,
+ } = dimensionBreakout;
+ const dimensionFilter = projectionConfig.dimensionFilter;
+
const hasFilterControls =
projectionInfo.projection && projectionInfo.filterDimension;
@@ -75,77 +149,159 @@ export function MetricControls({
projectionInfo.projectionDimension &&
(projectionInfo.isBinnable || projectionInfo.hasBinning);
- const config = getTabConfig(tabType);
+ const config = getDimensionBreakoutConfig(dimensionBreakoutType);
const chartTypes = config.availableDisplayTypes;
- const effectiveDisplayType = isValidDisplayTypeForTab(displayType, tabType)
+ const effectiveDisplayType = isValidDisplayTypeForDimensionBreakout(
+ displayType,
+ dimensionBreakoutType,
+ )
? displayType
: config.defaultDisplayType;
+ const hasSharedDimensions = availableDimensions.shared.length > 0;
+ const hasAnySourceDimensions = sourceOrder.some(
+ (sourceId) => (availableDimensions.bySource[sourceId]?.length ?? 0) > 0,
+ );
+ const hasAvailableDimensions = hasSharedDimensions || hasAnySourceDimensions;
+ const columnPickerLabel =
+ dimensionBreakoutType === "time"
+ ? t`Time`
+ : (dimensionBreakoutLabel ?? t`Select column`);
+ const columnPickerIcon = projectionInfo.projectionDimension
+ ? getDimensionIcon(projectionInfo.projectionDimension)
+ : undefined;
+
+ const hasCenterControls =
+ hasFilterControls || hasBucketControls || hasBinningControls;
+
+ if (dimensionBreakoutType === "scalar") {
+ return (
+ <Box className={S.root} data-testid="metrics-viewer-controls">
+ <Flex className={S.centerCluster}>
+ <Flex className={S.centerControls} align="center">
+ <ControlSection>
+ <Button
+ className={S.controlButton}
+ fw="bold"
+ aria-label={t`No breakout`}
+ variant="subtle"
+ color="text-primary"
+ leftSection={<Icon c="brand" name="unreferenced" size={16} />}
+ onClick={openSidebar}
+ >
+ {t`No breakout`}
+ </Button>
+ </ControlSection>
+ </Flex>
+ </Flex>
+ </Box>
+ );
+ }
+
return (
- <Flex
- maw="100%"
- h="3rem"
- display="inline-flex"
- bg="background-primary"
- bd="1px solid var(--mb-color-border)"
- bdrs="lg"
- px="sm"
- align="center"
- gap="xs"
- data-testid="metrics-viewer-controls"
- >
- <ChartTypePicker
- chartTypes={chartTypes}
- value={effectiveDisplayType}
- onChange={onDisplayTypeChange}
- />
- {showStackSeries && onVisualizationSettingsChange && (
- <>
- <Divider orientation="vertical" className={S.divider} mx="xs" />
+ <Box className={S.root} data-testid="metrics-viewer-controls">
+ <Flex className={S.leftControls} align="center" gap="md">
+ <ChartTypePicker
+ chartTypes={chartTypes}
+ value={effectiveDisplayType}
+ onChange={handleDisplayTypeChange}
+ />
+ {showStackSeries && (
<ChartLayoutPicker
isStacked={!!visualizationSettings?.["graph.split_panels"]}
onToggle={(stacked) =>
- onVisualizationSettingsChange({
+ handleVisualizationSettingsChange({
"graph.split_panels": stacked,
})
}
/>
- </>
- )}
- {hasFilterControls && projectionInfo.filterDimension && (
- <>
- <Divider orientation="vertical" className={S.divider} mx="xs" />
- <DimensionFilterButton
- definition={definition}
- filterDimension={projectionInfo.filterDimension}
- dimensionFilter={dimensionFilter}
- allFilterDimensions={allFilterDimensions}
- onChange={onDimensionFilterChange}
- />
- </>
- )}
- {hasBucketControls && projectionInfo.projectionDimension && (
- <>
- <Divider orientation="vertical" className={S.divider} mx="xs" />
- <BucketButton
- definition={definition}
- dimension={projectionInfo.projectionDimension}
- projection={projectionInfo.projection!}
- onChange={onTemporalUnitChange}
- />
- </>
- )}
- {hasBinningControls && projectionInfo.projectionDimension && (
- <>
- <Divider orientation="vertical" className={S.divider} mx="xs" />
- <BinningButton
- definition={definition}
- dimension={projectionInfo.projectionDimension}
- projection={projectionInfo.projection!}
- onBinningChange={onBinningChange}
- />
- </>
+ )}
+ </Flex>
+ {(hasCenterControls || canToggleColumnLabels) && (
+ <Box className={S.centerCluster}>
+ {hasCenterControls && (
+ <Flex className={S.centerControls} align="center">
+ {hasFilterControls && projectionInfo.filterDimension && (
+ <>
+ {hasAvailableDimensions && (
+ <ControlSection>
+ <Button
+ className={S.controlButton}
+ justify="space-between"
+ fw="bold"
+ aria-label={t`Change column`}
+ variant="subtle"
+ color="text-primary"
+ leftSection={
+ columnPickerIcon ? (
+ <Icon c="brand" name={columnPickerIcon} size={16} />
+ ) : undefined
+ }
+ onClick={openSidebar}
+ >
+ {columnPickerLabel}
+ </Button>
+ </ControlSection>
+ )}
+ <ControlSection>
+ <DimensionFilterButton
+ definition={definition}
+ filterDimension={projectionInfo.filterDimension}
+ dimensionFilter={dimensionFilter}
+ allFilterDimensions={allFilterDimensions}
+ onChange={handleDimensionFilterChange}
+ />
+ </ControlSection>
+ </>
+ )}
+ {hasBucketControls && projectionInfo.projectionDimension && (
+ <ControlSection>
+ <BucketButton
+ definition={definition}
+ dimension={projectionInfo.projectionDimension}
+ projection={projectionInfo.projection!}
+ onChange={handleTemporalUnitChange}
+ />
+ </ControlSection>
+ )}
+ {hasBinningControls && projectionInfo.projectionDimension && (
+ <ControlSection>
+ <BinningButton
+ definition={definition}
+ dimension={projectionInfo.projectionDimension}
+ projection={projectionInfo.projection!}
+ onBinningChange={handleBinningChange}
+ />
+ </ControlSection>
+ )}
+ </Flex>
+ )}
+ {canToggleColumnLabels && (
+ <Menu position="bottom-start" withinPortal>
+ <Menu.Target>
+ <ActionIcon
+ className={S.ellipsisMenuButton}
+ aria-label={t`Column label options`}
+ variant="subtle"
+ >
+ <Icon name="ellipsis" c="text-primary" />
+ </ActionIcon>
+ </Menu.Target>
+ <Menu.Dropdown p="md">
+ <Switch
+ label={t`Show column labels`}
+ size="sm"
+ labelPosition="right"
+ checked={showColumnLabels}
+ onChange={(event) =>
+ handleShowColumnLabelsChange(event.currentTarget.checked)
+ }
+ />
+ </Menu.Dropdown>
+ </Menu>
+ )}
+ </Box>
)}
- </Flex>
+ </Box>
);
}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricExpressionPill/MetricExpressionPill.module.css b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricExpressionPill/MetricExpressionPill.module.css
index f65b1dabda0..75b4654f7c7 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricExpressionPill/MetricExpressionPill.module.css
+++ b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricExpressionPill/MetricExpressionPill.module.css
@@ -33,3 +33,7 @@
cursor: text;
}
}
+
+.disabledText {
+ color: var(--mb-color-text-tertiary);
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricExpressionPill/MetricExpressionPill.tsx b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricExpressionPill/MetricExpressionPill.tsx
index 7f1f020bae0..500bdd78221 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricExpressionPill/MetricExpressionPill.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricExpressionPill/MetricExpressionPill.tsx
@@ -1,11 +1,12 @@
+import cx from "classnames";
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
import { t } from "ttag";
import { EditableText } from "metabase/common/components/EditableText";
import { SourceColorIndicator } from "metabase/common/components/SourceColorIndicator";
+import type { ExpressionDefinitionEntry } from "metabase/metrics-viewer/types";
import { Badge, Flex, Icon, Menu, Pill } from "metabase/ui";
-import type { ExpressionDefinitionEntry } from "../../../types/viewer-state";
import {
type MetricNameMap,
buildExpressionForPill,
@@ -18,6 +19,7 @@ type MetricExpressionPillProps = {
expressionEntry: ExpressionDefinitionEntry;
metricNames: MetricNameMap;
colors?: string[];
+ isDisabled?: boolean;
onNameChange: (name: string) => void;
onRemove: () => void;
onEdit: () => void;
@@ -27,6 +29,7 @@ export function MetricExpressionPill({
expressionEntry,
metricNames,
colors,
+ isDisabled,
onNameChange,
onRemove,
onEdit,
@@ -107,10 +110,12 @@ export function MetricExpressionPill({
ml: 0,
"aria-label": t`Remove expression`,
}}
- data-testid="metrics-viewer-search-pill"
+ data-testid="metrics-viewer-expression-pill"
>
<Flex align="center" gap="xs">
- <SourceColorIndicator colors={colors} />
+ <SourceColorIndicator
+ colors={isDisabled ? ["var(--mb-color-icon-disabled)"] : colors}
+ />
{isRenaming ? (
<EditableText
ref={editableRef}
@@ -125,28 +130,48 @@ export function MetricExpressionPill({
/>
) : (
<Flex align="center" gap={0}>
- {expressionEntry.name && expressionEntry.name !== expressionText
- ? expressionEntry.name
- : expressionForPill.map((segment, i) => {
- if (typeof segment === "number") {
- return (
- <Badge
- key={i}
- circle
- c="text-hover"
- style={{ marginInlineStart: "0.2em" }}
- >
- {segment}
- </Badge>
- );
- }
+ {expressionEntry.name &&
+ expressionEntry.name !== expressionText ? (
+ <span
+ className={cx(
+ S.expressionText,
+ isDisabled && S.disabledText,
+ )}
+ >
+ {expressionEntry.name}
+ </span>
+ ) : (
+ expressionForPill.map((segment, i) => {
+ if (typeof segment === "number") {
return (
- <span key={i} className={S.expressionText}>
+ <Badge
+ key={i}
+ circle
+ c="text-hover"
+ style={{ marginInlineStart: "0.2em" }}
+ >
{segment}
- </span>
+ </Badge>
);
- })}
- <span className={S.expressionText}>{"\u00a0"}</span>
+ }
+ return (
+ <span
+ key={i}
+ className={cx(
+ S.expressionText,
+ isDisabled && S.disabledText,
+ )}
+ >
+ {segment}
+ </span>
+ );
+ })
+ )}
+ <span
+ className={cx(S.expressionText, isDisabled && S.disabledText)}
+ >
+ {"\u00a0"}
+ </span>
</Flex>
)}
</Flex>
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricExpressionPill/MetricExpressionPill.unit.spec.tsx b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricExpressionPill/MetricExpressionPill.unit.spec.tsx
index da5dea937ce..66aaed30cb3 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricExpressionPill/MetricExpressionPill.unit.spec.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricExpressionPill/MetricExpressionPill.unit.spec.tsx
@@ -2,8 +2,8 @@ import { screen } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import { renderWithProviders } from "__support__/ui";
+import type { ExpressionDefinitionEntry } from "metabase/metrics-viewer/types";
-import type { ExpressionDefinitionEntry } from "../../../types/viewer-state";
import type { MetricNameMap } from "../utils";
import { MetricExpressionPill } from "./MetricExpressionPill";
@@ -71,7 +71,7 @@ describe("MetricExpressionPill expression rendering", () => {
setup({ expressionEntry });
- const pill = screen.getByTestId("metrics-viewer-search-pill");
+ const pill = screen.getByTestId("metrics-viewer-expression-pill");
// The raw expression text is shown — custom-name fallback is not used.
expect(pill).toHaveTextContent(/A\s*\+\s*A/);
// The first "A" is unique so far (no badge), but the second and third
@@ -117,7 +117,7 @@ describe("MetricExpressionPill action menu", () => {
it("should open a menu with a Rename item when the pill is clicked", async () => {
setup();
- await userEvent.click(screen.getByTestId("metrics-viewer-search-pill"));
+ await userEvent.click(screen.getByTestId("metrics-viewer-expression-pill"));
expect(await screen.findByText("Edit")).toBeInTheDocument();
expect(await screen.findByText("Rename")).toBeInTheDocument();
@@ -126,7 +126,7 @@ describe("MetricExpressionPill action menu", () => {
it("should start the inline rename flow when Rename is clicked", async () => {
setup();
- await userEvent.click(screen.getByTestId("metrics-viewer-search-pill"));
+ await userEvent.click(screen.getByTestId("metrics-viewer-expression-pill"));
await userEvent.click(await screen.findByText("Rename"));
expect(
@@ -139,7 +139,7 @@ describe("MetricExpressionPill action menu", () => {
it('should call onEdit if "Edit" menu item is clicked', async () => {
const { onEdit } = setup();
- await userEvent.click(screen.getByTestId("metrics-viewer-search-pill"));
+ await userEvent.click(screen.getByTestId("metrics-viewer-expression-pill"));
await userEvent.click(await screen.findByText("Edit"));
expect(onEdit).toHaveBeenCalledTimes(1);
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricPill/MetricPill.module.css b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricPill/MetricPill.module.css
index 5a63e1aae35..b090305b758 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricPill/MetricPill.module.css
+++ b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricPill/MetricPill.module.css
@@ -10,6 +10,14 @@
background-color: var(--mb-color-background-secondary);
}
+.metricPillText {
+ color: inherit;
+}
+
+.disabled {
+ color: var(--mb-color-text-tertiary);
+}
+
.menuTarget {
pointer-events: none;
}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricPill/MetricPill.tsx b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricPill/MetricPill.tsx
index 7e01cc874d7..9d0fb0f59be 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricPill/MetricPill.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricPill/MetricPill.tsx
@@ -1,19 +1,22 @@
+import cx from "classnames";
import { useCallback, useMemo, useState } from "react";
import { t } from "ttag";
import { ForwardRefLink } from "metabase/common/components/Link";
import { SourceColorIndicator } from "metabase/common/components/SourceColorIndicator";
+import type {
+ MetricsViewerDefinitionEntry,
+ SelectedMetric,
+} from "metabase/metrics-viewer/types";
+import {
+ getDimensionsByType,
+ getEntryBreakout,
+} from "metabase/metrics-viewer/utils";
import { Box, Flex, Icon, Menu, Pill, Popover, Skeleton } from "metabase/ui";
import * as Urls from "metabase/urls";
import type { ProjectionClause } from "metabase-lib/metric";
import * as LibMetric from "metabase-lib/metric";
-import type {
- MetricsViewerDefinitionEntry,
- SelectedMetric,
-} from "../../../types/viewer-state";
-import { getEntryBreakout } from "../../../utils/definition-entries";
-import { getDimensionsByType } from "../../../utils/tabs";
import { BreakoutDimensionPicker } from "../../BreakoutDimensionPicker";
import { MetricSearchDropdown } from "../MetricSearchDropdown";
@@ -25,6 +28,7 @@ type MetricPillProps = {
metric: SelectedMetric;
colors?: string[];
definitionEntry: MetricsViewerDefinitionEntry;
+ isDisabled?: boolean;
onSwap: (oldMetric: SelectedMetric, newMetric: SelectedMetric) => void;
onRemove: (metricId: number, sourceType: "metric" | "measure") => void;
onSetBreakout: (dimension: ProjectionClause | undefined) => void;
@@ -35,6 +39,7 @@ export function MetricPill({
metric,
colors,
definitionEntry,
+ isDisabled,
onSwap,
onRemove,
onSetBreakout,
@@ -137,7 +142,7 @@ export function MetricPill({
? t`Remove ${metric.name}`
: t`Remove metric`,
}}
- data-testid="metrics-viewer-search-pill"
+ data-testid="metrics-viewer-pill"
>
<Flex align="center" gap="xs">
{metric.isLoading ? (
@@ -145,12 +150,18 @@ export function MetricPill({
) : (
<>
<SourceColorIndicator
- colors={colors}
+ colors={
+ isDisabled ? ["var(--mb-color-icon-disabled)"] : colors
+ }
fallbackIcon={
metric.sourceType === "measure" ? "ruler" : "metric"
}
/>
- <span>{metric.name}</span>
+ <span
+ className={cx(S.metricPillText, isDisabled && S.disabled)}
+ >
+ {metric.name}
+ </span>
</>
)}
</Flex>
@@ -209,14 +220,16 @@ export function MetricPill({
leftSection={<Icon name="close" />}
onClick={handleRemoveBreakout}
>
- {t`Remove breakout`}
+ {t`Remove series breakout`}
</Menu.Item>
)}
<Menu.Item
leftSection={<Icon name="arrow_split" />}
onClick={handleOpenBreakoutPicker}
>
- {breakoutDimension ? t`Change breakout` : t`Break out`}
+ {breakoutDimension
+ ? t`Change series breakout`
+ : t`Add a series breakout`}
</Menu.Item>
</>
)}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricPill/MetricPill.unit.spec.tsx b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricPill/MetricPill.unit.spec.tsx
index 9b3c3746fec..2ca8181a9b8 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricPill/MetricPill.unit.spec.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricPill/MetricPill.unit.spec.tsx
@@ -3,40 +3,46 @@ import userEvent from "@testing-library/user-event";
import { setupSearchEndpoints } from "__support__/server-mocks";
import { renderWithProviders } from "__support__/ui";
-
import type {
MetricsViewerDefinitionEntry,
SelectedMetric,
-} from "../../../types/viewer-state";
+} from "metabase/metrics-viewer/types";
import {
REVENUE_METRIC,
createMetricMetadata,
setupDefinition,
-} from "../../../utils/__tests__/test-helpers";
+} from "metabase/metrics-viewer/utils/__tests__/test-helpers";
import { MetricPill } from "./MetricPill";
function setup({
metric,
definitionEntry,
+ isDisabled,
+ onRemove = jest.fn(),
}: {
metric: SelectedMetric;
definitionEntry?: MetricsViewerDefinitionEntry;
+ isDisabled?: boolean;
+ onRemove?: jest.Mock;
}) {
setupSearchEndpoints([]);
renderWithProviders(
<MetricPill
metric={metric}
definitionEntry={definitionEntry ?? { id: "measure:1", definition: null }}
+ isDisabled={isDisabled}
onSwap={jest.fn()}
- onRemove={jest.fn()}
+ onRemove={onRemove}
onSetBreakout={jest.fn()}
/>,
);
+
+ return { onRemove };
}
-async function openMenu() {
- const pill = screen.getByTestId("metrics-viewer-search-pill");
+async function openPillMenu() {
+ const pill = screen.getByTestId("metrics-viewer-pill");
await userEvent.click(pill);
}
@@ -45,11 +51,11 @@ describe("MetricPill action menu", () => {
setup({
metric: { id: 1, name: "Revenue", sourceType: "measure" },
});
- await openMenu();
+ await openPillMenu();
expect(screen.getByText("Replace")).toBeInTheDocument();
expect(screen.queryByRole("separator")).not.toBeInTheDocument();
- expect(screen.queryByText("Break out")).not.toBeInTheDocument();
+ expect(screen.queryByText("Add a series breakout")).not.toBeInTheDocument();
expect(
screen.queryByText("Go to metric home page"),
).not.toBeInTheDocument();
@@ -59,7 +65,7 @@ describe("MetricPill action menu", () => {
setup({
metric: { id: 1, name: "Revenue", sourceType: "metric" },
});
- await openMenu();
+ await openPillMenu();
expect(screen.getByText("Replace")).toBeInTheDocument();
expect(screen.getByText("Go to metric home page")).toBeInTheDocument();
@@ -67,7 +73,7 @@ describe("MetricPill action menu", () => {
expect(screen.queryByRole("separator")).not.toBeInTheDocument();
});
- it("should show 'Replace', 'Break out', and 'Go to metric home page' with a separator when dimensions exist", async () => {
+ it("should show 'Replace', 'Add a series breakout', and 'Go to metric home page' with a separator when dimensions exist", async () => {
const metadata = createMetricMetadata([REVENUE_METRIC]);
const definition = setupDefinition(metadata, REVENUE_METRIC.id);
@@ -75,10 +81,10 @@ describe("MetricPill action menu", () => {
metric: { id: REVENUE_METRIC.id, name: "Revenue", sourceType: "metric" },
definitionEntry: { id: "metric:1", definition },
});
- await openMenu();
+ await openPillMenu();
expect(screen.getByText("Replace")).toBeInTheDocument();
- expect(screen.getByText("Break out")).toBeInTheDocument();
+ expect(screen.getByText("Add a series breakout")).toBeInTheDocument();
expect(screen.getByText("Go to metric home page")).toBeInTheDocument();
// One separator between breakout items and 'Go to metric home page'.
expect(screen.getAllByRole("separator")).toHaveLength(1);
@@ -88,9 +94,25 @@ describe("MetricPill action menu", () => {
setup({
metric: { id: 1, name: "Revenue", sourceType: "metric" },
});
- await openMenu();
+ await openPillMenu();
await userEvent.click(screen.getByText("Replace"));
expect(await screen.findByText("Browse all")).toBeInTheDocument();
});
+
+ it("should keep pill actions available when visually disabled", async () => {
+ const onRemove = jest.fn();
+ setup({
+ metric: { id: 1, name: "Revenue", sourceType: "metric" },
+ isDisabled: true,
+ onRemove,
+ });
+
+ await openPillMenu();
+
+ expect(screen.getByText("Replace")).toBeInTheDocument();
+ await userEvent.click(screen.getByLabelText("Remove Revenue"));
+
+ expect(onRemove).toHaveBeenCalledWith(1, "metric");
+ });
});
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/MetricSearchInput.module.css b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/MetricSearchInput.module.css
index a011bc1f4ff..580c4d1ddd8 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/MetricSearchInput.module.css
+++ b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/MetricSearchInput.module.css
@@ -1,5 +1,9 @@
.inputWrapper {
cursor: text;
+ min-height: 3rem;
+ padding: 0.5rem;
+ background: var(--mb-color-background-secondary);
+ border-radius: 1rem;
}
.inputField {
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/MetricSearchInput.tsx b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/MetricSearchInput.tsx
index 6ce7c429e5a..42ffab959aa 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/MetricSearchInput.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/MetricSearchInput.tsx
@@ -10,12 +10,18 @@ import type {
MetricDefinitionEntry,
MetricSourceId,
MetricsViewerDefinitionEntry,
+ MetricsViewerDimensionBreakoutState,
MetricsViewerFormulaEntity,
SelectedMetric,
SourceColorMap,
} from "../../../types/viewer-state";
import { isExpressionEntry, isMetricEntry } from "../../../types/viewer-state";
import { getEffectiveDefinitionEntry } from "../../../utils/definition-entries";
+import {
+ computeMetricSlots,
+ findStandaloneSlot,
+ slotsForEntity,
+} from "../../../utils/metric-slots";
import {
createMeasureSourceId,
createMetricSourceId,
@@ -35,6 +41,7 @@ import { useMetricNameTracking } from "./useMetricNameTracking";
type MetricSearchInputProps = {
definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>;
formulaEntities: MetricsViewerFormulaEntity[];
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState | null;
onFormulaEntitiesChange: (
entities: MetricsViewerFormulaEntity[],
slotMapping?: Map<number, number>,
@@ -53,6 +60,7 @@ type MetricSearchInputProps = {
export function MetricSearchInput({
definitions,
formulaEntities,
+ activeDimensionBreakout,
onFormulaEntitiesChange,
selectedMetrics,
metricColors,
@@ -123,21 +131,22 @@ export function MetricSearchInput({
);
const isCollapsed = !isFocused && formulaEntities.length > 0;
+ const metricSlots = useMemo(
+ () => computeMetricSlots(formulaEntities),
+ [formulaEntities],
+ );
return (
<Flex
ref={containerRef}
className={S.inputWrapper}
- bg="background-primary"
align="center"
gap="sm"
- px="sm"
- py="xs"
onClick={handleContainerClick}
data-has-error={validationError ? true : undefined}
data-testid="metrics-formula-input"
>
- <Flex align="center" gap="sm" flex={1} wrap="wrap" mih="2.375rem">
+ <Flex align="center" gap="sm" flex={1} wrap="wrap" mih="2rem">
{isCollapsed ? (
// Unfocused: each formula entity rendered as MetricPill or MetricExpressionPill
<>
@@ -157,12 +166,21 @@ export function MetricSearchInput({
entry,
definitions,
);
+ const metricSlot = findStandaloneSlot(metricSlots, entryIndex);
+ const isDisabled =
+ activeDimensionBreakout != null &&
+ activeDimensionBreakout.type !== "scalar" &&
+ metricSlot != null &&
+ activeDimensionBreakout.dimensionMapping[
+ metricSlot.slotIndex
+ ] == null;
return (
<span key={`${entry.id}-${entryIndex}`}>
<MetricPill
metric={metric}
colors={metricColors[entryIndex]}
definitionEntry={definition}
+ isDisabled={isDisabled}
onSwap={handleSwapMetric}
onRemove={(_id, _sourceType) =>
handleRemoveItem(entryIndex)
@@ -179,6 +197,16 @@ export function MetricSearchInput({
const expressionColors = metricColors[entryIndex]
? [metricColors[entryIndex][0]]
: undefined;
+ const expressionSlots = slotsForEntity(metricSlots, entryIndex);
+ const isDisabled =
+ activeDimensionBreakout != null &&
+ activeDimensionBreakout.type !== "scalar" &&
+ expressionSlots.some(
+ (slot) =>
+ activeDimensionBreakout.dimensionMapping[
+ slot.slotIndex
+ ] == null,
+ );
return (
<span
@@ -189,6 +217,7 @@ export function MetricSearchInput({
expressionEntry={entry}
metricNames={metricNames}
colors={expressionColors}
+ isDisabled={isDisabled}
onNameChange={(newName) => {
const updated = [...formulaEntities];
updated[entryIndex] = { ...entry, name: newName };
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/MetricSearchInput.unit.spec.tsx b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/MetricSearchInput.unit.spec.tsx
index d4e189bfba6..90929f36462 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/MetricSearchInput.unit.spec.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/MetricSearchInput.unit.spec.tsx
@@ -1,8 +1,8 @@
import { fireEvent, within } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
+import { setupSearchEndpoints } from "__support__/server-mocks";
import { renderWithProviders, screen, waitFor } from "__support__/ui";
-
import type {
ExpressionDefinitionEntry,
ExpressionSubToken,
@@ -10,83 +10,25 @@ import type {
MetricExpressionId,
MetricSourceId,
MetricsViewerDefinitionEntry,
+ MetricsViewerDimensionBreakoutState,
MetricsViewerFormulaEntity,
SelectedMetric,
SourceColorMap,
-} from "../../../types/viewer-state";
-import { isExpressionEntry, isMetricEntry } from "../../../types/viewer-state";
-import { createMetricSourceId } from "../../../utils/source-ids";
+} from "metabase/metrics-viewer/types";
+import {
+ isExpressionEntry,
+ isMetricEntry,
+} from "metabase/metrics-viewer/types";
+import { createMetricSourceId } from "metabase/metrics-viewer/utils";
+
+import {
+ createMetricMetadata,
+ createMockNormalizedMetric,
+ setupDefinition,
+} from "../../../utils/__tests__/test-helpers";
import { MetricSearchInput } from "./MetricSearchInput";
-// ---------------------------------------------------------------------------
-// Mocks
-// ---------------------------------------------------------------------------
-
-jest.mock("../../../utils/definition-builder", () => ({
- getDefinitionName: (def: any) => def?.["display-name"] ?? null,
-}));
-
-jest.mock("../MetricPill", () => ({
- MetricPill: ({
- metric,
- onRemove,
- }: {
- metric: SelectedMetric;
- onRemove: (id: number, sourceType: "metric" | "measure") => void;
- }) => (
- <div data-testid="metric-pill" data-metric-name={metric.name}>
- <span>{metric.name}</span>
- <button onClick={() => onRemove(metric.id, metric.sourceType)}>
- remove
- </button>
- </div>
- ),
-}));
-
-jest.mock("../MetricExpressionPill", () => ({
- MetricExpressionPill: ({
- expressionEntry,
- onRemove,
- }: {
- expressionEntry: { name: string };
- metricNames: unknown;
- colors?: string[];
- onNameChange: (name: string) => void;
- onRemove: () => void;
- }) => {
- return (
- <div
- data-testid="metric-expression-pill"
- data-expression-text={expressionEntry.name}
- >
- <span>{expressionEntry.name}</span>
- <button onClick={onRemove}>remove</button>
- </div>
- );
- },
-}));
-
-jest.mock("../MetricSearchDropdown", () => ({
- MetricSearchDropdown: ({
- onSelect,
- searchQuery,
- }: {
- onSelect: (metric: SelectedMetric) => void;
- searchQuery: string;
- }) => (
- <div data-testid="search-dropdown" data-search-text={searchQuery}>
- <button
- onClick={() =>
- onSelect({ id: 99, name: "New Metric", sourceType: "metric" })
- }
- >
- select-new-metric
- </button>
- </div>
- ),
-}));
-
// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------
@@ -104,11 +46,20 @@ function makeMetricEntry(metric: SelectedMetric): MetricDefinitionEntry {
metric.sourceType === "metric"
? createMetricSourceId(metric.id)
: (`measure:${metric.id}` as MetricSourceId);
- // Create a fake definition with display-name for getDefinitionName
- const fakeDefinition = {
- "display-name": metric.name,
- } as unknown as MetricDefinitionEntry["definition"];
- return { id: sid, type: "metric" as const, definition: fakeDefinition };
+ if (metric.sourceType === "measure") {
+ return { id: sid, type: "metric" as const, definition: null };
+ }
+
+ const normalizedMetric = createMockNormalizedMetric({
+ id: metric.id,
+ name: metric.name ?? "",
+ });
+ const metadata = createMetricMetadata([normalizedMetric]);
+ return {
+ id: sid,
+ type: "metric" as const,
+ definition: setupDefinition(metadata, metric.id),
+ };
}
function makeExpressionEntry(
@@ -144,6 +95,7 @@ function buildFormulaEntities(
type SetupOptions = {
/** Mixed array of metric and expression entries (old-style convenience) */
entries?: (MetricDefinitionEntry | ExpressionDefinitionEntry)[];
+ activeDimensionBreakout?: MetricsViewerDimensionBreakoutState | null;
selectedMetrics?: SelectedMetric[];
metricColors?: SourceColorMap;
onFormulaEntitiesChange?: jest.Mock;
@@ -154,11 +106,14 @@ type SetupOptions = {
};
function setup(options: SetupOptions = {}) {
+ setupSearchEndpoints([]);
+
const revenue = makeMetric(1, "Revenue");
const costs = makeMetric(2, "Costs");
const {
selectedMetrics = [revenue, costs],
+ activeDimensionBreakout = null,
metricColors = {},
entries = selectedMetrics.map(makeMetricEntry),
onFormulaEntitiesChange = jest.fn(),
@@ -179,6 +134,7 @@ function setup(options: SetupOptions = {}) {
<MetricSearchInput
definitions={definitions}
formulaEntities={formulaEntities}
+ activeDimensionBreakout={activeDimensionBreakout}
onFormulaEntitiesChange={onFormulaEntitiesChange}
selectedMetrics={selectedMetrics}
metricColors={metricColors}
@@ -237,7 +193,7 @@ describe("collapsed view (definitions present, not focused)", () => {
it("renders a single metric definition as a MetricPill", () => {
setup({ entries: [revenueEntry] });
- expect(screen.getByTestId("metric-pill")).toBeInTheDocument();
+ expect(screen.getByTestId("metrics-viewer-pill")).toBeInTheDocument();
expect(screen.getByText("Revenue")).toBeInTheDocument();
expect(screen.queryByRole("textbox")).not.toBeInTheDocument();
});
@@ -252,18 +208,37 @@ describe("collapsed view (definitions present, not focused)", () => {
entries: [revenueEntry, costsEntry, expr],
});
- const pill = screen.getByTestId("metric-expression-pill");
+ const pill = screen.getByTestId("metrics-viewer-expression-pill");
expect(pill).toBeInTheDocument();
- expect(pill).toHaveAttribute("data-expression-text", "Revenue + Costs");
+ expect(pill).toHaveTextContent("Revenue + Costs");
});
it("renders two separate metric entries as two pills", () => {
setup({ entries: [revenueEntry, costsEntry] });
- const pills = screen.getAllByTestId("metric-pill");
+ const pills = screen.getAllByTestId("metrics-viewer-pill");
expect(pills).toHaveLength(2);
- expect(pills[0]).toHaveAttribute("data-metric-name", "Revenue");
- expect(pills[1]).toHaveAttribute("data-metric-name", "Costs");
+ expect(pills[0]).toHaveTextContent("Revenue");
+ expect(pills[1]).toHaveTextContent("Costs");
+ });
+
+ it("visually disables a metric without a dimension for the active breakout", () => {
+ setup({
+ entries: [revenueEntry, costsEntry],
+ activeDimensionBreakout: {
+ id: "time",
+ type: "time",
+ label: "Time",
+ display: "line",
+ dimensionMapping: { 0: "dim-created-at" },
+ projectionConfig: {},
+ },
+ });
+
+ const indicators = screen.getAllByTestId("color-indicator-container");
+ expect(
+ within(indicators[1]).getByRole("img", { hidden: true }),
+ ).toHaveStyle({ color: "var(--mb-color-icon-disabled)" });
});
it("does not render a text input when collapsed", () => {
@@ -285,7 +260,7 @@ describe("expanded view (focused text input)", () => {
it("transitions to text input when clicking the container", async () => {
const { user } = setup({ entries: [revenueEntry] });
- await user.click(screen.getByTestId("metric-pill"));
+ await user.click(screen.getByTestId("metrics-formula-input"));
await waitFor(() => {
expect(screen.getByRole("textbox")).toBeInTheDocument();
@@ -302,10 +277,7 @@ describe("expanded view (focused text input)", () => {
entries: [revenueEntry, costsEntry, expr],
});
- // Click a metric pill (not expression pill) to enter formula editing mode.
- // Expression pill clicks now open the name editor instead.
- const pills = screen.getAllByTestId("metric-pill");
- await user.click(pills[0]);
+ await user.click(screen.getByTestId("metrics-formula-input"));
await waitFor(() => {
expect(
@@ -320,9 +292,7 @@ describe("expanded view (focused text input)", () => {
const input = screen.getByTestId("metrics-viewer-search-input");
await user.type(input, "R");
- await waitFor(() => {
- expect(screen.getByTestId("search-dropdown")).toBeInTheDocument();
- });
+ expect(await screen.findByText("Browse all")).toBeInTheDocument();
});
});
@@ -335,7 +305,7 @@ describe("blur behavior", () => {
selectedMetrics: [revenue],
});
- await user.click(screen.getByTestId("metric-pill"));
+ await user.click(screen.getByTestId("metrics-formula-input"));
await waitFor(() => {
expect(
screen.getByTestId("metrics-viewer-search-input"),
@@ -347,7 +317,7 @@ describe("blur behavior", () => {
expect(
screen.queryByTestId("metrics-viewer-search-input"),
).not.toBeInTheDocument();
- expect(screen.getByTestId("metric-pill")).toBeInTheDocument();
+ expect(screen.getByTestId("metrics-viewer-pill")).toBeInTheDocument();
});
it("shows the Run button when formula is dirty", async () => {
@@ -356,8 +326,7 @@ describe("blur behavior", () => {
selectedMetrics: [revenue],
});
- // Click pill → transitions to editor
- await user.click(screen.getByTestId("metric-pill"));
+ await user.click(screen.getByTestId("metrics-formula-input"));
await waitFor(() => {
expect(
screen.getByTestId("metrics-viewer-search-input"),
@@ -383,9 +352,7 @@ describe("blur behavior", () => {
entries: [revenueEntry, costsEntry, expr],
});
- // Click a metric pill to enter formula editing mode.
- const pills = screen.getAllByTestId("metric-pill");
- await user.click(pills[0]);
+ await user.click(screen.getByTestId("metrics-formula-input"));
expect(await screen.findByRole("textbox")).toBeInTheDocument();
expect(
@@ -405,8 +372,7 @@ describe("run button and validation", () => {
onFormulaEntitiesChange,
});
- // Click pill → transitions to editor
- await user.click(screen.getByTestId("metric-pill"));
+ await user.click(screen.getByTestId("metrics-formula-input"));
await waitFor(() => {
expect(
screen.getByTestId("metrics-viewer-search-input"),
@@ -438,9 +404,7 @@ describe("run button and validation", () => {
onFormulaEntitiesChange,
});
- // Click a pill to transition to the editor
- const pills = screen.getAllByTestId("metric-pill");
- await user.click(pills[0]);
+ await user.click(screen.getByTestId("metrics-formula-input"));
await waitFor(() => {
expect(
@@ -478,7 +442,7 @@ describe("removing pills", () => {
onFormulaEntitiesChange,
});
- await user.click(screen.getByRole("button", { name: "remove" }));
+ await user.click(screen.getByLabelText("Remove Revenue"));
expect(onRemoveMetric).toHaveBeenCalledWith(1, "metric");
expect(onFormulaEntitiesChange).toHaveBeenCalledWith(
@@ -497,9 +461,7 @@ describe("removing pills", () => {
onFormulaEntitiesChange,
});
- const removeButtons = screen.getAllByRole("button", { name: "remove" });
- // Remove the first item (Revenue)
- await user.click(removeButtons[0]);
+ await user.click(screen.getByLabelText("Remove Revenue"));
expect(onRemoveMetric).toHaveBeenCalledWith(1, "metric");
expect(onFormulaEntitiesChange).toHaveBeenCalledWith(
@@ -523,10 +485,8 @@ describe("removing pills", () => {
onFormulaEntitiesChange,
});
- // The expression pill's remove button
- const exprPill = screen.getByTestId("metric-expression-pill");
- const removeButton = within(exprPill).getByRole("button");
- await user.click(removeButton);
+ const exprPill = screen.getByTestId("metrics-viewer-expression-pill");
+ await user.click(within(exprPill).getByLabelText("Remove expression"));
// Both Revenue and Costs are only referenced in the expression (the metric entries remain)
// Since revenueEntry and costsEntry still exist in remaining definitions,
@@ -554,9 +514,7 @@ describe("expression pill display after committing a formula", () => {
onFormulaEntitiesChange,
});
- // Click a pill to transition to the editor
- const pills = screen.getAllByTestId("metric-pill");
- await user.click(pills[0]);
+ await user.click(screen.getByTestId("metrics-formula-input"));
await waitFor(() => {
expect(
@@ -634,10 +592,6 @@ describe("typing in the text input", () => {
const input = screen.getByRole("textbox");
await user.type(input, "Rev");
- expect(screen.getByTestId("search-dropdown")).toBeInTheDocument();
- expect(screen.getByTestId("search-dropdown")).toHaveAttribute(
- "data-search-text",
- "Rev",
- );
+ expect(await screen.findByText("Browse all")).toBeInTheDocument();
});
});
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/useFormulaEditor.ts b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/useFormulaEditor.ts
index 329c47352a3..a516e949ac1 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/useFormulaEditor.ts
+++ b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/useFormulaEditor.ts
@@ -107,6 +107,7 @@ export function useFormulaEditor({
});
const pendingFocusRef = useRef(false);
+ const isCollapsingRef = useRef(false);
// When set, overrides the default end-of-doc caret position on focus —
// used when the user triggers "Edit" from a specific expression pill so the
// caret lands at the end of that expression instead of the full formula.
@@ -139,6 +140,7 @@ export function useFormulaEditor({
if (isFocused) {
return;
}
+
let changed = false;
const cleaned = formulaEntities.map((entry) => {
if (!isExpressionEntry(entry)) {
@@ -165,6 +167,9 @@ export function useFormulaEditor({
}, [isFocused, editorRef]);
const handleInputFocus = useCallback(() => {
+ if (isCollapsingRef.current) {
+ return;
+ }
// If an editing session is already active (e.g. focus returning from a
// dropdown item click via view.focus()), do not reset the text or the
// committed baseline.
@@ -183,6 +188,7 @@ export function useFormulaEditor({
setTextAtFocus(fullText);
setIsFocused(true);
+ editTextRef.current = fullText;
setEditText(fullText);
setValidationError(null);
setIsExpressionDirty(false);
@@ -232,6 +238,7 @@ export function useFormulaEditor({
entities.slice(0, entityIndex + 1),
metricNamesRef.current,
);
+ isCollapsingRef.current = false;
pendingCaretPositionRef.current = text.length;
pendingFocusRef.current = true;
setIsFocused(true);
@@ -289,10 +296,14 @@ export function useFormulaEditor({
}
onFormulaEntitiesChange(reconciledEntities, slotMapping);
+ isCollapsingRef.current = true;
isEditingSessionActiveRef.current = false;
+ textAtFocusRef.current = newText;
+ setTextAtFocus(newText);
setIsFocused(false);
setIsOpen(false);
setCurrentWord("");
+ editTextRef.current = "";
setEditText("");
setValidationError(null);
setIsExpressionDirty(false);
@@ -343,8 +354,12 @@ export function useFormulaEditor({
const handleChange = useCallback(
(newText: string) => {
+ editTextRef.current = newText;
setEditText(newText);
setValidationError(null);
+ if (isCollapsingRef.current) {
+ return;
+ }
if (newText !== textAtFocusRef.current) {
setIsExpressionDirty(true);
}
@@ -423,9 +438,10 @@ export function useFormulaEditor({
from: metricFrom,
to: metricTo,
sourceId,
- definition: null,
+ definition: definitionsRef.current[sourceId]?.definition ?? null,
}),
});
+ editTextRef.current = view.state.doc.toString();
setIsExpressionDirty(true);
handleAddMetric(metric);
@@ -435,7 +451,7 @@ export function useFormulaEditor({
setTimeout(() => {
const view = editorRef.current?.view;
- if (!view) {
+ if (!view || !isEditingSessionActiveRef.current) {
return;
}
// Return focus to the editor after the dropdown item click stole it
@@ -536,6 +552,7 @@ export function useFormulaEditor({
) {
return;
}
+ isCollapsingRef.current = false;
const view = editorRef.current?.view;
if (view) {
view.focus();
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/useMetricNameTracking.ts b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/useMetricNameTracking.ts
index 09aa5fd0ea2..5c75c46e8db 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/useMetricNameTracking.ts
+++ b/frontend/src/metabase/metrics-viewer/components/MetricSearch/MetricSearchInput/useMetricNameTracking.ts
@@ -67,9 +67,14 @@ export function useMetricNameTracking({
(metric: SelectedMetric) => {
onAddMetric(metric);
if (metric.name != null) {
+ const sourceId = createSourceId(metric.id, metric.sourceType);
+ metricNamesRef.current = {
+ ...metricNamesRef.current,
+ [sourceId]: metric.name,
+ };
setLocalMetricNames((prev) => ({
...prev,
- [createSourceId(metric.id, metric.sourceType)]: metric.name!,
+ [sourceId]: metric.name!,
}));
}
},
@@ -80,6 +85,9 @@ export function useMetricNameTracking({
(metricId: number, sourceType: "metric" | "measure") => {
onRemoveMetric(metricId, sourceType);
const sourceId = createSourceId(metricId, sourceType);
+ const nextMetricNames = { ...metricNamesRef.current };
+ delete nextMetricNames[sourceId];
+ metricNamesRef.current = nextMetricNames;
setLocalMetricNames((prev) => {
const next = { ...prev };
delete next[sourceId];
@@ -92,9 +100,17 @@ export function useMetricNameTracking({
const handleSwapMetric = useCallback(
(oldMetric: SelectedMetric, newMetric: SelectedMetric) => {
onSwapMetric(oldMetric, newMetric);
+ const oldSourceId = createSourceId(oldMetric.id, oldMetric.sourceType);
+ const nextMetricNames = { ...metricNamesRef.current };
+ delete nextMetricNames[oldSourceId];
+ if (newMetric.name != null) {
+ nextMetricNames[createSourceId(newMetric.id, newMetric.sourceType)] =
+ newMetric.name;
+ }
+ metricNamesRef.current = nextMetricNames;
setLocalMetricNames((prev) => {
const next = { ...prev };
- delete next[createSourceId(oldMetric.id, oldMetric.sourceType)];
+ delete next[oldSourceId];
if (newMetric.name != null) {
next[createSourceId(newMetric.id, newMetric.sourceType)] =
newMetric.name;
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricSearchPanel/MetricSearchPanel.module.css b/frontend/src/metabase/metrics-viewer/components/MetricSearchPanel/MetricSearchPanel.module.css
index 617034922d1..d28ae63867d 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricSearchPanel/MetricSearchPanel.module.css
+++ b/frontend/src/metabase/metrics-viewer/components/MetricSearchPanel/MetricSearchPanel.module.css
@@ -1,25 +1,15 @@
.container {
- border: 1px solid var(--mb-color-border);
- border-radius: var(--mantine-radius-lg);
+ border-radius: 1rem;
overflow: hidden;
- background: var(--mb-color-background-primary);
- transition: border-color 150ms ease;
-}
-
-.container:hover {
- border: 1px solid var(--mb-color-brand);
-}
-
-.container:focus-within {
- border-color: var(--mb-color-brand);
+ background: var(--mb-color-background-secondary);
}
.container:has([data-has-error]) {
- border-color: var(--mb-color-error);
+ box-shadow: inset 0 0 0 1px var(--mb-color-error);
}
.filterPillsSection {
- border-radius: 0 0 var(--mantine-radius-lg) var(--mantine-radius-lg);
+ border-radius: 0 0 1rem 1rem;
}
.filterButtonWithCount {
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricSearchPanel/MetricSearchPanel.tsx b/frontend/src/metabase/metrics-viewer/components/MetricSearchPanel/MetricSearchPanel.tsx
index 6f444a4781c..4326f7ebf6e 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricSearchPanel/MetricSearchPanel.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricSearchPanel/MetricSearchPanel.tsx
@@ -1,18 +1,16 @@
import { useCallback, useMemo, useState } from "react";
import { t } from "ttag";
+import {
+ trackMetricsViewerMetricAdded,
+ trackMetricsViewerMetricRemoved,
+} from "metabase/metrics-viewer/analytics";
+import { useMetricsViewerContext } from "metabase/metrics-viewer/context";
import { Box, Button, Flex, Icon, Stack, Text, Tooltip } from "metabase/ui";
-import type { MetricDefinition, ProjectionClause } from "metabase-lib/metric";
+import type { MetricDefinition } from "metabase-lib/metric";
import * as LibMetric from "metabase-lib/metric";
-import type {
- MetricDefinitionEntry,
- MetricSourceId,
- MetricsViewerDefinitionEntry,
- MetricsViewerFormulaEntity,
- SelectedMetric,
- SourceColorMap,
-} from "../../types/viewer-state";
+import type { SelectedMetric } from "../../types/viewer-state";
import type { DefinitionSource } from "../../utils/definition-sources";
import {
applyDefinitionToFormulaEntities,
@@ -24,37 +22,37 @@ import { MetricsFilterPills } from "../MetricsFilterPills";
import S from "./MetricSearchPanel.module.css";
-type MetricSearchPanelProps = {
- definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>;
- formulaEntities: MetricsViewerFormulaEntity[];
- onFormulaEntitiesChange: (
- entities: MetricsViewerFormulaEntity[],
- slotMapping?: Map<number, number>,
- ) => void;
- selectedMetrics: SelectedMetric[];
- metricColors: SourceColorMap;
- onAddMetric: (metric: SelectedMetric) => void;
- onRemoveMetric: (metricId: number, sourceType: "metric" | "measure") => void;
- onSwapMetric: (oldMetric: SelectedMetric, newMetric: SelectedMetric) => void;
- onSetBreakout: (
- entity: MetricDefinitionEntry,
- dimension: ProjectionClause | undefined,
- ) => void;
-};
-
-export function MetricSearchPanel({
- definitions,
- formulaEntities,
- onFormulaEntitiesChange,
- selectedMetrics,
- metricColors,
- onAddMetric,
- onRemoveMetric,
- onSwapMetric,
- onSetBreakout,
-}: MetricSearchPanelProps) {
+export function MetricSearchPanel() {
+ const {
+ definitions,
+ formulaEntities,
+ activeDimensionBreakout,
+ selectedMetrics,
+ sourceColors: metricColors,
+ setFormulaEntities: onFormulaEntitiesChange,
+ addMetric,
+ removeMetric,
+ swapMetric: onSwapMetric,
+ setBreakoutDimension: onSetBreakout,
+ } = useMetricsViewerContext();
const [isFilterPillsExpanded, setIsFilterPillsExpanded] = useState(true);
+ const onAddMetric = useCallback(
+ (metric: SelectedMetric) => {
+ addMetric(metric);
+ trackMetricsViewerMetricAdded(metric.id, metric.sourceType);
+ },
+ [addMetric],
+ );
+
+ const onRemoveMetric = useCallback(
+ (metricId: number, sourceType: "metric" | "measure") => {
+ removeMetric(metricId, sourceType);
+ trackMetricsViewerMetricRemoved(metricId, sourceType);
+ },
+ [removeMetric],
+ );
+
const definitionSources = useMemo(
() => getDefinitionSources(formulaEntities, definitions),
[formulaEntities, definitions],
@@ -140,6 +138,7 @@ export function MetricSearchPanel({
<MetricSearch
definitions={definitions}
formulaEntities={formulaEntities}
+ activeDimensionBreakout={activeDimensionBreakout}
onFormulaEntitiesChange={onFormulaEntitiesChange}
selectedMetrics={selectedMetrics}
metricColors={metricColors}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricsViewerDimensionBreakoutContent/MetricsViewerDimensionBreakoutContent.tsx b/frontend/src/metabase/metrics-viewer/components/MetricsViewerDimensionBreakoutContent/MetricsViewerDimensionBreakoutContent.tsx
new file mode 100644
index 00000000000..c173e5c530f
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/MetricsViewerDimensionBreakoutContent/MetricsViewerDimensionBreakoutContent.tsx
@@ -0,0 +1,171 @@
+import { useCallback, useMemo } from "react";
+
+import { DimensionPillBar } from "metabase/metrics-viewer/components/DimensionPillBar";
+import { MetricControls } from "metabase/metrics-viewer/components/MetricControls";
+import { MetricsViewerVisualization } from "metabase/metrics-viewer/components/MetricsViewerVisualization";
+import { useMetricsViewerContext } from "metabase/metrics-viewer/context";
+import {
+ buildDimensionItemsFromDefinitions,
+ getDimensionBreakoutConfig,
+ getProjectionInfo,
+ shouldShowStackSeries,
+} from "metabase/metrics-viewer/utils";
+import { Box, Flex, Stack } from "metabase/ui";
+import { getObjectKeys } from "metabase/utils/objects";
+import type { DimensionMetadata, MetricDefinition } from "metabase-lib/metric";
+import * as LibMetric from "metabase-lib/metric";
+
+export function MetricsViewerDimensionBreakoutContent() {
+ const {
+ definitions,
+ formulaEntities,
+ activeDimensionBreakout: dimensionBreakout,
+ queriesAreLoading,
+ queriesError,
+ modifiedDefinitionsBySlotIndex,
+ metricSlots,
+ series: rawSeries,
+ cardIdToEntityIndex,
+ sourceColors,
+ showColumnLabels,
+ updateActiveDimensionBreakout: onDimensionBreakoutUpdate,
+ } = useMetricsViewerContext();
+
+ const dimensionItems = useMemo(
+ () =>
+ dimensionBreakout
+ ? buildDimensionItemsFromDefinitions(
+ definitions,
+ dimensionBreakout.dimensionMapping,
+ modifiedDefinitionsBySlotIndex,
+ sourceColors,
+ metricSlots,
+ formulaEntities,
+ dimensionBreakout.projectionConfig,
+ getDimensionBreakoutConfig(dimensionBreakout.type)
+ .dimensionPredicate,
+ )
+ : [],
+ [
+ definitions,
+ dimensionBreakout,
+ modifiedDefinitionsBySlotIndex,
+ sourceColors,
+ metricSlots,
+ formulaEntities,
+ ],
+ );
+
+ const definitionForControls = useMemo((): MetricDefinition | null => {
+ if (!dimensionBreakout) {
+ return null;
+ }
+ if (dimensionBreakout.type === "scalar") {
+ return modifiedDefinitionsBySlotIndex.values().next().value ?? null;
+ }
+
+ for (const key of getObjectKeys(dimensionBreakout.dimensionMapping)) {
+ const slotIndex = Number(key);
+ const modDef = modifiedDefinitionsBySlotIndex.get(slotIndex);
+ if (!modDef) {
+ continue;
+ }
+ const projs = LibMetric.projections(modDef);
+ if (projs.length > 0) {
+ return modDef;
+ }
+ }
+ return null;
+ }, [dimensionBreakout, modifiedDefinitionsBySlotIndex]);
+
+ const allFilterDimensions = useMemo(() => {
+ const filterDimensions: DimensionMetadata[] = [];
+ if (!dimensionBreakout) {
+ return filterDimensions;
+ }
+ for (const key of getObjectKeys(dimensionBreakout.dimensionMapping)) {
+ const slotIndex = Number(key);
+ const modDef = modifiedDefinitionsBySlotIndex.get(slotIndex);
+ if (!modDef) {
+ continue;
+ }
+ const projInfo = getProjectionInfo(modDef);
+ if (projInfo.filterDimension) {
+ filterDimensions.push(projInfo.filterDimension);
+ }
+ }
+ return filterDimensions;
+ }, [dimensionBreakout, modifiedDefinitionsBySlotIndex]);
+
+ const handleBrush = useCallback(
+ ({ start, end }: { start: number; end: number }) => {
+ onDimensionBreakoutUpdate({
+ projectionConfig: {
+ ...dimensionBreakout?.projectionConfig,
+ dimensionFilter: {
+ type: "specific-date",
+ operator: "between",
+ values: [new Date(start), new Date(end)],
+ hasTime: true,
+ },
+ },
+ });
+ },
+ [onDimensionBreakoutUpdate, dimensionBreakout?.projectionConfig],
+ );
+
+ if (!dimensionBreakout) {
+ return null;
+ }
+
+ const showStackSeries = shouldShowStackSeries(
+ dimensionBreakout.display,
+ rawSeries,
+ formulaEntities,
+ definitions,
+ );
+
+ const isTimeDimensionBreakout = dimensionBreakout.type === "time";
+
+ const dimensionBreakoutConfig = getDimensionBreakoutConfig(
+ dimensionBreakout.type,
+ );
+ const hasAnyOptions = dimensionItems.some((item) =>
+ item.type === "expression"
+ ? item.metricSources.some((s) => s.availableOptions.length > 0)
+ : item.availableOptions.length > 0,
+ );
+ const hideDimensionPill =
+ dimensionBreakoutConfig.minDimensions === 0 && !hasAnyOptions;
+ return (
+ <Stack flex="1 0 auto" gap={0}>
+ <MetricsViewerVisualization
+ rawSeries={rawSeries}
+ onBrush={isTimeDimensionBreakout ? handleBrush : undefined}
+ definitions={definitions}
+ formulaEntities={formulaEntities}
+ metricSlots={metricSlots}
+ dimensionBreakout={dimensionBreakout}
+ onDimensionBreakoutUpdate={onDimensionBreakoutUpdate}
+ cardIdToEntityIndex={cardIdToEntityIndex}
+ queriesAreLoading={queriesAreLoading}
+ queriesError={queriesError}
+ />
+ {!hideDimensionPill && showColumnLabels && (
+ <Box mt="sm">
+ <DimensionPillBar items={dimensionItems} />
+ </Box>
+ )}
+ {definitionForControls && (
+ <Flex mt="md" justify="center" align="center">
+ <MetricControls
+ definition={definitionForControls}
+ allFilterDimensions={allFilterDimensions}
+ showStackSeries={showStackSeries}
+ canToggleColumnLabels={!hideDimensionPill}
+ />
+ </Flex>
+ )}
+ </Stack>
+ );
+}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricsViewerDimensionBreakoutContent/index.ts b/frontend/src/metabase/metrics-viewer/components/MetricsViewerDimensionBreakoutContent/index.ts
new file mode 100644
index 00000000000..bda06ca9c2c
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/components/MetricsViewerDimensionBreakoutContent/index.ts
@@ -0,0 +1 @@
+export { MetricsViewerDimensionBreakoutContent } from "./MetricsViewerDimensionBreakoutContent";
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/AddDimensionPopover/AddDimensionPopover.module.css b/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/AddDimensionPopover/AddDimensionPopover.module.css
deleted file mode 100644
index 8b8fd2ad660..00000000000
--- a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/AddDimensionPopover/AddDimensionPopover.module.css
+++ /dev/null
@@ -1,11 +0,0 @@
-.addButton {
- align-self: center;
-}
-
-.dropdown {
- overflow: hidden;
-}
-
-.dimensionPicker {
- color: var(--mb-color-brand);
-}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/AddDimensionPopover/AddDimensionPopover.tsx b/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/AddDimensionPopover/AddDimensionPopover.tsx
deleted file mode 100644
index 514791b31f5..00000000000
--- a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/AddDimensionPopover/AddDimensionPopover.tsx
+++ /dev/null
@@ -1,112 +0,0 @@
-import { useCallback, useMemo, useState } from "react";
-import { t } from "ttag";
-
-import { AccordionList } from "metabase/common/components/AccordionList";
-import { trackMetricsViewerDimensionTabAdded } from "metabase/metrics-viewer/analytics";
-import type { TabInfo } from "metabase/metrics-viewer/utils/tabs";
-import { ActionIcon, Icon, Popover } from "metabase/ui";
-
-import type { MetricSourceId } from "../../../types/viewer-state";
-import type {
- AvailableDimensionsResult,
- DimensionPickerItem,
- DimensionPickerSection,
- SourceDisplayInfo,
-} from "../../../utils/dimension-picker";
-import { buildDimensionPickerSections } from "../../../utils/dimension-picker";
-import { getScalarTabLabel } from "../../../utils/tabs";
-
-import S from "./AddDimensionPopover.module.css";
-
-type AddDimensionPopoverProps = {
- availableDimensions: AvailableDimensionsResult;
- sourceOrder: MetricSourceId[];
- sourceDataById: Record<MetricSourceId, SourceDisplayInfo>;
- hasMultipleSources: boolean;
- canAddScalarTab: boolean;
- onAddTab: (tabInfo: TabInfo) => void;
-};
-
-export function AddDimensionPopover({
- availableDimensions,
- sourceOrder,
- sourceDataById,
- hasMultipleSources,
- onAddTab,
- canAddScalarTab,
-}: AddDimensionPopoverProps) {
- const [isOpen, setIsOpen] = useState(false);
-
- const sections = useMemo(
- () =>
- buildDimensionPickerSections({
- availableDimensions,
- sourceOrder,
- sourceDataById,
- hasMultipleSources,
- }),
- [availableDimensions, sourceOrder, sourceDataById, hasMultipleSources],
- );
-
- const handleSelect = useCallback(
- (item: DimensionPickerItem) => {
- onAddTab(item.tabInfo);
- trackMetricsViewerDimensionTabAdded();
- setIsOpen(false);
- },
- [onAddTab],
- );
-
- const renderItemIcon = useCallback(
- (item: DimensionPickerItem) => <Icon name={item.icon} />,
- [],
- );
-
- let finalSections: DimensionPickerSection[] = sections;
- if (canAddScalarTab) {
- finalSections = [
- {
- items: [
- {
- name: getScalarTabLabel(),
- icon: "number",
- tabInfo: {
- type: "scalar",
- label: getScalarTabLabel(),
- dimensionMapping: {},
- },
- },
- ],
- },
- ...sections,
- ];
- }
-
- return (
- <Popover opened={isOpen} onChange={setIsOpen} position="bottom-start">
- <Popover.Target>
- <ActionIcon
- className={S.addButton}
- ml="xs"
- aria-label={t`Add dimension tab`}
- onClick={() => setIsOpen(true)}
- >
- <Icon name="add" c="icon-primary" />
- </ActionIcon>
- </Popover.Target>
- <Popover.Dropdown p={0} className={S.dropdown}>
- <AccordionList
- className={S.dimensionPicker}
- sections={finalSections}
- onChange={handleSelect}
- renderItemIcon={renderItemIcon}
- alwaysExpanded
- globalSearch
- searchable
- maxHeight={300}
- width="17.5rem"
- />
- </Popover.Dropdown>
- </Popover>
- );
-}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/AddDimensionPopover/index.ts b/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/AddDimensionPopover/index.ts
deleted file mode 100644
index 0e3ac2d598c..00000000000
--- a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/AddDimensionPopover/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { AddDimensionPopover } from "./AddDimensionPopover";
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabContent/MetricsViewerTabContent.tsx b/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabContent/MetricsViewerTabContent.tsx
deleted file mode 100644
index 2b5db60000d..00000000000
--- a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabContent/MetricsViewerTabContent.tsx
+++ /dev/null
@@ -1,253 +0,0 @@
-import { useCallback, useMemo } from "react";
-
-import { Box, Flex, Stack } from "metabase/ui";
-import { getObjectKeys, getObjectValues } from "metabase/utils/objects";
-import { isNotNull } from "metabase/utils/types";
-import type { DimensionMetadata, MetricDefinition } from "metabase-lib/metric";
-import * as LibMetric from "metabase-lib/metric";
-import type {
- CardId,
- SingleSeries,
- TemporalUnit,
- VisualizationSettings,
-} from "metabase-types/api";
-
-import type {
- MetricSourceId,
- MetricsViewerDefinitionEntry,
- MetricsViewerDisplayType,
- MetricsViewerFormulaEntity,
- MetricsViewerTabProjectionConfig,
- MetricsViewerTabState,
- SourceColorMap,
-} from "../../../types/viewer-state";
-import { getProjectionInfo } from "../../../utils/definition-builder";
-import type { DimensionFilterValue } from "../../../utils/dimension-filters";
-import type { MetricSlot } from "../../../utils/metric-slots";
-import {
- buildDimensionItemsFromDefinitions,
- shouldShowStackSeries,
-} from "../../../utils/series";
-import { getTabConfig } from "../../../utils/tab-config";
-import { DimensionPillBar } from "../../DimensionPillBar";
-import { MetricControls } from "../../MetricControls";
-import { MetricsViewerVisualization } from "../../MetricsViewerVisualization";
-
-type MetricsViewerTabContentProps = {
- definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>;
- formulaEntities: MetricsViewerFormulaEntity[];
- tab: MetricsViewerTabState;
- queriesAreLoading: boolean;
- queriesError: string | null;
- modifiedDefinitionsBySlotIndex: Map<number, MetricDefinition>;
- metricSlots: MetricSlot[];
- series: SingleSeries[];
- cardIdToEntityIndex: Record<CardId, number>;
- sourceColors: SourceColorMap;
- onTabUpdate: (updates: Partial<MetricsViewerTabState>) => void;
- onDimensionChange: (slotIndex: number, dimension: DimensionMetadata) => void;
- onDimensionRemove: (slotIndex: number) => void;
-};
-
-export function MetricsViewerTabContent({
- definitions,
- formulaEntities,
- tab,
- queriesAreLoading,
- queriesError,
- modifiedDefinitionsBySlotIndex,
- metricSlots,
- series: rawSeries,
- cardIdToEntityIndex,
- sourceColors,
- onTabUpdate,
- onDimensionChange,
- onDimensionRemove,
-}: MetricsViewerTabContentProps) {
- const dimensionFilter = getTabConfig(tab.type).dimensionPredicate;
-
- const dimensionItems = useMemo(
- () =>
- buildDimensionItemsFromDefinitions(
- definitions,
- tab.dimensionMapping,
- modifiedDefinitionsBySlotIndex,
- sourceColors,
- metricSlots,
- formulaEntities,
- tab.projectionConfig,
- dimensionFilter,
- ),
- [
- definitions,
- tab.dimensionMapping,
- modifiedDefinitionsBySlotIndex,
- sourceColors,
- metricSlots,
- formulaEntities,
- tab.projectionConfig,
- dimensionFilter,
- ],
- );
-
- const definitionForControls = useMemo((): MetricDefinition | null => {
- for (const key of getObjectKeys(tab.dimensionMapping)) {
- const slotIndex = Number(key);
- const modDef = modifiedDefinitionsBySlotIndex.get(slotIndex);
- if (!modDef) {
- continue;
- }
- const projs = LibMetric.projections(modDef);
- if (projs.length > 0) {
- return modDef;
- }
- }
- return null;
- }, [tab.dimensionMapping, modifiedDefinitionsBySlotIndex]);
-
- const allFilterDimensions = useMemo(() => {
- const filterDimensions: DimensionMetadata[] = [];
- for (const key of getObjectKeys(tab.dimensionMapping)) {
- const slotIndex = Number(key);
- const modDef = modifiedDefinitionsBySlotIndex.get(slotIndex);
- if (!modDef) {
- continue;
- }
- const projInfo = getProjectionInfo(modDef);
- if (projInfo.filterDimension) {
- filterDimensions.push(projInfo.filterDimension);
- }
- }
- return filterDimensions;
- }, [tab.dimensionMapping, modifiedDefinitionsBySlotIndex]);
-
- const updateProjectionConfig = useCallback(
- (updates: Partial<MetricsViewerTabProjectionConfig>) => {
- onTabUpdate({
- projectionConfig: { ...tab.projectionConfig, ...updates },
- });
- },
- [onTabUpdate, tab.projectionConfig],
- );
-
- const handleDimensionFilterChange = useCallback(
- (value: DimensionFilterValue | undefined) => {
- updateProjectionConfig({ dimensionFilter: value });
- },
- [updateProjectionConfig],
- );
-
- const handleTemporalUnitChange = useCallback(
- (unit: TemporalUnit | undefined) => {
- updateProjectionConfig({ temporalUnit: unit });
- },
- [updateProjectionConfig],
- );
-
- const handleBinningChange = useCallback(
- (binningStrategy: string | undefined) => {
- updateProjectionConfig({ binningStrategy });
- },
- [updateProjectionConfig],
- );
-
- const handleDisplayTypeChange = useCallback(
- (display: MetricsViewerDisplayType) => {
- onTabUpdate({ display });
- },
- [onTabUpdate],
- );
-
- const handleVisualizationSettingsChange = useCallback(
- (updates: Partial<VisualizationSettings>) => {
- onTabUpdate({
- visualizationSettings: {
- ...tab.visualizationSettings,
- ...updates,
- },
- });
- },
- [onTabUpdate, tab.visualizationSettings],
- );
-
- const handleBrush = useCallback(
- ({ start, end }: { start: number; end: number }) => {
- updateProjectionConfig({
- dimensionFilter: {
- type: "specific-date",
- operator: "between",
- values: [new Date(start), new Date(end)],
- hasTime: true,
- },
- });
- },
- [updateProjectionConfig],
- );
-
- const showStackSeries = shouldShowStackSeries(
- tab.display,
- rawSeries,
- formulaEntities,
- definitions,
- );
-
- const isTimeTab = tab.type === "time";
-
- const tabConfig = getTabConfig(tab.type);
- const hasAnyOptions = dimensionItems.some((item) =>
- item.type === "expression"
- ? item.metricSources.some((s) => s.availableOptions.length > 0)
- : item.availableOptions.length > 0,
- );
- const hideDimensionPill = tabConfig.minDimensions === 0 && !hasAnyOptions;
-
- const mappedDimensionCount = getObjectValues(tab.dimensionMapping).filter(
- isNotNull,
- ).length;
- const dimensionRemoveHandler =
- mappedDimensionCount > 1 ? onDimensionRemove : undefined;
-
- return (
- <Stack flex="1 0 auto" gap={0}>
- <MetricsViewerVisualization
- rawSeries={rawSeries}
- onBrush={isTimeTab ? handleBrush : undefined}
- definitions={definitions}
- formulaEntities={formulaEntities}
- metricSlots={metricSlots}
- tab={tab}
- onTabUpdate={onTabUpdate}
- cardIdToEntityIndex={cardIdToEntityIndex}
- queriesAreLoading={queriesAreLoading}
- queriesError={queriesError}
- />
- {!hideDimensionPill && (
- <Box mt="sm">
- <DimensionPillBar
- items={dimensionItems}
- onDimensionChange={onDimensionChange}
- onDimensionRemove={dimensionRemoveHandler}
- />
- </Box>
- )}
- {definitionForControls && (
- <Flex mt="md" justify="center" align="center">
- <MetricControls
- definition={definitionForControls}
- displayType={tab.display}
- tabType={tab.type}
- dimensionFilter={tab.projectionConfig.dimensionFilter}
- allFilterDimensions={allFilterDimensions}
- onDisplayTypeChange={handleDisplayTypeChange}
- onDimensionFilterChange={handleDimensionFilterChange}
- onTemporalUnitChange={handleTemporalUnitChange}
- onBinningChange={handleBinningChange}
- showStackSeries={showStackSeries}
- visualizationSettings={tab.visualizationSettings}
- onVisualizationSettingsChange={handleVisualizationSettingsChange}
- />
- </Flex>
- )}
- </Stack>
- );
-}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabContent/index.ts b/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabContent/index.ts
deleted file mode 100644
index b7125158a7e..00000000000
--- a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabContent/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { MetricsViewerTabContent } from "./MetricsViewerTabContent";
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabs.module.css b/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabs.module.css
deleted file mode 100644
index 1cb39e00800..00000000000
--- a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabs.module.css
+++ /dev/null
@@ -1,13 +0,0 @@
-.list {
- &::before {
- display: none;
- }
-}
-
-.closeButton {
- visibility: hidden;
-}
-
-.tab:hover .closeButton {
- visibility: visible;
-}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabs.tsx b/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabs.tsx
deleted file mode 100644
index c6a0202e0ea..00000000000
--- a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabs.tsx
+++ /dev/null
@@ -1,123 +0,0 @@
-import { useCallback } from "react";
-import { t } from "ttag";
-
-import {
- trackMetricsViewerDimensionTabRemoved,
- trackMetricsViewerDimensionTabSwitched,
-} from "metabase/metrics-viewer/analytics";
-import type { TabInfo } from "metabase/metrics-viewer/utils/tabs";
-import { ActionIcon, Icon, Skeleton, Tabs } from "metabase/ui";
-
-import type {
- MetricSourceId,
- MetricsViewerTabState,
-} from "../../types/viewer-state";
-import type {
- AvailableDimensionsResult,
- SourceDisplayInfo,
-} from "../../utils/dimension-picker";
-
-import { AddDimensionPopover } from "./AddDimensionPopover";
-import S from "./MetricsViewerTabs.module.css";
-
-type MetricsViewerTabsProps = {
- tabs: MetricsViewerTabState[];
- activeTabId: string | null;
- isLoading?: boolean;
- availableDimensions: AvailableDimensionsResult;
- sourceOrder: MetricSourceId[];
- sourceDataById: Record<MetricSourceId, SourceDisplayInfo>;
- onTabChange: (tabId: string) => void;
- onAddTab: (tabInfo: TabInfo) => void;
- onRemoveTab: (tabId: string) => void;
-};
-
-export function MetricsViewerTabs({
- tabs,
- activeTabId,
- isLoading,
- availableDimensions,
- sourceOrder,
- sourceDataById,
- onTabChange,
- onAddTab,
- onRemoveTab,
-}: MetricsViewerTabsProps) {
- const handleRemoveTab = useCallback(
- (e: React.MouseEvent, tabId: string) => {
- e.stopPropagation();
- onRemoveTab(tabId);
- trackMetricsViewerDimensionTabRemoved();
- },
- [onRemoveTab],
- );
-
- const handleTabChange = useCallback(
- (value: string) => {
- onTabChange(value);
- trackMetricsViewerDimensionTabSwitched();
- },
- [onTabChange],
- );
-
- const hasSharedDimensions = availableDimensions.shared.length > 0;
- const hasAnySourceDimensions = sourceOrder.some(
- (sourceId) => (availableDimensions.bySource[sourceId]?.length ?? 0) > 0,
- );
- const hasAvailableDimensions = hasSharedDimensions || hasAnySourceDimensions;
- const hasMultipleSources = sourceOrder.length > 1;
-
- if (tabs.length <= 1 && !hasAvailableDimensions) {
- return null;
- }
-
- const canAddScalarTab = !tabs.some((tab) => tab.type === "scalar");
-
- return (
- <Tabs
- value={activeTabId}
- onChange={(value) => value && handleTabChange(value)}
- w="auto"
- >
- <Tabs.List className={S.list} justify="flex-start">
- {tabs.map((tab) => (
- <Tabs.Tab
- key={tab.id}
- value={tab.id}
- pl="lg"
- aria-label={tab.label ?? undefined}
- className={S.tab}
- >
- {isLoading || tab.label == null ? (
- <Skeleton display="inline-block" w="4.5rem" h="1em" />
- ) : (
- tab.label
- )}
- <ActionIcon
- className={S.closeButton}
- size="xs"
- variant="subtle"
- ml="xs"
- aria-label={
- tab.label != null ? t`Remove ${tab.label} tab` : undefined
- }
- onClick={(e) => handleRemoveTab(e, tab.id)}
- >
- <Icon name="close" size={10} />
- </ActionIcon>
- </Tabs.Tab>
- ))}
- {hasAvailableDimensions && (
- <AddDimensionPopover
- availableDimensions={availableDimensions}
- sourceOrder={sourceOrder}
- sourceDataById={sourceDataById}
- hasMultipleSources={hasMultipleSources}
- onAddTab={onAddTab}
- canAddScalarTab={canAddScalarTab}
- />
- )}
- </Tabs.List>
- </Tabs>
- );
-}
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/index.ts b/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/index.ts
deleted file mode 100644
index 0dbaefa7056..00000000000
--- a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/index.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-export { MetricsViewerTabContent } from "./MetricsViewerTabContent";
-export { MetricsViewerTabs } from "./MetricsViewerTabs";
diff --git a/frontend/src/metabase/metrics-viewer/components/MetricsViewerVisualization/MetricsViewerVisualization.tsx b/frontend/src/metabase/metrics-viewer/components/MetricsViewerVisualization/MetricsViewerVisualization.tsx
index f45df7989d4..2958469a475 100644
--- a/frontend/src/metabase/metrics-viewer/components/MetricsViewerVisualization/MetricsViewerVisualization.tsx
+++ b/frontend/src/metabase/metrics-viewer/components/MetricsViewerVisualization/MetricsViewerVisualization.tsx
@@ -17,8 +17,8 @@ import type { CardId, SingleSeries } from "metabase-types/api";
import type {
MetricSourceId,
MetricsViewerDefinitionEntry,
+ MetricsViewerDimensionBreakoutState,
MetricsViewerFormulaEntity,
- MetricsViewerTabState,
} from "../../types/viewer-state";
import S from "./MetricsViewerVisualization.module.css";
@@ -30,8 +30,10 @@ type MetricsViewerVisualizationProps = {
definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>;
formulaEntities: MetricsViewerFormulaEntity[];
metricSlots: MetricSlot[];
- tab: MetricsViewerTabState;
- onTabUpdate: (updates: Partial<MetricsViewerTabState>) => void;
+ dimensionBreakout: MetricsViewerDimensionBreakoutState;
+ onDimensionBreakoutUpdate: (
+ updates: Partial<MetricsViewerDimensionBreakoutState>,
+ ) => void;
cardIdToEntityIndex: Record<CardId, number>;
interactive?: boolean;
queriesAreLoading: boolean;
@@ -45,8 +47,8 @@ export function MetricsViewerVisualization({
definitions,
formulaEntities,
metricSlots,
- tab,
- onTabUpdate,
+ dimensionBreakout,
+ onDimensionBreakoutUpdate,
cardIdToEntityIndex,
interactive = true,
queriesAreLoading,
@@ -62,8 +64,8 @@ export function MetricsViewerVisualization({
definitions,
formulaEntities,
metricSlots,
- tab,
- onTabUpdate,
+ dimensionBreakout,
+ onDimensionBreakoutUpdate,
cardIdToEntityIndex,
})
: undefined,
@@ -73,8 +75,8 @@ export function MetricsViewerVisualization({
formulaEntities,
metricSlots,
interactive,
- onTabUpdate,
- tab,
+ onDimensionBreakoutUpdate,
+ dimensionBreakout,
],
);
@@ -119,7 +121,8 @@ export function MetricsViewerVisualization({
className={className}
>
{rawSeries.length > 1 &&
- DISPLAY_TYPE_REGISTRY[tab.display].supportsMultipleSeries === false ? (
+ DISPLAY_TYPE_REGISTRY[dimensionBreakout.display]
+ .supportsMultipleSeries === false ? (
<SimpleGrid cols={cols} flex={1} spacing={0}>
{rawSeries.map((series, i) => (
<Stack
diff --git a/frontend/src/metabase/metrics-viewer/constants.ts b/frontend/src/metabase/metrics-viewer/constants.ts
index 98251f232f1..4986b0afa3b 100644
--- a/frontend/src/metabase/metrics-viewer/constants.ts
+++ b/frontend/src/metabase/metrics-viewer/constants.ts
@@ -1,3 +1,3 @@
export const UNBINNED = "__unbinned__" as const;
-export const MAX_AUTO_TABS = 5;
+export const MAX_AUTO_DIMENSION_BREAKOUTS = 5;
diff --git a/frontend/src/metabase/metrics-viewer/context/MetricsViewerContext.tsx b/frontend/src/metabase/metrics-viewer/context/MetricsViewerContext.tsx
new file mode 100644
index 00000000000..03c53eeeb56
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/context/MetricsViewerContext.tsx
@@ -0,0 +1,30 @@
+import { type ReactNode, createContext, useContext } from "react";
+
+import type { UseViewerStateResult } from "metabase/metrics-viewer/types";
+
+const MetricsViewerContext = createContext<UseViewerStateResult | null>(null);
+
+export function MetricsViewerProvider({
+ value,
+ children,
+}: {
+ value: UseViewerStateResult;
+ children: ReactNode;
+}) {
+ return (
+ <MetricsViewerContext.Provider value={value}>
+ {children}
+ </MetricsViewerContext.Provider>
+ );
+}
+
+export function useMetricsViewerContext(): UseViewerStateResult {
+ const context = useContext(MetricsViewerContext);
+ if (!context) {
+ throw new Error(
+ "useMetricsViewerContext must be used within a MetricsViewerProvider",
+ );
+ }
+
+ return context;
+}
diff --git a/frontend/src/metabase/metrics-viewer/context/index.ts b/frontend/src/metabase/metrics-viewer/context/index.ts
new file mode 100644
index 00000000000..cbd712b0e63
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/context/index.ts
@@ -0,0 +1,4 @@
+export {
+ MetricsViewerProvider,
+ useMetricsViewerContext,
+} from "./MetricsViewerContext";
diff --git a/frontend/src/metabase/metrics-viewer/hooks/index.ts b/frontend/src/metabase/metrics-viewer/hooks/index.ts
index 1ea8b44a1b7..f721488080f 100644
--- a/frontend/src/metabase/metrics-viewer/hooks/index.ts
+++ b/frontend/src/metabase/metrics-viewer/hooks/index.ts
@@ -1 +1 @@
-export { useMetricsViewer } from "./use-metrics-viewer";
+export { useViewerState } from "./use-viewer-state";
diff --git a/frontend/src/metabase/metrics-viewer/hooks/use-definition-queries.ts b/frontend/src/metabase/metrics-viewer/hooks/use-definition-queries.ts
index 649d5349a55..a5f87fe8344 100644
--- a/frontend/src/metabase/metrics-viewer/hooks/use-definition-queries.ts
+++ b/frontend/src/metabase/metrics-viewer/hooks/use-definition-queries.ts
@@ -21,8 +21,8 @@ import {
type ExpressionDefinitionEntry,
type MetricSourceId,
type MetricsViewerDefinitionEntry,
+ type MetricsViewerDimensionBreakoutState,
type MetricsViewerFormulaEntity,
- type MetricsViewerTabState,
isExpressionEntry,
isMetricEntry,
} from "../types/viewer-state";
@@ -35,6 +35,7 @@ import {
getEffectiveDefinitionEntry,
getEffectiveTokenDefinitionEntry,
} from "../utils/definition-entries";
+import { getDimensionBreakoutConfig } from "../utils/dimension-breakout-config";
import type { MetricSlot } from "../utils/metric-slots";
import {
computeMetricSlots,
@@ -42,7 +43,6 @@ import {
findStandaloneSlot,
} from "../utils/metric-slots";
import { parseExpression } from "../utils/parse-expression";
-import { getTabConfig } from "../utils/tab-config";
export interface UseDefinitionQueriesResult {
resultsByEntityIndex: Map<number, Dataset>;
@@ -52,18 +52,20 @@ export interface UseDefinitionQueriesResult {
breakoutValuesByEntityIndex: Map<number, MetricBreakoutValuesResponse>;
}
-function getModifiedDefinitionForTab(
+function getModifiedDefinitionForDimensionBreakout(
definition: MetricsViewerDefinitionEntry,
slotIndex: number,
- tab: MetricsViewerTabState,
+ dimensionBreakout: MetricsViewerDimensionBreakoutState,
): MetricDefinition | null {
if (!definition.definition) {
return null;
}
- const tabConfig = getTabConfig(tab.type);
- const dimensionId = tab.dimensionMapping[slotIndex];
+ const dimensionBreakoutConfig = getDimensionBreakoutConfig(
+ dimensionBreakout.type,
+ );
+ const dimensionId = dimensionBreakout.dimensionMapping[slotIndex];
if (!dimensionId) {
- if (tabConfig.minDimensions > 0) {
+ if (dimensionBreakoutConfig.minDimensions > 0) {
return null;
}
return definition.definition;
@@ -71,13 +73,13 @@ function getModifiedDefinitionForTab(
return getModifiedDefinition(
definition.definition,
dimensionId,
- tab.projectionConfig,
+ dimensionBreakout.projectionConfig,
);
}
function buildArithmeticRequest(
definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>,
- tab: MetricsViewerTabState,
+ dimensionBreakout: MetricsViewerDimensionBreakoutState,
entity: ExpressionDefinitionEntry,
metricSlots: MetricSlot[],
entityIndex: number,
@@ -104,10 +106,10 @@ function buildArithmeticRequest(
// Find the specific slot for this expression token
const tokenSlot = findExpressionTokenSlot(metricSlots, entityIndex, i);
const slotIndex = tokenSlot?.slotIndex ?? -1;
- const modifiedDefinition = getModifiedDefinitionForTab(
+ const modifiedDefinition = getModifiedDefinitionForDimensionBreakout(
definition,
slotIndex,
- tab,
+ dimensionBreakout,
);
if (!modifiedDefinition) {
if (!definition.definition) {
@@ -172,7 +174,7 @@ function buildArithmeticRequest(
function buildQueryItems(
definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>,
formulaEntities: MetricsViewerFormulaEntity[],
- tab: MetricsViewerTabState | null,
+ dimensionBreakout: MetricsViewerDimensionBreakoutState | null,
): {
datasetRequestsByEntityIndex: Map<number, MetricDatasetRequest>;
modifiedDefinitionsBySlotIndex: Map<number, MetricDefinition>;
@@ -182,7 +184,7 @@ function buildQueryItems(
const modifiedDefinitionsBySlotIndex = new Map<number, MetricDefinition>();
const expressionErrorsByEntityIndex = new Map<number, string>();
- if (!tab) {
+ if (!dimensionBreakout) {
return {
datasetRequestsByEntityIndex,
modifiedDefinitionsBySlotIndex,
@@ -199,10 +201,10 @@ function buildQueryItems(
if (!slot) {
return;
}
- const modifiedDefinition = getModifiedDefinitionForTab(
+ const modifiedDefinition = getModifiedDefinitionForDimensionBreakout(
effectiveEntry,
slot.slotIndex,
- tab,
+ dimensionBreakout,
);
if (!modifiedDefinition) {
return;
@@ -217,7 +219,7 @@ function buildQueryItems(
if (isExpressionEntry(entity)) {
buildArithmeticRequest(
definitions,
- tab,
+ dimensionBreakout,
entity,
metricSlots,
entityIndex,
@@ -239,7 +241,7 @@ function buildQueryItems(
export function useDefinitionQueries(
definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>,
formulaEntities: MetricsViewerFormulaEntity[],
- tab: MetricsViewerTabState | null,
+ dimensionBreakout: MetricsViewerDimensionBreakoutState | null,
): UseDefinitionQueriesResult {
const dispatch = useDispatch();
@@ -248,8 +250,8 @@ export function useDefinitionQueries(
modifiedDefinitionsBySlotIndex,
expressionErrorsByEntityIndex,
} = useMemo(
- () => buildQueryItems(definitions, formulaEntities, tab),
- [definitions, formulaEntities, tab],
+ () => buildQueryItems(definitions, formulaEntities, dimensionBreakout),
+ [definitions, formulaEntities, dimensionBreakout],
);
const breakoutRequests = useMemo(() => {
diff --git a/frontend/src/metabase/metrics-viewer/hooks/use-metrics-viewer.ts b/frontend/src/metabase/metrics-viewer/hooks/use-metrics-viewer.ts
deleted file mode 100644
index 9ca0d136fb1..00000000000
--- a/frontend/src/metabase/metrics-viewer/hooks/use-metrics-viewer.ts
+++ /dev/null
@@ -1,395 +0,0 @@
-import { useCallback, useMemo } from "react";
-
-import { objectFromEntries } from "metabase/utils/objects";
-import { isNotNull } from "metabase/utils/types";
-import type {
- DimensionMetadata,
- MetricDefinition,
- ProjectionClause,
-} from "metabase-lib/metric";
-import * as LibMetric from "metabase-lib/metric";
-import type {
- CardId,
- Dataset,
- MetricBreakoutValuesResponse,
- SingleSeries,
-} from "metabase-types/api";
-
-import type { MetricsViewerPageProps } from "../pages/MetricsViewerPage/MetricsViewerPage";
-import type {
- MetricDefinitionEntry,
- MetricSourceId,
- MetricsViewerDefinitionEntry,
- MetricsViewerFormulaEntity,
- MetricsViewerTabState,
- SelectedMetric,
- SourceBreakoutColorMap,
- SourceColorMap,
-} from "../types/viewer-state";
-import { isExpressionEntry, isMetricEntry } from "../types/viewer-state";
-import { getDefinitionName } from "../utils/definition-builder";
-import type {
- AvailableDimensionsResult,
- SourceDisplayInfo,
-} from "../utils/dimension-picker";
-import { getAvailableDimensionsForPicker } from "../utils/dimension-picker";
-import { type MetricSlot, computeMetricSlots } from "../utils/metric-slots";
-import {
- buildSeries,
- computeSourceBreakoutColors,
- getSelectedMetricsInfo,
-} from "../utils/series";
-import { createSourceId } from "../utils/source-ids";
-import {
- type TabInfo,
- createTabFromTabInfo,
- recomputeTabLabels,
-} from "../utils/tabs";
-
-import { useDefinitionQueries } from "./use-definition-queries";
-import { useViewerState } from "./use-viewer-state";
-import { type LoadSourcesRequest, useViewerUrl } from "./use-viewer-url";
-
-export interface UseMetricsViewerResult {
- definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>;
- formulaEntities: MetricsViewerFormulaEntity[];
- tabs: MetricsViewerTabState[];
- activeTab: MetricsViewerTabState | null;
- activeTabId: string | null;
- initialLoadComplete: boolean;
- loadingIds: Set<MetricSourceId>;
- resultsByEntityIndex: Map<number, Dataset>;
- queriesAreLoading: boolean;
- queriesError: string | null;
- modifiedDefinitionsBySlotIndex: Map<number, MetricDefinition>;
- breakoutValuesByEntityIndex: Map<number, MetricBreakoutValuesResponse>;
- metricSlots: MetricSlot[];
- series: SingleSeries[];
- cardIdToEntityIndex: Record<CardId, number>;
- activeBreakoutColors: SourceBreakoutColorMap;
- sourceColors: SourceColorMap;
- selectedMetrics: SelectedMetric[];
- sourceOrder: MetricSourceId[];
- sourceDataById: Record<MetricSourceId, SourceDisplayInfo>;
- availableDimensions: AvailableDimensionsResult;
-
- addMetric: (metric: SelectedMetric) => void;
- swapMetric: (oldMetric: SelectedMetric, newMetric: SelectedMetric) => void;
- removeMetric: (id: number, sourceType: "metric" | "measure") => void;
- changeTab: (tabId: string) => void;
- addAndSelectTab: (tabInfo: TabInfo) => void;
- removeTab: (tabId: string) => void;
- updateTab: (tabId: string, updates: Partial<MetricsViewerTabState>) => void;
- updateActiveTab: (updates: Partial<MetricsViewerTabState>) => void;
- changeTabDimension: (
- tabId: string,
- slotIndex: number,
- dimension: DimensionMetadata,
- ) => void;
- removeTabDimension: (tabId: string, slotIndex: number) => void;
- setBreakoutDimension: (
- entity: MetricDefinitionEntry,
- dimension: ProjectionClause | undefined,
- ) => void;
- setFormulaEntities: (
- entities: MetricsViewerFormulaEntity[],
- slotMapping?: Map<number, number>,
- ) => void;
-}
-
-export function useMetricsViewer({
- location,
-}: MetricsViewerPageProps): UseMetricsViewerResult {
- const {
- state,
- loadingIds,
- initialLoadComplete,
- setInitialLoadComplete,
- removeDefinition,
- setFormulaEntities,
- selectTab: changeTab,
- addTab,
- removeTab,
- updateTab,
- setDefinitionDimension: changeTabDimension,
- removeDefinitionDimension: removeTabDimension,
- setBreakoutDimension,
- initialize,
- loadAndAddMetric,
- loadAndAddMeasure,
- loadAndReplaceMetric,
- loadAndReplaceMeasure,
- } = useViewerState();
-
- const handleLoadSources = useCallback(
- (request: LoadSourcesRequest) => {
- for (const metricId of request.metricIds) {
- loadAndAddMetric(metricId);
- }
- for (const measureId of request.measureIds) {
- loadAndAddMeasure(measureId);
- }
- },
- [loadAndAddMetric, loadAndAddMeasure],
- );
-
- useViewerUrl(
- state,
- initialize,
- handleLoadSources,
- location,
- setFormulaEntities,
- setInitialLoadComplete,
- );
-
- const activeTab = useMemo((): MetricsViewerTabState | null => {
- if (state.tabs.length === 0) {
- return null;
- }
- return (
- state.tabs.find((tab) => tab.id === state.selectedTabId) ?? state.tabs[0]
- );
- }, [state.tabs, state.selectedTabId]);
-
- const {
- resultsByEntityIndex,
- queriesAreLoading,
- queriesError,
- modifiedDefinitionsBySlotIndex,
- breakoutValuesByEntityIndex,
- } = useDefinitionQueries(state.definitions, state.formulaEntities, activeTab);
-
- const definitionValues = useMemo(
- () => Object.values(state.definitions),
- [state.definitions],
- );
-
- const selectedMetrics = useMemo(
- () => getSelectedMetricsInfo(definitionValues, loadingIds),
- [definitionValues, loadingIds],
- );
-
- const metricSlots = useMemo(
- () => computeMetricSlots(state.formulaEntities),
- [state.formulaEntities],
- );
-
- const sourceBreakoutColors = useMemo(
- () =>
- computeSourceBreakoutColors(
- state.formulaEntities,
- state.definitions,
- breakoutValuesByEntityIndex,
- ),
- [state.formulaEntities, state.definitions, breakoutValuesByEntityIndex],
- );
-
- const { series, cardIdToEntityIndex, activeBreakoutColors } = useMemo(() => {
- if (!activeTab) {
- return { series: [], cardIdToEntityIndex: {}, activeBreakoutColors: {} };
- }
- return buildSeries({
- formulaEntities: state.formulaEntities,
- definitions: state.definitions,
- display: activeTab.display,
- resultsByEntityIndex,
- sourceBreakoutColors,
- extraVizSettings: activeTab.visualizationSettings,
- });
- }, [
- state.formulaEntities,
- state.definitions,
- activeTab,
- resultsByEntityIndex,
- sourceBreakoutColors,
- ]);
-
- const sourceColors = useMemo(
- () =>
- Object.fromEntries(
- Object.entries(activeBreakoutColors).map(([sourceId, colors]) => [
- sourceId,
- colors === undefined
- ? []
- : typeof colors === "string"
- ? [colors]
- : Array.from(colors.values()),
- ]),
- ),
- [activeBreakoutColors],
- );
-
- const definitionsBySourceId = useMemo(
- () =>
- objectFromEntries(
- definitionValues.map((entry) => [entry.id, entry.definition] as const),
- ),
- [definitionValues],
- );
-
- const sourceOrder = useMemo(() => {
- const out: MetricSourceId[] = [];
- const seen = new Set<MetricSourceId>();
- for (const entry of state.formulaEntities) {
- if (isMetricEntry(entry) && !seen.has(entry.id)) {
- out.push(entry.id);
- seen.add(entry.id);
- }
- if (isExpressionEntry(entry)) {
- for (const token of entry.tokens) {
- if (token.type === "metric" && !seen.has(token.sourceId)) {
- out.push(token.sourceId);
- seen.add(token.sourceId);
- }
- }
- }
- }
- return out;
- }, [state.formulaEntities]);
-
- const sourceDataById = useMemo((): Record<
- MetricSourceId,
- SourceDisplayInfo
- > => {
- const result: Record<MetricSourceId, SourceDisplayInfo> = {};
- for (const entry of definitionValues) {
- const { definition } = entry;
- if (!definition) {
- continue;
- }
- const name = getDefinitionName(definition);
- if (!name) {
- continue;
- }
- if (LibMetric.sourceMetricId(definition) != null) {
- result[entry.id] = { type: "metric", name };
- } else if (LibMetric.sourceMeasureId(definition) != null) {
- result[entry.id] = { type: "measure", name };
- }
- }
- return result;
- }, [definitionValues]);
-
- const existingTabDimensionIds = useMemo(
- () =>
- new Set(
- state.tabs
- .flatMap((tab) => Object.values(tab.dimensionMapping))
- .filter(isNotNull),
- ),
- [state.tabs],
- );
-
- const effectiveTabs = useMemo(
- () => recomputeTabLabels(state.tabs, state.definitions, metricSlots),
- [state.tabs, metricSlots, state.definitions],
- );
-
- const availableDimensions = useMemo(
- () =>
- getAvailableDimensionsForPicker(
- definitionsBySourceId,
- sourceOrder,
- metricSlots,
- existingTabDimensionIds,
- ),
- [definitionsBySourceId, sourceOrder, metricSlots, existingTabDimensionIds],
- );
-
- const addMetric = useCallback(
- (metric: SelectedMetric) => {
- const sourceId = createSourceId(metric.id, metric.sourceType);
-
- if (sourceId in state.definitions) {
- return;
- }
-
- if (metric.sourceType === "metric") {
- loadAndAddMetric(metric.id);
- } else {
- loadAndAddMeasure(metric.id);
- }
- },
- [state.definitions, loadAndAddMetric, loadAndAddMeasure],
- );
-
- const swapMetric = useCallback(
- (oldMetric: SelectedMetric, newMetric: SelectedMetric) => {
- const oldSourceId = createSourceId(oldMetric.id, oldMetric.sourceType);
-
- if (newMetric.sourceType === "metric") {
- loadAndReplaceMetric(oldSourceId, newMetric.id);
- } else {
- loadAndReplaceMeasure(oldSourceId, newMetric.id);
- }
- },
- [loadAndReplaceMetric, loadAndReplaceMeasure],
- );
-
- const removeMetric = useCallback(
- (id: number, sourceType: "metric" | "measure") => {
- removeDefinition(createSourceId(id, sourceType));
- },
- [removeDefinition],
- );
-
- const addAndSelectTab = useCallback(
- (tabInfo: TabInfo) => {
- const newTab = createTabFromTabInfo(tabInfo);
- if (!newTab) {
- return;
- }
-
- addTab(newTab);
- changeTab(newTab.id);
- },
- [addTab, changeTab],
- );
-
- const updateActiveTab = useCallback(
- (updates: Partial<MetricsViewerTabState>) => {
- if (!activeTab) {
- return;
- }
- updateTab(activeTab.id, updates);
- },
- [activeTab, updateTab],
- );
-
- return {
- definitions: state.definitions,
- formulaEntities: state.formulaEntities,
- tabs: effectiveTabs,
- activeTab,
- activeTabId: state.selectedTabId,
- initialLoadComplete,
- loadingIds,
- resultsByEntityIndex,
- queriesAreLoading,
- queriesError,
- modifiedDefinitionsBySlotIndex,
- breakoutValuesByEntityIndex,
- metricSlots,
- series,
- cardIdToEntityIndex,
- activeBreakoutColors,
- sourceColors,
- selectedMetrics,
- sourceOrder,
- sourceDataById,
- availableDimensions,
-
- addMetric,
- swapMetric,
- removeMetric,
- changeTab,
- addAndSelectTab,
- removeTab,
- updateTab,
- updateActiveTab,
- changeTabDimension,
- removeTabDimension,
- setBreakoutDimension,
- setFormulaEntities,
- };
-}
diff --git a/frontend/src/metabase/metrics-viewer/hooks/use-viewer-derived-data.ts b/frontend/src/metabase/metrics-viewer/hooks/use-viewer-derived-data.ts
new file mode 100644
index 00000000000..baf2fa395dd
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/hooks/use-viewer-derived-data.ts
@@ -0,0 +1,267 @@
+import { useMemo } from "react";
+
+import { objectFromEntries } from "metabase/utils/objects";
+import * as LibMetric from "metabase-lib/metric";
+
+import type {
+ MetricSourceId,
+ MetricsViewerDefinitionEntry,
+ MetricsViewerDimensionBreakoutState,
+ MetricsViewerFormulaEntity,
+ SourceDisplayInfo,
+ UseViewerStateResult,
+} from "../types/viewer-state";
+import { isExpressionEntry, isMetricEntry } from "../types/viewer-state";
+import { getDefinitionName } from "../utils/definition-builder";
+import {
+ getAvailableDimensionsForPicker,
+ getExistingDimensionBreakoutDimensionIds,
+} from "../utils/dimension-picker";
+import { computeMetricSlots } from "../utils/metric-slots";
+import {
+ buildSeries,
+ computeSourceBreakoutColors,
+ getSelectedMetricsInfo,
+} from "../utils/series";
+
+import { useDefinitionQueries } from "./use-definition-queries";
+
+type UseViewerDerivedDataInput = {
+ definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>;
+ formulaEntities: MetricsViewerFormulaEntity[];
+ dimensionBreakouts: MetricsViewerDimensionBreakoutState[];
+ selectedDimensionBreakoutId: string | null;
+ loadingIds: Set<MetricSourceId>;
+};
+
+type UseViewerDerivedDataResult = Pick<
+ UseViewerStateResult,
+ | "activeDimensionBreakout"
+ | "queriesAreLoading"
+ | "queriesError"
+ | "modifiedDefinitionsBySlotIndex"
+ | "metricSlots"
+ | "series"
+ | "cardIdToEntityIndex"
+ | "activeBreakoutColors"
+ | "sourceColors"
+ | "selectedMetrics"
+ | "sourceOrder"
+ | "sourceDataById"
+ | "availableDimensions"
+ | "sidebarAvailableDimensions"
+>;
+
+export function useViewerDerivedData({
+ definitions,
+ formulaEntities,
+ dimensionBreakouts,
+ selectedDimensionBreakoutId,
+ loadingIds,
+}: UseViewerDerivedDataInput): UseViewerDerivedDataResult {
+ const activeDimensionBreakout = useMemo(() => {
+ if (dimensionBreakouts.length === 0) {
+ return null;
+ }
+ return (
+ dimensionBreakouts.find(
+ (dimensionBreakout) =>
+ dimensionBreakout.id === selectedDimensionBreakoutId,
+ ) ?? dimensionBreakouts[0]
+ );
+ }, [dimensionBreakouts, selectedDimensionBreakoutId]);
+
+ const {
+ resultsByEntityIndex,
+ queriesAreLoading,
+ queriesError,
+ modifiedDefinitionsBySlotIndex,
+ breakoutValuesByEntityIndex,
+ } = useDefinitionQueries(
+ definitions,
+ formulaEntities,
+ activeDimensionBreakout,
+ );
+
+ const definitionValues = useMemo(
+ () => Object.values(definitions),
+ [definitions],
+ );
+
+ const selectedMetrics = useMemo(
+ () => getSelectedMetricsInfo(definitionValues, loadingIds),
+ [definitionValues, loadingIds],
+ );
+
+ const metricSlots = useMemo(
+ () => computeMetricSlots(formulaEntities),
+ [formulaEntities],
+ );
+
+ const sourceBreakoutColors = useMemo(
+ () =>
+ computeSourceBreakoutColors(
+ formulaEntities,
+ definitions,
+ breakoutValuesByEntityIndex,
+ ),
+ [formulaEntities, definitions, breakoutValuesByEntityIndex],
+ );
+
+ const { series, cardIdToEntityIndex, activeBreakoutColors } = useMemo(() => {
+ if (!activeDimensionBreakout) {
+ return { series: [], cardIdToEntityIndex: {}, activeBreakoutColors: {} };
+ }
+ return buildSeries({
+ formulaEntities,
+ definitions,
+ display: activeDimensionBreakout.display,
+ resultsByEntityIndex,
+ sourceBreakoutColors,
+ extraVizSettings: activeDimensionBreakout.visualizationSettings,
+ });
+ }, [
+ formulaEntities,
+ definitions,
+ activeDimensionBreakout,
+ resultsByEntityIndex,
+ sourceBreakoutColors,
+ ]);
+
+ const sourceColors = useMemo(
+ () =>
+ Object.fromEntries(
+ Object.entries(activeBreakoutColors).map(([sourceId, colors]) => [
+ sourceId,
+ colors === undefined
+ ? []
+ : typeof colors === "string"
+ ? [colors]
+ : Array.from(colors.values()),
+ ]),
+ ),
+ [activeBreakoutColors],
+ );
+
+ const definitionsBySourceId = useMemo(
+ () =>
+ objectFromEntries(
+ definitionValues.map((entry) => [entry.id, entry.definition] as const),
+ ),
+ [definitionValues],
+ );
+
+ const sourceOrder = useMemo(() => {
+ const out: MetricSourceId[] = [];
+ const seen = new Set<MetricSourceId>();
+ for (const entry of formulaEntities) {
+ if (isMetricEntry(entry) && !seen.has(entry.id)) {
+ out.push(entry.id);
+ seen.add(entry.id);
+ }
+ if (isExpressionEntry(entry)) {
+ for (const token of entry.tokens) {
+ if (token.type === "metric" && !seen.has(token.sourceId)) {
+ out.push(token.sourceId);
+ seen.add(token.sourceId);
+ }
+ }
+ }
+ }
+ return out;
+ }, [formulaEntities]);
+
+ const sourceDataById = useMemo((): Record<
+ MetricSourceId,
+ SourceDisplayInfo
+ > => {
+ const result: Record<MetricSourceId, SourceDisplayInfo> = {};
+ for (const entry of definitionValues) {
+ const { definition } = entry;
+ if (!definition) {
+ continue;
+ }
+ const name = getDefinitionName(definition);
+ if (!name) {
+ continue;
+ }
+ if (LibMetric.sourceMetricId(definition) != null) {
+ result[entry.id] = { type: "metric", name };
+ } else if (LibMetric.sourceMeasureId(definition) != null) {
+ result[entry.id] = { type: "measure", name };
+ }
+ }
+ return result;
+ }, [definitionValues]);
+
+ const existingNonActiveDimensionBreakoutDimensionIds = useMemo(
+ () =>
+ getExistingDimensionBreakoutDimensionIds(
+ dimensionBreakouts,
+ activeDimensionBreakout?.id,
+ ),
+ [dimensionBreakouts, activeDimensionBreakout?.id],
+ );
+
+ const availableDimensions = useMemo(
+ () =>
+ getAvailableDimensionsForPicker(
+ definitionsBySourceId,
+ sourceOrder,
+ metricSlots,
+ existingNonActiveDimensionBreakoutDimensionIds,
+ ),
+ [
+ definitionsBySourceId,
+ sourceOrder,
+ metricSlots,
+ existingNonActiveDimensionBreakoutDimensionIds,
+ ],
+ );
+
+ const sidebarAvailableDimensions = useMemo(
+ () =>
+ getAvailableDimensionsForPicker(
+ definitionsBySourceId,
+ sourceOrder,
+ metricSlots,
+ new Set(),
+ ),
+ [definitionsBySourceId, sourceOrder, metricSlots],
+ );
+
+ return useMemo(
+ () => ({
+ activeDimensionBreakout,
+ queriesAreLoading,
+ queriesError,
+ modifiedDefinitionsBySlotIndex,
+ metricSlots,
+ series,
+ cardIdToEntityIndex,
+ activeBreakoutColors,
+ sourceColors,
+ selectedMetrics,
+ sourceOrder,
+ sourceDataById,
+ availableDimensions,
+ sidebarAvailableDimensions,
+ }),
+ [
+ activeDimensionBreakout,
+ queriesAreLoading,
+ queriesError,
+ modifiedDefinitionsBySlotIndex,
+ metricSlots,
+ series,
+ cardIdToEntityIndex,
+ activeBreakoutColors,
+ sourceColors,
+ selectedMetrics,
+ sourceOrder,
+ sourceDataById,
+ availableDimensions,
+ sidebarAvailableDimensions,
+ ],
+ );
+}
diff --git a/frontend/src/metabase/metrics-viewer/hooks/use-viewer-state.ts b/frontend/src/metabase/metrics-viewer/hooks/use-viewer-state.ts
index 2b23a93ecfa..6c487821793 100644
--- a/frontend/src/metabase/metrics-viewer/hooks/use-viewer-state.ts
+++ b/frontend/src/metabase/metrics-viewer/hooks/use-viewer-state.ts
@@ -1,44 +1,50 @@
-import { useCallback, useEffect, useRef, useState } from "react";
+import { useDisclosure } from "@mantine/hooks";
+import { useCallback, useEffect, useMemo, useRef, useState } from "react";
import { measureApi, metricApi, segmentApi } from "metabase/api";
import { useDispatch, useStore } from "metabase/redux";
import { getMetadata } from "metabase/selectors/metadata";
-import { getObjectEntries, objectFromEntries } from "metabase/utils/objects";
-import { isNotNull } from "metabase/utils/types";
-import type {
- DimensionMetadata,
- MetricDefinition,
- ProjectionClause,
-} from "metabase-lib/metric";
+import { getObjectEntries } from "metabase/utils/objects";
+import type { MetricDefinition, ProjectionClause } from "metabase-lib/metric";
import * as LibMetric from "metabase-lib/metric";
import type { MeasureId } from "metabase-types/api";
import type { MetricId } from "metabase-types/api/metric";
+import type { MetricsViewerPageProps } from "../pages/MetricsViewerPage/MetricsViewerPage";
import type {
+ DimensionBreakoutInfo,
MetricDefinitionEntry,
MetricSourceId,
MetricsViewerDefinitionEntry,
+ MetricsViewerDimensionBreakoutState,
MetricsViewerFormulaEntity,
MetricsViewerPageState,
- MetricsViewerTabState,
- StoredMetricsViewerTab,
-} from "../types/viewer-state";
+ SelectedMetric,
+ UseViewerStateResult,
+} from "../types";
import {
getInitialMetricsViewerPageState,
isExpressionEntry,
isMetricEntry,
-} from "../types/viewer-state";
-import { buildBinnedBreakoutDefinition } from "../utils/definition-builder";
-import { getEffectiveDefinitionEntry } from "../utils/definition-entries";
-import { computeMetricSlots } from "../utils/metric-slots";
-import { remapDimensionMappings } from "../utils/remap-dimension-mappings";
+} from "../types";
import {
+ applySerializedDefinitionInfo,
+ areDimensionBreakoutDimensionsValid,
+ assignDimensionsForUnmappedSlots,
+ buildBinnedBreakoutDefinition,
+ computeDefaultDimensionBreakouts,
+ createDimensionBreakoutFromInfo,
createMeasureSourceId,
createMetricSourceId,
-} from "../utils/source-ids";
-import { getTabConfig } from "../utils/tab-config";
-import { computeDefaultTabs, findMatchingDimensionForTab } from "../utils/tabs";
-import { applySerializedDefinitionInfo } from "../utils/url-serialization";
+ createSourceId,
+ getEffectiveDefinitionEntry,
+ getValidSelectedDimensionBreakoutId,
+} from "../utils";
+import { computeMetricSlots } from "../utils/metric-slots";
+import { remapDimensionMappings } from "../utils/remap-dimension-mappings";
+
+import { useViewerDerivedData } from "./use-viewer-derived-data";
+import { type LoadSourcesRequest, useViewerUrl } from "./use-viewer-url";
async function loadMetricDefinition(
dispatch: ReturnType<typeof useDispatch>,
@@ -80,179 +86,9 @@ async function loadMeasureDefinition(
return LibMetric.fromMeasureMetadata(provider, meta);
}
-function getValidSelectedTabId(
- currentSelectedId: string | null,
- newTabs: MetricsViewerTabState[],
-): string | null {
- const selectedTabExists = newTabs.some((tab) => tab.id === currentSelectedId);
-
- return selectedTabExists ? currentSelectedId : (newTabs[0]?.id ?? null);
-}
-
-/**
- * For each tab, find slots that have no dimension assigned yet but whose
- * definition IS loaded, and try to smart-match a dimension using the same
- * logic as `addDefinitionToTabs`. This handles both timing orderings:
- * - definition loaded before formula committed (called from setFormulaEntities)
- * - formula committed before definition loaded (called from updateDefinition)
- */
-function assignDimensionsForUnmappedSlots(
- tabs: MetricsViewerTabState[],
- definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>,
- formulaEntities: MetricsViewerFormulaEntity[],
-): MetricsViewerTabState[] {
- const slots = computeMetricSlots(formulaEntities);
- if (slots.length === 0) {
- return tabs;
- }
-
- const slotIndexToSourceId = new Map<number, MetricSourceId>();
- for (const slot of slots) {
- slotIndexToSourceId.set(slot.slotIndex, slot.sourceId);
- }
-
- return tabs.map((tab) => {
- if (tab.label == null) {
- return tab;
- }
-
- // Collect unmapped slots grouped by sourceId.
- const unmappedBySource = new Map<
- MetricSourceId,
- { slotIndices: number[]; definition: MetricDefinition }
- >();
-
- for (const slot of slots) {
- const existing = tab.dimensionMapping[slot.slotIndex];
- if (existing !== undefined) {
- continue; // already mapped (even if null — that's an explicit clear)
- }
- const defEntry = definitions[slot.sourceId];
- if (!defEntry?.definition) {
- continue; // definition not loaded yet
- }
- let group = unmappedBySource.get(slot.sourceId);
- if (!group) {
- group = { slotIndices: [], definition: defEntry.definition };
- unmappedBySource.set(slot.sourceId, group);
- }
- group.slotIndices.push(slot.slotIndex);
- }
-
- if (unmappedBySource.size === 0) {
- return tab;
- }
-
- // Build stored-tab representation for matching.
- const activeMappings: Record<number, string> = {};
- for (const [key, value] of getObjectEntries(tab.dimensionMapping)) {
- if (value != null) {
- activeMappings[Number(key)] = value;
- }
- }
- const storedTab: StoredMetricsViewerTab = {
- id: tab.id,
- type: tab.type,
- label: tab.label,
- dimensionBySlotIndex: activeMappings,
- };
-
- let newMappings: Record<number, string> | null = null;
-
- for (const [sourceId, { slotIndices, definition }] of unmappedBySource) {
- const existingDefinitions = objectFromEntries(
- Object.values(definitions)
- .filter((entry) => entry.id !== sourceId && entry.definition != null)
- .map((entry) => [entry.id, entry.definition] as const),
- );
-
- const matchingDimension = findMatchingDimensionForTab(
- definition,
- storedTab,
- existingDefinitions,
- slotIndexToSourceId,
- );
-
- if (matchingDimension) {
- if (!newMappings) {
- newMappings = {};
- }
- for (const idx of slotIndices) {
- newMappings[idx] = matchingDimension;
- }
- }
- }
-
- if (!newMappings) {
- return tab;
- }
-
- return {
- ...tab,
- dimensionMapping: {
- ...tab.dimensionMapping,
- ...newMappings,
- },
- };
- });
-}
-
-function areTabDimensionsValid(tab: MetricsViewerTabState): boolean {
- const tabConfig = getTabConfig(tab.type);
- return (
- Object.values(tab.dimensionMapping).filter(isNotNull).length >=
- tabConfig.minDimensions
- );
-}
-
-export interface UseViewerStateResult {
- state: MetricsViewerPageState;
- loadingIds: Set<MetricSourceId>;
- initialLoadComplete: boolean;
- setInitialLoadComplete: (initialLoadComplete: boolean) => void;
-
- removeDefinition: (id: MetricSourceId) => void;
- updateDefinition: (id: MetricSourceId, definition: MetricDefinition) => void;
- setFormulaEntities: (
- entities: MetricsViewerFormulaEntity[],
- slotMapping?: Map<number, number>,
- ) => void;
-
- selectTab: (tabId: string) => void;
- addTab: (tab: MetricsViewerTabState) => void;
- removeTab: (tabId: string) => void;
- updateTab: (tabId: string, updates: Partial<MetricsViewerTabState>) => void;
- setDefinitionDimension: (
- tabId: string,
- slotIndex: number,
- dimension: DimensionMetadata,
- ) => void;
- removeDefinitionDimension: (tabId: string, slotIndex: number) => void;
- setBreakoutDimension: (
- entity: MetricDefinitionEntry,
- dimension: ProjectionClause | undefined,
- ) => void;
-
- initialize: (state: MetricsViewerPageState) => void;
- loadAndAddMetric: (
- metricId: MetricId,
- transform?: (def: MetricDefinition) => MetricDefinition,
- ) => void;
- loadAndAddMeasure: (
- measureId: MeasureId,
- transform?: (def: MetricDefinition) => MetricDefinition,
- ) => void;
- loadAndReplaceMetric: (
- oldSourceId: MetricSourceId,
- metricId: MetricId,
- ) => void;
- loadAndReplaceMeasure: (
- oldSourceId: MetricSourceId,
- measureId: MeasureId,
- ) => void;
-}
-
-export function useViewerState(): UseViewerStateResult {
+export function useViewerState({
+ location,
+}: MetricsViewerPageProps): UseViewerStateResult {
const dispatch = useDispatch();
const store = useStore();
@@ -266,6 +102,8 @@ export function useViewerState(): UseViewerStateResult {
const [loadingIds, setLoadingIds] = useState<Set<MetricSourceId>>(new Set());
const [initialLoadComplete, setInitialLoadComplete] = useState(false);
+ const [isSidebarOpen, { open: openSidebar, close: closeSidebar }] =
+ useDisclosure(false);
const initialize: (newState: MetricsViewerPageState) => void = setState;
@@ -298,34 +136,39 @@ export function useViewerState(): UseViewerStateResult {
slots.filter((s) => s.sourceId === id).map((s) => s.slotIndex),
);
- const newTabs =
- // scalar tab is always valid, but we want to remove it if there are no definitions
- // so that adding a new definition triggers computeDefaultTabs
+ const newDimensionBreakouts =
+ // scalar dimension breakout is always valid, but we want to remove it if there are no definitions
+ // so that adding a new definition triggers computeDefaultDimensionBreakouts
Object.keys(newDefinitions).length === 0
? []
- : prev.tabs
- .map((tab) => {
+ : prev.dimensionBreakouts
+ .map((dimensionBreakout) => {
// Remove entries for removed slot indices.
// Don't shift — remapDimensionMappings handles that
// when formulaEntities are updated separately.
const newMapping: Record<number, string | null> = {};
for (const [key, value] of getObjectEntries(
- tab.dimensionMapping,
+ dimensionBreakout.dimensionMapping,
)) {
const idx = Number(key);
if (!removedSlotIndices.has(idx)) {
newMapping[idx] = value;
}
}
- return { ...tab, dimensionMapping: newMapping };
+ return { ...dimensionBreakout, dimensionMapping: newMapping };
})
- .filter((tab) => areTabDimensionsValid(tab));
+ .filter((dimensionBreakout) =>
+ areDimensionBreakoutDimensionsValid(dimensionBreakout),
+ );
return {
...prev,
definitions: newDefinitions,
- tabs: newTabs,
- selectedTabId: getValidSelectedTabId(prev.selectedTabId, newTabs),
+ dimensionBreakouts: newDimensionBreakouts,
+ selectedDimensionBreakoutId: getValidSelectedDimensionBreakoutId(
+ prev.selectedDimensionBreakoutId,
+ newDimensionBreakouts,
+ ),
};
}),
[],
@@ -344,23 +187,29 @@ export function useViewerState(): UseViewerStateResult {
[id]: { ...existing, definition },
};
- if (prev.tabs.length === 0) {
+ if (prev.dimensionBreakouts.length === 0) {
return { ...prev, definitions: newDefinitions };
}
- const updatedTabs = assignDimensionsForUnmappedSlots(
- prev.tabs,
+ const updatedDimensionBreakouts = assignDimensionsForUnmappedSlots(
+ prev.dimensionBreakouts,
newDefinitions,
prev.formulaEntities,
);
- const newTabs = updatedTabs.filter((tab) => areTabDimensionsValid(tab));
+ const newDimensionBreakouts = updatedDimensionBreakouts.filter(
+ (dimensionBreakout) =>
+ areDimensionBreakoutDimensionsValid(dimensionBreakout),
+ );
return {
...prev,
definitions: newDefinitions,
- tabs: newTabs,
- selectedTabId: getValidSelectedTabId(prev.selectedTabId, newTabs),
+ dimensionBreakouts: newDimensionBreakouts,
+ selectedDimensionBreakoutId: getValidSelectedDimensionBreakoutId(
+ prev.selectedDimensionBreakoutId,
+ newDimensionBreakouts,
+ ),
};
}),
[],
@@ -402,133 +251,78 @@ export function useViewerState(): UseViewerStateResult {
);
// Remove dimension mappings for replaced slot indices (new metric has different dimensions)
- const newTabs = prev.tabs.map((tab) => {
- const newMapping = { ...tab.dimensionMapping };
- for (const idx of replacedSlotIndices) {
- delete newMapping[idx];
- }
- return { ...tab, dimensionMapping: newMapping };
- });
+ const newDimensionBreakouts = prev.dimensionBreakouts.map(
+ (dimensionBreakout) => {
+ const newMapping = { ...dimensionBreakout.dimensionMapping };
+ for (const idx of replacedSlotIndices) {
+ delete newMapping[idx];
+ }
+ return { ...dimensionBreakout, dimensionMapping: newMapping };
+ },
+ );
return {
...prev,
definitions: newDefinitions,
formulaEntities: newFormulaEntities,
- tabs: newTabs,
+ dimensionBreakouts: newDimensionBreakouts,
};
}),
[],
);
- const selectTab = useCallback(
- (tabId: string) => setState((prev) => ({ ...prev, selectedTabId: tabId })),
+ const selectDimensionBreakoutById = useCallback(
+ (dimensionBreakoutId: string) =>
+ setState((prev) => ({
+ ...prev,
+ selectedDimensionBreakoutId: dimensionBreakoutId,
+ })),
[],
);
- const addTab = useCallback(
- (tab: MetricsViewerTabState) =>
+ const addDimensionBreakout = useCallback(
+ (dimensionBreakout: MetricsViewerDimensionBreakoutState) =>
setState((prev) => {
- if (prev.tabs.some((existing) => existing.id === tab.id)) {
+ if (
+ prev.dimensionBreakouts.some(
+ (existing) => existing.id === dimensionBreakout.id,
+ )
+ ) {
return prev;
}
- const newTabs = assignDimensionsForUnmappedSlots(
- [...prev.tabs, tab],
+ const newDimensionBreakouts = assignDimensionsForUnmappedSlots(
+ [...prev.dimensionBreakouts, dimensionBreakout],
prev.definitions,
prev.formulaEntities,
);
return {
...prev,
- tabs: newTabs,
- selectedTabId:
- prev.selectedTabId == null ? tab.id : prev.selectedTabId,
+ dimensionBreakouts: newDimensionBreakouts,
+ selectedDimensionBreakoutId:
+ prev.selectedDimensionBreakoutId == null
+ ? dimensionBreakout.id
+ : prev.selectedDimensionBreakoutId,
};
}),
[],
);
- const removeTab = useCallback(
- (tabId: string) =>
- setState((prev) => {
- const newTabs = prev.tabs.filter((tab) => tab.id !== tabId);
- const needsTabSwitch = prev.selectedTabId === tabId;
-
- return {
- ...prev,
- tabs: newTabs,
- selectedTabId: needsTabSwitch
- ? (newTabs[0]?.id ?? null)
- : prev.selectedTabId,
- };
- }),
- [],
- );
-
- const updateTab = useCallback(
- (tabId: string, updates: Partial<MetricsViewerTabState>) =>
+ const updateDimensionBreakout = useCallback(
+ (
+ dimensionBreakoutId: string,
+ updates: Partial<MetricsViewerDimensionBreakoutState>,
+ ) =>
setState((prev) => ({
...prev,
- tabs: prev.tabs.map((tab) =>
- tab.id === tabId ? { ...tab, ...updates } : tab,
+ dimensionBreakouts: prev.dimensionBreakouts.map((dimensionBreakout) =>
+ dimensionBreakout.id === dimensionBreakoutId
+ ? { ...dimensionBreakout, ...updates }
+ : dimensionBreakout,
),
})),
[],
);
- const setDefinitionDimension = useCallback(
- (tabId: string, slotIndex: number, dimension: DimensionMetadata) =>
- setState((prev) => {
- const slots = computeMetricSlots(prev.formulaEntities);
- const slot = slots[slotIndex];
- if (!slot) {
- return prev;
- }
-
- const entry = prev.definitions[slot.sourceId];
- const def = entry?.definition;
- const dimId = def
- ? LibMetric.dimensionValuesInfo(def, dimension).id
- : undefined;
-
- if (!dimId) {
- return prev;
- }
-
- return {
- ...prev,
- tabs: prev.tabs.map((tab) => {
- if (tab.id !== tabId) {
- return tab;
- }
- return {
- ...tab,
- dimensionMapping: {
- ...tab.dimensionMapping,
- [slotIndex]: dimId,
- },
- };
- }),
- };
- }),
- [],
- );
-
- const removeDefinitionDimension = useCallback(
- (tabId: string, slotIndex: number) =>
- setState((prev) => ({
- ...prev,
- tabs: prev.tabs.map((tab) => {
- if (tab.id !== tabId) {
- return tab;
- }
- return {
- ...tab,
- dimensionMapping: { ...tab.dimensionMapping, [slotIndex]: null },
- };
- }),
- })),
- [],
- );
-
const setFormulaEntities = useCallback(
(
formulaEntities: MetricsViewerFormulaEntity[],
@@ -538,20 +332,24 @@ export function useViewerState(): UseViewerStateResult {
// When a slotMapping is provided (from commitAndCollapse or
// handleRemoveItem), use it to remap dimension mappings efficiently.
// Otherwise the caller is not changing entity structure (paren cleanup,
- // filter/breakout changes, URL restore) so tabs are kept as-is.
- const reconciledTabs = slotMapping
- ? remapDimensionMappings(prev.tabs, slotMapping, formulaEntities)
- : prev.tabs;
- let tabs = assignDimensionsForUnmappedSlots(
- reconciledTabs,
+ // filter/breakout changes, URL restore) so dimensionBreakouts are kept as-is.
+ const reconciledDimensionBreakouts = slotMapping
+ ? remapDimensionMappings(
+ prev.dimensionBreakouts,
+ slotMapping,
+ formulaEntities,
+ )
+ : prev.dimensionBreakouts;
+ let dimensionBreakouts = assignDimensionsForUnmappedSlots(
+ reconciledDimensionBreakouts,
prev.definitions,
formulaEntities,
);
- // When tabs are empty (e.g. all metrics were removed then one was
- // added back), generate default tabs now that formulaEntities includes
+ // When dimensionBreakouts are empty (e.g. all metrics were removed then one was
+ // added back), generate default dimensionBreakouts now that formulaEntities includes
// the new metric and its definition may already be loaded.
- if (tabs.length === 0) {
+ if (dimensionBreakouts.length === 0) {
const metricSlots = computeMetricSlots(formulaEntities);
if (metricSlots.length > 0) {
const definitionsBySourceId: Record<
@@ -562,14 +360,23 @@ export function useViewerState(): UseViewerStateResult {
definitionsBySourceId[id as MetricSourceId] =
entry.definition ?? null;
}
- tabs = computeDefaultTabs(definitionsBySourceId, metricSlots);
+ dimensionBreakouts = computeDefaultDimensionBreakouts(
+ definitionsBySourceId,
+ metricSlots,
+ );
}
}
+ let selectedDimensionBreakoutId = prev.selectedDimensionBreakoutId;
+ if (selectedDimensionBreakoutId == null) {
+ selectedDimensionBreakoutId = dimensionBreakouts[0]?.id ?? null;
+ }
+
return {
...prev,
formulaEntities,
- tabs,
+ dimensionBreakouts,
+ selectedDimensionBreakoutId,
};
}),
[],
@@ -652,7 +459,7 @@ export function useViewerState(): UseViewerStateResult {
: rawDefinition;
updateDefinition(id, definition);
- if (stateRef.current.tabs.length === 0) {
+ if (stateRef.current.dimensionBreakouts.length === 0) {
const definitions: Record<
MetricSourceId,
MetricDefinition | null
@@ -662,9 +469,12 @@ export function useViewerState(): UseViewerStateResult {
const metricSlots = computeMetricSlots(
stateRef.current.formulaEntities,
);
- const tabs = computeDefaultTabs(definitions, metricSlots);
- for (const tab of tabs) {
- addTab(tab);
+ const dimensionBreakouts = computeDefaultDimensionBreakouts(
+ definitions,
+ metricSlots,
+ );
+ for (const dimensionBreakout of dimensionBreakouts) {
+ addDimensionBreakout(dimensionBreakout);
}
}
} finally {
@@ -676,7 +486,13 @@ export function useViewerState(): UseViewerStateResult {
clearLoading(id);
}
},
- [addDefinition, updateDefinition, removeDefinition, addTab, clearLoading],
+ [
+ addDefinition,
+ updateDefinition,
+ removeDefinition,
+ addDimensionBreakout,
+ clearLoading,
+ ],
);
const loadAndReplace = useCallback(
@@ -811,28 +627,172 @@ export function useViewerState(): UseViewerStateResult {
}
}, [state.definitions, state.formulaEntities, setFormulaEntities]);
- return {
+ const handleLoadSources = useCallback(
+ (request: LoadSourcesRequest) => {
+ for (const metricId of request.metricIds) {
+ loadAndAddMetric(metricId);
+ }
+ for (const measureId of request.measureIds) {
+ loadAndAddMeasure(measureId);
+ }
+ },
+ [loadAndAddMetric, loadAndAddMeasure],
+ );
+
+ useViewerUrl(
state,
- loadingIds,
- initialLoadComplete,
+ initialize,
+ handleLoadSources,
+ location,
+ setFormulaEntities,
setInitialLoadComplete,
+ );
- removeDefinition,
- updateDefinition,
- setFormulaEntities,
+ const derivedData = useViewerDerivedData({
+ definitions: state.definitions,
+ formulaEntities: state.formulaEntities,
+ dimensionBreakouts: state.dimensionBreakouts,
+ selectedDimensionBreakoutId: state.selectedDimensionBreakoutId,
+ loadingIds,
+ });
- selectTab,
- addTab,
- removeTab,
- updateTab,
- setDefinitionDimension,
- removeDefinitionDimension,
- setBreakoutDimension,
+ const addMetric = useCallback(
+ (metric: SelectedMetric) => {
+ const sourceId = createSourceId(metric.id, metric.sourceType);
- initialize,
- loadAndAddMetric,
- loadAndAddMeasure,
- loadAndReplaceMetric,
- loadAndReplaceMeasure,
- };
+ if (sourceId in state.definitions) {
+ return;
+ }
+
+ if (metric.sourceType === "metric") {
+ loadAndAddMetric(metric.id);
+ } else {
+ loadAndAddMeasure(metric.id);
+ }
+ },
+ [state.definitions, loadAndAddMetric, loadAndAddMeasure],
+ );
+
+ const swapMetric = useCallback(
+ (oldMetric: SelectedMetric, newMetric: SelectedMetric) => {
+ const oldSourceId = createSourceId(oldMetric.id, oldMetric.sourceType);
+
+ if (newMetric.sourceType === "metric") {
+ loadAndReplaceMetric(oldSourceId, newMetric.id);
+ } else {
+ loadAndReplaceMeasure(oldSourceId, newMetric.id);
+ }
+ },
+ [loadAndReplaceMetric, loadAndReplaceMeasure],
+ );
+
+ const removeMetric = useCallback(
+ (id: number, sourceType: "metric" | "measure") => {
+ removeDefinition(createSourceId(id, sourceType));
+ },
+ [removeDefinition],
+ );
+
+ const selectDimensionBreakout = useCallback(
+ (
+ dimensionBreakoutInfo: DimensionBreakoutInfo,
+ options?: { updateExisting?: boolean },
+ ) => {
+ const newDimensionBreakout = createDimensionBreakoutFromInfo(
+ dimensionBreakoutInfo,
+ );
+ if (!newDimensionBreakout) {
+ return;
+ }
+
+ if (options?.updateExisting) {
+ setState((prev) => {
+ const existingDimensionBreakout = prev.dimensionBreakouts.find(
+ (dimensionBreakout) =>
+ dimensionBreakout.id === newDimensionBreakout.id,
+ );
+ const dimensionBreakouts = existingDimensionBreakout
+ ? prev.dimensionBreakouts.map((dimensionBreakout) =>
+ dimensionBreakout.id === newDimensionBreakout.id
+ ? {
+ ...dimensionBreakout,
+ label: newDimensionBreakout.label,
+ dimensionMapping: newDimensionBreakout.dimensionMapping,
+ }
+ : dimensionBreakout,
+ )
+ : assignDimensionsForUnmappedSlots(
+ [...prev.dimensionBreakouts, newDimensionBreakout],
+ prev.definitions,
+ prev.formulaEntities,
+ );
+
+ return {
+ ...prev,
+ dimensionBreakouts,
+ selectedDimensionBreakoutId: newDimensionBreakout.id,
+ };
+ });
+ return;
+ }
+
+ addDimensionBreakout(newDimensionBreakout);
+ selectDimensionBreakoutById(newDimensionBreakout.id);
+ },
+ [addDimensionBreakout, selectDimensionBreakoutById],
+ );
+
+ const updateActiveDimensionBreakout = useCallback(
+ (updates: Partial<MetricsViewerDimensionBreakoutState>) => {
+ if (!derivedData.activeDimensionBreakout) {
+ return;
+ }
+ updateDimensionBreakout(derivedData.activeDimensionBreakout.id, updates);
+ },
+ [derivedData.activeDimensionBreakout, updateDimensionBreakout],
+ );
+
+ const setShowColumnLabels = useCallback((showColumnLabels: boolean) => {
+ setState((prev) => ({ ...prev, showColumnLabels }));
+ }, []);
+
+ return useMemo(
+ () => ({
+ definitions: state.definitions,
+ formulaEntities: state.formulaEntities,
+ showColumnLabels: state.showColumnLabels,
+ ...derivedData,
+ initialLoadComplete,
+ isSidebarOpen,
+ openSidebar,
+ closeSidebar,
+
+ addMetric,
+ swapMetric,
+ removeMetric,
+ selectDimensionBreakout,
+ updateActiveDimensionBreakout,
+ setShowColumnLabels,
+ setBreakoutDimension,
+ setFormulaEntities,
+ }),
+ [
+ state.definitions,
+ state.formulaEntities,
+ state.showColumnLabels,
+ derivedData,
+ initialLoadComplete,
+ isSidebarOpen,
+ openSidebar,
+ closeSidebar,
+ addMetric,
+ swapMetric,
+ removeMetric,
+ selectDimensionBreakout,
+ updateActiveDimensionBreakout,
+ setShowColumnLabels,
+ setBreakoutDimension,
+ setFormulaEntities,
+ ],
+ );
}
diff --git a/frontend/src/metabase/metrics-viewer/hooks/use-viewer-url.ts b/frontend/src/metabase/metrics-viewer/hooks/use-viewer-url.ts
index 48a9d9b547f..1832163110d 100644
--- a/frontend/src/metabase/metrics-viewer/hooks/use-viewer-url.ts
+++ b/frontend/src/metabase/metrics-viewer/hooks/use-viewer-url.ts
@@ -10,9 +10,9 @@ import type { MeasureId } from "metabase-types/api";
import type { MetricId } from "metabase-types/api/metric";
import {
+ type MetricsViewerDimensionBreakoutState,
type MetricsViewerFormulaEntity,
type MetricsViewerPageState,
- type MetricsViewerTabState,
isExpressionEntry,
isMetricEntry,
} from "../types/viewer-state";
@@ -20,8 +20,8 @@ import { parseSourceId } from "../utils/source-ids";
import {
type SerializedMetricsViewerPageState,
decodeState,
+ deserializeDimensionBreakout,
deserializeFormulaEntities,
- deserializeTab,
encodeState,
stateToSerializedState,
} from "../utils/url-serialization";
@@ -62,8 +62,9 @@ export function useViewerUrl(
: { type: "measure" as const, id: parseInt(measureId!, 10) };
serializedState = {
formulaEntities: [entity],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
+ showColumnLabels: false,
};
const encodedHash = encodeState(serializedState);
if (encodedHash === undefined) {
@@ -84,15 +85,22 @@ export function useViewerUrl(
}
lastHashRef.current = hash;
- if (serializedState.tabs.length > 0) {
- const tabs: MetricsViewerTabState[] =
- serializedState.tabs.map(deserializeTab);
+ if (serializedState.dimensionBreakouts.length > 0) {
+ const dimensionBreakouts: MetricsViewerDimensionBreakoutState[] =
+ serializedState.dimensionBreakouts.map(deserializeDimensionBreakout);
+ const showColumnLabels =
+ serializedState.showColumnLabels ??
+ dimensionBreakouts.some(
+ (dimensionBreakout) => dimensionBreakout.showColumnLabels === true,
+ );
initialize({
definitions: {},
formulaEntities: [],
- tabs,
- selectedTabId: serializedState.selectedTabId,
+ dimensionBreakouts,
+ selectedDimensionBreakoutId:
+ serializedState.selectedDimensionBreakoutId,
+ showColumnLabels,
});
}
diff --git a/frontend/src/metabase/metrics-viewer/pages/MetricsViewerPage/MetricsViewerPage.module.css b/frontend/src/metabase/metrics-viewer/pages/MetricsViewerPage/MetricsViewerPage.module.css
index a4bd99fb4e0..7013778f38b 100644
--- a/frontend/src/metabase/metrics-viewer/pages/MetricsViewerPage/MetricsViewerPage.module.css
+++ b/frontend/src/metabase/metrics-viewer/pages/MetricsViewerPage/MetricsViewerPage.module.css
@@ -2,10 +2,6 @@
overflow: hidden;
}
-.tabsBar {
- border-bottom: 1px solid var(--mb-color-border);
-}
-
.content {
flex: 1 1 auto;
min-height: 0;
diff --git a/frontend/src/metabase/metrics-viewer/pages/MetricsViewerPage/MetricsViewerPage.tsx b/frontend/src/metabase/metrics-viewer/pages/MetricsViewerPage/MetricsViewerPage.tsx
index 0b52db4b571..765c5d7791e 100644
--- a/frontend/src/metabase/metrics-viewer/pages/MetricsViewerPage/MetricsViewerPage.tsx
+++ b/frontend/src/metabase/metrics-viewer/pages/MetricsViewerPage/MetricsViewerPage.tsx
@@ -1,25 +1,20 @@
import type { Location } from "history";
-import { useCallback } from "react";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-import { Box, Center, Flex, Stack } from "metabase/ui";
-
-import {
- trackMetricsViewerMetricAdded,
- trackMetricsViewerMetricRemoved,
-} from "../../analytics";
-import { BreakoutLegend } from "../../components/BreakoutLegend/BreakoutLegend";
+import { BreakoutLegend } from "metabase/metrics-viewer/components/BreakoutLegend/BreakoutLegend";
+import { DimensionPickerSidebar } from "metabase/metrics-viewer/components/DimensionPickerSidebar";
import {
MetricsViewerEmptyState,
- MetricsViewerNoTabsEmptyState,
-} from "../../components/EmptyState";
-import { MetricSearchPanel } from "../../components/MetricSearchPanel";
+ MetricsViewerNoDimensionBreakoutEmptyState,
+} from "metabase/metrics-viewer/components/EmptyState";
+import { MetricSearchPanel } from "metabase/metrics-viewer/components/MetricSearchPanel";
+import { MetricsViewerDimensionBreakoutContent } from "metabase/metrics-viewer/components/MetricsViewerDimensionBreakoutContent";
import {
- MetricsViewerTabContent,
- MetricsViewerTabs,
-} from "../../components/MetricsViewerTabs";
-import { useMetricsViewer } from "../../hooks/use-metrics-viewer";
-import type { SelectedMetric } from "../../types/viewer-state";
+ MetricsViewerProvider,
+ useMetricsViewerContext,
+} from "metabase/metrics-viewer/context";
+import { useViewerState } from "metabase/metrics-viewer/hooks";
+import { Box, Center, Flex, Stack } from "metabase/ui";
import S from "./MetricsViewerPage.module.css";
@@ -28,57 +23,9 @@ export type MetricsViewerPageProps = {
};
export function MetricsViewerPage(props: MetricsViewerPageProps) {
- const useMetricsViewerResult = useMetricsViewer(props);
+ const viewerState = useViewerState(props);
- const {
- definitions,
- formulaEntities,
- tabs,
- activeTab,
- activeTabId,
- initialLoadComplete,
- queriesAreLoading,
- queriesError,
- modifiedDefinitionsBySlotIndex,
- metricSlots,
- series,
- cardIdToEntityIndex,
- activeBreakoutColors,
- sourceColors,
- selectedMetrics,
- sourceOrder,
- sourceDataById,
- availableDimensions,
- addMetric,
- swapMetric,
- removeMetric,
- changeTab,
- addAndSelectTab,
- removeTab,
- updateActiveTab,
- changeTabDimension,
- removeTabDimension,
- setBreakoutDimension,
- setFormulaEntities,
- } = useMetricsViewerResult;
-
- const handleAddMetric = useCallback(
- (metric: SelectedMetric) => {
- addMetric(metric);
- trackMetricsViewerMetricAdded(metric.id, metric.sourceType);
- },
- [addMetric],
- );
-
- const handleRemoveMetric = useCallback(
- (metricId: number, sourceType: "metric" | "measure") => {
- removeMetric(metricId, sourceType);
- trackMetricsViewerMetricRemoved(metricId, sourceType);
- },
- [removeMetric],
- );
-
- if (!initialLoadComplete) {
+ if (!viewerState.initialLoadComplete) {
// parsing formulas won't work until the initial set of definitions are loaded
return (
<Center h="100%">
@@ -87,43 +34,32 @@ export function MetricsViewerPage(props: MetricsViewerPageProps) {
);
}
+ return (
+ <MetricsViewerProvider value={viewerState}>
+ <MetricsViewerPageBody />
+ </MetricsViewerProvider>
+ );
+}
+
+function MetricsViewerPageBody() {
+ const { definitions, activeDimensionBreakout, isSidebarOpen } =
+ useMetricsViewerContext();
+
const hasDefinitions = Object.keys(definitions).length > 0;
const hasLoadedDefinitions = Object.values(definitions).some(
(entry) => entry.definition != null,
);
+ const showDimensionPickerSidebar = isSidebarOpen && activeDimensionBreakout;
+ const showBreakoutLegend =
+ !showDimensionPickerSidebar && activeDimensionBreakout?.type !== "scalar";
return (
<Stack px="3rem" h="100%" gap={0} className={S.root}>
<Box pt="md" flex="0 0 auto">
- <MetricSearchPanel
- definitions={definitions}
- formulaEntities={formulaEntities}
- onFormulaEntitiesChange={setFormulaEntities}
- selectedMetrics={selectedMetrics}
- metricColors={sourceColors}
- onAddMetric={handleAddMetric}
- onRemoveMetric={handleRemoveMetric}
- onSwapMetric={swapMetric}
- onSetBreakout={setBreakoutDimension}
- />
+ <MetricSearchPanel />
</Box>
<Flex flex="1 1 auto" mih={0}>
<Stack gap={0} flex={1} mih={0} miw={0}>
- {hasDefinitions && (
- <Box pt="sm" flex="0 0 auto" className={S.tabsBar}>
- <MetricsViewerTabs
- tabs={tabs}
- activeTabId={activeTabId}
- isLoading={!hasLoadedDefinitions}
- availableDimensions={availableDimensions}
- sourceOrder={sourceOrder}
- sourceDataById={sourceDataById}
- onTabChange={changeTab}
- onAddTab={addAndSelectTab}
- onRemoveTab={removeTab}
- />
- </Box>
- )}
<Flex flex="1 1 auto" mih={0} pt="lg">
<Flex
direction="column"
@@ -135,37 +71,16 @@ export function MetricsViewerPage(props: MetricsViewerPageProps) {
>
{!hasDefinitions ? (
<MetricsViewerEmptyState />
- ) : activeTab ? (
- <MetricsViewerTabContent
- definitions={definitions}
- formulaEntities={formulaEntities}
- tab={activeTab}
- queriesAreLoading={queriesAreLoading}
- queriesError={queriesError}
- modifiedDefinitionsBySlotIndex={
- modifiedDefinitionsBySlotIndex
- }
- metricSlots={metricSlots}
- series={series}
- cardIdToEntityIndex={cardIdToEntityIndex}
- sourceColors={sourceColors}
- onTabUpdate={updateActiveTab}
- onDimensionChange={(slotIndex, dim) =>
- changeTabDimension(activeTab.id, slotIndex, dim)
- }
- onDimensionRemove={(slotIndex) =>
- removeTabDimension(activeTab.id, slotIndex)
- }
- />
+ ) : activeDimensionBreakout ? (
+ <MetricsViewerDimensionBreakoutContent />
) : hasLoadedDefinitions ? (
- <MetricsViewerNoTabsEmptyState />
+ <MetricsViewerNoDimensionBreakoutEmptyState />
) : null}
</Flex>
- {activeTab?.type !== "scalar" && (
- <BreakoutLegend
- formulaEntities={formulaEntities}
- definitions={definitions}
- activeBreakoutColors={activeBreakoutColors}
+ {showBreakoutLegend && <BreakoutLegend />}
+ {showDimensionPickerSidebar && (
+ <DimensionPickerSidebar
+ activeDimensionBreakout={activeDimensionBreakout}
/>
)}
</Flex>
diff --git a/frontend/src/metabase/metrics-viewer/test-utils.ts b/frontend/src/metabase/metrics-viewer/test-utils.ts
new file mode 100644
index 00000000000..b406172d3f6
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/test-utils.ts
@@ -0,0 +1,40 @@
+import type { UseViewerStateResult } from "metabase/metrics-viewer/types";
+
+const EMPTY_AVAILABLE_DIMENSIONS = { shared: [], bySource: {} };
+
+export function createMockMetricsViewerResult(
+ overrides: Partial<UseViewerStateResult> = {},
+): UseViewerStateResult {
+ return {
+ definitions: {},
+ formulaEntities: [],
+ activeDimensionBreakout: null,
+ initialLoadComplete: true,
+ queriesAreLoading: false,
+ queriesError: null,
+ modifiedDefinitionsBySlotIndex: new Map(),
+ metricSlots: [],
+ series: [],
+ cardIdToEntityIndex: {},
+ activeBreakoutColors: {},
+ sourceColors: {},
+ selectedMetrics: [],
+ sourceOrder: [],
+ sourceDataById: {},
+ availableDimensions: EMPTY_AVAILABLE_DIMENSIONS,
+ sidebarAvailableDimensions: EMPTY_AVAILABLE_DIMENSIONS,
+ showColumnLabels: false,
+ isSidebarOpen: true,
+ closeSidebar: jest.fn(),
+ openSidebar: jest.fn(),
+ addMetric: jest.fn(),
+ swapMetric: jest.fn(),
+ removeMetric: jest.fn(),
+ selectDimensionBreakout: jest.fn(),
+ updateActiveDimensionBreakout: jest.fn(),
+ setShowColumnLabels: jest.fn(),
+ setBreakoutDimension: jest.fn(),
+ setFormulaEntities: jest.fn(),
+ ...overrides,
+ };
+}
diff --git a/frontend/src/metabase/metrics-viewer/types/viewer-state.ts b/frontend/src/metabase/metrics-viewer/types/viewer-state.ts
index 1d2e36d9210..f4701b75c45 100644
--- a/frontend/src/metabase/metrics-viewer/types/viewer-state.ts
+++ b/frontend/src/metabase/metrics-viewer/types/viewer-state.ts
@@ -1,14 +1,25 @@
-import type { DimensionType } from "metabase/metrics/common/utils/dimension-types";
-import type { MetricDefinition } from "metabase-lib/metric";
+import type {
+ DimensionType,
+ GeoSubtype,
+} from "metabase/metrics/common/utils/dimension-types";
+import type {
+ DimensionGroup,
+ MetricDefinition,
+ ProjectionClause,
+} from "metabase-lib/metric";
import type {
CardDisplayType,
+ CardId,
DimensionId,
+ IconName,
MathOperator,
+ SingleSeries,
TemporalUnit,
VisualizationSettings,
} from "metabase-types/api";
import type { DimensionFilterValue } from "../utils/dimension-filters";
+import type { MetricSlot } from "../utils/metric-slots";
import type { SerializedDefinitionInfo } from "../utils/url-serialization";
// ── Core types ──
@@ -21,11 +32,11 @@ export type MetricsViewerDisplayType = Extract<
export type MetricSourceId = `metric:${number}` | `measure:${number}`;
export type MetricExpressionId = `expression:${string}`;
-export type MetricsViewerTabType = DimensionType | "scalar";
+export type MetricsViewerDimensionBreakoutType = DimensionType | "scalar";
-export interface StoredMetricsViewerTab {
+export interface StoredMetricsViewerDimensionBreakout {
id: string;
- type: MetricsViewerTabType;
+ type: MetricsViewerDimensionBreakoutType;
label: string;
dimensionBySlotIndex: Record<number, DimensionId>;
}
@@ -61,7 +72,7 @@ export type ExpressionSubToken =
* The entry's definition has 0-1 projections where that projection IS the breakout.
*
* This is different from the computed/modified definition (from getModifiedDefinition)
- * which adds the tab's dimension as an additional projection.
+ * which adds the dimension breakout's dimension as an additional projection.
*/
export interface MetricsViewerDefinitionEntry {
id: MetricSourceId;
@@ -96,22 +107,44 @@ export function isExpressionEntry(
return entry.type === "expression";
}
-// ── Tab state ──
+// ── Dimension breakout state ──
-export interface MetricsViewerTabProjectionConfig {
+export interface MetricsViewerDimensionBreakoutProjectionConfig {
temporalUnit?: TemporalUnit;
binningStrategy?: string;
dimensionFilter?: DimensionFilterValue;
}
-export interface MetricsViewerTabState {
+export interface MetricsViewerDimensionBreakoutState {
id: string;
- type: MetricsViewerTabType;
+ type: MetricsViewerDimensionBreakoutType;
label: string | null;
display: MetricsViewerDisplayType;
+ showColumnLabels?: boolean;
visualizationSettings?: Partial<VisualizationSettings>;
dimensionMapping: Record<number, DimensionId | null>;
- projectionConfig: MetricsViewerTabProjectionConfig;
+ projectionConfig: MetricsViewerDimensionBreakoutProjectionConfig;
+}
+
+export interface DimensionBreakoutInfo {
+ id?: string;
+ type: MetricsViewerDimensionBreakoutType;
+ label: string;
+ dimensionMapping: Record<number, string | null>;
+}
+
+export interface AvailableDimension {
+ icon: IconName;
+ group?: DimensionGroup;
+ canListValues?: boolean;
+ isPreferred?: boolean;
+ geoSubtype?: GeoSubtype | null;
+ dimensionBreakoutInfo: DimensionBreakoutInfo;
+}
+
+export interface AvailableDimensionsResult {
+ shared: AvailableDimension[];
+ bySource: Record<MetricSourceId, AvailableDimension[]>;
}
// ── Page state ──
@@ -119,16 +152,18 @@ export interface MetricsViewerTabState {
export interface MetricsViewerPageState {
definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>; // pristine definitions for unique metrics used in formula
formulaEntities: MetricsViewerFormulaEntity[]; // specific items used in formula, definitions there contains filters
- tabs: MetricsViewerTabState[]; // visualization settings for a tab
- selectedTabId: string | null;
+ dimensionBreakouts: MetricsViewerDimensionBreakoutState[]; // visualization settings for a dimension breakout
+ selectedDimensionBreakoutId: string | null;
+ showColumnLabels: boolean;
}
export function getInitialMetricsViewerPageState(): MetricsViewerPageState {
return {
definitions: {},
formulaEntities: [],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
+ showColumnLabels: false,
};
}
@@ -160,3 +195,52 @@ export type SelectedMetric = {
sourceType: "metric" | "measure";
isLoading?: boolean;
};
+
+export interface SourceDisplayInfo {
+ type: "metric" | "measure";
+ name: string;
+}
+
+export interface UseViewerStateResult {
+ definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>;
+ formulaEntities: MetricsViewerFormulaEntity[];
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState | null;
+ initialLoadComplete: boolean;
+ queriesAreLoading: boolean;
+ queriesError: string | null;
+ modifiedDefinitionsBySlotIndex: Map<number, MetricDefinition>;
+ metricSlots: MetricSlot[];
+ series: SingleSeries[];
+ cardIdToEntityIndex: Record<CardId, number>;
+ activeBreakoutColors: SourceBreakoutColorMap;
+ sourceColors: SourceColorMap;
+ selectedMetrics: SelectedMetric[];
+ sourceOrder: MetricSourceId[];
+ sourceDataById: Record<MetricSourceId, SourceDisplayInfo>;
+ availableDimensions: AvailableDimensionsResult;
+ sidebarAvailableDimensions: AvailableDimensionsResult;
+ showColumnLabels: boolean;
+ isSidebarOpen: boolean;
+ closeSidebar: () => void;
+ openSidebar: () => void;
+
+ addMetric: (metric: SelectedMetric) => void;
+ swapMetric: (oldMetric: SelectedMetric, newMetric: SelectedMetric) => void;
+ removeMetric: (id: number, sourceType: "metric" | "measure") => void;
+ selectDimensionBreakout: (
+ dimensionBreakoutInfo: DimensionBreakoutInfo,
+ options?: { updateExisting?: boolean },
+ ) => void;
+ updateActiveDimensionBreakout: (
+ updates: Partial<MetricsViewerDimensionBreakoutState>,
+ ) => void;
+ setShowColumnLabels: (showColumnLabels: boolean) => void;
+ setBreakoutDimension: (
+ entity: MetricDefinitionEntry,
+ dimension: ProjectionClause | undefined,
+ ) => void;
+ setFormulaEntities: (
+ entities: MetricsViewerFormulaEntity[],
+ slotMapping?: Map<number, number>,
+ ) => void;
+}
diff --git a/frontend/src/metabase/metrics-viewer/utils/MetricsViewerClickActionsMode.ts b/frontend/src/metabase/metrics-viewer/utils/MetricsViewerClickActionsMode.ts
index 07b1558f772..bb07f0274ff 100644
--- a/frontend/src/metabase/metrics-viewer/utils/MetricsViewerClickActionsMode.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/MetricsViewerClickActionsMode.ts
@@ -12,8 +12,8 @@ import {
type MetricDefinitionEntry,
type MetricSourceId,
type MetricsViewerDefinitionEntry,
+ type MetricsViewerDimensionBreakoutState,
type MetricsViewerFormulaEntity,
- type MetricsViewerTabState,
isMetricEntry,
} from "../types/viewer-state";
@@ -26,8 +26,10 @@ type MetricsViewerClickActionParams = {
definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>;
formulaEntities: MetricsViewerFormulaEntity[];
metricSlots: MetricSlot[];
- tab: MetricsViewerTabState;
- onTabUpdate: (updates: Partial<MetricsViewerTabState>) => void;
+ dimensionBreakout: MetricsViewerDimensionBreakoutState;
+ onDimensionBreakoutUpdate: (
+ updates: Partial<MetricsViewerDimensionBreakoutState>,
+ ) => void;
cardIdToEntityIndex: Record<CardId, number>;
};
@@ -35,22 +37,24 @@ export class MetricsViewerClickActionsMode implements ClickActionsMode {
private definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>;
private formulaEntities: MetricsViewerFormulaEntity[];
private metricSlots: MetricSlot[];
- private tab: MetricsViewerTabState;
- private onTabUpdate: (updates: Partial<MetricsViewerTabState>) => void;
+ private dimensionBreakout: MetricsViewerDimensionBreakoutState;
+ private onDimensionBreakoutUpdate: (
+ updates: Partial<MetricsViewerDimensionBreakoutState>,
+ ) => void;
private cardIdToEntityIndex: Record<CardId, number>;
constructor({
definitions,
formulaEntities,
metricSlots,
- tab,
- onTabUpdate,
+ dimensionBreakout,
+ onDimensionBreakoutUpdate,
cardIdToEntityIndex,
}: MetricsViewerClickActionParams) {
this.definitions = definitions;
this.formulaEntities = formulaEntities;
this.metricSlots = metricSlots;
- this.tab = tab;
- this.onTabUpdate = onTabUpdate;
+ this.dimensionBreakout = dimensionBreakout;
+ this.onDimensionBreakoutUpdate = onDimensionBreakoutUpdate;
this.cardIdToEntityIndex = cardIdToEntityIndex;
}
actionsForClick(clickObject: ClickObject): ClickAction[] {
@@ -65,8 +69,8 @@ export class MetricsViewerClickActionsMode implements ClickActionsMode {
entity,
entityIndex,
metricSlots: this.metricSlots,
- tab: this.tab,
- onTabUpdate: this.onTabUpdate,
+ dimensionBreakout: this.dimensionBreakout,
+ onDimensionBreakoutUpdate: this.onDimensionBreakoutUpdate,
clickObject,
};
return [getZoomInTimeSeriesAction(params)].filter(
@@ -80,8 +84,10 @@ type GetActionParams = {
entity: MetricsViewerFormulaEntity | undefined; //entity that was clicked on
entityIndex: number | undefined;
metricSlots: MetricSlot[];
- tab: MetricsViewerTabState;
- onTabUpdate: (updates: Partial<MetricsViewerTabState>) => void;
+ dimensionBreakout: MetricsViewerDimensionBreakoutState;
+ onDimensionBreakoutUpdate: (
+ updates: Partial<MetricsViewerDimensionBreakoutState>,
+ ) => void;
clickObject: ClickObject;
};
@@ -90,8 +96,8 @@ function getZoomInTimeSeriesAction({
entity,
entityIndex,
metricSlots,
- tab,
- onTabUpdate,
+ dimensionBreakout,
+ onDimensionBreakoutUpdate,
clickObject,
}: GetActionParams): ClickAction | undefined {
if (!entity || entityIndex == null || !isMetricEntry(entity)) {
@@ -110,7 +116,7 @@ function getZoomInTimeSeriesAction({
entity,
entityIndex,
metricSlots,
- tab,
+ dimensionBreakout,
currentTemporalUnit,
);
if (!nextTemporalUnit) {
@@ -136,9 +142,9 @@ function getZoomInTimeSeriesAction({
icon: "zoom_in",
buttonType: "horizontal",
onClick: ({ closePopover }) => {
- onTabUpdate({
+ onDimensionBreakoutUpdate({
projectionConfig: {
- ...tab.projectionConfig,
+ ...dimensionBreakout.projectionConfig,
temporalUnit: nextTemporalUnit,
dimensionFilter,
},
@@ -189,7 +195,7 @@ function getNextTemporalUnit(
entity: MetricDefinitionEntry,
entityIndex: number,
metricSlots: MetricSlot[],
- tab: MetricsViewerTabState,
+ dimensionBreakout: MetricsViewerDimensionBreakoutState,
currentUnit: TemporalUnit,
): TemporalUnit | undefined {
const definition = getEffectiveDefinitionEntry(
@@ -200,7 +206,7 @@ function getNextTemporalUnit(
if (!slot) {
return undefined;
}
- const dimensionId = tab.dimensionMapping[slot.slotIndex];
+ const dimensionId = dimensionBreakout.dimensionMapping[slot.slotIndex];
if (!definition || !dimensionId) {
return undefined;
}
diff --git a/frontend/src/metabase/metrics-viewer/utils/compact-schema.unit.spec.ts b/frontend/src/metabase/metrics-viewer/utils/compact-schema.unit.spec.ts
index 4f3f1cd1389..e1931a93bc4 100644
--- a/frontend/src/metabase/metrics-viewer/utils/compact-schema.unit.spec.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/compact-schema.unit.spec.ts
@@ -155,7 +155,7 @@ describe("defineCompactSchema", () => {
it("round-trips a complex object with all fields", () => {
const original = {
- id: "tab-1",
+ id: "dimensionBreakout-1",
type: "time",
label: "By Month",
display: "bar",
@@ -174,7 +174,7 @@ describe("defineCompactSchema", () => {
it("round-trips a minimal object with only required and default fields", () => {
const original = {
- id: "tab-1",
+ id: "dimensionBreakout-1",
type: "time",
label: "",
display: "line",
diff --git a/frontend/src/metabase/metrics-viewer/utils/definition-builder.unit.spec.ts b/frontend/src/metabase/metrics-viewer/utils/definition-builder.unit.spec.ts
index b306f5012b8..2aab3f62249 100644
--- a/frontend/src/metabase/metrics-viewer/utils/definition-builder.unit.spec.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/definition-builder.unit.spec.ts
@@ -234,7 +234,7 @@ describe("buildExecutableDefinition", () => {
});
});
- it("preserves global filters when tab-level filter targets the same dimension", () => {
+ it("preserves global filters when dimensionBreakout-level filter targets the same dimension", () => {
const definition = setupDefinition(metadata, REVENUE_METRIC.id);
const dimensions = LibMetric.projectionableDimensions(definition);
const categoryDimension = dimensions.find(
diff --git a/frontend/src/metabase/metrics-viewer/utils/definition-cache.ts b/frontend/src/metabase/metrics-viewer/utils/definition-cache.ts
index 93e54c86d92..b12a6a70511 100644
--- a/frontend/src/metabase/metrics-viewer/utils/definition-cache.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/definition-cache.ts
@@ -3,7 +3,7 @@ import { createSelector, weakMapMemoize } from "@reduxjs/toolkit";
import * as LibMetric from "metabase-lib/metric";
import type { JsMetricDefinition } from "metabase-types/api";
-import type { MetricsViewerTabProjectionConfig } from "../types/viewer-state";
+import type { MetricsViewerDimensionBreakoutProjectionConfig } from "../types/viewer-state";
import {
applyBreakoutDimension,
@@ -15,17 +15,17 @@ export const getModifiedDefinition = createSelector(
(
definition: LibMetric.MetricDefinition,
_projectionDimensionId: string | undefined,
- _projection: MetricsViewerTabProjectionConfig,
+ _projection: MetricsViewerDimensionBreakoutProjectionConfig,
) => definition,
(
_definition: LibMetric.MetricDefinition,
projectionDimensionId: string | undefined,
- _projection: MetricsViewerTabProjectionConfig,
+ _projection: MetricsViewerDimensionBreakoutProjectionConfig,
) => projectionDimensionId,
(
_definition: LibMetric.MetricDefinition,
_projectionDimensionId: string | undefined,
- projection: MetricsViewerTabProjectionConfig,
+ projection: MetricsViewerDimensionBreakoutProjectionConfig,
) => projection,
(
definition,
diff --git a/frontend/src/metabase/metrics-viewer/utils/tab-config.ts b/frontend/src/metabase/metrics-viewer/utils/dimension-breakout-config.ts
similarity index 73%
rename from frontend/src/metabase/metrics-viewer/utils/tab-config.ts
rename to frontend/src/metabase/metrics-viewer/utils/dimension-breakout-config.ts
index 4e9a492f5c2..6cf5a022a54 100644
--- a/frontend/src/metabase/metrics-viewer/utils/tab-config.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/dimension-breakout-config.ts
@@ -17,9 +17,9 @@ import {
type BreakoutColorMap,
type MetricSourceId,
type MetricsViewerDefinitionEntry,
+ type MetricsViewerDimensionBreakoutType,
type MetricsViewerDisplayType,
type MetricsViewerFormulaEntity,
- type MetricsViewerTabType,
isExpressionEntry,
isMetricEntry,
} from "../types/viewer-state";
@@ -57,8 +57,8 @@ type DisplayTypeDefinition = {
) => VisualizationSettings;
};
-interface BaseTabTypeDefinition {
- type: MetricsViewerTabType;
+interface BaseDimensionBreakoutTypeDefinition {
+ type: MetricsViewerDimensionBreakoutType;
dimensionPredicate: (dimension: DimensionMetadata) => boolean;
autoCreate: boolean;
dimensionSubtype?: (dimension: DimensionMetadata) => string | null;
@@ -68,16 +68,18 @@ interface BaseTabTypeDefinition {
index?: number;
}
-interface AggregateTabType extends BaseTabTypeDefinition {
+interface AggregateDimensionBreakoutType extends BaseDimensionBreakoutTypeDefinition {
matchMode: "aggregate";
fixedId: string;
}
-interface ExactColumnTabType extends BaseTabTypeDefinition {
+interface ExactColumnDimensionBreakoutType extends BaseDimensionBreakoutTypeDefinition {
matchMode: "exact-column";
}
-export type TabTypeDefinition = AggregateTabType | ExactColumnTabType;
+export type DimensionBreakoutTypeDefinition =
+ | AggregateDimensionBreakoutType
+ | ExactColumnDimensionBreakoutType;
// ── Chart type presets ──
@@ -97,74 +99,79 @@ const NUMERIC_CHART_TYPES: ChartTypeOption[] = [
{ type: "scatter", icon: "bubble" },
];
-// ── Tab type registry ──
+// ── DimensionBreakout type registry ──
-export const TAB_TYPE_REGISTRY: TabTypeDefinition[] = [
- {
- type: "time",
- dimensionPredicate: DIMENSION_PREDICATES.time,
- autoCreate: true,
- matchMode: "aggregate",
- fixedId: "time",
- defaultDisplayType: "line",
- availableDisplayTypes: STANDARD_CHART_TYPES,
- minDimensions: 1,
- },
- {
- type: "geo",
- dimensionPredicate: DIMENSION_PREDICATES.geo,
- autoCreate: true,
- matchMode: "aggregate",
- fixedId: "geo",
- dimensionSubtype: getGeoSubtype,
- defaultDisplayType: "map",
- availableDisplayTypes: GEO_CHART_TYPES,
- minDimensions: 1,
- },
- {
- type: "scalar",
- autoCreate: true,
- matchMode: "aggregate",
- fixedId: "scalar",
- dimensionPredicate: () => false,
- defaultDisplayType: "scalar",
- availableDisplayTypes: [{ type: "scalar", icon: "number" }],
- index: 5,
- minDimensions: 0,
- },
- {
- type: "category",
- dimensionPredicate: DIMENSION_PREDICATES.category,
- autoCreate: true,
- matchMode: "exact-column",
- defaultDisplayType: "bar",
- availableDisplayTypes: STANDARD_CHART_TYPES,
- minDimensions: 1,
- },
- {
- type: "boolean",
- dimensionPredicate: DIMENSION_PREDICATES.boolean,
- autoCreate: true,
- matchMode: "exact-column",
- defaultDisplayType: "bar",
- availableDisplayTypes: STANDARD_CHART_TYPES,
- minDimensions: 1,
- },
- {
- type: "numeric",
- dimensionPredicate: DIMENSION_PREDICATES.numeric,
- autoCreate: false,
- matchMode: "exact-column",
- defaultDisplayType: "bar",
- availableDisplayTypes: NUMERIC_CHART_TYPES,
- minDimensions: 1,
- },
-];
+export const DIMENSION_BREAKOUT_TYPE_REGISTRY: DimensionBreakoutTypeDefinition[] =
+ [
+ {
+ type: "time",
+ dimensionPredicate: DIMENSION_PREDICATES.time,
+ autoCreate: true,
+ matchMode: "aggregate",
+ fixedId: "time",
+ defaultDisplayType: "line",
+ availableDisplayTypes: STANDARD_CHART_TYPES,
+ minDimensions: 1,
+ },
+ {
+ type: "geo",
+ dimensionPredicate: DIMENSION_PREDICATES.geo,
+ autoCreate: true,
+ matchMode: "aggregate",
+ fixedId: "geo",
+ dimensionSubtype: getGeoSubtype,
+ defaultDisplayType: "map",
+ availableDisplayTypes: GEO_CHART_TYPES,
+ minDimensions: 1,
+ },
+ {
+ type: "scalar",
+ autoCreate: true,
+ matchMode: "aggregate",
+ fixedId: "scalar",
+ dimensionPredicate: () => false,
+ defaultDisplayType: "scalar",
+ availableDisplayTypes: [{ type: "scalar", icon: "number" }],
+ index: 5,
+ minDimensions: 0,
+ },
+ {
+ type: "category",
+ dimensionPredicate: DIMENSION_PREDICATES.category,
+ autoCreate: true,
+ matchMode: "exact-column",
+ defaultDisplayType: "bar",
+ availableDisplayTypes: STANDARD_CHART_TYPES,
+ minDimensions: 1,
+ },
+ {
+ type: "boolean",
+ dimensionPredicate: DIMENSION_PREDICATES.boolean,
+ autoCreate: true,
+ matchMode: "exact-column",
+ defaultDisplayType: "bar",
+ availableDisplayTypes: STANDARD_CHART_TYPES,
+ minDimensions: 1,
+ },
+ {
+ type: "numeric",
+ dimensionPredicate: DIMENSION_PREDICATES.numeric,
+ autoCreate: false,
+ matchMode: "exact-column",
+ defaultDisplayType: "bar",
+ availableDisplayTypes: NUMERIC_CHART_TYPES,
+ minDimensions: 1,
+ },
+ ];
-export function getTabConfig(type: MetricsViewerTabType): TabTypeDefinition {
- const config = TAB_TYPE_REGISTRY.find((config) => config.type === type);
+export function getDimensionBreakoutConfig(
+ type: MetricsViewerDimensionBreakoutType,
+): DimensionBreakoutTypeDefinition {
+ const config = DIMENSION_BREAKOUT_TYPE_REGISTRY.find(
+ (config) => config.type === type,
+ );
if (!config) {
- throw new Error(`No tab config found for type: ${type}`);
+ throw new Error(`No dimension breakout config found for type: ${type}`);
}
return config;
}
diff --git a/frontend/src/metabase/metrics-viewer/utils/tab-config.unit.spec.ts b/frontend/src/metabase/metrics-viewer/utils/dimension-breakout-config.unit.spec.ts
similarity index 91%
rename from frontend/src/metabase/metrics-viewer/utils/tab-config.unit.spec.ts
rename to frontend/src/metabase/metrics-viewer/utils/dimension-breakout-config.unit.spec.ts
index 1532e4a078e..9060590bd2d 100644
--- a/frontend/src/metabase/metrics-viewer/utils/tab-config.unit.spec.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/dimension-breakout-config.unit.spec.ts
@@ -15,7 +15,10 @@ import {
createMetricMetadata,
setupDefinition,
} from "./__tests__/test-helpers";
-import { DISPLAY_TYPE_REGISTRY, getTabConfig } from "./tab-config";
+import {
+ DISPLAY_TYPE_REGISTRY,
+ getDimensionBreakoutConfig,
+} from "./dimension-breakout-config";
const allMetadata = createMetricMetadata([REVENUE_METRIC, GEO_METRIC]);
const revenueDefinition = setupDefinition(allMetadata, REVENUE_METRIC.id);
@@ -99,11 +102,11 @@ function makeColorMap(values: string[]): BreakoutColorMap {
return new Map(values.map((v, i) => [v, palette[i % palette.length]]));
}
-// ── getTabConfig ──
+// ── getDimensionBreakoutConfig ──
-describe("getTabConfig", () => {
- it("returns config for time tab", () => {
- expect(getTabConfig("time")).toEqual(
+describe("getDimensionBreakoutConfig", () => {
+ it("returns config for time dimensionBreakout", () => {
+ expect(getDimensionBreakoutConfig("time")).toEqual(
expect.objectContaining({
type: "time",
autoCreate: true,
@@ -119,8 +122,8 @@ describe("getTabConfig", () => {
);
});
- it("returns config for geo tab", () => {
- expect(getTabConfig("geo")).toEqual(
+ it("returns config for geo dimensionBreakout", () => {
+ expect(getDimensionBreakoutConfig("geo")).toEqual(
expect.objectContaining({
type: "geo",
autoCreate: true,
@@ -137,8 +140,8 @@ describe("getTabConfig", () => {
);
});
- it("returns config for category tab", () => {
- expect(getTabConfig("category")).toEqual(
+ it("returns config for category dimensionBreakout", () => {
+ expect(getDimensionBreakoutConfig("category")).toEqual(
expect.objectContaining({
type: "category",
autoCreate: true,
@@ -153,8 +156,8 @@ describe("getTabConfig", () => {
);
});
- it("returns config for boolean tab", () => {
- expect(getTabConfig("boolean")).toEqual(
+ it("returns config for boolean dimensionBreakout", () => {
+ expect(getDimensionBreakoutConfig("boolean")).toEqual(
expect.objectContaining({
type: "boolean",
autoCreate: true,
@@ -169,8 +172,8 @@ describe("getTabConfig", () => {
);
});
- it("returns config for numeric tab", () => {
- expect(getTabConfig("numeric")).toEqual(
+ it("returns config for numeric dimensionBreakout", () => {
+ expect(getDimensionBreakoutConfig("numeric")).toEqual(
expect.objectContaining({
type: "numeric",
autoCreate: false,
@@ -186,22 +189,22 @@ describe("getTabConfig", () => {
);
});
- it("throws for unknown tab type", () => {
- expect(() => getTabConfig("unknown" as any)).toThrow(
- "No tab config found for type: unknown",
+ it("throws for unknown dimensionBreakout type", () => {
+ expect(() => getDimensionBreakoutConfig("unknown" as any)).toThrow(
+ "No dimension breakout config found for type: unknown",
);
});
});
// ── Dimension predicates ──
-describe("TAB_TYPE_REGISTRY", () => {
+describe("DIMENSION_BREAKOUT_TYPE_REGISTRY", () => {
describe("dimension predicates", () => {
- const timeConfig = getTabConfig("time");
- const geoConfig = getTabConfig("geo");
- const categoryConfig = getTabConfig("category");
- const booleanConfig = getTabConfig("boolean");
- const numericConfig = getTabConfig("numeric");
+ const timeConfig = getDimensionBreakoutConfig("time");
+ const geoConfig = getDimensionBreakoutConfig("geo");
+ const categoryConfig = getDimensionBreakoutConfig("category");
+ const booleanConfig = getDimensionBreakoutConfig("boolean");
+ const numericConfig = getDimensionBreakoutConfig("numeric");
it("time predicate matches datetime dimensions", () => {
expect(
diff --git a/frontend/src/metabase/metrics-viewer/utils/tabs.ts b/frontend/src/metabase/metrics-viewer/utils/dimension-breakouts.ts
similarity index 64%
rename from frontend/src/metabase/metrics-viewer/utils/tabs.ts
rename to frontend/src/metabase/metrics-viewer/utils/dimension-breakouts.ts
index 1e4297ff5e9..a001092a8c0 100644
--- a/frontend/src/metabase/metrics-viewer/utils/tabs.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/dimension-breakouts.ts
@@ -3,26 +3,29 @@ import { t } from "ttag";
import type { DimensionDescriptor } from "metabase/metrics/common/utils/dimension-descriptors";
import { getDimensionDescriptors } from "metabase/metrics/common/utils/dimension-descriptors";
import { GEO_SUBTYPE_PRIORITY } from "metabase/metrics/common/utils/dimension-types";
-import { getObjectEntries } from "metabase/utils/objects";
+import { getObjectEntries, objectFromEntries } from "metabase/utils/objects";
+import { isNotNull } from "metabase/utils/types";
import type { DimensionMetadata, MetricDefinition } from "metabase-lib/metric";
import * as LibMetric from "metabase-lib/metric";
import type { IconName } from "metabase-types/api";
-import { MAX_AUTO_TABS } from "../constants";
+import { MAX_AUTO_DIMENSION_BREAKOUTS } from "../constants";
import type {
+ DimensionBreakoutInfo,
MetricSourceId,
MetricsViewerDefinitionEntry,
- MetricsViewerTabState,
- MetricsViewerTabType,
- StoredMetricsViewerTab,
-} from "../types/viewer-state";
+ MetricsViewerDimensionBreakoutState,
+ MetricsViewerDimensionBreakoutType,
+ MetricsViewerFormulaEntity,
+ StoredMetricsViewerDimensionBreakout,
+} from "../types";
-import type { MetricSlot } from "./metric-slots";
import {
- TAB_TYPE_REGISTRY,
- type TabTypeDefinition,
- getTabConfig,
-} from "./tab-config";
+ DIMENSION_BREAKOUT_TYPE_REGISTRY,
+ type DimensionBreakoutTypeDefinition,
+ getDimensionBreakoutConfig,
+} from "./dimension-breakout-config";
+import { type MetricSlot, computeMetricSlots } from "./metric-slots";
// ── Dimension classification ──
@@ -39,23 +42,24 @@ export function getDimensionIcon(dimension: DimensionMetadata): IconName {
if (LibMetric.isDateOrDateTime(dimension) || LibMetric.isTime(dimension)) {
return "calendar";
}
- if (
- LibMetric.isCategory(dimension) ||
- LibMetric.isStringOrStringLike(dimension)
- ) {
- return "string";
- }
- if (LibMetric.isNumeric(dimension) || LibMetric.isCoordinate(dimension)) {
- return "int";
- }
if (
LibMetric.isState(dimension) ||
LibMetric.isCountry(dimension) ||
LibMetric.isCity(dimension) ||
- LibMetric.isLocation(dimension)
+ LibMetric.isLocation(dimension) ||
+ LibMetric.isCoordinate(dimension)
) {
return "location";
}
+ if (
+ LibMetric.isCategory(dimension) ||
+ LibMetric.isStringOrStringLike(dimension)
+ ) {
+ return "label";
+ }
+ if (LibMetric.isNumeric(dimension)) {
+ return "int";
+ }
return "unknown";
}
@@ -90,7 +94,9 @@ export function getDimensionsByType(
return result;
}
-export function resolveCommonTabLabel(names: string[]): string | null {
+export function resolveCommonDimensionBreakoutLabel(
+ names: string[],
+): string | null {
if (names.length === 0) {
return null;
}
@@ -115,47 +121,137 @@ export function resolveCommonTabLabel(names: string[]): string | null {
return bestName;
}
-/**
- * Recompute tab labels from the current dimension mappings.
- * Returns a new array only if at least one label changed.
- */
-export function recomputeTabLabels(
- tabs: MetricsViewerTabState[],
+export function getValidSelectedDimensionBreakoutId(
+ currentSelectedDimensionBreakoutId: string | null,
+ newDimensionBreakouts: MetricsViewerDimensionBreakoutState[],
+): string | null {
+ const selectedDimensionBreakoutExists = newDimensionBreakouts.some(
+ (dimensionBreakout) =>
+ dimensionBreakout.id === currentSelectedDimensionBreakoutId,
+ );
+
+ if (selectedDimensionBreakoutExists) {
+ return currentSelectedDimensionBreakoutId;
+ }
+
+ return newDimensionBreakouts[0]?.id ?? null;
+}
+
+export function assignDimensionsForUnmappedSlots(
+ dimensionBreakouts: MetricsViewerDimensionBreakoutState[],
definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>,
- metricSlots: MetricSlot[],
-): MetricsViewerTabState[] {
- const dimsBySlotIndex = new Map<
- number,
- Map<string, ViewerDimensionDescriptor>
- >();
- for (const slot of metricSlots) {
- const entry = definitions[slot.sourceId];
- if (entry?.definition) {
- dimsBySlotIndex.set(
- slot.slotIndex,
- getDimensionsByType(entry.definition),
+ formulaEntities: MetricsViewerFormulaEntity[],
+): MetricsViewerDimensionBreakoutState[] {
+ const slots = computeMetricSlots(formulaEntities);
+ if (slots.length === 0) {
+ return dimensionBreakouts;
+ }
+
+ const slotIndexToSourceId = new Map<number, MetricSourceId>();
+ for (const slot of slots) {
+ slotIndexToSourceId.set(slot.slotIndex, slot.sourceId);
+ }
+
+ return dimensionBreakouts.map((dimensionBreakout) => {
+ if (dimensionBreakout.label == null) {
+ return dimensionBreakout;
+ }
+
+ const unmappedBySource = new Map<
+ MetricSourceId,
+ { slotIndices: number[]; definition: MetricDefinition }
+ >();
+
+ for (const slot of slots) {
+ const existing = dimensionBreakout.dimensionMapping[slot.slotIndex];
+ if (existing !== undefined) {
+ continue;
+ }
+ const defEntry = definitions[slot.sourceId];
+ if (!defEntry?.definition) {
+ continue;
+ }
+ let group = unmappedBySource.get(slot.sourceId);
+ if (!group) {
+ group = { slotIndices: [], definition: defEntry.definition };
+ unmappedBySource.set(slot.sourceId, group);
+ }
+ group.slotIndices.push(slot.slotIndex);
+ }
+
+ if (unmappedBySource.size === 0) {
+ return dimensionBreakout;
+ }
+
+ const activeMappings: Record<number, string> = {};
+ for (const [key, value] of getObjectEntries(
+ dimensionBreakout.dimensionMapping,
+ )) {
+ if (value != null) {
+ activeMappings[Number(key)] = value;
+ }
+ }
+ const storedDimensionBreakout: StoredMetricsViewerDimensionBreakout = {
+ id: dimensionBreakout.id,
+ type: dimensionBreakout.type,
+ label: dimensionBreakout.label,
+ dimensionBySlotIndex: activeMappings,
+ };
+
+ let newMappings: Record<number, string> | null = null;
+
+ for (const [sourceId, { slotIndices, definition }] of unmappedBySource) {
+ const existingDefinitions = objectFromEntries(
+ Object.values(definitions)
+ .filter((entry) => entry.id !== sourceId && entry.definition != null)
+ .map((entry) => [entry.id, entry.definition] as const),
);
+
+ const matchingDimension = findMatchingDimensionForBreakout(
+ definition,
+ storedDimensionBreakout,
+ existingDefinitions,
+ slotIndexToSourceId,
+ );
+
+ if (matchingDimension) {
+ if (!newMappings) {
+ newMappings = {};
+ }
+ for (const idx of slotIndices) {
+ newMappings[idx] = matchingDimension;
+ }
+ }
}
- }
- let changed = false;
- const result = tabs.map((tab) => {
- const names = resolveTabDimensionNames(
- tab.dimensionMapping,
- dimsBySlotIndex,
- );
- const label = resolveCommonTabLabel(names);
- if (label != null && label !== tab.label) {
- changed = true;
- return { ...tab, label };
+ if (!newMappings) {
+ return dimensionBreakout;
}
- return tab;
+
+ return {
+ ...dimensionBreakout,
+ dimensionMapping: {
+ ...dimensionBreakout.dimensionMapping,
+ ...newMappings,
+ },
+ };
});
+}
- return changed ? result : tabs;
+export function areDimensionBreakoutDimensionsValid(
+ dimensionBreakout: MetricsViewerDimensionBreakoutState,
+): boolean {
+ const dimensionBreakoutConfig = getDimensionBreakoutConfig(
+ dimensionBreakout.type,
+ );
+
+ return (
+ Object.values(dimensionBreakout.dimensionMapping).filter(isNotNull)
+ .length >= dimensionBreakoutConfig.minDimensions
+ );
}
-// ── Default tab computation ──
+// ── Default dimensionBreakout computation ──
function getDimensionDescriptorsBySlotIndex(
definitionsBySourceId: Record<MetricSourceId, MetricDefinition | null>,
@@ -173,7 +269,7 @@ function getDimensionDescriptorsBySlotIndex(
return result;
}
-function resolveTabDimensionNames(
+function resolveDimensionBreakoutDimensionNames(
dimensionMapping: Record<number, string | null>,
dimensionsBySlotIndex: Map<number, Map<string, DimensionDescriptor>>,
): string[] {
@@ -197,7 +293,7 @@ function resolveTabDimensionNames(
function findDimensionOfType(
dimensions: Map<string, DimensionDescriptor>,
- type: MetricsViewerTabType,
+ type: MetricsViewerDimensionBreakoutType,
requireDefault = false,
): DimensionDescriptor | null {
for (const [, info] of dimensions) {
@@ -210,7 +306,7 @@ function findDimensionOfType(
function findDimensionBySubtype(
dimensions: Map<string, DimensionDescriptor>,
- type: MetricsViewerTabType,
+ type: MetricsViewerDimensionBreakoutType,
getSubtype: (dimension: DimensionMetadata) => string | null,
targetSubtype: string,
): DimensionDescriptor | null {
@@ -236,7 +332,7 @@ function pickBestGeoSubtype(found: Set<string>): string | null {
function collectSubtypes(
dimensions: Map<string, DimensionDescriptor>,
- type: MetricsViewerTabType,
+ type: MetricsViewerDimensionBreakoutType,
getSubtype: (dimension: DimensionMetadata) => string | null,
into: Set<string>,
): void {
@@ -252,7 +348,7 @@ function collectSubtypes(
function computeBestSubtypeAcrossSources(
dimensionsByEntityIndex: Map<number, Map<string, DimensionDescriptor>>,
- type: MetricsViewerTabType,
+ type: MetricsViewerDimensionBreakoutType,
getSubtype: (dimension: DimensionMetadata) => string | null,
): string | null {
const found = new Set<string>();
@@ -265,7 +361,7 @@ function computeBestSubtypeAcrossSources(
function findReferenceAcrossSources(
dimensionsByEntityIndex: Map<number, Map<string, DimensionDescriptor>>,
entityOrder: number[],
- type: MetricsViewerTabType,
+ type: MetricsViewerDimensionBreakoutType,
): { entityIndex: number; dimension: DimensionDescriptor } | null {
for (const entityIndex of entityOrder) {
const dimensions = dimensionsByEntityIndex.get(entityIndex);
@@ -289,7 +385,7 @@ function findReferenceAcrossSources(
*/
function findSourceMatch(
dimensions: Map<string, DimensionDescriptor>,
- type: MetricsViewerTabType,
+ type: MetricsViewerDimensionBreakoutType,
reference: DimensionDescriptor,
getSubtype?: (dimension: DimensionMetadata) => string | null,
): DimensionDescriptor | null {
@@ -345,7 +441,7 @@ function findSourceMatch(
function resolveAggregateDimensionMapping(
dimensionsByEntityIndex: Map<number, Map<string, DimensionDescriptor>>,
entityOrder: number[],
- config: TabTypeDefinition,
+ config: DimensionBreakoutTypeDefinition,
): Record<number, string> {
const mapping: Record<number, string> = {};
@@ -416,7 +512,7 @@ function resolveAggregateDimensionMapping(
function collectUniqueExactDimensions(
dimensionsBySlotIndex: Map<number, Map<string, DimensionDescriptor>>,
slotOrder: number[],
- type: MetricsViewerTabType,
+ type: MetricsViewerDimensionBreakoutType,
): Map<
string,
{
@@ -467,10 +563,10 @@ function collectUniqueExactDimensions(
return unique;
}
-export function computeDefaultTabs(
+export function computeDefaultDimensionBreakouts(
definitionsBySourceId: Record<MetricSourceId, MetricDefinition | null>,
metricSlots: MetricSlot[],
-): MetricsViewerTabState[] {
+): MetricsViewerDimensionBreakoutState[] {
if (metricSlots.length === 0) {
return [];
}
@@ -485,10 +581,15 @@ export function computeDefaultTabs(
return [];
}
- const tabs: (MetricsViewerTabState & { index?: number })[] = [];
+ const dimensionBreakouts: (MetricsViewerDimensionBreakoutState & {
+ index?: number;
+ })[] = [];
- for (const config of TAB_TYPE_REGISTRY) {
- if (!config.autoCreate || tabs.length >= MAX_AUTO_TABS) {
+ for (const config of DIMENSION_BREAKOUT_TYPE_REGISTRY) {
+ if (
+ !config.autoCreate ||
+ dimensionBreakouts.length >= MAX_AUTO_DIMENSION_BREAKOUTS
+ ) {
continue;
}
@@ -502,14 +603,17 @@ export function computeDefaultTabs(
continue;
}
- const names = resolveTabDimensionNames(mapping, dimensionsBySlotIndex);
- tabs.push({
+ const names = resolveDimensionBreakoutDimensionNames(
+ mapping,
+ dimensionsBySlotIndex,
+ );
+ dimensionBreakouts.push({
id: config.fixedId,
type: config.type,
label:
config.type === "scalar"
- ? getScalarTabLabel()
- : resolveCommonTabLabel(names),
+ ? getScalarDimensionBreakoutLabel()
+ : resolveCommonDimensionBreakoutLabel(names),
display: config.defaultDisplayType,
dimensionMapping: mapping,
projectionConfig: {},
@@ -539,7 +643,7 @@ export function computeDefaultTabs(
dimensionId,
{ displayName, slotIndices },
] of sortedDimensions) {
- if (tabs.length >= MAX_AUTO_TABS) {
+ if (dimensionBreakouts.length >= MAX_AUTO_DIMENSION_BREAKOUTS) {
break;
}
@@ -548,7 +652,7 @@ export function computeDefaultTabs(
mapping[slotIndex] = dimensionId;
}
- tabs.push({
+ dimensionBreakouts.push({
id: dimensionId,
type: config.type,
label: displayName,
@@ -560,31 +664,34 @@ export function computeDefaultTabs(
}
}
- tabs.sort((a, b) => (a.index ?? 0) - (b.index ?? 0));
+ dimensionBreakouts.sort((a, b) => (a.index ?? 0) - (b.index ?? 0));
- return tabs.map(({ index, ...tab }) => tab);
+ return dimensionBreakouts.map(
+ ({ index, ...dimensionBreakout }) => dimensionBreakout,
+ );
}
-// ── Manual tab creation ──
+// ── Manual dimensionBreakout creation ──
-export interface TabInfo {
- type: MetricsViewerTabType;
- label: string;
- dimensionMapping: Record<number, string>;
-}
-
-export function createTabFromTabInfo(
- tabInfo: TabInfo,
-): MetricsViewerTabState | null {
- const { type, label, dimensionMapping } = tabInfo;
+export function createDimensionBreakoutFromInfo(
+ dimensionBreakoutInfo: DimensionBreakoutInfo,
+): MetricsViewerDimensionBreakoutState | null {
+ const {
+ id: preferredId,
+ type,
+ label,
+ dimensionMapping,
+ } = dimensionBreakoutInfo;
if (type === "scalar") {
- return createScalarTab();
+ return createScalarDimensionBreakout();
}
- const id = Object.values(dimensionMapping)[0];
+ const id =
+ preferredId ??
+ Object.values(dimensionMapping).find((dimensionId) => dimensionId != null);
if (id == null) {
return null;
}
- const display = getTabConfig(type).defaultDisplayType;
+ const display = getDimensionBreakoutConfig(type).defaultDisplayType;
return {
id,
type,
@@ -595,29 +702,29 @@ export function createTabFromTabInfo(
};
}
-function createScalarTab(): MetricsViewerTabState | null {
- const config = getTabConfig("scalar");
+function createScalarDimensionBreakout(): MetricsViewerDimensionBreakoutState | null {
+ const config = getDimensionBreakoutConfig("scalar");
if (config.matchMode !== "aggregate") {
return null;
}
return {
id: config.fixedId,
type: config.type,
- label: getScalarTabLabel(),
+ label: getScalarDimensionBreakoutLabel(),
display: config.defaultDisplayType,
dimensionMapping: {},
projectionConfig: {},
};
}
-export function getScalarTabLabel() {
+export function getScalarDimensionBreakoutLabel() {
return t`Totals`;
}
-// ── Tab dimension matching ──
+// ── DimensionBreakout dimension matching ──
-function findSubtypeFromExistingTab(
- tab: StoredMetricsViewerTab,
+function findSubtypeFromExistingDimensionBreakout(
+ dimensionBreakout: StoredMetricsViewerDimensionBreakout,
getSubtype: (dimension: DimensionMetadata) => string | null,
baseDefinitions?: Record<MetricSourceId, MetricDefinition | null>,
slotIndexToSourceId?: Map<number, MetricSourceId>,
@@ -627,7 +734,7 @@ function findSubtypeFromExistingTab(
}
for (const [key, dimensionName] of getObjectEntries(
- tab.dimensionBySlotIndex,
+ dimensionBreakout.dimensionBySlotIndex,
)) {
const slotIndex = Number(key);
const sourceId = slotIndexToSourceId.get(slotIndex);
@@ -649,17 +756,17 @@ function findSubtypeFromExistingTab(
function findBestSubtypeInDimensions(
dimensions: Map<string, DimensionDescriptor>,
- tabType: MetricsViewerTabType,
+ dimensionBreakoutType: MetricsViewerDimensionBreakoutType,
getSubtype: (dimension: DimensionMetadata) => string | null,
): string | null {
const found = new Set<string>();
- collectSubtypes(dimensions, tabType, getSubtype, found);
+ collectSubtypes(dimensions, dimensionBreakoutType, getSubtype, found);
return pickBestGeoSubtype(found);
}
-function findReferenceFromTab(
- tab: StoredMetricsViewerTab,
- type: MetricsViewerTabType,
+function findReferenceFromDimensionBreakout(
+ dimensionBreakout: StoredMetricsViewerDimensionBreakout,
+ type: MetricsViewerDimensionBreakoutType,
baseDefinitions?: Record<MetricSourceId, MetricDefinition | null>,
slotIndexToSourceId?: Map<number, MetricSourceId>,
): DimensionDescriptor | null {
@@ -668,7 +775,7 @@ function findReferenceFromTab(
}
for (const [key, dimensionName] of getObjectEntries(
- tab.dimensionBySlotIndex,
+ dimensionBreakout.dimensionBySlotIndex,
)) {
const entityIndex = Number(key);
const sourceId = slotIndexToSourceId.get(entityIndex);
@@ -690,49 +797,86 @@ function findReferenceFromTab(
function resolveSubtypeFallback(
dimensionsByType: Map<string, DimensionDescriptor>,
- tabType: MetricsViewerTabType,
+ dimensionBreakoutType: MetricsViewerDimensionBreakoutType,
getSubtype: (dimension: DimensionMetadata) => string | null,
- tab: StoredMetricsViewerTab,
+ dimensionBreakout: StoredMetricsViewerDimensionBreakout,
baseDefinitions?: Record<MetricSourceId, MetricDefinition | null>,
slotIndexToSourceId?: Map<number, MetricSourceId>,
): string | null {
const targetSubtype =
- findSubtypeFromExistingTab(
- tab,
+ findSubtypeFromExistingDimensionBreakout(
+ dimensionBreakout,
getSubtype,
baseDefinitions,
slotIndexToSourceId,
- ) ?? findBestSubtypeInDimensions(dimensionsByType, tabType, getSubtype);
+ ) ??
+ findBestSubtypeInDimensions(
+ dimensionsByType,
+ dimensionBreakoutType,
+ getSubtype,
+ );
if (!targetSubtype) {
return null;
}
return (
- findDimensionBySubtype(dimensionsByType, tabType, getSubtype, targetSubtype)
- ?.id ?? null
+ findDimensionBySubtype(
+ dimensionsByType,
+ dimensionBreakoutType,
+ getSubtype,
+ targetSubtype,
+ )?.id ?? null
);
}
+/**
+ * Resolve a stored breakout to a dimension in `dimensions` by exact identity:
+ * first by dimension id, then by matching an already-mapped slot's reference
+ * and requiring a shared underlying source (same physical column/table) via
+ * `LibMetric.isSameSource`.
+ */
function findExactColumnMatch(
dimensions: Map<string, DimensionDescriptor>,
- tab: StoredMetricsViewerTab,
+ dimensionBreakout: StoredMetricsViewerDimensionBreakout,
baseDefinitions?: Record<MetricSourceId, MetricDefinition | null>,
slotIndexToSourceId?: Map<number, MetricSourceId>,
): string | null {
- const exactMatch = dimensions.get(tab.id);
- if (exactMatch?.dimensionType === tab.type) {
+ const exactMatch = dimensions.get(dimensionBreakout.id);
+ if (exactMatch?.dimensionType === dimensionBreakout.type) {
return exactMatch.id;
}
- const reference = findReferenceFromTab(
- tab,
- tab.type,
+ const reference = findReferenceFromDimensionBreakout(
+ dimensionBreakout,
+ dimensionBreakout.type,
baseDefinitions,
slotIndexToSourceId,
);
if (reference) {
- return findSourceMatch(dimensions, tab.type, reference)?.id ?? null;
+ return findStrictExactColumnMatch(dimensions, reference)?.id ?? null;
+ }
+
+ return null;
+}
+
+function findStrictExactColumnMatch(
+ dimensions: Map<string, DimensionDescriptor>,
+ reference: DimensionDescriptor,
+): DimensionDescriptor | null {
+ for (const [, info] of dimensions) {
+ if (info.dimensionType !== reference.dimensionType) {
+ continue;
+ }
+
+ if (
+ LibMetric.isSameSource(
+ info.dimensionMetadata,
+ reference.dimensionMetadata,
+ )
+ ) {
+ return info;
+ }
}
return null;
@@ -740,13 +884,13 @@ function findExactColumnMatch(
function findAggregateMatch(
dimensions: Map<string, DimensionDescriptor>,
- tab: StoredMetricsViewerTab,
- config: TabTypeDefinition,
+ dimensionBreakout: StoredMetricsViewerDimensionBreakout,
+ config: DimensionBreakoutTypeDefinition,
baseDefinitions?: Record<MetricSourceId, MetricDefinition | null>,
slotIndexToSourceId?: Map<number, MetricSourceId>,
): string | null {
- const reference = findReferenceFromTab(
- tab,
+ const reference = findReferenceFromDimensionBreakout(
+ dimensionBreakout,
config.type,
baseDefinitions,
slotIndexToSourceId,
@@ -774,7 +918,7 @@ function findAggregateMatch(
dimensions,
config.type,
config.dimensionSubtype,
- tab,
+ dimensionBreakout,
baseDefinitions,
slotIndexToSourceId,
);
@@ -786,19 +930,19 @@ function findAggregateMatch(
return findDimensionOfType(dimensions, config.type)?.id ?? null;
}
-export function findMatchingDimensionForTab(
+export function findMatchingDimensionForBreakout(
def: MetricDefinition,
- tab: StoredMetricsViewerTab,
+ dimensionBreakout: StoredMetricsViewerDimensionBreakout,
baseDefinitions?: Record<MetricSourceId, MetricDefinition | null>,
slotIndexToSourceId?: Map<number, MetricSourceId>,
): string | null {
const dimensions = getDimensionsByType(def);
- const config = getTabConfig(tab.type);
+ const config = getDimensionBreakoutConfig(dimensionBreakout.type);
if (config?.matchMode !== "aggregate") {
return findExactColumnMatch(
dimensions,
- tab,
+ dimensionBreakout,
baseDefinitions,
slotIndexToSourceId,
);
@@ -806,7 +950,7 @@ export function findMatchingDimensionForTab(
return findAggregateMatch(
dimensions,
- tab,
+ dimensionBreakout,
config,
baseDefinitions,
slotIndexToSourceId,
diff --git a/frontend/src/metabase/metrics-viewer/utils/dimension-breakouts.unit.spec.ts b/frontend/src/metabase/metrics-viewer/utils/dimension-breakouts.unit.spec.ts
new file mode 100644
index 00000000000..8aed648917f
--- /dev/null
+++ b/frontend/src/metabase/metrics-viewer/utils/dimension-breakouts.unit.spec.ts
@@ -0,0 +1,255 @@
+import type { MetricSourceId } from "../types/viewer-state";
+
+import {
+ createMetricMetadata,
+ createMockMetricDimension,
+ createMockNormalizedMetric,
+ setupDefinition,
+} from "./__tests__/test-helpers";
+import {
+ computeDefaultDimensionBreakouts,
+ createDimensionBreakoutFromInfo,
+ findMatchingDimensionForBreakout,
+ resolveCommonDimensionBreakoutLabel,
+} from "./dimension-breakouts";
+
+describe("resolveCommonDimensionBreakoutLabel", () => {
+ it("returns null for empty array", () => {
+ expect(resolveCommonDimensionBreakoutLabel([])).toBeNull();
+ });
+
+ it("returns the name when only one is provided", () => {
+ expect(resolveCommonDimensionBreakoutLabel(["Created At"])).toBe(
+ "Created At",
+ );
+ });
+
+ it("returns the name when all names are identical", () => {
+ expect(
+ resolveCommonDimensionBreakoutLabel(["Created At", "Created At"]),
+ ).toBe("Created At");
+ });
+
+ it("returns the most frequent name", () => {
+ expect(
+ resolveCommonDimensionBreakoutLabel([
+ "Created At",
+ "Order Date",
+ "Created At",
+ ]),
+ ).toBe("Created At");
+ });
+
+ it("returns the first name when tied", () => {
+ expect(resolveCommonDimensionBreakoutLabel(["State", "Category"])).toBe(
+ "State",
+ );
+ });
+
+ it("returns the first name when two different names are tied", () => {
+ expect(
+ resolveCommonDimensionBreakoutLabel(["Created At", "Order Date"]),
+ ).toBe("Created At");
+ });
+});
+
+describe("createDimensionBreakoutFromInfo", () => {
+ it("uses the first non-null dimension mapping as the dimensionBreakout id", () => {
+ expect(
+ createDimensionBreakoutFromInfo({
+ type: "numeric",
+ label: "Total",
+ dimensionMapping: { 0: null, 1: "dim-orders-total" },
+ }),
+ ).toEqual({
+ id: "dim-orders-total",
+ type: "numeric",
+ label: "Total",
+ display: "bar",
+ dimensionMapping: { 0: null, 1: "dim-orders-total" },
+ projectionConfig: {},
+ });
+ });
+
+ it("uses the preferred id when one is provided", () => {
+ expect(
+ createDimensionBreakoutFromInfo({
+ id: "dim-selected-created-at",
+ type: "time",
+ label: "Created At",
+ dimensionMapping: {
+ 0: "dim-comparable-canceled-at",
+ 1: "dim-selected-created-at",
+ },
+ }),
+ ).toEqual({
+ id: "dim-selected-created-at",
+ type: "time",
+ label: "Created At",
+ display: "line",
+ dimensionMapping: {
+ 0: "dim-comparable-canceled-at",
+ 1: "dim-selected-created-at",
+ },
+ projectionConfig: {},
+ });
+ });
+});
+
+describe("computeDefaultDimensionBreakouts", () => {
+ const CATEGORY_SELECTION_METRIC = createMockNormalizedMetric({
+ id: 101,
+ name: "Category Selection",
+ dimensions: [
+ createMockMetricDimension({
+ id: "dim-category",
+ display_name: "Category",
+ effective_type: "type/Text",
+ semantic_type: "type/Category",
+ }),
+ createMockMetricDimension({
+ id: "dim-status",
+ display_name: "Status",
+ effective_type: "type/Text",
+ semantic_type: null,
+ }),
+ ],
+ });
+
+ const sourceId: MetricSourceId = `metric:${CATEGORY_SELECTION_METRIC.id}`;
+ const metadata = createMetricMetadata([CATEGORY_SELECTION_METRIC]);
+ const definition = setupDefinition(metadata, CATEGORY_SELECTION_METRIC.id);
+
+ it("only auto-creates category dimensionBreakouts for preferred category dimensions", () => {
+ const dimensionBreakouts = computeDefaultDimensionBreakouts(
+ { [sourceId]: definition },
+ [{ slotIndex: 0, entityIndex: 0, sourceId }],
+ );
+
+ // Status should not be included because it's not preferred
+ expect(
+ dimensionBreakouts.map((dimensionBreakout) => dimensionBreakout.label),
+ ).toEqual(["Category", "Totals"]);
+ });
+});
+
+describe("findMatchingDimensionForBreakout", () => {
+ const FIRST_METRIC = createMockNormalizedMetric({
+ id: 201,
+ name: "First Metric",
+ dimensions: [
+ createMockMetricDimension({
+ id: "dim-first-last-name",
+ display_name: "Last Name",
+ effective_type: "type/Text",
+ semantic_type: "type/Category",
+ }),
+ ],
+ });
+ const SECOND_METRIC = createMockNormalizedMetric({
+ id: 202,
+ name: "Second Metric",
+ dimensions: [
+ createMockMetricDimension({
+ id: "dim-second-last-name",
+ display_name: "Last Name",
+ effective_type: "type/Text",
+ semantic_type: "type/Category",
+ }),
+ ],
+ });
+ const SHARED_SOURCE_METRIC = createMockNormalizedMetric({
+ id: 203,
+ name: "Shared Source Metric",
+ dimensions: [
+ createMockMetricDimension({
+ id: "dim-shared-first-name",
+ display_name: "First Name",
+ effective_type: "type/Text",
+ semantic_type: "type/Category",
+ sources: [{ type: "field", "field-id": 1 }],
+ }),
+ ],
+ });
+ const MATCHING_SHARED_SOURCE_METRIC = createMockNormalizedMetric({
+ id: 204,
+ name: "Matching Shared Source Metric",
+ dimensions: [
+ createMockMetricDimension({
+ id: "dim-matching-shared-first-name",
+ display_name: "First Name",
+ effective_type: "type/Text",
+ semantic_type: "type/Category",
+ sources: [{ type: "field", "field-id": 1 }],
+ }),
+ ],
+ });
+
+ const firstSourceId: MetricSourceId = `metric:${FIRST_METRIC.id}`;
+ const secondSourceId: MetricSourceId = `metric:${SECOND_METRIC.id}`;
+ const sharedSourceId: MetricSourceId = `metric:${SHARED_SOURCE_METRIC.id}`;
+ const metadata = createMetricMetadata([
+ FIRST_METRIC,
+ SECOND_METRIC,
+ SHARED_SOURCE_METRIC,
+ MATCHING_SHARED_SOURCE_METRIC,
+ ]);
+ const firstDefinition = setupDefinition(metadata, FIRST_METRIC.id);
+ const secondDefinition = setupDefinition(metadata, SECOND_METRIC.id);
+ const sharedSourceDefinition = setupDefinition(
+ metadata,
+ SHARED_SOURCE_METRIC.id,
+ );
+ const matchingSharedSourceDefinition = setupDefinition(
+ metadata,
+ MATCHING_SHARED_SOURCE_METRIC.id,
+ );
+
+ it("does not match exact-column dimensions without the same table group", () => {
+ expect(
+ findMatchingDimensionForBreakout(
+ secondDefinition,
+ {
+ id: "dim-first-last-name",
+ type: "category",
+ label: "Last Name",
+ dimensionBySlotIndex: { 0: "dim-first-last-name" },
+ },
+ { [firstSourceId]: firstDefinition },
+ new Map([[0, firstSourceId]]),
+ ),
+ ).toBeNull();
+ });
+
+ it("matches the exact dimension id when available", () => {
+ expect(
+ findMatchingDimensionForBreakout(
+ firstDefinition,
+ {
+ id: "dim-first-last-name",
+ type: "category",
+ label: "Last Name",
+ dimensionBySlotIndex: { 1: "dim-first-last-name" },
+ },
+ { [secondSourceId]: secondDefinition },
+ new Map([[1, secondSourceId]]),
+ ),
+ ).toBe("dim-first-last-name");
+ });
+
+ it("matches exact-column dimensions from the same underlying source column", () => {
+ expect(
+ findMatchingDimensionForBreakout(
+ matchingSharedSourceDefinition,
+ {
+ id: "dim-shared-first-name",
+ type: "category",
+ label: "First Name",
+ dimensionBySlotIndex: { 0: "dim-shared-first-name" },
+ },
+ { [sharedSourceId]: sharedSourceDefinition },
+ new Map([[0, sharedSourceId]]),
+ ),
+ ).toBe("dim-matching-shared-first-name");
+ });
+});
diff --git a/frontend/src/metabase/metrics-viewer/utils/dimension-picker.ts b/frontend/src/metabase/metrics-viewer/utils/dimension-picker.ts
index 9e482434092..2793e629e82 100644
--- a/frontend/src/metabase/metrics-viewer/utils/dimension-picker.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/dimension-picker.ts
@@ -1,5 +1,7 @@
-import { t } from "ttag";
-
+import {
+ type GeoSubtype,
+ getGeoSubtype,
+} from "metabase/metrics/common/utils/dimension-types";
import type {
DimensionGroup,
DimensionMetadata,
@@ -9,24 +11,42 @@ import * as LibMetric from "metabase-lib/metric";
import type { IconName } from "metabase-types/api";
import type {
+ AvailableDimension,
+ AvailableDimensionsResult,
MetricSourceId,
- MetricsViewerTabType,
-} from "../types/viewer-state";
-
+ MetricsViewerDimensionBreakoutState,
+ MetricsViewerDimensionBreakoutType,
+ SourceColorMap,
+ SourceDisplayInfo,
+} from "../types";
+
+export type {
+ AvailableDimension,
+ AvailableDimensionsResult,
+ SourceDisplayInfo,
+} from "../types";
+
+import { getDimensionIcon, getDimensionsByType } from "./dimension-breakouts";
import type { MetricSlot } from "./metric-slots";
-import { type TabInfo, getDimensionIcon, getDimensionsByType } from "./tabs";
// ── Dimension picker ──
-export interface AvailableDimension {
- icon: IconName;
- group?: DimensionGroup;
- tabInfo: TabInfo;
-}
-
-export interface AvailableDimensionsResult {
- shared: AvailableDimension[];
- bySource: Record<MetricSourceId, AvailableDimension[]>;
+export function getExistingDimensionBreakoutDimensionIds(
+ dimensionBreakouts: MetricsViewerDimensionBreakoutState[],
+
+ excludedDimensionBreakoutId?: string | null,
+) {
+ return new Set(
+ dimensionBreakouts
+ .filter(
+ (dimensionBreakout) =>
+ dimensionBreakout.id !== excludedDimensionBreakoutId,
+ )
+ .flatMap((dimensionBreakout) =>
+ Object.values(dimensionBreakout.dimensionMapping),
+ )
+ .filter((id) => id != null),
+ );
}
interface DimensionEntry {
@@ -34,15 +54,18 @@ interface DimensionEntry {
id: string;
label: string;
icon: IconName;
- tabType: MetricsViewerTabType;
+ dimensionBreakoutType: MetricsViewerDimensionBreakoutType;
group?: DimensionGroup;
+ canListValues: boolean;
+ isPreferred?: boolean;
+ geoSubtype?: GeoSubtype | null;
sourceId: MetricSourceId;
}
function collectAllDimensionEntries(
sourceOrder: MetricSourceId[],
definitionsBySourceId: Record<MetricSourceId, MetricDefinition | null>,
- existingTabDimensionIds: Set<string>,
+ existingDimensionBreakoutDimensionIds: Set<string>,
): DimensionEntry[] {
const entries: DimensionEntry[] = [];
@@ -53,17 +76,22 @@ function collectAllDimensionEntries(
}
for (const [id, info] of getDimensionsByType(def)) {
- if (existingTabDimensionIds.has(id)) {
+ if (existingDimensionBreakoutDimensionIds.has(id)) {
continue;
}
+ const geoSubtype = getGeoSubtype(info.dimensionMetadata);
+
entries.push({
dimension: info.dimensionMetadata,
id,
label: info.displayName,
icon: getDimensionIcon(info.dimensionMetadata),
- tabType: info.dimensionType,
+ dimensionBreakoutType: info.dimensionType,
group: info.group,
+ canListValues: info.canListValues,
+ isPreferred: info.isPreferred,
+ ...(geoSubtype ? { geoSubtype } : {}),
sourceId,
});
}
@@ -95,7 +123,7 @@ export function getAvailableDimensionsForPicker(
definitionsBySourceId: Record<MetricSourceId, MetricDefinition | null>,
sourceOrder: MetricSourceId[],
metricSlots: MetricSlot[],
- existingTabDimensionIds: Set<string>,
+ existingDimensionBreakoutDimensionIds: Set<string>,
): AvailableDimensionsResult {
const result: AvailableDimensionsResult = { shared: [], bySource: {} };
@@ -106,24 +134,18 @@ export function getAvailableDimensionsForPicker(
const entries = collectAllDimensionEntries(
sourceOrder,
definitionsBySourceId,
- existingTabDimensionIds,
+ existingDimensionBreakoutDimensionIds,
);
const groups = groupBySource(entries);
const loadedSourceCount = new Set(entries.map((entry) => entry.sourceId))
.size;
const hasMultipleSources = loadedSourceCount > 1;
- const sourceIdToSlotIndices = metricSlots.reduce(
- (acc, slot) => {
- if (acc[slot.sourceId]) {
- acc[slot.sourceId].push(slot.slotIndex);
- } else {
- acc[slot.sourceId] = [slot.slotIndex];
- }
- return acc;
- },
- {} as Record<MetricSourceId, number[]>,
- );
+ const sourceIdToSlotIndices: Record<MetricSourceId, number[]> = {};
+ for (const slot of metricSlots) {
+ const slotIndices = (sourceIdToSlotIndices[slot.sourceId] ??= []);
+ slotIndices.push(slot.slotIndex);
+ }
for (const group of groups) {
const uniqueSources = [...new Set(group.map((entry) => entry.sourceId))];
@@ -133,8 +155,11 @@ export function getAvailableDimensionsForPicker(
result.shared.push({
icon: first.icon,
group: first.group,
- tabInfo: {
- type: first.tabType,
+ canListValues: first.canListValues,
+ isPreferred: first.isPreferred,
+ ...(first.geoSubtype ? { geoSubtype: first.geoSubtype } : {}),
+ dimensionBreakoutInfo: {
+ type: first.dimensionBreakoutType,
label: first.label,
dimensionMapping: Object.fromEntries(
group.flatMap((entry) =>
@@ -152,8 +177,11 @@ export function getAvailableDimensionsForPicker(
arr.push({
icon: entry.icon,
group: entry.group,
- tabInfo: {
- type: entry.tabType,
+ canListValues: entry.canListValues,
+ isPreferred: entry.isPreferred,
+ ...(entry.geoSubtype ? { geoSubtype: entry.geoSubtype } : {}),
+ dimensionBreakoutInfo: {
+ type: entry.dimensionBreakoutType,
label: entry.label,
dimensionMapping: Object.fromEntries(
(sourceIdToSlotIndices[entry.sourceId] ?? []).map((slotIndex) => [
@@ -168,11 +196,15 @@ export function getAvailableDimensionsForPicker(
}
result.shared.sort((first, second) =>
- first.tabInfo.label.localeCompare(second.tabInfo.label),
+ first.dimensionBreakoutInfo.label.localeCompare(
+ second.dimensionBreakoutInfo.label,
+ ),
);
for (const sourceId of sourceOrder) {
result.bySource[sourceId]?.sort((first, second) =>
- first.tabInfo.label.localeCompare(second.tabInfo.label),
+ first.dimensionBreakoutInfo.label.localeCompare(
+ second.dimensionBreakoutInfo.label,
+ ),
);
}
@@ -181,91 +213,221 @@ export function getAvailableDimensionsForPicker(
// ── Display helpers ──
-export interface SourceDisplayInfo {
- type: "metric" | "measure";
- name: string;
-}
-
// ── Dimension picker sections ──
export type DimensionPickerItem = AvailableDimension & {
name: string;
};
+export type DimensionPickerSidebarCategory = DimensionPickerItem & {
+ key: string;
+ targetItems: DimensionPickerItem[];
+};
+
+export type DimensionPickerSidebarCategorySelectOption = {
+ value: string;
+ label: string;
+ icon: IconName;
+};
+
+type RawDimensionPickerSidebarCategorySelectOption =
+ DimensionPickerSidebarCategorySelectOption & {
+ groupName?: string;
+ };
+
+export type DimensionPickerSidebarCategorySelectRow = {
+ slotIndex: number;
+ sourceId: MetricSourceId;
+ metricName: string;
+ colors?: string[];
+ isExpressionToken: boolean;
+ value: string | null;
+ options: DimensionPickerSidebarCategorySelectOption[];
+};
+
export type DimensionPickerSection = {
name?: string;
items: DimensionPickerItem[];
+ isShared?: boolean;
+ sourceId?: MetricSourceId;
};
-export function buildDimensionPickerSections({
- availableDimensions,
- sourceOrder,
- sourceDataById,
- hasMultipleSources,
-}: {
- availableDimensions: AvailableDimensionsResult;
- sourceOrder: MetricSourceId[];
- sourceDataById: Record<MetricSourceId, SourceDisplayInfo>;
- hasMultipleSources: boolean;
-}): DimensionPickerSection[] {
- const sections: DimensionPickerSection[] = [];
-
- const splitByGroup = (
- dimensions: AvailableDimension[],
- sectionName?: string,
- ) => {
- const groups = new Map<string | undefined, AvailableDimension[]>();
- for (const dimension of dimensions) {
- const groupId = dimension.group?.id;
- const existing = groups.get(groupId);
- if (existing) {
- existing.push(dimension);
- } else {
- groups.set(groupId, [dimension]);
+export function getComparableDimensionKey(item: DimensionPickerItem) {
+ const type = item.dimensionBreakoutInfo.type;
+
+ if (type === "time") {
+ return "type:time";
+ }
+
+ if (type === "geo" && item.geoSubtype === "country") {
+ return "type:geo:country";
+ }
+
+ return [type, item.group?.id ?? "", item.name].join(":");
+}
+
+function getDimensionPickerItemByDimensionId(
+ sections: DimensionPickerSection[],
+) {
+ const itemsByDimensionId = new Map<string, DimensionPickerItem>();
+
+ for (const item of sections.flatMap((section) => section.items)) {
+ for (const dimensionId of Object.values(
+ item.dimensionBreakoutInfo.dimensionMapping,
+ )) {
+ if (dimensionId != null && !itemsByDimensionId.has(dimensionId)) {
+ itemsByDimensionId.set(dimensionId, item);
}
}
+ }
- if (groups.size <= 1) {
- sections.push({
- name: sectionName,
- items: dimensions.map((dimension) => ({
- ...dimension,
- name: dimension.tabInfo.label,
- })),
- });
- return;
+ return itemsByDimensionId;
+}
+
+export function getComparableDimensionMapping({
+ item,
+ sections,
+ metricSlots,
+ activeDimensionBreakout,
+}: {
+ item: DimensionPickerItem;
+ sections: DimensionPickerSection[];
+ metricSlots: MetricSlot[];
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState;
+}): Record<number, string | null> {
+ const comparableKey = getComparableDimensionKey(item);
+ const slotIndices = new Set(metricSlots.map((slot) => slot.slotIndex));
+ const mapping: Record<number, string | null> = Object.fromEntries(
+ metricSlots.map((slot) => [slot.slotIndex, null]),
+ );
+ const clickedSlotIndices = new Set(
+ Object.entries(item.dimensionBreakoutInfo.dimensionMapping)
+ .filter(([, dimensionId]) => dimensionId != null)
+ .map(([slotIndex]) => Number(slotIndex)),
+ );
+ const itemsByDimensionId = getDimensionPickerItemByDimensionId(sections);
+ const comparableSectionItems = sections
+ .flatMap((section) => section.items)
+ .filter(
+ (sectionItem) =>
+ sectionItem !== item &&
+ getComparableDimensionKey(sectionItem) === comparableKey,
+ );
+
+ const comparableItems = [
+ item,
+ ...comparableSectionItems.filter(
+ (sectionItem) => sectionItem.name === item.name,
+ ),
+ ...comparableSectionItems.filter(
+ (sectionItem) => sectionItem.name !== item.name,
+ ),
+ ];
+
+ for (const [slotIndex, dimensionId] of Object.entries(
+ activeDimensionBreakout.dimensionMapping,
+ )) {
+ const numericSlotIndex = Number(slotIndex);
+ if (
+ !slotIndices.has(numericSlotIndex) ||
+ clickedSlotIndices.has(numericSlotIndex)
+ ) {
+ continue;
}
- for (const [, groupDimensions] of groups) {
- const groupName = groupDimensions[0].group?.displayName;
- const name = sectionName ? `${sectionName} · ${groupName}` : groupName;
- sections.push({
- name,
- items: groupDimensions.map((dimension) => ({
- ...dimension,
- name: dimension.tabInfo.label,
- })),
- });
+ const currentItem = dimensionId
+ ? itemsByDimensionId.get(dimensionId)
+ : undefined;
+ if (
+ currentItem &&
+ getComparableDimensionKey(currentItem) === comparableKey
+ ) {
+ mapping[numericSlotIndex] = dimensionId;
}
- };
+ }
- if (hasMultipleSources && availableDimensions.shared.length > 0) {
- splitByGroup(availableDimensions.shared, t`Shared`);
+ for (const comparableItem of comparableItems) {
+ for (const [slotIndex, dimensionId] of Object.entries(
+ comparableItem.dimensionBreakoutInfo.dimensionMapping,
+ )) {
+ const numericSlotIndex = Number(slotIndex);
+ if (slotIndices.has(numericSlotIndex)) {
+ mapping[numericSlotIndex] ??= dimensionId;
+ }
+ }
}
- for (const sourceId of sourceOrder) {
- const sourceDimensions = availableDimensions.bySource[sourceId];
- if (!sourceDimensions || sourceDimensions.length === 0) {
- continue;
+ return mapping;
+}
+
+export function buildDimensionPickerSidebarCategorySelectRows({
+ category,
+ activeDimensionBreakout,
+ metricSlots,
+ sourceDataById,
+ sourceColors,
+}: {
+ category: DimensionPickerSidebarCategory;
+ activeDimensionBreakout: MetricsViewerDimensionBreakoutState;
+ metricSlots: MetricSlot[];
+ sourceDataById: Record<MetricSourceId, SourceDisplayInfo>;
+ sourceColors: SourceColorMap;
+}): DimensionPickerSidebarCategorySelectRow[] {
+ return metricSlots.flatMap((slot) => {
+ const optionsByValue = new Map<
+ string,
+ RawDimensionPickerSidebarCategorySelectOption
+ >();
+
+ for (const item of category.targetItems) {
+ const dimensionId =
+ item.dimensionBreakoutInfo.dimensionMapping[slot.slotIndex];
+ if (!dimensionId || optionsByValue.has(dimensionId)) {
+ continue;
+ }
+
+ optionsByValue.set(dimensionId, {
+ value: dimensionId,
+ label: item.name,
+ icon: item.icon,
+ groupName: item.group?.displayName,
+ });
}
- if (hasMultipleSources) {
- const sourceName = sourceDataById[sourceId]?.name ?? sourceId;
- splitByGroup(sourceDimensions, sourceName);
- } else {
- splitByGroup(sourceDimensions);
+ const labelCounts = new Map<string, number>();
+ for (const option of optionsByValue.values()) {
+ labelCounts.set(option.label, (labelCounts.get(option.label) ?? 0) + 1);
+ }
+ const fallbackGroupName =
+ sourceDataById[slot.sourceId]?.name ?? slot.sourceId;
+ const options = [...optionsByValue.values()]
+ .map(({ groupName, ...option }) => ({
+ ...option,
+ label:
+ (labelCounts.get(option.label) ?? 0) > 1
+ ? `${groupName ?? fallbackGroupName} → ${option.label}`
+ : option.label,
+ }))
+ .sort((first, second) => first.label.localeCompare(second.label));
+ if (options.length === 0) {
+ return [];
}
- }
- return sections;
+ const activeDimensionId =
+ activeDimensionBreakout.dimensionMapping[slot.slotIndex] ?? null;
+
+ return [
+ {
+ slotIndex: slot.slotIndex,
+ sourceId: slot.sourceId,
+ metricName: sourceDataById[slot.sourceId]?.name ?? slot.sourceId,
+ colors: sourceColors[slot.entityIndex],
+ isExpressionToken: slot.tokenPosition != null,
+ value: options.some((option) => option.value === activeDimensionId)
+ ? activeDimensionId
+ : null,
+ options,
+ },
+ ];
+ });
}
diff --git a/frontend/src/metabase/metrics-viewer/utils/dimension-picker.unit.spec.ts b/frontend/src/metabase/metrics-viewer/utils/dimension-picker.unit.spec.ts
index c35ea825618..951c1382d46 100644
--- a/frontend/src/metabase/metrics-viewer/utils/dimension-picker.unit.spec.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/dimension-picker.unit.spec.ts
@@ -1,4 +1,7 @@
-import type { MetricSourceId } from "../types/viewer-state";
+import type {
+ MetricSourceId,
+ MetricsViewerDimensionBreakoutState,
+} from "../types/viewer-state";
import {
REVENUE_METRIC,
@@ -7,7 +10,14 @@ import {
createMockNormalizedMetric,
setupDefinition,
} from "./__tests__/test-helpers";
-import { getAvailableDimensionsForPicker } from "./dimension-picker";
+import {
+ type AvailableDimension,
+ type DimensionPickerSidebarCategory,
+ buildDimensionPickerSidebarCategorySelectRows,
+ getAvailableDimensionsForPicker,
+ getComparableDimensionMapping,
+ getExistingDimensionBreakoutDimensionIds,
+} from "./dimension-picker";
const ORDERS_METRIC = createMockNormalizedMetric({
id: 3,
@@ -35,20 +45,24 @@ const ordersDefinition = setupDefinition(allMetadata, ORDERS_METRIC.id);
const REVENUE_SOURCE_ID: MetricSourceId = `metric:${REVENUE_METRIC.id}`;
const ORDERS_SOURCE_ID: MetricSourceId = `metric:${ORDERS_METRIC.id}`;
-const REVENUE_DIMENSIONS = [
+const REVENUE_DIMENSIONS: AvailableDimension[] = [
{
icon: "int",
group: undefined,
- tabInfo: {
+ canListValues: false,
+ isPreferred: undefined,
+ dimensionBreakoutInfo: {
type: "numeric",
label: "Amount",
dimensionMapping: { 0: "dim-amount" },
},
},
{
- icon: "string",
+ icon: "label",
group: undefined,
- tabInfo: {
+ canListValues: false,
+ isPreferred: true,
+ dimensionBreakoutInfo: {
type: "category",
label: "Category",
dimensionMapping: { 0: "dim-category" },
@@ -57,7 +71,9 @@ const REVENUE_DIMENSIONS = [
{
icon: "calendar",
group: undefined,
- tabInfo: {
+ canListValues: false,
+ isPreferred: undefined,
+ dimensionBreakoutInfo: {
type: "time",
label: "Created At",
dimensionMapping: { 0: "dim-created-at" },
@@ -66,7 +82,9 @@ const REVENUE_DIMENSIONS = [
{
icon: "io",
group: undefined,
- tabInfo: {
+ canListValues: false,
+ isPreferred: undefined,
+ dimensionBreakoutInfo: {
type: "boolean",
label: "Is Active",
dimensionMapping: { 0: "dim-active" },
@@ -74,20 +92,24 @@ const REVENUE_DIMENSIONS = [
},
];
-const ORDERS_DIMENSIONS = [
+const ORDERS_DIMENSIONS: AvailableDimension[] = [
{
icon: "calendar",
group: undefined,
- tabInfo: {
+ canListValues: false,
+ isPreferred: undefined,
+ dimensionBreakoutInfo: {
type: "time",
label: "Created At",
dimensionMapping: { 0: "dim-created-at" },
},
},
{
- icon: "string",
+ icon: "label",
group: undefined,
- tabInfo: {
+ canListValues: false,
+ isPreferred: true,
+ dimensionBreakoutInfo: {
type: "category",
label: "Status",
dimensionMapping: { 0: "dim-status" },
@@ -156,16 +178,20 @@ describe("getAvailableDimensionsForPicker", () => {
{
icon: "calendar",
group: undefined,
- tabInfo: {
+ canListValues: false,
+ isPreferred: undefined,
+ dimensionBreakoutInfo: {
type: "time",
label: "Created At",
dimensionMapping: { 1: "dim-created-at" },
},
},
{
- icon: "string",
+ icon: "label",
group: undefined,
- tabInfo: {
+ canListValues: false,
+ isPreferred: true,
+ dimensionBreakoutInfo: {
type: "category",
label: "Status",
dimensionMapping: { 1: "dim-status" },
@@ -190,22 +216,24 @@ describe("getAvailableDimensionsForPicker", () => {
const allDimensions = result.bySource[REVENUE_SOURCE_ID] ?? [];
expect(allDimensions).toHaveLength(REVENUE_DIMENSIONS.length);
- const labels = allDimensions.map((d) => d.tabInfo.label);
+ const labels = allDimensions.map((d) => d.dimensionBreakoutInfo.label);
expect(labels).toEqual([...new Set(labels)]);
for (const dim of allDimensions) {
- const dimId = Object.values(dim.tabInfo.dimensionMapping)[0];
- expect(dim.tabInfo.dimensionMapping).toEqual({
+ const dimId = Object.values(
+ dim.dimensionBreakoutInfo.dimensionMapping,
+ )[0];
+ expect(dim.dimensionBreakoutInfo.dimensionMapping).toEqual({
0: dimId,
1: dimId,
});
}
});
- it("filters out dimensions whose id matches existingTabDimensionIds", () => {
+ it("filters out dimensions whose id matches existingDimensionBreakoutDimensionIds", () => {
const allIds = REVENUE_DIMENSIONS.flatMap((dimension) =>
- Object.values(dimension.tabInfo.dimensionMapping),
- );
+ Object.values(dimension.dimensionBreakoutInfo.dimensionMapping),
+ ).filter((id): id is string => id != null);
const result = getAvailableDimensionsForPicker(
{ [REVENUE_SOURCE_ID]: revenueDefinition },
@@ -217,3 +245,767 @@ describe("getAvailableDimensionsForPicker", () => {
expect(result).toEqual({ shared: [], bySource: {} });
});
});
+
+describe("getExistingDimensionBreakoutDimensionIds", () => {
+ const dimensionBreakouts: MetricsViewerDimensionBreakoutState[] = [
+ {
+ id: "dimensionBreakout-category",
+ type: "category",
+ label: "Category",
+ display: "bar",
+ dimensionMapping: { 0: "dim-category" },
+ projectionConfig: {},
+ },
+ {
+ id: "dimensionBreakout-created-at",
+ type: "time",
+ label: "Created At",
+ display: "line",
+ dimensionMapping: { 0: "dim-created-at", 1: null },
+ projectionConfig: {},
+ },
+ ];
+
+ it("returns dimension ids from every dimensionBreakout", () => {
+ expect(
+ getExistingDimensionBreakoutDimensionIds(dimensionBreakouts),
+ ).toEqual(new Set(["dim-category", "dim-created-at"]));
+ });
+
+ it("can exclude the active dimensionBreakout ids", () => {
+ expect(
+ getExistingDimensionBreakoutDimensionIds(
+ dimensionBreakouts,
+ "dimensionBreakout-category",
+ ),
+ ).toEqual(new Set(["dim-created-at"]));
+ });
+});
+
+describe("buildDimensionPickerSidebarCategorySelectRows", () => {
+ it("builds one column select row per metric slot", () => {
+ const timeCategory: DimensionPickerSidebarCategory = {
+ key: "type:time",
+ name: "Time",
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Time",
+ dimensionMapping: { 0: "dim-created-at", 1: "dim-placed-at" },
+ },
+ targetItems: [
+ {
+ name: "Created At",
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 0: "dim-created-at" },
+ },
+ },
+ {
+ name: "Order Date",
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Order Date",
+ dimensionMapping: { 0: "dim-order-date" },
+ },
+ },
+ {
+ name: "Placed At",
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Placed At",
+ dimensionMapping: { 1: "dim-placed-at" },
+ },
+ },
+ ],
+ };
+
+ const rows = buildDimensionPickerSidebarCategorySelectRows({
+ category: timeCategory,
+ activeDimensionBreakout: {
+ id: "dim-created-at",
+ type: "time",
+ label: "Time",
+ display: "line",
+ dimensionMapping: { 0: "dim-created-at", 1: "dim-placed-at" },
+ projectionConfig: {},
+ },
+ metricSlots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: REVENUE_SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: ORDERS_SOURCE_ID },
+ ],
+ sourceDataById: {
+ [REVENUE_SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [ORDERS_SOURCE_ID]: { type: "metric", name: "Orders" },
+ },
+ sourceColors: { 0: ["#509ee3"], 1: ["#f9d45c"] },
+ });
+
+ expect(rows).toEqual([
+ {
+ slotIndex: 0,
+ sourceId: REVENUE_SOURCE_ID,
+ metricName: "Revenue",
+ colors: ["#509ee3"],
+ isExpressionToken: false,
+ value: "dim-created-at",
+ options: [
+ { value: "dim-created-at", label: "Created At", icon: "calendar" },
+ { value: "dim-order-date", label: "Order Date", icon: "calendar" },
+ ],
+ },
+ {
+ slotIndex: 1,
+ sourceId: ORDERS_SOURCE_ID,
+ metricName: "Orders",
+ colors: ["#f9d45c"],
+ isExpressionToken: false,
+ value: "dim-placed-at",
+ options: [
+ { value: "dim-placed-at", label: "Placed At", icon: "calendar" },
+ ],
+ },
+ ]);
+ });
+
+ it("prepends duplicate option labels with the table name", () => {
+ const timeCategory: DimensionPickerSidebarCategory = {
+ key: "type:time",
+ name: "Time",
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Time",
+ dimensionMapping: { 0: "dim-orders-created-at" },
+ },
+ targetItems: [
+ {
+ name: "Created At",
+ icon: "calendar",
+ group: { id: "orders", type: "main", displayName: "Orders" },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 0: "dim-orders-created-at" },
+ },
+ },
+ {
+ name: "Created At",
+ icon: "calendar",
+ group: {
+ id: "products",
+ type: "connection",
+ displayName: "Products",
+ },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 0: "dim-products-created-at" },
+ },
+ },
+ ],
+ };
+
+ const rows = buildDimensionPickerSidebarCategorySelectRows({
+ category: timeCategory,
+ activeDimensionBreakout: {
+ id: "dim-orders-created-at",
+ type: "time",
+ label: "Time",
+ display: "line",
+ dimensionMapping: { 0: "dim-orders-created-at" },
+ projectionConfig: {},
+ },
+ metricSlots: [
+ { slotIndex: 0, entityIndex: 0, sourceId: REVENUE_SOURCE_ID },
+ ],
+ sourceDataById: {
+ [REVENUE_SOURCE_ID]: { type: "metric", name: "Revenue" },
+ },
+ sourceColors: { 0: ["#509ee3"] },
+ });
+
+ expect(rows[0].options.map((option) => option.label)).toEqual([
+ "Orders → Created At",
+ "Products → Created At",
+ ]);
+ });
+
+ it("marks expression token rows", () => {
+ const timeCategory: DimensionPickerSidebarCategory = {
+ key: "type:time",
+ name: "Time",
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Time",
+ dimensionMapping: {
+ 0: "dim-revenue-created-at",
+ 1: "dim-orders-created-at",
+ },
+ },
+ targetItems: [
+ {
+ name: "Time",
+ icon: "calendar",
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Time",
+ dimensionMapping: {
+ 0: "dim-revenue-created-at",
+ 1: "dim-orders-created-at",
+ },
+ },
+ },
+ ],
+ };
+
+ const rows = buildDimensionPickerSidebarCategorySelectRows({
+ category: timeCategory,
+ activeDimensionBreakout: {
+ id: "time",
+ type: "time",
+ label: "Time",
+ display: "line",
+ dimensionMapping: {
+ 0: "dim-revenue-created-at",
+ 1: "dim-orders-created-at",
+ },
+ projectionConfig: {},
+ },
+ metricSlots: [
+ {
+ slotIndex: 0,
+ entityIndex: 0,
+ sourceId: REVENUE_SOURCE_ID,
+ tokenPosition: 0,
+ },
+ {
+ slotIndex: 1,
+ entityIndex: 0,
+ sourceId: ORDERS_SOURCE_ID,
+ tokenPosition: 2,
+ },
+ ],
+ sourceDataById: {
+ [REVENUE_SOURCE_ID]: { type: "metric", name: "Revenue" },
+ [ORDERS_SOURCE_ID]: { type: "metric", name: "Orders" },
+ },
+ sourceColors: { 0: ["#509ee3"] },
+ });
+
+ expect(rows.map((row) => row.isExpressionToken)).toEqual([true, true]);
+ });
+});
+
+describe("getComparableDimensionMapping", () => {
+ const metricSlots = [
+ { slotIndex: 0, entityIndex: 0, sourceId: REVENUE_SOURCE_ID },
+ { slotIndex: 1, entityIndex: 1, sourceId: ORDERS_SOURCE_ID },
+ ];
+ const activeDimensionBreakout = {
+ id: "active-dimension-breakout",
+ type: "time",
+ label: "Time",
+ display: "line",
+ dimensionMapping: {},
+ projectionConfig: {},
+ } satisfies MetricsViewerDimensionBreakoutState;
+
+ it("maps time fields across metric slots", () => {
+ const selectedItem = {
+ icon: "calendar",
+ name: "Birth Date",
+ group: { id: "users", type: "main", displayName: "Users" },
+ dimensionBreakoutInfo: {
+ type: "time" as const,
+ label: "Birth Date",
+ dimensionMapping: { 0: "dim-users-birth-date" },
+ },
+ } as const;
+
+ expect(
+ getComparableDimensionMapping({
+ item: selectedItem,
+ sections: [
+ { items: [selectedItem], sourceId: REVENUE_SOURCE_ID },
+ {
+ items: [
+ {
+ icon: "calendar",
+ name: "Created At",
+ group: { id: "orders", type: "main", displayName: "Orders" },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 1: "dim-orders-created-at" },
+ },
+ },
+ ],
+ sourceId: ORDERS_SOURCE_ID,
+ },
+ ],
+ metricSlots,
+ activeDimensionBreakout,
+ }),
+ ).toEqual({
+ 0: "dim-users-birth-date",
+ 1: "dim-orders-created-at",
+ });
+ });
+
+ it("prefers same-named time fields when multiple time fields are comparable", () => {
+ const selectedItem = {
+ icon: "calendar",
+ name: "Created At",
+ group: { id: "accounts", type: "main", displayName: "Accounts" },
+ dimensionBreakoutInfo: {
+ type: "time" as const,
+ label: "Created At",
+ dimensionMapping: { 1: "dim-feedback-accounts-created-at" },
+ },
+ } as const;
+
+ expect(
+ getComparableDimensionMapping({
+ item: selectedItem,
+ sections: [
+ {
+ items: [
+ {
+ icon: "calendar",
+ name: "Canceled At",
+ group: {
+ id: "accounts",
+ type: "main",
+ displayName: "Accounts",
+ },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Canceled At",
+ dimensionMapping: { 0: "dim-revenue-accounts-canceled-at" },
+ },
+ },
+ {
+ icon: "calendar",
+ name: "Created At",
+ group: {
+ id: "accounts",
+ type: "main",
+ displayName: "Accounts",
+ },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 0: "dim-revenue-accounts-created-at" },
+ },
+ },
+ ],
+ sourceId: REVENUE_SOURCE_ID,
+ },
+ {
+ items: [
+ {
+ icon: "calendar",
+ name: "Canceled At",
+ group: {
+ id: "accounts",
+ type: "main",
+ displayName: "Accounts",
+ },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Canceled At",
+ dimensionMapping: { 1: "dim-feedback-accounts-canceled-at" },
+ },
+ },
+ selectedItem,
+ ],
+ sourceId: ORDERS_SOURCE_ID,
+ },
+ ],
+ metricSlots,
+ activeDimensionBreakout,
+ }),
+ ).toEqual({
+ 0: "dim-revenue-accounts-created-at",
+ 1: "dim-feedback-accounts-created-at",
+ });
+ });
+
+ it("preserves another slot's compatible active time field", () => {
+ const selectedItem = {
+ icon: "calendar",
+ name: "Birth Date",
+ group: { id: "accounts", type: "main", displayName: "Accounts" },
+ dimensionBreakoutInfo: {
+ type: "time" as const,
+ label: "Birth Date",
+ dimensionMapping: { 0: "dim-revenue-accounts-birth-date" },
+ },
+ } as const;
+
+ expect(
+ getComparableDimensionMapping({
+ item: selectedItem,
+ sections: [
+ {
+ items: [
+ selectedItem,
+ {
+ icon: "calendar",
+ name: "Created At",
+ group: {
+ id: "accounts",
+ type: "main",
+ displayName: "Accounts",
+ },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 0: "dim-revenue-accounts-created-at" },
+ },
+ },
+ ],
+ sourceId: REVENUE_SOURCE_ID,
+ },
+ {
+ items: [
+ {
+ icon: "calendar",
+ name: "Canceled At",
+ group: {
+ id: "accounts",
+ type: "main",
+ displayName: "Accounts",
+ },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Canceled At",
+ dimensionMapping: { 1: "dim-feedback-accounts-canceled-at" },
+ },
+ },
+ {
+ icon: "calendar",
+ name: "Created At",
+ group: {
+ id: "accounts",
+ type: "main",
+ displayName: "Accounts",
+ },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 1: "dim-feedback-accounts-created-at" },
+ },
+ },
+ ],
+ sourceId: ORDERS_SOURCE_ID,
+ },
+ ],
+ metricSlots,
+ activeDimensionBreakout: {
+ ...activeDimensionBreakout,
+ dimensionMapping: { 1: "dim-feedback-accounts-created-at" },
+ },
+ }),
+ ).toEqual({
+ 0: "dim-revenue-accounts-birth-date",
+ 1: "dim-feedback-accounts-created-at",
+ });
+ });
+
+ it("preserves another slot's compatible active time field over a same-named fallback", () => {
+ const selectedItem = {
+ icon: "calendar",
+ name: "Created At",
+ group: { id: "accounts", type: "main", displayName: "Accounts" },
+ dimensionBreakoutInfo: {
+ type: "time" as const,
+ label: "Created At",
+ dimensionMapping: { 1: "dim-feedback-accounts-created-at" },
+ },
+ } as const;
+
+ expect(
+ getComparableDimensionMapping({
+ item: selectedItem,
+ sections: [
+ {
+ items: [
+ {
+ icon: "calendar",
+ name: "Birth Date",
+ group: {
+ id: "accounts",
+ type: "main",
+ displayName: "Accounts",
+ },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Birth Date",
+ dimensionMapping: { 0: "dim-revenue-accounts-birth-date" },
+ },
+ },
+ {
+ icon: "calendar",
+ name: "Created At",
+ group: {
+ id: "accounts",
+ type: "main",
+ displayName: "Accounts",
+ },
+ dimensionBreakoutInfo: {
+ type: "time",
+ label: "Created At",
+ dimensionMapping: { 0: "dim-revenue-accounts-created-at" },
+ },
+ },
+ ],
+ sourceId: REVENUE_SOURCE_ID,
+ },
+ {
+ items: [selectedItem],
+ sourceId: ORDERS_SOURCE_ID,
+ },
+ ],
+ metricSlots,
+ activeDimensionBreakout: {
+ ...activeDimensionBreakout,
+ dimensionMapping: { 0: "dim-revenue-accounts-birth-date" },
+ },
+ }),
+ ).toEqual({
+ 0: "dim-revenue-accounts-birth-date",
+ 1: "dim-feedback-accounts-created-at",
+ });
+ });
+
+ it("maps country fields across metric slots", () => {
+ const selectedItem = {
+ icon: "location",
+ name: "Product Country",
+ geoSubtype: "country" as const,
+ group: { id: "products", type: "main", displayName: "Products" },
+ dimensionBreakoutInfo: {
+ type: "geo" as const,
+ label: "Product Country",
+ dimensionMapping: { 0: "dim-product-country" },
+ },
+ } as const;
+
+ expect(
+ getComparableDimensionMapping({
+ item: selectedItem,
+ sections: [
+ { items: [selectedItem], sourceId: REVENUE_SOURCE_ID },
+ {
+ items: [
+ {
+ icon: "location",
+ name: "User Country",
+ geoSubtype: "country",
+ group: { id: "users", type: "main", displayName: "Users" },
+ dimensionBreakoutInfo: {
+ type: "geo",
+ label: "User Country",
+ dimensionMapping: { 1: "dim-user-country" },
+ },
+ },
+ ],
+ sourceId: ORDERS_SOURCE_ID,
+ },
+ ],
+ metricSlots,
+ activeDimensionBreakout,
+ }),
+ ).toEqual({
+ 0: "dim-product-country",
+ 1: "dim-user-country",
+ });
+ });
+
+ it("does not map same-named category fields from different tables", () => {
+ const selectedItem = {
+ icon: "label",
+ name: "Name",
+ group: { id: "users", type: "main", displayName: "Users" },
+ dimensionBreakoutInfo: {
+ type: "category" as const,
+ label: "Name",
+ dimensionMapping: { 0: "dim-user-name" },
+ },
+ } as const;
+
+ expect(
+ getComparableDimensionMapping({
+ item: selectedItem,
+ sections: [
+ { items: [selectedItem], sourceId: REVENUE_SOURCE_ID },
+ {
+ items: [
+ {
+ icon: "label",
+ name: "Name",
+ group: {
+ id: "products",
+ type: "main",
+ displayName: "Products",
+ },
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Name",
+ dimensionMapping: { 1: "dim-product-name" },
+ },
+ },
+ ],
+ sourceId: ORDERS_SOURCE_ID,
+ },
+ ],
+ metricSlots,
+ activeDimensionBreakout,
+ }),
+ ).toEqual({ 0: "dim-user-name", 1: null });
+ });
+
+ it.each([
+ ["Address", "dim-revenue-user-address"],
+ ["Name", "dim-revenue-user-name"],
+ ])(
+ "does not preserve an incompatible active field when selecting %s",
+ (fieldName, fieldId) => {
+ const selectedItem = {
+ icon: "label",
+ name: fieldName,
+ group: { id: "users", type: "main", displayName: "Users" },
+ dimensionBreakoutInfo: {
+ type: "category" as const,
+ label: fieldName,
+ dimensionMapping: { 0: fieldId },
+ },
+ } as const;
+
+ expect(
+ getComparableDimensionMapping({
+ item: selectedItem,
+ sections: [
+ { items: [selectedItem], sourceId: REVENUE_SOURCE_ID },
+ {
+ items: [
+ {
+ icon: "label",
+ name: "Email",
+ group: {
+ id: "accounts",
+ type: "main",
+ displayName: "Accounts",
+ },
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Email",
+ dimensionMapping: { 1: "dim-accounts-email" },
+ },
+ },
+ ],
+ sourceId: ORDERS_SOURCE_ID,
+ },
+ ],
+ metricSlots,
+ activeDimensionBreakout: {
+ ...activeDimensionBreakout,
+ type: "category",
+ label: "Email",
+ display: "bar",
+ dimensionMapping: { 1: "dim-accounts-email" },
+ },
+ }),
+ ).toEqual({ 0: fieldId, 1: null });
+ },
+ );
+
+ it("does not map same-typed numeric fields from different tables", () => {
+ const selectedItem = {
+ icon: "int",
+ name: "Total",
+ group: { id: "orders", type: "main", displayName: "Orders" },
+ dimensionBreakoutInfo: {
+ type: "numeric" as const,
+ label: "Total",
+ dimensionMapping: { 0: "dim-orders-total" },
+ },
+ } as const;
+
+ expect(
+ getComparableDimensionMapping({
+ item: selectedItem,
+ sections: [
+ { items: [selectedItem], sourceId: REVENUE_SOURCE_ID },
+ {
+ items: [
+ {
+ icon: "int",
+ name: "Price",
+ group: {
+ id: "products",
+ type: "main",
+ displayName: "Products",
+ },
+ dimensionBreakoutInfo: {
+ type: "numeric",
+ label: "Price",
+ dimensionMapping: { 1: "dim-products-price" },
+ },
+ },
+ ],
+ sourceId: ORDERS_SOURCE_ID,
+ },
+ ],
+ metricSlots,
+ activeDimensionBreakout,
+ }),
+ ).toEqual({ 0: "dim-orders-total", 1: null });
+ });
+
+ it("maps exact same table and column category fields across metric slots", () => {
+ const selectedItem = {
+ icon: "label",
+ name: "Name",
+ group: { id: "users", type: "main", displayName: "Users" },
+ dimensionBreakoutInfo: {
+ type: "category" as const,
+ label: "Name",
+ dimensionMapping: { 0: "dim-user-name" },
+ },
+ } as const;
+
+ expect(
+ getComparableDimensionMapping({
+ item: selectedItem,
+ sections: [
+ { items: [selectedItem], sourceId: REVENUE_SOURCE_ID },
+ {
+ items: [
+ {
+ icon: "label",
+ name: "Name",
+ group: { id: "users", type: "main", displayName: "Users" },
+ dimensionBreakoutInfo: {
+ type: "category",
+ label: "Name",
+ dimensionMapping: { 1: "dim-user-name" },
+ },
+ },
+ ],
+ sourceId: ORDERS_SOURCE_ID,
+ },
+ ],
+ metricSlots,
+ activeDimensionBreakout,
+ }),
+ ).toEqual({ 0: "dim-user-name", 1: "dim-user-name" });
+ });
+});
diff --git a/frontend/src/metabase/metrics-viewer/utils/index.ts b/frontend/src/metabase/metrics-viewer/utils/index.ts
index 63168b469e8..095d13a0f59 100644
--- a/frontend/src/metabase/metrics-viewer/utils/index.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/index.ts
@@ -3,9 +3,9 @@ export * from "./dimension-filters";
export * from "./dimension-lookup";
export * from "./definition-builder";
export * from "./definition-entries";
-export * from "./tab-config";
+export * from "./dimension-breakout-config";
export * from "./series";
-export * from "./tabs";
+export * from "./dimension-breakouts";
export * from "./dimension-picker";
export * from "./compact-schema";
export * from "./url-serialization";
diff --git a/frontend/src/metabase/metrics-viewer/utils/remap-dimension-mappings.ts b/frontend/src/metabase/metrics-viewer/utils/remap-dimension-mappings.ts
index 2e31da82022..b9348bb0bda 100644
--- a/frontend/src/metabase/metrics-viewer/utils/remap-dimension-mappings.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/remap-dimension-mappings.ts
@@ -2,8 +2,8 @@ import { getObjectEntries } from "metabase/utils/objects";
import type {
MetricSourceId,
+ MetricsViewerDimensionBreakoutState,
MetricsViewerFormulaEntity,
- MetricsViewerTabState,
} from "../types/viewer-state";
import type { MetricSlot } from "./metric-slots";
@@ -37,18 +37,20 @@ function findSiblingDimension(
* 2. Inherit sibling dimensions for unmapped new slots.
*/
export function remapDimensionMappings(
- tabs: MetricsViewerTabState[],
+ dimensionBreakouts: MetricsViewerDimensionBreakoutState[],
slotMapping: Map<number, number>,
newEntities: MetricsViewerFormulaEntity[],
-): MetricsViewerTabState[] {
+): MetricsViewerDimensionBreakoutState[] {
const newSlots = computeMetricSlots(newEntities);
- return tabs.map((tab) => {
+ return dimensionBreakouts.map((dimensionBreakout) => {
const newMapping: Record<number, string | null> = {};
let changed = false;
// 1. Remap existing entries from old slot index → new slot index
- for (const [oldKey, dimId] of getObjectEntries(tab.dimensionMapping)) {
+ for (const [oldKey, dimId] of getObjectEntries(
+ dimensionBreakout.dimensionMapping,
+ )) {
const oldSlotIndex = Number(oldKey);
const newSlotIndex = slotMapping.get(oldSlotIndex);
if (newSlotIndex == null) {
@@ -77,6 +79,8 @@ export function remapDimensionMappings(
}
}
- return changed ? { ...tab, dimensionMapping: newMapping } : tab;
+ return changed
+ ? { ...dimensionBreakout, dimensionMapping: newMapping }
+ : dimensionBreakout;
});
}
diff --git a/frontend/src/metabase/metrics-viewer/utils/remap-dimension-mappings.unit.spec.ts b/frontend/src/metabase/metrics-viewer/utils/remap-dimension-mappings.unit.spec.ts
index de770b904fc..942ebb3e82c 100644
--- a/frontend/src/metabase/metrics-viewer/utils/remap-dimension-mappings.unit.spec.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/remap-dimension-mappings.unit.spec.ts
@@ -1,8 +1,8 @@
import type {
MetricDefinitionEntry,
MetricSourceId,
- MetricsViewerTabState,
-} from "../types/viewer-state";
+ MetricsViewerDimensionBreakoutState,
+} from "../types";
import { remapDimensionMappings } from "./remap-dimension-mappings";
@@ -14,11 +14,11 @@ function metric(sourceId: MetricSourceId): MetricDefinitionEntry {
return { id: sourceId, type: "metric", definition: null as any };
}
-function makeTab(
- overrides: Partial<MetricsViewerTabState> = {},
-): MetricsViewerTabState {
+function makeDimensionBreakout(
+ overrides: Partial<MetricsViewerDimensionBreakoutState> = {},
+): MetricsViewerDimensionBreakoutState {
return {
- id: "tab-1",
+ id: "dimensionBreakout-1",
type: "time",
label: "By Month",
display: "line",
@@ -37,9 +37,9 @@ const COSTS: MetricSourceId = "metric:3" as MetricSourceId;
// ---------------------------------------------------------------------------
describe("remapDimensionMappings", () => {
- it("returns same tab objects when slot mapping is identity", () => {
+ it("returns same dimensionBreakout objects when slot mapping is identity", () => {
const entities = [metric(REVENUE), metric(ORDERS)];
- const tab = makeTab({
+ const dimensionBreakout = makeDimensionBreakout({
dimensionMapping: { 0: "created_at", 1: "created_at" },
});
const slotMapping = new Map([
@@ -47,16 +47,20 @@ describe("remapDimensionMappings", () => {
[1, 1],
]);
- const result = remapDimensionMappings([tab], slotMapping, entities);
+ const result = remapDimensionMappings(
+ [dimensionBreakout],
+ slotMapping,
+ entities,
+ );
- expect(result[0]).toBe(tab); // referential equality
+ expect(result[0]).toBe(dimensionBreakout); // referential equality
});
it("remaps indices when slots shift", () => {
// Old: [Revenue(0), Orders(1), Costs(2)], New: [Orders(0), Costs(1)]
// Revenue removed, Orders 1→0, Costs 2→1
const next = [metric(ORDERS), metric(COSTS)];
- const tab = makeTab({
+ const dimensionBreakout = makeDimensionBreakout({
dimensionMapping: { 0: "dim-rev", 1: "dim-ord", 2: "dim-cost" },
});
const slotMapping = new Map([
@@ -65,7 +69,11 @@ describe("remapDimensionMappings", () => {
// Revenue (old 0) not in map — removed
]);
- const result = remapDimensionMappings([tab], slotMapping, next);
+ const result = remapDimensionMappings(
+ [dimensionBreakout],
+ slotMapping,
+ next,
+ );
expect(result[0].dimensionMapping).toEqual({
0: "dim-ord",
@@ -75,7 +83,7 @@ describe("remapDimensionMappings", () => {
it("remaps indices when entities are reordered", () => {
const next = [metric(ORDERS), metric(REVENUE)]; // swapped
- const tab = makeTab({
+ const dimensionBreakout = makeDimensionBreakout({
dimensionMapping: { 0: "dim-rev", 1: "dim-ord" },
});
const slotMapping = new Map([
@@ -83,7 +91,11 @@ describe("remapDimensionMappings", () => {
[1, 0], // Orders: old 1 → new 0
]);
- const result = remapDimensionMappings([tab], slotMapping, next);
+ const result = remapDimensionMappings(
+ [dimensionBreakout],
+ slotMapping,
+ next,
+ );
expect(result[0].dimensionMapping).toEqual({
0: "dim-ord",
@@ -93,7 +105,7 @@ describe("remapDimensionMappings", () => {
it("inherits sibling dimension for a new slot with same sourceId", () => {
const next = [metric(REVENUE), metric(REVENUE)]; // second instance added
- const tab = makeTab({
+ const dimensionBreakout = makeDimensionBreakout({
dimensionMapping: { 0: "created_at" },
});
const slotMapping = new Map([
@@ -101,7 +113,11 @@ describe("remapDimensionMappings", () => {
// slot 1 is new — not in the mapping
]);
- const result = remapDimensionMappings([tab], slotMapping, next);
+ const result = remapDimensionMappings(
+ [dimensionBreakout],
+ slotMapping,
+ next,
+ );
expect(result[0].dimensionMapping).toEqual({
0: "created_at",
@@ -111,7 +127,7 @@ describe("remapDimensionMappings", () => {
it("does not add mapping for a brand-new metric with no sibling", () => {
const next = [metric(REVENUE), metric(ORDERS)]; // Orders is new
- const tab = makeTab({
+ const dimensionBreakout = makeDimensionBreakout({
dimensionMapping: { 0: "created_at" },
});
const slotMapping = new Map([
@@ -119,19 +135,23 @@ describe("remapDimensionMappings", () => {
// slot 1 (Orders) is new with no sibling
]);
- const result = remapDimensionMappings([tab], slotMapping, next);
+ const result = remapDimensionMappings(
+ [dimensionBreakout],
+ slotMapping,
+ next,
+ );
expect(result[0].dimensionMapping).toEqual({ 0: "created_at" });
});
- it("reconciles multiple tabs independently", () => {
+ it("reconciles multiple dimensionBreakouts independently", () => {
const next = [metric(ORDERS), metric(REVENUE)]; // swapped
- const tab1 = makeTab({
- id: "tab-1",
+ const dimensionBreakout1 = makeDimensionBreakout({
+ id: "dimensionBreakout-1",
dimensionMapping: { 0: "dim-rev", 1: "dim-ord" },
});
- const tab2 = makeTab({
- id: "tab-2",
+ const dimensionBreakout2 = makeDimensionBreakout({
+ id: "dimensionBreakout-2",
dimensionMapping: { 0: "cat-rev", 1: "cat-ord" },
});
const slotMapping = new Map([
@@ -139,7 +159,11 @@ describe("remapDimensionMappings", () => {
[1, 0],
]);
- const result = remapDimensionMappings([tab1, tab2], slotMapping, next);
+ const result = remapDimensionMappings(
+ [dimensionBreakout1, dimensionBreakout2],
+ slotMapping,
+ next,
+ );
expect(result[0].dimensionMapping).toEqual({
0: "dim-ord",
@@ -153,22 +177,32 @@ describe("remapDimensionMappings", () => {
it("handles empty slot mapping (all entities new)", () => {
const next = [metric(REVENUE)];
- const tab = makeTab({ dimensionMapping: { 0: "created_at" } });
+ const dimensionBreakout = makeDimensionBreakout({
+ dimensionMapping: { 0: "created_at" },
+ });
const slotMapping = new Map<number, number>();
- const result = remapDimensionMappings([tab], slotMapping, next);
+ const result = remapDimensionMappings(
+ [dimensionBreakout],
+ slotMapping,
+ next,
+ );
expect(result[0].dimensionMapping).toEqual({});
});
it("inherits null dimension from sibling", () => {
const next = [metric(REVENUE), metric(REVENUE)];
- const tab = makeTab({
+ const dimensionBreakout = makeDimensionBreakout({
dimensionMapping: { 0: null },
});
const slotMapping = new Map([[0, 0]]);
- const result = remapDimensionMappings([tab], slotMapping, next);
+ const result = remapDimensionMappings(
+ [dimensionBreakout],
+ slotMapping,
+ next,
+ );
expect(result[0].dimensionMapping).toEqual({
0: null,
diff --git a/frontend/src/metabase/metrics-viewer/utils/series.ts b/frontend/src/metabase/metrics-viewer/utils/series.ts
index e420541fca7..81d5da31685 100644
--- a/frontend/src/metabase/metrics-viewer/utils/series.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/series.ts
@@ -54,10 +54,10 @@ import {
getEffectiveDefinitionEntry,
getEntryBreakout,
} from "./definition-entries";
+import { DISPLAY_TYPE_REGISTRY } from "./dimension-breakout-config";
+import { getDimensionIcon } from "./dimension-breakouts";
import { type MetricSlot, slotsForEntity } from "./metric-slots";
import { nextSyntheticCardId, parseSourceId } from "./source-ids";
-import { DISPLAY_TYPE_REGISTRY } from "./tab-config";
-import { getDimensionIcon } from "./tabs";
export function shouldShowStackSeries(
display: MetricsViewerDisplayType,
@@ -352,7 +352,7 @@ export const DIMENSION_COLUMN_INDEX = 0;
export const BREAKOUT_COLUMN_INDEX = 1;
export const METRIC_COLUMN_INDEX = 2;
-// When the breakout dimension is the same as the tab's dimension,
+// When the breakout dimension is the same as the dimension breakout's dimension,
// the query avoids adding it twice, so we get [breakout, metric] instead of [dimension, breakout, metric].
function getBreakoutColumnDescriptor(cols: DatasetColumn[]): {
index: number;
diff --git a/frontend/src/metabase/metrics-viewer/utils/tabs.unit.spec.ts b/frontend/src/metabase/metrics-viewer/utils/tabs.unit.spec.ts
deleted file mode 100644
index 7ca3249b06a..00000000000
--- a/frontend/src/metabase/metrics-viewer/utils/tabs.unit.spec.ts
+++ /dev/null
@@ -1,161 +0,0 @@
-import type { MetricSourceId } from "../types/viewer-state";
-
-import {
- createMetricMetadata,
- createMockMetricDimension,
- createMockNormalizedMetric,
- setupDefinition,
-} from "./__tests__/test-helpers";
-import type {
- AvailableDimension,
- AvailableDimensionsResult,
-} from "./dimension-picker";
-import { buildDimensionPickerSections } from "./dimension-picker";
-import { computeDefaultTabs, resolveCommonTabLabel } from "./tabs";
-
-describe("resolveCommonTabLabel", () => {
- it("returns null for empty array", () => {
- expect(resolveCommonTabLabel([])).toBeNull();
- });
-
- it("returns the name when only one is provided", () => {
- expect(resolveCommonTabLabel(["Created At"])).toBe("Created At");
- });
-
- it("returns the name when all names are identical", () => {
- expect(resolveCommonTabLabel(["Created At", "Created At"])).toBe(
- "Created At",
- );
- });
-
- it("returns the most frequent name", () => {
- expect(
- resolveCommonTabLabel(["Created At", "Order Date", "Created At"]),
- ).toBe("Created At");
- });
-
- it("returns the first name when tied", () => {
- expect(resolveCommonTabLabel(["State", "Category"])).toBe("State");
- });
-
- it("returns the first name when two different names are tied", () => {
- expect(resolveCommonTabLabel(["Created At", "Order Date"])).toBe(
- "Created At",
- );
- });
-});
-
-describe("computeDefaultTabs", () => {
- const CATEGORY_SELECTION_METRIC = createMockNormalizedMetric({
- id: 101,
- name: "Category Selection",
- dimensions: [
- createMockMetricDimension({
- id: "dim-category",
- display_name: "Category",
- effective_type: "type/Text",
- semantic_type: "type/Category",
- }),
- createMockMetricDimension({
- id: "dim-status",
- display_name: "Status",
- effective_type: "type/Text",
- semantic_type: null,
- }),
- ],
- });
-
- const sourceId: MetricSourceId = `metric:${CATEGORY_SELECTION_METRIC.id}`;
- const metadata = createMetricMetadata([CATEGORY_SELECTION_METRIC]);
- const definition = setupDefinition(metadata, CATEGORY_SELECTION_METRIC.id);
-
- it("only auto-creates category tabs for preferred category dimensions", () => {
- const tabs = computeDefaultTabs({ [sourceId]: definition }, [
- { slotIndex: 0, entityIndex: 0, sourceId },
- ]);
-
- // Status should not be included because it's not preferred
- expect(tabs.map((tab) => tab.label)).toEqual(["Category", "Totals"]);
- });
-});
-
-function createMockAvailableDimension(label: string): AvailableDimension {
- return {
- icon: "string",
- tabInfo: {
- type: "category",
- label,
- dimensionMapping: {},
- },
- };
-}
-
-describe("buildDimensionPickerSections", () => {
- it("builds flat sections for a single source without groups", () => {
- const dimensions: AvailableDimensionsResult = {
- shared: [],
- bySource: {
- "metric:1": [
- createMockAvailableDimension("Category"),
- createMockAvailableDimension("State"),
- ],
- },
- };
-
- const sections = buildDimensionPickerSections({
- availableDimensions: dimensions,
- sourceOrder: ["metric:1"],
- sourceDataById: {
- "metric:1": { type: "metric", name: "Revenue" },
- },
- hasMultipleSources: false,
- });
-
- expect(sections).toEqual([
- {
- name: undefined,
- items: [
- expect.objectContaining({ name: "Category" }),
- expect.objectContaining({ name: "State" }),
- ],
- },
- ]);
- });
-
- it("splits by source and includes shared section for multiple sources", () => {
- const sharedDimension = createMockAvailableDimension("Created At");
-
- const dimensions: AvailableDimensionsResult = {
- shared: [sharedDimension],
- bySource: {
- "metric:1": [createMockAvailableDimension("Category")],
- "metric:2": [createMockAvailableDimension("Status")],
- },
- };
-
- const sections = buildDimensionPickerSections({
- availableDimensions: dimensions,
- sourceOrder: ["metric:1", "metric:2"],
- sourceDataById: {
- "metric:1": { type: "metric", name: "Revenue" },
- "metric:2": { type: "metric", name: "Orders" },
- },
- hasMultipleSources: true,
- });
-
- expect(sections).toEqual([
- {
- name: "Shared",
- items: [expect.objectContaining({ name: "Created At" })],
- },
- {
- name: "Revenue",
- items: [expect.objectContaining({ name: "Category" })],
- },
- {
- name: "Orders",
- items: [expect.objectContaining({ name: "Status" })],
- },
- ]);
- });
-});
diff --git a/frontend/src/metabase/metrics-viewer/utils/url-serialization.ts b/frontend/src/metabase/metrics-viewer/utils/url-serialization.ts
index f8ce81e28c8..2fe546ae120 100644
--- a/frontend/src/metabase/metrics-viewer/utils/url-serialization.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/url-serialization.ts
@@ -14,11 +14,11 @@ import type {
MetricExpressionId,
MetricSourceId,
MetricsViewerDefinitionEntry,
+ MetricsViewerDimensionBreakoutState,
+ MetricsViewerDimensionBreakoutType,
MetricsViewerDisplayType,
MetricsViewerFormulaEntity,
MetricsViewerPageState,
- MetricsViewerTabState,
- MetricsViewerTabType,
} from "../types/viewer-state";
import { isExpressionEntry, isMetricEntry } from "../types/viewer-state";
import {
@@ -183,7 +183,7 @@ interface SerializedSource {
type SerializedFormulaEntity = SerializedExpressionEntry | SerializedSource;
-interface SerializedTabDef {
+interface SerializedDimensionBreakoutDef {
slotIndex: number;
dimensionId?: string;
}
@@ -194,20 +194,22 @@ interface SerializedProjectionConfig {
binning?: string;
}
-interface SerializedTab {
+interface SerializedDimensionBreakout {
id: string;
- type: MetricsViewerTabType;
+ type: MetricsViewerDimensionBreakoutType;
label: string | null;
display: MetricsViewerDisplayType;
+ showColumnLabels?: boolean;
visualizationSettings?: Partial<VisualizationSettings>;
- definitions: SerializedTabDef[];
+ definitions: SerializedDimensionBreakoutDef[];
projectionConfig?: SerializedProjectionConfig;
}
export interface SerializedMetricsViewerPageState {
formulaEntities: SerializedFormulaEntity[];
- tabs: SerializedTab[];
- selectedTabId: string | null;
+ dimensionBreakouts: SerializedDimensionBreakout[];
+ selectedDimensionBreakoutId: string | null;
+ showColumnLabels?: boolean;
}
// ── Expression sub-token helpers ──
@@ -330,24 +332,26 @@ function definitionToSource(def: MetricDefinition): SerializedSource | null {
return null;
}
-function tabToSerializedTab(tab: MetricsViewerTabState): SerializedTab {
+function dimensionBreakoutToSerializedDimensionBreakout(
+ dimensionBreakout: MetricsViewerDimensionBreakoutState,
+): SerializedDimensionBreakout {
const { dimensionFilter, temporalUnit, binningStrategy } =
- tab.projectionConfig;
+ dimensionBreakout.projectionConfig;
const hasProjectionConfig =
dimensionFilter !== undefined ||
temporalUnit !== undefined ||
binningStrategy;
return {
- id: tab.id,
- type: tab.type,
- label: tab.label,
- display: tab.display,
- ...(tab.visualizationSettings &&
- Object.keys(tab.visualizationSettings).length > 0
- ? { visualizationSettings: tab.visualizationSettings }
+ id: dimensionBreakout.id,
+ type: dimensionBreakout.type,
+ label: dimensionBreakout.label,
+ display: dimensionBreakout.display,
+ ...(dimensionBreakout.visualizationSettings &&
+ Object.keys(dimensionBreakout.visualizationSettings).length > 0
+ ? { visualizationSettings: dimensionBreakout.visualizationSettings }
: {}),
- definitions: getObjectEntries(tab.dimensionMapping).map(
+ definitions: getObjectEntries(dimensionBreakout.dimensionMapping).map(
([key, dimensionId]) => ({
slotIndex: Number(key),
...(dimensionId != null ? { dimensionId } : {}),
@@ -363,27 +367,53 @@ function tabToSerializedTab(tab: MetricsViewerTabState): SerializedTab {
};
}
-export function deserializeTab(
- serializedTab: SerializedTab,
-): MetricsViewerTabState {
+function getSerializableDimensionBreakouts(state: MetricsViewerPageState) {
+ const selectedDimensionBreakout = state.dimensionBreakouts.find(
+ (dimensionBreakout) =>
+ dimensionBreakout.id === state.selectedDimensionBreakoutId,
+ );
+
+ if (!selectedDimensionBreakout) {
+ return {
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
+ };
+ }
+
+ return {
+ dimensionBreakouts: [selectedDimensionBreakout],
+ selectedDimensionBreakoutId: selectedDimensionBreakout.id,
+ };
+}
+
+export function deserializeDimensionBreakout(
+ serializedDimensionBreakout: SerializedDimensionBreakout,
+): MetricsViewerDimensionBreakoutState {
const dimensionMapping: Record<number, string | null> = {};
- for (const serializedDefinition of serializedTab.definitions) {
+ for (const serializedDefinition of serializedDimensionBreakout.definitions) {
dimensionMapping[serializedDefinition.slotIndex] =
serializedDefinition.dimensionId ?? null;
}
return {
- id: serializedTab.id,
- type: serializedTab.type,
- label: serializedTab.label,
- display: serializedTab.display,
- ...(serializedTab.visualizationSettings
- ? { visualizationSettings: serializedTab.visualizationSettings }
+ id: serializedDimensionBreakout.id,
+ type: serializedDimensionBreakout.type,
+ label: serializedDimensionBreakout.label,
+ display: serializedDimensionBreakout.display,
+ ...(serializedDimensionBreakout.showColumnLabels === true
+ ? { showColumnLabels: true }
+ : {}),
+ ...(serializedDimensionBreakout.visualizationSettings
+ ? {
+ visualizationSettings:
+ serializedDimensionBreakout.visualizationSettings,
+ }
: {}),
dimensionMapping,
projectionConfig: {
- dimensionFilter: serializedTab.projectionConfig?.dimensionFilter,
- temporalUnit: serializedTab.projectionConfig?.temporalUnit,
- binningStrategy: serializedTab.projectionConfig?.binning,
+ dimensionFilter:
+ serializedDimensionBreakout.projectionConfig?.dimensionFilter,
+ temporalUnit: serializedDimensionBreakout.projectionConfig?.temporalUnit,
+ binningStrategy: serializedDimensionBreakout.projectionConfig?.binning,
},
};
}
@@ -468,6 +498,8 @@ export function stateToSerializedState(
state: MetricsViewerPageState,
): SerializedMetricsViewerPageState {
const formulaEntities: SerializedFormulaEntity[] = [];
+ const { dimensionBreakouts, selectedDimensionBreakoutId } =
+ getSerializableDimensionBreakouts(state);
for (const entity of state.formulaEntities) {
if (isMetricEntry(entity)) {
@@ -497,8 +529,11 @@ export function stateToSerializedState(
return {
formulaEntities,
- tabs: state.tabs.map(tabToSerializedTab),
- selectedTabId: state.selectedTabId,
+ dimensionBreakouts: dimensionBreakouts.map(
+ dimensionBreakoutToSerializedDimensionBreakout,
+ ),
+ selectedDimensionBreakoutId,
+ ...(state.showColumnLabels ? { showColumnLabels: true } : {}),
};
}
@@ -531,10 +566,11 @@ const formulaEntitySchema = defineCompactSchema<SerializedFormulaEntity>({
tokens: { key: "T", schema: expressionSubTokenSchema, optional: true },
});
-const tabDefSchema = defineCompactSchema<SerializedTabDef>({
- slotIndex: "i",
- dimensionId: { key: "d", optional: true },
-});
+const dimensionBreakoutDefSchema =
+ defineCompactSchema<SerializedDimensionBreakoutDef>({
+ slotIndex: "i",
+ dimensionId: { key: "d", optional: true },
+ });
const projectionConfigSchema = defineCompactSchema<SerializedProjectionConfig>({
dimensionFilter: { key: "f", optional: true },
@@ -542,30 +578,46 @@ const projectionConfigSchema = defineCompactSchema<SerializedProjectionConfig>({
binning: { key: "b", optional: true },
});
-const tabSchema = defineCompactSchema<SerializedTab>({
- id: "i",
- type: "t",
- label: { key: "l", default: null },
- display: { key: "d", default: "line" },
- visualizationSettings: { key: "V", optional: true },
- definitions: { key: "D", schema: tabDefSchema, default: [] },
- projectionConfig: {
- key: "p",
- schema: projectionConfigSchema,
- optional: true,
- },
-});
+const dimensionBreakoutSchema =
+ defineCompactSchema<SerializedDimensionBreakout>({
+ id: "i",
+ type: "t",
+ label: { key: "l", default: null },
+ display: { key: "d", default: "line" },
+ showColumnLabels: { key: "c", optional: true },
+ visualizationSettings: { key: "V", optional: true },
+ definitions: {
+ key: "D",
+ schema: dimensionBreakoutDefSchema,
+ default: [],
+ },
+ projectionConfig: {
+ key: "p",
+ schema: projectionConfigSchema,
+ optional: true,
+ },
+ });
const rootSchema = defineCompactSchema<SerializedMetricsViewerPageState>({
formulaEntities: { key: "f", schema: formulaEntitySchema, default: [] },
- tabs: { key: "t", schema: tabSchema, default: [] },
- selectedTabId: { key: "a", default: null },
+ dimensionBreakouts: {
+ key: "t",
+ schema: dimensionBreakoutSchema,
+ default: [],
+ },
+ selectedDimensionBreakoutId: { key: "a", default: null },
+ showColumnLabels: { key: "c", optional: true },
});
// ── Encode / decode ──
function emptyState(): SerializedMetricsViewerPageState {
- return { formulaEntities: [], tabs: [], selectedTabId: null };
+ return {
+ formulaEntities: [],
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
+ showColumnLabels: false,
+ };
}
// After JSON.parse, Date values are ISO strings. Walk the decoded state and revive them.
@@ -603,18 +655,18 @@ function reviveStateDates(
}
return entity;
}),
- tabs: state.tabs.map((tab) =>
- tab.projectionConfig?.dimensionFilter
+ dimensionBreakouts: state.dimensionBreakouts.map((dimensionBreakout) =>
+ dimensionBreakout.projectionConfig?.dimensionFilter
? {
- ...tab,
+ ...dimensionBreakout,
projectionConfig: {
- ...tab.projectionConfig,
+ ...dimensionBreakout.projectionConfig,
dimensionFilter: reviveFilter(
- tab.projectionConfig.dimensionFilter,
+ dimensionBreakout.projectionConfig.dimensionFilter,
),
},
}
- : tab,
+ : dimensionBreakout,
),
};
}
diff --git a/frontend/src/metabase/metrics-viewer/utils/url-serialization.unit.spec.ts b/frontend/src/metabase/metrics-viewer/utils/url-serialization.unit.spec.ts
index c89b115fed3..ead74c86067 100644
--- a/frontend/src/metabase/metrics-viewer/utils/url-serialization.unit.spec.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/url-serialization.unit.spec.ts
@@ -1,9 +1,15 @@
+import type {
+ MetricsViewerDimensionBreakoutState,
+ MetricsViewerPageState,
+} from "../types";
+
import type { DimensionFilterValue } from "./dimension-filters";
import {
type SerializedMetricsViewerPageState,
decodeState,
deserializeFormulaEntities,
encodeState,
+ stateToSerializedState,
} from "./url-serialization";
function encodeStateOrThrow(state: SerializedMetricsViewerPageState): string {
@@ -14,17 +20,44 @@ function encodeStateOrThrow(state: SerializedMetricsViewerPageState): string {
return result;
}
+function createBreakout(
+ overrides: Partial<MetricsViewerDimensionBreakoutState> = {},
+): MetricsViewerDimensionBreakoutState {
+ return {
+ id: "time",
+ type: "time",
+ label: "Time",
+ display: "line",
+ dimensionMapping: { 0: "created_at" },
+ projectionConfig: {},
+ ...overrides,
+ };
+}
+
+function createPageState(
+ overrides: Partial<MetricsViewerPageState> = {},
+): MetricsViewerPageState {
+ return {
+ definitions: {},
+ formulaEntities: [],
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
+ showColumnLabels: false,
+ ...overrides,
+ };
+}
+
describe("url-serialization", () => {
describe("encodeState / decodeState round-trip", () => {
- it("round-trips a state with formula entities and tabs", () => {
+ it("round-trips a state with formula entities and dimensionBreakouts", () => {
const state: SerializedMetricsViewerPageState = {
formulaEntities: [
{ type: "metric", id: 1, breakout: "dim-1" },
{ type: "measure", id: 42 },
],
- tabs: [
+ dimensionBreakouts: [
{
- id: "tab-1",
+ id: "dimensionBreakout-1",
type: "time",
label: "By Month",
display: "bar",
@@ -34,7 +67,28 @@ describe("url-serialization", () => {
},
},
],
- selectedTabId: "tab-1",
+ selectedDimensionBreakoutId: "dimensionBreakout-1",
+ };
+
+ const hash = encodeStateOrThrow(state);
+ const decoded = decodeState(hash);
+ expect(decoded).toEqual(state);
+ });
+
+ it("round-trips enabled column labels", () => {
+ const state: SerializedMetricsViewerPageState = {
+ formulaEntities: [{ type: "metric", id: 1 }],
+ showColumnLabels: true,
+ dimensionBreakouts: [
+ {
+ id: "dimensionBreakout-1",
+ type: "time",
+ label: "By Month",
+ display: "line",
+ definitions: [{ slotIndex: 0, dimensionId: "created_at" }],
+ },
+ ],
+ selectedDimensionBreakoutId: "dimensionBreakout-1",
};
const hash = encodeStateOrThrow(state);
@@ -52,8 +106,8 @@ describe("url-serialization", () => {
breakoutTemporalUnit: "year",
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -71,8 +125,8 @@ describe("url-serialization", () => {
breakoutBinning: "50 bins",
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -91,8 +145,8 @@ describe("url-serialization", () => {
breakoutBinning: "Auto bin",
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -103,8 +157,8 @@ describe("url-serialization", () => {
it("round-trips an empty state", () => {
const state: SerializedMetricsViewerPageState = {
formulaEntities: [],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -131,8 +185,8 @@ describe("url-serialization", () => {
],
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -149,8 +203,8 @@ describe("url-serialization", () => {
segments: [42],
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -167,8 +221,8 @@ describe("url-serialization", () => {
segments: [11, 7, 23],
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -200,8 +254,8 @@ describe("url-serialization", () => {
segments: [42],
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -227,8 +281,8 @@ describe("url-serialization", () => {
],
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -241,8 +295,8 @@ describe("url-serialization", () => {
// round-trip still works and leaves segments undefined.
const state: SerializedMetricsViewerPageState = {
formulaEntities: [{ type: "metric", id: 1, breakout: "dim-1" }],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
const decoded = decodeState(hash);
@@ -256,8 +310,8 @@ describe("url-serialization", () => {
it("propagates decoded segments into serializedDefinitionInfo on the entity", () => {
const state: SerializedMetricsViewerPageState = {
formulaEntities: [{ type: "metric", id: 5, segments: [42] }],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
const decoded = decodeState(hash);
@@ -286,8 +340,8 @@ describe("url-serialization", () => {
],
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -316,8 +370,8 @@ describe("url-serialization", () => {
],
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -353,8 +407,8 @@ describe("url-serialization", () => {
],
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -367,16 +421,18 @@ describe("url-serialization", () => {
it("returns empty state for empty string", () => {
expect(decodeState("")).toEqual({
formulaEntities: [],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
+ showColumnLabels: false,
});
});
it("returns empty state for invalid base64", () => {
expect(decodeState("!!!not-valid-base64!!!")).toEqual({
formulaEntities: [],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
+ showColumnLabels: false,
});
});
@@ -384,8 +440,9 @@ describe("url-serialization", () => {
const hash = btoa("not json");
expect(decodeState(hash)).toEqual({
formulaEntities: [],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
+ showColumnLabels: false,
});
});
@@ -396,20 +453,128 @@ describe("url-serialization", () => {
});
});
+ describe("stateToSerializedState", () => {
+ it("serializes only the selected dimension breakout", () => {
+ const selectedBreakout = createBreakout({
+ id: "category",
+ type: "category",
+ label: "Category",
+ display: "bar",
+ dimensionMapping: { 0: "category" },
+ });
+ const state = createPageState({
+ dimensionBreakouts: [
+ createBreakout({ id: "time" }),
+ selectedBreakout,
+ createBreakout({ id: "geo", type: "geo", label: "Country" }),
+ ],
+ selectedDimensionBreakoutId: selectedBreakout.id,
+ });
+
+ expect(stateToSerializedState(state)).toEqual({
+ formulaEntities: [],
+ dimensionBreakouts: [
+ {
+ id: "category",
+ type: "category",
+ label: "Category",
+ display: "bar",
+ definitions: [{ slotIndex: 0, dimensionId: "category" }],
+ },
+ ],
+ selectedDimensionBreakoutId: "category",
+ });
+ });
+
+ it("preserves the selected dimension breakout configuration", () => {
+ const state = createPageState({
+ dimensionBreakouts: [
+ createBreakout({ id: "inactive" }),
+ createBreakout({
+ id: "selected",
+ label: "Orders by month",
+ display: "area",
+ dimensionMapping: { 0: "created_at", 1: null },
+ projectionConfig: {
+ temporalUnit: "month",
+ binningStrategy: "10 bins",
+ dimensionFilter: {
+ type: "string",
+ operator: "=",
+ values: ["Widget"],
+ options: {},
+ },
+ },
+ visualizationSettings: { "graph.show_values": true },
+ }),
+ ],
+ selectedDimensionBreakoutId: "selected",
+ });
+
+ expect(stateToSerializedState(state).dimensionBreakouts).toEqual([
+ {
+ id: "selected",
+ type: "time",
+ label: "Orders by month",
+ display: "area",
+ visualizationSettings: { "graph.show_values": true },
+ definitions: [
+ { slotIndex: 0, dimensionId: "created_at" },
+ { slotIndex: 1 },
+ ],
+ projectionConfig: {
+ temporalUnit: "month",
+ binning: "10 bins",
+ dimensionFilter: {
+ type: "string",
+ operator: "=",
+ values: ["Widget"],
+ options: {},
+ },
+ },
+ },
+ ]);
+ });
+
+ it("serializes no dimension breakouts when none is selected", () => {
+ const state = createPageState({
+ dimensionBreakouts: [createBreakout({ id: "time" })],
+ selectedDimensionBreakoutId: null,
+ });
+
+ expect(stateToSerializedState(state)).toMatchObject({
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
+ });
+ });
+
+ it("clears the selected dimension breakout ID when it does not exist", () => {
+ const state = createPageState({
+ dimensionBreakouts: [createBreakout({ id: "time" })],
+ selectedDimensionBreakoutId: "missing",
+ });
+
+ expect(stateToSerializedState(state)).toMatchObject({
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
+ });
+ });
+ });
+
describe("Unicode round-trip", () => {
- it("survives non-ASCII metric labels in tabs", () => {
+ it("survives non-ASCII metric labels in dimensionBreakouts", () => {
const state: SerializedMetricsViewerPageState = {
formulaEntities: [{ type: "metric", id: 1 }],
- tabs: [
+ dimensionBreakouts: [
{
- id: "tab-1",
+ id: "dimensionBreakout-1",
type: "time",
label: "Ré\u00e9venues par mois \u2014 \u00e9t\u00e9",
display: "line",
definitions: [],
},
],
- selectedTabId: "tab-1",
+ selectedDimensionBreakoutId: "dimensionBreakout-1",
};
const hash = encodeStateOrThrow(state);
@@ -420,16 +585,16 @@ describe("url-serialization", () => {
it("survives CJK characters", () => {
const state: SerializedMetricsViewerPageState = {
formulaEntities: [{ type: "metric", id: 1 }],
- tabs: [
+ dimensionBreakouts: [
{
- id: "tab-1",
+ id: "dimensionBreakout-1",
type: "category",
label: "\u6708\u5225\u58f2\u4e0a",
display: "bar",
definitions: [],
},
],
- selectedTabId: null,
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -440,16 +605,16 @@ describe("url-serialization", () => {
it("survives emoji characters", () => {
const state: SerializedMetricsViewerPageState = {
formulaEntities: [{ type: "metric", id: 1 }],
- tabs: [
+ dimensionBreakouts: [
{
- id: "tab-1",
+ id: "dimensionBreakout-1",
type: "time",
label: "\ud83d\udcc8 Revenue",
display: "line",
definitions: [],
},
],
- selectedTabId: null,
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -468,8 +633,8 @@ describe("url-serialization", () => {
filters: [{ dimensionId: "created_at", value: filter }],
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const decoded = decodeState(encodeStateOrThrow(state));
const entity = decoded.formulaEntities[0];
@@ -495,8 +660,8 @@ describe("url-serialization", () => {
],
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const decoded = decodeState(encodeStateOrThrow(state));
const entity = decoded.formulaEntities[0];
@@ -598,8 +763,8 @@ describe("url-serialization", () => {
filters: [{ dimensionId: "price", value: filter }],
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const decoded = decodeState(encodeStateOrThrow(state));
@@ -626,9 +791,9 @@ describe("url-serialization", () => {
],
},
],
- tabs: [
+ dimensionBreakouts: [
{
- id: "tab-time",
+ id: "dimensionBreakout-time",
type: "time",
label: "By Time",
display: "line",
@@ -638,7 +803,7 @@ describe("url-serialization", () => {
],
},
],
- selectedTabId: "tab-time",
+ selectedDimensionBreakoutId: "dimensionBreakout-time",
};
const hash = encodeStateOrThrow(state);
@@ -688,8 +853,8 @@ describe("url-serialization", () => {
],
},
],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
};
const hash = encodeStateOrThrow(state);
@@ -697,7 +862,7 @@ describe("url-serialization", () => {
expect(decoded).toEqual(state);
});
- it("preserves per-slot dimension mappings when same metric has different breakouts across multiple tabs", () => {
+ it("preserves per-slot dimension mappings when same metric has different breakouts across multiple dimensionBreakouts", () => {
const state: SerializedMetricsViewerPageState = {
formulaEntities: [
{
@@ -711,9 +876,9 @@ describe("url-serialization", () => {
],
},
],
- tabs: [
+ dimensionBreakouts: [
{
- id: "tab-time",
+ id: "dimensionBreakout-time",
type: "time",
label: "By Time",
display: "line",
@@ -723,7 +888,7 @@ describe("url-serialization", () => {
],
},
{
- id: "tab-cat",
+ id: "dimensionBreakout-cat",
type: "category",
label: "By Category",
display: "bar",
@@ -733,7 +898,7 @@ describe("url-serialization", () => {
],
},
],
- selectedTabId: "tab-cat",
+ selectedDimensionBreakoutId: "dimensionBreakout-cat",
};
const hash = encodeStateOrThrow(state);
@@ -761,9 +926,9 @@ describe("url-serialization", () => {
],
},
],
- tabs: [
+ dimensionBreakouts: [
{
- id: "tab-time",
+ id: "dimensionBreakout-time",
type: "time",
label: "By Month",
display: "line",
@@ -774,7 +939,7 @@ describe("url-serialization", () => {
],
},
],
- selectedTabId: "tab-time",
+ selectedDimensionBreakoutId: "dimensionBreakout-time",
};
const hash = encodeStateOrThrow(state);
@@ -789,7 +954,7 @@ describe("url-serialization", () => {
const second = decodeState("");
expect(first).not.toBe(second);
expect(first.formulaEntities).not.toBe(second.formulaEntities);
- expect(first.tabs).not.toBe(second.tabs);
+ expect(first.dimensionBreakouts).not.toBe(second.dimensionBreakouts);
});
});
@@ -799,8 +964,8 @@ describe("url-serialization", () => {
): SerializedMetricsViewerPageState {
return {
formulaEntities: [],
- tabs: [],
- selectedTabId: null,
+ dimensionBreakouts: [],
+ selectedDimensionBreakoutId: null,
...overrides,
};
}
diff --git a/frontend/src/metabase/ui/components/icons/Icon/icons/index.ts b/frontend/src/metabase/ui/components/icons/Icon/icons/index.ts
index 7cbe60625b8..582ab053e63 100644
--- a/frontend/src/metabase/ui/components/icons/Icon/icons/index.ts
+++ b/frontend/src/metabase/ui/components/icons/Icon/icons/index.ts
@@ -460,6 +460,8 @@ import slack_component from "./slack.svg?component";
import slack_source from "./slack.svg?source";
import slack_colorized_component from "./slack_colorized.svg?component";
import slack_colorized_source from "./slack_colorized.svg?source";
+import sliders_component from "./sliders.svg?component";
+import sliders_source from "./sliders.svg?source";
import smartscalar_component from "./smartscalar.svg?component";
import smartscalar_source from "./smartscalar.svg?source";
import smile_component from "./smile.svg?component";
@@ -1519,6 +1521,10 @@ export const Icons: Record<IconName, { component: React.VFC; source: string }> =
component: slack_colorized_component,
source: slack_colorized_source,
},
+ sliders: {
+ component: sliders_component,
+ source: sliders_source,
+ },
smartscalar: {
component: smartscalar_component,
source: smartscalar_source,
diff --git a/frontend/src/metabase/ui/components/icons/Icon/icons/sliders.svg b/frontend/src/metabase/ui/components/icons/Icon/icons/sliders.svg
new file mode 100644
index 00000000000..6deb0757d0c
--- /dev/null
+++ b/frontend/src/metabase/ui/components/icons/Icon/icons/sliders.svg
@@ -0,0 +1,8 @@
+<svg viewBox="0 0 16 16" fill="none">
+ <path d="M4 2.5v11" stroke="currentColor" stroke-width="1.5" />
+ <path d="M8 2.5v11" stroke="currentColor" stroke-width="1.5" />
+ <path d="M12 2.5v11" stroke="currentColor" stroke-width="1.5" />
+ <circle cx="4" cy="6" r="1.5" fill="currentColor" />
+ <circle cx="8" cy="10" r="1.5" fill="currentColor" />
+ <circle cx="12" cy="5" r="1.5" fill="currentColor" />
+</svg>
diff --git a/frontend/src/metabase/urls/metrics.ts b/frontend/src/metabase/urls/metrics.ts
index 0373cd4ce49..03b73b202f3 100644
--- a/frontend/src/metabase/urls/metrics.ts
+++ b/frontend/src/metabase/urls/metrics.ts
@@ -43,7 +43,7 @@ export function exploreMetricDimension({
}: ExploreMetricDimensionOptions): string {
const state: SerializedMetricsViewerPageState = {
formulaEntities: [{ type: "metric", id: metricId }],
- tabs: [
+ dimensionBreakouts: [
{
id: dimensionId,
type: dimensionType,
@@ -52,7 +52,7 @@ export function exploreMetricDimension({
definitions: [{ slotIndex: 0, dimensionId }],
},
],
- selectedTabId: dimensionId,
+ selectedDimensionBreakoutId: dimensionId,
};
const hash = encodeState(state);
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/model/dataset.ts b/frontend/src/metabase/visualizations/echarts/cartesian/model/dataset.ts
index 48c9f4c2e16..ffa3a763cd0 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/model/dataset.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/model/dataset.ts
@@ -521,13 +521,33 @@ function getBarSeriesDataLabelTransform(
function getBarSeriesZeroToNullTransform(
barSeriesModels: SeriesModel[],
): ConditionalTransform {
+ const dataKeysWithNonZeroValues = new Set<DataKey>();
+ let hasCheckedNonZeroValues = false;
+
return {
condition: barSeriesModels.length > 0,
- fn: (datum: Datum) => {
+ fn: (datum: Datum, _index: number, dataset: ChartDataset) => {
+ if (!hasCheckedNonZeroValues) {
+ barSeriesModels.forEach(({ dataKey }) => {
+ if (
+ dataset.some(
+ (datum) =>
+ typeof datum[dataKey] === "number" && datum[dataKey] !== 0,
+ )
+ ) {
+ dataKeysWithNonZeroValues.add(dataKey);
+ }
+ });
+ hasCheckedNonZeroValues = true;
+ }
+
const transforedDatum = { ...datum };
barSeriesModels.forEach(({ dataKey }) => {
- transforedDatum[dataKey] = datum[dataKey] === 0 ? null : datum[dataKey];
+ transforedDatum[dataKey] =
+ dataKeysWithNonZeroValues.has(dataKey) && datum[dataKey] === 0
+ ? null
+ : datum[dataKey];
});
return transforedDatum;
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/model/dataset.unit.spec.ts b/frontend/src/metabase/visualizations/echarts/cartesian/model/dataset.unit.spec.ts
index 42dd7eaa106..af6cc32a2e8 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/model/dataset.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/model/dataset.unit.spec.ts
@@ -42,6 +42,7 @@ import type {
TimeSeriesXAxisModel,
XAxisModel,
} from "./types";
+import { getBarSeriesDataLabelKey } from "./util";
const createMockComputedVisualizationSettings = (
opts: Partial<ComputedVisualizationSettings> = {},
@@ -513,6 +514,90 @@ describe("dataset transform functions", () => {
]);
});
+ it("should replace bar series zero values with nulls when the series has non-zero values", () => {
+ const dataset = [
+ {
+ [X_AXIS_DATA_KEY]: "A",
+ series1: 0,
+ },
+ {
+ [X_AXIS_DATA_KEY]: "B",
+ series1: 10,
+ },
+ ];
+
+ const result = applyVisualizationSettingsDataTransformations(
+ dataset,
+ [],
+ xAxisModel,
+ [createMockSeriesModel({ dataKey: "series1" })],
+ [],
+ yAxisScaleTransforms,
+ createMockComputedVisualizationSettings({
+ series: () => ({ display: "bar" }),
+ }),
+ );
+
+ expect(result).toEqual([
+ {
+ [INDEX_KEY]: 0,
+ [X_AXIS_DATA_KEY]: "A",
+ [X_AXIS_RAW_VALUE_DATA_KEY]: "A",
+ [getBarSeriesDataLabelKey("series1", "+")]: Number.MIN_VALUE,
+ series1: null,
+ },
+ {
+ [INDEX_KEY]: 1,
+ [X_AXIS_DATA_KEY]: "B",
+ [X_AXIS_RAW_VALUE_DATA_KEY]: "B",
+ [getBarSeriesDataLabelKey("series1", "+")]: Number.MIN_VALUE,
+ series1: 10,
+ },
+ ]);
+ });
+
+ it("should preserve bar series zero values when the whole series is zero", () => {
+ const dataset = [
+ {
+ [X_AXIS_DATA_KEY]: "A",
+ series1: 0,
+ },
+ {
+ [X_AXIS_DATA_KEY]: "B",
+ series1: 0,
+ },
+ ];
+
+ const result = applyVisualizationSettingsDataTransformations(
+ dataset,
+ [],
+ xAxisModel,
+ [createMockSeriesModel({ dataKey: "series1" })],
+ [],
+ yAxisScaleTransforms,
+ createMockComputedVisualizationSettings({
+ series: () => ({ display: "bar" }),
+ }),
+ );
+
+ expect(result).toEqual([
+ {
+ [INDEX_KEY]: 0,
+ [X_AXIS_DATA_KEY]: "A",
+ [X_AXIS_RAW_VALUE_DATA_KEY]: "A",
+ [getBarSeriesDataLabelKey("series1", "+")]: Number.MIN_VALUE,
+ series1: 0,
+ },
+ {
+ [INDEX_KEY]: 1,
+ [X_AXIS_DATA_KEY]: "B",
+ [X_AXIS_RAW_VALUE_DATA_KEY]: "B",
+ [getBarSeriesDataLabelKey("series1", "+")]: Number.MIN_VALUE,
+ series1: 0,
+ },
+ ]);
+ });
+
describe("ordinal series", () => {
it("should stringify x values if they're objects (metabase#52684)", () => {
const dataset = [