feat(query): resume failed SQL batches safely

This commit is contained in:
zipg authored and GitHub committed 2026-08-22 16:37:24 +08:00
1 parent 9774a194ec
commit 0559f9f76e
16 files changed
+531 -33

No files matched your search

@@ -0,0 +1,102 @@
import { describe, expect, it } from "vitest";
import { batchSqlRecoverySql, batchSqlRecoveryState, mergeBatchQueryResults, prepareBatchSqlRecovery } from "@/lib/query/batchSqlRecovery";
import type { BatchSqlExecution, QueryResult } from "@/types/database";
function batch(): BatchSqlExecution {
return {
executionId: "first",
submittedSql: "SELECT 1;\nSELECT bad;\nSELECT 3",
editorFingerprint: "editor",
sourceOffset: 10,
completed: 2,
total: 3,
startedAt: 1,
finishedAt: 2,
items: [
{ statementIndex: 0, sql: "SELECT 1", from: 10, to: 18, status: "success" },
{
statementIndex: 1,
sql: "SELECT bad",
from: 20,
to: 30,
status: "error",
error: "bad SQL",
errorDetails: {
version: 1,
code: "DBX-JDBC-4001",
messageKey: "backendErrors.jdbc.sqlFailed",
messageParams: { stage: "execute" },
source: "jdbcAgent",
operationOutcome: "unknown",
diagnostics: { category: "sql" },
},
},
{ statementIndex: 2, sql: "SELECT 3", from: 32, to: 40, status: "skipped" },
],
};
}
describe("batchSqlRecovery", () => {
it("offers recovery only for a stopped auto-commit batch with a safe SQL error", () => {
expect(batchSqlRecoveryState({ autoCommit: true, isExecuting: false, batchSqlExecution: batch() })).toEqual({ failedStatementIndex: 1, remainingStatementCount: 1 });
expect(batchSqlRecoveryState({ autoCommit: false, isExecuting: false, batchSqlExecution: batch() })).toBeUndefined();
expect(batchSqlRecoveryState({ autoCommit: true, isExecuting: true, batchSqlExecution: batch() })).toBeUndefined();
const unsafe = batch();
unsafe.items[1]!.errorDetails = { ...unsafe.items[1]!.errorDetails!, code: "DBX-JDBC-2002", diagnostics: { category: "timeout" } };
expect(batchSqlRecoveryState({ autoCommit: true, isExecuting: false, batchSqlExecution: unsafe })).toBeUndefined();
const legacy = batch();
legacy.items[1]!.errorDetails = {
...legacy.items[1]!.errorDetails!,
code: "DBX-LEGACY-0001",
messageKey: "backendErrors.legacy",
source: "legacyBackend",
diagnostics: undefined,
};
expect(batchSqlRecoveryState({ autoCommit: true, isExecuting: false, batchSqlExecution: legacy })).toBeUndefined();
legacy.items[2]!.status = "pending";
expect(batchSqlRecoveryState({ autoCommit: true, isExecuting: false, batchSqlExecution: legacy })).toBeUndefined();
legacy.items[1]!.errorDetails = undefined;
legacy.items[1]!.executionTimeMs = 0;
expect(batchSqlRecoveryState({ autoCommit: true, isExecuting: false, batchSqlExecution: legacy })).toBeUndefined();
const dismissed = batch();
dismissed.recoveryDismissed = true;
expect(batchSqlRecoveryState({ autoCommit: true, isExecuting: false, batchSqlExecution: dismissed })).toBeUndefined();
});
it("uses the latest failed statement when a resumed batch stops again", () => {
const value = batch();
value.items.push({ statementIndex: 3, sql: "SELECT bad2", from: 42, to: 53, status: "error", errorDetails: value.items[1]!.errorDetails }, { statementIndex: 4, sql: "SELECT 5", from: 55, to: 63, status: "skipped" });
value.total = 5;
expect(batchSqlRecoveryState({ autoCommit: true, isExecuting: false, batchSqlExecution: value })).toEqual({ failedStatementIndex: 3, remainingStatementCount: 1 });
});
it("restarts from the original submitted SQL and resets only the resumed tail", () => {
expect(batchSqlRecoverySql(batch(), 1)).toEqual({ sql: "SELECT bad;\nSELECT 3", sourceOffset: 20 });
expect(prepareBatchSqlRecovery(batch(), "second", 2)).toMatchObject({
executionId: "second",
completed: 2,
finishedAt: undefined,
items: [{ status: "success" }, { status: "error" }, { status: "running", error: undefined }],
});
});
it("replaces results by global statement index while retaining earlier results", () => {
const previous = [
{ columns: [], rows: [], affected_rows: 1, execution_time_ms: 1, statement_index: 0 },
{ columns: ["message"], rows: [["second result set"]], affected_rows: 0, execution_time_ms: 1, statement_index: 0 },
{ columns: ["Error"], rows: [["bad"]], affected_rows: 0, execution_time_ms: 1, statement_index: 1, execution_error: true },
] as QueryResult[];
const resumed = [
{ columns: [], rows: [], affected_rows: 1, execution_time_ms: 1, statement_index: 1 },
{ columns: ["message"], rows: [["retried result set"]], affected_rows: 0, execution_time_ms: 1, statement_index: 1 },
{ columns: [], rows: [], affected_rows: 1, execution_time_ms: 1, statement_index: 2 },
] as QueryResult[];
expect(mergeBatchQueryResults(previous, resumed)).toEqual([previous[0], previous[1], resumed[0], resumed[1], resumed[2]]);
});
});
@@ -0,0 +1,69 @@
import type { BatchSqlExecution, QueryResult, QueryTab } from "@/types/database";
export type BatchSqlRecoveryAction = "retry" | "skip" | "skip-all";
export interface BatchSqlRecoveryState {
failedStatementIndex: number;
remainingStatementCount: number;
}
function isRecoverableStatementError(batch: BatchSqlExecution, statementIndex: number): boolean {
const error = batch.items[statementIndex]?.errorDetails;
return error?.code === "DBX-JDBC-4001" || error?.diagnostics?.category === "sql";
}
export function batchSqlRecoveryState(tab: Pick<QueryTab, "autoCommit" | "batchSqlExecution" | "isExecuting">): BatchSqlRecoveryState | undefined {
const batch = tab.batchSqlExecution;
if (!batch || tab.isExecuting || tab.autoCommit === false || batch.recoveryDismissed === true) return undefined;
for (let failedStatementIndex = batch.items.length - 1; failedStatementIndex >= 0; failedStatementIndex -= 1) {
if (batch.items[failedStatementIndex]?.status !== "error" || !isRecoverableStatementError(batch, failedStatementIndex)) continue;
const remainingStatementCount = batch.items.slice(failedStatementIndex + 1).filter((item) => item.status === "skipped" || item.status === "pending").length;
if (remainingStatementCount > 0) return { failedStatementIndex, remainingStatementCount };
}
return undefined;
}
export function prepareBatchSqlRecovery(batch: BatchSqlExecution, executionId: string, startStatementIndex: number): BatchSqlExecution {
const resumed: BatchSqlExecution = {
...batch,
executionId,
finishedAt: undefined,
recoveryDismissed: false,
items: batch.items.map((item) => ({ ...item })),
};
for (let index = startStatementIndex; index < resumed.items.length; index += 1) {
const item = resumed.items[index]!;
item.status = index === startStatementIndex ? "running" : "pending";
item.executionTimeMs = undefined;
item.affectedRows = undefined;
item.error = undefined;
item.errorDetails = undefined;
}
resumed.completed = resumed.items.filter((item) => item.status === "success" || item.status === "error").length;
return resumed;
}
export function batchSqlRecoverySql(batch: BatchSqlExecution, startStatementIndex: number): { sql: string; sourceOffset: number } | undefined {
const item = batch.items[startStatementIndex];
if (!item) return undefined;
const relativeFrom = item.from - batch.sourceOffset;
if (relativeFrom < 0 || relativeFrom >= batch.submittedSql.length) return undefined;
return { sql: batch.submittedSql.slice(relativeFrom), sourceOffset: item.from };
}
export function offsetBatchQueryResultIndexes(results: QueryResult[], statementOffset: number): QueryResult[] {
if (statementOffset === 0) return results;
for (const [fallbackIndex, result] of results.entries()) {
result.statement_index = statementOffset + (Number.isInteger(result.statement_index) ? result.statement_index! : fallbackIndex);
}
return results;
}
export function mergeBatchQueryResults(previous: QueryResult[], resumed: QueryResult[]): QueryResult[] {
if (resumed.length === 0) return previous;
const resumedStart = Math.min(...resumed.map((result, fallbackIndex) => (Number.isInteger(result.statement_index) ? result.statement_index! : fallbackIndex)));
const retained = previous.filter((result, fallbackIndex) => (Number.isInteger(result.statement_index) ? result.statement_index! : fallbackIndex) < resumedStart);
return [...retained, ...resumed];
}