TypeScript
fix(desktop): quit no longer orphans a backend that is slow to stop (#22572)
Alex Southwell69726aac2f6f
diff --git a/apps/desktop/src/app/DesktopApp.ts b/apps/desktop/src/app/DesktopApp.tsindex 151c227e47f..5d877206d0e 100644--- a/apps/desktop/src/app/DesktopApp.ts+++ b/apps/desktop/src/app/DesktopApp.ts@@ -1,6 +1,5 @@import * as Cause from "effect/Cause";import * as Config from "effect/Config";-import * as Duration from "effect/Duration";import * as Effect from "effect/Effect";import * as Option from "effect/Option";import * as Ref from "effect/Ref";@@ -19,6 +18,7 @@ import * as DesktopClerk from "./DesktopClerk.ts";import * as DesktopApplicationMenu from "../window/DesktopApplicationMenu.ts";import * as DesktopWindow from "../window/DesktopWindow.ts";import * as PreviewPasskeys from "../preview/Passkeys.ts";+import * as DesktopBackendManager from "../backend/DesktopBackendManager.ts";import * as DesktopBackendPool from "../backend/DesktopBackendPool.ts";import * as DesktopEnvironment from "./DesktopEnvironment.ts";import * as DesktopLegacyLocalStorage from "./DesktopLegacyLocalStorage.ts";@@ -160,7 +160,7 @@ const stopAllPoolInstances = Effect.fn("desktop.app.stopAllPoolInstances")(const instances = yield* pool.list;yield* Effect.forEach(instances,- (instance) => instance.stop({ timeout: Duration.seconds(5) }),+ (instance) => instance.stop({ timeout: DesktopBackendManager.BACKEND_QUIT_STOP_TIMEOUT }),{ concurrency: "unbounded" },);},diff --git a/apps/desktop/src/backend/DesktopBackendManager.test.ts b/apps/desktop/src/backend/DesktopBackendManager.test.tsindex e4714673777..2741daa1ddd 100644--- a/apps/desktop/src/backend/DesktopBackendManager.test.ts+++ b/apps/desktop/src/backend/DesktopBackendManager.test.ts@@ -720,4 +720,58 @@ describe("DesktopBackendManager", () => {}).pipe(Effect.provide(TestClock.layer())),),);++ it.effect("the quit stop deadline waits for a backend that only exits at the force kill", () =>+ Effect.scoped(+ Effect.gen(function* () {+ const spawned = yield* Deferred.make<void>();+ const teardownStarted = yield* Deferred.make<void>();+ const teardownFinished = yield* Deferred.make<void>();+ // The real spawner sends SIGTERM, waits the grace, then SIGKILLs. A backend that+ // ignores SIGTERM therefore finishes tearing down just after the grace.+ const instance = yield* makeTestInstance({+ spawnerLayer: Layer.succeed(+ ChildProcessSpawner.ChildProcessSpawner,+ ChildProcessSpawner.make(() =>+ Effect.gen(function* () {+ const scope = yield* Scope.Scope;+ yield* Deferred.succeed(spawned, undefined);+ yield* Scope.addFinalizer(+ scope,+ Deferred.succeed(teardownStarted, undefined).pipe(+ Effect.andThen(Effect.sleep(Duration.seconds(6))),+ Effect.andThen(Deferred.succeed(teardownFinished, undefined)),+ Effect.asVoid,+ ),+ );+ return makeProcess({+ exitCode: Deferred.await(teardownFinished).pipe(+ Effect.as(ChildProcessSpawner.ExitCode(0)),+ ),+ });+ }),+ ),+ ),+ httpClientLayer: layerHttpClient(() => Effect.never),+ });+ yield* instance.start;+ yield* Deferred.await(spawned);++ // App quit and the updater stop every backend with this deadline.+ const quitDone = yield* Deferred.make<void>();+ const quitFiber = yield* instance+ .stop({ timeout: DesktopBackendManager.BACKEND_QUIT_STOP_TIMEOUT })+ .pipe(Effect.andThen(Deferred.succeed(quitDone, undefined)), Effect.forkChild);++ yield* Deferred.await(teardownStarted);+ // Past the SIGTERM grace but before the force kill lands: quit must still be waiting.+ yield* TestClock.adjust(Duration.millis(5_500));+ assert.isFalse(yield* Deferred.isDone(quitDone));++ yield* TestClock.adjust(Duration.millis(500));+ yield* Fiber.join(quitFiber);+ assert.isTrue(yield* Deferred.isDone(teardownFinished));+ }).pipe(Effect.provide(TestClock.layer())),+ ),+ );});diff --git a/apps/desktop/src/backend/DesktopBackendManager.ts b/apps/desktop/src/backend/DesktopBackendManager.tsindex 2f5b57c4e3c..6e356a7c856 100644--- a/apps/desktop/src/backend/DesktopBackendManager.ts+++ b/apps/desktop/src/backend/DesktopBackendManager.ts@@ -41,6 +41,12 @@ const DEFAULT_BACKEND_READINESS_INTERVAL = Duration.millis(100);const DEFAULT_BACKEND_READINESS_REQUEST_TIMEOUT = Duration.seconds(1);// Match the service launcher's grace period so backends can stop provider sessions.const DEFAULT_BACKEND_TERMINATE_GRACE = Duration.seconds(5);+// Allow SIGKILL and the spawner exit wait after the SIGTERM grace so quit cannot+// orphan a backend whose shutdown hangs.+export const BACKEND_QUIT_STOP_TIMEOUT = Duration.sum(+ DEFAULT_BACKEND_TERMINATE_GRACE,+ Duration.seconds(2),+);const DEFAULT_BACKEND_OUTPUT_DRAIN_TIMEOUT = Duration.seconds(5);const BACKEND_READINESS_PATH = "/.well-known/t3/environment";// Three restarts without readiness is about 2 s of backoff: past a blip, early enough to help.diff --git a/apps/desktop/src/updates/DesktopUpdates.ts b/apps/desktop/src/updates/DesktopUpdates.tsindex 6279e8b6141..14688e52580 100644--- a/apps/desktop/src/updates/DesktopUpdates.ts+++ b/apps/desktop/src/updates/DesktopUpdates.ts@@ -25,6 +25,7 @@ import * as Scope from "effect/Scope";import * as Semaphore from "effect/Semaphore";import * as Stream from "effect/Stream";+import * as DesktopBackendManager from "../backend/DesktopBackendManager.ts";import * as DesktopBackendPool from "../backend/DesktopBackendPool.ts";import * as DesktopConfig from "../app/DesktopConfig.ts";import * as DesktopEnvironment from "../app/DesktopEnvironment.ts";@@ -819,7 +820,8 @@ export const make = Effect.gen(function* () {yield* Ref.set(installRunningBackendsRef, runningInstances);yield* Effect.forEach(instances,- (instance) => instance.stop({ timeout: Duration.seconds(5) }),+ (instance) =>+ instance.stop({ timeout: DesktopBackendManager.BACKEND_QUIT_STOP_TIMEOUT }),{ concurrency: "unbounded" },);yield* electronUpdater.quitAndInstall({