feat(grid): sort local filter values by count

This commit is contained in:
二丫讲梵 authored and GitHub committed 2026-09-23 15:40:16 +08:00
1 parent d13bc37bea
commit 33eb12d9f8
7 files changed
+310 -16

No files matched your search

@@ -0,0 +1,116 @@
// @vitest-environment happy-dom
import { createApp, defineComponent, h, ref, computed } from "vue";
import { afterEach, describe, expect, it, vi } from "vitest";
import { useDataGridColumnFilters, type DataGridColumnFilterState, type DataGridLocalFilterDraft } from "@/composables/useDataGridColumnFilters";
import type { DataGridLocalFilterOption } from "@/lib/dataGrid/dataGridLocalColumnFilterState";
import type { CellValue } from "@/lib/dataGrid/cellValue";
import type { QueryResult } from "@/types/database";
vi.mock("@/lib/backend/api", () => ({ executeQuery: vi.fn() }));
const disposers: Array<() => void> = [];
function mountColumnFilters(rows: CellValue[][]) {
const state: DataGridColumnFilterState = {
localColumnFilters: ref({}),
localFilterOpenColumn: ref<number | null>(null),
localFilterSearch: ref(""),
localFilterDraft: ref<DataGridLocalFilterDraft | null>(null),
serverFilterLoading: ref(false),
serverFilterError: ref(""),
serverFilterOptions: ref<DataGridLocalFilterOption[]>([]),
serverFilterLimited: ref(false),
serverFilterValueByKey: ref(new Map()),
serverColumnFilters: ref({}),
};
const result: QueryResult = { columns: ["status"], rows };
let filters: ReturnType<typeof useDataGridColumnFilters> | undefined;
const app = createApp(
defineComponent({
setup() {
filters = useDataGridColumnFilters({
state,
getResult: () => result,
getTableMeta: () => undefined,
getConnectionId: () => undefined,
getSchema: () => undefined,
getExecutionDatabase: () => "",
resolvedDatabaseType: computed(() => undefined),
canUseWhereSearch: computed(() => false),
canUseServerColumnFilter: computed(() => false),
structuredFilterCount: computed(() => 0),
hasStructuredFilters: computed(() => false),
whereFilterInput: ref(""),
getConnectionConfig: () => undefined,
getIdentifierQuote: () => undefined,
getNewRows: () => [],
getRowData: (row) => row,
formatValue: (value) => String(value),
waitForTableMeta: () => Promise.resolve(null),
applyWhereFilter: () => Promise.resolve(),
resetGridVerticalScroll: () => {},
emitLocalFiltersChange: () => {},
});
return () => h("div");
},
}),
);
app.mount(document.createElement("div"));
disposers.push(() => app.unmount());
if (!filters) throw new Error("useDataGridColumnFilters was not mounted");
return filters;
}
afterEach(() => {
for (const dispose of disposers.splice(0)) dispose();
});
describe("useDataGridColumnFilters local filter sort", () => {
it("sorts values by count descending on the first count click and back to value ascending on the first value click", () => {
const filters = mountColumnFilters([["beta"], ["beta"], ["beta"], ["alpha"], ["alpha"], ["zulu"]]);
filters.openLocalFilter(0);
expect(filters.localFilterSort.value).toEqual({ field: "value", direction: "asc" });
expect(filters.localFilterOptions.value.map((option) => option.label)).toEqual(["alpha", "beta", "zulu"]);
filters.toggleLocalFilterSort("count");
expect(filters.localFilterSort.value).toEqual({ field: "count", direction: "desc" });
expect(filters.localFilterOptions.value.map((option) => [option.label, option.count])).toEqual([
["beta", 3],
["alpha", 2],
["zulu", 1],
]);
filters.toggleLocalFilterSort("value");
expect(filters.localFilterSort.value).toEqual({ field: "value", direction: "asc" });
expect(filters.localFilterOptions.value.map((option) => option.label)).toEqual(["alpha", "beta", "zulu"]);
});
it("flips the direction when the same sort header is clicked again", () => {
const filters = mountColumnFilters([["beta"], ["alpha"], ["alpha"]]);
filters.openLocalFilter(0);
filters.toggleLocalFilterSort("count");
expect(filters.localFilterSort.value).toEqual({ field: "count", direction: "desc" });
expect(filters.localFilterOptions.value.map((option) => [option.label, option.count])).toEqual([
["alpha", 2],
["beta", 1],
]);
filters.toggleLocalFilterSort("count");
expect(filters.localFilterSort.value).toEqual({ field: "count", direction: "asc" });
expect(filters.localFilterOptions.value.map((option) => [option.label, option.count])).toEqual([
["beta", 1],
["alpha", 2],
]);
});
it("ignores sort toggles while no local filter draft is open", () => {
const filters = mountColumnFilters([["beta"], ["alpha"]]);
filters.toggleLocalFilterSort("count");
expect(filters.localFilterSort.value).toEqual({ field: "value", direction: "asc" });
});
});
@@ -1,8 +1,8 @@
import { computed, onUnmounted, watch, type ComputedRef, type Ref } from "vue";
import { computed, onUnmounted, ref, watch, type ComputedRef, type Ref } from "vue";
import * as api from "@/lib/backend/api";
import { buildColumnValueFilterCondition, buildColumnValuesFilterCondition, parseFilterValue, removeColumnValueFilterCondition, replaceColumnValueFilterCondition, appendColumnValueFilterCondition } from "@/lib/dataGrid/dataGridColumnFilter";
import { buildDataGridColumnDistinctValuesSql } from "@/lib/dataGrid/dataGridSql";
import { buildDataGridLocalFilterOptions, dataGridLocalFilterKey, dataGridLocalFilterLabel, rowMatchesDataGridLocalColumnFilters, type DataGridLocalFilterOption } from "@/lib/dataGrid/dataGridLocalColumnFilterState";
import { buildDataGridLocalFilterOptions, sortDataGridLocalFilterOptions, type DataGridLocalFilterSort, dataGridLocalFilterKey, dataGridLocalFilterLabel, rowMatchesDataGridLocalColumnFilters, type DataGridLocalFilterOption } from "@/lib/dataGrid/dataGridLocalColumnFilterState";
import type { DataGridCachedServerColumnFilter } from "@/lib/dataGrid/dataGridFilterBuilderPersistence";
import type { CellValue } from "@/lib/dataGrid/cellValue";
import type { ColumnInfo, DatabaseType, QueryResult } from "@/types/database";
@@ -72,6 +72,17 @@ const SERVER_COLUMN_FILTER_DEBOUNCE_MS = 300;
export function useDataGridColumnFilters(options: UseDataGridColumnFiltersOptions) {
const { state } = options;
const localFilterSort = ref<DataGridLocalFilterSort>({ field: "value", direction: "asc" });
function toggleLocalFilterSort(field: DataGridLocalFilterSort["field"]) {
if (state.localFilterDraft.value?.mode !== "local") return;
const current = localFilterSort.value;
localFilterSort.value = {
field,
direction: current.field === field ? (current.direction === "asc" ? "desc" : "asc") : field === "count" ? "desc" : "asc",
};
}
let serverFilterRequestId = 0;
let serverFilterSearchTimer: ReturnType<typeof window.setTimeout> | undefined;
@@ -138,7 +149,13 @@ export function useDataGridColumnFilters(options: UseDataGridColumnFiltersOption
const localFilterOptions = computed(() => {
if (state.localFilterDraft.value?.mode === "server") return state.serverFilterOptions.value;
const query = state.localFilterSearch.value.trim().toLowerCase();
return localFilterAllOptions.value.filter((option) => !query || option.label.toLowerCase().includes(query)).slice(0, 500);
const matchingOptions = localFilterAllOptions.value.filter((option) => !query || option.label.toLowerCase().includes(query));
// Sort before limiting so frequent values outside the default first 500 remain discoverable.
// buildDataGridLocalFilterOptions already returns value-ascending options, so the default
// sort state skips the re-sort instead of re-running it on every search keystroke.
const sort = localFilterSort.value;
const sorted = sort.field === "value" && sort.direction === "asc" ? matchingOptions : sortDataGridLocalFilterOptions(matchingOptions, sort);
return sorted.slice(0, 500);
});
const localFilterTypedValue = computed(() => state.localFilterSearch.value.trim());
const localFilterDraftIsAllSelected = computed(() => {
@@ -172,6 +189,7 @@ export function useDataGridColumnFilters(options: UseDataGridColumnFiltersOption
function openLocalFilter(columnIndex: number, requestedMode: DataGridLocalFilterMode = "local") {
options.onOpen?.();
localFilterSort.value = { field: "value", direction: "asc" };
state.localFilterSearch.value = "";
const mode = requestedMode === "server" && options.canUseServerColumnFilter.value ? "server" : "local";
const allKeys = mode === "server" ? [] : buildLocalFilterOptions(columnIndex).map((option) => option.key);
@@ -426,6 +444,8 @@ export function useDataGridColumnFilters(options: UseDataGridColumnFiltersOption
rowMatchesLocalColumnFilters,
localFilterAllOptions,
localFilterOptions,
localFilterSort,
toggleLocalFilterSort,
localFilterTypedValue,
canApplyTypedLocalFilterValue,
openLocalFilter,