From fd59d88c0c852fbf9864dddbe9e3382cde11498a Mon Sep 17 00:00:00 2001 From: William Valentin Date: Mon, 16 Feb 2026 18:49:20 -0800 Subject: [PATCH] feat(companion): add clearEventSubscriptions helper --- README.md | 2 +- docs/plans/state.json | 13 +++++++++++++ src/companion/runtimeClient.test.ts | 22 ++++++++++++++++++++++ src/companion/runtimeClient.ts | 4 ++++ 4 files changed, 40 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 60bf41a..9edb5db 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`) and event helpers (`subscribeEvents()`, `subscribeEvent()`, `waitForEvent()`). +- `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`) and event helpers (`subscribeEvents()`, `subscribeEvent()`, `waitForEvent()`, `clearEventSubscriptions()`). - `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 2b40722..7c7dfc8 100644 --- a/docs/plans/state.json +++ b/docs/plans/state.json @@ -395,6 +395,19 @@ ], "test_status": "pnpm test:run src/companion/platformClients.test.ts src/companion/heartbeatLoop.test.ts src/companion/runtimeClient.test.ts src/companion/platformClients.integration.test.ts + pnpm typecheck passing" }, + "companion-runtime-clear-event-subscriptions": { + "status": "completed", + "date": "2026-02-17", + "updated": "2026-02-17", + "summary": "Added `clearEventSubscriptions()` to `CompanionRuntimeClient` for explicit teardown of all registered event handlers, with test coverage for generic + filtered subscriptions.", + "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", diff --git a/src/companion/runtimeClient.test.ts b/src/companion/runtimeClient.test.ts index 2fad71c..416bdc0 100644 --- a/src/companion/runtimeClient.test.ts +++ b/src/companion/runtimeClient.test.ts @@ -196,6 +196,28 @@ describe('CompanionRuntimeClient', () => { expect(streamHandler).toHaveBeenCalledTimes(1); }); + it('clears all event subscriptions', () => { + const client = new CompanionRuntimeClient({ + url: 'ws://127.0.0.1:1', + }); + const handlerA = vi.fn(); + const handlerB = vi.fn(); + client.subscribeEvents(handlerA); + client.subscribeEvent('agent.stream', handlerB); + client.clearEventSubscriptions(); + + (client as unknown as { handleMessage: (raw: string) => void }).handleMessage( + JSON.stringify({ + id: 50, + event: 'agent.stream', + data: { token: 'cleared' }, + }), + ); + + expect(handlerA).not.toHaveBeenCalled(); + expect(handlerB).not.toHaveBeenCalled(); + }); + it('waitForEvent resolves using optional predicate filter', 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 53c304e..e8ffd88 100644 --- a/src/companion/runtimeClient.ts +++ b/src/companion/runtimeClient.ts @@ -364,6 +364,10 @@ export class CompanionRuntimeClient { }; } + clearEventSubscriptions(): void { + this.eventHandlers.clear(); + } + subscribeEvent( eventName: string, handler: CompanionTypedEventHandler,