From 01f75e536de3c234066cf77ba690ac63e17cf284 Mon Sep 17 00:00:00 2001 From: William Valentin Date: Mon, 16 Feb 2026 23:33:36 -0800 Subject: [PATCH] fix(companion): clear disconnect metadata after reconnect --- README.md | 2 +- docs/plans/state.json | 15 +++++++++++- src/companion/runtimeClient.test.ts | 38 +++++++++++++++++++++++++++++ src/companion/runtimeClient.ts | 2 ++ 4 files changed, 55 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fe846c0..445b160 100644 --- a/README.md +++ b/README.md @@ -1190,7 +1190,7 @@ Methods: - `system.capabilities` returns gateway protocol and node policy snapshot. Companion runtime helper: -- `src/companion/runtimeClient.ts` provides a typed Node/WebSocket client for companion runtimes (macOS/iOS/Android workers) with wrappers for `node.register`, `node.capabilities.get`, `node.location.set/get`, `node.status.set`, `node.push_token.set`, `system.capabilities`, `system.nodes`, and canvas artifact RPCs (`canvas.put/get/list/delete/clear`), plus convenience helpers (`bootstrapNode`, optional `autoConnect`, `dispose()`, `waitForIdle()` for pending-work drain synchronization) and event helpers (`subscribeEvents()`, `subscribeEvent()`, `subscribeAgentStream()`, `subscribeAgentTyping()`, `subscribeContextWarning()`, `waitForEvent()` with timeout/predicate/abort support plus event-name/timeout validation and deterministic teardown cancellation including socket-close rejection, `waitForAnyEvent()` with event-list/timeout validation, `waitForAgentStream()`, `waitForAgentTyping()`, `waitForContextWarning()`, `clearEventSubscriptions()` returning cleared-subscription/cancelled-wait counts, `cancelPendingEventWaits()` returning cancelled waiter count, `listKnownEventNames()`, `eventSubscriptionCount`) plus in-flight observability via `pendingRequestCount`, `pendingEventWaitCount`, `hasPendingWork`, `idle`, `lastDisconnectCode`, `lastDisconnectReason`, `getPendingWorkSnapshot()`, `getEventSurfaceSnapshot()`, and `getConnectionSnapshot()` (including disconnect metadata). +- `src/companion/runtimeClient.ts` provides a typed Node/WebSocket client for companion runtimes (macOS/iOS/Android workers) with wrappers for `node.register`, `node.capabilities.get`, `node.location.set/get`, `node.status.set`, `node.push_token.set`, `system.capabilities`, `system.nodes`, and canvas artifact RPCs (`canvas.put/get/list/delete/clear`), plus convenience helpers (`bootstrapNode`, optional `autoConnect`, `dispose()`, `waitForIdle()` for pending-work drain synchronization) and event helpers (`subscribeEvents()`, `subscribeEvent()`, `subscribeAgentStream()`, `subscribeAgentTyping()`, `subscribeContextWarning()`, `waitForEvent()` with timeout/predicate/abort support plus event-name/timeout validation and deterministic teardown cancellation including socket-close rejection, `waitForAnyEvent()` with event-list/timeout validation, `waitForAgentStream()`, `waitForAgentTyping()`, `waitForContextWarning()`, `clearEventSubscriptions()` returning cleared-subscription/cancelled-wait counts, `cancelPendingEventWaits()` returning cancelled waiter count, `listKnownEventNames()`, `eventSubscriptionCount`) plus in-flight observability via `pendingRequestCount`, `pendingEventWaitCount`, `hasPendingWork`, `idle`, `lastDisconnectCode`, `lastDisconnectReason`, `getPendingWorkSnapshot()`, `getEventSurfaceSnapshot()`, and `getConnectionSnapshot()` (including disconnect metadata, cleared on successful reconnect). - `src/companion/platformClients.ts` provides platform-focused wrappers: - `MacOSCompanionClient` (`platform: "macos"`, APNs push registration) - `IOSCompanionClient` (`platform: "ios"`, APNs push registration) diff --git a/docs/plans/state.json b/docs/plans/state.json index 9055781..686d24b 100644 --- a/docs/plans/state.json +++ b/docs/plans/state.json @@ -1252,6 +1252,19 @@ ], "test_status": "pnpm test:run src/companion/runtimeClient.test.ts src/companion/platformClients.test.ts src/companion/platformClients.integration.test.ts src/companion/heartbeatLoop.test.ts + pnpm typecheck passing" }, + "companion-runtime-reconnect-clears-disconnect-metadata": { + "status": "completed", + "date": "2026-02-17", + "updated": "2026-02-17", + "summary": "Cleared stale disconnect metadata on successful reconnect (`connect`) so `lastDisconnectCode`/`lastDisconnectReason` reflect only the latest completed disconnection lifecycle.", + "files_modified": [ + "src/companion/runtimeClient.ts", + "src/companion/runtimeClient.test.ts", + "README.md", + "docs/plans/state.json" + ], + "test_status": "pnpm test:run src/companion/runtimeClient.test.ts src/companion/platformClients.test.ts src/companion/platformClients.integration.test.ts src/companion/heartbeatLoop.test.ts + pnpm typecheck passing" + }, "browser-tools-activation-clarity": { "status": "completed", "date": "2026-02-17", @@ -5050,7 +5063,7 @@ } }, "overall_progress": { - "total_test_count": 1881, + "total_test_count": 1882, "all_tests_passing": true, "p0_completion": "3/3 (100%)", "p1_completion": "4/4 (100%)", diff --git a/src/companion/runtimeClient.test.ts b/src/companion/runtimeClient.test.ts index 67c40e5..68b9c47 100644 --- a/src/companion/runtimeClient.test.ts +++ b/src/companion/runtimeClient.test.ts @@ -886,6 +886,44 @@ describe('CompanionRuntimeClient', () => { }); }); + it('connect clears stale disconnect metadata from prior sessions', async () => { + class FakeWebSocket extends EventEmitter { + readyState: number = WebSocket.CONNECTING; + + constructor() { + super(); + queueMicrotask(() => { + this.readyState = WebSocket.OPEN; + this.emit('open'); + }); + } + + send(_payload: string, callback?: (error?: Error) => void): void { + callback?.(); + } + + close(code?: number, reason?: string): void { + this.readyState = WebSocket.CLOSED; + this.emit('close', code ?? 1000, Buffer.from(reason ?? '')); + } + } + + const client = new CompanionRuntimeClient({ + url: 'ws://127.0.0.1:1', + websocketFactory: () => new FakeWebSocket() as unknown as WebSocket, + }); + await client.connect(); + client.disconnect(4100, 'manual stop'); + + expect(client.lastDisconnectCode).toBe(4100); + expect(client.lastDisconnectReason).toBe('manual stop'); + + await client.connect(); + + expect(client.lastDisconnectCode).toBeUndefined(); + expect(client.lastDisconnectReason).toBeUndefined(); + }); + it('waitForIdle resolves immediately when no work is pending', 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 58b57d2..ba68ec7 100644 --- a/src/companion/runtimeClient.ts +++ b/src/companion/runtimeClient.ts @@ -418,6 +418,8 @@ export class CompanionRuntimeClient { cleanup(); settled = true; this.ws = ws; + this._lastDisconnectCode = undefined; + this._lastDisconnectReason = undefined; this.ws.on('message', (raw) => this.handleMessage(raw.toString())); this.ws.on('close', (code, reason) => { if (this.ws === ws) {