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
Extract a shared AdminDataTable for admin list tables (sortable + paginated) (#78136)
Sébastien0795d60b2127
diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpAnalyticsPage.tsx b/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpAnalyticsPage.tsxindex 6d9f308a549..6988452a812 100644--- a/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpAnalyticsPage.tsx+++ b/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpAnalyticsPage.tsx@@ -33,7 +33,7 @@ import { McpEventsTable } from "./McpEventsTable";*/export function McpAnalyticsPage({ location, router }: WithRouterProps) {const [- { date, user, group, tenant, tab, page, sortColumn, sortDirection },+ { date, user, group, tenant, tab, page, sort_column, sort_direction },{ patchUrlState },] = useUrlState(location, mcpUrlStateConfig);@@ -207,14 +207,11 @@ export function McpAnalyticsPage({ location, router }: WithRouterProps) {page={page}total={count}onPageChange={(newPage) => patchUrlState({ page: newPage })}- sortingOptions={{- sort_column: sortColumn,- sort_direction: sortDirection,- }}+ sortingOptions={{ sort_column, sort_direction }}onSortingOptionsChange={(newSorting) =>patchUrlState({- sortColumn: newSorting.sort_column,- sortDirection: newSorting.sort_direction,+ sort_column: newSorting.sort_column,+ sort_direction: newSorting.sort_direction,page: 0,})}diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpAnalyticsPage.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpAnalyticsPage.unit.spec.tsxindex c190b4807a6..3e5cc0fc90c 100644--- a/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpAnalyticsPage.unit.spec.tsx+++ b/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpAnalyticsPage.unit.spec.tsx@@ -300,6 +300,38 @@ describe("McpAnalyticsPage", () => {});});+ it("issues exactly one events query per page change (no redundant refetch)", async () => {+ const { history } = setup({ dataset: multiPageDatasetResponse });++ await screen.findByRole("heading", { name: "MCP analytics" });+ await userEvent.click(+ await screen.findByRole("tab", { name: "Tool calls" }),+ );+ await within(screen.getByRole("tabpanel")).findByRole("table");++ // Dataset calls for the events query's second page (MBQL `:page` is 1-indexed, so UI page 1).+ const page2EventsCalls = () =>+ fetchMock.callHistory.calls("dataset").filter((call) => {+ const body = call.options?.body;+ if (typeof body !== "string") {+ return false;+ }+ return JSON.parse(body)?.stages?.[0]?.page?.page === 2;+ });++ await userEvent.click(await screen.findByLabelText("Next page"));++ // Wait for the debounced URL update to land — it's the last re-render trigger around a page+ // change, and where the old `sortingOptions`-object dependency used to fire redundant refetches.+ await waitFor(() =>+ expect(history?.getCurrentLocation().search).toContain("page=1"),+ );++ // The query memo depends on the primitive sort values, so it stays referentially stable across+ // those re-renders: one page change → exactly one events request, not one per render.+ expect(page2EventsCalls()).toHaveLength(1);+ });+it("orders the events query by a total order (created_at + tool_call_id) for stable paging", async () => {setup();diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpEventsTable.module.css b/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpEventsTable.module.cssindex a20b9bf988d..ade0d89e392 100644--- a/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpEventsTable.module.css+++ b/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpEventsTable.module.css@@ -1,40 +1,8 @@-.scroll {- overflow: auto;- /* Cap the body so it scrolls internally and the pagination controls below the card stay in- view. The offset must clear the chrome above the card (nav, any banner, page header, tabs)- plus the pager below it; sized generously so the pager stays visible even with a banner. */- max-height: calc(100vh - 23rem);- min-height: 15rem;-}--.table {- width: 100%;-}--/* Keep the sortable headers reachable while the body scrolls. */-.table thead th {- position: sticky;- top: 0;- z-index: 1;- background-color: var(--mb-color-background_surface-primary);-}-+/* Tool-call rows can hold long values (ids, user agents, error text); keep them on one line so the+ body scrolls horizontally rather than wrapping into tall, hard-to-scan rows. */.table thead th,-.table thead th * {- color: var(--mb-color-core-brand);- white-space: nowrap;-}-+.table thead th *,.table td,.table th {- padding-block: 0.75em;white-space: nowrap;}--.table td:first-child {- font-weight: normal;-}--.table tbody tr:not(:last-child) {- border-bottom: 1px solid var(--mb-color-border-neutral);-}diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpEventsTable.tsx b/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpEventsTable.tsxindex 2653b011334..7a5f19088c8 100644--- a/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpEventsTable.tsx+++ b/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/components/McpEventsTable.tsx@@ -1,12 +1,11 @@-import cx from "classnames";import { type ReactNode, useMemo, useRef } from "react";import { t } from "ttag";+import {+ AdminDataTable,+ type AdminDataTableColumn,+} from "metabase/admin/components/AdminDataTable";import { DateTime } from "metabase/common/components/DateTime";-import { SortableColumnHeader } from "metabase/common/components/ItemsTable/BaseItemsTable";-import { PaginationControls } from "metabase/common/components/PaginationControls";-import AdminS from "metabase/css/admin.module.css";-import { Box, Card, Flex, LoadingOverlay } from "metabase/ui";import { EMPTY_CELL_PLACEHOLDER } from "metabase/utils/constants";import { formatNumber } from "metabase/utils/formatting";import type {@@ -194,6 +193,9 @@ function McpEventsTableInner({sortColumn: sortingOptions.sort_column,sortDirection: sortingOptions.sort_direction,}),+ // Depend on the primitive sort values, not the `sortingOptions` object: the object identity+ // changes on every render of the parent, but rebuilding the query mints fresh metabase-lib+ // UUIDs, which churn the RTK cache key and cause a redundant refetch on incidental re-renders.[provider,table,@@ -202,7 +204,8 @@ function McpEventsTableInner({userId,groupId,tenantId,- sortingOptions,+ sortingOptions.sort_column,+ sortingOptions.sort_direction,],);@@ -231,72 +234,42 @@ function McpEventsTableInner({return new Map(cols.map((col, index) => [col.name.toLowerCase(), index]));}, [data]);- const showEmpty = !isFetching && rows.length === 0;+ // Adapt the curated `columns` to the generic table: each render pulls its value out of the+ // warehouse-ordered result row by the column's position in `columnIndex`.+ const dataColumns = useMemo<+ AdminDataTableColumn<RowValues, McpEventSortColumn>[]+ >(+ () =>+ columns.map((column) => ({+ key: column.key,+ title: column.title,+ sortKey: column.sort,+ align: column.align,+ render: (row) => {+ const index = columnIndex.get(column.key);+ const value = index != null ? row[index] : null;+ return renderCell(column, value);+ },+ })),+ [columns, columnIndex],+ );return (- <>- <Card withBorder shadow="none" p={0} pos="relative">- <LoadingOverlay visible={isFetching} />- <Box className={S.scroll}>- <table className={cx(AdminS.ContentTable, S.table)}>- <thead>- <tr>- {columns.map((column) => (- <SortableColumnHeader- key={column.key}- name={column.sort}- sortingOptions={sortingOptions}- onSortingOptionsChange={onSortingOptionsChange}- columnHeaderProps={{ style: { textAlign: column.align } }}- >- {column.title}- </SortableColumnHeader>- ))}- </tr>- </thead>- <tbody>- {showEmpty ? (- <tr>- <td colSpan={columns.length}>- <Flex c="text-disabled" justify="center">- {t`No tool calls found`}- </Flex>- </td>- </tr>- ) : (- rows.map((row, rowIndex) => (- <tr key={rowIndex}>- {columns.map((column) => {- const index = columnIndex.get(column.key);- const value = index != null ? row[index] : null;- return (- <td- key={column.key}- style={{ textAlign: column.align }}- >- {renderCell(column, value)}- </td>- );- })}- </tr>- ))- )}- </tbody>- </table>- </Box>- </Card>-- <Flex justify="flex-end" mt="md">- <PaginationControls- page={page}- pageSize={EVENTS_PAGE_SIZE}- itemsLength={rows.length}- total={total}- showTotal- onPreviousPage={() => onPageChange(page - 1)}- onNextPage={() => onPageChange(page + 1)}- />- </Flex>- </>+ <AdminDataTable+ columns={dataColumns}+ rows={rows}+ sorting={{ sortingOptions, onSortingOptionsChange }}+ pagination={{+ page,+ pageSize: EVENTS_PAGE_SIZE,+ total,+ onPageChange,+ showTotal: true,+ }}+ loading={isFetching}+ emptyText={t`No tool calls found`}+ maxBodyHeight="calc(100vh - 23rem)"+ tableClassName={S.table}+ />);}diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/url-state.ts b/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/url-state.tsindex b355ec8c364..950b6021c9c 100644--- a/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/url-state.ts+++ b/enterprise/frontend/src/metabase-enterprise/audit_app/mcp-analytics/url-state.ts@@ -19,8 +19,8 @@ type McpPageUrlState = {tab: McpTab;/** Current page of the row-level events table, 0-indexed. */page: number;- sortColumn: McpEventSortColumn;- sortDirection: SortDirection;+ sort_column: McpEventSortColumn;+ sort_direction: SortDirection;};export type McpUrlState = FilterUrlState & McpPageUrlState;@@ -58,15 +58,15 @@ const mcpPageUrlStateConfig: UrlStateConfig<McpPageUrlState> = {parse: (query) => ({tab: parseTab(query.tab),page: parsePage(query.page),- sortColumn: parseSortColumn(query.sortColumn),- sortDirection: parseSortDirection(query.sortDirection),+ sort_column: parseSortColumn(query.sort_column),+ sort_direction: parseSortDirection(query.sort_direction),}),- serialize: ({ tab, page, sortColumn, sortDirection }) => ({+ serialize: ({ tab, page, sort_column, sort_direction }) => ({tab: tab === DEFAULT_TAB ? undefined : tab,page: page === 0 ? undefined : String(page),- sortColumn: sortColumn === DEFAULT_SORT_COLUMN ? undefined : sortColumn,- sortDirection:- sortDirection === DEFAULT_SORT_DIRECTION ? undefined : sortDirection,+ sort_column: sort_column === DEFAULT_SORT_COLUMN ? undefined : sort_column,+ sort_direction:+ sort_direction === DEFAULT_SORT_DIRECTION ? undefined : sort_direction,}),};diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/ConversationsPage.tsx b/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/ConversationsPage.tsxindex 8b00e8b5c73..2b23bfa5417 100644--- a/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/ConversationsPage.tsx+++ b/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/ConversationsPage.tsx@@ -3,10 +3,9 @@ import { t } from "ttag";import { MetabotAdminLayout } from "metabase/admin/ai/MetabotAdminLayout";import { SettingsPageWrapper } from "metabase/admin/components/SettingsSection";-import { PaginationControls } from "metabase/common/components/PaginationControls";import { useUrlState } from "metabase/common/hooks/use-url-state";import type { WithRouterProps } from "metabase/router";-import { Card, Flex, Title } from "metabase/ui";+import { Flex, Title } from "metabase/ui";import { useListMetabotAnalyticsConversationsQuery } from "../../api";import { ConversationFilters, useFilterOptions } from "../ConversationFilters";@@ -80,28 +79,19 @@ export function ConversationsPage({ location }: WithRouterProps) {/></Flex>- <Card withBorder shadow="none" p={0} style={{ overflowX: "auto" }}>- <ConversationsTable- conversations={conversations}- isLoading={isLoading}- error={error}- sortingOptions={{ sort_column, sort_direction }}- onSortingOptionsChange={(newSortingOptions) =>- patchUrlState({ ...newSortingOptions, page: 0 })- }- />- </Card>-- <Flex justify="flex-end">- <PaginationControls- onPreviousPage={() => patchUrlState({ page: page - 1 })}- onNextPage={() => patchUrlState({ page: page + 1 })}- page={page}- pageSize={PAGE_SIZE}- itemsLength={conversations.length}- total={total}- />- </Flex>+ <ConversationsTable+ conversations={conversations}+ isLoading={isLoading}+ error={error}+ sortingOptions={{ sort_column, sort_direction }}+ onSortingOptionsChange={(newSortingOptions) =>+ patchUrlState({ ...newSortingOptions, page: 0 })+ }+ page={page}+ pageSize={PAGE_SIZE}+ total={total}+ onPageChange={(newPage) => patchUrlState({ page: newPage })}+ /></SettingsPageWrapper></MetabotAdminLayout>);diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/ConversationsTable.module.css b/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/ConversationsTable.module.cssdeleted file mode 100644index 08d5d934e39..00000000000--- a/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/ConversationsTable.module.css+++ /dev/null@@ -1,21 +0,0 @@-.table {- min-width: 60rem;-}--.table thead th,-.table thead th * {- color: var(--mb-color-core-brand);-}--.table td,-.table th {- padding-block: 0.75em;-}--.table td:first-child {- font-weight: normal;-}--.table tbody tr:not(:last-child) {- border-bottom: 1px solid var(--mb-color-border-neutral);-}diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/ConversationsTable.tsx b/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/ConversationsTable.tsxindex 166166e7797..c804724aaef 100644--- a/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/ConversationsTable.tsx+++ b/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/ConversationsTable.tsx@@ -1,15 +1,14 @@-import cx from "classnames";import { t } from "ttag";+import {+ AdminDataTable,+ type AdminDataTableColumn,+} from "metabase/admin/components/AdminDataTable";import { DateTime } from "metabase/common/components/DateTime";-import { SortableColumnHeader } from "metabase/common/components/ItemsTable/BaseItemsTable";-import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";-import AdminS from "metabase/css/admin.module.css";-import CS from "metabase/css/core/index.css";import { renderMetabotProfileLabel } from "metabase/metabot/constants";import { useDispatch } from "metabase/redux";import { push } from "metabase/router";-import { Badge, Ellipsified, Flex, Tooltip } from "metabase/ui";+import { Badge, Ellipsified, Tooltip } from "metabase/ui";import { EMPTY_CELL_PLACEHOLDER } from "metabase/utils/constants";import { formatNumber } from "metabase/utils/formatting";import { getUserName } from "metabase/utils/user";@@ -17,8 +16,6 @@ import type { SortingOptions } from "metabase-types/api";import type { ConversationSortColumn, ConversationSummary } from "../../types";-import S from "./ConversationsTable.module.css";-type Props = {conversations: ConversationSummary[];isLoading: boolean;@@ -27,6 +24,10 @@ type Props = {onSortingOptionsChange: (options: SortingOptions<ConversationSortColumn>,) => void;+ page: number;+ pageSize: number;+ total: number;+ onPageChange: (page: number) => void;};export function ConversationsTable({@@ -35,125 +36,114 @@ export function ConversationsTable({error,sortingOptions,onSortingOptionsChange,+ page,+ pageSize,+ total,+ onPageChange,}: Props) {const dispatch = useDispatch();- const showLoadingAndError = isLoading || error != null;- const handleRowClick = (convo: ConversationSummary) => {- dispatch(- push(- `/admin/metabot/usage-auditing/conversations/${convo.conversation_id}`,+ const columns: AdminDataTableColumn<+ ConversationSummary,+ ConversationSortColumn+ >[] = [+ {+ key: "title",+ title: t`Title`,+ render: (convo) => (+ <Ellipsified style={{ maxWidth: 280 }}>+ {convo.title ?? t`Untitled`}+ </Ellipsified>+ ),+ },+ {+ key: "user",+ title: t`User`,+ sortKey: "user",+ render: (convo) => (convo.user ? getUserName(convo.user) : t`Unknown`),+ },+ {+ key: "profile_id",+ title: t`Profile`,+ sortKey: "profile_id",+ render: (convo) =>+ convo.profile_id ? (+ <Badge color="brand" variant="filled">+ {renderMetabotProfileLabel(convo.profile_id)}+ </Badge>+ ) : null,+ },+ {+ key: "created_at",+ title: t`Date`,+ sortKey: "created_at",+ render: (convo) => (+ <Ellipsified style={{ maxWidth: 180 }}>+ <DateTime value={convo.created_at} unit="day" />+ </Ellipsified>+ ),+ },+ {+ key: "message_count",+ title: t`Messages`,+ sortKey: "message_count",+ headerProps: { style: { width: "5rem" } },+ render: (convo) => formatNumber(convo.message_count),+ },+ {+ key: "total_tokens",+ title: t`Tokens`,+ sortKey: "total_tokens",+ render: (convo) => formatNumber(convo.total_tokens),+ },+ {+ key: "cache_read_tokens",+ title: (+ <Tooltip+ label={t`Portion of tokens served from the provider cache. A subset of Tokens, not an additional count.`}+ >+ <span>{t`Cached tokens`}</span>+ </Tooltip>),- );- };+ sortKey: "cache_read_tokens",+ render: (convo) => formatNumber(convo.cache_read_tokens),+ },+ {+ key: "query_count",+ title: t`Queries`,+ render: (convo) => formatNumber(convo.query_count),+ },+ {+ key: "search_count",+ title: t`Searches`,+ render: (convo) => formatNumber(convo.search_count),+ },+ {+ key: "ip_address",+ title: t`IP`,+ sortKey: "ip_address",+ render: (convo) => convo.ip_address ?? EMPTY_CELL_PLACEHOLDER,+ },+ ];return (- <table className={cx(AdminS.ContentTable, S.table)}>- <thead>- <tr>- <th>{t`Title`}</th>- <SortableColumnHeader- name="user"- sortingOptions={sortingOptions}- onSortingOptionsChange={onSortingOptionsChange}- >{t`User`}</SortableColumnHeader>- <SortableColumnHeader- name="profile_id"- sortingOptions={sortingOptions}- onSortingOptionsChange={onSortingOptionsChange}- >{t`Profile`}</SortableColumnHeader>- <SortableColumnHeader- name="created_at"- sortingOptions={sortingOptions}- onSortingOptionsChange={onSortingOptionsChange}- >{t`Date`}</SortableColumnHeader>- <SortableColumnHeader- name="message_count"- sortingOptions={sortingOptions}- onSortingOptionsChange={onSortingOptionsChange}- columnHeaderProps={{ style: { width: "5rem" } }}- >{t`Messages`}</SortableColumnHeader>- <SortableColumnHeader- name="total_tokens"- sortingOptions={sortingOptions}- onSortingOptionsChange={onSortingOptionsChange}- >{t`Tokens`}</SortableColumnHeader>- <SortableColumnHeader- name="cache_read_tokens"- sortingOptions={sortingOptions}- onSortingOptionsChange={onSortingOptionsChange}- >- <Tooltip- label={t`Portion of tokens served from the provider cache. A subset of Tokens, not an additional count.`}- >- <span>{t`Cached tokens`}</span>- </Tooltip>- </SortableColumnHeader>- <th>{t`Queries`}</th>- <th>{t`Searches`}</th>- <SortableColumnHeader- name="ip_address"- sortingOptions={sortingOptions}- onSortingOptionsChange={onSortingOptionsChange}- >{t`IP`}</SortableColumnHeader>- </tr>- </thead>- <tbody>- {showLoadingAndError && (- <tr>- <td colSpan={10}>- <LoadingAndErrorWrapper loading={isLoading} error={error} />- </td>- </tr>- )}-- {!showLoadingAndError && (- <>- {conversations.length === 0 && (- <tr>- <td colSpan={10}>- <Flex c="text-disabled" justify="center">- {t`No conversations found`}- </Flex>- </td>- </tr>- )}-- {conversations.map((convo) => (- <tr- key={convo.conversation_id}- className={CS.cursorPointer}- onClick={() => handleRowClick(convo)}- >- <td>- <Ellipsified style={{ maxWidth: 280 }}>- {convo.title ?? t`Untitled`}- </Ellipsified>- </td>- <td>{convo.user ? getUserName(convo.user) : t`Unknown`}</td>- <td>- {convo.profile_id && (- <Badge color="brand" variant="filled">- {renderMetabotProfileLabel(convo.profile_id)}- </Badge>- )}- </td>- <td>- <Ellipsified style={{ maxWidth: 180 }}>- <DateTime value={convo.created_at} unit="day" />- </Ellipsified>- </td>- <td>{formatNumber(convo.message_count)}</td>- <td>{formatNumber(convo.total_tokens)}</td>- <td>{formatNumber(convo.cache_read_tokens)}</td>- <td>{formatNumber(convo.query_count)}</td>- <td>{formatNumber(convo.search_count)}</td>- <td>{convo.ip_address ?? EMPTY_CELL_PLACEHOLDER}</td>- </tr>- ))}- </>- )}- </tbody>- </table>+ <AdminDataTable+ columns={columns}+ rows={conversations}+ getRowKey={(convo) => convo.conversation_id}+ sorting={{ sortingOptions, onSortingOptionsChange }}+ pagination={{ page, pageSize, total, onPageChange }}+ loading={isLoading}+ error={error}+ emptyText={t`No conversations found`}+ maxBodyHeight="calc(100vh - 20rem)"+ onRowClick={(convo) =>+ dispatch(+ push(+ `/admin/metabot/usage-auditing/conversations/${convo.conversation_id}`,+ ),+ )+ }+ />);}diff --git a/frontend/src/metabase/admin/components/AdminDataTable/AdminDataTable.module.css b/frontend/src/metabase/admin/components/AdminDataTable/AdminDataTable.module.cssnew file mode 100644index 00000000000..e57f7ab791f--- /dev/null+++ b/frontend/src/metabase/admin/components/AdminDataTable/AdminDataTable.module.css@@ -0,0 +1,45 @@+.table {+ width: 100%;+}++/* Scrolls the body internally (with `maxBodyHeight`) so the pagination controls below the table+ stay in view instead of being pushed off the bottom of the page. */+.scrollBox {+ /* Height reserved for the sticky header (measures ~2.38rem; rounded up for a small buffer). */+ --admin-data-table-header-height: 3rem;++ overflow: auto;+ min-height: 15rem;+}++/* Keeps the (sortable) headers reachable while the body scrolls. */+.scrollBox .table thead th {+ position: sticky;+ top: 0;+ z-index: 1;+ background-color: var(--mb-color-background_surface-primary);+}++/* Keep a row clear of the sticky header when it's scrolled into view, so it isn't tucked+ underneath it — otherwise clicks aimed at the row land on the header instead. */+.scrollBox .table tbody tr {+ scroll-margin-top: var(--admin-data-table-header-height);+}++.table thead th,+.table thead th * {+ color: var(--mb-color-core-brand);+}++.table td,+.table th {+ padding-block: 0.75em;+}++.table td:first-child {+ font-weight: normal;+}++.table tbody tr:not(:last-child) {+ border-bottom: 1px solid var(--mb-color-border-neutral);+}diff --git a/frontend/src/metabase/admin/components/AdminDataTable/AdminDataTable.tsx b/frontend/src/metabase/admin/components/AdminDataTable/AdminDataTable.tsxnew file mode 100644index 00000000000..74a5dc2f237--- /dev/null+++ b/frontend/src/metabase/admin/components/AdminDataTable/AdminDataTable.tsx@@ -0,0 +1,188 @@+import cx from "classnames";+import type { HTMLAttributes, Key, ReactNode } from "react";+import { t } from "ttag";++import { SortableColumnHeader } from "metabase/common/components/ItemsTable/BaseItemsTable";+import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";+import { PaginationControls } from "metabase/common/components/PaginationControls";+import AdminS from "metabase/css/admin.module.css";+import CS from "metabase/css/core/index.css";+import { Box, Card, Flex, LoadingOverlay } from "metabase/ui";+import type { SortingOptions } from "metabase-types/api";++import S from "./AdminDataTable.module.css";++export type AdminDataTableAlign = "left" | "center" | "right";++export type AdminDataTableColumn<Row, SortColumn extends string = string> = {+ /** Stable React key for the column, also used for the cell key. */+ key: string;+ title: ReactNode;+ /** Present when the column can be sorted; wires the header to `sorting`. */+ sortKey?: SortColumn;+ align?: AdminDataTableAlign;+ render: (row: Row) => ReactNode;+ /** Extra props forwarded to the `<th>` (e.g. a fixed width). */+ headerProps?: Partial<HTMLAttributes<HTMLTableHeaderCellElement>>;+};++export type AdminDataTableSorting<SortColumn extends string> = {+ sortingOptions: SortingOptions<SortColumn>;+ onSortingOptionsChange: (sortingOptions: SortingOptions<SortColumn>) => void;+};++export type AdminDataTablePagination = {+ /** Current page, 0-indexed. */+ page: number;+ pageSize: number;+ /** Total number of rows across all pages. */+ total: number;+ onPageChange: (page: number) => void;+ /** Whether to render the "of N" total (defaults to false, matching `PaginationControls`). */+ showTotal?: boolean;+};++export type AdminDataTableProps<Row, SortColumn extends string = string> = {+ columns: AdminDataTableColumn<Row, SortColumn>[];+ rows: Row[];+ /** Stable key per row; falls back to the row index. */+ getRowKey?: (row: Row, index: number) => Key;+ sorting?: AdminDataTableSorting<SortColumn>;+ pagination?: AdminDataTablePagination;+ loading?: boolean;+ error?: unknown;+ /** Message shown when there are no rows (and not loading/erroring). */+ emptyText?: ReactNode;+ onRowClick?: (row: Row) => void;+ /**+ * Cap the table body's height (any CSS length, e.g. `calc(100vh - 23rem)`) so it scrolls+ * internally with sticky headers, keeping the pagination controls in view.+ */+ maxBodyHeight?: string;+ /** Class applied to the `<table>` itself. */+ tableClassName?: string;+};++/**+ * Generic admin list table built on the shared primitives (`SortableColumnHeader`,+ * `PaginationControls`, `AdminS.ContentTable`, `LoadingAndErrorWrapper`). Callers declare+ * `columns` + `rows` and, optionally, `sorting` / `pagination` / loading-error-empty states; the+ * component stays agnostic about how the rows were fetched.+ */+export function AdminDataTable<Row, SortColumn extends string = string>({+ columns,+ rows,+ getRowKey,+ sorting,+ pagination,+ loading = false,+ error,+ emptyText = t`No results found`,+ onRowClick,+ maxBodyHeight,+ tableClassName,+}: AdminDataTableProps<Row, SortColumn>) {+ // While an initial load or an error is in flight there is nothing to show, so hand the whole body+ // to LoadingAndErrorWrapper. Once we have rows, keep showing them and overlay a spinner instead,+ // so paging/sorting doesn't blank the table out.+ const showLoadingOrError = error != null || (loading && rows.length === 0);+ const showEmpty = !loading && error == null && rows.length === 0;+ const showOverlay = loading && rows.length > 0;++ const table = (+ <Box pos="relative">+ <LoadingOverlay visible={showOverlay} />+ <Box+ data-testid="admin-data-table-body"+ className={maxBodyHeight != null ? S.scrollBox : undefined}+ style={maxBodyHeight != null ? { maxHeight: maxBodyHeight } : undefined}+ >+ <table className={cx(AdminS.ContentTable, S.table, tableClassName)}>+ <thead>+ <tr>+ {columns.map((column) => {+ const headerProps = {+ ...column.headerProps,+ style: {+ textAlign: column.align,+ ...column.headerProps?.style,+ },+ };+ // Only sortable columns get the interactive header; the rest render a plain `<th>`+ // so screen readers don't announce a static header as a button.+ return sorting != null && column.sortKey != null ? (+ <SortableColumnHeader+ key={column.key}+ name={column.sortKey}+ sortingOptions={sorting.sortingOptions}+ onSortingOptionsChange={sorting.onSortingOptionsChange}+ columnHeaderProps={headerProps}+ >+ {column.title}+ </SortableColumnHeader>+ ) : (+ <th key={column.key} {...headerProps}>+ {column.title}+ </th>+ );+ })}+ </tr>+ </thead>+ <tbody>+ {showLoadingOrError ? (+ <tr>+ <td colSpan={columns.length}>+ <LoadingAndErrorWrapper loading={loading} error={error} />+ </td>+ </tr>+ ) : showEmpty ? (+ <tr>+ <td colSpan={columns.length}>+ <Flex c="text-disabled" justify="center">+ {emptyText}+ </Flex>+ </td>+ </tr>+ ) : (+ rows.map((row, rowIndex) => (+ <tr+ key={getRowKey ? getRowKey(row, rowIndex) : rowIndex}+ className={onRowClick ? CS.cursorPointer : undefined}+ onClick={onRowClick ? () => onRowClick(row) : undefined}+ >+ {columns.map((column) => (+ <td key={column.key} style={{ textAlign: column.align }}>+ {column.render(row)}+ </td>+ ))}+ </tr>+ ))+ )}+ </tbody>+ </table>+ </Box>+ </Box>+ );++ return (+ <>+ <Card withBorder shadow="none" p={0}>+ {table}+ </Card>++ {pagination && (+ <Flex justify="flex-end" mt="md">+ <PaginationControls+ page={pagination.page}+ pageSize={pagination.pageSize}+ itemsLength={rows.length}+ total={pagination.total}+ showTotal={pagination.showTotal ?? false}+ onPreviousPage={() => pagination.onPageChange(pagination.page - 1)}+ onNextPage={() => pagination.onPageChange(pagination.page + 1)}+ />+ </Flex>+ )}+ </>+ );+}diff --git a/frontend/src/metabase/admin/components/AdminDataTable/AdminDataTable.unit.spec.tsx b/frontend/src/metabase/admin/components/AdminDataTable/AdminDataTable.unit.spec.tsxnew file mode 100644index 00000000000..6fb35ddba29--- /dev/null+++ b/frontend/src/metabase/admin/components/AdminDataTable/AdminDataTable.unit.spec.tsx@@ -0,0 +1,206 @@+import userEvent from "@testing-library/user-event";++import { render, screen } from "__support__/ui";+import type { SortingOptions } from "metabase-types/api";++import {+ AdminDataTable,+ type AdminDataTableColumn,+ type AdminDataTableProps,+} from "./AdminDataTable";++type Row = { id: number; name: string; count: number };++type SortColumn = "name" | "count";++const ROWS: Row[] = [+ { id: 1, name: "Alpha", count: 10 },+ { id: 2, name: "Beta", count: 20 },+];++const COLUMNS: AdminDataTableColumn<Row, SortColumn>[] = [+ { key: "name", title: "Name", sortKey: "name", render: (row) => row.name },+ {+ key: "count",+ title: "Count",+ sortKey: "count",+ align: "right",+ render: (row) => row.count,+ },+ // A static, non-sortable column.+ { key: "id", title: "ID", render: (row) => row.id },+];++type SetupOpts = Partial<AdminDataTableProps<Row, SortColumn>> & {+ sortingOptions?: SortingOptions<SortColumn>;+};++const setup = ({ sortingOptions, ...props }: SetupOpts = {}) => {+ const onSortingOptionsChange = jest.fn();+ const onPageChange = jest.fn();+ const onRowClick = jest.fn();++ const utils = render(+ <AdminDataTable<Row, SortColumn>+ columns={COLUMNS}+ rows={ROWS}+ getRowKey={(row) => row.id}+ sorting={{+ sortingOptions: sortingOptions ?? {+ sort_column: "name",+ sort_direction: "asc",+ },+ onSortingOptionsChange,+ }}+ onRowClick={onRowClick}+ {...props}+ />,+ );++ return { ...utils, onSortingOptionsChange, onPageChange, onRowClick };+};++describe("AdminDataTable", () => {+ it("renders headers and cell values from each column's render()", () => {+ setup();++ expect(screen.getByText("Name")).toBeInTheDocument();+ expect(screen.getByText("Count")).toBeInTheDocument();+ expect(screen.getByText("ID")).toBeInTheDocument();++ expect(screen.getByText("Alpha")).toBeInTheDocument();+ expect(screen.getByText("Beta")).toBeInTheDocument();+ expect(screen.getByText("20")).toBeInTheDocument();+ });++ it("toggles the sort direction when a sortable header is clicked", async () => {+ const { onSortingOptionsChange } = setup({+ sortingOptions: { sort_column: "name", sort_direction: "asc" },+ });++ await userEvent.click(screen.getByText("Name"));++ expect(onSortingOptionsChange).toHaveBeenCalledWith({+ sort_column: "name",+ sort_direction: "desc",+ });+ });++ it("does not wire sorting on columns without a sortKey", async () => {+ const { onSortingOptionsChange } = setup();++ await userEvent.click(screen.getByText("ID"));++ expect(onSortingOptionsChange).not.toHaveBeenCalled();+ });++ it("renders sortable headers as buttons and non-sortable ones as plain headers", () => {+ setup({+ // "Sortable" has a sortKey; "Static" doesn't. (Sort on an unrelated column so+ // "Sortable" isn't the active one — an active header also renders a sort icon.)+ sortingOptions: { sort_column: "name", sort_direction: "asc" },+ columns: [+ {+ key: "sortable",+ title: "Sortable",+ sortKey: "count",+ render: () => "x",+ },+ { key: "static", title: "Static", render: () => "y" },+ ],+ });++ // the column with a sortKey exposes an interactive control...+ expect(+ screen.getByRole("button", { name: "Sortable" }),+ ).toBeInTheDocument();+ // ...while the column without one stays a static header, not a button.+ expect(+ screen.getByRole("columnheader", { name: "Static" }),+ ).toBeInTheDocument();+ expect(+ screen.queryByRole("button", { name: "Static" }),+ ).not.toBeInTheDocument();+ });++ it("fires onRowClick with the clicked row", async () => {+ const { onRowClick } = setup();++ await userEvent.click(screen.getByText("Beta"));++ expect(onRowClick).toHaveBeenCalledWith(ROWS[1]);+ });++ it("shows the empty message when there are no rows", () => {+ setup({ rows: [], emptyText: "Nothing here" });++ expect(screen.getByText("Nothing here")).toBeInTheDocument();+ expect(screen.queryByText("Alpha")).not.toBeInTheDocument();+ });++ it("keeps showing rows while refetching (overlay instead of blanking)", () => {+ setup({ loading: true });++ // rows stay visible; the spinner overlays them+ expect(screen.getByText("Alpha")).toBeInTheDocument();+ });++ it("does not render rows while loading with no data yet", () => {+ setup({ rows: [], loading: true, emptyText: "Nothing here" });++ expect(screen.queryByText("Alpha")).not.toBeInTheDocument();+ expect(screen.queryByText("Nothing here")).not.toBeInTheDocument();+ });++ it("renders the error message when an error is present", () => {+ setup({ rows: [], error: "Boom" });++ expect(screen.getByText("Boom")).toBeInTheDocument();+ expect(screen.queryByText("Alpha")).not.toBeInTheDocument();+ });++ it("caps the body height when maxBodyHeight is set", () => {+ setup({ maxBodyHeight: "calc(100vh - 23rem)" });++ expect(screen.getByTestId("admin-data-table-body")).toHaveStyle({+ maxHeight: "calc(100vh - 23rem)",+ });+ });++ it("hides the total by default and shows it when showTotal is set", () => {+ const onPageChange = jest.fn();++ const { rerender } = setup({+ pagination: { page: 1, pageSize: 2, total: 10, onPageChange },+ });+ expect(screen.queryByTestId("pagination-total")).not.toBeInTheDocument();++ rerender(+ <AdminDataTable<Row, SortColumn>+ columns={COLUMNS}+ rows={ROWS}+ pagination={{+ page: 1,+ pageSize: 2,+ total: 10,+ onPageChange,+ showTotal: true,+ }}+ />,+ );+ expect(screen.getByTestId("pagination-total")).toHaveTextContent("10");+ });++ it("renders pagination controls and pages forward/back", async () => {+ const onPageChange = jest.fn();+ setup({+ pagination: { page: 1, pageSize: 2, total: 10, onPageChange },+ });++ await userEvent.click(screen.getByTestId("next-page-btn"));+ expect(onPageChange).toHaveBeenCalledWith(2);++ await userEvent.click(screen.getByTestId("previous-page-btn"));+ expect(onPageChange).toHaveBeenCalledWith(0);+ });+});diff --git a/frontend/src/metabase/admin/components/AdminDataTable/index.ts b/frontend/src/metabase/admin/components/AdminDataTable/index.tsnew file mode 100644index 00000000000..392b951314b--- /dev/null+++ b/frontend/src/metabase/admin/components/AdminDataTable/index.ts@@ -0,0 +1 @@+export * from "./AdminDataTable";