feat(companion): add waitForAnyEvent runtime helper

This commit is contained in:
William Valentin
2026-02-16 19:27:25 -08:00
parent f7c6947d22
commit 717e5d60e5
5 changed files with 156 additions and 1 deletions
+1 -1
View File
@@ -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, `waitForAgentStream()`, `waitForAgentTyping()`, `waitForContextWarning()`, `clearEventSubscriptions()`).
- `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()`).
- `src/companion/platformClients.ts` provides platform-focused wrappers:
- `MacOSCompanionClient` (`platform: "macos"`, APNs push registration)
- `IOSCompanionClient` (`platform: "ios"`, APNs push registration)
+14
View File
@@ -593,6 +593,20 @@
],
"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-any-event-helper": {
"status": "completed",
"date": "2026-02-17",
"updated": "2026-02-17",
"summary": "Added `waitForAnyEvent()` on `CompanionRuntimeClient` to await the first matching event from a set of event names with timeout/predicate/abort support and typed event envelopes.",
"files_modified": [
"src/companion/runtimeClient.ts",
"src/companion/runtimeClient.test.ts",
"src/companion/index.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",
+1
View File
@@ -15,6 +15,7 @@ export type {
CompanionEventHandler,
CompanionTypedEventHandler,
CompanionEventPredicate,
CompanionEventEnvelope,
RegisterNodeInput,
ListNodesInput,
SetNodeStatusInput,
+66
View File
@@ -416,6 +416,72 @@ describe('CompanionRuntimeClient', () => {
await expect(awaited).resolves.toEqual({ thresholdPct: 75, estimatedPct: 88 });
});
it('waitForAnyEvent resolves with event envelope for first matching event', async () => {
const client = new CompanionRuntimeClient({
url: 'ws://127.0.0.1:1',
});
const awaited = client.waitForAnyEvent<{ active?: boolean; token?: string }>(
['agent.typing', 'agent.stream'],
{ timeoutMs: 2000 },
);
(client as unknown as { handleMessage: (raw: string) => void }).handleMessage(
JSON.stringify({
id: 58,
event: 'agent.typing',
data: { active: true },
}),
);
await expect(awaited).resolves.toEqual({
event: 'agent.typing',
data: { active: true },
});
});
it('waitForAnyEvent supports per-event predicate filtering', async () => {
const client = new CompanionRuntimeClient({
url: 'ws://127.0.0.1:1',
});
const awaited = client.waitForAnyEvent<{ token?: string }>(
['agent.stream'],
{
timeoutMs: 2000,
predicate: (_event, data) => data.token === 'accept',
},
);
(client as unknown as { handleMessage: (raw: string) => void }).handleMessage(
JSON.stringify({
id: 59,
event: 'agent.stream',
data: { token: 'skip' },
}),
);
(client as unknown as { handleMessage: (raw: string) => void }).handleMessage(
JSON.stringify({
id: 60,
event: 'agent.stream',
data: { token: 'accept' },
}),
);
await expect(awaited).resolves.toEqual({
event: 'agent.stream',
data: { token: 'accept' },
});
});
it('waitForAnyEvent validates input event list', () => {
const client = new CompanionRuntimeClient({
url: 'ws://127.0.0.1:1',
});
expect(() => client.waitForAnyEvent([])).toThrow(
'eventNames must contain at least one event name',
);
});
it('connects and performs node registration + capability discovery', async () => {
if (!LISTEN_ALLOWED) {
return;
+74
View File
@@ -44,6 +44,10 @@ export interface CompanionRuntimeClientOptions {
export type CompanionEventHandler = (event: string, data: unknown) => void;
export type CompanionTypedEventHandler<TData = unknown> = (data: TData) => void;
export type CompanionEventPredicate<TData = unknown> = (data: TData) => boolean;
export type CompanionEventEnvelope<TData = unknown> = {
event: string;
data: TData;
};
export const COMPANION_EVENT_NAMES = {
agentStream: 'agent.stream',
@@ -475,6 +479,76 @@ export class CompanionRuntimeClient {
});
}
waitForAnyEvent<TData = unknown>(
eventNames: readonly string[],
options?: {
timeoutMs?: number;
predicate?: (event: string, data: TData) => boolean;
signal?: AbortSignal;
},
): Promise<CompanionEventEnvelope<TData>> {
if (eventNames.length === 0) {
throw new Error('eventNames must contain at least one event name');
}
const eventNameSet = new Set(eventNames);
const timeoutMs = options?.timeoutMs ?? this.requestTimeoutMs;
const predicate = options?.predicate;
const signal = options?.signal;
return new Promise<CompanionEventEnvelope<TData>>((resolve, reject) => {
let settled = false;
let abortCleanup: (() => void) | null = null;
const finish = (fn: () => void) => {
if (settled) {
return;
}
settled = true;
clearTimeout(timeout);
unsubscribe();
if (abortCleanup) {
abortCleanup();
abortCleanup = null;
}
this.pendingEventWaits.delete(cancelWait);
fn();
};
const cancelWait = (error: Error) => {
finish(() => reject(error));
};
this.pendingEventWaits.add(cancelWait);
const unsubscribe = this.subscribeEvents((event, data) => {
if (!eventNameSet.has(event)) {
return;
}
const castData = data as TData;
if (predicate && !predicate(event, castData)) {
return;
}
finish(() => resolve({ event, data: castData }));
});
const timeout = setTimeout(() => {
cancelWait(new Error(`Timed out waiting for any event in [${eventNames.join(', ')}]`));
}, timeoutMs);
if (signal) {
const onAbort = () => {
cancelWait(new Error(`Aborted while waiting for events [${eventNames.join(', ')}]`));
};
signal.addEventListener('abort', onAbort, { once: true });
abortCleanup = () => {
signal.removeEventListener('abort', onAbort);
};
if (signal.aborted) {
onAbort();
}
}
});
}
waitForAgentStream<TData = unknown>(options?: {
timeoutMs?: number;
predicate?: CompanionEventPredicate<TData>;