fix(sidebar): preserve primary keys on first table open
This commit is contained in:
1 parent
7b14ef3b48
commit
5289dc819d
11 files changed
+978
-21
No files matched your search
@@ -1,6 +1,7 @@
|
||||
import { computed } from "vue";
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { useDataGridActions } from "@/composables/useDataGridActions";
|
||||
import { clearTableMetadataCache } from "@/lib/metadata/tableMetadataCache";
|
||||
import type { QueryTab } from "@/types/database";
|
||||
|
||||
const mocks = vi.hoisted(() => ({
|
||||
@@ -10,6 +11,11 @@ const mocks = vi.hoisted(() => ({
|
||||
getConfig: vi.fn(),
|
||||
setExecuting: vi.fn(),
|
||||
updateSql: vi.fn(),
|
||||
getColumns: vi.fn(),
|
||||
listIndexes: vi.fn(),
|
||||
ensureConnected: vi.fn(),
|
||||
tabs: [] as QueryTab[],
|
||||
setTableMeta: vi.fn(),
|
||||
}));
|
||||
|
||||
vi.mock("vue-i18n", () => ({
|
||||
@@ -18,6 +24,8 @@ vi.mock("vue-i18n", () => ({
|
||||
|
||||
vi.mock("@/lib/backend/api", () => ({
|
||||
buildSortedQuerySql: mocks.buildSortedQuerySql,
|
||||
getColumns: mocks.getColumns,
|
||||
listIndexes: mocks.listIndexes,
|
||||
}));
|
||||
|
||||
vi.mock("@/lib/table/tableSelectSql", () => ({
|
||||
@@ -28,6 +36,7 @@ vi.mock("@/lib/table/tableSelectSql", () => ({
|
||||
vi.mock("@/stores/connectionStore", () => ({
|
||||
useConnectionStore: () => ({
|
||||
getConfig: mocks.getConfig,
|
||||
ensureConnected: mocks.ensureConnected,
|
||||
}),
|
||||
}));
|
||||
|
||||
@@ -36,6 +45,16 @@ vi.mock("@/stores/queryStore", () => ({
|
||||
executeTabSql: mocks.executeTabSql,
|
||||
setExecuting: mocks.setExecuting,
|
||||
updateSql: mocks.updateSql,
|
||||
tabs: mocks.tabs,
|
||||
setTableMeta: mocks.setTableMeta.mockImplementation((id: string, meta: NonNullable<QueryTab["tableMeta"]>) => {
|
||||
const tab = mocks.tabs.find((item) => item.id === id);
|
||||
if (tab) {
|
||||
tab.tableMeta = meta;
|
||||
tab.tableMetaUpdatedAt = Date.now();
|
||||
// 与真实 store 一致:仅真实元数据(columns 非空)落地才结束行标识等待
|
||||
if (meta.columns.length > 0) tab.tableMetaPending = false;
|
||||
}
|
||||
}),
|
||||
}),
|
||||
}));
|
||||
|
||||
@@ -70,10 +89,15 @@ function tableDataTab(patch: Partial<QueryTab> = {}): QueryTab {
|
||||
|
||||
describe("useDataGridActions", () => {
|
||||
beforeEach(() => {
|
||||
clearTableMetadataCache();
|
||||
vi.clearAllMocks();
|
||||
mocks.tabs.length = 0;
|
||||
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" });
|
||||
mocks.ensureConnected.mockResolvedValue(undefined);
|
||||
mocks.getColumns.mockResolvedValue([{ name: "id", data_type: "integer", is_nullable: false, column_default: null, is_primary_key: true, extra: null }]);
|
||||
mocks.listIndexes.mockResolvedValue([]);
|
||||
});
|
||||
|
||||
it("uses the table-data default when toolbar reload has no saved pagination", async () => {
|
||||
@@ -137,6 +161,103 @@ describe("useDataGridActions", () => {
|
||||
);
|
||||
});
|
||||
|
||||
it("marks row identity pending and refreshes metadata when real columns are missing, despite fallback result columns", async () => {
|
||||
// 恢复的占位身份:真实 tableMeta.columns 为空,但存在(失败)结果列。
|
||||
// tableMetaForDataTab 会用结果列合成 columns,不得据此跳过刷新
|
||||
const tab = tableDataTab({
|
||||
tableMeta: { schema: "public", tableName: "users", tableType: "TABLE", columns: [], primaryKeys: [] },
|
||||
tableMetaUpdatedAt: Date.now(),
|
||||
result: { columns: ["Error"], rows: [["boom"]], affected_rows: 0, execution_time_ms: 1 },
|
||||
});
|
||||
mocks.tabs.push(tab);
|
||||
const actions = useDataGridActions(computed(() => tab));
|
||||
|
||||
await actions.onReloadData(tab.sql, "", "", "", undefined, undefined, "refresh");
|
||||
|
||||
// 合成的 ["Error"] 结果列不得进入 SQL 投影:真实列缺失时省略 columns(SELECT *)
|
||||
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(expect.objectContaining({ columns: undefined }));
|
||||
await vi.waitFor(() => {
|
||||
expect(mocks.getColumns).toHaveBeenCalled();
|
||||
expect(mocks.setTableMeta).toHaveBeenCalledWith("tab-1", expect.objectContaining({ primaryKeys: ["id"] }));
|
||||
expect(tab.tableMetaPending).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
it("reuses an in-flight metadata refresh when a later reload can apply the result", async () => {
|
||||
const tab = tableDataTab({
|
||||
tableMeta: { schema: "public", tableName: "users", tableType: "TABLE", columns: [], primaryKeys: [] },
|
||||
tableMetaUpdatedAt: Date.now(),
|
||||
});
|
||||
mocks.tabs.push(tab);
|
||||
const actions = useDataGridActions(computed(() => tab));
|
||||
|
||||
// 第一轮:stale-tab 早退(tabs 里找不到匹配项时 refreshDataTabTableMeta 直接返回)
|
||||
mocks.tabs.length = 0;
|
||||
await actions.onReloadData(tab.sql, "", "", "", undefined, undefined, "refresh");
|
||||
await vi.waitFor(() => expect(mocks.getColumns).toHaveBeenCalledTimes(1));
|
||||
expect(mocks.setTableMeta).not.toHaveBeenCalled();
|
||||
expect(tab.tableMetaPending).toBe(true);
|
||||
|
||||
// 第二轮:真实 columns 仍为空,新的消费者加入同一在途请求;共享缓存应
|
||||
// 去重后端调用,但本轮仍要在目标恢复后落地结果
|
||||
mocks.tabs.push(tab);
|
||||
await actions.onReloadData(tab.sql, "", "", "", undefined, undefined, "refresh");
|
||||
await vi.waitFor(() => {
|
||||
expect(mocks.getColumns).toHaveBeenCalledTimes(1);
|
||||
expect(mocks.setTableMeta).toHaveBeenCalledWith("tab-1", expect.objectContaining({ primaryKeys: ["id"] }));
|
||||
});
|
||||
});
|
||||
|
||||
it("defers the Dameng metadata refresh until after the reload query", async () => {
|
||||
mocks.getConfig.mockReturnValue({ id: "dameng-1", db_type: "dameng" });
|
||||
const callOrder: string[] = [];
|
||||
const tab = tableDataTab({
|
||||
connectionId: "dameng-1",
|
||||
tableMeta: { schema: "public", tableName: "users", tableType: "TABLE", columns: [], primaryKeys: [] },
|
||||
tableMetaUpdatedAt: Date.now(),
|
||||
});
|
||||
mocks.executeTabSql.mockImplementationOnce(async () => {
|
||||
callOrder.push("query");
|
||||
// 查询执行期间:元数据尚未启动,行标识等待保持
|
||||
expect(tab.tableMetaPending).toBe(true);
|
||||
});
|
||||
mocks.getColumns.mockImplementationOnce(async () => {
|
||||
callOrder.push("metadata");
|
||||
return [{ name: "id", data_type: "integer", is_nullable: false, column_default: null, is_primary_key: true, extra: null }];
|
||||
});
|
||||
mocks.tabs.push(tab);
|
||||
const actions = useDataGridActions(computed(() => tab));
|
||||
|
||||
await actions.onReloadData(tab.sql, "", "", "", undefined, undefined, "refresh");
|
||||
|
||||
// Dameng 元数据必须排在数据查询之后(串行约束,同 useSidebarDataOpenRuntime);
|
||||
// 真实元数据落地后结束行标识等待
|
||||
await vi.waitFor(() => {
|
||||
expect(callOrder).toEqual(["query", "metadata"]);
|
||||
expect(tab.tableMetaPending).toBe(false);
|
||||
expect(tab.tableMeta?.primaryKeys).toEqual(["id"]);
|
||||
});
|
||||
});
|
||||
|
||||
it("starts the deferred Dameng metadata refresh even when the reload query rejects", async () => {
|
||||
mocks.getConfig.mockReturnValue({ id: "dameng-1", db_type: "dameng" });
|
||||
mocks.executeTabSql.mockRejectedValueOnce(new Error("query failed"));
|
||||
const tab = tableDataTab({
|
||||
connectionId: "dameng-1",
|
||||
tableMeta: { schema: "public", tableName: "users", tableType: "TABLE", columns: [], primaryKeys: [] },
|
||||
tableMetaUpdatedAt: Date.now(),
|
||||
});
|
||||
mocks.tabs.push(tab);
|
||||
const actions = useDataGridActions(computed(() => tab));
|
||||
|
||||
// 查询 reject 仍会重新抛出,但元数据刷新必须已启动,标签页可恢复
|
||||
await expect(actions.onReloadData(tab.sql, "", "", "", undefined, undefined, "refresh")).rejects.toThrow("query failed");
|
||||
await vi.waitFor(() => {
|
||||
expect(mocks.getColumns).toHaveBeenCalled();
|
||||
expect(tab.tableMetaPending).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
it("excludes hidden primary keys and remaps the selected column for database sorting", async () => {
|
||||
const tab = {
|
||||
id: "tab-1",
|
||||
|
||||
@@ -0,0 +1,274 @@
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { useNavigationTargets } from "@/composables/useNavigationTargets";
|
||||
import { clearTableMetadataCache } from "@/lib/metadata/tableMetadataCache";
|
||||
import type { QueryTab } from "@/types/database";
|
||||
|
||||
const mocks = vi.hoisted(() => ({
|
||||
tabs: [] as QueryTab[],
|
||||
reuseDataTab: true,
|
||||
activeTabId: "",
|
||||
databaseType: "postgres" as string,
|
||||
ensureConnected: vi.fn(),
|
||||
executeTabSql: vi.fn(),
|
||||
getColumns: vi.fn(),
|
||||
listIndexes: vi.fn(),
|
||||
setTableMeta: vi.fn(),
|
||||
updateSql: vi.fn(),
|
||||
}));
|
||||
|
||||
vi.mock("@/lib/backend/api", () => ({
|
||||
getColumns: mocks.getColumns,
|
||||
listIndexes: mocks.listIndexes,
|
||||
}));
|
||||
|
||||
vi.mock("@/stores/connectionStore", () => ({
|
||||
useConnectionStore: () => ({
|
||||
activeConnectionId: "",
|
||||
getConfig: () => ({ id: "connection-1", db_type: mocks.databaseType }),
|
||||
ensureConnected: mocks.ensureConnected,
|
||||
connectionIdentifierQuote: () => undefined,
|
||||
refreshObjectListTreeNode: vi.fn(),
|
||||
}),
|
||||
}));
|
||||
|
||||
vi.mock("@/stores/queryStore", () => ({
|
||||
useQueryStore: () => ({
|
||||
tabs: mocks.tabs,
|
||||
activeTabId: mocks.activeTabId,
|
||||
createTab: (connectionId: string, database: string, title: string, mode: QueryTab["mode"], schema?: string) => {
|
||||
const tab = {
|
||||
id: `tab-${mocks.tabs.length + 1}`,
|
||||
connectionId,
|
||||
database,
|
||||
title,
|
||||
mode,
|
||||
schema,
|
||||
sql: "",
|
||||
isDirty: false,
|
||||
isExecuting: false,
|
||||
isCancelling: false,
|
||||
isExplaining: false,
|
||||
} as QueryTab;
|
||||
mocks.tabs.push(tab);
|
||||
return tab.id;
|
||||
},
|
||||
switchTab: vi.fn(),
|
||||
setExecuting: vi.fn(),
|
||||
setExecutingWithId: (id: string, executionId: string) => {
|
||||
const tab = mocks.tabs.find((item) => item.id === id);
|
||||
if (tab) {
|
||||
tab.isExecuting = true;
|
||||
tab.executionId = executionId;
|
||||
}
|
||||
},
|
||||
setTableMeta: mocks.setTableMeta.mockImplementation((id: string, meta: NonNullable<QueryTab["tableMeta"]>) => {
|
||||
const tab = mocks.tabs.find((item) => item.id === id);
|
||||
if (tab) {
|
||||
tab.tableMeta = meta;
|
||||
tab.tableMetaUpdatedAt = Date.now();
|
||||
// 与真实 store 一致:仅真实元数据(columns 非空)落地才结束行标识等待
|
||||
if (meta.columns.length > 0) tab.tableMetaPending = false;
|
||||
}
|
||||
}),
|
||||
updateSql: mocks.updateSql,
|
||||
executeTabSql: mocks.executeTabSql,
|
||||
setErrorResult: vi.fn(),
|
||||
invalidateTableStructure: vi.fn(),
|
||||
}),
|
||||
}));
|
||||
|
||||
vi.mock("@/stores/settingsStore", () => ({
|
||||
useSettingsStore: () => ({ editorSettings: { reuseDataTab: mocks.reuseDataTab } }),
|
||||
}));
|
||||
|
||||
vi.mock("@/lib/table/tableSelectSql", () => ({
|
||||
buildTableSelectSql: async ({ tableName }: { tableName: string }) => `SELECT * FROM ${tableName}`,
|
||||
}));
|
||||
|
||||
const dialogs = {
|
||||
showFieldLineageDialog: { value: false },
|
||||
showDatabaseSearchDialog: { value: false },
|
||||
showDiagramDialog: { value: false },
|
||||
};
|
||||
|
||||
function column(name: string) {
|
||||
return { name, data_type: "integer", is_nullable: false, column_default: null, is_primary_key: true, extra: null };
|
||||
}
|
||||
|
||||
describe("useNavigationTargets openTableTarget", () => {
|
||||
beforeEach(() => {
|
||||
clearTableMetadataCache();
|
||||
vi.clearAllMocks();
|
||||
mocks.tabs.length = 0;
|
||||
mocks.reuseDataTab = true;
|
||||
mocks.databaseType = "postgres";
|
||||
mocks.ensureConnected.mockResolvedValue(undefined);
|
||||
mocks.executeTabSql.mockResolvedValue(undefined);
|
||||
mocks.getColumns.mockResolvedValue([column("id")]);
|
||||
mocks.listIndexes.mockResolvedValue([]);
|
||||
});
|
||||
|
||||
it("marks row identity pending until real metadata lands", async () => {
|
||||
let releaseColumns: (columns: unknown[]) => void = () => {};
|
||||
mocks.getColumns.mockReturnValueOnce(
|
||||
new Promise((resolve) => {
|
||||
releaseColumns = resolve;
|
||||
}),
|
||||
);
|
||||
let pendingDuringQuery: boolean | undefined;
|
||||
mocks.executeTabSql.mockImplementationOnce(async () => {
|
||||
pendingDuringQuery = mocks.tabs[0]?.tableMetaPending;
|
||||
});
|
||||
|
||||
const open = useNavigationTargets(dialogs).openLineageTarget({ connectionId: "connection-1", database: "app", schema: "public", tableName: "users" });
|
||||
releaseColumns([column("id")]);
|
||||
await open;
|
||||
|
||||
// 数据查询执行期间元数据未落地:行标识等待必须已挂起
|
||||
expect(pendingDuringQuery).toBe(true);
|
||||
expect(mocks.tabs[0]?.tableMeta?.primaryKeys).toEqual(["id"]);
|
||||
expect(mocks.tabs[0]?.tableMetaPending).toBe(false);
|
||||
});
|
||||
|
||||
it("reuses cached metadata and force-refreshes it once per catalog after a structure save", async () => {
|
||||
const navigation = useNavigationTargets(dialogs);
|
||||
const target = { connectionId: "connection-1", database: "app", schema: "public", catalog: "catalog-1", tableName: "users" };
|
||||
|
||||
await navigation.openLineageTarget(target);
|
||||
await navigation.openLineageTarget(target);
|
||||
expect(mocks.getColumns).toHaveBeenCalledTimes(1);
|
||||
|
||||
const firstTab = mocks.tabs[0]!;
|
||||
mocks.tabs.push({ ...firstTab, id: "tab-2", tableMeta: { ...firstTab.tableMeta! } });
|
||||
mocks.getColumns.mockResolvedValueOnce([column("fresh_id")]);
|
||||
|
||||
await navigation.onStructureEditorSaved(vi.fn().mockResolvedValue(undefined), vi.fn(), {
|
||||
connectionId: target.connectionId,
|
||||
database: target.database,
|
||||
schema: target.schema,
|
||||
tableName: target.tableName,
|
||||
});
|
||||
|
||||
expect(mocks.getColumns).toHaveBeenCalledTimes(2);
|
||||
expect(mocks.tabs.map((tab) => tab.tableMeta?.primaryKeys)).toEqual([["fresh_id"], ["fresh_id"]]);
|
||||
});
|
||||
|
||||
it("keeps row identity pending when shared metadata loading fails", async () => {
|
||||
mocks.getColumns.mockRejectedValueOnce(new Error("metadata unavailable"));
|
||||
|
||||
await useNavigationTargets(dialogs).openLineageTarget({ connectionId: "connection-1", database: "app", schema: "public", tableName: "users" });
|
||||
|
||||
expect(mocks.tabs[0]?.tableMeta?.columns).toEqual([]);
|
||||
expect(mocks.tabs[0]?.tableMetaPending).toBe(true);
|
||||
});
|
||||
|
||||
it("does not let a stale navigation land metadata over a newer target on a reused tab", async () => {
|
||||
// A 的 getColumns 挂起;B 复用同一 tab 后 A 才返回
|
||||
const columnGates = new Map<string, (columns: unknown[]) => void>();
|
||||
mocks.getColumns.mockImplementation(
|
||||
(_connectionId: string, _database: string, _schema: string, tableName: string) =>
|
||||
new Promise((resolve) => {
|
||||
columnGates.set(tableName, resolve);
|
||||
}),
|
||||
);
|
||||
const navigation = useNavigationTargets(dialogs);
|
||||
const openA = navigation.openLineageTarget({ connectionId: "connection-1", database: "app", schema: "public", tableName: "table_a" });
|
||||
await vi.waitFor(() => expect(columnGates.has("table_a")).toBe(true));
|
||||
|
||||
const openB = navigation.openLineageTarget({ connectionId: "connection-1", database: "app", schema: "public", tableName: "table_b" });
|
||||
await vi.waitFor(() => expect(columnGates.has("table_b")).toBe(true));
|
||||
expect(mocks.tabs).toHaveLength(1);
|
||||
|
||||
// 旧 A 晚返回:不得覆盖 B 的占位身份,不得解除 B 的行标识等待
|
||||
columnGates.get("table_a")?.([column("a_id")]);
|
||||
await openA;
|
||||
expect(mocks.tabs[0]?.tableMeta?.tableName).toBe("table_b");
|
||||
expect(mocks.tabs[0]?.tableMetaPending).toBe(true);
|
||||
|
||||
// B 返回后正常落地
|
||||
columnGates.get("table_b")?.([column("b_id")]);
|
||||
await openB;
|
||||
expect(mocks.tabs[0]?.tableMeta?.tableName).toBe("table_b");
|
||||
expect(mocks.tabs[0]?.tableMeta?.primaryKeys).toEqual(["b_id"]);
|
||||
expect(mocks.tabs[0]?.tableMetaPending).toBe(false);
|
||||
});
|
||||
|
||||
it("stops landing when another entry point takes over the tab, even for the same table", async () => {
|
||||
const { beginDataTabNavigation } = await import("@/lib/tabs/dataTabNavigationGeneration");
|
||||
// A(openTableTarget)的 getColumns 挂起
|
||||
const columnGates = new Map<string, (columns: unknown[]) => void>();
|
||||
mocks.getColumns.mockImplementation(
|
||||
(_connectionId: string, _database: string, _schema: string, tableName: string) =>
|
||||
new Promise((resolve) => {
|
||||
columnGates.set(tableName, resolve);
|
||||
}),
|
||||
);
|
||||
const navigation = useNavigationTargets(dialogs);
|
||||
const openA = navigation.openLineageTarget({ connectionId: "connection-1", database: "app", schema: "public", tableName: "users" });
|
||||
await vi.waitFor(() => expect(columnGates.has("users")).toBe(true));
|
||||
mocks.setTableMeta.mockClear();
|
||||
|
||||
// 侧边栏 openData 接管同一 tab(同表——目标身份校验无法区分):登记新代次即作废旧代次
|
||||
beginDataTabNavigation(mocks.tabs[0]!.id);
|
||||
|
||||
// 旧 A 晚返回:目标身份仍匹配,但代次已作废,不得落地元数据
|
||||
columnGates.get("users")?.([column("id")]);
|
||||
await openA;
|
||||
expect(mocks.setTableMeta).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("skips the tdengine requery when a cancel was requested during the first execute", async () => {
|
||||
// tdengine 无条件走元数据后的第二次查询。模拟:首次 executeTabSql 期间
|
||||
// 用户点击停止,但取消返回 false(查询先完成),isCancelling 被清、
|
||||
// 结果正常——重查仍然必须被跳过(不能替用户重跑他停掉的查询)
|
||||
mocks.databaseType = "tdengine";
|
||||
mocks.executeTabSql.mockImplementationOnce(async (id: string) => {
|
||||
const tab = mocks.tabs.find((item) => item.id === id);
|
||||
if (tab) {
|
||||
// 用户在执行期间请求停止:计数单调递增;随后取消失败、状态被清
|
||||
tab.cancelRequestCount = (tab.cancelRequestCount ?? 0) + 1;
|
||||
tab.isCancelling = false;
|
||||
tab.result = { columns: ["id"], rows: [[1]], affected_rows: 0, execution_time_ms: 1 };
|
||||
}
|
||||
});
|
||||
|
||||
await useNavigationTargets(dialogs).openLineageTarget({ connectionId: "connection-1", database: "app", schema: "public", tableName: "users" });
|
||||
|
||||
// 只有首次执行;tdengine 重查被取消请求拦下,元数据仍正常落地
|
||||
expect(mocks.executeTabSql).toHaveBeenCalledTimes(1);
|
||||
expect(mocks.tabs[0]?.tableMeta?.columns.length).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
it("runs the tdengine requery normally when no cancel was requested", async () => {
|
||||
mocks.databaseType = "tdengine";
|
||||
|
||||
await useNavigationTargets(dialogs).openLineageTarget({ connectionId: "connection-1", database: "app", schema: "public", tableName: "users" });
|
||||
|
||||
// 无取消请求:元数据落地后按既有行为执行第二次查询
|
||||
expect(mocks.executeTabSql).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
it("invalidates the previous execution id when a new navigation reuses the tab", async () => {
|
||||
const columnGates = new Map<string, (columns: unknown[]) => void>();
|
||||
mocks.getColumns.mockImplementation(
|
||||
(_connectionId: string, _database: string, _schema: string, tableName: string) =>
|
||||
new Promise((resolve) => {
|
||||
columnGates.set(tableName, resolve);
|
||||
}),
|
||||
);
|
||||
const navigation = useNavigationTargets(dialogs);
|
||||
const openA = navigation.openLineageTarget({ connectionId: "connection-1", database: "app", schema: "public", tableName: "table_a" });
|
||||
await vi.waitFor(() => expect(columnGates.has("table_a")).toBe(true));
|
||||
const executionIdForA = mocks.tabs[0]?.executionId;
|
||||
|
||||
const openB = navigation.openLineageTarget({ connectionId: "connection-1", database: "app", schema: "public", tableName: "table_b" });
|
||||
// B 开始即作废 A 的执行代次,A 在途查询结果无法再按旧 executionId 落地
|
||||
expect(mocks.tabs[0]?.executionId).toBeDefined();
|
||||
expect(mocks.tabs[0]?.executionId).not.toBe(executionIdForA);
|
||||
|
||||
columnGates.get("table_a")?.([column("a_id")]);
|
||||
await vi.waitFor(() => expect(columnGates.has("table_b")).toBe(true));
|
||||
columnGates.get("table_b")?.([column("b_id")]);
|
||||
await Promise.all([openA, openB]);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,310 @@
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { useSidebarDataOpenRuntime } from "@/composables/useSidebarDataOpenRuntime";
|
||||
import type { QueryTab, TreeNode } from "@/types/database";
|
||||
|
||||
const mocks = vi.hoisted(() => ({
|
||||
databaseType: "oceanbase" as string,
|
||||
callOrder: [] as string[],
|
||||
tabs: [] as QueryTab[],
|
||||
cachedMetadata: undefined as unknown,
|
||||
ensureConnected: vi.fn(),
|
||||
executeTabSql: vi.fn(),
|
||||
loadTableMetadata: vi.fn(),
|
||||
setErrorResult: vi.fn(),
|
||||
cancelTabExecution: vi.fn(),
|
||||
}));
|
||||
|
||||
vi.mock("@/stores/connectionStore", () => ({
|
||||
useConnectionStore: () => ({
|
||||
getConfig: () => ({ id: "connection-1", db_type: mocks.databaseType }),
|
||||
ensureConnected: mocks.ensureConnected,
|
||||
connectionIdentifierQuote: () => undefined,
|
||||
}),
|
||||
}));
|
||||
|
||||
vi.mock("@/stores/queryStore", () => ({
|
||||
useQueryStore: () => ({
|
||||
tabs: mocks.tabs,
|
||||
createTab: (connectionId: string, database: string, title: string, mode: QueryTab["mode"], schema?: string) => {
|
||||
const tab = {
|
||||
id: "tab-1",
|
||||
connectionId,
|
||||
database,
|
||||
title,
|
||||
mode,
|
||||
schema,
|
||||
sql: "",
|
||||
isDirty: false,
|
||||
isExecuting: false,
|
||||
isCancelling: false,
|
||||
isExplaining: false,
|
||||
} as QueryTab;
|
||||
mocks.tabs.push(tab);
|
||||
return tab.id;
|
||||
},
|
||||
switchTab: vi.fn(),
|
||||
cancelTabExecution: mocks.cancelTabExecution,
|
||||
setExecutingWithId: (id: string, executionId: string) => {
|
||||
const tab = mocks.tabs.find((item) => item.id === id);
|
||||
if (tab) {
|
||||
tab.isExecuting = true;
|
||||
tab.executionId = executionId;
|
||||
}
|
||||
},
|
||||
setTableMeta: (id: string, tableMeta: NonNullable<QueryTab["tableMeta"]>) => {
|
||||
const tab = mocks.tabs.find((item) => item.id === id);
|
||||
if (tab) {
|
||||
tab.tableMeta = tableMeta;
|
||||
// 与真实 store 一致:仅真实元数据(columns 非空)落地才结束行标识等待
|
||||
if (tableMeta.columns.length > 0) tab.tableMetaPending = false;
|
||||
}
|
||||
},
|
||||
updateSql: (id: string, sql: string) => {
|
||||
const tab = mocks.tabs.find((item) => item.id === id);
|
||||
if (tab) tab.sql = sql;
|
||||
},
|
||||
executeTabSql: mocks.executeTabSql,
|
||||
setErrorResult: mocks.setErrorResult,
|
||||
}),
|
||||
}));
|
||||
|
||||
vi.mock("@/stores/settingsStore", () => ({
|
||||
useSettingsStore: () => ({ editorSettings: { reuseDataTab: false, pageSize: 100 } }),
|
||||
}));
|
||||
|
||||
vi.mock("@/lib/database/jdbcDialect", () => ({
|
||||
effectiveDatabaseTypeForConnection: () => mocks.databaseType,
|
||||
connectionObjectTreeNodeSchema: (_config: unknown, _database: string, schema?: string) => schema,
|
||||
connectionObjectTreeQuerySchema: (_config: unknown, _database: string, schema?: string) => schema ?? "",
|
||||
}));
|
||||
|
||||
vi.mock("@/lib/metadata/tableMetadataCache", async (importOriginal) => {
|
||||
const actual = await importOriginal<typeof import("@/lib/metadata/tableMetadataCache")>();
|
||||
return {
|
||||
...actual,
|
||||
getCachedTableMetadata: () => mocks.cachedMetadata,
|
||||
loadTableMetadata: mocks.loadTableMetadata,
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock("@/lib/common/utils", () => ({ uuid: () => "open-data-id" }));
|
||||
vi.mock("@/lib/backend/debugLog", () => ({ appendDebugLog: vi.fn(), isDebugLoggingEnabled: () => false }));
|
||||
// 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/tableEditing", () => ({ usesSyntheticRowIdKey: () => false }));
|
||||
vi.mock("@/lib/table/tableOpenPageLimit", () => ({ tableOpenPageLimit: () => 100 }));
|
||||
vi.mock("@/lib/tabs/dataTabActivation", () => ({ canActivateExistingDataTableTab: () => false }));
|
||||
|
||||
const tableNode: TreeNode = {
|
||||
id: "table-users",
|
||||
label: "users",
|
||||
type: "table",
|
||||
connectionId: "connection-1",
|
||||
database: "app",
|
||||
schema: "public",
|
||||
tableType: "TABLE",
|
||||
};
|
||||
|
||||
describe("useSidebarDataOpenRuntime", () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
mocks.databaseType = "oceanbase";
|
||||
mocks.callOrder.length = 0;
|
||||
mocks.tabs.length = 0;
|
||||
mocks.cachedMetadata = undefined;
|
||||
mocks.ensureConnected.mockResolvedValue(undefined);
|
||||
mocks.executeTabSql.mockImplementation(async () => {
|
||||
mocks.callOrder.push("query");
|
||||
});
|
||||
mocks.loadTableMetadata.mockImplementation(async () => {
|
||||
mocks.callOrder.push("metadata");
|
||||
return {
|
||||
metadata: {
|
||||
schema: "public",
|
||||
tableName: "users",
|
||||
tableType: "TABLE",
|
||||
database: "app",
|
||||
columns: [{ name: "id", data_type: "bigint", is_nullable: false, column_default: null, is_primary_key: true, extra: null }],
|
||||
indexes: [],
|
||||
primaryKeys: ["id"],
|
||||
cachedAt: Date.now(),
|
||||
},
|
||||
cacheStatus: "miss",
|
||||
ageMs: 0,
|
||||
};
|
||||
});
|
||||
});
|
||||
|
||||
it("starts cold-cache OceanBase metadata before the table query", async () => {
|
||||
await useSidebarDataOpenRuntime().openData(tableNode);
|
||||
|
||||
await vi.waitFor(() => {
|
||||
expect(mocks.callOrder).toEqual(["metadata", "query"]);
|
||||
expect(mocks.tabs[0]?.tableMeta?.primaryKeys).toEqual(["id"]);
|
||||
});
|
||||
});
|
||||
|
||||
it("keeps Dameng metadata deferred until after the table query", async () => {
|
||||
mocks.databaseType = "dameng";
|
||||
|
||||
await useSidebarDataOpenRuntime().openData(tableNode);
|
||||
|
||||
await vi.waitFor(() => {
|
||||
expect(mocks.callOrder).toEqual(["query", "metadata"]);
|
||||
expect(mocks.tabs[0]?.tableMeta?.primaryKeys).toEqual(["id"]);
|
||||
});
|
||||
});
|
||||
|
||||
it("keeps row identity pending while delayed metadata is in flight and the query finishes first", async () => {
|
||||
// 元数据延迟:查询先返回,元数据仍挂起
|
||||
let releaseMetadata: () => void = () => {};
|
||||
const gate = new Promise<void>((resolve) => {
|
||||
releaseMetadata = resolve;
|
||||
});
|
||||
mocks.loadTableMetadata.mockImplementation(async () => {
|
||||
mocks.callOrder.push("metadata-start");
|
||||
await gate;
|
||||
mocks.callOrder.push("metadata-done");
|
||||
return {
|
||||
metadata: {
|
||||
schema: "public",
|
||||
tableName: "users",
|
||||
tableType: "TABLE",
|
||||
database: "app",
|
||||
columns: [{ name: "id", data_type: "bigint", is_nullable: false, column_default: null, is_primary_key: true, extra: null }],
|
||||
indexes: [],
|
||||
primaryKeys: ["id"],
|
||||
cachedAt: Date.now(),
|
||||
},
|
||||
cacheStatus: "miss",
|
||||
ageMs: 0,
|
||||
};
|
||||
});
|
||||
|
||||
await useSidebarDataOpenRuntime().openData(tableNode);
|
||||
|
||||
// 查询已完成、元数据尚未返回:行标识必须仍处于等待状态,
|
||||
// primaryKeys 为空不得被当作"确认无主键"(#3727 整行 WHERE 保存路径)
|
||||
expect(mocks.callOrder).toEqual(["metadata-start", "query"]);
|
||||
expect(mocks.tabs[0]?.tableMeta?.primaryKeys).toEqual([]);
|
||||
expect(mocks.tabs[0]?.tableMetaPending).toBe(true);
|
||||
|
||||
releaseMetadata();
|
||||
await vi.waitFor(() => {
|
||||
expect(mocks.tabs[0]?.tableMeta?.primaryKeys).toEqual(["id"]);
|
||||
expect(mocks.tabs[0]?.tableMetaPending).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
it("keeps the tab read-only when the metadata load fails", async () => {
|
||||
mocks.loadTableMetadata.mockRejectedValue(new Error("metadata failed"));
|
||||
|
||||
await useSidebarDataOpenRuntime().openData(tableNode);
|
||||
await vi.waitFor(() => {
|
||||
expect(mocks.loadTableMetadata).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
// 行标识仍然未知:保持只读兜底,不回退到整行 WHERE 写入;
|
||||
// 刷新或重开表会重试元数据加载并恢复可编辑
|
||||
expect(mocks.tabs[0]?.tableMetaPending).toBe(true);
|
||||
expect(mocks.tabs[0]?.tableMeta?.primaryKeys).toEqual([]);
|
||||
});
|
||||
|
||||
it("keeps the superseded tab read-only when metadata never starts", async () => {
|
||||
// openData 在 ensureConnected 阶段被新请求取代:元数据请求不会启动
|
||||
let releaseConnect: () => void = () => {};
|
||||
mocks.ensureConnected.mockImplementation(
|
||||
() =>
|
||||
new Promise<void>((resolve) => {
|
||||
releaseConnect = resolve;
|
||||
}),
|
||||
);
|
||||
let current = true;
|
||||
const request = {
|
||||
isCurrent: () => current,
|
||||
signal: new AbortController().signal,
|
||||
registerCancel: () => {},
|
||||
};
|
||||
const open = useSidebarDataOpenRuntime().openData(tableNode, request);
|
||||
await vi.waitFor(() => {
|
||||
expect(mocks.ensureConnected).toHaveBeenCalled();
|
||||
});
|
||||
current = false;
|
||||
releaseConnect();
|
||||
await open;
|
||||
|
||||
// 行标识从未确认:保持只读兜底;重开该表或刷新会重新加载元数据恢复
|
||||
expect(mocks.loadTableMetadata).not.toHaveBeenCalled();
|
||||
expect(mocks.executeTabSql).not.toHaveBeenCalled();
|
||||
expect(mocks.tabs[0]?.tableMetaPending).toBe(true);
|
||||
});
|
||||
|
||||
it("aborts when a newer navigation takes over the tab during the cancel wait", async () => {
|
||||
const { beginDataTabNavigation } = await import("@/lib/tabs/dataTabNavigationGeneration");
|
||||
// 已存在同表 data tab 且有在途执行:真实 findExistingDataTabCandidate 会
|
||||
// 选中它(same-table 复用分支),openData 需先等待取消
|
||||
mocks.tabs.push({
|
||||
id: "existing-tab",
|
||||
connectionId: "connection-1",
|
||||
database: "app",
|
||||
title: "users",
|
||||
mode: "data",
|
||||
schema: "public",
|
||||
sql: "",
|
||||
isDirty: false,
|
||||
isExecuting: true,
|
||||
executionId: "stale-execution",
|
||||
isCancelling: false,
|
||||
isExplaining: false,
|
||||
tableMeta: { schema: "public", tableName: "users", tableType: "TABLE", columns: [], primaryKeys: [] },
|
||||
} as QueryTab);
|
||||
let releaseCancel: () => void = () => {};
|
||||
mocks.cancelTabExecution.mockReturnValueOnce(
|
||||
new Promise<void>((resolve) => {
|
||||
releaseCancel = resolve;
|
||||
}),
|
||||
);
|
||||
const open = useSidebarDataOpenRuntime().openData(tableNode);
|
||||
await vi.waitFor(() => expect(mocks.cancelTabExecution).toHaveBeenCalledWith("existing-tab"));
|
||||
// 复用既有 tab,而非新建
|
||||
expect(mocks.tabs).toHaveLength(1);
|
||||
|
||||
// 取消等待期间,更晚的导航(如 openTableTarget)接管该 tab
|
||||
beginDataTabNavigation("existing-tab");
|
||||
const takeoverMeta = { schema: "public", tableName: "other_table", tableType: "TABLE", columns: [], primaryKeys: [] };
|
||||
mocks.tabs[0]!.tableMeta = takeoverMeta;
|
||||
|
||||
releaseCancel();
|
||||
await open;
|
||||
|
||||
// 旧 openData 必须让位:不得覆盖新导航写入的身份,不得启动查询
|
||||
expect(mocks.tabs[0]?.tableMeta).toBe(takeoverMeta);
|
||||
expect(mocks.executeTabSql).not.toHaveBeenCalled();
|
||||
expect(mocks.loadTableMetadata).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("does not mark row identity pending on a warm metadata cache", async () => {
|
||||
mocks.cachedMetadata = {
|
||||
metadata: {
|
||||
schema: "public",
|
||||
tableName: "users",
|
||||
tableType: "TABLE",
|
||||
database: "app",
|
||||
columns: [{ name: "id", data_type: "bigint", is_nullable: false, column_default: null, is_primary_key: true, extra: null }],
|
||||
indexes: [],
|
||||
primaryKeys: ["id"],
|
||||
cachedAt: Date.now(),
|
||||
},
|
||||
cacheStatus: "hit",
|
||||
ageMs: 0,
|
||||
};
|
||||
|
||||
await useSidebarDataOpenRuntime().openData(tableNode);
|
||||
|
||||
expect(mocks.tabs[0]?.tableMeta?.primaryKeys).toEqual(["id"]);
|
||||
expect(mocks.tabs[0]?.tableMetaPending).toBeFalsy();
|
||||
expect(mocks.loadTableMetadata).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
Reference in new issue
Block a user