feat: sms limiting

scripts/20210628_create-isOnboardedAcc/create-isOnboardedAcc.js

@@ -0,0 +1,63 @@
+/* eslint-disable */
+
+/*
+This script creates a new key, isOnboardedAccount, on the smscounts db which indexes the msgSrvcId variable
+*/
+
+let formTwilioId = 'insert the form twilio id here'
+
+// == PRE-UPDATE CHECKS ==
+// Count the number of verifications (A)
+db.getCollection('smscounts').count({ smsType: 'VERIFICATION' })
+
+// Count of forms using our twilio acc (B)
+db.getCollection('smscounts').count({
+  smsType: 'VERIFICATION',
+msgSrvcSid: {$eq: formTwilioId},
+})
+
+// Count of forms using their own twilio acc (C)
+// A === B + C
+db.getCollection('smscounts').count({
+  smsType: 'VERIFICATION',
+  msgSrvcSid: { $ne: formTwilioId },
+})
+
+
+// == UPDATE ==
+// Update verifications which have message service id equal to form twilio id
+db.getCollection('smscounts').updateMany(
+  { smsType: 'VERIFICATION', msgSrvcSid: { $eq: formTwilioId } },
+  {
+    $set: {
+      isOnboardedAccount: false,
+    },
+  }
+)
+
+// Update verifications whose message service id is not equal to form twilio id
+db.getCollection('smscounts').updateMany(
+  { smsType: 'VERIFICATION', msgSrvcSid: { $ne: formTwilioId } },
+  {
+    $set: {
+      isOnboardedAccount: true,
+    },
+  }
+)
+
+// == POST-UPDATE CHECKS ==
+// Check number of verifications updated
+// Sum of these two should be equal to the initial count
+// Count of forms using our twilio acc
+db.getCollection('smscounts').count({
+  smsType: 'VERIFICATION',
+  msgSrvcSid: { $eq: formTwilioId },
+  isOnboardedAccount: false
+})
+
+// Count of forms using their own twilio acc
+db.getCollection('smscounts').count({
+  smsType: 'VERIFICATION',
+  msgSrvcSid: { $ne: formTwilioId },
+  isOnboardedAccount: true
+})

scripts/20210628_create-isOnboardedAcc/delete-isOnboardedAcc.js

@@ -0,0 +1,30 @@
+/* eslint-disable */
+
+/*
+This script creates a new key, isOnboardedAccount, on the smscounts db which indexes the msgSrvcId variable
+*/
+
+// == PRE-UPDATE CHECKS ==
+// Count the number of verifications we have to update
+db.getCollection('smscounts').count({ smsType: 'VERIFICATION' })
+
+// == UPDATE ==
+// Update verified smses
+db.getCollection('smscounts').updateMany(
+  { smsType: 'VERIFICATION' },
+  {
+    $unset: {
+      isOnboardedAccount: false,
+    },
+  }
+)
+
+// == POST-UPDATE CHECKS ==
+// Check number of verifications updated
+// SHOULD BE 0
+db.getCollection('smscounts').count({
+  smsType: 'VERIFICATION',
+  isOnboardedAccount: {
+    $exists: true
+  }
+})

shared/utils/verification.ts

@@ -21,3 +21,15 @@ export enum VfnErrors {
   TransactionNotFound = 'TRANSACTION_NOT_FOUND',
   InvalidMobileNumber = 'INVALID_MOBILE_NUMBER',
 }
+
+export enum ADMIN_VERIFIED_SMS_STATES {
+  limitExceeded = 'LIMIT_EXCEEDED',
+  belowLimit = 'BELOW_LIMIT',
+  hasMessageServiceId = 'MESSAGE_SERVICE_ID_OBTAINED',
+}
+
+export enum SMS_WARNING_TIERS {
+  LOW = 2500,
+  MED = 5000,
+  HIGH = 7500,
+}

src/app/models/__tests__/form.server.model.spec.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 import { ObjectId } from 'bson-ext'
-import { cloneDeep, map, merge, omit, orderBy, pick } from 'lodash'
+import { cloneDeep, map, merge, omit, orderBy, pick, range } from 'lodash'
 import mongoose, { Types } from 'mongoose'
 import {
   EMAIL_PUBLIC_FORM_FIELDS,
@@ -1802,6 +1802,131 @@ describe('Form Model', () => {
         await expect(Form.countDocuments()).resolves.toEqual(0)
       })
     })
+
+    describe('disableSmsVerificationsForUser', () => {
+      it('should disable sms verifications for all forms belonging to a user successfully', async () => {
+        // Arrange
+        const mockFormPromises = range(3).map(() => {
+          return Form.create({
+            admin: populatedAdmin._id,
+            responseMode: ResponseMode.Email,
+            title: 'mock mobile form',
+            emails: [populatedAdmin.email],
+            form_fields: [
+              generateDefaultField(BasicField.Mobile, { isVerifiable: true }),
+            ],
+          })
+        })
+        await Promise.all(mockFormPromises)
+
+        // Act
+        await Form.disableSmsVerificationsForUser(populatedAdmin._id)
+
+        // Assert
+        // Find all forms that match admin id
+        const updatedForms = await Form.find({ admin: populatedAdmin._id })
+        updatedForms.map(({ form_fields }) =>
+          form_fields!.map((field) => {
+            expect(field.isVerifiable).toBe(false)
+          }),
+        )
+      })
+
+      it('should not disable non mobile fields for a user', async () => {
+        // Arrange
+        const mockFormPromises = range(3).map(() => {
+          return Form.create({
+            admin: populatedAdmin._id,
+            responseMode: ResponseMode.Email,
+            title: 'mock email form',
+            emails: [populatedAdmin.email],
+            form_fields: [
+              generateDefaultField(BasicField.Email, { isVerifiable: true }),
+            ],
+          })
+        })
+        await Promise.all(mockFormPromises)
+
+        // Act
+        await Form.disableSmsVerificationsForUser(populatedAdmin._id)
+
+        // Assert
+        // Find all forms that match admin id
+        const updatedForms = await Form.find({ admin: populatedAdmin._id })
+        updatedForms.map(({ form_fields }) =>
+          form_fields!.map((field) => {
+            expect(field.isVerifiable).toBe(true)
+          }),
+        )
+      })
+
+      it('should only disable sms verifications for a particular user', async () => {
+        // Arrange
+        const MOCK_USER_ID = new ObjectId()
+        await dbHandler.insertFormCollectionReqs({
+          userId: MOCK_USER_ID,
+          mailDomain: 'something.com',
+        })
+        await Form.create({
+          admin: populatedAdmin._id,
+          responseMode: ResponseMode.Email,
+          title: 'mock email form',
+          emails: [populatedAdmin.email],
+          form_fields: [
+            generateDefaultField(BasicField.Mobile, { isVerifiable: true }),
+          ],
+        })
+        await Form.create({
+          admin: MOCK_USER_ID,
+          responseMode: ResponseMode.Email,
+          title: 'mock email form',
+          emails: [populatedAdmin.email],
+          form_fields: [
+            generateDefaultField(BasicField.Email, { isVerifiable: true }),
+          ],
+        })
+
+        // Act
+        await Form.disableSmsVerificationsForUser(populatedAdmin._id)
+
+        // Assert
+        // Find all forms that match admin id
+        const updatedMobileForm = await Form.find({ admin: populatedAdmin._id })
+        expect(updatedMobileForm[0]!.form_fields[0].isVerifiable).toBe(false)
+        const updatedEmailForm = await Form.find({ admin: MOCK_USER_ID })
+        expect(updatedEmailForm[0]!.form_fields[0].isVerifiable).toBe(true)
+      })
+
+      it('should not update when a db error occurs', async () => {
+        // Arrange
+        const disableSpy = jest.spyOn(Form, 'disableSmsVerificationsForUser')
+        disableSpy.mockResolvedValueOnce(new Error('tee hee db crashed'))
+        const mockFormPromises = range(3).map(() => {
+          return Form.create({
+            admin: populatedAdmin._id,
+            responseMode: ResponseMode.Email,
+            title: 'mock mobile form',
+            emails: [populatedAdmin.email],
+            form_fields: [
+              generateDefaultField(BasicField.Mobile, { isVerifiable: true }),
+            ],
+          })
+        })
+        await Promise.all(mockFormPromises)
+
+        // Act
+        await Form.disableSmsVerificationsForUser(populatedAdmin._id)
+
+        // Assert
+        // Find all forms that match admin id
+        const updatedForms = await Form.find({ admin: populatedAdmin._id })
+        updatedForms.map(({ form_fields }) =>
+          form_fields!.map((field) => {
+            expect(field.isVerifiable).toBe(true)
+          }),
+        )
+      })
+    })
   })
 
   describe('Methods', () => {

src/app/models/form.server.model.ts

@@ -808,6 +808,31 @@ const compileFormModel = (db: Mongoose): IFormModel => {
     ).exec()
   }
 
+  FormSchema.statics.disableSmsVerificationsForUser = async function (
+    userId: IUserSchema['_id'],
+  ) {
+    return this.updateMany(
+      // Filter the collection so that only specified user is selected
+      // Only update forms without message service name
+      // As it implies that those forms are using default (our) credentials
+      {
+        admin: userId,
+        msgSrvcName: {
+          $exists: false,
+        },
+      },
+      // Next, set the isVerifiable property for each field in form_fields
+      // Refer here for $[identifier] syntax: https://docs.mongodb.com/manual/reference/operator/update/positional-filtered/
+      { $set: { 'form_fields.$[field].isVerifiable': false } },
+      {
+        // Only set if the field has fieldType equal to mobile
+        arrayFilters: [{ 'field.fieldType': 'mobile' }],
+        // NOTE: Not updating the timestamp because we should preserve ordering due to user-level modifications
+        timestamps: false,
+      },
+    ).exec()
+  }
+
   // Hooks
   FormSchema.pre<IFormSchema>('validate', function (next) {
     // Reject save if form document is too large