feat(data-grid): add configurable default sorting

This commit is contained in:
二丫讲梵 authored and GitHub committed 2026-07-29 04:46:46 +08:00
1 parent fdaef62518
commit 2e5b439c8a
24 files changed
+720 -17

No files matched your search

@@ -14,7 +14,9 @@ const mocks = vi.hoisted(() => ({
getColumns: vi.fn(),
listIndexes: vi.fn(),
ensureConnected: vi.fn(),
sortTabResultLocally: vi.fn(),
tableOpenPageSize: 100,
openTableDefaultSortMode: "none" as "none" | "primary-key-asc" | "primary-key-desc",
tabs: [] as QueryTab[],
setTableMeta: vi.fn(),
}));
@@ -38,6 +40,7 @@ vi.mock("@/stores/connectionStore", () => ({
useConnectionStore: () => ({
getConfig: mocks.getConfig,
ensureConnected: mocks.ensureConnected,
connectionIdentifierQuote: () => undefined,
}),
}));
@@ -46,6 +49,7 @@ vi.mock("@/stores/queryStore", () => ({
executeTabSql: mocks.executeTabSql,
setExecuting: mocks.setExecuting,
updateSql: mocks.updateSql,
sortTabResultLocally: mocks.sortTabResultLocally,
tabs: mocks.tabs,
setTableMeta: mocks.setTableMeta.mockImplementation((id: string, meta: NonNullable<QueryTab["tableMeta"]>) => {
const tab = mocks.tabs.find((item) => item.id === id);
@@ -60,7 +64,14 @@ vi.mock("@/stores/queryStore", () => ({
}));
vi.mock("@/stores/settingsStore", () => ({
useSettingsStore: () => ({ editorSettings: { tableOpenPageSize: mocks.tableOpenPageSize } }),
useSettingsStore: () => ({
editorSettings: {
tableOpenPageSize: mocks.tableOpenPageSize,
openTableDefaultSortMode: mocks.openTableDefaultSortMode,
infiniteScroll: false,
infiniteScrollMaxRows: 5000,
},
}),
}));
vi.mock("@/composables/useToast", () => ({
@@ -98,6 +109,7 @@ describe("useDataGridActions", () => {
vi.clearAllMocks();
mocks.tabs.length = 0;
mocks.tableOpenPageSize = 100;
mocks.openTableDefaultSortMode = "none";
mocks.getConfig.mockReturnValue({ id: "postgres-1", db_type: "postgres" });
mocks.buildTableSelectSql.mockResolvedValue("SELECT * FROM public.users LIMIT 100 OFFSET 0");
mocks.buildSortedQuerySql.mockResolvedValue({ ok: true, sql: "SELECT sorted" });
@@ -305,4 +317,64 @@ describe("useDataGridActions", () => {
}),
);
});
it("rebuilds composite primary-key ordering for toolbar refresh and pagination", async () => {
mocks.openTableDefaultSortMode = "primary-key-desc";
const tab = tableDataTab({
tableMeta: {
schema: "public",
tableName: "users",
tableType: "TABLE",
columns: [
{ name: "tenant_id", data_type: "text", is_nullable: false, column_default: null, is_primary_key: true, extra: null },
{ name: "record_id", data_type: "bigint", is_nullable: false, column_default: null, is_primary_key: true, extra: null },
],
primaryKeys: ["tenant_id", "record_id"],
},
openTableDefaultSortApplied: true,
openTableDefaultSortOrderBy: '"tenant_id" ASC, "record_id" ASC',
orderByInput: '"tenant_id" ASC, "record_id" ASC',
});
const actions = useDataGridActions(computed(() => tab));
await actions.onReloadData(tab.sql, "", "", tab.orderByInput, 25, 50, "refresh");
expect(mocks.buildTableSelectSql).toHaveBeenLastCalledWith(
expect.objectContaining({
orderBy: '"tenant_id" DESC, "record_id" DESC',
limit: 25,
offset: 50,
}),
);
await actions.onPaginate(75, 25, "", tab.orderByInput);
expect(mocks.buildTableSelectSql).toHaveBeenLastCalledWith(
expect.objectContaining({
orderBy: '"tenant_id" DESC, "record_id" DESC',
limit: 25,
offset: 75,
}),
);
});
it("sorts locally without issuing a database query", async () => {
const tab = tableDataTab();
const actions = useDataGridActions(computed(() => tab));
await actions.onSort("id", 0, "asc", "", "local");
expect(mocks.sortTabResultLocally).toHaveBeenCalledWith("tab-1", "id", 0, "asc");
expect(mocks.buildTableSelectSql).not.toHaveBeenCalled();
expect(mocks.executeTabSql).not.toHaveBeenCalled();
});
it("sorts in the database by rebuilding and executing table SQL", async () => {
const tab = tableDataTab();
const actions = useDataGridActions(computed(() => tab));
await actions.onSort("id", 0, "desc", "", "database");
expect(mocks.sortTabResultLocally).not.toHaveBeenCalled();
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(expect.objectContaining({ orderBy: '"id" DESC' }));
expect(mocks.executeTabSql).toHaveBeenCalledWith("tab-1", expect.any(String), expect.objectContaining({ preserveResultDuringExecution: true }));
});
});
@@ -9,9 +9,11 @@ const mocks = vi.hoisted(() => ({
cachedMetadata: undefined as unknown,
ensureConnected: vi.fn(),
executeTabSql: vi.fn(),
buildTableSelectSql: vi.fn(),
loadTableMetadata: vi.fn(),
setErrorResult: vi.fn(),
cancelTabExecution: vi.fn(),
openTableDefaultSortMode: "none" as "none" | "primary-key-asc" | "primary-key-desc",
}));
vi.mock("@/stores/connectionStore", () => ({
@@ -69,7 +71,7 @@ vi.mock("@/stores/queryStore", () => ({
}));
vi.mock("@/stores/settingsStore", () => ({
useSettingsStore: () => ({ editorSettings: { reuseDataTab: false, pageSize: 100 } }),
useSettingsStore: () => ({ editorSettings: { reuseDataTab: false, tableOpenPageSize: 100, openTableDefaultSortMode: mocks.openTableDefaultSortMode } }),
}));
vi.mock("@/lib/database/jdbcDialect", () => ({
@@ -92,7 +94,10 @@ vi.mock("@/lib/backend/debugLog", () => ({ appendDebugLog: vi.fn(), isDebugLoggi
// dataTabOpenPolicy 使用真实实现:beforeEach 清空 tabs 时无候选可复用,
// 取消窗口测试则依赖真实 findExistingDataTabCandidate 选中同表 tab
vi.mock("@/lib/sidebar/treeNodeContext", () => ({ hasTreeNodeDatabaseContext: () => true }));
vi.mock("@/lib/table/tableSelectSql", () => ({ buildTableSelectSql: async () => "SELECT * FROM users" }));
vi.mock("@/lib/table/tableSelectSql", async (importOriginal) => ({
...(await importOriginal<typeof import("@/lib/table/tableSelectSql")>()),
buildTableSelectSql: mocks.buildTableSelectSql,
}));
vi.mock("@/lib/table/tableEditing", () => ({ usesSyntheticRowIdKey: () => false }));
vi.mock("@/lib/table/tableOpenPageLimit", () => ({ tableOpenPageLimit: () => 100 }));
vi.mock("@/lib/tabs/dataTabActivation", () => ({ canActivateExistingDataTableTab: () => false }));
@@ -114,7 +119,9 @@ describe("useSidebarDataOpenRuntime", () => {
mocks.callOrder.length = 0;
mocks.tabs.length = 0;
mocks.cachedMetadata = undefined;
mocks.openTableDefaultSortMode = "none";
mocks.ensureConnected.mockResolvedValue(undefined);
mocks.buildTableSelectSql.mockResolvedValue("SELECT * FROM users");
mocks.executeTabSql.mockImplementation(async () => {
mocks.callOrder.push("query");
});
@@ -307,4 +314,43 @@ describe("useSidebarDataOpenRuntime", () => {
expect(mocks.tabs[0]?.tableMetaPending).toBeFalsy();
expect(mocks.loadTableMetadata).not.toHaveBeenCalled();
});
it("loads composite primary-key metadata before the first query when default ordering is enabled", async () => {
mocks.databaseType = "postgres";
mocks.openTableDefaultSortMode = "primary-key-asc";
mocks.loadTableMetadata.mockResolvedValueOnce({
metadata: {
schema: "public",
tableName: "users",
tableType: "TABLE",
database: "app",
columns: [
{ name: "Tenant", data_type: "text", is_nullable: false, column_default: null, is_primary_key: true, extra: null },
{ name: "Order", data_type: "bigint", is_nullable: false, column_default: null, is_primary_key: true, extra: null },
],
indexes: [],
primaryKeys: ["Tenant", "Order"],
cachedAt: Date.now(),
},
cacheStatus: "miss",
ageMs: 0,
});
await useSidebarDataOpenRuntime().openData(tableNode);
expect(mocks.loadTableMetadata).toHaveBeenCalledTimes(1);
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(
expect.objectContaining({
primaryKeys: ["Tenant", "Order"],
orderBy: '"Tenant" ASC, "Order" ASC',
}),
);
expect(mocks.tabs[0]).toMatchObject({
resultSortColumn: "Tenant",
resultSortDirection: "asc",
resultSortMode: "database",
orderByInput: '"Tenant" ASC, "Order" ASC',
openTableDefaultSortApplied: true,
});
});
});