Skip to content

Commit e71cdd2

Browse files
committed
fix(desktop): drain renderer history before quit
1 parent 469e905 commit e71cdd2

5 files changed

Lines changed: 64 additions & 17 deletions

File tree

‎apps/desktop/src/app/DesktopApp.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ import * as DesktopRemoteUpdates from "../updates/DesktopRemoteUpdates.ts";
3333
import * as DesktopUpdates from "../updates/DesktopUpdates.ts";
3434
import * as DesktopSnapShot from "../snapShot/DesktopSnapShot.ts";
3535
import * as DesktopWslBackend from "../wsl/DesktopWslBackend.ts";
36+
import * as DesktopRendererHistory from "../telemetry/DesktopRendererHistory.ts";
3637

3738
const DEFAULT_DESKTOP_BACKEND_PORT = 3773;
3839
const MAX_TCP_PORT = 65_535;
@@ -342,14 +343,18 @@ const scopedProgram = Effect.scoped(
342343
yield* Effect.annotateCurrentSpan({ scope: "desktop", runId });
343344

344345
const shutdown = yield* DesktopShutdown.DesktopShutdown;
346+
const rendererHistory = yield* DesktopRendererHistory.DesktopRendererHistory;
345347

346348
yield* Effect.addFinalizer(() =>
347349
// Stop every backend in the pool, not just the primary. The
348350
// electronApp.quit() path can race ahead of the layer-scope
349351
// cascade, so leaving the WSL instance for its parent scope
350352
// finalizer means it gets hard-killed by the OS instead of
351353
// receiving SIGTERM + grace.
352-
stopAllPoolInstances().pipe(Effect.ensuring(shutdown.markComplete)),
354+
stopAllPoolInstances().pipe(
355+
Effect.ensuring(rendererHistory.shutdown),
356+
Effect.ensuring(shutdown.markComplete),
357+
),
353358
);
354359

355360
yield* startup;

‎apps/desktop/src/preview/Manager.test.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,7 @@ const layer = PreviewManager.layer.pipe(
272272
Layer.succeed(DesktopRendererHistory.DesktopRendererHistory, {
273273
register: () => Effect.void,
274274
recordMetrics: () => Effect.void,
275+
shutdown: Effect.void,
275276
}),
276277
),
277278
Layer.provideMerge(browserSessionLayer),

‎apps/desktop/src/telemetry/DesktopRendererHistory.ts‎

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import * as Cause from "effect/Cause";
33
import * as Clock from "effect/Clock";
44
import * as Context from "effect/Context";
55
import * as Effect from "effect/Effect";
6+
import * as Fiber from "effect/Fiber";
67
import * as Layer from "effect/Layer";
78
import * as Path from "effect/Path";
89
import * as Queue from "effect/Queue";
@@ -23,6 +24,7 @@ export class DesktopRendererHistory extends Context.Service<
2324
identity: RendererIdentity,
2425
) => Effect.Effect<void>;
2526
readonly recordMetrics: (metrics: ReadonlyArray<Electron.ProcessMetric>) => Effect.Effect<void>;
27+
readonly shutdown: Effect.Effect<void>;
2628
}
2729
>()("@t3tools/desktop/telemetry/DesktopRendererHistory") {}
2830

@@ -63,6 +65,7 @@ interface TrackedRenderer {
6365
pid: number | null;
6466
creationTimeMs: number | null;
6567
memory: RendererMemory | null;
68+
gone: boolean;
6669
readonly removeListeners: () => void;
6770
}
6871

@@ -79,6 +82,7 @@ const make = Effect.fn("DesktopRendererHistory.make")(function* () {
7982
const mainSessionStartedAtUnixMs = clock.currentTimeMillisUnsafe();
8083
const records = yield* Queue.sliding<RendererRecord>(256);
8184
const active = new Map<number, TrackedRenderer>();
85+
let accepting = true;
8286
const writer = yield* makeRotatingLogFileWriter({
8387
filePath: path.join(environment.logDir, "renderer-history.ndjson"),
8488
maxBytes: 256 * 1024,
@@ -93,7 +97,7 @@ const make = Effect.fn("DesktopRendererHistory.make")(function* () {
9397

9498
const writeRecord = (record: RendererRecord) =>
9599
writer.writeText(`${JSON.stringify(record)}\n`).pipe(Effect.ignore);
96-
yield* Effect.forever(
100+
const writerFiber = yield* Effect.forever(
97101
Effect.uninterruptibleMask((restore) =>
98102
restore(Queue.take(records)).pipe(Effect.flatMap(writeRecord)),
99103
).pipe(
@@ -116,7 +120,7 @@ const make = Effect.fn("DesktopRendererHistory.make")(function* () {
116120

117121
const readPid = (renderer: TrackedRenderer): RendererRecord["rendererPidSource"] => {
118122
try {
119-
if (!renderer.webContents.isDestroyed()) {
123+
if (!renderer.gone && !renderer.webContents.isDestroyed()) {
120124
const pid = renderer.webContents.getOSProcessId();
121125
if (Number.isInteger(pid) && pid > 0) {
122126
if (pid !== renderer.pid) {
@@ -163,7 +167,7 @@ const make = Effect.fn("DesktopRendererHistory.make")(function* () {
163167

164168
const register = (webContents: Electron.WebContents, identity: RendererIdentity) =>
165169
Effect.sync(() => {
166-
if (webContents.isDestroyed()) return;
170+
if (!accepting || webContents.isDestroyed()) return;
167171
const boundedIdentity: RendererIdentity = {
168172
surface: identity.surface,
169173
...(identity.tabId === undefined ? {} : { tabId: identity.tabId.slice(0, 128) }),
@@ -179,7 +183,15 @@ const make = Effect.fn("DesktopRendererHistory.make")(function* () {
179183
}
180184
return;
181185
}
182-
const onDomReady = () => record(renderer, "dom-ready");
186+
const onDomReady = () => {
187+
if (renderer.gone) {
188+
renderer.pid = null;
189+
renderer.creationTimeMs = null;
190+
renderer.memory = null;
191+
renderer.gone = false;
192+
}
193+
record(renderer, "dom-ready");
194+
};
183195
const onDevToolsOpened = () => {
184196
const tools = webContents.devToolsWebContents;
185197
if (tools)
@@ -190,8 +202,11 @@ const make = Effect.fn("DesktopRendererHistory.make")(function* () {
190202
}),
191203
);
192204
};
193-
const onGone = (_event: Electron.Event, details: Electron.RenderProcessGoneDetails) =>
205+
const onGone = (_event: Electron.Event, details: Electron.RenderProcessGoneDetails) => {
206+
readPid(renderer);
207+
renderer.gone = true;
194208
record(renderer, "render-process-gone", details);
209+
};
195210
const onDestroyed = () => {
196211
record(renderer, "destroyed");
197212
active.delete(webContents.id);
@@ -203,6 +218,7 @@ const make = Effect.fn("DesktopRendererHistory.make")(function* () {
203218
pid: null,
204219
creationTimeMs: null,
205220
memory: null,
221+
gone: false,
206222
removeListeners: () => {
207223
webContents.removeListener("dom-ready", onDomReady);
208224
webContents.removeListener("devtools-opened", onDevToolsOpened);
@@ -226,10 +242,11 @@ const make = Effect.fn("DesktopRendererHistory.make")(function* () {
226242
let lastSampledAtUnixMs = -Infinity;
227243
const recordMetrics = (metrics: ReadonlyArray<Electron.ProcessMetric>) =>
228244
Effect.sync(() => {
229-
const byPid = new Map(metrics.map((metric) => [metric.pid, metric]));
245+
if (!accepting) return;
230246
const sampledAtUnixMs = clock.currentTimeMillisUnsafe();
231247
if (sampledAtUnixMs - lastSampledAtUnixMs < 30_000) return;
232248
lastSampledAtUnixMs = sampledAtUnixMs;
249+
const byPid = new Map(metrics.map((metric) => [metric.pid, metric]));
233250
for (const renderer of active.values()) {
234251
const pidSource = readPid(renderer);
235252
// A last-known PID may already have been reused by another process.
@@ -253,14 +270,14 @@ const make = Effect.fn("DesktopRendererHistory.make")(function* () {
253270
() => Effect.void,
254271
),
255272
);
256-
yield* Effect.addFinalizer(() =>
257-
Effect.sync(() => {
258-
for (const renderer of active.values()) renderer.removeListeners();
259-
active.clear();
260-
}),
261-
);
273+
const shutdown = Effect.sync(() => {
274+
accepting = false;
275+
for (const renderer of active.values()) renderer.removeListeners();
276+
active.clear();
277+
}).pipe(Effect.andThen(Fiber.interrupt(writerFiber)), Effect.asVoid);
278+
yield* Effect.addFinalizer(() => shutdown);
262279

263-
return DesktopRendererHistory.of({ register, recordMetrics });
280+
return DesktopRendererHistory.of({ register, recordMetrics, shutdown });
264281
});
265282

266283
export const layer = Layer.effect(DesktopRendererHistory, make());

‎apps/desktop/src/telemetry/DesktopTelemetryPublisher.test.ts‎

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import * as DesktopRendererHistory from "./DesktopRendererHistory.ts";
2727
const historyLayer = Layer.succeed(DesktopRendererHistory.DesktopRendererHistory, {
2828
register: () => Effect.void,
2929
recordMetrics: () => Effect.void,
30+
shutdown: Effect.void,
3031
});
3132

3233
function makeElectronAppLayer(
@@ -154,6 +155,7 @@ describe("DesktopTelemetryPublisher", () => {
154155
powerLayer,
155156
Layer.succeed(DesktopRendererHistory.DesktopRendererHistory, {
156157
register: () => Effect.void,
158+
shutdown: Effect.void,
157159
recordMetrics: (sample) =>
158160
Effect.sync(() => {
159161
recordedMetrics.push(sample);
@@ -656,13 +658,23 @@ describe("DesktopRendererHistory", () => {
656658
assert.equal(crash.rendererPidSource, "last-known");
657659
assert.equal(crash.reason, "oom");
658660
assert.equal(crash.exitCode, -7);
661+
// A restarted renderer can reuse the same numeric PID.
662+
const restarted = yield* Deferred.make<Record>();
663+
milestone = { matches: (row) => row.event === "dom-ready", written: restarted };
664+
previewPid = 7_003;
665+
preview.emit("dom-ready");
666+
const restart = yield* Deferred.await(restarted);
667+
assert.equal(restart.rendererPid, 7_003);
668+
assert.equal(restart.rendererPidSource, "current");
669+
assert.isNull(restart.rendererCreationTimeMs);
670+
assert.isNull(restart.memory);
659671
const destroyed = yield* Deferred.make<Record>();
660672
milestone = { matches: (row) => row.event === "destroyed", written: destroyed };
661673
previewDestroyed = true;
662674
preview.emit("destroyed");
663675
const destruction = yield* Deferred.await(destroyed);
664676
assert.equal(destruction.rendererPid, 7_003);
665-
assert.equal(destruction.rendererCreationTimeMs, 700_300);
677+
assert.isNull(destruction.rendererCreationTimeMs);
666678
assert.equal(destruction.tabId, "preview-tab");
667679
assert.equal(preview.eventNames().length, 0);
668680
const afterDestroy = yield* Deferred.make<Record>();
@@ -672,8 +684,19 @@ describe("DesktopRendererHistory", () => {
672684
yield* history.recordMetrics(metrics);
673685
assert.equal((yield* Deferred.await(afterDestroy)).webContentsId, 1);
674686
assert.isFalse(persisted.slice(previousCount).some((row) => row.webContentsId === 2));
675-
// Closing immediately still drains these accepted lifecycle records.
687+
// The app quit handshake drains before the history layer closes.
676688
for (let index = 0; index < 12; index++) main.emit("dom-ready");
689+
yield* history.shutdown;
690+
assert.equal(
691+
persisted.filter((row) => row.webContentsId === 1 && row.event === "dom-ready").length,
692+
12,
693+
);
694+
const afterShutdown = persisted.length;
695+
yield* history.register(main as unknown as Electron.WebContents, { surface: "main" });
696+
yield* history.recordMetrics(metrics);
697+
assert.equal(persisted.length, afterShutdown);
698+
assert.equal(main.eventNames().length, 0);
699+
yield* history.shutdown;
677700
}).pipe(Effect.provide(layer));
678701

679702
assert.equal(main.eventNames().length, 0);
@@ -728,7 +751,6 @@ describe("DesktopRendererHistory", () => {
728751
logDir: directory,
729752
} as DesktopEnvironment.DesktopEnvironment["Service"]),
730753
),
731-
makeElectronAppLayer([]),
732754
fileLayer,
733755
),
734756
),

‎apps/desktop/src/window/DesktopWindow.test.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,7 @@ function makeTestLayer(input: {
290290
Layer.succeed(DesktopRendererHistory.DesktopRendererHistory, {
291291
register: () => Effect.void,
292292
recordMetrics: () => Effect.void,
293+
shutdown: Effect.void,
293294
}),
294295
desktopEnvironmentLayer,
295296
desktopAppSettingsLayer,
@@ -409,6 +410,7 @@ const makeSplashScenario = (createOutcomes: readonly (Electron.BrowserWindow | n
409410
Layer.succeed(DesktopRendererHistory.DesktopRendererHistory, {
410411
register: () => Effect.void,
411412
recordMetrics: () => Effect.void,
413+
shutdown: Effect.void,
412414
}),
413415
desktopEnvironmentLayer,
414416
DesktopAppSettings.layerTest(),

0 commit comments

Comments
 (0)