Skip to content

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

Make sorting consistent in small dashboard tables when including NULL text values (#78701)

Anderson6a045e90d693
diff --git a/frontend/src/metabase/data-grid/types.ts b/frontend/src/metabase/data-grid/types.ts
index 12fdcf054bf..1deff08182f 100644
--- a/frontend/src/metabase/data-grid/types.ts
+++ b/frontend/src/metabase/data-grid/types.ts
@@ -2,6 +2,7 @@ import type {
Cell,
CellContext,
Column,
+ ColumnDef,
ColumnDefTemplate,
ColumnSizingState,
HeaderContext,
@@ -110,6 +111,9 @@ export interface ColumnOptions<TRow extends RowData, TValue = unknown> {
/** Initial sort direction for this column */
sortDirection?: "asc" | "desc";
+ /** Function used to sort values in this column */
+ sortingFn?: ColumnDef<TRow, TValue>["sortingFn"];
+
/** Whether this column can be resized */
enableResizing?: boolean;
diff --git a/frontend/src/metabase/data-grid/utils/columns/data-column.tsx b/frontend/src/metabase/data-grid/utils/columns/data-column.tsx
index 18bdcacb223..86d2a6e90f0 100644
--- a/frontend/src/metabase/data-grid/utils/columns/data-column.tsx
+++ b/frontend/src/metabase/data-grid/utils/columns/data-column.tsx
@@ -88,8 +88,15 @@ export const getDataColumn = <TRow, TValue>(
truncateWidth: number,
onExpand: (columnName: string, content: React.ReactNode) => void,
): ColumnDef<TRow, TValue> => {
- const { id, accessorFn, wrap, cell, header, headerClickTargetSelector } =
- columnOptions;
+ const {
+ id,
+ accessorFn,
+ wrap,
+ cell,
+ header,
+ headerClickTargetSelector,
+ sortingFn,
+ } = columnOptions;
const columnWidth = columnSizing[id] ?? 0;
const measuredColumnWidth = measuredColumnSizing[id] ?? 0;
@@ -101,6 +108,7 @@ export const getDataColumn = <TRow, TValue>(
const columnDefinition: ColumnDef<TRow, TValue> = {
accessorFn,
id,
+ ...(sortingFn != null ? { sortingFn } : {}),
header:
typeof header !== "string"
? memo(header ?? getDefaultHeaderTemplate(columnOptions))
diff --git a/frontend/src/metabase/visualizations/components/TableInteractive/TableInteractive.tsx b/frontend/src/metabase/visualizations/components/TableInteractive/TableInteractive.tsx
index 7bdb57f9a3c..9e057fca544 100644
--- a/frontend/src/metabase/visualizations/components/TableInteractive/TableInteractive.tsx
+++ b/frontend/src/metabase/visualizations/components/TableInteractive/TableInteractive.tsx
@@ -61,7 +61,7 @@ import type {
} from "metabase/visualizations/types";
import type { ClickObject, OrderByDirection } from "metabase-lib";
import type Question from "metabase-lib/v1/Question";
-import { isFK, isID, isPK } from "metabase-lib/v1/types/utils/isa";
+import { isFK, isID, isPK, isString } from "metabase-lib/v1/types/utils/isa";
import type {
ColumnSettings,
DatasetColumn,
@@ -553,6 +553,7 @@ export const TableInteractiveInner = forwardRef(function TableInteractiveInner(
align,
wrap,
sortDirection,
+ sortingFn: isString(col) ? "alphanumeric" : undefined,
enableResizing: true,
getBackgroundColor,
formatter: formatter.rich,
diff --git a/frontend/src/metabase/visualizations/visualizations/Table/Table.unit.spec.tsx b/frontend/src/metabase/visualizations/visualizations/Table/Table.unit.spec.tsx
index 6992c5ff37d..402afffd3ac 100644
--- a/frontend/src/metabase/visualizations/visualizations/Table/Table.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Table/Table.unit.spec.tsx
@@ -3,8 +3,15 @@ import { thaw } from "icepick";
import { useState } from "react";
import { createMockMetadata } from "__support__/metadata";
-import { renderWithProviders, screen, within } from "__support__/ui";
+import {
+ fireEvent,
+ mockGetBoundingClientRect,
+ renderWithProviders,
+ screen,
+ within,
+} from "__support__/ui";
import { QuestionChartSettings } from "metabase/visualizations/components/ChartSettings";
+import Visualization from "metabase/visualizations/components/Visualization";
import { registerVisualizations } from "metabase/visualizations/register";
import { Table } from "metabase/visualizations/visualizations/Table/Table";
import Question from "metabase-lib/v1/Question";
@@ -241,6 +248,84 @@ describe("table.pivot", () => {
});
});
+describe("dashboard client-side sorting", () => {
+ beforeAll(() => {
+ mockGetBoundingClientRect();
+ });
+
+ it("sorts numeric, null, and text values in small datasets (#67756)", () => {
+ const series = [
+ createMockSingleSeries(
+ { display: "table" },
+ {
+ data: {
+ cols: [
+ createMockNumericColumn({ display_name: "id", name: "id" }),
+ createMockCategoryColumn({
+ display_name: "name",
+ name: "name",
+ }),
+ ],
+ rows: [
+ [1, "Alice"],
+ [2, null],
+ [3, "Charlie"],
+ [4, null],
+ [5, "Bob"],
+ [6, null],
+ [7, "Delta"],
+ [8, null],
+ ],
+ },
+ },
+ ),
+ ];
+
+ renderWithProviders(
+ <Visualization rawSeries={series} isDashboard width={600} height={400} />,
+ );
+
+ const idHeader = screen.getByRole("columnheader", { name: "id" });
+ const idClickTarget = within(idHeader).getByTestId("cell-data");
+
+ fireEvent.mouseDown(idClickTarget, { clientX: 0, clientY: 0 });
+ fireEvent.mouseUp(idClickTarget, { clientX: 0, clientY: 0 });
+
+ expect(
+ screen
+ .getAllByRole("row")
+ .slice(1)
+ .map((row) => within(row).getAllByRole("gridcell")[0].textContent),
+ ).toEqual(["8", "7", "6", "5", "4", "3", "2", "1"]);
+
+ const nameHeader = screen.getByRole("columnheader", { name: "name" });
+ const clickTarget = within(nameHeader).getByTestId("cell-data");
+
+ fireEvent.mouseDown(clickTarget, { clientX: 0, clientY: 0 });
+ fireEvent.mouseUp(clickTarget, { clientX: 0, clientY: 0 });
+
+ const rows = screen
+ .getAllByRole("row")
+ .slice(1)
+ .map((row) =>
+ within(row)
+ .getAllByRole("gridcell")
+ .map((cell) => cell.textContent),
+ );
+
+ expect(rows).toEqual([
+ ["7", "Delta"],
+ ["3", "Charlie"],
+ ["5", "Bob"],
+ ["1", "Alice"],
+ ["2", ""],
+ ["4", ""],
+ ["6", ""],
+ ["8", ""],
+ ]);
+ });
+});
+
describe("text_wrapping", () => {
describe("in columnSettings", () => {
function assertDefined<T>(