Skip to content

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

GDGT-3131: refactor ai usage stats page to use nested routes (#82420)

Will Fry75398ad620ca
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/ConversationStatsPage.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/ConversationStatsPage.tsx
index c9a90674cd4..c6446ed3516 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/ConversationStatsPage.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/ConversationStatsPage.tsx
@@ -8,7 +8,13 @@ import { dayjs } from "metabase/dayjs";
import { MonitorHeaderTitle } from "metabase/monitor/components/MonitorHeaderTitle";
import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
import { serializeDateParameterValue } from "metabase/querying/parameters/utils/parsing";
-import { queryToSearch, useLocation, useNavigate } from "metabase/router";
+import {
+ Navigate,
+ queryToSearch,
+ useLocation,
+ useNavigate,
+ useParams,
+} from "metabase/router";
import {
Button,
Flex,
@@ -25,6 +31,7 @@ import {
} from "metabase-enterprise/monitor/ai-auditing/metabot-analytics/api";
import {
ConversationFilters,
+ filterUrlStateConfig,
useFilterOptions,
} from "metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationFilters";
import {
@@ -54,7 +61,7 @@ import {
tableForMetric,
} from "./query-utils";
import type { ChartDataSources, ChartProps } from "./types";
-import { statsUrlStateConfig } from "./utils";
+import { DEFAULT_USAGE_STATS_METRIC, parseUsageStatsMetric } from "./utils";
const sourceTitles: Record<UsageStatsMetric, string> = {
get conversations() {
@@ -144,10 +151,33 @@ const labelUnknownIpAddress = (value: unknown) =>
value == null ? t`Unknown` : value;
export function ConversationStatsPage() {
+ const location = useLocation();
+ const params = useParams();
+ const metric = parseUsageStatsMetric(params.metric);
+
+ if (metric === undefined) {
+ return (
+ <Navigate
+ to={`${Urls.monitorAiAuditingUsageMetric(DEFAULT_USAGE_STATS_METRIC)}${location.search}`}
+ replace
+ />
+ );
+ }
+
+ return <UsageStats metric={metric} />;
+}
+
+type UsageStatsProps = {
+ metric: UsageStatsMetric;
+};
+
+function UsageStats({ metric }: UsageStatsProps) {
const location = useLocation();
const navigate = useNavigate();
- const [{ date, user, group, tenant, metric }, { patchUrlState }] =
- useUrlState(location, statsUrlStateConfig);
+ const [{ date, user, group, tenant }, { patchUrlState }] = useUrlState(
+ location,
+ filterUrlStateConfig,
+ );
const {
dateFilter,
@@ -266,6 +296,15 @@ export function ConversationStatsPage() {
[navigateToConversations, tenantOptions],
);
+ const handleMetricChange = (value: string | null) => {
+ if (value) {
+ navigate({
+ pathname: Urls.monitorAiAuditingUsageMetric(value),
+ search: location.search,
+ });
+ }
+ };
+
return (
<MonitorMain>
<Stack gap="xl">
@@ -273,11 +312,7 @@ export function ConversationStatsPage() {
{hasDataComplexityFeature ? t`Usage metrics` : t`Usage stats`}
</MonitorHeaderTitle>
- <Tabs
- variant="pills"
- value={metric}
- onChange={(value) => patchUrlState({ metric: value ?? undefined })}
- >
+ <Tabs variant="pills" value={metric} onChange={handleMetricChange}>
<Tabs.List>
<Tabs.Tab value="conversations">{t`Conversations`}</Tabs.Tab>
<Tabs.Tab value="tokens">{t`Tokens`}</Tabs.Tab>
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/ConversationStatsPage.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/ConversationStatsPage.unit.spec.tsx
index 41ebfdaa505..ec16afc7d5f 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/ConversationStatsPage.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/ConversationStatsPage.unit.spec.tsx
@@ -79,7 +79,7 @@ jest.mock("metabase/visualizations/components/Visualization", () => {
return { __esModule: true, default: StubVisualization };
});
-const STATS_PATH = Urls.monitorAiAuditingUsage();
+const STATS_PATH = Urls.monitorAiAuditingUsageMetric("conversations");
const CONVERSATIONS_PATH = Urls.monitorAiAuditingConversations();
const { database: auditDatabase } = buildAuditViewsFixture();
@@ -225,7 +225,10 @@ function setup({
return renderWithProviders(
<>
- <Route path={STATS_PATH} element={<ConversationStatsPage />} />
+ <Route
+ path={`${Urls.monitorAiAuditingUsage()}/:metric`}
+ element={<ConversationStatsPage />}
+ />
<Route
path={CONVERSATIONS_PATH}
element={<div data-testid="conversations-page" />}
@@ -295,9 +298,11 @@ describe("ConversationStatsPage", () => {
{ tab: "Tokens", metric: "tokens" },
{ tab: "Messages", metric: "messages" },
])(
- "switches to the $metric charts and records the metric in the url",
+ "switches to the $metric charts at the $metric route, keeping the filters",
async ({ tab, metric }) => {
- const { router } = setup();
+ const { router } = setup({
+ initialRoute: `${STATS_PATH}?date=past6days~`,
+ });
await screen.findByText("Conversations by day");
await userEvent.click(screen.getByRole("tab", { name: tab }));
@@ -310,15 +315,30 @@ describe("ConversationStatsPage", () => {
expect(await screen.findByText(title)).toBeInTheDocument();
}
await waitFor(() => {
- expect(parseSearchQuery(router?.location.search ?? "")).toMatchObject(
- {
- metric,
- },
- );
+ expect(router?.location).toMatchObject({
+ pathname: Urls.monitorAiAuditingUsageMetric(metric),
+ search: "?date=past6days~",
+ });
});
},
);
+ it("redirects an unknown metric to the Conversations tab, keeping the filters", async () => {
+ const { router } = setup({
+ initialRoute: `${Urls.monitorAiAuditingUsage()}/unknown?date=past6days~`,
+ });
+
+ await waitFor(() => {
+ expect(router?.location).toMatchObject({
+ pathname: STATS_PATH,
+ search: "?date=past6days~",
+ });
+ });
+ expect(
+ await screen.findByRole("tab", { name: "Conversations" }),
+ ).toHaveAttribute("aria-selected", "true");
+ });
+
it("buckets the timeseries by hour for a single-day date filter", async () => {
setup({ initialRoute: `${STATS_PATH}?date=${SINGLE_DAY}` });
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/utils.ts b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/utils.ts
index b7ec39d4048..a5f21a5594b 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/utils.ts
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/metabot-analytics/components/ConversationStatsPage/utils.ts
@@ -1,16 +1,5 @@
-import {
- type QueryParam,
- type UrlStateConfig,
- getFirstParamValue,
-} from "metabase/common/hooks/use-url-state";
import { deserializeDateParameterValue } from "metabase/querying/parameters/utils/parsing";
-import {
- type FilterUrlState,
- filterUrlStateConfig,
- mergeUrlStateConfig,
-} from "../ConversationFilters/url-state";
-
import type { UsageStatsMetric } from "./query-utils";
export function getFilterDays(dateValue: string): number {
@@ -21,30 +10,16 @@ export function getFilterDays(dateValue: string): number {
return 30;
}
-type StatsPageUrlState = {
- metric: UsageStatsMetric;
-};
-
-export type StatsUrlState = FilterUrlState & StatsPageUrlState;
+export const DEFAULT_USAGE_STATS_METRIC: UsageStatsMetric = "conversations";
-const DEFAULT_METRIC: UsageStatsMetric = "conversations";
+const USAGE_STATS_METRICS: readonly UsageStatsMetric[] = [
+ "conversations",
+ "tokens",
+ "messages",
+];
-function parseMetric(param: QueryParam): UsageStatsMetric {
- const value = getFirstParamValue(param);
- if (value === "messages" || value === "tokens") {
- return value;
- }
- return DEFAULT_METRIC;
+export function parseUsageStatsMetric(
+ value: string | undefined,
+): UsageStatsMetric | undefined {
+ return USAGE_STATS_METRICS.find((metric) => metric === value);
}
-
-const statsPageUrlStateConfig: UrlStateConfig<StatsPageUrlState> = {
- parse: (query) => ({
- metric: parseMetric(query.metric),
- }),
- serialize: ({ metric }) => ({
- metric: metric === DEFAULT_METRIC ? undefined : metric,
- }),
-};
-
-export const statsUrlStateConfig: UrlStateConfig<StatsUrlState> =
- mergeUrlStateConfig(filterUrlStateConfig, statsPageUrlStateConfig);
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/routes.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/routes.tsx
index 6e378dbb083..e2acfd9068c 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/routes.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/routes.tsx
@@ -124,7 +124,10 @@ export function getAiAuditingRoutes() {
<>
<Route index element={redirect("usage")} />
<Route element={<MetabotAnalyticsAvailabilityLayout />}>
- <Route path="usage" lazy={conversationStatsPage} />
+ <Route path="usage">
+ <Route index element={redirect("conversations")} />
+ <Route path=":metric" lazy={conversationStatsPage} />
+ </Route>
<Route path="conversations" lazy={conversationsPage} />
<Route path="conversations/:convoId" lazy={conversationDetailPage} />
</Route>
@@ -138,7 +141,7 @@ export function getAiAuditingUpsellRoutes() {
return (
<>
<Route index element={redirect("usage")} />
- <Route path="usage" lazy={metabotAnalyticsUpsellPage} />
+ <Route path="usage/*" lazy={metabotAnalyticsUpsellPage} />
{getMcpAnalyticsRoutes()}
{getCliAnalyticsRoutes()}
</>
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/routes.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/routes.unit.spec.tsx
index a3f5844f644..ebe14272d23 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/routes.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/ai-auditing/routes.unit.spec.tsx
@@ -101,7 +101,9 @@ describe("AI Auditing routes", () => {
await waitFor(() => {
expect(router?.location).toMatchObject({
- pathname: Urls.monitorAiAuditingUsage(),
+ pathname: upsell
+ ? Urls.monitorAiAuditingUsage()
+ : Urls.monitorAiAuditingUsageMetric("conversations"),
search: "?date=past7days~",
});
});
@@ -141,12 +143,38 @@ describe("AI Auditing routes", () => {
},
);
- it("renders Usage stats at the canonical route", async () => {
- setup({ route: Urls.monitorAiAuditingUsage() });
+ it("redirects Usage stats to its Conversations tab, preserving the query", async () => {
+ const { router } = setup({
+ route: `${Urls.monitorAiAuditingUsage()}?date=past7days~`,
+ });
+ await waitFor(() => {
+ expect(router?.location).toMatchObject({
+ pathname: Urls.monitorAiAuditingUsageMetric("conversations"),
+ search: "?date=past7days~",
+ });
+ });
expect(await screen.findByText("Usage stats page")).toBeInTheDocument();
});
+ it.each(["conversations", "tokens", "messages"])(
+ "renders Usage stats at the %s tab route",
+ async (metric) => {
+ setup({ route: Urls.monitorAiAuditingUsageMetric(metric) });
+
+ expect(await screen.findByText("Usage stats page")).toBeInTheDocument();
+ },
+ );
+
+ it("renders the upsell at a Usage stats tab route", async () => {
+ setup({
+ route: Urls.monitorAiAuditingUsageMetric("tokens"),
+ upsell: true,
+ });
+
+ expect(await screen.findByText("Usage stats upsell")).toBeInTheDocument();
+ });
+
it("renders full Metabot analytics when enabled and configured", async () => {
setup({ route: "/monitor/ai-auditing/conversations" });
diff --git a/frontend/src/metabase/urls/monitor.ts b/frontend/src/metabase/urls/monitor.ts
index 901816704ce..62687e0c928 100644
--- a/frontend/src/metabase/urls/monitor.ts
+++ b/frontend/src/metabase/urls/monitor.ts
@@ -99,6 +99,10 @@ export function monitorAiAuditingUsage(opts?: { groupId?: GroupId }) {
return opts?.groupId == null ? path : `${path}?group=${opts.groupId}`;
}
+export function monitorAiAuditingUsageMetric(metric: string) {
+ return `${monitorAiAuditingUsage()}/${metric}`;
+}
+
export function monitorAiAuditingConversations() {
return `${monitorAiAuditing()}/conversations`;
}