Working inboundCall tests with 100% coverage

Author: cweems

src/@types/types.ts

@@ -38,9 +38,7 @@ export interface JoinConferenceParams extends Request {
   }
 }
 
-export interface ParticipantsToDial[] {
-  messagingBinding: {
-    address: string
-    proxyAddress: string
-  }
+export interface ParticipantToDial {
+  address: string,
+  proxyAddress: string
 }

src/services/inboundCall.service.ts

@@ -5,6 +5,7 @@ import { getConversationByAddressPair } from "../utils/getConversationByAddressP
 import client from '../twilioClient'
 import { participantsToDial } from "../utils/participantsToDial.util";
 import { listConversationParticipants } from "../utils";
+import { generateConferenceName } from "../utils/generateConferenceName.util";
 
 export const generateTwiml = async (from: string, to: string) => {
   let response = new VoiceResponse();
@@ -27,7 +28,7 @@ export const generateTwiml = async (from: string, to: string) => {
     }, process.env.CONNECTING_CALL_ANNOUCEMENT);
 
     if (dialList.length > 1) {
-      const conferenceName = `${from}_at_${Date.now()}`
+      const conferenceName = generateConferenceName(from)
 
       const callPromises = dialList.map(pa => {
           console.log(`Dialing ${pa.address} from ${pa.proxyAddress}...`);
@@ -39,12 +40,7 @@ export const generateTwiml = async (from: string, to: string) => {
           });
       });
 
-      try {
-        await Promise.all(callPromises)
-      } catch(err) {
-        console.log(err)
-        throw new Error(err)
-      }
+      await Promise.all(callPromises)
 
       const dial = response.dial();
       dial.conference({

src/utils/generateConferenceName.util.ts

@@ -0,0 +1,3 @@
+export const generateConferenceName = (phoneNumber: string) : string => {
+  return encodeURIComponent(`${phoneNumber}_at_${Date.now()}`)
+}

src/utils/participantsToDial.util.ts

@@ -1,9 +1,9 @@
 import { ParticipantInstance } from "twilio/lib/rest/conversations/v1/conversation/participant";
+import { ParticipantToDial } from "../@types/types";
 
-export const participantsToDial = (participants: Array<ParticipantInstance>, from: string) : ParticipantsToDial => {
+export const participantsToDial = (participants: Array<ParticipantInstance>, from: string) : ParticipantToDial[] => {
 
-  let accumulator: {address: string, proxyAddress: string }[]
-  return participants.reduce((result, p) => {
+  const output = participants.reduce((result, p) => {
     if (p.messagingBinding.type === "sms" && p.messagingBinding.address != from) {
         console.log(`Adding ${p.messagingBinding.address} to list of numbers to dial.\n`)
 
@@ -14,5 +14,7 @@ export const participantsToDial = (participants: Array<ParticipantInstance>, fro
     }
 
     return result;
-  }, accumulator)
+  }, [])
+
+  return output;
 }

tests/services/inboundCall.test.ts

@@ -1,27 +1,26 @@
 
+import client from '../../src/twilioClient'
 import { generateTwiml } from '../../src/services/inboundCall.service'
 import { getConversationByAddressPair } from "../../src/utils/getConversationByAddressPair.util";
 import { listConversationParticipants } from '../../src/utils/listConversationParticipants.util';
 import { participantsToDial } from '../../src/utils/participantsToDial.util'
+import { generateConferenceName } from '../../src/utils/generateConferenceName.util'
 
-
+jest.mock('../../src/twilioClient')
 jest.mock("../../src/utils/getConversationByAddressPair.util")
-
 jest.mock("../../src/utils/listConversationParticipants.util")
-
 jest.mock('../../src/utils/participantsToDial.util')
+jest.mock('../../src/utils/generateConferenceName.util')
 
 describe('inbound call service', () => {
   const env = process.env
   const mockGetConversationAddressPair = jest.mocked(getConversationByAddressPair, true)
   const mockListConversationParticipants = jest.mocked(listConversationParticipants, true)
   const mockParticipantsToDial = jest.mocked(participantsToDial, true)
 
-
   beforeEach(() => {
     jest.resetModules()
     process.env = { ...env }
-
   })
 
   afterEach(() => {
@@ -39,8 +38,20 @@ describe('inbound call service', () => {
 
     expect(result.toString()).toBe("<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><Say voice=\"alice\" language=\"en\">You session has ended, please call our main line.</Say></Response>")
   })
+  
+  it('creates a conference and dials participants if dialList is longer than 1', async () => {
+    process.env.DOMAIN = 'testdomain.com'
+    process.env.CALL_ANNOUNCMENT_VOICE = 'alice'
+    process.env.CALL_ANNOUCEMENT_LANGUAGE = 'en'
+    process.env.CONNECTING_CALL_ANNOUCEMENT = 'Connecting you to your agent now.'
+    
+    let mockedClient = jest.mocked(client, true)
+    const createSpy = jest.fn((callObject) => { return })
+    const mockedConferenceName = jest.mocked(generateConferenceName, true)
 
-  it('creates a conference if dialList is longer than 1', async () => {
+    mockedClient['calls'] = {
+        create: (options) => createSpy(options)
+    } as any
 
     mockGetConversationAddressPair.mockResolvedValue({ conversationSid: 'CH123'} as any)
     mockListConversationParticipants.mockResolvedValue([{
@@ -50,16 +61,97 @@ describe('inbound call service', () => {
       }
     }] as any)
 
-    mockParticipantsToDial.mockResolvedValue([{
+    const mockParticipantToDial = [{
+      address: '+1112223333',
+      proxyAddress: '+2223334444'
+    }, {
+      address: '+3334445555',
+      proxyAddress: '+4445556666'
+    }]
+
+    mockParticipantsToDial.mockReturnValueOnce(mockParticipantToDial)
+    mockedConferenceName.mockReturnValue('test_conference')
+
+    const result = await generateTwiml('+1112223333', '+2223334444')
+
+    expect(result.toString()).toBe("<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><Say language=\"en\">Connecting you to your agent now.</Say><Dial><Conference endConferenceOnExit=\"true\">test_conference</Conference></Dial></Response>")
+
+    expect(createSpy).toHaveBeenNthCalledWith(1,
+      expect.objectContaining({
+        to: '+1112223333',
+        from: '+2223334444',
+        url: 'https://testdomain.com/join-conference?conferenceName=test_conference'
+      })
+    )
+
+    expect(createSpy).toHaveBeenNthCalledWith(2,
+      expect.objectContaining({
+        to: '+3334445555',
+        from: '+4445556666',
+        url: 'https://testdomain.com/join-conference?conferenceName=test_conference'
+      })
+    )
+  })
+
+  it('throws an error if an outbound call fails', async () => {
+    process.env.DOMAIN = 'testdomain.com'
+    process.env.CALL_ANNOUNCMENT_VOICE = 'alice'
+    process.env.CALL_ANNOUCEMENT_LANGUAGE = 'en'
+    process.env.CONNECTING_CALL_ANNOUCEMENT = 'Connecting you to your agent now.'
+    
+    let mockedClient = jest.mocked(client, true)
+    const createSpy = jest.fn((callObject) => { return })
+    const mockedConferenceName = jest.mocked(generateConferenceName, true)
+
+    mockedClient['calls'] = {
+        create: jest.fn(() => { throw new Error('Call fail') })
+    } as any
+    
+    mockGetConversationAddressPair.mockResolvedValue({ conversationSid: 'CH123'} as any)
+    mockListConversationParticipants.mockResolvedValue([{
       messagingBinding: {
         address: '+1112223333',
         proxyAddress: '+2223334444'
       }
-    }])
+    }] as any)
 
-    const result = await generateTwiml('+1112223333', '+2223334444')
+    const mockParticipantToDial = [{
+      address: '+1112223333',
+      proxyAddress: '+2223334444'
+    }, {
+      address: '+3334445555',
+      proxyAddress: '+4445556666'
+    }]
+
+    mockParticipantsToDial.mockReturnValueOnce(mockParticipantToDial)
+
+    await expect(generateTwiml('+1112223333', '+2223334444'))
+      .rejects
+      .toThrowError('Call fail')
+  })
+
+  it('connects caller with dial if there is only one other participant', async () => {
+    process.env.CALL_ANNOUNCMENT_VOICE = 'alice'
+    process.env.CALL_ANNOUCEMENT_LANGUAGE = 'en'
+    process.env.CONNECTING_CALL_ANNOUCEMENT = 'Connecting you to your agent now.'
+
+    mockGetConversationAddressPair.mockResolvedValue({ conversationSid: 'CH123'} as any)
+    mockListConversationParticipants.mockResolvedValue([{
+      messagingBinding: {
+        address: '+1112223333',
+        proxyAddress: '+2223334444'
+      }
+    }] as any)
+
+    const mockParticipantToDial = [{
+      address: '+1112223333',
+      proxyAddress: '+2223334444'
+    }]
 
-  })  
+    mockParticipantsToDial.mockReturnValueOnce(mockParticipantToDial)
 
+    const result = await generateTwiml('+1112223333', '+2223334444')
 
+    expect(result.toString()).toBe("<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><Say language=\"en\">Connecting you to your agent now.</Say><Dial callerId=\"+2223334444\"><Number>+1112223333</Number></Dial></Response>")
+  })
 })