From d3e571b728ae09773be3cc620e9e0aef9e3fb456 Mon Sep 17 00:00:00 2001 From: William Valentin Date: Mon, 16 Feb 2026 19:32:25 -0800 Subject: [PATCH] feat(companion): expose runtime event subscription count --- README.md | 2 +- docs/plans/state.json | 13 +++++++++++++ src/companion/runtimeClient.test.ts | 3 +++ src/companion/runtimeClient.ts | 4 ++++ 4 files changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a32aca4..658607c 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()`) and event helpers (`subscribeEvents()`, `subscribeEvent()`, `subscribeAgentStream()`, `subscribeAgentTyping()`, `subscribeContextWarning()`, `waitForEvent()` with timeout/predicate/abort support and deterministic teardown cancellation, `waitForAnyEvent()`, `waitForAgentStream()`, `waitForAgentTyping()`, `waitForContextWarning()`, `clearEventSubscriptions()`, `listKnownEventNames()`). +- `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()`) and event helpers (`subscribeEvents()`, `subscribeEvent()`, `subscribeAgentStream()`, `subscribeAgentTyping()`, `subscribeContextWarning()`, `waitForEvent()` with timeout/predicate/abort support and deterministic teardown cancellation, `waitForAnyEvent()`, `waitForAgentStream()`, `waitForAgentTyping()`, `waitForContextWarning()`, `clearEventSubscriptions()`, `listKnownEventNames()`, `eventSubscriptionCount`). - `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 75ddeb4..c23aa0c 100644 --- a/docs/plans/state.json +++ b/docs/plans/state.json @@ -660,6 +660,19 @@ ], "test_status": "pnpm test:run src/companion/platformClients.test.ts src/companion/runtimeClient.test.ts src/companion/heartbeatLoop.test.ts src/companion/platformClients.integration.test.ts + pnpm typecheck passing" }, + "companion-runtime-event-subscription-count": { + "status": "completed", + "date": "2026-02-17", + "updated": "2026-02-17", + "summary": "Added `eventSubscriptionCount` on `CompanionRuntimeClient` to expose active event-listener cardinality for runtime observability and debugging.", + "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/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 44db720..bbac87f 100644 --- a/src/companion/runtimeClient.test.ts +++ b/src/companion/runtimeClient.test.ts @@ -110,7 +110,9 @@ describe('CompanionRuntimeClient', () => { url: 'ws://127.0.0.1:1', }); const handler = vi.fn(); + expect(client.eventSubscriptionCount).toBe(0); const unsubscribe = client.subscribeEvents(handler); + expect(client.eventSubscriptionCount).toBe(1); (client as unknown as { handleMessage: (raw: string) => void }).handleMessage( JSON.stringify({ @@ -133,6 +135,7 @@ describe('CompanionRuntimeClient', () => { ); expect(handler).toHaveBeenCalledTimes(1); + expect(client.eventSubscriptionCount).toBe(0); }); it('isolates subscriber callback failures', () => { diff --git a/src/companion/runtimeClient.ts b/src/companion/runtimeClient.ts index 0ce245c..349d53e 100644 --- a/src/companion/runtimeClient.ts +++ b/src/companion/runtimeClient.ts @@ -298,6 +298,10 @@ export class CompanionRuntimeClient { return this.ws?.readyState === WebSocket.OPEN; } + get eventSubscriptionCount(): number { + return this.eventHandlers.size; + } + async connect(): Promise { if (this.connected) { return;