The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Show value preview for metrics defined on a model (#75169)
Andrei Chernykh04b98c15018e
diff --git a/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/AboutVisualization.tsx b/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/AboutVisualization.tsxindex 28b0788ddef..b1a3ceb9f52 100644--- a/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/AboutVisualization.tsx+++ b/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/AboutVisualization.tsx@@ -30,7 +30,7 @@ export function AboutVisualization({ card }: AboutVisualizationProps) {return (<Stack gap={0} h="100%" className={S.visualizationPanel}>{trendData && (- <Box p="xl" pb="sm">+ <Box p="xl" pb="sm" data-testid="metric-value-preview"><TrendInfo {...trendData} /></Box>)}diff --git a/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.tsx b/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.tsxindex ba2faa515ca..5314c3ae553 100644--- a/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.tsx+++ b/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.tsx@@ -1,11 +1,8 @@-import { useMemo } from "react";-import { MetricCardVisualization } from "metabase/data-studio/common/components/OverviewVisualization";import { useCardQueryData } from "metabase/data-studio/common/hooks/use-card-query-data";-import { useMetricDefinition } from "metabase/metrics/common/hooks";import { isNumericMetric } from "metabase/metrics/utils/validation";import { Box, Flex, Stack } from "metabase/ui";-import * as LibMetric from "metabase-lib/metric";+import { isDate, isNumeric } from "metabase-lib/v1/types/utils/isa";import type { Card } from "metabase-types/api";import type { MetricUrls } from "../../../types";@@ -21,18 +18,12 @@ interface MetricAboutProps {}export function MetricAbout({ card, urls }: MetricAboutProps) {- const { definition } = useMetricDefinition(card.id ?? null);const { data, isLoading } = useCardQueryData(card);- const hasTimeDimension = useMemo(- () =>- definition- ? LibMetric.defaultBreakoutDimensions(definition).some(- LibMetric.isDateOrDateTime,- )- : false,- [definition],- );+ // Time series → show value + change over time. Keyed off result columns, not the+ // Lib metric definition, so metrics defined on models (name-based breakout refs) work too.+ const cols = card.result_metadata;+ const isTimeSeries = isDate(cols?.[0]) && isNumeric(cols?.[1]);return (<Flex className={S.root} flex={1} gap="md">@@ -42,7 +33,7 @@ export function MetricAbout({ card, urls }: MetricAboutProps) {<ExploreMetricButton cardId={card.id} /></Box>)}- {hasTimeDimension ? (+ {isTimeSeries ? (<AboutVisualization card={card} />) : (<MetricCardVisualizationdiff --git a/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.unit.spec.tsx b/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.unit.spec.tsxindex a21d2b4b58f..60909202adb 100644--- a/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.unit.spec.tsx+++ b/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.unit.spec.tsx@@ -9,10 +9,12 @@ import {} from "__support__/server-mocks";import { renderWithProviders, screen } from "__support__/ui";import { createMockState } from "metabase/redux/store/mocks";-import type { Card, Field } from "metabase-types/api";+import registerVisualizations from "metabase/visualizations/register";+import type { Card, Dataset, Field } from "metabase-types/api";import {createMockCard,createMockCardQueryMetadata,+ createMockColumn,createMockDataset,createMockDatasetData,createMockField,@@ -27,6 +29,8 @@ import {import { MetricAbout } from "./MetricAbout";+registerVisualizations();+const SAMPLE_DB = createSampleDatabase();const mockUrls = {@@ -56,22 +60,21 @@ function makeMetricCard(resultMetadata: Field[]): Card {});}-function setup(card: Card) {+const SCALAR_DATASET = createMockDataset({+ data: createMockDatasetData({+ cols: [createMockNumericColumn({ name: "count" })],+ rows: [],+ }),+});++function setup(card: Card, dataset: Dataset = SCALAR_DATASET) {setupDatabaseEndpoints(SAMPLE_DB);setupCardEndpoints(card);setupCardQueryMetadataEndpoint(card,createMockCardQueryMetadata({ databases: [SAMPLE_DB] }),);- setupCardQueryEndpoints(- card,- createMockDataset({- data: createMockDatasetData({- cols: [createMockNumericColumn({ name: "count" })],- rows: [],- }),- }),- );+ setupCardQueryEndpoints(card, dataset);setupMetricEndpoint(createMockMetric({ id: card.id, name: card.name }));renderWithProviders(@@ -113,4 +116,89 @@ describe("MetricAbout", () => {expect(await screen.findByText("Source")).toBeInTheDocument();expect(screen.queryByTestId("explore-link")).not.toBeInTheDocument();});++ // The value preview (latest value + period-over-period change) only renders+ // for a time series, so its presence/absence tells us which branch was chosen.+ describe("value + change-over-time preview", () => {+ const TIME_SERIES = createMockDataset({+ data: createMockDatasetData({+ cols: [+ createMockColumn({+ name: "created_at",+ base_type: "type/DateTime",+ unit: "month",+ }),+ createMockNumericColumn({ name: "count" }),+ ],+ rows: [+ ["2023-12-01T00:00:00Z", 100],+ ["2024-01-01T00:00:00Z", 150],+ ],+ }),+ });++ it("shows the latest value when results are a (date, value) time series", async () => {+ setup(+ makeMetricCard([+ createMockField({ name: "created_at", base_type: "type/DateTime" }),+ createMockField({ name: "count", base_type: "type/Integer" }),+ ]),+ TIME_SERIES,+ );++ expect(+ await screen.findByTestId("metric-value-preview"),+ ).toHaveTextContent("150");+ });++ it("does not show the value preview for a scalar metric with no date column", async () => {+ setup(+ makeMetricCard([+ createMockField({ name: "count", base_type: "type/Integer" }),+ ]),+ );++ expect(await screen.findByText("Source")).toBeInTheDocument();+ expect(+ screen.queryByTestId("metric-value-preview"),+ ).not.toBeInTheDocument();+ });++ it("does not show the value preview when broken out by a non-temporal dimension", async () => {+ setup(+ makeMetricCard([+ createMockField({+ name: "category",+ base_type: "type/Text",+ semantic_type: "type/Category",+ }),+ createMockField({ name: "count", base_type: "type/Integer" }),+ ]),+ );++ expect(await screen.findByText("Source")).toBeInTheDocument();+ expect(+ screen.queryByTestId("metric-value-preview"),+ ).not.toBeInTheDocument();+ });++ it("does not show the value preview for a multi-breakout series where the value is not the second column", async () => {+ setup(+ makeMetricCard([+ createMockField({ name: "created_at", base_type: "type/DateTime" }),+ createMockField({+ name: "category",+ base_type: "type/Text",+ semantic_type: "type/Category",+ }),+ createMockField({ name: "count", base_type: "type/Integer" }),+ ]),+ );++ expect(await screen.findByText("Source")).toBeInTheDocument();+ expect(+ screen.queryByTestId("metric-value-preview"),+ ).not.toBeInTheDocument();+ });+ });});