chore: Create `BookingCreatedService` CAL-[5026] #18516

joeauyeung · 2025-01-08T03:40:25Z

What does this PR do?

Aims to abstract post booking created code from handleNewBooking into a new class BookingListener
This PR starts with creating a .create() method on the BookingListener
The follow post booking actions are added to the method
- Video link creation
- Calendar event creation
- Writing to CRM
- Sending/scheduling webhooks
- Sending/scheduling workflows
Fixes #XXXX (GitHub issue number)
Fixes CAL-XXXX (Linear issue number - should be visible at the bottom of the GitHub issue description)

Mandatory Tasks (DO NOT REMOVE)

I have self-reviewed the code (A decent size PR without self-review might be rejected).
I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

Create a booking that does the following
- Has a dynamic video link
- Connected to a calendar
- Sends data to a CRM
- Sends a webhook
- Sends a workflow

…mmediately

keithwillcode · 2025-01-08T21:00:20Z

packages/features/bookings/lib/handleNewBooking.ts

-    referencesToCreate = createManager.referencesToCreate;
-    videoCallUrl = evt.videoCallData && evt.videoCallData.url ? evt.videoCallData.url : null;
+    if (!isDryRun) {
+      await BookingListener.create({


BookingListener.create() reads weird. If it’s a listener, why is it creating anything?

Seems like we need to switch to the pub/sub naming convention.

BookingPublisher/BookingSubscriber

Or BookingService

I see the confusion. .create() refers to when a booking is created. I'm hoping to add BookingListener.reschedule(), BookingListener.cancel().

I was debating on BookingListener.bookingCreated(), would that be clearer?

No. It's the fact that it's called BookingListener. Typically classes with name Listener don't have functions like .create() or .reschedule(). They are typically just .listen()

If you plan to add those functions, BookingService operating as an application service makes a lot more sense.

In fact, in many big systems like ours with complex code, a service per operation is sometimes preferred. e.g. BookingCreationService, BookingRescheduleService, etc.

joeauyeung · 2025-01-08T20:12:26Z

packages/features/bookings/lib/handleNewBooking.ts

-    results = createManager.results;
-    referencesToCreate = createManager.referencesToCreate;
-    videoCallUrl = evt.videoCallData && evt.videoCallData.url ? evt.videoCallData.url : null;
+    if (!isDryRun) {


A benefit is we don't have to wrap (!isDryRun) around multiple functions.

joeauyeung · 2025-01-08T20:16:35Z

packages/features/bookings/lib/handleNewBooking.ts

-          );
-        }
-      }
+      return {


Once the post booking actions are taken we can return

joeauyeung · 2025-01-08T20:17:22Z

packages/features/bookings/lib/handleNewBooking.ts

Note some post booking functions we need to keep in handleNewBooking as they're being used for rescheduled bookings, payments, and setting up bookings that require confirmation.

joeauyeung · 2025-01-08T20:17:58Z

packages/features/bookings/lib/handleNewBooking.ts

      };

-      loggerWithEventDetails.error(
-        `EventManager.create failure in some of the integrations ${organizerUser.username}`,


All of the following removed code can be moved to the BookingListener

joeauyeung · 2025-01-08T20:18:17Z

packages/features/bookings/lib/handleNewBooking.ts

@@ -1832,67 +1710,8 @@ async function handler(

  loggerWithEventDetails.debug(`Booking ${organizerUser.username} completed`);

-  // We are here so, booking doesn't require payment and booking is also created in DB already, through createBooking call
-  if (isConfirmedByDefault) {


These calls are moved to the booking listener

joeauyeung · 2025-01-08T20:19:12Z

packages/features/bookings/lib/handleNewBooking/createBooking.ts

+    noEmail?: NoEmail;
+    reqAppsStatus?: ReqAppsStatus;


These properties only exist in handleNewBooking although we'll need to access these in the tasker.

joeauyeung · 2025-01-08T20:20:14Z

packages/features/bookings/lib/handleNewBooking/handleAppsStatus.ts

+    return calculateAggregatedAppsStatus(reqAppsStatus, resultStatus);
+  }
+
+  return resultStatus;


In updateBookingWithStatus the resultStatus is returned

joeauyeung · 2025-01-08T20:20:56Z

packages/features/bookings/lib/handleSeats/handleSeats.ts

@@ -108,6 +110,13 @@ const handleSeats = async (newSeatedBookingObject: NewSeatedBookingObject) => {
      ...reqBodyMetadata,
    };
    try {
+      const workflows = await getAllWorkflowsFromEventType(


Moved getAllWorkflowsFromEventType from being called in handleNewBooking to either being called in handleSeats or BookingListener.create()

joeauyeung · 2025-01-08T21:30:48Z

packages/features/bookings/lib/handleNewBooking.ts

-    referencesToCreate = createManager.referencesToCreate;
-    videoCallUrl = evt.videoCallData && evt.videoCallData.url ? evt.videoCallData.url : null;
+    if (!isDryRun) {
+      await BookingListener.create({


I see the confusion. .create() refers to when a booking is created. I'm hoping to add BookingListener.reschedule(), BookingListener.cancel().

I was debating on BookingListener.bookingCreated(), would that be clearer?

vercel · 2025-01-08T21:47:58Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
cal	⬜️ Ignored (Inspect)	Visit Preview		Jan 13, 2025 3:55am
calcom-web-canary	⬜️ Ignored (Inspect)	Visit Preview		Jan 13, 2025 3:55am

joeauyeung added 13 commits January 7, 2025 22:35

Add bookingListener create method, EventManager and email

b1a51c5

Add noEmail and reqAPpsStatus to booking metadata

2fef90c

Make ReqAppsStatus optional in handleAppsStatus

3cbac75

Update booking metadata with noEmails and appsStatus

87847d7

getAllWorkflowsFromEventType doesn't require event type workflows i…

d17d46a

…mmediately

Move workflows query to bookingListener and handleSeats

49de8f7

Implement booking listener for apps and emails

c1ffead

type fix

c1b1d07

Trigger webhooks

bcb2e05

Add scheduling workflows and no show triggers

2729c19

Early return after bookingListener is called

b5dc33f

Create booking references

e3bb00c

Create create input type

79b746e

keithwillcode added consumer core area: core, team members only labels Jan 8, 2025

vercel bot had a problem deploying to Preview – api January 8, 2025 03:44 Failure

joeauyeung mentioned this pull request Jan 8, 2025

chore: Create booking listener #18514

Closed

3 tasks

keithwillcode reviewed Jan 8, 2025

View reviewed changes

joeauyeung commented Jan 8, 2025

View reviewed changes

Add back commented logic

c468fd6

vercel bot had a problem deploying to Preview – api January 8, 2025 21:52 Failure

joeauyeung added 2 commits January 9, 2025 13:36

Rename to BookingCreatedService

3881fc6

Type fixes

f0abaf5

vercel bot had a problem deploying to Preview – api January 9, 2025 19:00 Failure

Type fixes

5d3a99c

joeauyeung changed the title ~~chore: Create BookingListener and .create method~~ chore: Create BookingCreatedService Jan 9, 2025

vercel bot deployed to Preview – api January 9, 2025 19:56 View deployment

Fix schema

c92fdb9

vercel bot deployed to Preview – api January 9, 2025 21:25 View deployment

joeauyeung added 2 commits January 12, 2025 22:54

Merge branch 'main' into create-booking-listener-2

37b83cd

add changes from #18202

71d7b4e

vercel bot had a problem deploying to Preview – api January 13, 2025 04:06 Failure

joeauyeung changed the title ~~chore: Create BookingCreatedService~~ chore: Create BookingCreatedService CAL-[5026] Jan 15, 2025

joeauyeung linked an issue Jan 15, 2025 that may be closed by this pull request

[CAL-5026] Create BookingCreatedService #18671

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Create `BookingCreatedService` CAL-[5026] #18516

chore: Create `BookingCreatedService` CAL-[5026] #18516

joeauyeung commented Jan 8, 2025 •

edited

Loading

keithwillcode Jan 8, 2025

keithwillcode Jan 8, 2025

joeauyeung Jan 8, 2025

keithwillcode Jan 8, 2025

keithwillcode Jan 8, 2025

keithwillcode Jan 8, 2025 •

edited

Loading

joeauyeung Jan 8, 2025

joeauyeung Jan 8, 2025

joeauyeung Jan 8, 2025

joeauyeung Jan 8, 2025

joeauyeung Jan 8, 2025

joeauyeung Jan 8, 2025

joeauyeung Jan 8, 2025

joeauyeung Jan 8, 2025

joeauyeung Jan 8, 2025

vercel bot commented Jan 8, 2025 •

edited

Loading

chore: Create BookingCreatedService CAL-[5026] #18516

Are you sure you want to change the base?

chore: Create BookingCreatedService CAL-[5026] #18516

Conversation

joeauyeung commented Jan 8, 2025 • edited Loading

What does this PR do?

Mandatory Tasks (DO NOT REMOVE)

How should this be tested?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

keithwillcode Jan 8, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented Jan 8, 2025 • edited Loading

chore: Create `BookingCreatedService` CAL-[5026] #18516

chore: Create `BookingCreatedService` CAL-[5026] #18516

joeauyeung commented Jan 8, 2025 •

edited

Loading

keithwillcode Jan 8, 2025 •

edited

Loading

vercel bot commented Jan 8, 2025 •

edited

Loading