fix(connection): invalidate data-tab metadata on disconnect/reconnect

This commit is contained in:
jearhe authored and GitHub committed 2026-08-20 09:25:14 +08:00
1 parent b537c4b891
commit 78aab1e5ed
15 files changed
+804 -31

No files matched your search

@@ -22,6 +22,7 @@ const mocks = vi.hoisted(() => ({
setTableMeta: vi.fn(),
clearInvalidDataTabSort: vi.fn(),
activeResultExecutionTarget: vi.fn(),
metadataGeneration: 0,
}));
vi.mock("vue-i18n", () => ({
@@ -43,6 +44,7 @@ vi.mock("@/stores/connectionStore", () => ({
useConnectionStore: () => ({
getConfig: mocks.getConfig,
ensureConnected: mocks.ensureConnected,
metadataGenerationFor: () => mocks.metadataGeneration,
}),
}));
@@ -74,6 +76,7 @@ vi.mock("@/stores/queryStore", () => ({
const tab = mocks.tabs.find((item) => item.id === id);
if (tab) {
tab.tableMeta = meta;
tab.tableMetaGeneration = mocks.metadataGeneration;
tab.tableMetaUpdatedAt = Date.now();
// 与真实 store 一致:仅真实元数据(columns 非空)落地才结束行标识等待
if (meta.columns.length > 0) tab.tableMetaPending = false;
@@ -111,6 +114,7 @@ function tableDataTab(patch: Partial<QueryTab> = {}): QueryTab {
isCancelling: false,
isExplaining: false,
tableMetaUpdatedAt: Date.now(),
tableMetaGeneration: 0,
tableMeta: {
schema: "public",
tableName: "users",
@@ -131,6 +135,7 @@ describe("useDataGridActions", () => {
mocks.infiniteScroll = true;
mocks.queryResultMaxRowsEnabled = true;
mocks.queryResultMaxRows = 10_000;
mocks.metadataGeneration = 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" });
@@ -399,6 +404,105 @@ describe("useDataGridActions", () => {
});
});
it("rebuilds table metadata before the first toolbar reload after a reconnect boundary", async () => {
const tab = tableDataTab({
tableMetaUpdatedAt: undefined,
tableMetaGeneration: 0,
tableMeta: {
schema: "public",
tableName: "users",
tableType: "TABLE",
columns: [{ name: "id", data_type: "integer", is_nullable: false, column_default: null, is_primary_key: true, extra: null }],
primaryKeys: ["id"],
},
});
mocks.tabs.push(tab);
mocks.metadataGeneration = 1;
mocks.getColumns.mockResolvedValueOnce([
{ name: "id", data_type: "integer", is_nullable: false, column_default: null, is_primary_key: true, extra: null },
{ name: "age", data_type: "integer", is_nullable: true, column_default: null, is_primary_key: false, extra: null },
]);
mocks.listIndexes.mockResolvedValueOnce([]);
const actions = useDataGridActions(computed(() => tab));
await actions.onReloadData(tab.sql, "", "", "", undefined, undefined, "refresh");
expect(mocks.getColumns).toHaveBeenCalledTimes(1);
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(expect.objectContaining({ columns: ["id", "age"] }));
expect(tab.tableMeta?.columns.map((column) => column.name)).toEqual(["id", "age"]);
expect(tab.tableMetaGeneration).toBe(1);
expect(tab.tableMetaUpdatedAt).toBeDefined();
expect(mocks.executeTabSql).toHaveBeenCalledTimes(1);
});
it("rebuilds table metadata on the first toolbar reload after a dead-pool reconnect", async () => {
const tab = tableDataTab({
tableMetaGeneration: 0,
tableMeta: {
schema: "public",
tableName: "users",
tableType: "TABLE",
columns: [{ name: "old_name", data_type: "text", is_nullable: true, column_default: null, is_primary_key: false, extra: null }],
primaryKeys: [],
},
});
mocks.tabs.push(tab);
mocks.ensureConnected.mockImplementationOnce(async () => {
mocks.metadataGeneration = 1;
});
mocks.getColumns.mockResolvedValueOnce([{ name: "new_name", data_type: "text", is_nullable: true, column_default: null, is_primary_key: false, extra: null }]);
const actions = useDataGridActions(computed(() => tab));
await actions.onReloadData(tab.sql, "", "", "", undefined, undefined, "refresh");
expect(mocks.ensureConnected).toHaveBeenCalled();
expect(mocks.getColumns).toHaveBeenCalledTimes(1);
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(expect.objectContaining({ columns: ["new_name"] }));
expect(mocks.executeTabSql).toHaveBeenCalledTimes(1);
});
it("does not refetch metadata on a warm toolbar reload in the same generation", async () => {
const tab = tableDataTab();
mocks.tabs.push(tab);
const actions = useDataGridActions(computed(() => tab));
await actions.onReloadData(tab.sql, "", "", "", undefined, undefined, "refresh");
expect(mocks.getColumns).not.toHaveBeenCalled();
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(expect.objectContaining({ columns: ["id"] }));
expect(mocks.executeTabSql).toHaveBeenCalledTimes(1);
});
it("drops an in-flight toolbar metadata write after disconnect bumps generation", async () => {
const tab = tableDataTab({
tableMetaUpdatedAt: undefined,
tableMetaGeneration: 0,
});
mocks.tabs.push(tab);
mocks.metadataGeneration = 0;
let resolveColumns!: (columns: Array<{ name: string; data_type: string; is_nullable: boolean; column_default: null; is_primary_key: boolean; extra: null }>) => void;
mocks.getColumns.mockReturnValueOnce(
new Promise((resolve) => {
resolveColumns = resolve;
}),
);
const actions = useDataGridActions(computed(() => tab));
const reload = actions.onReloadData(tab.sql, "", "", "", undefined, undefined, "refresh");
await vi.waitFor(() => expect(mocks.getColumns).toHaveBeenCalledTimes(1));
mocks.metadataGeneration = 1;
tab.tableMetaUpdatedAt = undefined;
resolveColumns([{ name: "id", data_type: "integer", is_nullable: false, column_default: null, is_primary_key: true, extra: null }]);
await reload;
expect(mocks.setTableMeta).not.toHaveBeenCalled();
expect(tab.tableMeta?.columns.map((column) => column.name)).toEqual(["id"]);
expect(tab.tableMetaUpdatedAt).toBeUndefined();
expect(tab.tableMetaGeneration).toBe(0);
expect(mocks.buildTableSelectSql).not.toHaveBeenCalled();
expect(mocks.executeTabSql).not.toHaveBeenCalled();
});
it("excludes hidden primary keys and remaps the selected column for database sorting", async () => {
const tab = {
id: "tab-1",
@@ -28,6 +28,7 @@ vi.mock("@/stores/connectionStore", () => ({
getConfig: () => ({ id: "connection-1", db_type: mocks.databaseType }),
ensureConnected: mocks.ensureConnected,
connectionIdentifierQuote: () => undefined,
metadataGenerationFor: () => 0,
refreshObjectListTreeNode: vi.fn(),
invalidateCompletionTableCache: mocks.invalidateCompletionTableCache,
}),
@@ -9,6 +9,8 @@ const mocks = vi.hoisted(() => ({
getConfig: vi.fn((connectionId: string) => ({ id: connectionId, db_type: "postgres" })),
ensureConnected: vi.fn(),
connectionIdentifierQuote: vi.fn(() => undefined),
// 与真实 store 一致:setTableMeta 记录连接元数据代次
metadataGenerationFor: vi.fn(() => 0),
refreshObjectListTreeNode: vi.fn(),
invalidateCompletionTableCache: vi.fn(),
},
@@ -11,6 +11,7 @@ const mocks = vi.hoisted(() => ({
cachedMetadata: undefined as unknown,
dataTabReuseMode: "same-table" as DataTabReuseMode,
openDataTabsNextToActive: false,
metadataGeneration: 0,
ensureConnected: vi.fn(),
executeTabSql: vi.fn(),
loadTableMetadata: vi.fn(),
@@ -24,6 +25,7 @@ vi.mock("@/stores/connectionStore", () => ({
getConfig: () => ({ id: "connection-1", db_type: mocks.databaseType }),
ensureConnected: mocks.ensureConnected,
connectionIdentifierQuote: () => undefined,
metadataGenerationFor: () => mocks.metadataGeneration,
}),
}));
@@ -76,6 +78,9 @@ vi.mock("@/stores/queryStore", () => ({
const tab = mocks.tabs.find((item) => item.id === id);
if (tab) {
tab.tableMeta = tableMeta;
// 与真实 store 一致:记录写入时的连接元数据代次
tab.tableMetaGeneration = mocks.metadataGeneration;
tab.tableMetaUpdatedAt = Date.now();
// 与真实 store 一致:仅真实元数据(columns 非空)落地才结束行标识等待
if (tableMeta.columns.length > 0) tab.tableMetaPending = false;
}
@@ -145,6 +150,7 @@ describe("useSidebarDataOpenRuntime", () => {
mocks.cachedMetadata = undefined;
mocks.dataTabReuseMode = "same-table";
mocks.openDataTabsNextToActive = false;
mocks.metadataGeneration = 0;
mocks.ensureConnected.mockResolvedValue(undefined);
mocks.buildTableSelectSql.mockResolvedValue("SELECT * FROM users");
mocks.executeTabSql.mockImplementation(async () => {
@@ -508,6 +514,8 @@ describe("useSidebarDataOpenRuntime", () => {
primaryKeys: ["id"],
},
tableMetaUpdatedAt: Date.now(),
// 真实 tab 的 tableMeta 必经 setTableMeta 写入并记录当前代次(0)
tableMetaGeneration: 0,
} as QueryTab);
mocks.activeTabId = null;
@@ -542,4 +550,122 @@ describe("useSidebarDataOpenRuntime", () => {
expect(mocks.tabs[0]?.tableMetaPending).toBeFalsy();
expect(mocks.loadTableMetadata).not.toHaveBeenCalled();
});
it("keeps tab-local metadata warm within the TTL window (no reload on reopen)", async () => {
const reload = vi.fn();
mocks.loadTableMetadata.mockImplementation(async () => {
reload();
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);
// 第一次打开已把 tab-local tableMetaUpdatedAt 置为新鲜
expect(mocks.tabs[0]?.tableMetaUpdatedAt).toBeDefined();
// 复位执行态,让第二次打开走重开(reuse)路径而非 activate 早退
mocks.tabs[0]!.isExecuting = false;
mocks.tabs[0]!.executionId = undefined;
// 未发生连接生命周期变化:TTL 窗口内重开同表直接复用 tab-local 元数据
await useSidebarDataOpenRuntime().openData(tableNode);
expect(reload).toHaveBeenCalledTimes(1);
expect(mocks.tabs[0]?.tableMeta?.tableName).toBe("users");
});
it("reloads tab metadata after a reconnect boundary (issue #6623 reconnect regression)", async () => {
// 第一次打开的元数据:[id]
await useSidebarDataOpenRuntime().openData(tableNode);
expect(mocks.loadTableMetadata).toHaveBeenCalledTimes(1);
expect(mocks.tabs[0]?.tableMeta?.columns.map((column) => column.name)).toEqual(["id"]);
expect(mocks.tabs[0]?.tableMetaUpdatedAt).toBeDefined();
// 外部 ALTER TABLE ... ADD age:DBX 断开→重连。断开时 connectionStore 会
// 清掉该连接下数据标签页的 freshness 戳(staleConnectionDataTabMetadata),
// 此处等价模拟该生命周期边界。
mocks.tabs[0]!.tableMetaUpdatedAt = undefined;
mocks.tabs[0]!.isExecuting = false;
mocks.tabs[0]!.executionId = undefined;
// 第二次打开(重连后):即使处于原 30s TTL 窗口内,也必须重新拉取结构
mocks.loadTableMetadata.mockImplementationOnce(async () => ({
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 },
{ name: "age", data_type: "integer", is_nullable: true, column_default: null, is_primary_key: false, extra: null },
],
indexes: [],
primaryKeys: ["id"],
cachedAt: Date.now(),
},
cacheStatus: "miss",
ageMs: 0,
}));
await useSidebarDataOpenRuntime().openData(tableNode);
expect(mocks.loadTableMetadata).toHaveBeenCalledTimes(2);
await vi.waitFor(() => {
expect(mocks.tabs[0]?.tableMeta?.columns.map((column) => column.name)).toContain("age");
});
});
it("does not write stale in-flight metadata back to the tab after a disconnect boundary", async () => {
// 手动挂起的元数据加载:openData 启动后台加载后停留在 in-flight
let resolveMetadata!: (value: Awaited<ReturnType<typeof mocks.loadTableMetadata>>) => void;
const pendingMetadata = new Promise<Awaited<ReturnType<typeof mocks.loadTableMetadata>>>((resolve) => {
resolveMetadata = resolve;
});
mocks.loadTableMetadata.mockReturnValueOnce(pendingMetadata);
const openPromise = useSidebarDataOpenRuntime().openData(tableNode);
await vi.waitFor(() => {
expect(mocks.loadTableMetadata).toHaveBeenCalledTimes(1);
});
// 模拟 disconnect 生命周期边界:连接代次递增 + freshness 戳被清
// (staleConnectionDataTabMetadata)
mocks.metadataGeneration = 1;
mocks.tabs[0]!.tableMetaUpdatedAt = undefined;
// 旧连接在途的结果此时才返回:shared 缓存写回已被 per-scope 失效代数
// 挡住,tab-local 写回必须被连接代次校验拦下(PR #6640 review blocker 1)
resolveMetadata({
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 openPromise;
await vi.waitFor(() => {
expect(mocks.tabs[0]?.tableMetaUpdatedAt).toBeUndefined();
});
// 占位元数据未被旧列覆盖:freshness 保持在失效后的"冷"状态
expect(mocks.tabs[0]?.tableMeta?.columns).toEqual([]);
expect(mocks.tabs[0]?.tableMetaGeneration).toBe(0);
});
});