Files
calendar/packages/features/webhooks/lib/service/WebhookTaskConsumer.ts
T
Syed Ali ShahbazGitHubDevin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>Hariom Balhara
5d65df9c05 chore: migrate booking requested webhook trigger (#27546)
* init

* wiring up

* fix type

* feat: implement DI pattern for webhook producer in API v2

- Export IWebhookProducerService and getWebhookProducer from platform-libraries
- Add WEBHOOK_PRODUCER token and useFactory provider in RegularBookingModule
- Inject webhookProducer in RegularBookingService and pass to base class

This follows the composition root pattern where only the NestJS module
knows about getWebhookProducer(), and all consumers depend only on the
IWebhookProducerService interface via constructor injection.

Co-Authored-By: ali@cal.com <alishahbaz7@gmail.com>

* test: migrate BOOKING_REQUESTED tests to new webhook architecture

- Remove failing BOOKING_REQUESTED tests from fresh-booking.test.ts (4 tests)
- Remove failing BOOKING_REQUESTED tests from reschedule.test.ts (2 tests)
- Remove failing BOOKING_REQUESTED test from collective-scheduling.test.ts (1 test)
- Replace WebhookTaskConsumer.test.ts with placeholder (constructor changed)
- Create new webhook architecture test suite:
  - producer/WebhookTaskerProducerService.test.ts (14 tests)
  - consumer/WebhookTaskConsumer.test.ts (8 tests)
  - consumer/triggers/booking-requested.test.ts (8 tests)

The new test suite is organized by trigger type for extensibility as more
triggers are migrated to the producer/consumer pattern.

Co-Authored-By: ali@cal.com <alishahbaz7@gmail.com>

* test: remove paid events BOOKING_REQUESTED test (moved to new architecture)

Co-Authored-By: ali@cal.com <alishahbaz7@gmail.com>

* wrap webhook in own try-catch

* wire datafetcher

* fix

* fix v2

* fix circular dependency

* --

* merge-conflict-resolve

* mreg-conflict-resolve

* remove early return

* test: add integration tests for BOOKING_REQUESTED webhook producer invocation

Cover all 8 scenarios verifying the booking flow correctly invokes
the webhook producer for BOOKING_REQUESTED:

1. Basic confirmation → queueBookingRequestedWebhook called
2. Booker-is-organizer + confirmation → still called
3. Confirmation threshold NOT met → not called (BOOKING_CREATED instead)
4. Confirmation threshold IS met → called
5. Paid event + confirmation → called after payment succeeds
6. Reschedule + confirmation (non-organizer) → called (not BOOKING_RESCHEDULED)
7. Reschedule + confirmation (organizer) → not called (BOOKING_RESCHEDULED instead)
8. Collective scheduling + confirmation → called

Adds reusable MockWebhookProducer helper in @calcom/testing for
extendable use as more webhook triggers migrate to the new architecture.

Co-Authored-By: ali@cal.com <alishahbaz7@gmail.com>

* fix bug

* fix conditional check

* remove unnecessary comment

* add missing expect

* remove empty test

* clean up

* tasker config

* --

* fix missing metadata

* remove faulty if else

* test: add payload content verification tests for BOOKING_REQUESTED webhook

Co-Authored-By: ali@cal.com <alishahbaz7@gmail.com>

* remove unnecessary tests

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: Hariom Balhara <1780212+hariombalhara@users.noreply.github.com>
2026-02-19 20:21:26 +04:00

216 lines
7.3 KiB
TypeScript

import type { BookingForCalEventBuilder } from "@calcom/features/CalendarEventBuilder";
import { WebhookTriggerEvents } from "@calcom/prisma/enums";
import type { CalendarEvent } from "@calcom/types/Calendar";
import type { WebhookEventDTO, WebhookSubscriber } from "../dto/types";
import type { PayloadBuilderFactory } from "../factory/versioned/PayloadBuilderFactory";
import type { IWebhookDataFetcher } from "../interface/IWebhookDataFetcher";
import type { IWebhookRepository } from "../interface/IWebhookRepository";
import { DEFAULT_WEBHOOK_VERSION } from "../interface/IWebhookRepository";
import type { ILogger } from "../interface/infrastructure";
import type { IWebhookService } from "../interface/services";
import type {
BookingWebhookTaskPayload,
PaymentWebhookTaskPayload,
WebhookTaskPayload,
} from "../types/webhookTask";
export class WebhookTaskConsumer {
private readonly log: ILogger;
constructor(
private readonly webhookRepository: IWebhookRepository,
private readonly dataFetchers: IWebhookDataFetcher[],
private readonly payloadBuilderFactory: PayloadBuilderFactory,
private readonly webhookService: IWebhookService,
logger: ILogger
) {
this.log = logger.getSubLogger({ prefix: ["[WebhookTaskConsumer]"] });
}
/**
* Main entry point for processing webhook delivery tasks.
*/
async processWebhookTask(payload: WebhookTaskPayload, taskId: string): Promise<void> {
this.log.debug("Processing webhook delivery task", {
operationId: payload.operationId,
taskId,
triggerEvent: payload.triggerEvent,
});
try {
const fetcher = this.getDataFetcher(payload.triggerEvent);
if (!fetcher) {
this.log.error("No data fetcher found for trigger event", {
operationId: payload.operationId,
triggerEvent: payload.triggerEvent,
});
throw new Error(`No data fetcher registered for trigger event: ${payload.triggerEvent}`);
}
const subscriberContext = fetcher.getSubscriberContext(payload);
const subscribers = await this.webhookRepository.getSubscribers(subscriberContext);
if (subscribers.length === 0) {
this.log.debug("No webhook subscribers found", { operationId: payload.operationId });
return;
}
this.log.debug(`Found ${subscribers.length} webhook subscriber(s)`, {
operationId: payload.operationId,
});
const eventData = await fetcher.fetchEventData(payload);
if (!eventData) {
this.log.warn("Event data not found", {
operationId: payload.operationId,
triggerEvent: payload.triggerEvent,
});
return;
}
await this.sendWebhooksToSubscribers(subscribers, eventData, payload);
this.log.debug("Webhook delivery task completed", {
operationId: payload.operationId,
subscriberCount: subscribers.length,
});
} catch (error) {
this.log.error("Failed to process webhook delivery task", {
operationId: payload.operationId,
taskId,
error: error instanceof Error ? error.message : String(error),
});
throw error;
}
}
/**
* Get the appropriate data fetcher for the trigger event.
*
* Uses polymorphism via canHandle() method - each fetcher knows which events it handles.
*/
private getDataFetcher(triggerEvent: string): IWebhookDataFetcher | null {
return this.dataFetchers.find((fetcher) => fetcher.canHandle(triggerEvent as never)) || null;
}
/**
* Build webhook payloads and send to each subscriber via WebhookService.
* Uses WebhookService.processWebhooks() for HTTP delivery.
*/
private async sendWebhooksToSubscribers(
subscribers: WebhookSubscriber[],
eventData: Record<string, unknown>,
payload: WebhookTaskPayload
): Promise<void> {
if (subscribers.length === 0) {
this.log.debug("No subscribers to send webhooks to");
return;
}
try {
const dto = this.buildDTO(eventData, payload);
if (!dto) {
this.log.warn("Failed to build DTO for webhook", {
triggerEvent: payload.triggerEvent,
operationId: payload.operationId,
});
return;
}
const builder = this.payloadBuilderFactory.getBuilder(DEFAULT_WEBHOOK_VERSION, dto.triggerEvent);
const webhookPayload = builder.build(dto);
await this.webhookService.processWebhooks(dto.triggerEvent, webhookPayload, subscribers);
this.log.debug("Webhook sending completed", {
subscriberCount: subscribers.length,
triggerEvent: payload.triggerEvent,
operationId: payload.operationId,
});
} catch (error) {
this.log.error("Error in sendWebhooksToSubscribers", {
error: error instanceof Error ? error.message : String(error),
triggerEvent: payload.triggerEvent,
});
throw error;
}
}
/**
* Build WebhookEventDTO from fetched event data.
*
* This method maps the data fetched from DB into the DTO structure
* expected by PayloadBuilders.
*/
private buildDTO(eventData: Record<string, unknown>, payload: WebhookTaskPayload): WebhookEventDTO | null {
const { triggerEvent, timestamp } = payload;
const calendarEvent = eventData.calendarEvent as CalendarEvent | undefined;
const booking = eventData.booking as BookingForCalEventBuilder | undefined;
const eventType = booking?.eventType;
if (!calendarEvent || !booking || !eventType) {
this.log.warn("Missing required data to build DTO", {
hasCalendarEvent: !!calendarEvent,
hasBooking: !!booking,
hasEventType: !!eventType,
});
return null;
}
const eventTypeInfo = {
id: eventType.id,
eventTitle: eventType.title,
eventDescription: eventType.description,
requiresConfirmation: eventType.requiresConfirmation,
price: eventType.price,
currency: eventType.currency,
length: eventType.length,
};
const bookingPayload = payload as BookingWebhookTaskPayload;
const baseDTO = {
createdAt: timestamp,
bookingId: booking.id,
eventTypeId: eventType.id,
userId: booking.user?.id ?? null,
teamId: bookingPayload.teamId ?? null,
orgId: bookingPayload.orgId,
platformClientId: bookingPayload.platformClientId ?? bookingPayload.oAuthClientId,
evt: calendarEvent,
eventType: eventTypeInfo,
booking: {
id: booking.id,
eventTypeId: booking.eventTypeId,
userId: booking.userId,
startTime: booking.startTime,
smsReminderNumber: booking.smsReminderNumber,
iCalSequence: booking.iCalSequence,
// Raw assignmentReason from DB for legacy format [{ reasonEnum, reasonString }]
assignmentReason: booking.assignmentReason,
},
};
switch (triggerEvent) {
case WebhookTriggerEvents.BOOKING_REQUESTED:
return {
...baseDTO,
triggerEvent,
metadata: {
...(typeof booking.metadata === "object" &&
booking.metadata !== null &&
!Array.isArray(booking.metadata)
? booking.metadata
: {}),
...(bookingPayload.metadata ?? {}),
},
} as WebhookEventDTO;
default:
this.log.warn("Unsupported trigger event for DTO building", { triggerEvent });
return null;
}
}
}