From 239d9f93ff7ae75e3236143cbed9cb1308cdaf53 Mon Sep 17 00:00:00 2001 From: William Valentin Date: Mon, 16 Feb 2026 20:57:34 -0800 Subject: [PATCH] fix(companion): validate waitForIdle timeout option --- docs/plans/state.json | 12 ++++++++++++ src/companion/runtimeClient.test.ts | 10 ++++++++++ src/companion/runtimeClient.ts | 5 ++++- 3 files changed, 26 insertions(+), 1 deletion(-) diff --git a/docs/plans/state.json b/docs/plans/state.json index 1dffc18..cb9dbd2 100644 --- a/docs/plans/state.json +++ b/docs/plans/state.json @@ -938,6 +938,18 @@ ], "test_status": "pnpm test:run src/companion/runtimeClient.test.ts src/companion/platformClients.test.ts src/companion/heartbeatLoop.test.ts src/companion/platformClients.integration.test.ts + pnpm typecheck passing" }, + "companion-runtime-wait-for-idle-timeout-validation": { + "status": "completed", + "date": "2026-02-17", + "updated": "2026-02-17", + "summary": "Added `waitForIdle()` timeout validation guardrails (`timeoutMs > 0`) with regression tests for deterministic option validation behavior.", + "files_modified": [ + "src/companion/runtimeClient.ts", + "src/companion/runtimeClient.test.ts", + "docs/plans/state.json" + ], + "test_status": "pnpm test:run src/companion/runtimeClient.test.ts src/companion/platformClients.test.ts src/companion/heartbeatLoop.test.ts src/companion/platformClients.integration.test.ts + pnpm typecheck passing" + }, "browser-tools-activation-clarity": { "status": "completed", "date": "2026-02-17", diff --git a/src/companion/runtimeClient.test.ts b/src/companion/runtimeClient.test.ts index 76a88e2..82a1c07 100644 --- a/src/companion/runtimeClient.test.ts +++ b/src/companion/runtimeClient.test.ts @@ -661,6 +661,16 @@ describe('CompanionRuntimeClient', () => { ); }); + it('waitForIdle validates timeoutMs option', () => { + const client = new CompanionRuntimeClient({ + url: 'ws://127.0.0.1:1', + }); + + expect(() => client.waitForIdle({ timeoutMs: 0 })).toThrow( + 'timeoutMs must be a positive number', + ); + }); + it('waitForIdle resolves after pending event waiters are cleared', async () => { const client = new CompanionRuntimeClient({ url: 'ws://127.0.0.1:1', diff --git a/src/companion/runtimeClient.ts b/src/companion/runtimeClient.ts index 1cf0e11..3c20a84 100644 --- a/src/companion/runtimeClient.ts +++ b/src/companion/runtimeClient.ts @@ -614,6 +614,10 @@ export class CompanionRuntimeClient { } waitForIdle(options?: WaitForIdleOptions): Promise { + const timeoutMs = options?.timeoutMs ?? this.requestTimeoutMs; + if (!Number.isFinite(timeoutMs) || timeoutMs <= 0) { + throw new Error('timeoutMs must be a positive number'); + } const pollIntervalMs = options?.pollIntervalMs ?? 25; if (!Number.isFinite(pollIntervalMs) || pollIntervalMs <= 0) { throw new Error('pollIntervalMs must be a positive number'); @@ -621,7 +625,6 @@ export class CompanionRuntimeClient { if (!this.hasPendingWork) { return Promise.resolve(); } - const timeoutMs = options?.timeoutMs ?? this.requestTimeoutMs; const signal = options?.signal; return new Promise((resolve, reject) => {