feat: skip platform billing for non-platform-managed users (calcom#27521)

* feat: skip platform billing for non-platform-managed users

- Add isPlatformManaged to user select in saveBooking and findBookingQuery
- Update 2024-04-15 booking controller to check isPlatformManaged before billing
- Update 2024-08-13 bookings service billBooking methods to check isPlatformManaged
- Update buildDryRunBooking to include isPlatformManaged in user object

Co-Authored-By: morgan@cal.com <morgan@cal.com>

* test: update buildDryRunBooking test to include uuid and isPlatformManaged fields

Co-Authored-By: morgan@cal.com <morgan@cal.com>

* refactor: simplify to only check isPlatformManaged in normal booking flow

Co-Authored-By: morgan@cal.com <morgan@cal.com>

* test: add E2E tests for billing behavior based on isPlatformManaged flag

Co-Authored-By: morgan@cal.com <morgan@cal.com>

* chore: only trigger platform billing for platform user bookingd

* test: add E2E tests for cancel and recurring booking billing behavior

Co-Authored-By: morgan@cal.com <morgan@cal.com>

* fix: correct expected status code for cancel booking endpoint (201 instead of 200)

Co-Authored-By: morgan@cal.com <morgan@cal.com>

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>

Author: ThyMinimalDev

apps/api/v2/src/ee/bookings/2024-04-15/controllers/bookings-billing.e2e-spec.ts

@@ -1,11 +1,59 @@
+import {
+  BOOKING_READ,
+  BOOKING_WRITE,
+  SUCCESS_STATUS,
+  X_CAL_CLIENT_ID,
+  X_CAL_PLATFORM_EMBED,
+} from "@calcom/platform-constants";
+import {
+  BookingResponse,
+  CreationSource,
+  getAllUserBookings,
+  getBookingForReschedule,
+  getBookingInfo,
+  handleCancelBooking,
+  handleMarkNoShow,
+} from "@calcom/platform-libraries";
+import { type InstantBookingCreateResult } from "@calcom/platform-libraries/bookings";
+import { ErrorCode, HttpError } from "@calcom/platform-libraries/errors";
+import type { ApiResponse } from "@calcom/platform-types";
+import {
+  CancelBookingInput_2024_04_15,
+  GetBookingsInput_2024_04_15,
+  Status_2024_04_15,
+} from "@calcom/platform-types";
+import type { PrismaClient } from "@calcom/prisma";
+import {
+  BadRequestException,
+  Body,
+  Controller,
+  ForbiddenException,
+  Get,
+  Headers,
+  HttpException,
+  InternalServerErrorException,
+  Logger,
+  NotFoundException,
+  Param,
+  Post,
+  Query,
+  Req,
+  UnauthorizedException,
+  UseGuards,
+} from "@nestjs/common";
+import { ConfigService } from "@nestjs/config";
+import { ApiQuery, ApiExcludeController as DocsExcludeController } from "@nestjs/swagger";
+import { Request } from "express";
+import { NextApiRequest } from "next/types";
+import { v4 as uuidv4 } from "uuid";
 import { CreateBookingInput_2024_04_15 } from "@/ee/bookings/2024-04-15/inputs/create-booking.input";
 import { CreateRecurringBookingInput_2024_04_15 } from "@/ee/bookings/2024-04-15/inputs/create-recurring-booking.input";
 import { MarkNoShowInput_2024_04_15 } from "@/ee/bookings/2024-04-15/inputs/mark-no-show.input";
 import { GetBookingOutput_2024_04_15 } from "@/ee/bookings/2024-04-15/outputs/get-booking.output";
 import { GetBookingsOutput_2024_04_15 } from "@/ee/bookings/2024-04-15/outputs/get-bookings.output";
 import { MarkNoShowOutput_2024_04_15 } from "@/ee/bookings/2024-04-15/outputs/mark-no-show.output";
 import { PlatformBookingsService } from "@/ee/bookings/shared/platform-bookings.service";
-import { sha256Hash, isApiKey, stripApiKey } from "@/lib/api-key";
+import { isApiKey, sha256Hash, stripApiKey } from "@/lib/api-key";
 import { VERSION_2024_04_15, VERSION_2024_06_11, VERSION_2024_06_14 } from "@/lib/api-versions";
 import { PrismaEventTypeRepository } from "@/lib/repositories/prisma-event-type.repository";
 import { PrismaTeamRepository } from "@/lib/repositories/prisma-team.repository";
@@ -30,50 +78,6 @@ import { OAuthFlowService } from "@/modules/oauth-clients/services/oauth-flow.se
 import { PrismaReadService } from "@/modules/prisma/prisma-read.service";
 import { UsersService } from "@/modules/users/services/users.service";
 import { UsersRepository, UserWithProfile } from "@/modules/users/users.repository";
-import {
-  Controller,
-  Post,
-  Logger,
-  Req,
-  InternalServerErrorException,
-  Body,
-  Headers,
-  HttpException,
-  Param,
-  Get,
-  Query,
-  NotFoundException,
-  UseGuards,
-  BadRequestException,
-  UnauthorizedException,
-  ForbiddenException,
-} from "@nestjs/common";
-import { ConfigService } from "@nestjs/config";
-import { ApiQuery, ApiExcludeController as DocsExcludeController } from "@nestjs/swagger";
-import { Request } from "express";
-import { NextApiRequest } from "next/types";
-import { v4 as uuidv4 } from "uuid";
-
-import { X_CAL_CLIENT_ID, X_CAL_PLATFORM_EMBED } from "@calcom/platform-constants";
-import { BOOKING_READ, SUCCESS_STATUS, BOOKING_WRITE } from "@calcom/platform-constants";
-import {
-  BookingResponse,
-  handleMarkNoShow,
-  getAllUserBookings,
-  getBookingInfo,
-  handleCancelBooking,
-  getBookingForReschedule,
-} from "@calcom/platform-libraries";
-import { CreationSource } from "@calcom/platform-libraries";
-import { type InstantBookingCreateResult } from "@calcom/platform-libraries/bookings";
-import { HttpError, ErrorCode } from "@calcom/platform-libraries/errors";
-import {
-  GetBookingsInput_2024_04_15,
-  CancelBookingInput_2024_04_15,
-  Status_2024_04_15,
-} from "@calcom/platform-types";
-import type { ApiResponse } from "@calcom/platform-types";
-import type { PrismaClient } from "@calcom/prisma";
 
 type BookingRequest = Request & {
   userId?: number;
@@ -137,7 +141,7 @@ export class BookingsController_2024_04_15 {
     @Query() queryParams: GetBookingsInput_2024_04_15
   ): Promise<GetBookingsOutput_2024_04_15> {
     const { filters, cursor, limit } = queryParams;
-    const bookingListingByStatus = filters?.status ?? Status_2024_04_15["upcoming"];
+    const bookingListingByStatus = filters?.status ?? Status_2024_04_15.upcoming;
     const profile = this.usersService.getUserMainProfile(user);
     const bookings = await getAllUserBookings({
       bookingListingByStatus: [bookingListingByStatus],
@@ -221,7 +225,7 @@ export class BookingsController_2024_04_15 {
           areCalendarEventsEnabled: bookingRequest.areCalendarEventsEnabled,
         },
       });
-      if (booking.userId && booking.uid && booking.startTime) {
+      if (booking.userId && booking.uid && booking.startTime && booking.user?.isPlatformManaged) {
         void (await this.billingService.increaseUsageByUserId(booking.userId, {
           uid: booking.uid,
           startTime: booking.startTime,
@@ -242,12 +246,12 @@ export class BookingsController_2024_04_15 {
   async cancelBooking(
     @Req() req: BookingRequest,
     @Param("bookingUid") bookingUid: string,
-    @Body() body: CancelBookingInput_2024_04_15,
+    @Body() _body: CancelBookingInput_2024_04_15,
     @Headers(X_CAL_CLIENT_ID) clientId?: string,
     @Headers(X_CAL_PLATFORM_EMBED) isEmbed?: string
   ): Promise<ApiResponse<{ bookingId: number; bookingUid: string; onlyRemovedAttendee: boolean }>> {
     const oAuthClientId = clientId?.toString();
-    const isUidNumber = !isNaN(Number(bookingUid));
+    const isUidNumber = !Number.isNaN(Number(bookingUid));
 
     if (isUidNumber) {
       throw new BadRequestException("Please provide booking uid instead of booking id.");
@@ -276,7 +280,7 @@ export class BookingsController_2024_04_15 {
           platformRescheduleUrl: bookingRequest.platformRescheduleUrl,
           platformBookingUrl: bookingRequest.platformBookingUrl,
         });
-        if (!res.onlyRemovedAttendee) {
+        if (!res.onlyRemovedAttendee && res.isPlatformManagedUserBooking) {
           void (await this.billingService.cancelUsageByBookingUid(res.bookingUid));
         }
         return {
@@ -353,7 +357,7 @@ export class BookingsController_2024_04_15 {
       });
 
       createdBookings.forEach(async (booking) => {
-        if (booking.userId && booking.uid && booking.startTime) {
+        if (booking.userId && booking.uid && booking.startTime && booking.user.isPlatformManaged) {
           void (await this.billingService.increaseUsageByUserId(booking.userId, {
             uid: booking.uid,
             startTime: booking.startTime,
@@ -623,58 +627,22 @@ export class BookingsController_2024_04_15 {
         oAuthClientId
       );
     }
-    if (requestBody?.responses?.guests && requestBody?.responses?.guests.length) {
+    if (requestBody?.responses?.guests?.length) {
       requestBody.responses.guests = await this.platformBookingsService.getPlatformAttendeesEmails(
         requestBody.responses.guests,
         oAuthClientId
       );
     }
   }
 
-  private async createNextApiRecurringBookingRequest(
-    req: BookingRequest,
-    oAuthClientId?: string,
-    platformBookingLocation?: string,
-    isEmbed?: string
-  ): Promise<NextApiRequest & { userId?: number; userUuid?: string } & OAuthRequestParams> {
-    const clone = { ...req };
-    const owner = await this.getOwner(req);
-    const userId = owner?.id ?? -1;
-    const userUuid = owner?.uuid;
-
-    const oAuthParams = oAuthClientId
-      ? await this.getOAuthClientsParams(oAuthClientId, this.transformToBoolean(isEmbed))
-      : DEFAULT_PLATFORM_PARAMS;
-    const requestId = req.get("X-Request-Id");
-    this.logger.log(`createNextApiRecurringBookingRequest_2024_04_15`, {
-      requestId,
-      ownerId: userId,
-      platformBookingLocation,
-      oAuthClientId,
-      ...oAuthParams,
-    });
-    Object.assign(clone, {
-      userId,
-      userUuid,
-      ...oAuthParams,
-      platformBookingLocation,
-      noEmail: !oAuthParams.arePlatformEmailsEnabled,
-      creationSource: CreationSource.API_V2,
-    });
-    if (oAuthClientId) {
-      await this.setPlatformAttendeesEmails(clone.body, oAuthClientId);
-    }
-    return clone as unknown as NextApiRequest & { userId?: number; userUuid?: string } & OAuthRequestParams;
-  }
-
   private handleBookingErrors(
     err: Error | HttpError | unknown,
     type?: "recurring" | `instant` | "no-show"
   ): void {
     const errMsg =
       type === "no-show"
         ? `Error while marking no-show.`
-        : `Error while creating ${type ? type + " " : ""}booking.`;
+        : `Error while creating ${type ? `${type} ` : ""}booking.`;
     if (err instanceof HttpError) {
       const httpError = err as HttpError;
       throw new HttpException(httpError?.message ?? errMsg, httpError?.statusCode ?? 500);

apps/api/v2/src/ee/bookings/2024-04-15/controllers/bookings.controller.ts

@@ -32,4 +32,5 @@ export type HandleCancelBookingResponse = {
   onlyRemovedAttendee: boolean;
   bookingId: number;
   bookingUid: string;
+  isPlatformManagedUserBooking: boolean;
 };

packages/features/bookings/lib/dto/BookingCancel.d.ts

@@ -23,6 +23,7 @@ export async function getBookingToDelete(id: number | undefined, uid: string | u
           name: true,
           destinationCalendar: true,
           locale: true,
+          isPlatformManaged: true,
           profiles: {
             select: {
               organizationId: true,

packages/features/bookings/lib/getBookingToDelete.ts

@@ -1,12 +1,17 @@
-import type { z } from "zod";
-import { v4 as uuidv4 } from "uuid";
-
 import { DailyLocationType } from "@calcom/app-store/constants";
 import { FAKE_DAILY_CREDENTIAL } from "@calcom/app-store/dailyvideo/lib/VideoApiAdapter";
 import { eventTypeMetaDataSchemaWithTypedApps } from "@calcom/app-store/zod-utils";
 import dayjs from "@calcom/dayjs";
 import { sendCancelledEmailsAndSMS } from "@calcom/emails/email-manager";
+import type { Actor } from "@calcom/features/booking-audit/lib/dto/types";
+import {
+  buildActorEmail,
+  getUniqueIdentifier,
+  makeGuestActor,
+  makeUserActor,
+} from "@calcom/features/booking-audit/lib/makeActor";
 import type { ActionSource } from "@calcom/features/booking-audit/lib/types/actionSource";
+import { BookingReferenceRepository } from "@calcom/features/bookingReference/repositories/BookingReferenceRepository";
 import { getBookingEventHandlerService } from "@calcom/features/bookings/di/BookingEventHandlerService.container";
 import EventManager from "@calcom/features/bookings/lib/EventManager";
 import { getCalEventResponses } from "@calcom/features/bookings/lib/getCalEventResponses";
@@ -23,8 +28,8 @@ import { UserRepository } from "@calcom/features/users/repositories/UserReposito
 import type { GetSubscriberOptions } from "@calcom/features/webhooks/lib/getWebhooks";
 import getWebhooks from "@calcom/features/webhooks/lib/getWebhooks";
 import {
-  deleteWebhookScheduledTriggers,
   cancelNoShowTasksForBooking,
+  deleteWebhookScheduledTriggers,
 } from "@calcom/features/webhooks/lib/scheduleTrigger";
 import sendPayload from "@calcom/features/webhooks/lib/sendOrSchedulePayload";
 import type { EventTypeInfo } from "@calcom/features/webhooks/lib/sendPayload";
@@ -36,36 +41,28 @@ import { parseRecurringEvent } from "@calcom/lib/isRecurringEvent";
 import logger from "@calcom/lib/logger";
 import { safeStringify } from "@calcom/lib/safeStringify";
 import { getTranslation } from "@calcom/lib/server/i18n";
-import { BookingReferenceRepository } from "@calcom/features/bookingReference/repositories/BookingReferenceRepository";
 import { getTimeFormatStringFromUserTimeFormat } from "@calcom/lib/timeFormat";
 // TODO: Prisma import would be used from DI in a followup PR when we remove `handler` export
 import prisma from "@calcom/prisma";
-import type { WorkflowMethods } from "@calcom/prisma/enums";
-import type { WebhookTriggerEvents } from "@calcom/prisma/enums";
+import type { WebhookTriggerEvents, WorkflowMethods } from "@calcom/prisma/enums";
 import { BookingStatus } from "@calcom/prisma/enums";
-import { bookingMetadataSchema, bookingCancelInput } from "@calcom/prisma/zod-utils";
 import type { EventTypeMetadata } from "@calcom/prisma/zod-utils";
+import { bookingCancelInput, bookingMetadataSchema } from "@calcom/prisma/zod-utils";
 import type { CalendarEvent } from "@calcom/types/Calendar";
-
+import { v4 as uuidv4 } from "uuid";
+import type { z } from "zod";
 import { BookingRepository } from "../repositories/BookingRepository";
 import { PrismaBookingAttendeeRepository } from "../repositories/PrismaBookingAttendeeRepository";
 import type {
-  CancelRegularBookingData,
   CancelBookingMeta,
+  CancelRegularBookingData,
   HandleCancelBookingResponse,
 } from "./dto/BookingCancel";
 import { getAllCredentialsIncludeServiceAccountKey } from "./getAllCredentialsForUsersOnEvent/getAllCredentials";
 import { getBookingToDelete } from "./getBookingToDelete";
 import { handleInternalNote } from "./handleInternalNote";
 import cancelAttendeeSeat from "./handleSeats/cancel/cancelAttendeeSeat";
 import type { IBookingCancelService } from "./interfaces/IBookingCancelService";
-import {
-  buildActorEmail,
-  getUniqueIdentifier,
-  makeGuestActor,
-  makeUserActor,
-} from "@calcom/features/booking-audit/lib/makeActor";
-import type { Actor } from "@calcom/features/booking-audit/lib/dto/types";
 
 const log = logger.getSubLogger({ prefix: ["handleCancelBooking"] });
 
@@ -218,7 +215,7 @@ async function handler(input: CancelBookingInput, dependencies?: Dependencies) {
   }
 
   const isCancellationUserHost =
-    bookingToDelete.userId == userId || bookingToDelete.user.email === cancelledBy;
+    bookingToDelete.userId === userId || bookingToDelete.user.email === cancelledBy;
 
   if (
     !platformClientId &&
@@ -385,12 +382,12 @@ async function handler(input: CancelBookingInput, dependencies?: Dependencies) {
     cancellationReason: cancellationReason,
     ...(teamMembers &&
       teamId && {
-      team: {
-        name: bookingToDelete?.eventType?.team?.name || "Nameless",
-        members: teamMembers,
-        id: teamId,
-      },
-    }),
+        team: {
+          name: bookingToDelete?.eventType?.team?.name || "Nameless",
+          members: teamMembers,
+          id: teamId,
+        },
+      }),
     seatsPerTimeSlot: bookingToDelete.eventType?.seatsPerTimeSlot,
     seatsShowAttendees: bookingToDelete.eventType?.seatsShowAttendees,
     iCalUID: bookingToDelete.iCalUID,
@@ -423,6 +420,7 @@ async function handler(input: CancelBookingInput, dependencies?: Dependencies) {
       bookingId: bookingToDelete.id,
       bookingUid: bookingToDelete.uid,
       message: "Attendee successfully removed.",
+      isPlatformManagedUserBooking: bookingToDelete.user.isPlatformManaged,
     } satisfies HandleCancelBookingResponse;
 
   const promises = webhooks.map((webhook) =>
@@ -698,6 +696,7 @@ async function handler(input: CancelBookingInput, dependencies?: Dependencies) {
     onlyRemovedAttendee: false,
     bookingId: bookingToDelete.id,
     bookingUid: bookingToDelete.uid,
+    isPlatformManagedUserBooking: bookingToDelete.user.isPlatformManaged,
   } satisfies HandleCancelBookingResponse;
 }
 

packages/features/bookings/lib/handleCancelBooking.ts

@@ -143,7 +143,7 @@ async function saveBooking(
   const createBookingObj = {
     include: {
       user: {
-        select: { uuid: true, email: true, name: true, timeZone: true, username: true },
+        select: { uuid: true, email: true, name: true, timeZone: true, username: true, isPlatformManaged: true },
       },
       attendees: true,
       payment: true,

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

@@ -24,6 +24,7 @@ const _findBookingQuery = async (bookingId: number) => {
           email: true,
           timeZone: true,
           username: true,
+          isPlatformManaged: true,
         },
       },
       eventType: {