feat(companion): add waitForEvent runtime helper
This commit is contained in:
@@ -13,6 +13,7 @@ export type {
|
||||
CompanionRuntimeClientOptions,
|
||||
CompanionEventHandler,
|
||||
CompanionTypedEventHandler,
|
||||
CompanionEventPredicate,
|
||||
RegisterNodeInput,
|
||||
ListNodesInput,
|
||||
SetNodeStatusInput,
|
||||
|
||||
@@ -187,6 +187,48 @@ describe('CompanionRuntimeClient', () => {
|
||||
expect(streamHandler).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('waitForEvent resolves using optional predicate filter', async () => {
|
||||
const client = new CompanionRuntimeClient({
|
||||
url: 'ws://127.0.0.1:1',
|
||||
});
|
||||
|
||||
const awaited = client.waitForEvent<{ seq: number }>('agent.stream', {
|
||||
timeoutMs: 2000,
|
||||
predicate: (data) => data.seq === 2,
|
||||
});
|
||||
|
||||
(client as unknown as { handleMessage: (raw: string) => void }).handleMessage(
|
||||
JSON.stringify({
|
||||
id: 48,
|
||||
event: 'agent.stream',
|
||||
data: { seq: 1 },
|
||||
}),
|
||||
);
|
||||
(client as unknown as { handleMessage: (raw: string) => void }).handleMessage(
|
||||
JSON.stringify({
|
||||
id: 49,
|
||||
event: 'agent.stream',
|
||||
data: { seq: 2 },
|
||||
}),
|
||||
);
|
||||
|
||||
await expect(awaited).resolves.toEqual({ seq: 2 });
|
||||
});
|
||||
|
||||
it('waitForEvent rejects on timeout', async () => {
|
||||
vi.useFakeTimers();
|
||||
const client = new CompanionRuntimeClient({
|
||||
url: 'ws://127.0.0.1:1',
|
||||
});
|
||||
|
||||
const awaited = expect(
|
||||
client.waitForEvent('agent.stream', { timeoutMs: 100 }),
|
||||
).rejects.toThrow('Timed out waiting for event agent.stream');
|
||||
await vi.advanceTimersByTimeAsync(100);
|
||||
await awaited;
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
it('connects and performs node registration + capability discovery', async () => {
|
||||
if (!LISTEN_ALLOWED) {
|
||||
return;
|
||||
|
||||
@@ -43,6 +43,7 @@ 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 interface RegisterNodeInput {
|
||||
nodeId: string;
|
||||
@@ -365,6 +366,42 @@ export class CompanionRuntimeClient {
|
||||
});
|
||||
}
|
||||
|
||||
waitForEvent<TData = unknown>(
|
||||
eventName: string,
|
||||
options?: {
|
||||
timeoutMs?: number;
|
||||
predicate?: CompanionEventPredicate<TData>;
|
||||
},
|
||||
): Promise<TData> {
|
||||
const timeoutMs = options?.timeoutMs ?? this.requestTimeoutMs;
|
||||
const predicate = options?.predicate;
|
||||
|
||||
return new Promise<TData>((resolve, reject) => {
|
||||
let settled = false;
|
||||
const unsubscribe = this.subscribeEvent<TData>(eventName, (data) => {
|
||||
if (predicate && !predicate(data)) {
|
||||
return;
|
||||
}
|
||||
if (settled) {
|
||||
return;
|
||||
}
|
||||
settled = true;
|
||||
clearTimeout(timeout);
|
||||
unsubscribe();
|
||||
resolve(data);
|
||||
});
|
||||
|
||||
const timeout = setTimeout(() => {
|
||||
if (settled) {
|
||||
return;
|
||||
}
|
||||
settled = true;
|
||||
unsubscribe();
|
||||
reject(new Error(`Timed out waiting for event ${eventName}`));
|
||||
}, timeoutMs);
|
||||
});
|
||||
}
|
||||
|
||||
async call<T>(method: string, params?: Record<string, unknown>): Promise<T> {
|
||||
if (!this.connected) {
|
||||
if (!this.autoConnect) {
|
||||
|
||||
Reference in New Issue
Block a user