Files
calendar/packages/features/webhooks/lib/__tests__/webhookDelivery.integration-test.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

119 lines
3.6 KiB
TypeScript

import { prisma } from "@calcom/prisma";
import type { EventType, User, Webhook } from "@calcom/prisma/client";
import { WebhookTriggerEvents } from "@calcom/prisma/enums";
import { v4 } from "uuid";
import { afterAll, beforeAll, beforeEach, describe, expect, test, vi } from "vitest";
import type { WebhookTaskPayload } from "../types/webhookTask";
/**
* Webhook Producer Integration Tests
*
* These tests verify that the WebhookTaskerProducerService correctly:
* 1. Integrates with the DI container
* 2. Calls WebhookTasker.deliverWebhook() with correct payloads
*
* Note: With the new WebhookTasker architecture:
* - Async mode sends to trigger.dev (external service)
* - Sync mode executes immediately via WebhookTaskConsumer
*
* Neither writes to the local Prisma Task table, so we mock
* the WebhookTasker to verify the producer's behavior.
*/
// Track deliverWebhook calls
const deliveredWebhooks: WebhookTaskPayload[] = [];
// Mock the WebhookTasker module before importing the container
vi.mock("@calcom/features/webhooks/lib/tasker/WebhookTasker", () => ({
WebhookTasker: class MockWebhookTasker {
async deliverWebhook(payload: WebhookTaskPayload) {
deliveredWebhooks.push(payload);
return { taskId: `mock-task-${deliveredWebhooks.length}` };
}
},
}));
// Import after mocking
const { getWebhookProducer } = await import("@calcom/features/di/webhooks/containers/webhook");
describe("Webhook Producer Integration", () => {
let testUser: User;
let testEventType: EventType;
// eslint-disable-next-line @typescript-eslint/no-unused-vars
let testWebhook: Webhook;
// Use unique identifiers for each test run to avoid collisions
const testId = v4();
beforeAll(async () => {
// Create test user
testUser = await prisma.user.create({
data: {
email: `webhook-producer-test-${testId}@example.com`,
username: `webhook-producer-test-${testId}`,
name: "Webhook Producer Test User",
},
});
// Create test event type
testEventType = await prisma.eventType.create({
data: {
title: "Webhook Producer Test Event",
slug: `webhook-producer-test-event-${testId}`,
length: 30,
userId: testUser.id,
},
});
// Create test webhook
testWebhook = await prisma.webhook.create({
data: {
id: `webhook-producer-test-${testId}`,
userId: testUser.id,
subscriberUrl: "https://example.com/webhook",
eventTriggers: [WebhookTriggerEvents.BOOKING_CREATED],
active: true,
},
});
});
beforeEach(() => {
// Clear delivered webhooks before each test
deliveredWebhooks.length = 0;
});
afterAll(async () => {
// Clean up all test data
await prisma.webhook.deleteMany({
where: { userId: testUser.id },
});
await prisma.eventType.deleteMany({
where: { id: testEventType.id },
});
await prisma.user.deleteMany({
where: { id: testUser.id },
});
});
describe("BOOKING_REQUESTED", () => {
test("calls deliverWebhook with correct payload", async () => {
const producer = getWebhookProducer();
const bookingUid = "test-booking-uid-requested";
await producer.queueBookingRequestedWebhook({
bookingUid,
eventTypeId: testEventType.id,
userId: testUser.id,
});
expect(deliveredWebhooks.length).toBe(1);
const payload = deliveredWebhooks[0];
expect(payload.triggerEvent).toBe(WebhookTriggerEvents.BOOKING_REQUESTED);
if (payload.triggerEvent === WebhookTriggerEvents.BOOKING_REQUESTED) {
expect(payload.bookingUid).toBe(bookingUid);
}
});
});
});