fix(gateway): release wizard owners after settlement failures (#121915)

Ensure detached Gateway admission and cancelled-session cleanup runs when setup lock settlement rejects, while keeping the original rejection observable and preserving normal terminal-response ordering.
This commit is contained in:
Peter Steinberger
2026-08-11 01:08:37 -07:00
committed by GitHub
parent ca0d89ef07
commit 00d65b69af
2 changed files with 79 additions and 5 deletions
+76 -1
View File
@@ -1,6 +1,8 @@
// Wizard server-method tests cover stable lifecycle errors for process-local sessions.
import fs from "node:fs/promises";
import { __setFsSafeTestHooksForTest } from "@openclaw/fs-safe/test-hooks";
import { expectDefined } from "@openclaw/normalization-core";
import { describe, expect, it, vi } from "vitest";
import { afterEach, describe, expect, it, vi } from "vitest";
import { createDeferred } from "../../../test/helpers/promise.js";
import {
getActiveGatewayRootWorkCount,
@@ -18,6 +20,10 @@ import { systemAgentHandlers } from "./system-agent.js";
import type { GatewayRequestHandlerOptions } from "./types.js";
import { type SetupWizardRunner, wizardHandlers } from "./wizard.js";
afterEach(() => {
__setFsSafeTestHooksForTest(undefined);
});
function createWizardContext(
wizardRunner: NonNullable<GatewayRequestHandlerOptions["context"]>["wizardRunner"],
) {
@@ -283,6 +289,75 @@ describe("wizard setup ownership", () => {
}
});
it("cleans up detached wizard owners when setup lock release fails", async () => {
resetGatewayWorkAdmission();
const runnerSettled = createDeferred();
const tracker = createWizardSessionTracker();
const context = {
...tracker,
wizardRunner: async (_opts: unknown, _runtime: RuntimeEnv, prompter: WizardPrompter) => {
prompter.progress("working");
await runnerSettled.promise;
},
};
const unhandledRejections: unknown[] = [];
const onUnhandledRejection = (reason: unknown) => {
unhandledRejections.push(reason);
};
process.on("unhandledRejection", onUnhandledRejection);
let lockPath: string | undefined;
try {
let sessionId = "";
await runWithGatewayIndependentRootWorkAdmission(async () => {
const respond = vi.fn();
await expectDefined(
wizardHandlers["wizard.start"],
"wizard.start test invariant",
)({ params: { mode: "local" }, respond, context } as never);
sessionId = String(respond.mock.calls[0]?.[1]?.sessionId ?? "");
});
expect(sessionId).not.toBe("");
expect(getActiveGatewayRootWorkCount()).toBe(1);
const cancelRespond = vi.fn();
await expectDefined(
wizardHandlers["wizard.cancel"],
"wizard.cancel test invariant",
)({ params: { sessionId }, respond: cancelRespond, context } as never);
expect(cancelRespond.mock.calls[0]?.[1]).toMatchObject({ status: "cancelled" });
const releaseError = new Error("setup lock release failed");
__setFsSafeTestHooksForTest({
beforeSidecarLockSnapshotOpen: (candidate) => {
lockPath = candidate;
throw releaseError;
},
});
runnerSettled.resolve();
const session = expectDefined(
tracker.wizardSessions.get(sessionId),
"cancelled setup session",
);
await expect(whenAdmittedWizardSessionSettled(session)).rejects.toBe(releaseError);
await new Promise<void>((resolve) => {
setImmediate(resolve);
});
expect.soft(unhandledRejections).toEqual([]);
expect.soft(getActiveGatewayRootWorkCount()).toBe(0);
expect.soft(tracker.wizardSessions.has(sessionId)).toBe(false);
} finally {
process.off("unhandledRejection", onUnhandledRejection);
__setFsSafeTestHooksForTest(undefined);
runnerSettled.resolve();
resetGatewayWorkAdmission();
if (lockPath) {
await fs.rm(lockPath, { force: true });
}
}
});
it("blocks a replacement wizard until the cancelled runner settles", async () => {
const runnerSettled = createDeferred();
const tracker = createWizardSessionTracker();
+3 -4
View File
@@ -84,7 +84,7 @@ function retainGatewayWorkUntilSettled(session: WizardSession): void {
// active between steps or a config reload can erase the process-local session.
const release = retainGatewayRootWorkAdmissionContinuation();
if (release) {
void whenAdmittedWizardSessionSettled(session).then(release);
void whenAdmittedWizardSessionSettled(session).then(release, release);
}
}
@@ -219,9 +219,8 @@ export const wizardHandlers: GatewayRequestHandlers = {
const cancelled = session.cancel();
const status = readWizardStatus(session);
if (cancelled) {
void whenAdmittedWizardSessionSettled(session).then(() =>
context.purgeWizardSession(sessionId),
);
const purge = () => context.purgeWizardSession(sessionId);
void whenAdmittedWizardSessionSettled(session).then(purge, purge);
} else {
context.purgeWizardSession(sessionId);
}