e2e tests, CF, agent and guest

.github/workflows/browser-js-production.yml

@@ -50,6 +50,7 @@ jobs:
         run: npm run -w=@sw-internal/e2e-js dev -- --project ${{ matrix.project }}
         env:
           SW_TEST_CONFIG: ${{ secrets.PRODUCTION_E2E_JS_SW_TEST_CONFIG }}
+          EXTERNAL_URL_FOR_CXML: ${{ secrets.EXTERNAL_URL_FOR_CXML }}
 
   report-result:
     needs: e2e-tests

.github/workflows/browser-js-staging.yml

@@ -49,6 +49,7 @@ jobs:
         run: npm run -w=@sw-internal/e2e-js dev -- --project ${{ matrix.project }}
         env:
           SW_TEST_CONFIG: ${{ secrets.STAGING_E2E_JS_SW_TEST_CONFIG }}
+          EXTERNAL_URL_FOR_CXML: ${{ secrets.EXTERNAL_URL_FOR_CXML }}
 
   report-result:
     needs: e2e-tests

internal/e2e-js/fixtures.ts

@@ -1,16 +1,20 @@
 import { PageWithWsInspector, intercepWsTraffic } from 'playwrigth-ws-inspector'
 import { test as baseTest, expect, type Page } from '@playwright/test'
 import {
+  CreatecXMLScriptParams,
   CreateRelayAppResourceParams,
   CreateSWMLAppResourceParams,
   Resource,
+  createcXMLExternalURLResource,
+  createcXMLScriptResource,
   createRelayAppResource,
   createSWMLAppResource,
   createVideoRoomResource,
   deleteResource,
   disconnectClient,
   enablePageLogs,
   leaveRoom,
+  CreatecXMLExternalURLParams,
 } from './utils'
 
 type CustomPage = Page & {
@@ -23,6 +27,8 @@ type CustomFixture = {
   }): Promise<PageWithWsInspector<CustomPage>>
   createCustomVanillaPage(options: { name: string }): Promise<Page>
   resource: {
+    createcXMLExternalURLResource: typeof createcXMLExternalURLResource
+    createcXMLScriptResource: typeof createcXMLScriptResource
     createVideoRoomResource: typeof createVideoRoomResource
     createSWMLAppResource: typeof createSWMLAppResource
     createRelayAppResource: typeof createRelayAppResource
@@ -96,6 +102,16 @@ const test = baseTest.extend<CustomFixture>({
         resources.push(data)
         return data
       },
+      createcXMLExternalURLResource: async (params: CreatecXMLExternalURLParams) => {
+        const data = await createcXMLExternalURLResource(params)
+        resources.push(data)
+        return data
+      },
+      createcXMLScriptResource: async (params: CreatecXMLScriptParams) => {
+        const data = await createcXMLScriptResource(params)
+        resources.push(data)
+        return data
+      },
       createSWMLAppResource: async (params: CreateSWMLAppResourceParams) => {
         const data = await createSWMLAppResource(params)
         resources.push(data)

internal/e2e-js/playwright.config.ts

@@ -36,6 +36,7 @@ const reattachTests = [
   'roomSessionReattachWrongProtocol.spec.ts',
 ]
 const callfabricTests = [
+  'agent_customer.spec.ts',
   'address.spec.ts',
   'cleanup.spec.ts',
   'conversation.spec.ts',

internal/e2e-js/tests/callfabric/agent_customer.spec.ts

@@ -0,0 +1,325 @@
+import { uuid } from '@signalwire/core'
+import { test } from '../../fixtures'
+import { expect } from '../../fixtures'
+import {
+  SERVER_URL,
+  createCFClient,
+  createGuestCFClient,
+  dialAddress,
+  expectCFFinalEvents,
+  expectCFInitialEvents,
+  expectTotalAudioEnergyToBeGreaterThan,
+  getResourceAddresses,
+} from '../../utils'
+
+const agent_customer_static_scripts_desc = 'CallFabric Agent/Customer interaction, static cXML scripts'
+test.describe(agent_customer_static_scripts_desc, () => {
+
+  const conference_name = `e2e-cxml-script-conference_${uuid()}`
+
+  const cXMLScriptAgentContent = {
+    call_handler_script: `<?xml version="1.0" encoding="UTF-8"?><Response><Dial><Conference>${conference_name}</Conference></Dial></Response>`
+  }
+  const cXMLScriptCustomerContent = {
+    call_handler_script: `<?xml version="1.0" encoding="UTF-8"?><Response><Dial><Conference>${conference_name}</Conference></Dial></Response>`
+  }
+
+  test('agent and customer should dial an address linked to a static cXML script and expect to join a Conference', async ({
+    createCustomPage,
+    resource,
+  }) => {
+    // Agent
+    const agent_page = await createCustomPage({ name: '[agent_page]' })
+    await agent_page.goto(SERVER_URL)
+
+    const agentResourceName = `e2e-cxml-script-agent_${uuid()}`
+    const agent_resource_data = await resource.createcXMLScriptResource({
+      name: agentResourceName,
+      contents: cXMLScriptAgentContent,
+    })
+
+    expect(agent_resource_data.cxml_application?.id).toBeDefined()
+
+    await createCFClient(agent_page)
+
+    await dialAddress(agent_page, {
+      address: `/private/${agentResourceName}`, // or /public/?
+      shouldWaitForJoin: false,
+      shouldStartCall: false
+    })
+
+    const expectInitialEventsForAgent = expectCFInitialEvents(agent_page, [])
+    await agent_page.evaluate(async () => {
+      // @ts-expect-error
+      const call = window._roomObj
+
+      await call.start()
+    })
+
+    console.log("Address dialled by Agent...")
+    expectInitialEventsForAgent
+    console.log("After CF Initial events for agent...")
+
+    console.log('--------- creating customer ------------------')
+    // Customer
+    const customer_page = await createCustomPage({ name: '[customer_page]' })
+    await customer_page.goto(SERVER_URL)
+
+    const customerResourceName = `e2e-cxml-script-customer_${uuid()}`
+    const customer_resource_data = await resource.createcXMLScriptResource({
+      name: customerResourceName,
+      contents: cXMLScriptCustomerContent,
+    })
+
+    expect(customer_resource_data.id).toBeDefined()
+    const resource_addresses = await getResourceAddresses(customer_resource_data.id)
+    const allowed_addresses: string[] = resource_addresses.data.map((address: { id: any }) => address.id ?? '')
+
+    console.log("Allowed addresses: ", allowed_addresses, " <---------------")
+
+    await createGuestCFClient(customer_page, { allowed_addresses: allowed_addresses})
+
+    await dialAddress(customer_page, {
+      address: `/private/${customerResourceName}`, // or /public/?
+      shouldWaitForJoin: false,
+      shouldStartCall: false
+    })
+
+    // Let the Agent wait a little before the Customer joins
+    await customer_page.waitForTimeout(2000)
+
+    const expectInitialEventsForCustomer = expectCFInitialEvents(customer_page, [])
+    await customer_page.evaluate(async () => {
+      // @ts-expect-error
+      const call = window._roomObj
+
+      await call.start()
+    })
+    await expectInitialEventsForCustomer
+
+    // 5 seconds' call
+    await customer_page.waitForTimeout(5000)
+
+    console.log("Expect to have received audio...")
+    await expectTotalAudioEnergyToBeGreaterThan(agent_page, 0.15)
+    await expectTotalAudioEnergyToBeGreaterThan(customer_page, 0.15)
+
+    // Attach final listeners
+    const customerFinalEvents = expectCFFinalEvents(customer_page)
+    const agentFinalEvents = expectCFFinalEvents(agent_page)
+
+    console.log("Test done - hanging up customer")
+
+    await customer_page.evaluate(async () => {
+      // @ts-expect-error
+      const call = window._roomObj
+
+      await call.hangup()
+    })
+
+    console.log("Test done - hanging up agent")
+
+    await agent_page.evaluate(async () => {
+      // @ts-expect-error
+      const call = window._roomObj
+
+      await call.hangup()
+    })
+
+    await Promise.all([customerFinalEvents, agentFinalEvents])
+
+    console.log("Test done -", agent_customer_static_scripts_desc)
+  })
+})
+
+const agent_customer_external_url_desc = 'CallFabric Agent/Customer interaction, cXML with external URL'
+test.describe(agent_customer_external_url_desc, () => {
+  const external_url_for_cxml = process.env.EXTERNAL_URL_FOR_CXML
+
+  const cXMLExternalURLAgent = {
+    call_handler_url: external_url_for_cxml
+  }
+  const cXMLExternalURLCustomer = {
+    call_handler_url: external_url_for_cxml
+  }
+
+  const test_uuid = `${uuid()}`
+
+  test('agent and customer should dial an address linked to a cXML script with external URL and expect to join a Conference', async ({
+    createCustomPage,
+    resource,
+  }) => {
+    // Agent
+    const agent_page = await createCustomPage({ name: '[agent_page]' })
+    await agent_page.goto(SERVER_URL)
+
+    const agentResourceName = `${test_uuid}_e2e-cxml-external-url-agent_${uuid()}`
+    const agent_resource_data = await resource.createcXMLExternalURLResource({
+      name: agentResourceName,
+      contents: cXMLExternalURLAgent,
+    })
+
+    expect(agent_resource_data.cxml_application?.id).toBeDefined()
+
+    await createCFClient(agent_page)
+
+    await dialAddress(agent_page, {
+      address: `/private/${agentResourceName}`, // or /public/?
+      shouldWaitForJoin: false,
+      shouldStartCall: false
+    })
+
+    const expectInitialEventsForAgent = expectCFInitialEvents(agent_page, [])
+    await agent_page.evaluate(async () => {
+      // @ts-expect-error
+      const call = window._roomObj
+
+      await call.start()
+    })
+
+    console.log("Address dialled by Agent...")
+    expectInitialEventsForAgent
+    console.log("After CF Initial events for agent...")
+
+    console.log('--------- creating customer ------------------')
+    // Customer
+    const customer_page = await createCustomPage({ name: '[customer_page]' })
+    await customer_page.goto(SERVER_URL)
+
+    const customerResourceName = `${test_uuid}_e2e-cxml-external-url-customer_${uuid()}`
+    const customer_resource_data = await resource.createcXMLExternalURLResource({
+      name: customerResourceName,
+      contents: cXMLExternalURLCustomer,
+    })
+
+    expect(customer_resource_data.id).toBeDefined()
+    const resource_addresses = await getResourceAddresses(customer_resource_data.id)
+    const allowed_addresses: string[] = resource_addresses.data.map((address: { id: any }) => address.id ?? '')
+
+    console.log("Allowed addresses: ", allowed_addresses, " <---------------")
+
+    await createGuestCFClient(customer_page, { allowed_addresses: allowed_addresses})
+
+    await dialAddress(customer_page, {
+      address: `/private/${customerResourceName}`, // or /public/?
+      shouldWaitForJoin: false,
+      shouldStartCall: false
+    })
+
+    // Let the Agent wait a little before the Customer joins
+    await new Promise((r) => setTimeout(r, 2000))
+
+    const expectInitialEventsForCustomer = expectCFInitialEvents(customer_page, [])
+    await customer_page.evaluate(async () => {
+      // @ts-expect-error
+      const call = window._roomObj
+
+      await call.start()
+    })
+    await expectInitialEventsForCustomer
+
+    // 5 seconds' call
+    await customer_page.waitForTimeout(5000)
+
+    console.log("Expect to have received audio...")
+    await expectTotalAudioEnergyToBeGreaterThan(agent_page, 0.15)
+    await expectTotalAudioEnergyToBeGreaterThan(customer_page, 0.15)
+
+    // Attach final listeners
+    const customerFinalEvents = expectCFFinalEvents(customer_page)
+    const agentFinalEvents = expectCFFinalEvents(agent_page)
+
+    console.log("Test done - hanging up customer")
+
+    await customer_page.evaluate(async () => {
+      // @ts-expect-error
+      const call = window._roomObj
+
+      await call.hangup()
+    })
+
+    console.log("Test done - hanging up agent")
+
+    await agent_page.evaluate(async () => {
+      // @ts-expect-error
+      const call = window._roomObj
+
+      await call.hangup()
+    })
+
+    await Promise.all([customerFinalEvents, agentFinalEvents])
+    console.log("Test done -", agent_customer_external_url_desc)
+  })
+})
+
+// TODO: Enable when ready
+// const customer_stream_desc = 'CallFabric Customer connecting to stream'
+// test.describe(customer_stream_desc, () => {
+//   test('customer should dial an address linked to a cXML script connecting to a conference with stream', async ({
+//     createCustomPage,
+//     resource,
+//   }) => {
+
+//     const conference_name = `e2e-cxml-customer-stream_${uuid()}`
+//     const stream_url = `${process.env.CXML_STREAM_URL}`
+
+//     const cXMLScriptCustomerContent = {
+//      call_handler_script: `<?xml version="1.0" encoding="UTF-8"?><Response><Dial><Conference addStream="true" streamUrl="${stream_url}">${conference_name}</Conference></Dial></Response>`
+//    }
+
+//     console.log('--------- creating customer ------------------')
+//     // Customer
+//     const customer_page = await createCustomPage({ name: '[customer_page]' })
+//     await customer_page.goto(SERVER_URL)
+
+//     const customerResourceName = `e2e-cxml-customer-stream_${uuid()}`
+//     const customer_resource_data = await resource.createcXMLScriptResource({
+//       name: customerResourceName,
+//       contents: cXMLScriptCustomerContent,
+//     })
+
+//     expect(customer_resource_data.id).toBeDefined()
+//     const resource_addresses = await getResourceAddresses(customer_resource_data.id)
+//     const allowed_addresses: string[] = resource_addresses.data.map((address: { id: any }) => address.id ?? '')
+
+//     console.log("Allowed addresses: ", allowed_addresses, " <---------------")
+
+//     await createGuestCFClient(customer_page, { allowed_addresses: allowed_addresses})
+
+//     await dialAddress(customer_page, {
+//       address: `/private/${customerResourceName}`, // or /public/?
+//       shouldWaitForJoin: false,
+//       shouldStartCall: false
+//     })
+
+//     const expectInitialEventsForCustomer = expectCFInitialEvents(customer_page, [])
+//     await customer_page.evaluate(async () => {
+//       // @ts-expect-error
+//       const call = window._roomObj
+
+//       await call.start()
+//     })
+//     await expectInitialEventsForCustomer
+
+//     // 10 seconds' call
+//     await customer_page.waitForTimeout(10000)
+
+//     console.log("Expect to have received some audio...")
+//     await expectTotalAudioEnergyToBeGreaterThan(customer_page, 0.01)
+
+//     // Attach final listeners
+//     const customerFinalEvents = expectCFFinalEvents(customer_page)
+
+//     console.log("Test done - hanging up customer")
+
+//     await customer_page.evaluate(async () => {
+//       // @ts-expect-error
+//       const call = window._roomObj
+
+//       await call.hangup()
+//     })
+
+//     await customerFinalEvents
+//     console.log("Test done -", customer_stream_desc)
+//   })
+// })