Additional service tests

Author: cweems

src/@types/types.ts

@@ -36,4 +36,11 @@ export interface JoinConferenceParams extends Request {
   params: {
     conferenceName: string
   }
+}
+
+export interface ParticipantsToDial[] {
+  messagingBinding: {
+    address: string
+    proxyAddress: string
+  }
 }

src/services/inboundCall.service.ts

@@ -3,6 +3,8 @@ import VoiceResponse from "twilio/lib/twiml/VoiceResponse";
 import { getConversationByAddressPair } from "../utils/getConversationByAddressPair.util";
 
 import client from '../twilioClient'
+import { participantsToDial } from "../utils/participantsToDial.util";
+import { listConversationParticipants } from "../utils";
 
 export const generateTwiml = async (from: string, to: string) => {
   let response = new VoiceResponse();
@@ -16,33 +18,18 @@ export const generateTwiml = async (from: string, to: string) => {
       language: process.env.CALL_ANNOUCEMENT_LANGUAGE as any,
     }, process.env.OUT_OF_SESSION_MESSAGE_FOR_CALL);
   } else {
-    const participants = await client.conversations
-      .conversations(conversation.conversationSid)
-      .participants
-      .list()
-
-    const participantsToDial = 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`)
-
-          result.push({
-              address: p.messagingBinding.address,
-              proxyAddress: p.messagingBinding.proxy_address
-          })
-      }
-
-      return result;
-    }, [])
+    const participants = await listConversationParticipants(conversation.conversationSid)
+    const dialList = participantsToDial(participants, from)
 
     response.say({
       voice: process.env.CALL_ANNOUCEMENT_VOICE as any,
       language: process.env.CALL_ANNOUCEMENT_LANGUAGE as any
     }, process.env.CONNECTING_CALL_ANNOUCEMENT);
 
-    if (participantsToDial.length > 1) {
+    if (dialList.length > 1) {
       const conferenceName = `${from}_at_${Date.now()}`
 
-      const callPromises = participantsToDial.map(pa => {
+      const callPromises = dialList.map(pa => {
           console.log(`Dialing ${pa.address} from ${pa.proxyAddress}...`);
 
           return client.calls.create({
@@ -66,7 +53,7 @@ export const generateTwiml = async (from: string, to: string) => {
 
 
     } else {
-      const callee = participantsToDial[0]
+      const callee = dialList[0]
       const dial = response.dial({
         callerId: callee.proxyAddress
       });

src/utils/index.ts

@@ -2,4 +2,6 @@ export * from "./addParticipant.util";
 export * from "./createConversation.util";
 export * from "./deleteConversation.util";
 export * from "./listParticipantConversations.util"
-export * from "./retryAddParticipant.util"
+export * from "./retryAddParticipant.util"
+export * from "./listConversationParticipants.util"
+export * from "./participantsToDial.util"

src/utils/listConversationParticipants.util.ts

@@ -0,0 +1,25 @@
+import retry from 'async-retry'
+import { ParticipantInstance } from 'twilio/lib/rest/conversations/v1/conversation/participant'
+import client from '../twilioClient'
+
+export const listConversationParticipants = async (conversation: string) : Promise<ParticipantInstance[]> => {
+  return retry(async (quit) => {
+    try {
+      const participants = await client.conversations
+        .conversations(conversation)
+        .participants
+        .list()
+
+      return participants
+    } catch (err) {
+      if (err.status !== 429) {
+        quit(new Error(err));
+        return;
+      }
+
+      console.log('Re-trying on 429 error');
+      throw new Error(err);
+    }
+  })
+
+}

src/utils/participantsToDial.util.ts

@@ -0,0 +1,18 @@
+import { ParticipantInstance } from "twilio/lib/rest/conversations/v1/conversation/participant";
+
+export const participantsToDial = (participants: Array<ParticipantInstance>, from: string) : ParticipantsToDial => {
+  
+  let accumulator: {address: string, proxyAddress: string }[]
+  return 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`)
+  
+        result.push({
+            address: p.messagingBinding.address,
+            proxyAddress: p.messagingBinding.proxy_address
+        })
+    }
+  
+    return result;
+  }, accumulator)
+}

tests/services/inboundCall.test.ts

@@ -0,0 +1,65 @@
+
+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'
+
+
+jest.mock("../../src/utils/getConversationByAddressPair.util")
+
+jest.mock("../../src/utils/listConversationParticipants.util")
+
+jest.mock('../../src/utils/participantsToDial.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(() => {
+    process.env = env
+    jest.resetAllMocks()
+  })
+
+  it('returns out of session call announcement if no conversation if provided', async () => {
+    mockGetConversationAddressPair.mockResolvedValue(undefined)
+
+    process.env.CALL_ANNOUCEMENT_VOICE = 'alice'
+    process.env.CALL_ANNOUCEMENT_LANGUAGE = 'en'
+    process.env.OUT_OF_SESSION_MESSAGE_FOR_CALL = 'You session has ended, please call our main line.'
+    const result = await generateTwiml('+1112223333', '+2223334444')
+
+    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 if dialList is longer than 1', async () => {
+    
+    mockGetConversationAddressPair.mockResolvedValue({ conversationSid: 'CH123'} as any)
+    mockListConversationParticipants.mockResolvedValue([{
+      messagingBinding: {
+        address: '+1112223333',
+        proxyAddress: '+2223334444'
+      }
+    }] as any)
+
+    mockParticipantsToDial.mockResolvedValue([{
+      messagingBinding: {
+        address: '+1112223333',
+        proxyAddress: '+2223334444'
+      }
+    }])
+
+    const result = await generateTwiml('+1112223333', '+2223334444')
+
+  })  
+
+
+})