Fix e2e test cases with v4 SDK

.changeset/lovely-tigers-breathe.md

@@ -0,0 +1,5 @@
+---
+'@signalwire/realtime-api': patch
+---
+
+Fix `onStarted` function in decorated promises

.github/workflows/unit-tests.yml

@@ -1,4 +1,4 @@
-name: Unit and stack tests
+name: Tests
 
 on:
  push:

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

@@ -56,10 +56,15 @@ const testSubscribe = ({ jsChat, rtChat }: TestChatOptions) => {
  console.log('Running subscribe..')
  let events = 0
 
- const resolveIfDone = () => {
+ let unsubRTChannel: Promise<() => Promise<void>>
+
+ const resolveIfDone = async () => {
  // wait 4 events (rt and js receive their own events + the other member)
  if (events === 4) {
  jsChat.off('member.joined')
+ await (
+ await unsubRTChannel
+ )()
  resolve(0)
  }
  }
@@ -71,18 +76,17 @@ const testSubscribe = ({ jsChat, rtChat }: TestChatOptions) => {
  resolveIfDone()
  })
 
- const [unsubRTClient] = await Promise.all([
- rtChat.listen({
- channels: [channel],
- onMemberJoined(member) {
- // TODO: Check the member payload
- console.log('rtChat member.joined')
- events += 1
- resolveIfDone()
- },
- }),
- jsChat.subscribe(channel),
- ])
+ unsubRTChannel = rtChat.listen({
+ channels: [channel],
+ onMemberJoined(member) {
+ // TODO: Check the member payload
+ console.log('rtChat member.joined')
+ events += 1
+ resolveIfDone()
+ },
+ })
+
+ await Promise.all([unsubRTChannel, jsChat.subscribe(channel)])
  })
 
  return timeoutPromise(promise, promiseTimeout, promiseException)
@@ -275,6 +279,7 @@ const testDisconnectedRTClient = (rtClient: RealtimeSWClient) => {
 
  reject(4)
  } catch (e) {
+ console.log('Client disconnected okay!')
  resolve(0)
  }
  })
@@ -289,6 +294,9 @@ const handler = async () => {
  host: process.env.RELAY_HOST,
  // @ts-expect-error
  token: CRT.token,
+ debug: {
+ logWsTraffic: true,
+ },
  })
 
  const jsChatResultCode = await testChatMethod(jsChat)
@@ -302,6 +310,9 @@ const handler = async () => {
  host: process.env.RELAY_HOST,
  project: process.env.RELAY_PROJECT as string,
  token: process.env.RELAY_TOKEN as string,
+ // debug: {
+ // logWsTraffic: true,
+ // },
  })
  const rtChat = rtClient.chat
 
@@ -372,7 +383,7 @@ async function main() {
  const runner = createTestRunner({
  name: 'Chat E2E',
  testHandler: handler,
- executionTime: 15_000,
+ executionTime: 30_000,
  })
 
  await runner.run()

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

@@ -234,6 +234,7 @@ async function main() {
  const runner = createTestRunner({
  name: 'PubSub E2E',
  testHandler: handler,
+ executionTime: 20_000,
  })
 
  await runner.run()

internal/e2e-realtime-api/src/utils.ts

@@ -1,3 +1,4 @@
+import tap from 'tap'
 import { request } from 'node:https'
 import { randomUUID, randomBytes } from 'node:crypto'
 
@@ -43,7 +44,6 @@ interface CreateTestRunnerParams {
  testHandler: TestHandler
  executionTime?: number
  useDomainApp?: boolean
- exitOnSuccess?: boolean
 }
 
 export const createTestRunner = ({
@@ -52,7 +52,6 @@ export const createTestRunner = ({
  testHandler,
  executionTime = MAX_EXECUTION_TIME,
  useDomainApp = false,
- exitOnSuccess = true,
 }: CreateTestRunnerParams) => {
  let timer: ReturnType<typeof setTimeout>
 
@@ -61,15 +60,13 @@ export const createTestRunner = ({
  console.error(`Test Runner ${name} ran out of time (${executionTime})`)
  process.exit(2)
  }, executionTime)
+ tap.setTimeout(executionTime)
  }
 
  const done = (exitCode: number) => {
  clearTimeout(timer)
  if (exitCode === 0) {
  console.log(`Test Runner ${name} Passed!`)
- if (!exitOnSuccess) {
- return
- }
  } else {
  console.log(`Test Runner ${name} finished with exitCode: ${exitCode}`)
  }
@@ -94,7 +91,6 @@ export const createTestRunner = ({
  if (params.domainApp) {
  console.log('Delete domain app..')
  await deleteDomainApp({ id: params.domainApp.id })
- delete params.domainApp
  }
  done(exitCode)
  } catch (error) {
@@ -103,7 +99,6 @@ export const createTestRunner = ({
  if (params.domainApp) {
  console.log('Delete domain app..')
  await deleteDomainApp({ id: params.domainApp.id })
- delete params.domainApp
  }
  done(1)
  }

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

@@ -25,6 +25,11 @@ const handler: TestHandler = ({ domainApp }) => {
  let outboundCall: Voice.Call
  let callsReceived = new Set()
 
+ let waitForDetectStartResolve: () => void
+ const waitForDetectStart = new Promise<void>((resolve) => {
+ waitForDetectStartResolve = resolve
+ })
+
  const unsubVoice = await client.voice.listen({
  topics: [domainApp.call_relay_context],
  onCallReceived: async (call) => {
@@ -53,11 +58,14 @@ const handler: TestHandler = ({ domainApp }) => {
  )
 
  if (callsReceived.size === 2) {
+ // Wait until the outbound peer starts digit detection
+ await waitForDetectStart
+
  const sendDigitResult = await call.sendDigits('1#')
  tap.equal(
  call.id,
  sendDigitResult.id,
- 'Peer - SendDigit returns the same instance'
+ 'PeerInboundCall - SendDigit returns the same instance'
  )
 
  return
@@ -177,16 +185,22 @@ const handler: TestHandler = ({ domainApp }) => {
  console.log('Peer:', peer.id, peer.type, peer.from, peer.to)
  console.log('Main:', call.id, call.type, call.from, call.to)
 
- const detector = await call.detectDigit({
- digits: '1',
- })
+ const detector = await call
+ .detectDigit({
+ digits: '1',
+ })
+ .onStarted()
+
+ // Inform inbound peer that the detector has started
+ waitForDetectStartResolve()
+
+ const detected = await detector.ended()
 
  // TODO: update this once the backend can send us the actual result
  tap.equal(
- // @ts-expect-error
- detector.detect.params.event,
+ detected.detect?.params.event,
  'finished',
- 'Peer - Detect digit is finished'
+ 'PeerOutboundCall - Detect digit is finished'
  )
 
  console.log('Finishing the calls.')

internal/e2e-realtime-api/src/voiceCollectAllListeners.test.ts → internal/e2e-realtime-api/src/voiceCollect/withAllListeners.test.ts

@@ -6,7 +6,7 @@ import {
  CALL_PROPS,
  TestHandler,
  makeSipDomainAppAddress,
-} from './utils'
+} from '../utils'
 
 const handler: TestHandler = ({ domainApp }) => {
  if (!domainApp) {

internal/e2e-realtime-api/src/voiceCollectCallListeners.test.ts → internal/e2e-realtime-api/src/voiceCollect/withCallListeners.test.ts

@@ -6,7 +6,7 @@ import {
  CALL_PROPS,
  TestHandler,
  makeSipDomainAppAddress,
-} from './utils'
+} from '../utils'
 
 const handler: TestHandler = ({ domainApp }) => {
  if (!domainApp) {

internal/e2e-realtime-api/src/voiceCollectListeners.test.ts → internal/e2e-realtime-api/src/voiceCollect/withCollectListeners.test.ts

@@ -6,7 +6,7 @@ import {
  CALL_PROPS,
  TestHandler,
  makeSipDomainAppAddress,
-} from './utils'
+} from '../utils'
 
 const handler: TestHandler = ({ domainApp }) => {
  if (!domainApp) {