Merge pull request #15 from aymenn/tests

Implement Unit Testing Framework

Author: cweems

src/config/retry.config.ts

@@ -0,0 +1,6 @@
+export const retryConfig = {
+  retries: 5,
+  factor: 2,
+  minTimeout: 1000,
+  maxTimeout: 360000
+}

src/twilioClient.ts

@@ -1,15 +1,26 @@
 import twilio from "twilio";
 
-const { TWILIO_ACCOUNT_SID, TWILIO_AUTH_TOKEN } = process.env;
+let TWILIO_ACCOUNT_SID
+let TWILIO_AUTH_TOKEN
 
-if (!TWILIO_ACCOUNT_SID || !TWILIO_AUTH_TOKEN)
+if (process.env.NODE_ENV === "test") {
+  TWILIO_ACCOUNT_SID = "ACabc"
+  TWILIO_AUTH_TOKEN = "123"
+} else {
+  TWILIO_ACCOUNT_SID = process.env.TWILIO_ACCOUNT_SID
+  TWILIO_AUTH_TOKEN = process.env. TWILIO_AUTH_TOKEN
+}
+
+
+if (!TWILIO_ACCOUNT_SID || !TWILIO_AUTH_TOKEN) {
   throw Error(
     "TWILIO_ACCOUNT_SID &/or TWILIO_AUTH_TOKEN are missing from environment variables."
   );
+}
 
 const client = twilio(
-  process.env.TWILIO_ACCOUNT_SID,
-  process.env.TWILIO_AUTH_TOKEN
+  TWILIO_ACCOUNT_SID,
+  TWILIO_AUTH_TOKEN
 );
 
 export default client;

src/utils/createConversation.util.ts

@@ -3,20 +3,23 @@ import { SessionPostBody } from "../@types/types";
 import client from "../twilioClient";
 
 import retry from 'async-retry';
+import { retryConfig } from "../config/retry.config";
 
-export const createConversation = async (options: SessionPostBody) : Promise<ConversationInstance> => {
+
+export const createConversation = async (options: SessionPostBody, retryOptions = retryConfig) : Promise<ConversationInstance> => {
   return retry(async (quit) => {
     try {
-      const conversation = await client.conversations.conversations.create(options);
-      return conversation;
+      return client.conversations.conversations.create(options);
     } catch (err) {
       if (err.status !== 429) {
-        quit(new Error(err));
+        console.log('Quit without retry')
+        console.log(err)
+        quit(new Error('Quit without retry'));
         return;
       }
 
       console.log('Re-trying on 429 error');
       throw new Error(err);
     }
-  })
+  }, retryOptions)
 }

tests/index.test.js

@@ -9,6 +9,8 @@ const client = twilio(
   process.env.TWILIO_AUTH_TOKEN
 );
 
+const sleep = ms => new Promise(resolve => setTimeout(resolve, ms));
+
 async function makeRequest(contacts) {
   const body = { addresses: contacts }
 
@@ -43,13 +45,17 @@ async function runTest() {
 
       const promise = makeRequest(contacts)
       requests.push(promise);
+      await sleep(2)
     }
 
     results = await Promise.allSettled(requests);
     console.timeEnd('testCreate');
   } catch(e) {
     console.error(`failed ${JSON.stringify(e)}`);
   } finally {
+
+    const deletePromises = []
+
     for (let i = 0; i < results.length; ++i) {
       const response = results[i];
 
@@ -63,13 +69,23 @@ async function runTest() {
           if (response.value.sid) {
             console.log(`Removing conversation ${response.value.sid}`);
           }
-          await client.conversations.conversations(response.value.sid).remove()
-
+          const deletePromise = client.conversations.conversations(response.value.sid).remove()
+          deletePromises.push(deletePromise)
         }
       } catch(e){
         console.error(`Couldnt delete convo ${results[i]}: ${JSON.stringify(e)}`)
       }
+      await sleep(50)
     }
+
+    try {
+      await Promise.all(deletePromises)
+    } catch (err) {
+      console.log(err);
+    }
+
+    console.log('Done cleaning up conversations')
+
   }
 }
 

tests/loadtest.js

@@ -0,0 +1,76 @@
+import { createConversation } from "../../src/utils";
+import client from '../../src/twilioClient'
+
+jest.mock('../../src/twilioClient')
+let mockedClient = jest.mocked(client, true)
+
+describe('createConversation util', () => {
+  beforeEach(() => {
+    jest.resetAllMocks()
+  })
+  
+  it('it creates conversation with options passed', async () => {
+    const createSpy = jest.fn((options) => { return options })
+    mockedClient['conversations'] = {
+      conversations: {
+        create: (options) => createSpy(options)
+      }
+    } as any
+
+    const result = await createConversation({ friendlyName: "my conversation", addresses: ['1', '2'] })
+    
+    expect(createSpy).toBeCalledWith({ friendlyName: "my conversation", addresses: ['1', '2'] })
+    expect(result).toEqual({ friendlyName: "my conversation", addresses: ['1', '2'] })
+  })
+
+  it('calls quit if error is not a 429 retry', async () => {
+    mockedClient['conversations'] = {
+      conversations: {
+        create: (options) => {
+          throw new Error('Twilio Problem') 
+        }
+      }
+    } as any
+
+    const consoleSpy = jest.spyOn(console, 'log');
+
+    try {
+      await createConversation({ friendlyName: "my conversation", addresses: ['1', '2'] });
+    } catch (e) {
+      expect(consoleSpy).toHaveBeenCalledWith('Quit without retry');
+    }
+  })
+
+  it('throws error to retry on 429 status code', async () => {
+
+    interface TwilioError extends Error {
+      status: number
+    }
+
+    class TwilioError extends Error {
+      constructor(message) {
+        super(message);
+        this.name = "ConcurrencyLimit";
+        this.status = 429
+      }
+    }
+
+    mockedClient['conversations'] = {
+      conversations: {
+        create: (options) => {
+          throw new TwilioError('Too many requests')
+        }
+      }
+    } as any
+
+    const consoleSpy = jest.spyOn(console, 'log');
+
+    try {
+      await createConversation(
+        { friendlyName: "my conversation", addresses: ['1', '2']},
+        { retries: 0, factor: 1, maxTimeout: 0, minTimeout: 0 });
+    } catch (e) {
+      expect(consoleSpy).toHaveBeenCalledWith('Re-trying on 429 error');
+    }
+  })
+})