fix: don't fail if createBirpc is awaited (#14)

antfu · Feb 19, 2024 · 9bee728 · 9bee728
1 parent 9e68576
commit 9bee728
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 20 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -146,7 +146,7 @@ const defaultDeserialize = defaultSerialize
 const { clearTimeout, setTimeout } = globalThis
 const random = Math.random.bind(Math)
 
-export function createBirpc<RemoteFunctions = Record<string, never>, LocalFunctions = Record<string, never>>(
+export function createBirpc<RemoteFunctions = Record<string, never>, LocalFunctions extends object = Record<string, never>>(
   functions: LocalFunctions,
   options: BirpcOptions<RemoteFunctions>,
 ): BirpcReturn<RemoteFunctions, LocalFunctions> {
@@ -169,6 +169,10 @@ export function createBirpc<RemoteFunctions = Record<string, never>, LocalFuncti
       if (method === '$functions')
         return functions
 
+      // catch if "createBirpc" is returned from async function
+      if (method === 'then' && !eventNames.includes('then' as any) && !('then' in functions))
+        return undefined
+
       const sendEvent = (...args: any[]) => {
         post(serialize(<Request>{ m: method, a: args, t: 'q' }))
       }
@@ -263,7 +267,7 @@ export function cachedMap<T, R>(items: T[], fn: ((i: T) => R)): R[] {
   })
 }
 
-export function createBirpcGroup<RemoteFunctions = Record<string, never>, LocalFunctions = Record<string, never>>(
+export function createBirpcGroup<RemoteFunctions = Record<string, never>, LocalFunctions extends object = Record<string, never>>(
   functions: LocalFunctions,
   channels: ChannelOptions[] | (() => ChannelOptions[]),
   options: EventOptions<RemoteFunctions> = {},

diff --git a/test/index.test.ts b/test/index.test.ts
@@ -7,26 +7,31 @@ import * as Alice from './alice'
 type BobFunctions = typeof Bob
 type AliceFunctions = typeof Alice
 
-it('basic', async () => {
+function createChannel() {
   const channel = new MessageChannel()
+  return {
+    channel,
+    alice: createBirpc<BobFunctions, AliceFunctions>(
+      Alice,
+      {
+        // mark bob's `bump` as an event without response
+        eventNames: ['bump'],
+        post: data => channel.port2.postMessage(data),
+        on: data => channel.port2.on('message', data),
+      },
+    ),
+    bob: createBirpc<AliceFunctions, BobFunctions>(
+      Bob,
+      {
+        post: data => channel.port1.postMessage(data),
+        on: data => channel.port1.on('message', data),
+      },
+    ),
+  }
+}
 
-  const bob = createBirpc<AliceFunctions, BobFunctions>(
-    Bob,
-    {
-      post: data => channel.port1.postMessage(data),
-      on: data => channel.port1.on('message', data),
-    },
-  )
-
-  const alice = createBirpc<BobFunctions, AliceFunctions>(
-    Alice,
-    {
-      // mark bob's `bump` as an event without response
-      eventNames: ['bump'],
-      post: data => channel.port2.postMessage(data),
-      on: data => channel.port2.on('message', data),
-    },
-  )
+it('basic', async () => {
+  const { bob, alice } = createChannel()
 
   // RPCs
   expect(await bob.hello('Bob'))
@@ -41,3 +46,10 @@ it('basic', async () => {
   await new Promise(resolve => setTimeout(resolve, 1))
   expect(Bob.getCount()).toBe(1)
 })
+
+it('async', async () => {
+  const { bob, alice } = createChannel()
+
+  await alice
+  await bob
+})