fix(grid): refresh comments for restored data tabs
This commit is contained in:
3 files changed
+87
-54
No files matched your search
@@ -7,7 +7,7 @@ import { uuid } from "@/lib/common/utils";
|
|||||||
import { appendDebugLog, isDebugLoggingEnabled } from "@/lib/backend/debugLog";
|
import { appendDebugLog, isDebugLoggingEnabled } from "@/lib/backend/debugLog";
|
||||||
import { effectiveDatabaseTypeForConnection, connectionObjectTreeNodeSchema, connectionObjectTreeQuerySchema } from "@/lib/database/jdbcDialect";
|
import { effectiveDatabaseTypeForConnection, connectionObjectTreeNodeSchema, connectionObjectTreeQuerySchema } from "@/lib/database/jdbcDialect";
|
||||||
import { getCachedTableMetadata, loadTableMetadata, TABLE_METADATA_CACHE_TTL_MS, tableMetadataToDataTabMeta } from "@/lib/metadata/tableMetadataCache";
|
import { getCachedTableMetadata, loadTableMetadata, TABLE_METADATA_CACHE_TTL_MS, tableMetadataToDataTabMeta } from "@/lib/metadata/tableMetadataCache";
|
||||||
import { canApplyDataTabMetadata, findExistingDataTabCandidate, type DataTabOpenMode } from "@/lib/sidebar/dataTabOpenPolicy";
|
import { canApplyDataTabMetadata, dataTabMetadataNeedsRefresh, findExistingDataTabCandidate, type DataTabOpenMode } from "@/lib/sidebar/dataTabOpenPolicy";
|
||||||
import type { SidebarDataOpenRequest } from "@/lib/sidebar/sidebarDataOpenCoordinator";
|
import type { SidebarDataOpenRequest } from "@/lib/sidebar/sidebarDataOpenCoordinator";
|
||||||
import { hasTreeNodeDatabaseContext } from "@/lib/sidebar/treeNodeContext";
|
import { hasTreeNodeDatabaseContext } from "@/lib/sidebar/treeNodeContext";
|
||||||
import { buildTableSelectSql } from "@/lib/table/tableSelectSql";
|
import { buildTableSelectSql } from "@/lib/table/tableSelectSql";
|
||||||
@@ -65,6 +65,57 @@ export function useSidebarDataOpenRuntime() {
|
|||||||
catalog: node.catalog,
|
catalog: node.catalog,
|
||||||
tableName: node.label,
|
tableName: node.label,
|
||||||
};
|
};
|
||||||
|
const canApplyTableMetadata = (targetTabId: string) =>
|
||||||
|
canApplyDataTabMetadata(
|
||||||
|
queryStore.tabs.find((tab) => tab.id === targetTabId),
|
||||||
|
dataTabTarget,
|
||||||
|
request?.signal,
|
||||||
|
);
|
||||||
|
const refreshTableMetaInBackground = async (targetTabId: string, ensureConnected = false) => {
|
||||||
|
if (!config) return;
|
||||||
|
const metadataStartedAt = performance.now();
|
||||||
|
openDataLog("info", "metadata:start", {
|
||||||
|
traceId,
|
||||||
|
elapsed: elapsed(),
|
||||||
|
});
|
||||||
|
try {
|
||||||
|
if (ensureConnected) await connectionStore.ensureConnected(node.connectionId);
|
||||||
|
const loadedMetadata = await loadTableMetadata({
|
||||||
|
connectionId: node.connectionId,
|
||||||
|
database: node.database,
|
||||||
|
schema: querySchema,
|
||||||
|
tableName: node.label,
|
||||||
|
tableType,
|
||||||
|
databaseType: metadataDatabaseType,
|
||||||
|
driverProfile: config.driver_profile || config.db_type,
|
||||||
|
catalog: node.catalog,
|
||||||
|
traceLogger: isDebugLoggingEnabled() ? (event) => openDataLog("debug", "metadata:trace", { sourceTraceId: traceId, ...event }) : undefined,
|
||||||
|
});
|
||||||
|
if (!canApplyTableMetadata(targetTabId)) {
|
||||||
|
openDataLog("info", "metadata:stale", {
|
||||||
|
traceId,
|
||||||
|
tabId: targetTabId,
|
||||||
|
columnCount: loadedMetadata.metadata.columns.length,
|
||||||
|
elapsed: elapsed(),
|
||||||
|
});
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const nextTableMeta = tableMetadataToDataTabMeta(loadedMetadata.metadata, tableSchema);
|
||||||
|
queryStore.setTableMeta(targetTabId, nextTableMeta);
|
||||||
|
openDataLog("info", "metadata:done", {
|
||||||
|
traceId,
|
||||||
|
tabId: targetTabId,
|
||||||
|
columnCount: nextTableMeta.columns.length,
|
||||||
|
primaryKeyCount: nextTableMeta.primaryKeys.length,
|
||||||
|
cacheStatus: loadedMetadata.cacheStatus,
|
||||||
|
ageMs: Math.round(loadedMetadata.ageMs),
|
||||||
|
elapsed: elapsed(),
|
||||||
|
metadataMs: Math.round(performance.now() - metadataStartedAt),
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
openDataLog("warn", "metadata:error", { traceId, tabId: targetTabId, elapsed: elapsed(), error });
|
||||||
|
}
|
||||||
|
};
|
||||||
const existingDataTabCandidate = findExistingDataTabCandidate(queryStore.tabs, dataTabTarget, { openMode, reuseDataTab: settingsStore.editorSettings.reuseDataTab });
|
const existingDataTabCandidate = findExistingDataTabCandidate(queryStore.tabs, dataTabTarget, { openMode, reuseDataTab: settingsStore.editorSettings.reuseDataTab });
|
||||||
const existingSameTableTab = existingDataTabCandidate?.match === "same-table" ? existingDataTabCandidate.tab : undefined;
|
const existingSameTableTab = existingDataTabCandidate?.match === "same-table" ? existingDataTabCandidate.tab : undefined;
|
||||||
const resetReusedDataTabState = (tab: (typeof queryStore.tabs)[number]) => {
|
const resetReusedDataTabState = (tab: (typeof queryStore.tabs)[number]) => {
|
||||||
@@ -93,6 +144,10 @@ export function useSidebarDataOpenRuntime() {
|
|||||||
if (existingSameTableTab && canActivateExistingDataTableTab(existingSameTableTab, { activateExecuting: false })) {
|
if (existingSameTableTab && canActivateExistingDataTableTab(existingSameTableTab, { activateExecuting: false })) {
|
||||||
queryStore.switchTab(existingSameTableTab.id);
|
queryStore.switchTab(existingSameTableTab.id);
|
||||||
logPhase("existing-tab-activated", { table: node.label });
|
logPhase("existing-tab-activated", { table: node.label });
|
||||||
|
if (dataTabMetadataNeedsRefresh(existingSameTableTab, DATA_TAB_METADATA_TTL_MS)) {
|
||||||
|
void refreshTableMetaInBackground(existingSameTableTab.id, true);
|
||||||
|
logPhase("metadata-started", { tabId: existingSameTableTab.id, reason: "existing-tab-stale" });
|
||||||
|
}
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -171,12 +226,6 @@ export function useSidebarDataOpenRuntime() {
|
|||||||
|
|
||||||
// Helper to check if this openData call is still active (not superseded by a newer click)
|
// Helper to check if this openData call is still active (not superseded by a newer click)
|
||||||
const isActive = () => (request?.isCurrent() ?? true) && queryStore.tabs.find((t) => t.id === tabId)?.executionId === openDataId;
|
const isActive = () => (request?.isCurrent() ?? true) && queryStore.tabs.find((t) => t.id === tabId)?.executionId === openDataId;
|
||||||
const canApplyTableMetadata = () =>
|
|
||||||
canApplyDataTabMetadata(
|
|
||||||
queryStore.tabs.find((t) => t.id === tabId),
|
|
||||||
dataTabTarget,
|
|
||||||
request?.signal,
|
|
||||||
);
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
openDataLog("info", "ensure-connected:start", { traceId, elapsed: elapsed() });
|
openDataLog("info", "ensure-connected:start", { traceId, elapsed: elapsed() });
|
||||||
@@ -190,49 +239,6 @@ export function useSidebarDataOpenRuntime() {
|
|||||||
if (!config) throw new Error("Connection config not found");
|
if (!config) throw new Error("Connection config not found");
|
||||||
|
|
||||||
const limit = tableOpenPageLimit();
|
const limit = tableOpenPageLimit();
|
||||||
const refreshTableMetaInBackground = async () => {
|
|
||||||
const metadataStartedAt = performance.now();
|
|
||||||
openDataLog("info", "metadata:start", {
|
|
||||||
traceId,
|
|
||||||
elapsed: elapsed(),
|
|
||||||
});
|
|
||||||
try {
|
|
||||||
const loadedMetadata = await loadTableMetadata({
|
|
||||||
connectionId: node.connectionId,
|
|
||||||
database: node.database,
|
|
||||||
schema: querySchema,
|
|
||||||
tableName: node.label,
|
|
||||||
tableType,
|
|
||||||
databaseType: metadataDatabaseType,
|
|
||||||
driverProfile: config.driver_profile || config.db_type,
|
|
||||||
catalog: node.catalog,
|
|
||||||
traceLogger: isDebugLoggingEnabled() ? (event) => openDataLog("debug", "metadata:trace", { sourceTraceId: traceId, ...event }) : undefined,
|
|
||||||
});
|
|
||||||
if (!canApplyTableMetadata()) {
|
|
||||||
openDataLog("info", "metadata:stale", {
|
|
||||||
traceId,
|
|
||||||
tabId,
|
|
||||||
columnCount: loadedMetadata.metadata.columns.length,
|
|
||||||
elapsed: elapsed(),
|
|
||||||
});
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const nextTableMeta = tableMetadataToDataTabMeta(loadedMetadata.metadata, tableSchema);
|
|
||||||
queryStore.setTableMeta(tabId, nextTableMeta);
|
|
||||||
openDataLog("info", "metadata:done", {
|
|
||||||
traceId,
|
|
||||||
tabId,
|
|
||||||
columnCount: nextTableMeta.columns.length,
|
|
||||||
primaryKeyCount: nextTableMeta.primaryKeys.length,
|
|
||||||
cacheStatus: loadedMetadata.cacheStatus,
|
|
||||||
ageMs: Math.round(loadedMetadata.ageMs),
|
|
||||||
elapsed: elapsed(),
|
|
||||||
metadataMs: Math.round(performance.now() - metadataStartedAt),
|
|
||||||
});
|
|
||||||
} catch (error) {
|
|
||||||
openDataLog("warn", "metadata:error", { traceId, tabId, elapsed: elapsed(), error });
|
|
||||||
}
|
|
||||||
};
|
|
||||||
const shouldRefreshTableMeta = !cachedTableMeta;
|
const shouldRefreshTableMeta = !cachedTableMeta;
|
||||||
if (cachedTableMeta) {
|
if (cachedTableMeta) {
|
||||||
openDataLog("info", "metadata:cache-hit", {
|
openDataLog("info", "metadata:cache-hit", {
|
||||||
@@ -289,8 +295,8 @@ export function useSidebarDataOpenRuntime() {
|
|||||||
});
|
});
|
||||||
openDataLog("info", "execute:done", { traceId, tabId, elapsed: elapsed() });
|
openDataLog("info", "execute:done", { traceId, tabId, elapsed: elapsed() });
|
||||||
logPhase("execute-tab-sql", { tabId });
|
logPhase("execute-tab-sql", { tabId });
|
||||||
if (shouldRefreshTableMeta && canApplyTableMetadata()) {
|
if (shouldRefreshTableMeta && canApplyTableMetadata(tabId)) {
|
||||||
void refreshTableMetaInBackground();
|
void refreshTableMetaInBackground(tabId);
|
||||||
logPhase("metadata-started", { tabId });
|
logPhase("metadata-started", { tabId });
|
||||||
}
|
}
|
||||||
} catch (e: any) {
|
} catch (e: any) {
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import { describe, expect, it } from "vitest";
|
import { describe, expect, it } from "vitest";
|
||||||
import { canApplyDataTabMetadata, dataTabOpenModeFromTreeClick, findExistingDataTabCandidate } from "@/lib/sidebar/dataTabOpenPolicy";
|
import { canApplyDataTabMetadata, dataTabMetadataNeedsRefresh, dataTabOpenModeFromTreeClick, findExistingDataTabCandidate } from "@/lib/sidebar/dataTabOpenPolicy";
|
||||||
import type { QueryTab } from "@/types/database";
|
import type { QueryTab } from "@/types/database";
|
||||||
|
|
||||||
function click(modifiers: Partial<Pick<MouseEvent, "metaKey" | "ctrlKey" | "altKey" | "shiftKey">> = {}) {
|
function click(modifiers: Partial<Pick<MouseEvent, "metaKey" | "ctrlKey" | "altKey" | "shiftKey">> = {}) {
|
||||||
@@ -88,4 +88,26 @@ describe("dataTabOpenPolicy", () => {
|
|||||||
|
|
||||||
expect(canApplyDataTabMetadata(tab, usersTarget, new AbortController().signal)).toBe(false);
|
expect(canApplyDataTabMetadata(tab, usersTarget, new AbortController().signal)).toBe(false);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("refreshes missing, restored, and expired table metadata", () => {
|
||||||
|
const now = 100_000;
|
||||||
|
const ttl = 30_000;
|
||||||
|
const tab = dataTab("users", "users");
|
||||||
|
|
||||||
|
expect(dataTabMetadataNeedsRefresh(tab, ttl, now)).toBe(true);
|
||||||
|
|
||||||
|
tab.tableMeta = {
|
||||||
|
schema: "public",
|
||||||
|
tableName: "users",
|
||||||
|
columns: [{ name: "id", data_type: "integer", is_nullable: false, column_default: null, is_primary_key: true, extra: null }],
|
||||||
|
primaryKeys: ["id"],
|
||||||
|
};
|
||||||
|
expect(dataTabMetadataNeedsRefresh(tab, ttl, now)).toBe(true);
|
||||||
|
|
||||||
|
tab.tableMetaUpdatedAt = now - ttl + 1;
|
||||||
|
expect(dataTabMetadataNeedsRefresh(tab, ttl, now)).toBe(false);
|
||||||
|
|
||||||
|
tab.tableMetaUpdatedAt = now - ttl;
|
||||||
|
expect(dataTabMetadataNeedsRefresh(tab, ttl, now)).toBe(true);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
@@ -3,7 +3,7 @@ import type { QueryTab, TreeNodeType } from "@/types/database";
|
|||||||
|
|
||||||
export type DataTabOpenMode = "default" | "new-tab";
|
export type DataTabOpenMode = "default" | "new-tab";
|
||||||
|
|
||||||
type DataTabLike = Pick<QueryTab, "id" | "mode" | "connectionId" | "database" | "schema" | "title" | "tableMeta">;
|
type DataTabLike = Pick<QueryTab, "id" | "mode" | "connectionId" | "database" | "schema" | "title" | "tableMeta" | "tableMetaUpdatedAt">;
|
||||||
|
|
||||||
export interface DataTabTarget {
|
export interface DataTabTarget {
|
||||||
connectionId: string;
|
connectionId: string;
|
||||||
@@ -41,6 +41,11 @@ export function canApplyDataTabMetadata(tab: DataTabLike | undefined, target: Da
|
|||||||
return signal?.aborted !== true && tab !== undefined && isSameTable(tab, target);
|
return signal?.aborted !== true && tab !== undefined && isSameTable(tab, target);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function dataTabMetadataNeedsRefresh(tab: DataTabLike, maxAgeMs: number, now = Date.now()): boolean {
|
||||||
|
if (!tab.tableMeta?.columns.length || tab.tableMetaUpdatedAt === undefined) return true;
|
||||||
|
return now - tab.tableMetaUpdatedAt >= maxAgeMs;
|
||||||
|
}
|
||||||
|
|
||||||
export function findExistingDataTabCandidate<T extends DataTabLike>(tabs: T[], target: DataTabTarget, options: { openMode: DataTabOpenMode; reuseDataTab: boolean }): ExistingDataTabCandidate<T> | undefined {
|
export function findExistingDataTabCandidate<T extends DataTabLike>(tabs: T[], target: DataTabTarget, options: { openMode: DataTabOpenMode; reuseDataTab: boolean }): ExistingDataTabCandidate<T> | undefined {
|
||||||
if (options.openMode === "new-tab") return undefined;
|
if (options.openMode === "new-tab") return undefined;
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user