WIP: Explore runSaga

.changeset/blue-games-live.md

@@ -0,0 +1,5 @@
+---
+'@signalwire/core': patch
+---
+
+Base event emitter for PubSub and Chat APIs

.changeset/dry-hairs-rhyme.md

@@ -0,0 +1,5 @@
+---
+'@signalwire/realtime-api': patch
+---
+
+Base event emitter for Messaging API

.changeset/rude-horses-lick.md

@@ -0,0 +1,6 @@
+---
+'@signalwire/realtime-api': patch
+'@signalwire/core': patch
+---
+
+Event emitter for each instance of a component

.changeset/serious-poems-wink.md

@@ -0,0 +1,5 @@
+---
+'@signalwire/realtime-api': patch
+---
+
+Remove emitter transform for Voice Call APIs

.changeset/ten-geckos-design.md

@@ -0,0 +1,6 @@
+---
+'@signalwire/realtime-api': patch
+'@signalwire/core': patch
+---
+
+Event emitter for each Call instance

.github/workflows/main.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches: [main]
   pull_request:
-    branches: [main]
+    branches: [main, dev]
   workflow_dispatch:
 
 concurrency:

internal/e2e-js/tests/chat.spec.ts

@@ -23,44 +23,49 @@ test.describe('Chat', () => {
       },
     })
 
-    const { message: chatMessage, allowedChannels }: any = await page.evaluate(
-      (options) => {
-        return new Promise(async (resolve) => {
-          try {
-            // @ts-expect-error
-            const Chat = window._SWJS.Chat
-            const client = new Chat.Client({
-              host: options.RELAY_HOST,
-              token: options.API_TOKEN,
-            })
-            const allowedChannels = await client.getAllowedChannels()
-            // .subscribe should be after .on but i left here for test.
-            await client.subscribe([options.channel])
-            client.on('message', (message: any) => {
-              resolve({ allowedChannels, message })
-            })
+    const { msgContent, msgChannel, allowedChannels }: any =
+      await page.evaluate(
+        (options) => {
+          return new Promise(async (resolve) => {
+            try {
+              // @ts-expect-error
+              const Chat = window._SWJS.Chat
+              const client = new Chat.Client({
+                host: options.RELAY_HOST,
+                token: options.API_TOKEN,
+              })
+              const allowedChannels = await client.getAllowedChannels()
+              // .subscribe should be after .on but i left here for test.
+              await client.subscribe([options.channel])
+              client.on('message', (message: any) => {
+                resolve({
+                  allowedChannels,
+                  msgContent: message.content,
+                  msgChannel: message.channel,
+                })
+              })
 
-            await client.publish({
-              channel: options.channel,
-              content: options.messageContent,
-            })
-          } catch (error) {
-            console.log('Chat Error', error)
-          }
-        })
-      },
-      {
-        RELAY_HOST: process.env.RELAY_HOST,
-        API_TOKEN: crt,
-        channel,
-        messageContent,
-      }
-    )
+              await client.publish({
+                channel: options.channel,
+                content: options.messageContent,
+              })
+            } catch (error) {
+              console.log('Chat Error', error)
+            }
+          })
+        },
+        {
+          RELAY_HOST: process.env.RELAY_HOST,
+          API_TOKEN: crt,
+          channel,
+          messageContent,
+        }
+      )
     expect(allowedChannels).toStrictEqual({
       'js-e2e': { read: true, write: true },
     })
-    expect(chatMessage.content).toBe(messageContent)
-    expect(chatMessage.channel).toBe(channel)
+    expect(msgContent).toBe(messageContent)
+    expect(msgChannel).toBe(channel)
   })
 
   test('should expose disconnect()', async ({ page }) => {

internal/e2e-js/tests/pubSub.spec.ts

@@ -23,44 +23,49 @@ test.describe('PubSub', () => {
       },
     })
 
-    const { message: chatMessage, allowedChannels }: any = await page.evaluate(
-      (options) => {
-        return new Promise(async (resolve) => {
-          try {
-            // @ts-expect-error
-            const PubSub = window._SWJS.PubSub
-            const pubSubClient = new PubSub.Client({
-              host: options.RELAY_HOST,
-              token: options.API_TOKEN,
-            })
-            const allowedChannels = await pubSubClient.getAllowedChannels()
-            // .subscribe should be after .on but i left here for test.
-            await pubSubClient.subscribe([options.channel])
-            pubSubClient.on('message', (message: any) => {
-              resolve({ allowedChannels, message })
-            })
+    const { msgContent, msgChannel, allowedChannels }: any =
+      await page.evaluate(
+        (options) => {
+          return new Promise(async (resolve) => {
+            try {
+              // @ts-expect-error
+              const PubSub = window._SWJS.PubSub
+              const pubSubClient = new PubSub.Client({
+                host: options.RELAY_HOST,
+                token: options.API_TOKEN,
+              })
+              const allowedChannels = await pubSubClient.getAllowedChannels()
+              // .subscribe should be after .on but i left here for test.
+              await pubSubClient.subscribe([options.channel])
+              pubSubClient.on('message', (message: any) => {
+                resolve({
+                  allowedChannels,
+                  msgContent: message.content,
+                  msgChannel: message.channel,
+                })
+              })
 
-            await pubSubClient.publish({
-              channel: options.channel,
-              content: options.messageContent,
-            })
-          } catch (error) {
-            console.log('PubSub Error', error)
-          }
-        })
-      },
-      {
-        RELAY_HOST: process.env.RELAY_HOST,
-        API_TOKEN: crt,
-        channel,
-        messageContent,
-      }
-    )
+              await pubSubClient.publish({
+                channel: options.channel,
+                content: options.messageContent,
+              })
+            } catch (error) {
+              console.log('PubSub Error', error)
+            }
+          })
+        },
+        {
+          RELAY_HOST: process.env.RELAY_HOST,
+          API_TOKEN: crt,
+          channel,
+          messageContent,
+        }
+      )
     expect(allowedChannels).toStrictEqual({
       'js-e2e': { read: true, write: true },
     })
-    expect(chatMessage.content).toBe(messageContent)
-    expect(chatMessage.channel).toBe(channel)
+    expect(msgContent).toBe(messageContent)
+    expect(msgChannel).toBe(channel)
   })
 
   test('should expose disconnect()', async ({ page }) => {

internal/e2e-realtime-api/src/voicePlayback.test.ts

@@ -29,25 +29,35 @@ const handler = () => {
           'Inbound - Call answered gets the same instance'
         )
 
-        // Play an invalid audio
-        const handle = await call.playAudio({
-          url: 'https://cdn.fake.com/default-music/fake.mp3',
-        })
-
-        tap.equal(
-          call.id,
-          handle.callId,
-          'Inbound - playback returns the same instance'
-        )
+        try {
+          // Play an invalid audio
+          const handle = call.playAudio({
+            url: 'https://cdn.fake.com/default-music/fake.mp3',
+          })
 
-        const waitForPlaybackFailed = new Promise((resolve) => {
-          call.on('playback.failed', (playback) => {
-            tap.equal(playback.state, 'error', 'Inbound - playback has failed')
-            resolve(true)
+          const waitForPlaybackFailed = new Promise((resolve) => {
+            call.on('playback.failed', (playback) => {
+              tap.equal(
+                playback.state,
+                'error',
+                'Inbound - playback has failed'
+              )
+              resolve(true)
+            })
           })
-        })
-        // Wait for the inbound audio to failed
-        await waitForPlaybackFailed
+          // Wait for the inbound audio to failed
+          await waitForPlaybackFailed
+
+          // Resolve late so that we attach `playback.failed` and wait for it
+          await handle
+        } catch (error) {
+          console.log('Inbound - invalid playback error')
+          tap.equal(
+            call.id,
+            error.callId,
+            'Inbound - playback returns the same instance'
+          )
+        }
 
         // Callee hangs up a call
         await call.hangup()
@@ -65,16 +75,10 @@ const handler = () => {
     tap.ok(call.id, 'Outbound - Call resolved')
 
     // Play an audio
-    const handle = await call.playAudio({
+    const handle = call.playAudio({
       url: 'https://cdn.signalwire.com/default-music/welcome.mp3',
     })
 
-    tap.equal(
-      call.id,
-      handle.callId,
-      'Outbound - Playback returns the same instance'
-    )
-
     const waitForPlaybackStarted = new Promise((resolve) => {
       call.on('playback.started', (playback) => {
         tap.equal(playback.state, 'playing', 'Outbound - Playback has started')
@@ -84,6 +88,15 @@ const handler = () => {
     // Wait for the outbound audio to start
     await waitForPlaybackStarted
 
+    // Resolve late so that we attach `playback.started` and wait for it
+    const resolvedHandle = await handle
+
+    tap.equal(
+      call.id,
+      resolvedHandle.callId,
+      'Outbound - Playback returns the same instance'
+    )
+
     const waitForPlaybackEnded = new Promise((resolve) => {
       call.on('playback.ended', (playback) => {
         tap.equal(

internal/e2e-realtime-api/src/voicePlaybackMultiple.test.ts

@@ -45,25 +45,34 @@ const handler = () => {
           'Inbound - Call answered gets the same instance'
         )
 
-        // Play an invalid audio
-        const fakePlay = await call.playAudio({
-          url: 'https://cdn.fake.com/default-music/fake.mp3',
-        })
-
-        tap.equal(
-          call.id,
-          fakePlay.callId,
-          'Inbound - fakePlay returns the same instance'
-        )
+        try {
+          // Play an invalid audio
+          const fakePlay = call.playAudio({
+            url: 'https://cdn.fake.com/default-music/fake.mp3',
+          })
 
-        const waitForPlaybackFailed = new Promise((resolve) => {
-          call.on('playback.failed', (playback) => {
-            tap.equal(playback.state, 'error', 'Inbound - playback has failed')
-            resolve(true)
+          const waitForPlaybackFailed = new Promise((resolve) => {
+            call.on('playback.failed', (playback) => {
+              tap.equal(
+                playback.state,
+                'error',
+                'Inbound - playback has failed'
+              )
+              resolve(true)
+            })
           })
-        })
-        // Wait for the inbound audio to failed
-        await waitForPlaybackFailed
+          // Wait for the inbound audio to failed
+          await waitForPlaybackFailed
+
+          // Resolve late so that we attach `playback.failed` and wait for it
+          await fakePlay
+        } catch (error) {
+          tap.equal(
+            call.id,
+            error.callId,
+            'Inbound - fakePlay returns the same instance'
+          )
+        }
 
         const playback = await call.playTTS({
           text: 'Random TTS message while the call is up. Thanks and good bye!',
@@ -96,16 +105,10 @@ const handler = () => {
     tap.ok(call.id, 'Outbound - Call resolved')
 
     // Play an audio
-    const handle = await call.playAudio({
+    const handle = call.playAudio({
       url: 'https://cdn.signalwire.com/default-music/welcome.mp3',
     })
 
-    tap.equal(
-      call.id,
-      handle.callId,
-      'Outbound - Playback returns the same instance'
-    )
-
     const waitForPlaybackStarted = new Promise((resolve) => {
       call.on('playback.started', (playback) => {
         tap.equal(playback.state, 'playing', 'Outbound - Playback has started')
@@ -115,6 +118,15 @@ const handler = () => {
     // Wait for the outbound audio to start
     await waitForPlaybackStarted
 
+    // Resolve late so that we attach `playback.started` and wait for it
+    const resolvedHandle = await handle
+
+    tap.equal(
+      call.id,
+      resolvedHandle.callId,
+      'Outbound - Playback returns the same instance'
+    )
+
     const waitForPlaybackEnded = new Promise((resolve) => {
       call.on('playback.ended', (playback) => {
         tap.equal(