summaryrefslogtreecommitdiffhomepage
path: root/packages/host-bin/src/collector-supervisor.test.ts
blob: 8c1f10448a1aea1dfae40d5ae2430721249b72a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
import { describe, expect, it } from "vitest";
import { type ChildHandle, createCollectorSupervisor } from "./collector-supervisor.js";

interface FakeChild {
	readonly handle: ChildHandle;
	resolveExit: (code: number) => void;
	readonly signals: string[];
}

function createFakeChild(code = 0): FakeChild {
	let resolveExit!: (code: number) => void;
	const exited = new Promise<number>((r) => {
		resolveExit = r;
	});
	const signals: string[] = [];
	const handle: ChildHandle = {
		kill: (signal?: string) => {
			signals.push(signal ?? "SIGTERM");
			if (signal === "SIGKILL") resolveExit(code);
		},
		exited,
	};
	return { handle, resolveExit, signals };
}

function createFakeLogger() {
	const msgs: Array<{ level: string; msg: string }> = [];
	return {
		msgs,
		debug: () => {},
		info: (msg: string) => msgs.push({ level: "info", msg }),
		warn: (msg: string) => msgs.push({ level: "warn", msg }),
		error: () => {},
		child: () => createFakeLogger(),
		span: () => ({
			id: "s",
			log: createFakeLogger(),
			setAttributes: () => {},
			addLink: () => {},
			child: () => ({}) as never,
			end: () => {},
		}),
	};
}

describe("createCollectorSupervisor", () => {
	const DEFAULTS = {
		journalPath: "/tmp/journal.ndjson",
		dbPath: "/tmp/traces.db",
	};

	it("start() spawns with the correct command and args", () => {
		let capturedCmd: string[] = [];
		const children: FakeChild[] = [];
		const spawn = (cmd: string[]) => {
			capturedCmd = cmd;
			const child = createFakeChild();
			children.push(child);
			return child.handle;
		};

		const supervisor = createCollectorSupervisor({
			...DEFAULTS,
			spawn,
			logger: createFakeLogger() as never,
		});
		supervisor.start();

		expect(capturedCmd).toEqual([
			"bun",
			"packages/observability-collector/src/main.ts",
			"--journal",
			"/tmp/journal.ndjson",
			"--db",
			"/tmp/traces.db",
		]);
	});

	it("start() passes --interval when provided", () => {
		let capturedCmd: string[] = [];
		const spawn = (cmd: string[]) => {
			capturedCmd = cmd;
			return createFakeChild().handle;
		};

		const supervisor = createCollectorSupervisor({
			...DEFAULTS,
			interval: 500,
			spawn,
			logger: createFakeLogger() as never,
		});
		supervisor.start();

		expect(capturedCmd).toContain("--interval");
		expect(capturedCmd).toContain("500");
	});

	it("unexpected child exit respawns the collector", async () => {
		const children: FakeChild[] = [];
		let spawnCount = 0;
		const spawn = () => {
			spawnCount++;
			const child = createFakeChild();
			children.push(child);
			return child.handle;
		};

		const time = 0;
		const now = () => time;
		const delayResolvers: Array<() => void> = [];
		const delay = (_ms: number) =>
			new Promise<void>((r) => {
				delayResolvers.push(r);
			});

		const supervisor = createCollectorSupervisor({
			...DEFAULTS,
			spawn,
			logger: createFakeLogger() as never,
			now,
			delay,
		});
		supervisor.start();

		expect(spawnCount).toBe(1);

		// Simulate unexpected exit
		children[0]?.resolveExit(1);
		await Promise.resolve();
		await Promise.resolve();

		// Trigger the backoff delay resolver
		expect(delayResolvers.length).toBe(1);
		delayResolvers[0]?.();
		await Promise.resolve();
		await Promise.resolve();

		expect(spawnCount).toBe(2);
	});

	it("restart guard caps respawns in a tight loop", async () => {
		const children: FakeChild[] = [];
		let spawnCount = 0;
		const spawn = () => {
			spawnCount++;
			const child = createFakeChild();
			children.push(child);
			return child.handle;
		};

		const time = 0;
		const now = () => time;
		const delayResolvers: Array<() => void> = [];
		const delay = (_ms: number) =>
			new Promise<void>((r) => {
				delayResolvers.push(r);
			});

		const logger = createFakeLogger();
		const supervisor = createCollectorSupervisor({
			...DEFAULTS,
			spawn,
			logger: logger as never,
			now,
			delay,
		});
		supervisor.start();

		// Simulate rapid crashes (within the restart window)
		for (let i = 0; i < 5; i++) {
			children[i]?.resolveExit(1);
			await Promise.resolve();
			await Promise.resolve();
			if (delayResolvers.length > i) {
				delayResolvers[i]?.();
				await Promise.resolve();
				await Promise.resolve();
			}
		}

		// Should have spawned 6 times (1 initial + 5 restarts)
		expect(spawnCount).toBe(6);

		// 6th child also dies — should NOT respawn (cap reached)
		children[5]?.resolveExit(1);
		await Promise.resolve();
		await Promise.resolve();

		// spawnCount should still be 6
		expect(spawnCount).toBe(6);
		expect(logger.msgs.some((m) => m.msg === "Collector restart cap reached; giving up")).toBe(
			true,
		);
	});

	it("stop() sends SIGTERM and does not respawn", async () => {
		const child = createFakeChild();
		const spawn = () => child.handle;

		const supervisor = createCollectorSupervisor({
			...DEFAULTS,
			spawn,
			logger: createFakeLogger() as never,
		});
		supervisor.start();

		// Resolve exit after SIGTERM (simulating graceful shutdown)
		const stopPromise = supervisor.stop();
		child.resolveExit(0);
		await stopPromise;

		expect(child.signals).toContain("SIGTERM");
	});

	it("stop() sends SIGKILL when child does not exit in time", async () => {
		const child = createFakeChild();
		const spawn = () => child.handle;

		const time = 0;
		const now = () => time;
		const delayResolvers: Array<() => void> = [];
		const delay = (_ms: number) =>
			new Promise<void>((r) => {
				delayResolvers.push(r);
			});

		const supervisor = createCollectorSupervisor({
			...DEFAULTS,
			spawn,
			logger: createFakeLogger() as never,
			now,
			delay,
		});
		supervisor.start();

		const stopPromise = supervisor.stop();

		// Don't resolve exit — simulate hung child
		// Resolve the timeout delay instead
		expect(delayResolvers.length).toBe(1);
		delayResolvers[0]?.();
		await stopPromise;

		expect(child.signals).toContain("SIGTERM");
		expect(child.signals).toContain("SIGKILL");
	});

	it("stop() does not respawn after unexpected exit during stop", async () => {
		const children: FakeChild[] = [];
		let spawnCount = 0;
		const spawn = () => {
			spawnCount++;
			const child = createFakeChild();
			children.push(child);
			return child.handle;
		};

		const supervisor = createCollectorSupervisor({
			...DEFAULTS,
			spawn,
			logger: createFakeLogger() as never,
		});
		supervisor.start();
		expect(spawnCount).toBe(1);

		// Child exits during stop — supervisor is already stopping
		const stopPromise = supervisor.stop();
		children[0]?.resolveExit(1);
		await stopPromise;

		// Should NOT have respawned
		expect(spawnCount).toBe(1);
	});

	it("spawn throwing does not throw to caller", () => {
		const spawn = () => {
			throw new Error("spawn failed");
		};

		const logger = createFakeLogger();
		const supervisor = createCollectorSupervisor({
			...DEFAULTS,
			spawn,
			logger: logger as never,
		});

		expect(() => supervisor.start()).not.toThrow();
		expect(logger.msgs.some((m) => m.msg === "Failed to spawn collector")).toBe(true);
	});

	it("stop() is safe to call when no child was started", async () => {
		const spawn = () => createFakeChild().handle;
		const supervisor = createCollectorSupervisor({
			...DEFAULTS,
			spawn,
			logger: createFakeLogger() as never,
		});

		await expect(supervisor.stop()).resolves.toBeUndefined();
	});
});