fix(session): retain failed provider cleanup for lifecycle retries (#1260)
Retire inactive clients until cleanup succeeds and block replacement startup while owned resources remain. Preserve startup/cancellation failures alongside cleanup diagnostics and retain explicit document choices across retries. Assisted-by: Kogasa (gensokyo-skills:kogasa-surprise-testing)
This commit is contained in:
@@ -1,4 +1,6 @@
|
||||
import { ProviderCleanupError } from "../../domain/providerCleanupError.js";
|
||||
import { ProviderAdapterError } from "../../domain/providerAdapterError.js";
|
||||
import { projectAnalysisError } from "../../domain/analysisErrorProjection.js";
|
||||
import { err, ok, type Result } from "../../domain/result.js";
|
||||
import { AnalysisError } from "../../domain/analysisErrorBase.js";
|
||||
import type { AnalysisClient, ExecutionOptions } from "../AnalysisProvider.js";
|
||||
@@ -30,3 +32,27 @@ export const closeAnalysisClient = async (
|
||||
);
|
||||
}
|
||||
};
|
||||
|
||||
/** Preserve the original lifecycle failure alongside incomplete cleanup. */
|
||||
export const analysisErrorWithCleanupFailure = (
|
||||
primary: AnalysisError,
|
||||
cleanup: AnalysisError,
|
||||
operation = "close_binary",
|
||||
): AnalysisError => {
|
||||
const projected = projectAnalysisError(cleanup);
|
||||
return new ProviderAdapterError(
|
||||
cleanup instanceof ProviderAdapterError ? cleanup.providerId : "rea",
|
||||
operation,
|
||||
{
|
||||
cause: primary,
|
||||
cleanup: {
|
||||
reason: projected.message,
|
||||
resources: cleanup.cleanupResources,
|
||||
},
|
||||
diagnostics: {
|
||||
primary_error: projectAnalysisError(primary),
|
||||
cleanup_error: projected,
|
||||
},
|
||||
},
|
||||
);
|
||||
};
|
||||
|
||||
@@ -44,7 +44,10 @@ import {
|
||||
commitExecutionProfile,
|
||||
prepareSessionExecution,
|
||||
} from "./BinarySessionExecution.js";
|
||||
import { closeAnalysisClient } from "./AnalysisClientCleanup.js";
|
||||
import {
|
||||
analysisErrorWithCleanupFailure,
|
||||
closeAnalysisClient,
|
||||
} from "./AnalysisClientCleanup.js";
|
||||
export type { BinarySessionPort } from "./BinarySessionPort.js";
|
||||
const OFFICIAL_OPERATIONS: ReadonlySet<string> = new Set(
|
||||
OFFICIAL_TOOL_CONTRACTS.map(({ name }) => name),
|
||||
@@ -53,6 +56,15 @@ const ENHANCED_OPERATIONS: ReadonlySet<string> = new Set(
|
||||
ENHANCED_TOOL_CONTRACTS.map(({ name }) => name),
|
||||
);
|
||||
|
||||
interface SessionBinding {
|
||||
readonly target: BinaryTarget;
|
||||
readonly client: AnalysisClient;
|
||||
readonly profile: AnalysisProfileCommitment | null;
|
||||
readonly compatibility: Readonly<Record<string, JsonValue>>;
|
||||
readonly route: SessionProviderRoute;
|
||||
readonly runId: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Owns the single active target shared by CLI and MCP adapters.
|
||||
*
|
||||
@@ -64,14 +76,12 @@ export class BinarySession
|
||||
extends BinarySessionRecords
|
||||
implements BinarySessionPort
|
||||
{
|
||||
#active:
|
||||
#active: SessionBinding | undefined;
|
||||
#pendingCleanup:
|
||||
| {
|
||||
readonly target: BinaryTarget;
|
||||
readonly client: AnalysisClient;
|
||||
readonly profile: AnalysisProfileCommitment | null;
|
||||
readonly compatibility: Readonly<Record<string, JsonValue>>;
|
||||
readonly route: SessionProviderRoute;
|
||||
readonly runId: string;
|
||||
readonly providerId: string;
|
||||
readonly retainDocument: boolean;
|
||||
}
|
||||
| undefined;
|
||||
#transition: Promise<void> = Promise.resolve();
|
||||
@@ -240,6 +250,10 @@ export class BinarySession
|
||||
? profile === null
|
||||
: profile !== null && analysisProfilesEqual(activeProfile, profile);
|
||||
await this.#drainCalls(admittedThrough);
|
||||
if (isAborted(options.signal))
|
||||
return err(new AnalysisCancelledError("open_binary"));
|
||||
const pendingClosed = await this.#retryPendingCleanup();
|
||||
if (!pendingClosed.ok) return pendingClosed;
|
||||
if (isAborted(options.signal))
|
||||
return err(new AnalysisCancelledError("open_binary"));
|
||||
if (sameTarget && sameProfile) {
|
||||
@@ -252,7 +266,7 @@ export class BinarySession
|
||||
const previous = this.#active;
|
||||
this.#active = undefined;
|
||||
if (previous !== undefined) {
|
||||
const closed = await closeAnalysisClient(
|
||||
const closed = await this.#retireClient(
|
||||
previous.client,
|
||||
previous.route.identity.id,
|
||||
);
|
||||
@@ -262,18 +276,35 @@ export class BinarySession
|
||||
return closed;
|
||||
}
|
||||
}
|
||||
if (isAborted(options.signal))
|
||||
return err(
|
||||
await this.#restoreAfterFailedOpen(
|
||||
previous,
|
||||
new AnalysisCancelledError("open_binary"),
|
||||
),
|
||||
);
|
||||
const runId = randomUUID();
|
||||
const client = route.createClient(target, { runId });
|
||||
const started = await client.execute("health", {}, options);
|
||||
if (!started.ok) {
|
||||
await client.close();
|
||||
await this.#restore(previous);
|
||||
return started;
|
||||
return err(
|
||||
await this.#failedOpen(
|
||||
client,
|
||||
route.identity.id,
|
||||
previous,
|
||||
started.error,
|
||||
),
|
||||
);
|
||||
}
|
||||
if (isAborted(options.signal)) {
|
||||
await client.close();
|
||||
await this.#restore(previous);
|
||||
return err(new AnalysisCancelledError("open_binary"));
|
||||
return err(
|
||||
await this.#failedOpen(
|
||||
client,
|
||||
route.identity.id,
|
||||
previous,
|
||||
new AnalysisCancelledError("open_binary"),
|
||||
),
|
||||
);
|
||||
}
|
||||
this.#active = {
|
||||
target,
|
||||
@@ -293,9 +324,14 @@ export class BinarySession
|
||||
const imported = this.importAnalysisSnapshot(options.snapshot);
|
||||
if (!imported.ok) {
|
||||
this.#active = undefined;
|
||||
await client.close();
|
||||
await this.#restore(previous);
|
||||
return imported;
|
||||
return err(
|
||||
await this.#failedOpen(
|
||||
client,
|
||||
route.identity.id,
|
||||
previous,
|
||||
imported.error,
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
return ok(target);
|
||||
@@ -346,8 +382,11 @@ export class BinarySession
|
||||
this.#active = undefined;
|
||||
const closed =
|
||||
previous === undefined
|
||||
? ok(null)
|
||||
: await closeAnalysisClient(
|
||||
? await this.#retryPendingCleanup(
|
||||
options.progress,
|
||||
options.retainProviderDocuments,
|
||||
)
|
||||
: await this.#retireClient(
|
||||
previous.client,
|
||||
previous.route.identity.id,
|
||||
{
|
||||
@@ -364,6 +403,69 @@ export class BinarySession
|
||||
return closed;
|
||||
}
|
||||
|
||||
async #retireClient(
|
||||
client: AnalysisClient,
|
||||
providerId: string,
|
||||
options: Pick<ExecutionOptions, "progress"> & {
|
||||
readonly retainDocument?: boolean;
|
||||
} = {},
|
||||
): Promise<Result<null, AnalysisError>> {
|
||||
this.#pendingCleanup = {
|
||||
client,
|
||||
providerId,
|
||||
retainDocument: options.retainDocument === true,
|
||||
};
|
||||
return this.#retryPendingCleanup(options.progress);
|
||||
}
|
||||
|
||||
async #retryPendingCleanup(
|
||||
progress?: ExecutionOptions["progress"],
|
||||
retainDocument?: boolean,
|
||||
): Promise<Result<null, AnalysisError>> {
|
||||
let pending = this.#pendingCleanup;
|
||||
if (pending === undefined) return ok(null);
|
||||
if (retainDocument !== undefined) {
|
||||
pending = { ...pending, retainDocument };
|
||||
this.#pendingCleanup = pending;
|
||||
}
|
||||
const closed = await closeAnalysisClient(
|
||||
pending.client,
|
||||
pending.providerId,
|
||||
{
|
||||
...(progress === undefined ? {} : { progress }),
|
||||
...(pending.retainDocument ? { retainDocument: true } : {}),
|
||||
},
|
||||
);
|
||||
if (closed.ok) this.#pendingCleanup = undefined;
|
||||
return closed;
|
||||
}
|
||||
|
||||
async #failedOpen(
|
||||
client: AnalysisClient,
|
||||
providerId: string,
|
||||
previous: SessionBinding | undefined,
|
||||
primary: AnalysisError,
|
||||
): Promise<AnalysisError> {
|
||||
const closed = await this.#retireClient(client, providerId);
|
||||
if (!closed.ok)
|
||||
return analysisErrorWithCleanupFailure(
|
||||
primary,
|
||||
closed.error,
|
||||
"open_binary",
|
||||
);
|
||||
return this.#restoreAfterFailedOpen(previous, primary);
|
||||
}
|
||||
|
||||
async #restoreAfterFailedOpen(
|
||||
previous: SessionBinding | undefined,
|
||||
primary: AnalysisError,
|
||||
): Promise<AnalysisError> {
|
||||
const restored = await this.#restore(previous);
|
||||
return restored.ok
|
||||
? primary
|
||||
: analysisErrorWithCleanupFailure(primary, restored.error, "open_binary");
|
||||
}
|
||||
|
||||
/** Describe the active binary session. */
|
||||
status(): JsonValue {
|
||||
return binarySessionStatus({
|
||||
@@ -580,22 +682,13 @@ export class BinarySession
|
||||
}
|
||||
|
||||
async #restore(
|
||||
previous:
|
||||
| {
|
||||
readonly target: BinaryTarget;
|
||||
readonly client: AnalysisClient;
|
||||
readonly profile: AnalysisProfileCommitment | null;
|
||||
readonly compatibility: Readonly<Record<string, JsonValue>>;
|
||||
readonly route: SessionProviderRoute;
|
||||
readonly runId: string;
|
||||
}
|
||||
| undefined,
|
||||
): Promise<void> {
|
||||
if (previous === undefined) return;
|
||||
previous: SessionBinding | undefined,
|
||||
): Promise<Result<null, AnalysisError>> {
|
||||
if (previous === undefined) return ok(null);
|
||||
const runId = randomUUID();
|
||||
const client = previous.route.createClient(previous.target, { runId });
|
||||
const started = await client.execute("health", {});
|
||||
if (started.ok)
|
||||
if (started.ok) {
|
||||
this.#active = {
|
||||
target: previous.target,
|
||||
client,
|
||||
@@ -604,7 +697,18 @@ export class BinarySession
|
||||
route: previous.route,
|
||||
runId,
|
||||
};
|
||||
else await client.close();
|
||||
return ok(null);
|
||||
}
|
||||
const closed = await this.#retireClient(client, previous.route.identity.id);
|
||||
return closed.ok
|
||||
? ok(null)
|
||||
: err(
|
||||
analysisErrorWithCleanupFailure(
|
||||
started.error,
|
||||
closed.error,
|
||||
"open_binary",
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
async #waitForTransition(
|
||||
|
||||
Reference in New Issue
Block a user