feat(companion): add platform event teardown passthrough
This commit is contained in:
@@ -1200,7 +1200,7 @@ Companion runtime helper:
|
|||||||
- `createHeartbeatLoop()` convenience helper that returns a bound `CompanionHeartbeatLoop`
|
- `createHeartbeatLoop()` convenience helper that returns a bound `CompanionHeartbeatLoop`
|
||||||
- optional `defaultSessionId` for canvas helper calls so `sessionId` can be omitted per call
|
- optional `defaultSessionId` for canvas helper calls so `sessionId` can be omitted per call
|
||||||
- `dispose()` lifecycle helper for unified runtime teardown
|
- `dispose()` lifecycle helper for unified runtime teardown
|
||||||
- stream passthrough helpers (`subscribeEvents`, `subscribeAgentStream/Typing/ContextWarning`, `waitForAnyEvent`, `waitForAgentStream/Typing/ContextWarning`)
|
- stream passthrough helpers (`subscribeEvents`, `clearEventSubscriptions`, `subscribeAgentStream/Typing/ContextWarning`, `waitForAnyEvent`, `waitForAgentStream/Typing/ContextWarning`)
|
||||||
- `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.
|
- `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
|
## Canvas / A2UI Foundation
|
||||||
|
|||||||
@@ -620,6 +620,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"
|
"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-platform-event-subscription-teardown": {
|
||||||
|
"status": "completed",
|
||||||
|
"date": "2026-02-17",
|
||||||
|
"updated": "2026-02-17",
|
||||||
|
"summary": "Added `clearEventSubscriptions()` passthrough to platform clients so event handler teardown can be managed directly at the platform wrapper layer.",
|
||||||
|
"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": {
|
"browser-tools-activation-clarity": {
|
||||||
"status": "completed",
|
"status": "completed",
|
||||||
"date": "2026-02-17",
|
"date": "2026-02-17",
|
||||||
|
|||||||
@@ -29,6 +29,7 @@ function createRuntimeMock(): {
|
|||||||
subscribeAgentTyping: ReturnType<typeof vi.fn>;
|
subscribeAgentTyping: ReturnType<typeof vi.fn>;
|
||||||
subscribeContextWarning: ReturnType<typeof vi.fn>;
|
subscribeContextWarning: ReturnType<typeof vi.fn>;
|
||||||
subscribeEvents: ReturnType<typeof vi.fn>;
|
subscribeEvents: ReturnType<typeof vi.fn>;
|
||||||
|
clearEventSubscriptions: ReturnType<typeof vi.fn>;
|
||||||
waitForAgentStream: ReturnType<typeof vi.fn>;
|
waitForAgentStream: ReturnType<typeof vi.fn>;
|
||||||
waitForAgentTyping: ReturnType<typeof vi.fn>;
|
waitForAgentTyping: ReturnType<typeof vi.fn>;
|
||||||
waitForContextWarning: ReturnType<typeof vi.fn>;
|
waitForContextWarning: ReturnType<typeof vi.fn>;
|
||||||
@@ -62,6 +63,7 @@ function createRuntimeMock(): {
|
|||||||
const subscribeAgentTyping = vi.fn(() => () => undefined);
|
const subscribeAgentTyping = vi.fn(() => () => undefined);
|
||||||
const subscribeContextWarning = vi.fn(() => () => undefined);
|
const subscribeContextWarning = vi.fn(() => () => undefined);
|
||||||
const subscribeEvents = vi.fn(() => () => undefined);
|
const subscribeEvents = vi.fn(() => () => undefined);
|
||||||
|
const clearEventSubscriptions = vi.fn(() => undefined);
|
||||||
const waitForAgentStream = vi.fn(async () => ({ token: 'streamed' }));
|
const waitForAgentStream = vi.fn(async () => ({ token: 'streamed' }));
|
||||||
const waitForAgentTyping = vi.fn(async () => ({ active: true }));
|
const waitForAgentTyping = vi.fn(async () => ({ active: true }));
|
||||||
const waitForContextWarning = vi.fn(async () => ({ thresholdPct: 75, estimatedPct: 90 }));
|
const waitForContextWarning = vi.fn(async () => ({ thresholdPct: 75, estimatedPct: 90 }));
|
||||||
@@ -89,6 +91,7 @@ function createRuntimeMock(): {
|
|||||||
subscribeAgentTyping,
|
subscribeAgentTyping,
|
||||||
subscribeContextWarning,
|
subscribeContextWarning,
|
||||||
subscribeEvents,
|
subscribeEvents,
|
||||||
|
clearEventSubscriptions,
|
||||||
waitForAgentStream,
|
waitForAgentStream,
|
||||||
waitForAgentTyping,
|
waitForAgentTyping,
|
||||||
waitForContextWarning,
|
waitForContextWarning,
|
||||||
@@ -118,6 +121,7 @@ function createRuntimeMock(): {
|
|||||||
subscribeAgentTyping,
|
subscribeAgentTyping,
|
||||||
subscribeContextWarning,
|
subscribeContextWarning,
|
||||||
subscribeEvents,
|
subscribeEvents,
|
||||||
|
clearEventSubscriptions,
|
||||||
waitForAgentStream,
|
waitForAgentStream,
|
||||||
waitForAgentTyping,
|
waitForAgentTyping,
|
||||||
waitForContextWarning,
|
waitForContextWarning,
|
||||||
@@ -217,6 +221,15 @@ describe('platform companion clients', () => {
|
|||||||
unsubscribeEvents();
|
unsubscribeEvents();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('platform clearEventSubscriptions forwards to runtime client', async () => {
|
||||||
|
const mock = createRuntimeMock();
|
||||||
|
const client = new IOSCompanionClient({ runtime: mock.runtime, nodeId: 'ios-node' });
|
||||||
|
|
||||||
|
client.clearEventSubscriptions();
|
||||||
|
|
||||||
|
expect(mock.clearEventSubscriptions).toHaveBeenCalledOnce();
|
||||||
|
});
|
||||||
|
|
||||||
it('macOS client forwards canvas methods to runtime client', async () => {
|
it('macOS client forwards canvas methods to runtime client', async () => {
|
||||||
const mock = createRuntimeMock();
|
const mock = createRuntimeMock();
|
||||||
const client = new MacOSCompanionClient({ runtime: mock.runtime, nodeId: 'mac-node' });
|
const client = new MacOSCompanionClient({ runtime: mock.runtime, nodeId: 'mac-node' });
|
||||||
|
|||||||
@@ -251,6 +251,10 @@ export class MacOSCompanionClient {
|
|||||||
return this.runtime.subscribeEvents(handler);
|
return this.runtime.subscribeEvents(handler);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
clearEventSubscriptions(): void {
|
||||||
|
this.runtime.clearEventSubscriptions();
|
||||||
|
}
|
||||||
|
|
||||||
waitForAnyEvent<TData = unknown>(
|
waitForAnyEvent<TData = unknown>(
|
||||||
eventNames: readonly string[],
|
eventNames: readonly string[],
|
||||||
options?: {
|
options?: {
|
||||||
@@ -459,6 +463,10 @@ export class IOSCompanionClient {
|
|||||||
return this.runtime.subscribeEvents(handler);
|
return this.runtime.subscribeEvents(handler);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
clearEventSubscriptions(): void {
|
||||||
|
this.runtime.clearEventSubscriptions();
|
||||||
|
}
|
||||||
|
|
||||||
waitForAnyEvent<TData = unknown>(
|
waitForAnyEvent<TData = unknown>(
|
||||||
eventNames: readonly string[],
|
eventNames: readonly string[],
|
||||||
options?: {
|
options?: {
|
||||||
@@ -665,6 +673,10 @@ export class AndroidCompanionClient {
|
|||||||
return this.runtime.subscribeEvents(handler);
|
return this.runtime.subscribeEvents(handler);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
clearEventSubscriptions(): void {
|
||||||
|
this.runtime.clearEventSubscriptions();
|
||||||
|
}
|
||||||
|
|
||||||
waitForAnyEvent<TData = unknown>(
|
waitForAnyEvent<TData = unknown>(
|
||||||
eventNames: readonly string[],
|
eventNames: readonly string[],
|
||||||
options?: {
|
options?: {
|
||||||
|
|||||||
Reference in New Issue
Block a user