fix(grid): refresh table metadata before reloading data

This commit is contained in:
soddygo authored and GitHub committed 2026-09-15 16:00:03 +08:00
1 parent 2ee04c51ec
commit fd4ca30707
6 files changed
+353 -110

No files matched your search

@@ -14,6 +14,7 @@ const mocks = vi.hoisted(() => ({
setExecuting: vi.fn(),
updateSql: vi.fn(),
getColumns: vi.fn(),
deleteSchemaCachePrefix: vi.fn(),
listIndexes: vi.fn(),
ensureConnected: vi.fn(),
tableOpenPageSize: 100,
@@ -35,6 +36,7 @@ vi.mock("vue-i18n", () => ({
vi.mock("@/lib/backend/api", () => ({
buildSortedQuerySql: mocks.buildSortedQuerySql,
getColumns: mocks.getColumns,
deleteSchemaCachePrefix: mocks.deleteSchemaCachePrefix,
listIndexes: mocks.listIndexes,
}));
@@ -136,6 +138,7 @@ describe("useDataGridActions", () => {
clearTableMetadataCache();
vi.clearAllMocks();
mocks.executeTabSql.mockReset();
mocks.deleteSchemaCachePrefix.mockReset().mockResolvedValue(undefined);
mocks.tabs.length = 0;
mocks.tableOpenPageSize = 100;
mocks.infiniteScroll = true;
@@ -152,10 +155,151 @@ describe("useDataGridActions", () => {
mocks.listIndexes.mockResolvedValue([]);
});
it("manual refresh waits for cache deletion and fresh columns before building SQL", async () => {
const tab = tableDataTab();
mocks.tabs.push(tab);
let release!: () => void;
mocks.deleteSchemaCachePrefix.mockReturnValue(
new Promise<void>((resolve) => {
release = resolve;
}),
);
mocks.getColumns.mockResolvedValue([...tab.tableMeta!.columns, { name: "added", data_type: "text", is_nullable: true }]);
const actions = useDataGridActions(computed(() => tab));
const reload = actions.onReloadData(tab.id, tab.sql, "", "", "", 25, 50, "refresh");
await vi.waitFor(() => expect(mocks.deleteSchemaCachePrefix).toHaveBeenCalledWith("object-meta:v1:postgres-1:app:public:users:"));
expect(mocks.getColumns).not.toHaveBeenCalled();
expect(mocks.buildTableSelectSql).not.toHaveBeenCalled();
release();
await reload;
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(expect.objectContaining({ columns: ["id", "added"], limit: 25, offset: 50 }));
});
it("preserves rows when cache deletion fails and allows retry", async () => {
const tab = tableDataTab();
mocks.tabs.push(tab);
const result = tab.result;
const failure = new Error("cache deletion failed");
mocks.deleteSchemaCachePrefix.mockRejectedValueOnce(failure);
const actions = useDataGridActions(computed(() => tab));
await expect(actions.onReloadData(tab.id, tab.sql, "", "", "", 100, 0, "refresh")).rejects.toMatchObject({ name: "ObjectCacheInvalidationError", reason: failure });
expect(tab.result).toBe(result);
expect(mocks.getColumns).not.toHaveBeenCalled();
expect(mocks.executeTabSql).not.toHaveBeenCalled();
expect(mocks.setExecuting).toHaveBeenLastCalledWith(tab.id, false);
await actions.onReloadData(tab.id, tab.sql, "", "", "", 100, 0, "refresh");
expect(mocks.executeTabSql).toHaveBeenCalledTimes(1);
});
it("waits for fresh columns and suppresses a duplicate refresh", async () => {
const tab = tableDataTab();
mocks.tabs.push(tab);
let release!: (columns: unknown[]) => void;
mocks.getColumns.mockReturnValueOnce(
new Promise((resolve) => {
release = resolve;
}),
);
const actions = useDataGridActions(computed(() => tab));
const reload = actions.onReloadData(tab.id, tab.sql, "", "", "", 100, 0, "refresh");
await vi.waitFor(() => expect(mocks.getColumns).toHaveBeenCalledTimes(1));
await actions.onReloadData(tab.id, tab.sql, "", "", "", 100, 0, "refresh");
expect(mocks.buildTableSelectSql).not.toHaveBeenCalled();
release([{ ...tab.tableMeta!.columns[0], name: "renamed", data_type: "bigint" }]);
await reload;
expect(mocks.executeTabSql).toHaveBeenCalledTimes(1);
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(expect.objectContaining({ columns: ["renamed"] }));
expect(tab.tableMeta!.columns[0].data_type).toBe("bigint");
});
it("does not execute after the tab is replaced during metadata loading", async () => {
const tab = tableDataTab();
mocks.tabs.push(tab);
let release!: (columns: unknown[]) => void;
mocks.getColumns.mockReturnValueOnce(
new Promise((resolve) => {
release = resolve;
}),
);
const actions = useDataGridActions(computed(() => tab));
const reload = actions.onReloadData(tab.id, tab.sql, "", "", "", 100, 0, "refresh");
await vi.waitFor(() => expect(mocks.getColumns).toHaveBeenCalledTimes(1));
mocks.tabs.splice(0, 1, tableDataTab());
release(tab.tableMeta!.columns);
await reload;
expect(mocks.setTableMeta).not.toHaveBeenCalled();
expect(mocks.executeTabSql).not.toHaveBeenCalled();
});
it("does not execute old SQL or clear a replacement tab's loading state after SQL generation", async () => {
const tab = tableDataTab();
mocks.tabs.push(tab);
let release!: (sql: string) => void;
mocks.buildTableSelectSql.mockReturnValueOnce(
new Promise<string>((resolve) => {
release = resolve;
}),
);
const actions = useDataGridActions(computed(() => tab));
const reload = actions.onReloadData(tab.id, tab.sql, "", "", "", 100, 0, "refresh");
await vi.waitFor(() => expect(mocks.buildTableSelectSql).toHaveBeenCalledTimes(1));
mocks.tabs.splice(0, 1, tableDataTab({ isExecuting: true }));
mocks.setExecuting.mockClear();
release("SELECT old_target");
await reload;
expect(mocks.updateSql).not.toHaveBeenCalled();
expect(mocks.executeTabSql).not.toHaveBeenCalled();
expect(mocks.setExecuting).not.toHaveBeenCalled();
});
it.each(["closed", "retargeted", "reconnected"] as const)("abandons SQL prepared for a %s tab", async (change) => {
const tab = tableDataTab();
mocks.tabs.push(tab);
let release!: (sql: string) => void;
mocks.buildTableSelectSql.mockReturnValueOnce(
new Promise<string>((resolve) => {
release = resolve;
}),
);
const actions = useDataGridActions(computed(() => tab));
const reload = actions.onReloadData(tab.id, tab.sql, "", "", "", 100, 0, "refresh");
await vi.waitFor(() => expect(mocks.buildTableSelectSql).toHaveBeenCalledTimes(1));
if (change === "closed") mocks.tabs.length = 0;
if (change === "retargeted") tab.tableMeta!.tableName = "other_table";
if (change === "reconnected") mocks.metadataGeneration++;
release("SELECT stale_target");
await reload;
expect(mocks.updateSql).not.toHaveBeenCalled();
expect(mocks.executeTabSql).not.toHaveBeenCalled();
});
it("does not let an older background metadata read overwrite manual refresh", async () => {
const tab = tableDataTab({ tableMetaUpdatedAt: 1 });
mocks.tabs.push(tab);
const oldColumns = tab.tableMeta!.columns;
let release!: (columns: unknown[]) => void;
mocks.getColumns.mockReturnValueOnce(
new Promise((resolve) => {
release = resolve;
}),
);
const actions = useDataGridActions(computed(() => tab));
await actions.onReloadData(tab.id, tab.sql, "", "", "", 100, 0, "auto-refresh");
await vi.waitFor(() => expect(mocks.getColumns).toHaveBeenCalledTimes(1));
mocks.getColumns.mockResolvedValueOnce([...oldColumns, { ...oldColumns[0], name: "added" }]);
await actions.onReloadData(tab.id, tab.sql, "", "", "", 100, 0, "refresh");
expect(tab.tableMeta!.columns.map((column) => column.name)).toEqual(["id", "added"]);
release(oldColumns);
// Drain the old metadata promise and its consumers.
await new Promise((resolve) => setTimeout(resolve, 0));
expect(tab.tableMeta!.columns.map((column) => column.name)).toEqual(["id", "added"]);
});
it("uses the configured table-data default when toolbar reload has no saved pagination", async () => {
mocks.tableOpenPageSize = 250;
mocks.buildTableSelectSql.mockResolvedValueOnce("SELECT * FROM public.users LIMIT 250 OFFSET 0");
const tab = tableDataTab();
mocks.tabs.push(tab);
const actions = useDataGridActions(computed(() => tab));
await actions.onReloadData(tab.id, tab.sql, "", "", "", undefined, undefined, "refresh");
@@ -297,6 +441,7 @@ describe("useDataGridActions", () => {
resultPageOffset: 50,
});
mocks.buildTableSelectSql.mockResolvedValueOnce("SELECT * FROM public.users LIMIT 25 OFFSET 50");
mocks.tabs.push(tab);
const actions = useDataGridActions(computed(() => tab));
await actions.onReloadData(tab.id, tab.sql, "", "", "", 25, 50, "refresh");
@@ -316,6 +461,7 @@ describe("useDataGridActions", () => {
},
});
mocks.buildTableSelectSql.mockResolvedValueOnce("SELECT * FROM public.users LIMIT 100 OFFSET 100");
mocks.tabs.push(tab);
const actions = useDataGridActions(computed(() => tab));
await actions.onPaginate(tab.id, 100, 100);
@@ -448,8 +594,8 @@ describe("useDataGridActions", () => {
await actions.onReloadData(tab.id, tab.sql, "", "", "", undefined, undefined, "refresh");
// 合成的 ["Error"] 结果列不得进入 SQL 投影:真实列缺失时省略 columns(SELECT *)
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(expect.objectContaining({ columns: undefined }));
// Explicit refresh waits for actual metadata rather than projecting fallback error columns.
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(expect.objectContaining({ columns: ["id"] }));
await vi.waitFor(() => {
expect(mocks.getColumns).toHaveBeenCalled();
expect(mocks.setTableMeta).toHaveBeenCalledWith("tab-1", expect.objectContaining({ primaryKeys: ["id"] }));
@@ -467,7 +613,7 @@ describe("useDataGridActions", () => {
// 第一轮:stale-tab 早退(tabs 里找不到匹配项时 refreshDataTabTableMeta 直接返回)
mocks.tabs.length = 0;
await actions.onReloadData(tab.id, tab.sql, "", "", "", undefined, undefined, "refresh");
await actions.onReloadData(tab.id, tab.sql, "", "", "", undefined, undefined, "auto-refresh");
await vi.waitFor(() => expect(mocks.getColumns).toHaveBeenCalledTimes(1));
expect(mocks.setTableMeta).not.toHaveBeenCalled();
expect(tab.tableMetaPending).toBe(true);
@@ -475,7 +621,7 @@ describe("useDataGridActions", () => {
// 第二轮:真实 columns 仍为空,新的消费者加入同一在途请求;共享缓存应
// 去重后端调用,但本轮仍要在目标恢复后落地结果
mocks.tabs.push(tab);
await actions.onReloadData(tab.id, tab.sql, "", "", "", undefined, undefined, "refresh");
await actions.onReloadData(tab.id, tab.sql, "", "", "", undefined, undefined, "auto-refresh");
await vi.waitFor(() => {
expect(mocks.getColumns).toHaveBeenCalledTimes(1);
expect(mocks.setTableMeta).toHaveBeenCalledWith("tab-1", expect.objectContaining({ primaryKeys: ["id"] }));
@@ -502,7 +648,7 @@ describe("useDataGridActions", () => {
mocks.tabs.push(tab);
const actions = useDataGridActions(computed(() => tab));
await actions.onReloadData(tab.id, tab.sql, "", "", "", undefined, undefined, "refresh");
await actions.onReloadData(tab.id, tab.sql, "", "", "", undefined, undefined, "auto-refresh");
// Dameng 元数据必须排在数据查询之后(串行约束,同 useSidebarDataOpenRuntime);
// 真实元数据落地后结束行标识等待
@@ -525,7 +671,7 @@ describe("useDataGridActions", () => {
const actions = useDataGridActions(computed(() => tab));
// 查询 reject 仍会重新抛出,但元数据刷新必须已启动,标签页可恢复
await expect(actions.onReloadData(tab.id, tab.sql, "", "", "", undefined, undefined, "refresh")).rejects.toThrow("query failed");
await expect(actions.onReloadData(tab.id, tab.sql, "", "", "", undefined, undefined, "auto-refresh")).rejects.toThrow("query failed");
await vi.waitFor(() => {
expect(mocks.getColumns).toHaveBeenCalled();
expect(tab.tableMetaPending).toBe(false);
@@ -589,12 +735,12 @@ describe("useDataGridActions", () => {
expect(mocks.executeTabSql).toHaveBeenCalledTimes(1);
});
it("does not refetch metadata on a warm toolbar reload in the same generation", async () => {
it("does not refetch metadata on a warm automatic reload in the same generation", async () => {
const tab = tableDataTab();
mocks.tabs.push(tab);
const actions = useDataGridActions(computed(() => tab));
await actions.onReloadData(tab.id, tab.sql, "", "", "", undefined, undefined, "refresh");
await actions.onReloadData(tab.id, tab.sql, "", "", "", undefined, undefined, "auto-refresh");
expect(mocks.getColumns).not.toHaveBeenCalled();
expect(mocks.buildTableSelectSql).toHaveBeenCalledWith(expect.objectContaining({ columns: ["id"] }));