feat(companion): add AbortSignal support for waitForEvent
This commit is contained in:
@@ -260,6 +260,19 @@ describe('CompanionRuntimeClient', () => {
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
it('waitForEvent supports AbortSignal cancellation', async () => {
|
||||
const client = new CompanionRuntimeClient({
|
||||
url: 'ws://127.0.0.1:1',
|
||||
});
|
||||
const controller = new AbortController();
|
||||
|
||||
const awaited = expect(
|
||||
client.waitForEvent('agent.stream', { signal: controller.signal, timeoutMs: 10_000 }),
|
||||
).rejects.toThrow('Aborted while waiting for event agent.stream');
|
||||
controller.abort();
|
||||
await awaited;
|
||||
});
|
||||
|
||||
it('connects and performs node registration + capability discovery', async () => {
|
||||
if (!LISTEN_ALLOWED) {
|
||||
return;
|
||||
|
||||
@@ -385,34 +385,54 @@ export class CompanionRuntimeClient {
|
||||
options?: {
|
||||
timeoutMs?: number;
|
||||
predicate?: CompanionEventPredicate<TData>;
|
||||
signal?: AbortSignal;
|
||||
},
|
||||
): Promise<TData> {
|
||||
const timeoutMs = options?.timeoutMs ?? this.requestTimeoutMs;
|
||||
const predicate = options?.predicate;
|
||||
const signal = options?.signal;
|
||||
|
||||
return new Promise<TData>((resolve, reject) => {
|
||||
let settled = false;
|
||||
const unsubscribe = this.subscribeEvent<TData>(eventName, (data) => {
|
||||
if (predicate && !predicate(data)) {
|
||||
return;
|
||||
}
|
||||
let abortCleanup: (() => void) | null = null;
|
||||
|
||||
const finish = (fn: () => void) => {
|
||||
if (settled) {
|
||||
return;
|
||||
}
|
||||
settled = true;
|
||||
clearTimeout(timeout);
|
||||
unsubscribe();
|
||||
resolve(data);
|
||||
if (abortCleanup) {
|
||||
abortCleanup();
|
||||
abortCleanup = null;
|
||||
}
|
||||
fn();
|
||||
};
|
||||
|
||||
const unsubscribe = this.subscribeEvent<TData>(eventName, (data) => {
|
||||
if (predicate && !predicate(data)) {
|
||||
return;
|
||||
}
|
||||
finish(() => resolve(data));
|
||||
});
|
||||
|
||||
const timeout = setTimeout(() => {
|
||||
if (settled) {
|
||||
return;
|
||||
}
|
||||
settled = true;
|
||||
unsubscribe();
|
||||
reject(new Error(`Timed out waiting for event ${eventName}`));
|
||||
finish(() => reject(new Error(`Timed out waiting for event ${eventName}`)));
|
||||
}, timeoutMs);
|
||||
|
||||
if (signal) {
|
||||
const onAbort = () => {
|
||||
finish(() => reject(new Error(`Aborted while waiting for event ${eventName}`)));
|
||||
};
|
||||
signal.addEventListener('abort', onAbort, { once: true });
|
||||
abortCleanup = () => {
|
||||
signal.removeEventListener('abort', onAbort);
|
||||
};
|
||||
if (signal.aborted) {
|
||||
onAbort();
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user