feat(query): add switchable query result runs and archives
* docs: design query result run tabs * feat(query): add result run model helpers * feat(query): persist result run metadata * feat(query): record switchable result runs * feat(query): sync active result run state * feat(query): cache result run payloads * feat(query): render result run tabs * docs: design query result archives * feat(query): add result archive codec * feat(query): restore result archives * feat(query): add result archive actions * fix(query): toggle execution summary view * fix(query): avoid archive compression backpressure * feat(query): remove result runs * chore: remove local spec docs from pr
This commit is contained in:
1 parent
cbc7f9b0db
commit
97192297eb
18 files changed
+1430
-11
No files matched your search
@@ -32,6 +32,7 @@ import { connectionUsesDatabaseObjectTreeMode, connectionUsesSchemaExecutionCont
|
||||
import { queryTimeoutSecsForConnection } from "@/lib/queryTimeout";
|
||||
import { clearDataGridPendingSnapshotsForTab } from "@/composables/useDataGridEditor";
|
||||
import { buildTabResultSnapshot, deleteTabResultSnapshot, readTabResultSnapshot, tabResultCacheKey, writeTabResultSnapshot } from "@/lib/tabResultCache";
|
||||
import { decodeQueryResultArchive, encodeQueryResultArchive, type DecodedQueryResultArchive } from "@/lib/queryResultArchive";
|
||||
import * as api from "@/lib/api";
|
||||
import { useConnectionStore } from "@/stores/connectionStore";
|
||||
import { useSettingsStore } from "@/stores/settingsStore";
|
||||
@@ -51,6 +52,14 @@ function markQueryResultsRowsRaw(results: QueryResult[]): QueryResult[] {
|
||||
return results;
|
||||
}
|
||||
|
||||
function markQueryResultRunsRowsRaw(resultRuns: NonNullable<QueryTab["resultRuns"]>): NonNullable<QueryTab["resultRuns"]> {
|
||||
for (const run of resultRuns) {
|
||||
if (run.result) markQueryResultRowsRaw(run.result);
|
||||
if (run.results) markQueryResultsRowsRaw(run.results);
|
||||
}
|
||||
return resultRuns;
|
||||
}
|
||||
|
||||
async function withFrontendQueryTimeout<T>(promise: Promise<T>, timeoutSecs: number, message: string): Promise<T> {
|
||||
if (timeoutSecs === 0) return promise;
|
||||
|
||||
@@ -186,6 +195,149 @@ export const useQueryStore = defineStore("query", () => {
|
||||
}
|
||||
}
|
||||
|
||||
function projectResultRun(tab: QueryTab, run: NonNullable<QueryTab["resultRuns"]>[number]) {
|
||||
const activeIndex = run.activeResultIndex ?? 0;
|
||||
tab.activeResultRunId = run.id;
|
||||
tab.result = run.result ?? run.results?.[activeIndex];
|
||||
tab.results = run.results;
|
||||
tab.activeResultIndex = run.activeResultIndex;
|
||||
tab.resultBaseSql = run.resultBaseSql;
|
||||
tab.resultSortedSql = run.resultSortedSql;
|
||||
tab.resultSortColumn = run.resultSortColumn;
|
||||
tab.resultSortColumnIndex = run.resultSortColumnIndex;
|
||||
tab.resultSortDirection = run.resultSortDirection;
|
||||
tab.orderByInput = run.orderByInput;
|
||||
tab.resultPageSql = run.resultPageSql;
|
||||
tab.resultPageLimit = run.resultPageLimit;
|
||||
tab.resultPageOffset = run.resultPageOffset;
|
||||
tab.resultCountSql = run.resultCountSql;
|
||||
tab.resultTotalRowCount = run.resultTotalRowCount;
|
||||
tab.resultTotalRowCountLoading = run.resultTotalRowCountLoading;
|
||||
tab.resultSessionId = run.resultSessionId;
|
||||
tab.resultAccessedAt = run.resultAccessedAt;
|
||||
tab.resultCacheKey = run.resultCacheKey;
|
||||
tab.resultCacheState = run.resultCacheState;
|
||||
tab.resultEvicted = run.resultEvicted;
|
||||
tab.queryAnalysis = run.queryAnalysis;
|
||||
tab.querySourceColumns = run.querySourceColumns;
|
||||
tab.queryEditabilityReason = run.queryEditabilityReason;
|
||||
tab.tableMeta = run.tableMeta;
|
||||
touchResult(tab);
|
||||
}
|
||||
|
||||
function setActiveResultRun(id: string, runId: string) {
|
||||
const tab = tabs.value.find((t) => t.id === id);
|
||||
const run = tab?.resultRuns?.find((item) => item.id === runId);
|
||||
if (!tab || !run) return false;
|
||||
projectResultRun(tab, run);
|
||||
return true;
|
||||
}
|
||||
|
||||
function removeResultRun(id: string, runId: string) {
|
||||
const tab = tabs.value.find((t) => t.id === id);
|
||||
const runIndex = tab?.resultRuns?.findIndex((run) => run.id === runId) ?? -1;
|
||||
if (!tab || !tab.resultRuns || runIndex < 0) return false;
|
||||
|
||||
const wasActive = tab.activeResultRunId === runId;
|
||||
const remainingRuns = tab.resultRuns.filter((run) => run.id !== runId);
|
||||
tab.resultRuns = remainingRuns;
|
||||
|
||||
if (!wasActive) return true;
|
||||
|
||||
const nextRun = remainingRuns[Math.min(runIndex, remainingRuns.length - 1)];
|
||||
if (nextRun) {
|
||||
projectResultRun(tab, nextRun);
|
||||
return true;
|
||||
}
|
||||
|
||||
tab.activeResultRunId = undefined;
|
||||
clearResultPayload(tab);
|
||||
return true;
|
||||
}
|
||||
|
||||
function nextResultRunSequence(tab: QueryTab): number {
|
||||
return (tab.resultRuns?.reduce((max, run) => Math.max(max, run.sequence), 0) ?? 0) + 1;
|
||||
}
|
||||
|
||||
function captureDisplayedResultRun(tab: QueryTab, sql: string, createdAt = Date.now()) {
|
||||
if (tab.mode !== "query" || !tab.result) return;
|
||||
const sequence = nextResultRunSequence(tab);
|
||||
const run: NonNullable<QueryTab["resultRuns"]>[number] = {
|
||||
id: uuid(),
|
||||
title: `Run ${sequence}`,
|
||||
sequence,
|
||||
sql,
|
||||
createdAt,
|
||||
result: tab.result,
|
||||
results: tab.results,
|
||||
activeResultIndex: tab.activeResultIndex,
|
||||
resultBaseSql: tab.resultBaseSql,
|
||||
resultSortedSql: tab.resultSortedSql,
|
||||
resultSortColumn: tab.resultSortColumn,
|
||||
resultSortColumnIndex: tab.resultSortColumnIndex,
|
||||
resultSortDirection: tab.resultSortDirection,
|
||||
orderByInput: tab.orderByInput,
|
||||
resultPageSql: tab.resultPageSql,
|
||||
resultPageLimit: tab.resultPageLimit,
|
||||
resultPageOffset: tab.resultPageOffset,
|
||||
resultCountSql: tab.resultCountSql,
|
||||
resultTotalRowCount: tab.resultTotalRowCount,
|
||||
resultTotalRowCountLoading: tab.resultTotalRowCountLoading,
|
||||
resultSessionId: tab.resultSessionId,
|
||||
resultAccessedAt: tab.resultAccessedAt,
|
||||
resultCacheKey: tab.resultCacheKey,
|
||||
resultCacheState: tab.resultCacheState,
|
||||
resultEvicted: tab.resultEvicted,
|
||||
queryAnalysis: tab.queryAnalysis,
|
||||
querySourceColumns: tab.querySourceColumns,
|
||||
queryEditabilityReason: tab.queryEditabilityReason,
|
||||
tableMeta: tab.tableMeta,
|
||||
};
|
||||
tab.resultRuns = [...(tab.resultRuns ?? []), run];
|
||||
tab.activeResultRunId = run.id;
|
||||
}
|
||||
|
||||
function syncActiveResultRunFromDisplayed(tab: QueryTab) {
|
||||
if (!tab.activeResultRunId || !tab.resultRuns?.length) return;
|
||||
const index = tab.resultRuns.findIndex((run) => run.id === tab.activeResultRunId);
|
||||
if (index < 0) return;
|
||||
tab.resultRuns[index] = {
|
||||
...tab.resultRuns[index],
|
||||
result: tab.result,
|
||||
results: tab.results,
|
||||
activeResultIndex: tab.activeResultIndex,
|
||||
resultBaseSql: tab.resultBaseSql,
|
||||
resultSortedSql: tab.resultSortedSql,
|
||||
resultSortColumn: tab.resultSortColumn,
|
||||
resultSortColumnIndex: tab.resultSortColumnIndex,
|
||||
resultSortDirection: tab.resultSortDirection,
|
||||
orderByInput: tab.orderByInput,
|
||||
resultPageSql: tab.resultPageSql,
|
||||
resultPageLimit: tab.resultPageLimit,
|
||||
resultPageOffset: tab.resultPageOffset,
|
||||
resultCountSql: tab.resultCountSql,
|
||||
resultTotalRowCount: tab.resultTotalRowCount,
|
||||
resultTotalRowCountLoading: tab.resultTotalRowCountLoading,
|
||||
resultSessionId: tab.resultSessionId,
|
||||
resultAccessedAt: tab.resultAccessedAt,
|
||||
resultCacheKey: tab.resultCacheKey,
|
||||
resultCacheState: tab.resultCacheState,
|
||||
resultEvicted: tab.resultEvicted,
|
||||
queryAnalysis: tab.queryAnalysis,
|
||||
querySourceColumns: tab.querySourceColumns,
|
||||
queryEditabilityReason: tab.queryEditabilityReason,
|
||||
tableMeta: tab.tableMeta,
|
||||
};
|
||||
}
|
||||
|
||||
function resultRunHasPayload(run: NonNullable<QueryTab["resultRuns"]>[number]): boolean {
|
||||
return !!run.result || !!run.results?.length;
|
||||
}
|
||||
|
||||
function resultSnapshotHasPayload(snapshot: NonNullable<ReturnType<typeof buildTabResultSnapshot>>): boolean {
|
||||
return !!snapshot.result || !!snapshot.results?.length || !!snapshot.resultRuns?.some(resultRunHasPayload);
|
||||
}
|
||||
|
||||
async function evictCachedResult(tab: QueryTab) {
|
||||
await closeResultSession(tab);
|
||||
const cacheKey = tabResultCacheKey(tab.id);
|
||||
@@ -885,6 +1037,7 @@ export const useQueryStore = defineStore("query", () => {
|
||||
const current = tabs.value.find((t) => t.id === tabId);
|
||||
if (patch && current?.result === result) {
|
||||
applyQueryMetadataPatch(current, patch);
|
||||
syncActiveResultRunFromDisplayed(current);
|
||||
console.info("[DBX][executeTabSql:metadata:done]", { traceId, elapsed: elapsed() });
|
||||
} else {
|
||||
console.warn("[DBX][executeTabSql:metadata:stale]", { traceId, elapsed: elapsed() });
|
||||
@@ -898,6 +1051,7 @@ export const useQueryStore = defineStore("query", () => {
|
||||
if (current.executionId !== executionId && current.result !== result) return;
|
||||
current.resultTotalRowCount = totalRowCount;
|
||||
current.resultTotalRowCountLoading = false;
|
||||
syncActiveResultRunFromDisplayed(current);
|
||||
}
|
||||
|
||||
function countQueryTotalRowsInBackground(options: { tabId: string; connectionId: string; database: string; schema?: string; countSql?: string; result: QueryResult; pageLimit?: number; pageOffset?: number; executionId: string; traceId: string; elapsed: () => string; timeoutSecs: number }) {
|
||||
@@ -1019,6 +1173,7 @@ export const useQueryStore = defineStore("query", () => {
|
||||
current.tableMeta = undefined;
|
||||
current.resultBaseSql = options?.resultBaseSql ?? sql;
|
||||
current.resultSortedSql = options?.resultSortedSql;
|
||||
captureDisplayedResultRun(current, options?.resultBaseSql ?? sql);
|
||||
}
|
||||
return;
|
||||
}
|
||||
@@ -1065,6 +1220,7 @@ export const useQueryStore = defineStore("query", () => {
|
||||
current.tableMeta = undefined;
|
||||
current.resultBaseSql = options?.resultBaseSql ?? sql;
|
||||
current.resultSortedSql = options?.resultSortedSql;
|
||||
captureDisplayedResultRun(current, options?.resultBaseSql ?? sql);
|
||||
}
|
||||
return;
|
||||
}
|
||||
@@ -1090,6 +1246,7 @@ export const useQueryStore = defineStore("query", () => {
|
||||
current.tableMeta = undefined;
|
||||
current.resultBaseSql = options?.resultBaseSql ?? sql;
|
||||
current.resultSortedSql = options?.resultSortedSql;
|
||||
captureDisplayedResultRun(current, options?.resultBaseSql ?? sql);
|
||||
}
|
||||
return;
|
||||
}
|
||||
@@ -1121,6 +1278,7 @@ export const useQueryStore = defineStore("query", () => {
|
||||
current.tableMeta = undefined;
|
||||
current.resultBaseSql = options?.resultBaseSql ?? sql;
|
||||
current.resultSortedSql = options?.resultSortedSql;
|
||||
captureDisplayedResultRun(current, options?.resultBaseSql ?? sql);
|
||||
}
|
||||
return;
|
||||
}
|
||||
@@ -1147,6 +1305,7 @@ export const useQueryStore = defineStore("query", () => {
|
||||
current.tableMeta = undefined;
|
||||
current.resultBaseSql = options?.resultBaseSql ?? sql;
|
||||
current.resultSortedSql = options?.resultSortedSql;
|
||||
captureDisplayedResultRun(current, options?.resultBaseSql ?? sql);
|
||||
}
|
||||
return;
|
||||
}
|
||||
@@ -1187,6 +1346,7 @@ export const useQueryStore = defineStore("query", () => {
|
||||
current.tableMeta = undefined;
|
||||
current.resultBaseSql = options?.resultBaseSql ?? sql;
|
||||
current.resultSortedSql = options?.resultSortedSql;
|
||||
captureDisplayedResultRun(current, options?.resultBaseSql ?? sql);
|
||||
}
|
||||
return;
|
||||
}
|
||||
@@ -1251,6 +1411,7 @@ export const useQueryStore = defineStore("query", () => {
|
||||
current.resultTotalRowCountLoading = false;
|
||||
}
|
||||
touchResult(current);
|
||||
captureDisplayedResultRun(current, queryBaseSql);
|
||||
if (current.mode === "query" && current.result) {
|
||||
countQueryTotalRowsInBackground({
|
||||
tabId: id,
|
||||
@@ -1304,6 +1465,7 @@ export const useQueryStore = defineStore("query", () => {
|
||||
current.resultTotalRowCount = undefined;
|
||||
current.resultTotalRowCountLoading = false;
|
||||
touchResult(current);
|
||||
captureDisplayedResultRun(current, queryBaseSql);
|
||||
}
|
||||
} finally {
|
||||
const current = tabs.value.find((t) => t.id === id);
|
||||
@@ -1473,6 +1635,7 @@ export const useQueryStore = defineStore("query", () => {
|
||||
tab.queryAnalysis = undefined;
|
||||
tab.querySourceColumns = undefined;
|
||||
tab.queryEditabilityReason = undefined;
|
||||
syncActiveResultRunFromDisplayed(tab);
|
||||
}
|
||||
|
||||
function notifyConnectionMayBeLost() {
|
||||
@@ -1507,7 +1670,9 @@ export const useQueryStore = defineStore("query", () => {
|
||||
tab.results = results;
|
||||
tab.activeResultIndex = snapshot.activeResultIndex;
|
||||
tab.result = snapshot.result ? markQueryResultRowsRaw(snapshot.result) : results?.[activeIndex] ? markQueryResultRowsRaw(results[activeIndex]) : undefined;
|
||||
if (!tab.result && !tab.results) return false;
|
||||
tab.resultRuns = snapshot.resultRuns ? markQueryResultRunsRowsRaw(snapshot.resultRuns) : tab.resultRuns;
|
||||
tab.activeResultRunId = snapshot.activeResultRunId ?? tab.activeResultRunId;
|
||||
if (!tab.result && !tab.results && !tab.resultRuns) return false;
|
||||
|
||||
tab.queryAnalysis = snapshot.queryAnalysis;
|
||||
tab.querySourceColumns = snapshot.querySourceColumns;
|
||||
@@ -1526,6 +1691,56 @@ export const useQueryStore = defineStore("query", () => {
|
||||
return true;
|
||||
}
|
||||
|
||||
async function resultArchiveSnapshotForTab(tab: QueryTab) {
|
||||
let snapshot = buildTabResultSnapshot(tab);
|
||||
if (tab.resultCacheKey && (!snapshot || tab.resultEvicted || !resultSnapshotHasPayload(snapshot))) {
|
||||
snapshot = (await readTabResultSnapshot(tab.resultCacheKey)) ?? snapshot;
|
||||
}
|
||||
return snapshot && resultSnapshotHasPayload(snapshot) ? snapshot : undefined;
|
||||
}
|
||||
|
||||
async function exportResultArchive(id: string): Promise<Uint8Array | undefined> {
|
||||
const tab = tabs.value.find((t) => t.id === id);
|
||||
if (!tab || tab.mode !== "query") return undefined;
|
||||
const snapshot = await resultArchiveSnapshotForTab(tab);
|
||||
if (!snapshot) return undefined;
|
||||
return encodeQueryResultArchive(tab, snapshot);
|
||||
}
|
||||
|
||||
function openResultArchiveTab(archive: DecodedQueryResultArchive): string | undefined {
|
||||
const id = uuid();
|
||||
const title = archive.tab.title.trim() || t("tabs.importedResultArchive");
|
||||
const tab: QueryTab = {
|
||||
id,
|
||||
title,
|
||||
customTitle: true,
|
||||
connectionId: archive.tab.connectionId,
|
||||
database: archive.tab.database,
|
||||
schema: archive.tab.schema,
|
||||
sql: archive.tab.sql,
|
||||
originalSql: archive.tab.sql,
|
||||
lastExecutedSql: archive.tab.lastExecutedSql,
|
||||
resultBaseSql: archive.tab.resultBaseSql,
|
||||
resultSortedSql: archive.tab.resultSortedSql,
|
||||
isExecuting: false,
|
||||
isCancelling: false,
|
||||
isExplaining: false,
|
||||
mode: "query",
|
||||
};
|
||||
if (!restoreCachedResultPayload(tab, archive.snapshot)) return undefined;
|
||||
const activeRun = tab.resultRuns?.find((run) => run.id === tab.activeResultRunId) ?? tab.resultRuns?.[0];
|
||||
if (activeRun) projectResultRun(tab, activeRun);
|
||||
tabs.value.push(tab);
|
||||
activeTabId.value = id;
|
||||
return id;
|
||||
}
|
||||
|
||||
async function importResultArchive(bytes: Uint8Array | ArrayBuffer): Promise<string | undefined> {
|
||||
const archive = await decodeQueryResultArchive(bytes);
|
||||
if (!archive) return undefined;
|
||||
return openResultArchiveTab(archive);
|
||||
}
|
||||
|
||||
async function reloadEvictedTab(id: string) {
|
||||
const tab = tabs.value.find((t) => t.id === id);
|
||||
if (!tab || !tab.resultEvicted) return;
|
||||
@@ -1716,6 +1931,8 @@ export const useQueryStore = defineStore("query", () => {
|
||||
setExecuting,
|
||||
setExecutingWithId,
|
||||
setErrorResult,
|
||||
setActiveResultRun,
|
||||
removeResultRun,
|
||||
setActiveResultIndex,
|
||||
executeCurrentTab,
|
||||
executeCurrentSql,
|
||||
@@ -1724,6 +1941,8 @@ export const useQueryStore = defineStore("query", () => {
|
||||
cancelTabExecution,
|
||||
cancelTabExplain,
|
||||
reloadEvictedTab,
|
||||
exportResultArchive,
|
||||
importResultArchive,
|
||||
fetchTabResultForExport,
|
||||
notifyConnectionMayBeLost,
|
||||
};
|
||||
|
||||
Reference in new issue
Block a user