feat(companion): add connection snapshot helper
This commit is contained in:
@@ -15,6 +15,7 @@ export type {
|
||||
WaitForIdleOptions,
|
||||
PendingWorkSnapshot,
|
||||
EventSurfaceSnapshot,
|
||||
ConnectionSnapshot,
|
||||
CompanionEventHandler,
|
||||
CompanionTypedEventHandler,
|
||||
CompanionEventName,
|
||||
|
||||
@@ -37,6 +37,7 @@ function createRuntimeMock(): {
|
||||
waitForIdle: ReturnType<typeof vi.fn>;
|
||||
getPendingWorkSnapshot: ReturnType<typeof vi.fn>;
|
||||
getEventSurfaceSnapshot: ReturnType<typeof vi.fn>;
|
||||
getConnectionSnapshot: ReturnType<typeof vi.fn>;
|
||||
waitForAgentStream: ReturnType<typeof vi.fn>;
|
||||
waitForAgentTyping: ReturnType<typeof vi.fn>;
|
||||
waitForContextWarning: ReturnType<typeof vi.fn>;
|
||||
@@ -92,6 +93,14 @@ function createRuntimeMock(): {
|
||||
eventSubscriptionCount: 3,
|
||||
pendingEventWaitCount: 1,
|
||||
}));
|
||||
const getConnectionSnapshot = vi.fn(() => ({
|
||||
connected: true,
|
||||
eventSubscriptionCount: 3,
|
||||
pendingRequestCount: 2,
|
||||
pendingEventWaitCount: 1,
|
||||
hasPendingWork: true,
|
||||
idle: false,
|
||||
}));
|
||||
const waitForAgentStream = vi.fn(async () => ({ token: 'streamed' }));
|
||||
const waitForAgentTyping = vi.fn(async () => ({ active: true }));
|
||||
const waitForContextWarning = vi.fn(async () => ({ thresholdPct: 75, estimatedPct: 90 }));
|
||||
@@ -133,6 +142,7 @@ function createRuntimeMock(): {
|
||||
waitForIdle,
|
||||
getPendingWorkSnapshot,
|
||||
getEventSurfaceSnapshot,
|
||||
getConnectionSnapshot,
|
||||
waitForAgentStream,
|
||||
waitForAgentTyping,
|
||||
waitForContextWarning,
|
||||
@@ -188,6 +198,7 @@ function createRuntimeMock(): {
|
||||
waitForIdle,
|
||||
getPendingWorkSnapshot,
|
||||
getEventSurfaceSnapshot,
|
||||
getConnectionSnapshot,
|
||||
waitForAgentStream,
|
||||
waitForAgentTyping,
|
||||
waitForContextWarning,
|
||||
@@ -417,6 +428,23 @@ describe('platform companion clients', () => {
|
||||
});
|
||||
});
|
||||
|
||||
it('platform getConnectionSnapshot forwards to runtime client', async () => {
|
||||
const mock = createRuntimeMock();
|
||||
const client = new IOSCompanionClient({ runtime: mock.runtime, nodeId: 'ios-node' });
|
||||
|
||||
const snapshot = client.getConnectionSnapshot();
|
||||
|
||||
expect(mock.getConnectionSnapshot).toHaveBeenCalledOnce();
|
||||
expect(snapshot).toEqual({
|
||||
connected: true,
|
||||
eventSubscriptionCount: 3,
|
||||
pendingRequestCount: 2,
|
||||
pendingEventWaitCount: 1,
|
||||
hasPendingWork: true,
|
||||
idle: false,
|
||||
});
|
||||
});
|
||||
|
||||
it('macOS client forwards canvas methods to runtime client', async () => {
|
||||
const mock = createRuntimeMock();
|
||||
const client = new MacOSCompanionClient({ runtime: mock.runtime, nodeId: 'mac-node' });
|
||||
|
||||
@@ -2,6 +2,7 @@ import type {
|
||||
CompanionEventName,
|
||||
CompanionEventEnvelope,
|
||||
EventSurfaceSnapshot,
|
||||
ConnectionSnapshot,
|
||||
CompanionEventHandler,
|
||||
CanvasClearResult,
|
||||
CanvasDeleteResult,
|
||||
@@ -306,6 +307,10 @@ export class MacOSCompanionClient {
|
||||
return this.runtime.getEventSurfaceSnapshot();
|
||||
}
|
||||
|
||||
getConnectionSnapshot(): ConnectionSnapshot {
|
||||
return this.runtime.getConnectionSnapshot();
|
||||
}
|
||||
|
||||
waitForAnyEvent<TData = unknown>(
|
||||
eventNames: readonly (CompanionEventName | string)[],
|
||||
options?: {
|
||||
@@ -580,6 +585,10 @@ export class IOSCompanionClient {
|
||||
return this.runtime.getEventSurfaceSnapshot();
|
||||
}
|
||||
|
||||
getConnectionSnapshot(): ConnectionSnapshot {
|
||||
return this.runtime.getConnectionSnapshot();
|
||||
}
|
||||
|
||||
waitForAnyEvent<TData = unknown>(
|
||||
eventNames: readonly (CompanionEventName | string)[],
|
||||
options?: {
|
||||
@@ -852,6 +861,10 @@ export class AndroidCompanionClient {
|
||||
return this.runtime.getEventSurfaceSnapshot();
|
||||
}
|
||||
|
||||
getConnectionSnapshot(): ConnectionSnapshot {
|
||||
return this.runtime.getConnectionSnapshot();
|
||||
}
|
||||
|
||||
waitForAnyEvent<TData = unknown>(
|
||||
eventNames: readonly (CompanionEventName | string)[],
|
||||
options?: {
|
||||
|
||||
@@ -721,6 +721,33 @@ describe('CompanionRuntimeClient', () => {
|
||||
await pendingWait;
|
||||
});
|
||||
|
||||
it('returns connection snapshot', async () => {
|
||||
const client = new CompanionRuntimeClient({
|
||||
url: 'ws://127.0.0.1:1',
|
||||
});
|
||||
const pendingWait = client.waitForEvent('agent.stream', { timeoutMs: 10_000 }).catch(() => undefined);
|
||||
|
||||
expect(client.getConnectionSnapshot()).toEqual({
|
||||
connected: false,
|
||||
eventSubscriptionCount: 1,
|
||||
pendingRequestCount: 0,
|
||||
pendingEventWaitCount: 1,
|
||||
hasPendingWork: true,
|
||||
idle: false,
|
||||
});
|
||||
|
||||
client.clearEventSubscriptions();
|
||||
await pendingWait;
|
||||
expect(client.getConnectionSnapshot()).toEqual({
|
||||
connected: false,
|
||||
eventSubscriptionCount: 0,
|
||||
pendingRequestCount: 0,
|
||||
pendingEventWaitCount: 0,
|
||||
hasPendingWork: false,
|
||||
idle: true,
|
||||
});
|
||||
});
|
||||
|
||||
it('waitForIdle resolves immediately when no work is pending', async () => {
|
||||
const client = new CompanionRuntimeClient({
|
||||
url: 'ws://127.0.0.1:1',
|
||||
|
||||
@@ -59,6 +59,15 @@ export interface EventSurfaceSnapshot {
|
||||
pendingEventWaitCount: number;
|
||||
}
|
||||
|
||||
export interface ConnectionSnapshot {
|
||||
connected: boolean;
|
||||
eventSubscriptionCount: number;
|
||||
pendingRequestCount: number;
|
||||
pendingEventWaitCount: number;
|
||||
hasPendingWork: boolean;
|
||||
idle: boolean;
|
||||
}
|
||||
|
||||
export type CompanionEventHandler = (event: string, data: unknown) => void;
|
||||
export type CompanionTypedEventHandler<TData = unknown> = (data: TData) => void;
|
||||
export type CompanionEventPredicate<TData = unknown> = (data: TData) => boolean;
|
||||
@@ -352,6 +361,17 @@ export class CompanionRuntimeClient {
|
||||
};
|
||||
}
|
||||
|
||||
getConnectionSnapshot(): ConnectionSnapshot {
|
||||
return {
|
||||
connected: this.connected,
|
||||
eventSubscriptionCount: this.eventSubscriptionCount,
|
||||
pendingRequestCount: this.pendingRequestCount,
|
||||
pendingEventWaitCount: this.pendingEventWaitCount,
|
||||
hasPendingWork: this.hasPendingWork,
|
||||
idle: this.idle,
|
||||
};
|
||||
}
|
||||
|
||||
async connect(): Promise<void> {
|
||||
if (this.connected) {
|
||||
return;
|
||||
|
||||
Reference in New Issue
Block a user