test: add unit tests for sms sending

apps/web/test/fixtures/fixtures.ts

@@ -2,19 +2,30 @@
 import { test as base } from "vitest";
 
 import { getTestEmails } from "@calcom/lib/testEmails";
+import { getTestSMS } from "@calcom/lib/testSMS";
 
 export interface Fixtures {
   emails: ReturnType<typeof getEmailsFixture>;
+  sms: ReturnType<typeof getSMSFixture>;
 }
 
 export const test = base.extend<Fixtures>({
   emails: async ({}, use) => {
     await use(getEmailsFixture());
   },
+  sms: async ({}, use) => {
+    await use(getSMSFixture());
+  },
 });
 
 function getEmailsFixture() {
   return {
     get: getTestEmails,
   };
 }
+
+function getSMSFixture() {
+  return {
+    get: getTestSMS,
+  };
+}

apps/web/test/utils/bookingScenario/bookingScenario.ts

@@ -19,7 +19,7 @@ import logger from "@calcom/lib/logger";
 import { safeStringify } from "@calcom/lib/safeStringify";
 import { ProfileRepository } from "@calcom/lib/server/repository/profile";
 import type { WorkflowActions, WorkflowTemplates, WorkflowTriggerEvents } from "@calcom/prisma/client";
-import type { SchedulingType } from "@calcom/prisma/enums";
+import type { SchedulingType, SMSLockState } from "@calcom/prisma/enums";
 import type { BookingStatus } from "@calcom/prisma/enums";
 import type { teamMetadataSchema } from "@calcom/prisma/zod-utils";
 import type { userMetadataType } from "@calcom/prisma/zod-utils";
@@ -952,6 +952,7 @@ export function getOrganizer({
   teams,
   organizationId,
   metadata,
+  smsLockState,
 }: {
   name: string;
   email: string;
@@ -965,6 +966,7 @@ export function getOrganizer({
   weekStart?: WeekDays;
   teams?: InputUser["teams"];
   metadata?: userMetadataType;
+  smsLockState?: SMSLockState;
 }) {
   return {
     ...TestData.users.example,
@@ -981,6 +983,7 @@ export function getOrganizer({
     organizationId,
     profiles: [],
     metadata,
+    smsLockState,
   };
 }
 

apps/web/test/utils/bookingScenario/expects.ts

@@ -170,7 +170,7 @@
         pass: false,
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         //@ts-ignore
         actual: icsObject[icsKey].uid!,
         expected: expectedEmail.ics?.iCalUID,
         message: () => `Expected ICS UID ${isNot ? "is" : "isn't"} present in actual`,
       };
@@ -307,38 +307,72 @@
 
 export function expectWorkflowToBeTriggered({
   emails,
-  organizer,
-  destinationEmail,
+  emailsToReceive,
 }: {
   emails: Fixtures["emails"];
-  organizer: { email: string; name: string; timeZone: string };
-  destinationEmail?: string;
+  emailsToReceive: string[];
 }) {
   const subjectPattern = /^Reminder: /i;
-  expect(emails.get()).toEqual(
-    expect.arrayContaining([
-      expect.objectContaining({
-        subject: expect.stringMatching(subjectPattern),
-        to: destinationEmail ?? organizer.email,
-      }),
-    ])
-  );
+  emailsToReceive.forEach((email) => {
+    expect(emails.get()).toEqual(
+      expect.arrayContaining([
+        expect.objectContaining({
+          subject: expect.stringMatching(subjectPattern),
+          to: email,
+        }),
+      ])
+    );
+  });
 }
 
 export function expectWorkflowToBeNotTriggered({
   emails,
-  organizer,
+  emailsToReceive,
 }: {
   emails: Fixtures["emails"];
-  organizer: { email: string; name: string; timeZone: string };
+  emailsToReceive: string[];
 }) {
   const subjectPattern = /^Reminder: /i;
 
-  expect(emails.get()).not.toEqual(
+  emailsToReceive.forEach((email) => {
+    expect(emails.get()).not.toEqual(
+      expect.arrayContaining([
+        expect.objectContaining({
+          subject: expect.stringMatching(subjectPattern),
+          to: email,
+        }),
+      ])
+    );
+  });
+}
+
+export function expectSMSWorkflowToBeTriggered({
+  sms,
+  toNumber,
+}: {
+  sms: Fixtures["sms"];
+  toNumber: string;
+}) {
+  expect(sms.get()).toEqual(
+    expect.arrayContaining([
+      expect.objectContaining({
+        to: toNumber,
+      }),
+    ])
+  );
+}
+
+export function expectSMSWorkflowToBeNotTriggered({
+  sms,
+  toNumber,
+}: {
+  sms: Fixtures["sms"];
+  toNumber: string;
+}) {
+  expect(sms.get()).not.toEqual(
     expect.arrayContaining([
       expect.objectContaining({
-        subject: expect.stringMatching(subjectPattern),
-        to: organizer.email,
+        to: toNumber,
       }),
     ])
   );
@@ -735,7 +769,7 @@
   booker,
   booking,
   bookNewTimePath,
   organizer,
 }: {
   emails: Fixtures["emails"];
   organizer: ReturnType<typeof getOrganizer>;

apps/web/test/utils/bookingScenario/getMockRequestDataForBooking.ts

@@ -30,6 +30,7 @@ export function getMockRequestDataForBooking({
       email: string;
       name: string;
       location: { optionValue: ""; value: string };
+      smsReminderNumber?: string;
     };
   };
 }) {

apps/web/test/utils/bookingScenario/test.ts

@@ -15,7 +15,7 @@ const _testWithAndWithoutOrg = (
   const t = mode === "only" ? test.only : mode === "skip" ? test.skip : test;
   t(
     `${description} - With org`,
-    async ({ emails, meta, task, onTestFailed, expect, skip }) => {
+    async ({ emails, sms, meta, task, onTestFailed, expect, skip }) => {
       const org = await createOrganization({
         name: "Test Org",
         slug: "testorg",
@@ -27,6 +27,7 @@ const _testWithAndWithoutOrg = (
         onTestFailed,
         expect,
         emails,
+        sms,
         skip,
         org: {
           organization: org,
@@ -39,9 +40,10 @@ const _testWithAndWithoutOrg = (
 
   t(
     `${description}`,
-    async ({ emails, meta, task, onTestFailed, expect, skip }) => {
+    async ({ emails, sms, meta, task, onTestFailed, expect, skip }) => {
       await fn({
         emails,
+        sms,
         meta,
         task,
         onTestFailed,

packages/features/bookings/lib/handleNewBooking/test/fresh-booking.test.ts

@@ -42,6 +42,7 @@ import {
 import { createMockNextJsRequest } from "@calcom/web/test/utils/bookingScenario/createMockNextJsRequest";
 import {
   expectWorkflowToBeTriggered,
+  expectWorkflowToBeNotTriggered,
   expectSuccessfulBookingCreationEmails,
   expectBookingToBeInDatabase,
   expectAwaitingPaymentEmails,
@@ -51,7 +52,6 @@ import {
   expectBookingPaymentIntiatedWebhookToHaveBeenFired,
   expectBrokenIntegrationEmails,
   expectSuccessfulCalendarEventCreationInCalendar,
-  expectWorkflowToBeNotTriggered,
   expectICalUIDAsString,
 } from "@calcom/web/test/utils/bookingScenario/expects";
 import { getMockRequestDataForBooking } from "@calcom/web/test/utils/bookingScenario/getMockRequestDataForBooking";
@@ -215,9 +215,8 @@ describe("handleNewBooking", () => {
         });
 
         expectWorkflowToBeTriggered({
-          organizer,
+          emailsToReceive: [organizerDestinationCalendarEmailOnEventType],
           emails,
-          destinationEmail: organizerDestinationCalendarEmailOnEventType,
         });
         expectSuccessfulCalendarEventCreationInCalendar(calendarMock, {
           calendarId: "event-type-1@google-calendar.com",
@@ -379,7 +378,7 @@ describe("handleNewBooking", () => {
             iCalUID: createdBooking.iCalUID,
           });
 
-          expectWorkflowToBeTriggered({ organizer, emails });
+          expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
           expectSuccessfulCalendarEventCreationInCalendar(calendarMock, {
             videoCallUrl: "http://mock-dailyvideo.example.com/meeting-1",
             // We won't be sending evt.destinationCalendar in this case.
@@ -541,7 +540,7 @@ describe("handleNewBooking", () => {
             iCalUID: createdBooking.iCalUID,
           });
 
-          expectWorkflowToBeTriggered({ organizer, emails });
+          expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
           expectSuccessfulCalendarEventCreationInCalendar(calendarMock, {
             calendarId: "organizer@google-calendar.com",
             videoCallUrl: "http://mock-dailyvideo.example.com/meeting-1",
@@ -675,7 +674,7 @@ describe("handleNewBooking", () => {
             ],
           });
 
-          expectWorkflowToBeTriggered({ organizer, emails });
+          expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
 
           // FIXME: We should send Broken Integration emails on calendar event creation failure
           // expectCalendarEventCreationFailureEmails({ booker, organizer, emails });
@@ -825,7 +824,7 @@ describe("handleNewBooking", () => {
             iCalUID: createdBooking.iCalUID,
           });
 
-          expectWorkflowToBeTriggered({ organizer, emails });
+          expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
 
           expectSuccessfulCalendarEventCreationInCalendar(calendarMock, {
             calendarId: "organizer@google-calendar.com",
@@ -982,7 +981,7 @@ describe("handleNewBooking", () => {
             ],
           });
 
-          expectWorkflowToBeTriggered({ organizer, emails });
+          expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
           expectSuccessfulCalendarEventCreationInCalendar(calendarMock, {
             calendarId: "organizer@google-calendar.com",
             videoCallUrl: "http://mock-dailyvideo.example.com/meeting-1",
@@ -1511,7 +1510,7 @@ describe("handleNewBooking", () => {
             status: BookingStatus.PENDING,
           });
 
-          expectWorkflowToBeNotTriggered({ organizer, emails });
+          expectWorkflowToBeNotTriggered({ emailsToReceive: [organizer.email], emails });
 
           expectBookingRequestedEmails({
             booker,
@@ -1636,7 +1635,7 @@ describe("handleNewBooking", () => {
             }),
           });
 
-          expectWorkflowToBeNotTriggered({ organizer, emails });
+          expectWorkflowToBeNotTriggered({ emailsToReceive: [organizer.email], emails });
 
           expectBookingRequestedEmails({
             booker,
@@ -1764,7 +1763,7 @@ describe("handleNewBooking", () => {
             iCalUID: createdBooking.iCalUID,
           });
 
-          expectWorkflowToBeTriggered({ organizer, emails });
+          expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
 
           const iCalUID = expectICalUIDAsString(createdBooking.iCalUID);
 
@@ -1897,7 +1896,7 @@ describe("handleNewBooking", () => {
             iCalUID: createdBooking.iCalUID,
           });
 
-          expectWorkflowToBeNotTriggered({ organizer, emails });
+          expectWorkflowToBeNotTriggered({ emailsToReceive: [organizer.email], emails });
 
           expectBookingRequestedEmails({ booker, organizer, emails });
 
@@ -2076,7 +2075,7 @@ describe("handleNewBooking", () => {
           iCalUID: createdBooking.iCalUID,
         });
 
-        expectWorkflowToBeTriggered({ organizer, emails });
+        expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
 
         const iCalUID = expectICalUIDAsString(createdBooking.iCalUID);
 
@@ -2220,7 +2219,7 @@ describe("handleNewBooking", () => {
             }),
           });
 
-          expectWorkflowToBeNotTriggered({ organizer, emails });
+          expectWorkflowToBeNotTriggered({ emailsToReceive: [organizer.email], emails });
 
           expectAwaitingPaymentEmails({ organizer, booker, emails });
 
@@ -2244,7 +2243,7 @@ describe("handleNewBooking", () => {
             status: BookingStatus.ACCEPTED,
           });
 
-          expectWorkflowToBeTriggered({ organizer, emails });
+          expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
 
           expectBookingCreatedWebhookToHaveBeenFired({
             booker,
@@ -2374,7 +2373,7 @@ describe("handleNewBooking", () => {
             status: BookingStatus.PENDING,
           });
 
-          expectWorkflowToBeNotTriggered({ organizer, emails });
+          expectWorkflowToBeNotTriggered({ emailsToReceive: [organizer.email], emails });
 
           expectAwaitingPaymentEmails({ organizer, booker, emails });
           expectBookingPaymentIntiatedWebhookToHaveBeenFired({

packages/features/bookings/lib/handleNewBooking/test/reschedule.test.ts

@@ -240,7 +240,7 @@ describe("handleNewBooking", () => {
               ],
             },
           });
-          expectWorkflowToBeTriggered({ emails, organizer });
+          expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
 
           expectSuccessfulVideoMeetingUpdationInCalendar(videoMock, {
             calEvent: {
@@ -459,7 +459,7 @@ describe("handleNewBooking", () => {
             },
           });
 
-          expectWorkflowToBeTriggered({ emails, organizer });
+          expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
 
           expectSuccessfulVideoMeetingUpdationInCalendar(videoMock, {
             calEvent: {
@@ -656,7 +656,7 @@ describe("handleNewBooking", () => {
             },
           });
 
-          expectWorkflowToBeTriggered({ emails, organizer });
+          expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
 
           // FIXME: We should send Broken Integration emails on calendar event updation failure
           // expectBrokenIntegrationEmails({ booker, organizer, emails });
@@ -850,7 +850,7 @@ describe("handleNewBooking", () => {
               },
             });
 
-            expectWorkflowToBeTriggered({ emails, organizer });
+            expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
 
             expectBookingRequestedEmails({
               booker,
@@ -1085,7 +1085,7 @@ describe("handleNewBooking", () => {
               },
             });
 
-            expectWorkflowToBeTriggered({ emails, organizer });
+            expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
 
             expectSuccessfulVideoMeetingUpdationInCalendar(videoMock, {
               calEvent: {
@@ -1312,7 +1312,7 @@ describe("handleNewBooking", () => {
               },
             });
 
-            //expectWorkflowToBeTriggered({emails, organizer});
+            //expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
 
             expectBookingRequestedEmails({
               booker,
@@ -1559,7 +1559,7 @@ describe("handleNewBooking", () => {
               },
             });
 
-            expectWorkflowToBeTriggered({ emails, organizer });
+            expectWorkflowToBeTriggered({ emailsToReceive: [organizer.email], emails });
 
             expectSuccessfulVideoMeetingUpdationInCalendar(videoMock, {
               calEvent: {