Finish getConversationByAddressPair test, add deleteConversation nested method example

Author: cweems

src/utils/deleteConversation.util.ts

@@ -6,6 +6,7 @@ import { retryConfig } from "../config/retry.config";
 export const deleteConversation = async (conversationSid: string, retryOptions = retryConfig) : Promise<boolean> => {
   return retry(async(quit) => {
     try {
+      console.log(client['conversations']['conversations']['remove'])
       await client.conversations.conversations(conversationSid).remove()
       return true
     } catch (err) {

src/utils/getConversationByAddressPair.util.ts

@@ -1,25 +1,21 @@
 import { ParticipantConversationInstance } from 'twilio/lib/rest/conversations/v1/participantConversation';
 import retry from 'async-retry'
 import client from '../twilioClient'
+import { retryConfig } from '../config/retry.config';
 
-export const getConversationByAddressPair = async (address: string, proxyAddress: string) : Promise<ParticipantConversationInstance> => {
+export const getConversationByAddressPair = async (address: string, proxyAddress: string, retryOptions = retryConfig) : Promise<ParticipantConversationInstance> => {
   return retry(async(quit) => {
     try {
-      if (address === undefined) {
-        throw "getOpenConversationsForAddressPair: address is missing";
-      }
-    
       const participantConversations = await client.conversations.v1
         .participantConversations
         .list({ address: address });
-    
+      
       const conversation = participantConversations.find(p => {
         if (p.conversationState !== 'closed' && p.participantMessagingBinding.proxy_address === proxyAddress) {
           console.log(`Found a non-closed conversation ${p.conversationSid} with proxy address ${p.participantMessagingBinding.proxy_address} for address ${address}`);
           return p;
         }
       });
-    
       return conversation;
     } catch(err) {
       if (err.status !== 429) {
@@ -30,5 +26,5 @@ export const getConversationByAddressPair = async (address: string, proxyAddress
       console.log('Re-trying on 429 error');
       throw new Error(err);
     }
-  })
+  }, retryOptions)
 }

tests/utils/deleteConversation.test.ts

@@ -0,0 +1,43 @@
+
+import client from '../../src/twilioClient'
+jest.mock('../../src/twilioClient')
+import { deleteConversation } from "../../src/utils";
+
+
+describe('deleteConversation util', () => {
+  beforeEach(() => {
+    jest.resetAllMocks()
+  })
+  
+  it('it deletes conversation', async () => {
+    let mockedClient = jest.mocked(client, true)
+
+    let removeSpy = jest.fn(() => {
+      return true
+    })
+
+    let conversationsSpy = jest.fn((options) => {
+      return {
+        remove: removeSpy
+      }
+    })
+    
+    mockedClient['conversations'] = {
+      conversations: conversationsSpy
+    } as any
+
+    const result = await deleteConversation("myConversationSid")
+    expect(result).toBe(true)
+    
+    expect(conversationsSpy).toBeCalledWith("myConversationSid")
+    expect(removeSpy).toBeCalled()
+  })
+
+  it.skip('throws an error if Twilio client throws', async () => {
+
+  })
+
+  it.skip('retrys if error is 429', () => {
+
+  })
+})

tests/utils/deleteConversation.test.ts.skip

@@ -1,6 +1,5 @@
 import { getConversationByAddressPair } from "../../src/utils";
 import client from '../../src/twilioClient';
-import { ParticipantConversationInstance } from 'twilio/lib/rest/conversations/v1/participantConversation';
 
 jest.mock('../../src/twilioClient')
 let mockedClient = jest.mocked(client, true)
@@ -10,28 +9,88 @@ describe('GetConversationByAddressPair util', () => {
     jest.resetAllMocks()
   })
 
-  it('it gets Conversation by address pair', async () => {
+  it('it gets Conversation by address pair, excluding closed conversations', async () => {
     const mockParticipants = [{
       conversationState: "closed",
-      conversationSid: "myConversationSid",
+      conversationSid: "myClosedConversationSid",
+      participantMessagingBinding: {
+        proxy_address: "+0000" 
+      }
+    }, {
+      conversationState: "open",
+      conversationSid: "myClosedConversationSid",
+      participantMessagingBinding: {
+        proxy_address: "+0000" 
+      }
+    }, {
+      conversationState: "open",
+      conversationSid: "myOpenConversationSid",
       participantMessagingBinding: {
         proxy_address: "+5678" 
       }
     }]
 
-    const createSpy = jest.fn((options) => { return mockParticipants })
+    const listSpy = jest.fn((options) => { return mockParticipants })
     mockedClient['conversations'] = {
       v1:{
         participantConversations: {
-          list: (options) => createSpy(options)
+          list: (options) => listSpy(options)
         }
       }
     } as any
 
     const result = await getConversationByAddressPair("+1234","+5678");
-    expect(createSpy).toBeCalledWith({"address":"+1234"});
-    expect(result).not.toBeNull();
+    expect(listSpy).toBeCalledWith({"address":"+1234"});
+    expect(result).toEqual({conversationSid: "myOpenConversationSid", conversationState: "open", participantMessagingBinding: {proxy_address: "+5678"}});
     // ToDo: add proper mocked response with ParticipantConversationInstance
   })
+
+  it("should throw error if Twilio client throws", async () => {
+    const createSpy = jest.fn((options) => { throw new Error('Twilio Problem') })
+    mockedClient['conversations'] = {
+      v1:{
+        participantConversations: {
+          list: (options) => createSpy(options)
+        }
+      }
+    } as any
+
+    await expect(getConversationByAddressPair("bad input", "worse input"))
+      .rejects
+      .toThrowError('Twilio Proble')
+  })
+
+  it("should retry if Twilio error is 429", async () => {
+
+      interface TwilioError extends Error {
+        status: number
+      }
+  
+      class TwilioError extends Error {
+        constructor(message) {
+          super(message);
+          this.name = "ConcurrencyLimit";
+          this.status = 429
+        }
+      }
+
+      mockedClient['conversations'] = {
+        v1:{
+          participantConversations: {
+            list: (options) => {
+              throw new TwilioError('Too many requests')
+            }
+          }
+        }
+      } as any
+  
+      const consoleSpy = jest.spyOn(console, 'log');
+  
+      try {
+        await getConversationByAddressPair("+1234", "+5678", { retries: 0, factor: 1, maxTimeout: 0, minTimeout: 0 });
+      } catch (e) {
+        expect(consoleSpy).toHaveBeenCalledWith('Re-trying on 429 error');
+      }
+  })
 })