Improve E2E tests for JS (#860)

* improve e2e-js utils exposing createRoom too * lock updates * use createRoom when needed and delete room on end tests * changeset
signalwire · Aug 22, 2023 · 19f8673 · 19f8673
1 parent 5e1ff11
commit 19f8673
Show file tree

Hide file tree

Showing 8 changed files with 79 additions and 48 deletions.
diff --git a/.changeset/healthy-fireants-prove.md b/.changeset/healthy-fireants-prove.md
@@ -0,0 +1,5 @@
+---
+'@sw-internal/e2e-js': patch
+---
+
+Improve e2e-tests for the browser sDK
diff --git a/internal/e2e-js/tests/roomSessionAutomaticStream.spec.ts b/internal/e2e-js/tests/roomSessionAutomaticStream.spec.ts
@@ -5,9 +5,10 @@ import {
   createTestRoomSession,
   expectRoomJoined,
   expectMCUVisible,
-  createOrUpdateRoom,
+  createRoom,
   createStreamForRoom,
   randomizeRoomName,
+  deleteRoom,
 } from '../utils'
 
 test.describe('Room Session Auto Stream', () => {
@@ -31,7 +32,7 @@ test.describe('Room Session Auto Stream', () => {
     const pageOne = await createCustomPage({ name: '[pageOne]' })
     pageOne.goto(SERVER_URL)
 
-    await createOrUpdateRoom({ name: roomName })
+    const roomData = await createRoom({ name: roomName })
     await createStreamForRoom(roomName, streamingURL)
 
     await createTestRoomSession(pageOne, connectionSettings)
@@ -47,5 +48,7 @@ test.describe('Room Session Auto Stream', () => {
     })
 
     expect(streamsResult.streams).toHaveLength(1)
+
+    await deleteRoom(roomData.id)
   })
 })
diff --git a/internal/e2e-js/tests/roomSessionMaxMembers.spec.ts b/internal/e2e-js/tests/roomSessionMaxMembers.spec.ts
@@ -5,8 +5,9 @@ import {
   createTestRoomSession,
   expectRoomJoined,
   expectMCUVisible,
-  createOrUpdateRoom,
+  createRoom,
   randomizeRoomName,
+  deleteRoom,
 } from '../utils'
 
 test.describe('Room Session Max Members', () => {
@@ -25,7 +26,7 @@ test.describe('Room Session Max Members', () => {
 
     const roomName = randomizeRoomName('max_member_e2e')
 
-    await createOrUpdateRoom({
+    const roomData = await createRoom({
       name: roomName,
       max_members: 2,
     })
@@ -41,8 +42,8 @@ test.describe('Room Session Max Members', () => {
           },
           initialEvents: ['stream.started', 'stream.ended'],
           expectToJoin: false,
-        })}
-      )
+        })
+      })
     )
 
     await Promise.all([expectRoomJoined(pageOne), expectRoomJoined(pageTwo)])
@@ -67,5 +68,7 @@ test.describe('Room Session Max Members', () => {
     })
 
     await expect(joinRoom).rejects.toBeTruthy()
+
+    await deleteRoom(roomData.id)
   })
 })
diff --git a/internal/e2e-js/tests/roomSessionReattachMultiple.spec.ts b/internal/e2e-js/tests/roomSessionReattachMultiple.spec.ts
@@ -7,6 +7,7 @@ import {
   expectRoomJoined,
   expectMCUVisible,
   expectMCUVisibleForAudience,
+  deleteRoom,
 } from '../utils'
 
 type Test = {
@@ -47,6 +48,7 @@ test.describe('RoomSessionReattach', () => {
       await createTestRoomSession(page, connectionSettings)
 
       const joinParams: any = await expectRoomJoined(page)
+      const roomId = joinParams.room_session.room_id
 
       expect(joinParams.room).toBeDefined()
       expect(joinParams.room_session).toBeDefined()
@@ -116,6 +118,9 @@ test.describe('RoomSessionReattach', () => {
           )
         ).toBeTruthy()
       }
+      // Make sure the room_id is stable
+      expect(reattachParams2.room_session.room_id).toBe(roomId)
+
       expect(reattachParams2.room_session.name).toBe(roomName)
       expect(reattachParams2.room.name).toBe(roomName)
       // Make sure the member_id is stable
@@ -125,6 +130,8 @@ test.describe('RoomSessionReattach', () => {
       expect(reattachParams2.call_id).toBeDefined()
       expect(reattachParams2.call_id).toBe(joinParams.call_id)
       await row.expectMCU(page)
+
+      await deleteRoom(roomId)
     })
   })
 })
diff --git a/internal/e2e-js/tests/roomSessionStreamingAPI.spec.ts b/internal/e2e-js/tests/roomSessionStreamingAPI.spec.ts
@@ -2,7 +2,7 @@ import { test } from '../fixtures'
 import {
   SERVER_URL,
   createTestRoomSession,
-  createOrUpdateRoom,
+  createRoom,
   randomizeRoomName,
   createStreamForRoom,
   deleteRoom,
@@ -30,7 +30,7 @@ test.describe('Room Streaming from REST API', () => {
       initialEvents: ['stream.started', 'stream.ended'],
     }
 
-    const roomData = await createOrUpdateRoom({
+    const roomData = await createRoom({
       name: room_name,
     })
 

diff --git a/internal/e2e-js/tests/roomSettings.spec.ts b/internal/e2e-js/tests/roomSettings.spec.ts
@@ -2,7 +2,7 @@ import { test, expect } from '../fixtures'
 import {
   SERVER_URL,
   createTestRoomSession,
-  createOrUpdateRoom,
+  createRoom,
   deleteRoom,
   CreateOrUpdateRoomOptions,
   randomizeRoomName,
@@ -46,7 +46,7 @@ test.describe('Room Settings', () => {
       const page = await createCustomPage({ name: '[page]' })
       await page.goto(SERVER_URL)
 
-      const roomData = await createOrUpdateRoom({
+      const roomData = await createRoom({
         name: row.roomName,
         ...row.roomSettings,
       })

diff --git a/internal/e2e-js/utils.ts b/internal/e2e-js/utils.ts
@@ -27,6 +27,9 @@ const TARGET_ROOT_PATH: Record<
 }
 
 export const SERVER_URL = 'http://localhost:1337'
+export const BASIC_TOKEN = Buffer.from(
+  `${process.env.RELAY_PROJECT}:${process.env.RELAY_TOKEN}`
+).toString('base64')
 
 export const createTestServer = async (
   options: CreateTestServerOptions = { target: 'blank' }
@@ -75,11 +78,11 @@ export const createTestRoomSession = async (
         host: options.RELAY_HOST,
         token: options.API_TOKEN,
         rootElement: document.getElementById('rootElement'),
-        // logLevel: options.CI ? 'warn' : 'debug',
-        logLevel: 'debug',
+        // logLevel: options.CI ? 'info' : 'debug',
+        // logLevel: 'debug',
         debug: {
           // logWsTraffic: !options.CI,
-          logWsTraffic: true,
+          logWsTraffic: false,
         },
         ...options.roomSessionOptions,
       })
@@ -193,18 +196,17 @@ interface CreateTestVRTOptions {
   media_allowed?: 'audio-only' | 'video-only' | 'all'
   join_audio_muted?: boolean
   join_video_muted?: boolean
-  end_room_session_on_leave?: boolean,
+  end_room_session_on_leave?: boolean
 }
 
 export const createTestVRTToken = async (body: CreateTestVRTOptions) => {
-  const authCreds = `${process.env.RELAY_PROJECT}:${process.env.RELAY_TOKEN}`
   const response = await fetch(
     `https://${process.env.API_HOST}/api/video/room_tokens`,
     {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
-        Authorization: `Basic ${Buffer.from(authCreds).toString('base64')}`,
+        Authorization: `Basic ${BASIC_TOKEN}`,
       },
       body: JSON.stringify(body),
     }
@@ -221,14 +223,13 @@ interface CreateTestCRTOptions {
 }
 
 export const createTestCRTToken = async (body: CreateTestCRTOptions) => {
-  const authCreds = `${process.env.RELAY_PROJECT}:${process.env.RELAY_TOKEN}`
   const response = await fetch(
     `https://${process.env.API_HOST}/api/chat/tokens`,
     {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
-        Authorization: `Basic ${Buffer.from(authCreds).toString('base64')}`,
+        Authorization: `Basic ${BASIC_TOKEN}`,
       },
       body: JSON.stringify(body),
     }
@@ -306,7 +307,7 @@ export const expectRoomJoined = (
     return new Promise<any>(async (resolve) => {
       // @ts-expect-error
       const roomObj: Video.RoomSession = window._roomObj
-      
+
       roomObj.once('room.joined', resolve)
 
       if (invokeJoin) {
@@ -417,14 +418,13 @@ export const expectTotalAudioEnergyToBeGreaterThan = async (
 }
 
 const getRoomByName = async (roomName: string) => {
-  const authCreds = `${process.env.RELAY_PROJECT}:${process.env.RELAY_TOKEN}`
   const response = await fetch(
     `https://${process.env.API_HOST}/api/video/rooms/${roomName}`,
     {
       method: 'GET',
       headers: {
         'Content-Type': 'application/json',
-        Authorization: `Basic ${Buffer.from(authCreds).toString('base64')}`,
+        Authorization: `Basic ${BASIC_TOKEN}`,
       },
     }
   )
@@ -450,38 +450,52 @@ export interface CreateOrUpdateRoomOptions {
 
 export const createOrUpdateRoom = async (body: CreateOrUpdateRoomOptions) => {
   const room = await getRoomByName(body.name)
-  const authCreds = `${process.env.RELAY_PROJECT}:${process.env.RELAY_TOKEN}`
+  if (!room) {
+    return createRoom(body)
+  }
+
   const response = await fetch(
-    `https://${process.env.API_HOST}/api/video/rooms${
-      room ? `/${room.id}` : ''
-    }`,
+    `https://${process.env.API_HOST}/api/video/rooms/${room.id}`,
     {
-      method: room ? 'PUT' : 'POST',
+      method: 'PUT',
       headers: {
         'Content-Type': 'application/json',
-        Authorization: `Basic ${Buffer.from(authCreds).toString('base64')}`,
+        Authorization: `Basic ${BASIC_TOKEN}`,
       },
       body: JSON.stringify(body),
     }
   )
-  const data = await response.json()
-  return data
+  return response.json()
+}
+
+export const createRoom = async (body: CreateOrUpdateRoomOptions) => {
+  const response = await fetch(
+    `https://${process.env.API_HOST}/api/video/rooms`,
+    {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: `Basic ${BASIC_TOKEN}`,
+      },
+      body: JSON.stringify(body),
+    }
+  )
+  return response.json()
 }
 
 export const createStreamForRoom = async (name: string, url: string) => {
   const room = await getRoomByName(name)
   if (!room) {
     throw new Error('Room not found')
   }
-  const authCreds = `${process.env.RELAY_PROJECT}:${process.env.RELAY_TOKEN}`
 
   const response = await fetch(
     `https://${process.env.API_HOST}/api/video/rooms/${room.id}/streams`,
     {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
-        Authorization: `Basic ${Buffer.from(authCreds).toString('base64')}`,
+        Authorization: `Basic ${BASIC_TOKEN}`,
       },
       body: JSON.stringify({ url }),
     }
@@ -496,12 +510,11 @@ export const createStreamForRoom = async (name: string, url: string) => {
 }
 
 export const deleteRoom = async (id: string) => {
-  const authCreds = `${process.env.RELAY_PROJECT}:${process.env.RELAY_TOKEN}`
   return await fetch(`https://${process.env.API_HOST}/api/video/rooms/${id}`, {
     method: 'DELETE',
     headers: {
       'Content-Type': 'application/json',
-      Authorization: `Basic ${Buffer.from(authCreds).toString('base64')}`,
+      Authorization: `Basic ${BASIC_TOKEN}`,
     },
   })
 }