feat: add $rejectPendingCalls (#26)

AriPerkkio · web-flow · commit 5cc1df989752 · 2025-07-14T18:42:27.000+02:00
diff --git a/src/index.ts b/src/index.ts
@@ -109,7 +109,14 @@ export interface BirpcGroupFn<T> {
 
 export type BirpcReturn<RemoteFunctions, LocalFunctions = Record<string, never>> = {
   [K in keyof RemoteFunctions]: BirpcFn<RemoteFunctions[K]>
-} & { $functions: LocalFunctions, $close: (error?: Error) => void, $closed: boolean }
+} & {
+  $functions: LocalFunctions
+  $close: (error?: Error) => void
+  $closed: boolean
+  $rejectPendingCalls: (handler?: PendingCallHandler) => Promise<void>[]
+}
+
+type PendingCallHandler = (options: Pick<PromiseEntry, 'method' | 'reject'>) => void | Promise<void>
 
 export type BirpcGroupReturn<RemoteFunctions> = {
   [K in keyof RemoteFunctions]: BirpcGroupFn<RemoteFunctions[K]>
@@ -122,6 +129,13 @@ export interface BirpcGroup<RemoteFunctions, LocalFunctions = Record<string, nev
   updateChannels: (fn?: ((channels: ChannelOptions[]) => void)) => BirpcReturn<RemoteFunctions, LocalFunctions>[]
 }
 
+interface PromiseEntry {
+  resolve: (arg: any) => void
+  reject: (error: any) => void
+  method: string
+  timeoutId?: ReturnType<typeof setTimeout>
+}
+
 const TYPE_REQUEST = 'q' as const
 const TYPE_RESPONSE = 's' as const
 
@@ -192,12 +206,7 @@ export function createBirpc<RemoteFunctions = Record<string, never>, LocalFuncti
     timeout = DEFAULT_TIMEOUT,
   } = options
 
-  const rpcPromiseMap = new Map<string, {
-    resolve: (arg: any) => void
-    reject: (error: any) => void
-    method: string
-    timeoutId?: ReturnType<typeof setTimeout>
-  }>()
+  const rpcPromiseMap = new Map<string, PromiseEntry>()
 
   let _promise: Promise<any> | any
   let closed = false
@@ -210,6 +219,10 @@ export function createBirpc<RemoteFunctions = Record<string, never>, LocalFuncti
       if (method === '$close')
         return close
 
+      if (method === '$rejectPendingCalls') {
+        return rejectPendingCalls
+      }
+
       if (method === '$closed')
         return closed
 
@@ -285,6 +298,22 @@ export function createBirpc<RemoteFunctions = Record<string, never>, LocalFuncti
     off(onMessage)
   }
 
+  function rejectPendingCalls(handler?: PendingCallHandler) {
+    const entries = Array.from(rpcPromiseMap.values())
+
+    const handlerResults = entries.map(({ method, reject }) => {
+      if (!handler) {
+        return reject(new Error(`[birpc]: rejected pending call "${method}".`))
+      }
+
+      return handler({ method, reject })
+    })
+
+    rpcPromiseMap.clear()
+
+    return handlerResults
+  }
+
   async function onMessage(data: any, ...extra: any[]) {
     let msg: RPCMessage
 
diff --git a/test/reject-pending-calls.test.ts b/test/reject-pending-calls.test.ts
@@ -0,0 +1,77 @@
+import { expect, it } from 'vitest'
+import { createBirpc } from '../src'
+
+it('rejects pending calls', async () => {
+  const rpc = createBirpc<{ first: () => Promise<void>, second: () => Promise<void> }>({}, {
+    on() {},
+    post() {},
+  })
+
+  const promises = [
+    rpc.first()
+      .then(() => expect.fail('first() should not resolve'))
+      .catch(error => error),
+
+    rpc.second()
+      .then(() => expect.fail('second() should not resolve'))
+      .catch(error => error),
+  ]
+
+  const rejections = rpc.$rejectPendingCalls()
+  expect(rejections).toHaveLength(2)
+
+  const errors = await Promise.all(promises)
+  expect(errors).toHaveLength(2)
+
+  expect.soft(errors[0].message).toBe('[birpc]: rejected pending call "first".')
+  expect.soft(errors[1].message).toBe('[birpc]: rejected pending call "second".')
+})
+
+it('rejects pending calls with custom handler', async () => {
+  const rpc = createBirpc<{ first: () => Promise<void>, second: () => Promise<void> }>({}, {
+    on() {},
+    post() {},
+  })
+
+  const promises = [
+    rpc.first()
+      .then(() => expect.fail('first() should not resolve'))
+      .catch(error => error),
+
+    rpc.second()
+      .then(() => expect.fail('second() should not resolve'))
+      .catch(error => error),
+  ]
+
+  const rejections = rpc.$rejectPendingCalls(({ method, reject }) =>
+    reject(new Error(`Rejected call. Method: "${method}".`)),
+  )
+  expect(rejections).toHaveLength(2)
+
+  const errors = await Promise.all(promises)
+  expect(errors).toHaveLength(2)
+
+  expect.soft(errors[0].message).toBe('Rejected call. Method: "first".')
+  expect.soft(errors[1].message).toBe('Rejected call. Method: "second".')
+})
+
+it('rejected calls are cleared from rpc', async () => {
+  const rpc = createBirpc<{ stuck: () => Promise<void> }>({}, {
+    on() {},
+    post() {},
+  })
+
+  rpc.stuck()
+    .then(() => expect.fail('stuck() should not resolve'))
+    .catch(() => undefined)
+
+  {
+    const rejections = rpc.$rejectPendingCalls(({ reject }) => reject(new Error('Rejected')))
+    expect(rejections).toHaveLength(1)
+  }
+
+  {
+    const rejections = rpc.$rejectPendingCalls(({ reject }) => reject(new Error('Rejected')))
+    expect(rejections).toHaveLength(0)
+  }
+})
