Scheduling infrastructure for absolutely everyone.
fix: v2 bookings with sms reminders (#21191)
Lauris Skraucis7fc11ff34160
diff --git a/apps/api/v2/src/ee/bookings/2024-08-13/controllers/e2e/user-bookings.e2e-spec.ts b/apps/api/v2/src/ee/bookings/2024-08-13/controllers/e2e/user-bookings.e2e-spec.tsindex a3161cbd099..592e2aedaa6 100644--- a/apps/api/v2/src/ee/bookings/2024-08-13/controllers/e2e/user-bookings.e2e-spec.ts+++ b/apps/api/v2/src/ee/bookings/2024-08-13/controllers/e2e/user-bookings.e2e-spec.ts@@ -14,7 +14,7 @@ import { UsersModule } from "@/modules/users/users.module";import { INestApplication } from "@nestjs/common";import { NestExpressApplication } from "@nestjs/platform-express";import { Test } from "@nestjs/testing";-import { EventType, User } from "@prisma/client";+import { EventType, User, Workflow } from "@prisma/client";import { advanceTo, clear } from "jest-date-mock";import * as request from "supertest";import { BookingsRepositoryFixture } from "test/fixtures/repository/bookings.repository.fixture";@@ -22,6 +22,8 @@ import { EventTypesRepositoryFixture } from "test/fixtures/repository/event-typeimport { OAuthClientRepositoryFixture } from "test/fixtures/repository/oauth-client.repository.fixture";import { TeamRepositoryFixture } from "test/fixtures/repository/team.repository.fixture";import { UserRepositoryFixture } from "test/fixtures/repository/users.repository.fixture";+import { WorkflowReminderRepositoryFixture } from "test/fixtures/repository/workflow-reminder.repository.fixture";+import { WorkflowRepositoryFixture } from "test/fixtures/repository/workflow.repository.fixture";import { randomString } from "test/utils/randomString";import { withApiAuth } from "test/utils/withApiAuth";@@ -32,6 +34,7 @@ import {VERSION_2024_08_13,X_CAL_CLIENT_ID,} from "@calcom/platform-constants";+import { AttendeeScheduledEmail, OrganizerScheduledEmail } from "@calcom/platform-libraries/emails";import {CreateEventTypeInput_2024_06_14,FAILED_EVENT_TYPE_IDENTIFICATION_ERROR_MESSAGE,@@ -60,6 +63,8 @@ describe("Bookings Endpoints 2024-08-13", () => {let schedulesService: SchedulesService_2024_04_15;let eventTypesRepositoryFixture: EventTypesRepositoryFixture;let oauthClientRepositoryFixture: OAuthClientRepositoryFixture;+ let workflowReminderRepositoryFixture: WorkflowReminderRepositoryFixture;+ let workflowRepositoryFixture: WorkflowRepositoryFixture;let oAuthClient: PlatformOAuthClient;let teamRepositoryFixture: TeamRepositoryFixture;@@ -68,6 +73,8 @@ describe("Bookings Endpoints 2024-08-13", () => {let eventTypeId: number;let eventType: EventType;+ let eventTypeWithAttendeeSmsReminder: EventType;+ let workflow: Workflow;const eventTypeSlug = `user-bookings-event-type-${randomString()}`;let recurringEventTypeId: number;const recurringEventTypeSlug = `user-bookings-event-type-${randomString()}`;@@ -97,6 +104,8 @@ describe("Bookings Endpoints 2024-08-13", () => {oauthClientRepositoryFixture = new OAuthClientRepositoryFixture(moduleRef);teamRepositoryFixture = new TeamRepositoryFixture(moduleRef);schedulesService = moduleRef.get<SchedulesService_2024_04_15>(SchedulesService_2024_04_15);+ workflowReminderRepositoryFixture = new WorkflowReminderRepositoryFixture(moduleRef);+ workflowRepositoryFixture = new WorkflowRepositoryFixture(moduleRef);organization = await teamRepositoryFixture.create({name: `user-bookings-organization-${randomString()}`,@@ -177,6 +186,85 @@ describe("Bookings Endpoints 2024-08-13", () => {rating: 10,});+ workflow = await workflowRepositoryFixture.create({+ user: {+ connect: {+ id: user.id,+ },+ },+ trigger: "BEFORE_EVENT",+ time: 24,+ timeUnit: "HOUR",+ position: 0,+ isActiveOnAll: false,+ name: "Attendee SMS Reminder",+ steps: {+ create: {+ stepNumber: 1,+ action: "SMS_ATTENDEE",+ sendTo: null,+ reminderBody:+ "Hi {ATTENDEE}, this is a reminder that your meeting ({EVENT_NAME}) with {ORGANIZER} is on {EVENT_DATE_YYYY MMM D} at {EVENT_TIME_h:mma} {TIMEZONE}.",+ emailSubject: "Reminder: {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma}",+ template: "REMINDER",+ numberRequired: true,+ sender: "Cal",+ numberVerificationPending: false,+ includeCalendarEvent: false,+ verifiedAt: new Date(),+ },+ },+ });++ eventTypeWithAttendeeSmsReminder = await eventTypesRepositoryFixture.create(+ {+ title: "event with attendee sms reminder",+ slug: "event-with-attendee-sms-reminder",+ length: 15,+ bookingFields: [+ {+ name: "smsReminderNumber",+ type: "phone",+ sources: [+ {+ id: String(workflow.id),+ type: "workflow",+ label: "Workflow",+ editUrl: `/workflows/${workflow.id}`,+ fieldRequired: true,+ },+ ],+ editable: "system",+ required: true,+ defaultLabel: "number_text_notifications",+ defaultPlaceholder: "enter_phone_number",+ },+ ],+ metadata: {+ disableStandardEmails: {+ all: {+ attendee: true,+ host: true,+ },+ confirmation: {+ host: true,+ attendee: true,+ },+ },+ },+ workflows: {+ create: {+ workflow: {+ connect: {+ id: workflow.id,+ },+ },+ },+ },+ },+ user.id+ );+app = moduleRef.createNestApplication();bootstrap(app as NestExpressApplication);@@ -1668,7 +1756,6 @@ describe("Bookings Endpoints 2024-08-13", () => {describe("book by username and event type slug", () => {it("should not create a booking by if neither event type id nor username and event type slug provided", async () => {- const googleMeetUrl = "https://meet.google.com/abc-def-ghi";const body = {start: new Date(Date.UTC(2036, 0, 8, 15, 0, 0)).toISOString(),attendee: {@@ -1677,7 +1764,7 @@ describe("Bookings Endpoints 2024-08-13", () => {timeZone: "Europe/Rome",language: "it",},- location: googleMeetUrl,+ location: "https://meet.google.com/abc-def-ghi",bookingFieldsResponses: {customField: "customValue",},@@ -2227,6 +2314,91 @@ describe("Bookings Endpoints 2024-08-13", () => {});});+ describe("create booking with attendee sms reminder", () => {+ it("should not be able create a booking if attendee sms reminder is missing", async () => {+ const body: CreateBookingInput_2024_08_13 = {+ start: new Date(Date.UTC(2030, 0, 8, 15, 0, 0)).toISOString(),+ eventTypeId: eventTypeWithAttendeeSmsReminder.id,+ attendee: {+ name: "Mr Proper",+ email: "[email protected]",+ timeZone: "Europe/Rome",+ language: "it",+ },+ };++ const response = await request(app.getHttpServer())+ .post("/v2/bookings")+ .send(body)+ .set(CAL_API_VERSION_HEADER, VERSION_2024_08_13)+ .expect(400);++ expect(response.body.error.message).toEqual(+ `Missing attendee phone number - it is required by the event type. Pass it as \"attendee.phoneNumber\" string in the request.`+ );+ });++ it("should be able create a booking if attendee sms reminder is provided", async () => {+ const phoneNumber = "+37122222222";+ const body: CreateBookingInput_2024_08_13 = {+ start: new Date(Date.UTC(2030, 0, 8, 15, 0, 0)).toISOString(),+ eventTypeId: eventTypeWithAttendeeSmsReminder.id,+ attendee: {+ name: "Mr Proper",+ email: "[email protected]",+ timeZone: "Europe/Rome",+ language: "it",+ phoneNumber,+ },+ };++ const response = await request(app.getHttpServer())+ .post("/v2/bookings")+ .send(body)+ .set(CAL_API_VERSION_HEADER, VERSION_2024_08_13)+ .expect(201);++ const responseBody: CreateBookingOutput_2024_08_13 = response.body;+ expect(responseBody.status).toEqual(SUCCESS_STATUS);+ expect(responseBody.data).toBeDefined();+ expect(responseDataIsBooking(responseBody.data)).toBe(true);++ if (responseDataIsBooking(responseBody.data)) {+ const data: BookingOutput_2024_08_13 = responseBody.data;+ expect(data.id).toBeDefined();+ expect(data.uid).toBeDefined();+ expect(data.hosts.length).toEqual(1);+ expect(data.hosts[0].id).toEqual(user.id);+ expect(data.status).toEqual("accepted");+ expect(data.start).toEqual(body.start);+ expect(data.end).toEqual(new Date(Date.UTC(2030, 0, 8, 15, 15, 0)).toISOString());+ expect(data.duration).toEqual(15);+ expect(data.eventTypeId).toEqual(eventTypeWithAttendeeSmsReminder.id);+ expect(data.attendees.length).toEqual(1);+ expect(data.attendees[0]).toEqual({+ name: body.attendee.name,+ email: body.attendee.email,+ timeZone: body.attendee.timeZone,+ language: body.attendee.language,+ phoneNumber: body.attendee.phoneNumber,+ absent: false,+ });+ expect(data.bookingFieldsResponses).toEqual({+ name: body.attendee.name,+ email: body.attendee.email,+ attendeePhoneNumber: body.attendee.phoneNumber,+ smsReminderNumber: body.attendee.phoneNumber,+ });+ const dbBooking = await bookingsRepositoryFixture.getById(data.id);+ expect(dbBooking?.smsReminderNumber).toEqual(phoneNumber);+ const dbWorkflowReminder = await workflowReminderRepositoryFixture.getByBookingUid(data.uid);+ expect(dbWorkflowReminder?.method).toEqual("SMS");+ } else {+ throw new Error("Invalid response data");+ }+ });+ });+function responseDataIsRecurranceBooking(data: any): data is RecurringBookingOutput_2024_08_13 {return (!Array.isArray(data) &&diff --git a/apps/api/v2/src/ee/bookings/2024-08-13/services/bookings.service.ts b/apps/api/v2/src/ee/bookings/2024-08-13/services/bookings.service.tsindex 59fae0af57a..9340b4fa423 100644--- a/apps/api/v2/src/ee/bookings/2024-08-13/services/bookings.service.ts+++ b/apps/api/v2/src/ee/bookings/2024-08-13/services/bookings.service.ts@@ -66,7 +66,7 @@ const eventTypeBookingFieldSchema = z.object({editable: z.string(),});-const eventTypeBookingFieldsSchema = z.array(eventTypeBookingFieldSchema);+export const eventTypeBookingFieldsSchema = z.array(eventTypeBookingFieldSchema);export type EventTypeWithOwnerAndTeam = EventType & { owner: User | null; team: Team | null };@@ -172,25 +172,30 @@ export class BookingsService_2024_08_13 {}async hasRequiredBookingFieldsResponses(body: CreateBookingInput, eventType: EventType | null) {- const bookingFields = { ...body.bookingFieldsResponses, attendeePhoneNumber: body.attendee.phoneNumber };+ const bookingFields: Record<string, unknown> = {+ ...body.bookingFieldsResponses,+ attendeePhoneNumber: body.attendee.phoneNumber,+ smsReminderNumber: body.attendee.phoneNumber,+ };if (!eventType?.bookingFields) {return true;}- // note(Lauris): we filter out system fields, because some of them are set by default and name and email are passed in the body.attendee+ // note(Lauris): we filter out system fields, because some of them are set by default and name and email are passed in the body.attendee. Only exception+ // is smsReminderNumber, because if it is required and not passed sms workflow won't work.const eventTypeBookingFields = eventTypeBookingFieldsSchema.parse(eventType.bookingFields)- .filter((field) => !field.editable.startsWith("system"));+ .filter((field) => !field.editable.startsWith("system") || field.name === "smsReminderNumber");if (!eventTypeBookingFields.length) {return true;}for (const field of eventTypeBookingFields) {- if (field.required && !(field.name in bookingFields)) {- if (field.name === "attendeePhoneNumber") {+ if (field.required && (bookingFields[field.name] === null || bookingFields[field.name] === undefined)) {+ if (field.name === "attendeePhoneNumber" || field.name === "smsReminderNumber") {throw new BadRequestException(- `Missing attendee phone number - it is required by the event type. Pass it as "attendee.phoneNumber" in the request.`+ `Missing attendee phone number - it is required by the event type. Pass it as "attendee.phoneNumber" string in the request.`);}throw new BadRequestException(diff --git a/apps/api/v2/src/ee/bookings/2024-08-13/services/input.service.ts b/apps/api/v2/src/ee/bookings/2024-08-13/services/input.service.tsindex fdb8fa265da..b0082396358 100644--- a/apps/api/v2/src/ee/bookings/2024-08-13/services/input.service.ts+++ b/apps/api/v2/src/ee/bookings/2024-08-13/services/input.service.ts@@ -1,5 +1,8 @@import { BookingsRepository_2024_08_13 } from "@/ee/bookings/2024-08-13/bookings.repository";-import { EventTypeWithOwnerAndTeam } from "@/ee/bookings/2024-08-13/services/bookings.service";+import {+ eventTypeBookingFieldsSchema,+ EventTypeWithOwnerAndTeam,+} from "@/ee/bookings/2024-08-13/services/bookings.service";import {bookingResponsesSchema,seatedBookingDataSchema,@@ -159,6 +162,12 @@ export class InputBookingsService_2024_08_13 {this.isBookingLocationWithEventTypeLocations(inputLocation, eventType);const location = inputLocation ? this.transformLocation(inputLocation) : undefined;+ const needsSmsReminderNumber = eventType.bookingFields+ ? eventTypeBookingFieldsSchema+ .parse(eventType.bookingFields)+ .find((field) => field.name === "smsReminderNumber")+ : undefined;+return {start: startTime.toISO(),end: endTime.toISO(),@@ -174,6 +183,7 @@ export class InputBookingsService_2024_08_13 {name: inputBooking.attendee.name,email: attendeeEmail ?? "",attendeePhoneNumber: inputBooking.attendee.phoneNumber,+ smsReminderNumber: needsSmsReminderNumber ? inputBooking.attendee.phoneNumber : undefined,guests,location,},diff --git a/apps/api/v2/test/fixtures/repository/workflow-reminder.repository.fixture.ts b/apps/api/v2/test/fixtures/repository/workflow-reminder.repository.fixture.tsnew file mode 100644index 00000000000..b9532176766--- /dev/null+++ b/apps/api/v2/test/fixtures/repository/workflow-reminder.repository.fixture.ts@@ -0,0 +1,17 @@+import { PrismaReadService } from "@/modules/prisma/prisma-read.service";+import { PrismaWriteService } from "@/modules/prisma/prisma-write.service";+import { TestingModule } from "@nestjs/testing";++export class WorkflowReminderRepositoryFixture {+ private prismaReadClient: PrismaReadService["prisma"];+ private prismaWriteClient: PrismaWriteService["prisma"];++ constructor(private readonly module: TestingModule) {+ this.prismaReadClient = module.get(PrismaReadService).prisma;+ this.prismaWriteClient = module.get(PrismaWriteService).prisma;+ }++ async getByBookingUid(uid: string) {+ return this.prismaReadClient.workflowReminder.findFirst({ where: { bookingUid: uid } });+ }+}diff --git a/apps/api/v2/test/fixtures/repository/workflow.repository.fixture.ts b/apps/api/v2/test/fixtures/repository/workflow.repository.fixture.tsnew file mode 100644index 00000000000..4b797a37666--- /dev/null+++ b/apps/api/v2/test/fixtures/repository/workflow.repository.fixture.ts@@ -0,0 +1,23 @@+import { PrismaReadService } from "@/modules/prisma/prisma-read.service";+import { PrismaWriteService } from "@/modules/prisma/prisma-write.service";+import { TestingModule } from "@nestjs/testing";++import { Prisma } from "@calcom/prisma/client";++export class WorkflowRepositoryFixture {+ private prismaReadClient: PrismaReadService["prisma"];+ private prismaWriteClient: PrismaWriteService["prisma"];++ constructor(private readonly module: TestingModule) {+ this.prismaReadClient = module.get(PrismaReadService).prisma;+ this.prismaWriteClient = module.get(PrismaWriteService).prisma;+ }++ async create(data: Prisma.WorkflowCreateInput) {+ return this.prismaWriteClient.workflow.create({ data });+ }++ async delete(id: number) {+ return this.prismaWriteClient.workflow.delete({ where: { id } });+ }+}