feat(editor): configurable default sort when opening tables

This commit is contained in:
二丫讲梵 authored and GitHub committed 2026-09-18 13:37:33 +08:00
1 parent 5cdee2e7a3
commit ff874e8af9
25 files changed
+417 -23

No files matched your search

@@ -8,11 +8,13 @@ const mocks = vi.hoisted(() => ({
activeTabId: "",
buildTableSelectSql: vi.fn(),
databaseType: "postgres" as string,
tableOpenSortMode: "none" as "none" | "database" | "local",
ensureConnected: vi.fn(),
executeTabSql: vi.fn(),
getColumns: vi.fn(),
invalidateCompletionTableCache: vi.fn(),
listIndexes: vi.fn(),
setErrorResult: vi.fn(),
setTableMeta: vi.fn(),
updateSql: vi.fn(),
}));
@@ -75,16 +77,17 @@ vi.mock("@/stores/queryStore", () => ({
}),
updateSql: mocks.updateSql,
executeTabSql: mocks.executeTabSql,
setErrorResult: vi.fn(),
setErrorResult: mocks.setErrorResult,
invalidateTableStructure: vi.fn(),
}),
}));
vi.mock("@/stores/settingsStore", () => ({
useSettingsStore: () => ({ editorSettings: { dataTabReuseMode: "same-table" } }),
useSettingsStore: () => ({ editorSettings: { dataTabReuseMode: "same-table", tableOpenSortMode: mocks.tableOpenSortMode, tableDatabaseSortDirection: "desc", tableLocalSortDirection: "asc" } }),
}));
vi.mock("@/lib/table/tableSelectSql", () => ({
vi.mock("@/lib/table/tableSelectSql", async (importOriginal) => ({
...(await importOriginal<typeof import("@/lib/table/tableSelectSql")>()),
buildTableSelectSql: mocks.buildTableSelectSql,
}));
@@ -104,6 +107,7 @@ describe("useNavigationTargets openTableTarget", () => {
vi.clearAllMocks();
mocks.tabs.length = 0;
mocks.databaseType = "postgres";
mocks.tableOpenSortMode = "none";
mocks.ensureConnected.mockResolvedValue(undefined);
mocks.buildTableSelectSql.mockImplementation(async ({ tableName }: { tableName: string }) => `SELECT * FROM ${tableName}`);
mocks.executeTabSql.mockResolvedValue(undefined);
@@ -111,6 +115,33 @@ describe("useNavigationTargets openTableTarget", () => {
mocks.listIndexes.mockResolvedValue([]);
});
it.each(["oracle", "oceanbase-oracle", "xugu", "neo4j"])("keeps %s synthetic row identifiers out of default database ordering", async (databaseType) => {
mocks.databaseType = databaseType;
mocks.tableOpenSortMode = "database";
mocks.getColumns.mockResolvedValue([{ ...column("name"), is_primary_key: false }]);
await useNavigationTargets(dialogs).openTableTarget({ connectionId: "connection-1", database: "app", tableName: "users", tableType: "TABLE" });
expect(mocks.executeTabSql).toHaveBeenCalled();
expect(mocks.buildTableSelectSql).toHaveBeenCalled();
for (const [options] of mocks.buildTableSelectSql.mock.calls) {
expect(options.orderBy).toBeUndefined();
}
expect(mocks.tabs[0]?.orderByInput).toBeUndefined();
});
it.each(["oracle", "oceanbase-oracle"])("uses the %s physical primary index for default ordering", async (databaseType) => {
mocks.databaseType = databaseType;
mocks.tableOpenSortMode = "database";
mocks.getColumns.mockResolvedValue([{ ...column("id"), is_primary_key: false }]);
mocks.listIndexes.mockResolvedValue([{ name: "users_pk", columns: ["id"], is_unique: true, is_primary: true }]);
await useNavigationTargets(dialogs).openTableTarget({ connectionId: "connection-1", database: "app", tableName: "users", tableType: "TABLE" });
expect(mocks.setErrorResult).not.toHaveBeenCalled();
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(expect.objectContaining({ orderBy: '"id" DESC' }));
});
it("loads stable row identity before the first PostgreSQL table query", async () => {
let releaseColumns: (columns: unknown[]) => void = () => {};
mocks.getColumns.mockReturnValueOnce(
@@ -162,7 +193,7 @@ describe("useNavigationTargets openTableTarget", () => {
});
it("keeps row identity pending when shared metadata loading fails", async () => {
mocks.getColumns.mockRejectedValueOnce(new Error("metadata unavailable"));
mocks.getColumns.mockRejectedValue(new Error("metadata unavailable"));
await useNavigationTargets(dialogs).openLineageTarget({ connectionId: "connection-1", database: "app", schema: "public", tableName: "users" });
@@ -170,6 +201,17 @@ describe("useNavigationTargets openTableTarget", () => {
expect(mocks.tabs[0]?.tableMetaPending).toBe(true);
});
it.each(["none", "database", "local"] as const)("opens the table when metadata preload fails in %s sort mode", async (mode) => {
mocks.databaseType = "sqlite";
mocks.tableOpenSortMode = mode;
mocks.getColumns.mockRejectedValue(new Error("metadata unavailable"));
await useNavigationTargets(dialogs).openLineageTarget({ connectionId: "connection-1", database: "app", tableName: "users" });
expect(mocks.executeTabSql).toHaveBeenCalledTimes(1);
expect(mocks.tabs[0]?.tableMetaPending).toBe(true);
});
it("uses the SQLite attached database as the table namespace when a target omits schema", async () => {
mocks.databaseType = "sqlite";
@@ -5,6 +5,8 @@ import type { QueryTab, TreeNode } from "@/types/database";
const mocks = vi.hoisted(() => ({
databaseType: "oceanbase" as string,
tableOpenSortMode: "none" as "none" | "database" | "local",
sortTabResultLocally: vi.fn(),
callOrder: [] as string[],
tabs: [] as QueryTab[],
activeTabId: null as string | null,
@@ -90,12 +92,13 @@ vi.mock("@/stores/queryStore", () => ({
if (tab) tab.sql = sql;
},
executeTabSql: mocks.executeTabSql,
sortTabResultLocally: mocks.sortTabResultLocally,
setErrorResult: mocks.setErrorResult,
}),
}));
vi.mock("@/stores/settingsStore", () => ({
useSettingsStore: () => ({ editorSettings: { dataTabReuseMode: mocks.dataTabReuseMode, openDataTabsNextToActive: mocks.openDataTabsNextToActive, pageSize: 100 } }),
useSettingsStore: () => ({ editorSettings: { tableOpenSortMode: mocks.tableOpenSortMode, tableDatabaseSortDirection: "desc", tableLocalSortDirection: "asc", dataTabReuseMode: mocks.dataTabReuseMode, openDataTabsNextToActive: mocks.openDataTabsNextToActive, pageSize: 100 } }),
}));
vi.mock("@/lib/database/jdbcDialect", () => ({
@@ -117,8 +120,12 @@ vi.mock("@/lib/common/utils", () => ({ uuid: () => "open-data-id" }));
vi.mock("@/lib/backend/debugLog", () => ({ appendDebugLog: vi.fn(), isDebugLoggingEnabled: () => false }));
// dataTabOpenPolicy 使用真实实现,覆盖设置开关对应的复用范围
vi.mock("@/lib/sidebar/treeNodeContext", () => ({ hasTreeNodeDatabaseContext: () => true }));
vi.mock("@/lib/table/tableSelectSql", () => ({ buildTableSelectSql: mocks.buildTableSelectSql }));
vi.mock("@/lib/table/tableSelectSql", async (importOriginal) => ({ ...(await importOriginal<typeof import("@/lib/table/tableSelectSql")>()), buildTableSelectSql: mocks.buildTableSelectSql }));
vi.mock("@/lib/table/tableEditing", () => ({
physicalTablePrimaryKeys: (columns: Array<{ name: string; is_primary_key: boolean }>, indexes: Array<{ columns: string[]; is_primary: boolean }> = []) => {
const columnPrimaryKeys = columns.filter((column) => column.is_primary_key).map((column) => column.name);
return columnPrimaryKeys.length > 0 ? columnPrimaryKeys : (indexes.find((index) => index.is_primary && index.columns.length > 0)?.columns ?? []);
},
usesSyntheticRowIdKey: () => false,
shouldIncludeSyntheticRowId: () => false,
}));
@@ -147,6 +154,7 @@ describe("useSidebarDataOpenRuntime", () => {
beforeEach(() => {
vi.clearAllMocks();
mocks.databaseType = "oceanbase";
mocks.tableOpenSortMode = "none";
mocks.callOrder.length = 0;
mocks.tabs.length = 0;
mocks.activeTabId = null;
@@ -178,6 +186,48 @@ describe("useSidebarDataOpenRuntime", () => {
});
});
it.each(["database", "local"] as const)("applies the %s default using its independent direction", async (mode) => {
mocks.tableOpenSortMode = mode;
mocks.executeTabSql.mockImplementation(async () => {
const tab = mocks.tabs[0]!;
tab.isExecuting = false;
tab.executionId = undefined;
tab.result = { columns: ["id"], rows: [[2], [1]], affected_rows: 0, execution_time_ms: 0 } as any;
});
await useSidebarDataOpenRuntime().openData(tableNode);
if (mode === "database") {
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(expect.objectContaining({ orderBy: '"id" DESC' }));
expect(mocks.tabs[0]).toMatchObject({ resultSortColumn: "id", resultSortDirection: "desc", resultSortMode: "database" });
} else {
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(expect.objectContaining({ orderBy: undefined }));
expect(mocks.sortTabResultLocally).toHaveBeenCalledWith("tab-1", "id", 0, "asc");
}
});
it("applies database sorting from a physical primary index when columns omit the key flag", async () => {
mocks.databaseType = "oracle";
mocks.tableOpenSortMode = "database";
mocks.loadTableMetadata.mockResolvedValue({
metadata: {
schema: "public",
tableName: "users",
tableType: "TABLE",
database: "app",
columns: [{ name: "id", data_type: "bigint", is_nullable: false, column_default: null, is_primary_key: false, extra: null }],
indexes: [{ name: "users_pk", columns: ["id"], is_unique: true, is_primary: true }],
primaryKeys: ["id"],
cachedAt: Date.now(),
},
cacheStatus: "miss",
ageMs: 0,
});
await useSidebarDataOpenRuntime().openData(tableNode);
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(expect.objectContaining({ orderBy: '"id" DESC' }));
expect(mocks.tabs[0]?.tableMeta?.physicalPrimaryKeys).toEqual(["id"]);
});
it("creates a new sidebar tab for the same table in always-new mode", async () => {
mocks.dataTabReuseMode = "always-new";