* fix: break circular dependency in messageDispatcher via dependency injection Break the 4-file circular dependency chain: credit-service → reminderScheduler → smsReminderManager → messageDispatcher → credit-service Solution: - Add optional creditCheckFn parameter to messageDispatcher functions - Thread creditCheckFn through the call chain: scheduleWorkflowReminders → scheduleSMSReminder/scheduleWhatsappReminder → messageDispatcher - When creditCheckFn is provided, use it; otherwise fall back to dynamic CreditService import for backward compatibility - This breaks the workflows → billing import while preserving immediate fallback behavior Changes: - messageDispatcher: Accept optional creditCheckFn parameter, use it if provided - smsReminderManager: Thread creditCheckFn through scheduleSMSReminder - whatsappReminderManager: Thread creditCheckFn through scheduleWhatsappReminder - reminderScheduler: Add creditCheckFn to ScheduleWorkflowRemindersArgs and pass through processWorkflowStep All type checks, lint checks, and unit tests pass. Co-Authored-By: benny@cal.com <sldisek783@gmail.com> * feat: wire creditCheckFn from all callers to complete circular dependency fix - Add creditCheckFn parameter to WorkflowService.scheduleFormWorkflows - Wire creditCheckFn from all 10 entry points that call workflow scheduling: * formSubmissionUtils.ts (form submissions) * roundRobinManualReassignment.ts (round-robin reassignment) * triggerFormSubmittedNoEventWorkflow.ts (form workflow trigger) * handleBookingRequested.ts (booking requests) * RegularBookingService.ts (2 calls - payment initiated & new bookings) * handleSeats.ts (seated bookings) * handleConfirmation.ts (2 calls - confirmation & payment) * handleMarkNoShow.ts (no-show updates) * confirm.handler.ts (booking rejection) - Update test expectations to use expect.objectContaining() - Fix pre-existing lint warning in handleMarkNoShow.ts (any type) - This completes the messageDispatcher circular dependency fix by ensuring creditCheckFn is actually passed through the call chain, breaking the 4-file circular dependency at runtime Co-Authored-By: benny@cal.com <sldisek783@gmail.com> * fix: use generic type with type guard in logFailedResults to fix type check error - Replace constrained type with generic type parameter - Add proper type guard for rejected promises - Fixes CI type check failure in handleMarkNoShow.ts:385 - Avoids 'any' type while accepting any fulfilled value shape Co-Authored-By: benny@cal.com <sldisek783@gmail.com> * wip * wip * wip * revert * revert * feat: wire creditCheckFn from all remaining callers to eliminate fallbacks - Wire creditCheckFn in packages/sms/sms-manager.ts (can safely import CreditService) - Create makeHandler factory pattern for CRON endpoints (scheduleSMSReminders.ts, scheduleWhatsappReminders.ts) - Wire creditCheckFn from apps/web CRON routes to factories - Add warning log in messageDispatcher when fallback is used - Complete creditCheckFn wiring from all direct callers (activateEventType.handler.ts, util.ts) This eliminates all fallbacks to dynamic import except as a safety net for unforeseen call sites. The circular dependency (workflows ↔ billing) remains acceptable as discussed with user (Option C). Co-Authored-By: benny@cal.com <sldisek783@gmail.com> * test: update formSubmissionUtils tests to expect creditCheckFn parameter The scheduleFormWorkflows function now receives creditCheckFn as a parameter. Updated test assertions to use expect.objectContaining() with creditCheckFn: expect.any(Function) to account for the new dependency injection parameter. Co-Authored-By: benny@cal.com <sldisek783@gmail.com> * test: update sms-manager test to expect creditCheckFn parameter The sendSmsOrFallbackEmail function now receives creditCheckFn as a parameter. Updated test assertion to use expect.objectContaining() with creditCheckFn: expect.any(Function) to account for the new dependency injection parameter. Also removed teamId: undefined assertion as the key may be omitted entirely from the actual call. Co-Authored-By: benny@cal.com <sldisek783@gmail.com> * feat: make creditCheckFn required to fully break circular dependency This commit completes the circular dependency fix by making creditCheckFn required throughout the call chain, eliminating the dynamic import fallback entirely. Changes: - Make creditCheckFn required in messageDispatcher functions (sendSmsOrFallbackEmail, scheduleSmsOrFallbackEmail) - Remove dynamic import fallback and warning log from messageDispatcher - Make creditCheckFn required in ScheduleTextReminderArgs (smsReminderManager) - Make creditCheckFn required in processWorkflowStep and ScheduleWorkflowRemindersArgs (reminderScheduler) - Add creditCheckFn to SendCancelledRemindersArgs and wire from handleCancelBooking The circular dependency is now fully broken - no more dynamic imports of CreditService from within the workflows package. All callers must explicitly provide creditCheckFn via dependency injection. Co-Authored-By: benny@cal.com <sldisek783@gmail.com> * fix: make creditCheckFn required in WorkflowService.scheduleFormWorkflows This commit fixes the CI type check error by making creditCheckFn required in WorkflowService.scheduleFormWorkflows. Previously, creditCheckFn was optional in scheduleFormWorkflows but required in scheduleWorkflowReminders, causing a type mismatch. Changes: - Make creditCheckFn required in scheduleFormWorkflows signature - Update WorkflowService.test.ts to pass mock creditCheckFn in all test cases - Add responseId and routedEventTypeId to test calls for completeness All callers of scheduleFormWorkflows already pass creditCheckFn, so this change is safe and completes the circular dependency fix. Co-Authored-By: benny@cal.com <sldisek783@gmail.com> * remove * fix * refactor * refactor * refactor * wip * fix * fix * rm --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
157 lines
4.7 KiB
TypeScript
157 lines
4.7 KiB
TypeScript
import dayjs from "@calcom/dayjs";
|
|
import { CreditService } from "@calcom/features/ee/billing/credit-service";
|
|
import { getSenderId } from "@calcom/features/ee/workflows/lib/alphanumericSenderIdSupport";
|
|
import { sendSmsOrFallbackEmail } from "@calcom/features/ee/workflows/lib/reminders/messageDispatcher";
|
|
import { SENDER_ID } from "@calcom/lib/constants";
|
|
import isSmsCalEmail from "@calcom/lib/isSmsCalEmail";
|
|
import { piiHasher } from "@calcom/lib/server/PiiHasher";
|
|
import { checkSMSRateLimit } from "@calcom/lib/smsLockState";
|
|
import { TimeFormat } from "@calcom/lib/timeFormat";
|
|
import prisma from "@calcom/prisma";
|
|
import type { CalendarEvent, Person } from "@calcom/types/Calendar";
|
|
|
|
const handleSendingSMS = async ({
|
|
reminderPhone,
|
|
smsMessage,
|
|
senderID,
|
|
teamId,
|
|
bookingUid,
|
|
organizerUserId,
|
|
}: {
|
|
reminderPhone: string;
|
|
smsMessage: string;
|
|
senderID: string;
|
|
teamId?: number;
|
|
bookingUid?: string | null;
|
|
organizerUserId?: number;
|
|
}) => {
|
|
try {
|
|
// If teamId is provided, we check the rate limit for the team.
|
|
// If organizerUserId is provided, we check the rate limit for the organizer.
|
|
// If neither is provided(Just in case), we check the rate limit for the reminderPhone.
|
|
await checkSMSRateLimit({
|
|
identifier: teamId
|
|
? `handleSendingSMS:team:${teamId}`
|
|
: organizerUserId
|
|
? `handleSendingSMS:user:${organizerUserId}`
|
|
: `handleSendingSMS:user:${piiHasher.hash(reminderPhone)}`,
|
|
rateLimitingType: "sms",
|
|
});
|
|
|
|
const creditService = new CreditService();
|
|
|
|
const smsOrFallbackEmail = await sendSmsOrFallbackEmail({
|
|
twilioData: {
|
|
phoneNumber: reminderPhone,
|
|
body: smsMessage,
|
|
sender: senderID,
|
|
...(teamId ? { teamId } : { userId: organizerUserId }),
|
|
bookingUid,
|
|
},
|
|
creditCheckFn: creditService.hasAvailableCredits.bind(creditService),
|
|
});
|
|
|
|
return smsOrFallbackEmail;
|
|
} catch (e) {
|
|
console.error("sendSmsOrFallbackEmail failed", e);
|
|
throw e; // propagate the error
|
|
}
|
|
};
|
|
|
|
const getTeamWithOrganizationSettings = async (teamId: number) => {
|
|
return await prisma.team.findUnique({
|
|
where: { id: teamId },
|
|
select: {
|
|
parent: {
|
|
select: {
|
|
isOrganization: true,
|
|
organizationSettings: true,
|
|
},
|
|
},
|
|
},
|
|
});
|
|
};
|
|
|
|
export default abstract class SMSManager {
|
|
calEvent: CalendarEvent;
|
|
isTeamEvent = false;
|
|
teamId: number | undefined = undefined;
|
|
organizerUserId: number | undefined = undefined;
|
|
private _isSMSNotificationEnabled: boolean | null = null;
|
|
|
|
constructor(calEvent: CalendarEvent) {
|
|
this.calEvent = calEvent;
|
|
this.teamId = this.calEvent?.team?.id;
|
|
this.isTeamEvent = !!this.calEvent?.team?.id;
|
|
this.organizerUserId = this.calEvent?.organizer?.id;
|
|
}
|
|
|
|
private async isSMSNotificationEnabled(): Promise<boolean> {
|
|
if (this._isSMSNotificationEnabled !== null) {
|
|
return this._isSMSNotificationEnabled;
|
|
}
|
|
|
|
const teamId = this.teamId;
|
|
|
|
if (teamId) {
|
|
const team = await getTeamWithOrganizationSettings(teamId);
|
|
|
|
this._isSMSNotificationEnabled = !team?.parent?.organizationSettings?.disablePhoneOnlySMSNotifications;
|
|
return this._isSMSNotificationEnabled;
|
|
}
|
|
|
|
this._isSMSNotificationEnabled = true;
|
|
return true;
|
|
}
|
|
|
|
getFormattedTime(
|
|
timezone: string,
|
|
locale: string,
|
|
time: string,
|
|
format = `dddd, LL | ${TimeFormat.TWELVE_HOUR}`
|
|
) {
|
|
return dayjs(time).tz(timezone).locale(locale).format(format);
|
|
}
|
|
|
|
getFormattedDate(timezone: string, locale: string) {
|
|
return `${this.getFormattedTime(timezone, locale, this.calEvent.startTime)} - ${this.getFormattedTime(
|
|
timezone,
|
|
locale,
|
|
this.calEvent.endTime
|
|
)} (${timezone})`;
|
|
}
|
|
|
|
abstract getMessage(attendee: Person): string;
|
|
|
|
async sendSMSToAttendee(attendee: Person, bookingUid?: string | null) {
|
|
const teamId = this.teamId;
|
|
const attendeePhoneNumber = attendee.phoneNumber;
|
|
const isPhoneOnlyBooking = attendeePhoneNumber && isSmsCalEmail(attendee.email);
|
|
|
|
if (!attendeePhoneNumber || !isPhoneOnlyBooking || !(await this.isSMSNotificationEnabled())) return;
|
|
|
|
const smsMessage = this.getMessage(attendee);
|
|
const senderID = getSenderId(attendeePhoneNumber, SENDER_ID);
|
|
return handleSendingSMS({
|
|
reminderPhone: attendeePhoneNumber,
|
|
smsMessage,
|
|
senderID,
|
|
teamId,
|
|
bookingUid,
|
|
organizerUserId: this.organizerUserId,
|
|
});
|
|
}
|
|
|
|
async sendSMSToAttendees() {
|
|
const smsToSend: Promise<unknown>[] = [];
|
|
|
|
if (!(await this.isSMSNotificationEnabled())) return;
|
|
|
|
for (const attendee of this.calEvent.attendees) {
|
|
smsToSend.push(this.sendSMSToAttendee(attendee, this.calEvent.uid));
|
|
}
|
|
|
|
await Promise.all(smsToSend);
|
|
}
|
|
}
|