TypeScript
chore(desktop): trace shutdown phases (#31850)
Yash Singhe21347b47081
diff --git a/apps/desktop/src/app/DesktopApp.test.ts b/apps/desktop/src/app/DesktopApp.test.tsindex 66fc83adae1..8b5f9f712dc 100644--- a/apps/desktop/src/app/DesktopApp.test.ts+++ b/apps/desktop/src/app/DesktopApp.test.ts@@ -2,6 +2,7 @@ import { assert, it } from "@effect/vitest";import * as NodeCrypto from "@effect/platform-node/NodeCrypto";import * as Deferred from "effect/Deferred";import * as Effect from "effect/Effect";+import * as Exit from "effect/Exit";import * as Layer from "effect/Layer";import * as FileSystem from "effect/FileSystem";import * as Path from "effect/Path";@@ -69,14 +70,19 @@ import * as ElectronWindow from "../electron/ElectronWindow.ts";import * as MacPermissions from "../permissions/MacPermissions.ts";import * as PreviewManager from "../preview/Manager.ts";-it.effect(- "starts the backend and window while Linux registration is stalled and cancels it on shutdown",- () =>+it.effect.each([false, true])(+ "stops backends together before flushing history and cancels Linux registration, stop defect=%s",+ (stopDefect) =>Effect.gen(function* () {const registrationStarted = yield* Deferred.make<void>();const releaseRegistration = yield* Deferred.make<void>();const registrationStopped = yield* Deferred.make<void>();const windowStarted = yield* Deferred.make<void>();+ const firstStopStarted = yield* Deferred.make<void>();+ const secondStopStarted = yield* Deferred.make<void>();+ const releaseStops = yield* Deferred.make<void>();+ const historyStarted = yield* Deferred.make<void>();+ const releaseHistory = yield* Deferred.make<void>();const quitting = yield* Ref.make(false);const events: string[] = [];const record = (event: string) =>@@ -169,7 +175,21 @@ it.effect(start: record("backend"),currentConfig: Effect.succeedSome({ preflightFailure: Option.none() }),}),- list: Effect.succeed([]),+ list: Effect.succeed([+ {+ stop: () =>+ Deferred.succeed(firstStopStarted, undefined).pipe(+ Effect.andThen(Deferred.await(releaseStops)),+ Effect.andThen(stopDefect ? Effect.die("stop defect") : Effect.void),+ ),+ },+ {+ stop: () =>+ Deferred.succeed(secondStopStarted, undefined).pipe(+ Effect.andThen(Deferred.await(releaseStops)),+ ),+ },+ ]),} as unknown as DesktopBackendPool.DesktopBackendPool["Service"]),Effect.provideService(DesktopServerExposure.DesktopServerExposure, {configureFromSettings: () => Effect.succeed({ mode: "local-only" }),@@ -182,7 +202,10 @@ it.effect(start: Effect.void,} as unknown as DesktopAppActivation.DesktopAppActivation["Service"]),Effect.provideService(DesktopRendererHistory.DesktopRendererHistory, {- shutdown: Effect.void,+ shutdown: Deferred.succeed(historyStarted, undefined).pipe(+ Effect.andThen(Deferred.await(releaseHistory)),+ Effect.asVoid,+ ),} as DesktopRendererHistory.DesktopRendererHistory["Service"]),);const app = yield* runApp.pipe(@@ -226,8 +249,19 @@ it.effect(yield* Deferred.await(windowStarted);assert.deepEqual(events, ["identity", "ready", "identity", "backend", "window"]);assert.isFalse(yield* Deferred.isDone(registrationStopped));- yield* (yield* DesktopShutdown.DesktopShutdown).request;- yield* Fiber.join(app);+ const shutdown = yield* DesktopShutdown.DesktopShutdown;+ yield* shutdown.request;+ yield* Deferred.await(firstStopStarted);+ yield* Deferred.await(secondStopStarted);+ assert.isFalse(yield* Deferred.isDone(historyStarted));+ assert.isFalse(yield* shutdown.isComplete);+ yield* Deferred.succeed(releaseStops, undefined);+ yield* Deferred.await(historyStarted);+ assert.isFalse(yield* shutdown.isComplete);+ yield* Deferred.succeed(releaseHistory, undefined);+ const result = yield* Fiber.await(app);+ assert.equal(Exit.isFailure(result), stopDefect);+ assert.isTrue(yield* shutdown.isComplete);assert.isTrue(yield* Deferred.isDone(registrationStopped));}).pipe(Effect.provide(DesktopShutdown.layer)),);diff --git a/apps/desktop/src/app/DesktopApp.ts b/apps/desktop/src/app/DesktopApp.tsindex 5d877206d0e..3c5f499a1cb 100644--- a/apps/desktop/src/app/DesktopApp.ts+++ b/apps/desktop/src/app/DesktopApp.ts@@ -363,6 +363,7 @@ const scopedProgram = Effect.scoped(stopAllPoolInstances().pipe(Effect.ensuring(rendererHistory.shutdown),Effect.ensuring(shutdown.markComplete),+ Effect.withSpan("desktop.app.shutdown"),),);diff --git a/apps/desktop/src/backend/DesktopBackendManager.ts b/apps/desktop/src/backend/DesktopBackendManager.tsindex 6e356a7c856..98de41e2471 100644--- a/apps/desktop/src/backend/DesktopBackendManager.ts+++ b/apps/desktop/src/backend/DesktopBackendManager.ts@@ -312,7 +312,10 @@ const closeRun = (onNone: () => Effect.void,onSome: (fiber) => Fiber.await(fiber).pipe(Effect.asVoid),});- const close = Scope.close(run.scope, Exit.void).pipe(Effect.andThen(waitForFiber));+ const close = Scope.close(run.scope, Exit.void).pipe(+ Effect.withSpan("desktop.backendInstance.closeScope"),+ Effect.andThen(waitForFiber.pipe(Effect.withSpan("desktop.backendInstance.awaitRun"))),+ );const timeout = options?.timeout;if (!timeout) {@@ -573,6 +576,7 @@ export const runBackendProcess = Effect.fn("runBackendProcess")(function* (yield* probeReadiness().pipe(Effect.repeat({ while: (ready) => !ready }), Effect.forkScoped);const exit = yield* handle.exitCode.pipe(+ Effect.withSpan("desktop.backendProcess.awaitExit"),Effect.map((exitCode) => ({code: Option.some(exitCode),reason: `code=${exitCode}`,@@ -608,6 +612,7 @@ export const runBackendProcess = Effect.fn("runBackendProcess")(function* (}).pipe(Effect.timeout(options.outputDrainTimeout ?? DEFAULT_BACKEND_OUTPUT_DRAIN_TIMEOUT),Effect.ignore,+ Effect.withSpan("desktop.backendProcess.drainOutput"),);if (Exit.isFailure(exit)) {return yield* Effect.failCause(exit.cause);diff --git a/apps/desktop/src/telemetry/DesktopRendererHistory.ts b/apps/desktop/src/telemetry/DesktopRendererHistory.tsindex ed1590f63b1..dc3e157f953 100644--- a/apps/desktop/src/telemetry/DesktopRendererHistory.ts+++ b/apps/desktop/src/telemetry/DesktopRendererHistory.ts@@ -273,7 +273,11 @@ const make = Effect.fn("DesktopRendererHistory.make")(function* () {accepting = false;for (const renderer of active.values()) renderer.removeListeners();active.clear();- }).pipe(Effect.andThen(Fiber.interrupt(writerFiber)), Effect.asVoid);+ }).pipe(+ Effect.andThen(Fiber.interrupt(writerFiber)),+ Effect.asVoid,+ Effect.withSpan("desktop.rendererHistory.shutdown"),+ );yield* Effect.addFinalizer(() => shutdown);return DesktopRendererHistory.of({ register, recordMetrics, shutdown });