feat(companion): add platform stream passthrough helpers

This commit is contained in:
William Valentin
2026-02-16 19:23:50 -08:00
parent 1fb70ce0b1
commit 6018db0dd3
4 changed files with 80 additions and 0 deletions
+1
View File
@@ -1200,6 +1200,7 @@ Companion runtime helper:
- `createHeartbeatLoop()` convenience helper that returns a bound `CompanionHeartbeatLoop`
- optional `defaultSessionId` for canvas helper calls so `sessionId` can be omitted per call
- `dispose()` lifecycle helper for unified runtime teardown
- stream passthrough helpers (`subscribeAgentStream()`, `waitForAgentStream()`)
- `src/companion/heartbeatLoop.ts` provides `CompanionHeartbeatLoop` for periodic heartbeat scheduling (`publishHeartbeat`) with start/stop safety, optional interval jitter (`jitterRatio`) to spread load, `tickNow()` for manual sends, success/error hooks, failure observability (`failureCount`, `lastFailure`, `getState()`), and optional auto-stop after repeated failures.
## Canvas / A2UI Foundation
+13
View File
@@ -554,6 +554,19 @@
],
"test_status": "pnpm test:run src/companion/heartbeatLoop.test.ts src/companion/runtimeClient.test.ts src/companion/platformClients.test.ts src/companion/platformClients.integration.test.ts + pnpm typecheck passing"
},
"companion-platform-stream-helper-passthrough": {
"status": "completed",
"date": "2026-02-17",
"updated": "2026-02-17",
"summary": "Added platform-wrapper passthrough helpers for agent stream flows (`subscribeAgentStream`, `waitForAgentStream`) so companion apps can stay on platform clients instead of dropping to raw runtime APIs.",
"files_modified": [
"src/companion/platformClients.ts",
"src/companion/platformClients.test.ts",
"README.md",
"docs/plans/state.json"
],
"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"
},
"browser-tools-activation-clarity": {
"status": "completed",
"date": "2026-02-17",
+22
View File
@@ -25,6 +25,8 @@ function createRuntimeMock(): {
listCanvasArtifacts: ReturnType<typeof vi.fn>;
deleteCanvasArtifact: ReturnType<typeof vi.fn>;
clearCanvasArtifacts: ReturnType<typeof vi.fn>;
subscribeAgentStream: ReturnType<typeof vi.fn>;
waitForAgentStream: ReturnType<typeof vi.fn>;
} {
const connect = vi.fn(async () => undefined);
const disconnect = vi.fn(() => undefined);
@@ -50,6 +52,8 @@ function createRuntimeMock(): {
const listCanvasArtifacts = vi.fn(async () => ({ artifacts: [{ id: 'a1' }] }));
const deleteCanvasArtifact = vi.fn(async () => ({ deleted: true }));
const clearCanvasArtifacts = vi.fn(async () => ({ cleared: 1 }));
const subscribeAgentStream = vi.fn(() => () => undefined);
const waitForAgentStream = vi.fn(async () => ({ token: 'streamed' }));
const runtime = {
connect,
@@ -69,6 +73,8 @@ function createRuntimeMock(): {
listCanvasArtifacts,
deleteCanvasArtifact,
clearCanvasArtifacts,
subscribeAgentStream,
waitForAgentStream,
} as unknown as CompanionRuntimeClient;
return {
@@ -90,6 +96,8 @@ function createRuntimeMock(): {
listCanvasArtifacts,
deleteCanvasArtifact,
clearCanvasArtifacts,
subscribeAgentStream,
waitForAgentStream,
};
}
@@ -150,6 +158,20 @@ describe('platform companion clients', () => {
expect(mock.dispose).toHaveBeenCalledOnce();
});
it('platform stream helper methods forward to runtime client', async () => {
const mock = createRuntimeMock();
const client = new AndroidCompanionClient({ runtime: mock.runtime, nodeId: 'android-node' });
const streamHandler = vi.fn();
const unsubscribe = client.subscribeAgentStream(streamHandler);
const awaited = await client.waitForAgentStream<{ token: string }>({ timeoutMs: 500 });
expect(mock.subscribeAgentStream).toHaveBeenCalledWith(streamHandler);
expect(mock.waitForAgentStream).toHaveBeenCalledWith({ timeoutMs: 500 });
expect(awaited).toEqual({ token: 'streamed' });
unsubscribe();
});
it('macOS client forwards canvas methods to runtime client', async () => {
const mock = createRuntimeMock();
const client = new MacOSCompanionClient({ runtime: mock.runtime, nodeId: 'mac-node' });
+44
View File
@@ -4,6 +4,8 @@ import type {
CanvasGetResult,
CanvasListResult,
CanvasPutResult,
CompanionEventPredicate,
CompanionTypedEventHandler,
CompanionRuntimeClient,
DeleteCanvasArtifactInput,
GetCanvasArtifactInput,
@@ -217,6 +219,20 @@ export class MacOSCompanionClient {
return this.runtime.clearCanvasArtifacts(this.resolveSessionId(sessionId));
}
subscribeAgentStream<TData = unknown>(
handler: CompanionTypedEventHandler<TData>,
): () => void {
return this.runtime.subscribeAgentStream(handler);
}
waitForAgentStream<TData = unknown>(options?: {
timeoutMs?: number;
predicate?: CompanionEventPredicate<TData>;
signal?: AbortSignal;
}): Promise<TData> {
return this.runtime.waitForAgentStream(options);
}
private resolveSessionId(sessionId?: string): string {
const resolved = sessionId ?? this.defaultSessionId;
if (!resolved) {
@@ -368,6 +384,20 @@ export class IOSCompanionClient {
return this.runtime.clearCanvasArtifacts(this.resolveSessionId(sessionId));
}
subscribeAgentStream<TData = unknown>(
handler: CompanionTypedEventHandler<TData>,
): () => void {
return this.runtime.subscribeAgentStream(handler);
}
waitForAgentStream<TData = unknown>(options?: {
timeoutMs?: number;
predicate?: CompanionEventPredicate<TData>;
signal?: AbortSignal;
}): Promise<TData> {
return this.runtime.waitForAgentStream(options);
}
private resolveSessionId(sessionId?: string): string {
const resolved = sessionId ?? this.defaultSessionId;
if (!resolved) {
@@ -517,6 +547,20 @@ export class AndroidCompanionClient {
return this.runtime.clearCanvasArtifacts(this.resolveSessionId(sessionId));
}
subscribeAgentStream<TData = unknown>(
handler: CompanionTypedEventHandler<TData>,
): () => void {
return this.runtime.subscribeAgentStream(handler);
}
waitForAgentStream<TData = unknown>(options?: {
timeoutMs?: number;
predicate?: CompanionEventPredicate<TData>;
signal?: AbortSignal;
}): Promise<TData> {
return this.runtime.waitForAgentStream(options);
}
private resolveSessionId(sessionId?: string): string {
const resolved = sessionId ?? this.defaultSessionId;
if (!resolved) {