* add workflows to bookingScenario * activate sandbox mode for unit/integreation tests * add sendgrid specific code to SendgridProvider * Refactor WIP * remove duplicate sendgridProvider file * first implementation for testing workflows * revert unintended changes * comment out Workflow trigger tests * move sendgrid check after test mode * Update signup.tsx * fix esLint * test webhooks on all tests in fresh-booking.test.ts * fix subjectPattern as title can be different * add workflow tests to reschedule.test.ts * code clean up * code clean up * fix sendgrid credentials missing message * code clean up --------- Co-authored-by: CarinaWolli <wollencarina@gmail.com>
352 lines
12 KiB
TypeScript
352 lines
12 KiB
TypeScript
/* Schedule any workflow reminder that falls within 72 hours for email */
|
|
import client from "@sendgrid/client";
|
|
import type { NextApiRequest, NextApiResponse } from "next";
|
|
import { v4 as uuidv4 } from "uuid";
|
|
|
|
import dayjs from "@calcom/dayjs";
|
|
import { getCalEventResponses } from "@calcom/features/bookings/lib/getCalEventResponses";
|
|
import logger from "@calcom/lib/logger";
|
|
import { defaultHandler } from "@calcom/lib/server";
|
|
import { getTimeFormatStringFromUserTimeFormat } from "@calcom/lib/timeFormat";
|
|
import prisma from "@calcom/prisma";
|
|
import { WorkflowActions, WorkflowMethods, WorkflowTemplates } from "@calcom/prisma/enums";
|
|
import { bookingMetadataSchema } from "@calcom/prisma/zod-utils";
|
|
|
|
import type { PartialWorkflowReminder } from "../lib/getWorkflowReminders";
|
|
import {
|
|
getAllRemindersToCancel,
|
|
getAllRemindersToDelete,
|
|
getAllUnscheduledReminders,
|
|
} from "../lib/getWorkflowReminders";
|
|
import { getiCalEventAsString } from "../lib/getiCalEventAsString";
|
|
import { sendSendgridMail } from "../lib/reminders/providers/sendgridProvider";
|
|
import type { VariablesType } from "../lib/reminders/templates/customTemplate";
|
|
import customTemplate from "../lib/reminders/templates/customTemplate";
|
|
import emailReminderTemplate from "../lib/reminders/templates/emailReminderTemplate";
|
|
|
|
async function handler(req: NextApiRequest, res: NextApiResponse) {
|
|
const apiKey = req.headers.authorization || req.query.apiKey;
|
|
if (process.env.CRON_API_KEY !== apiKey) {
|
|
res.status(401).json({ message: "Not authenticated" });
|
|
return;
|
|
}
|
|
|
|
if (!process.env.SENDGRID_API_KEY || !process.env.SENDGRID_EMAIL) {
|
|
res.status(405).json({ message: "No SendGrid API key or email" });
|
|
return;
|
|
}
|
|
|
|
// delete batch_ids with already past scheduled date from scheduled_sends
|
|
const remindersToDelete: { referenceId: string | null }[] = await getAllRemindersToDelete();
|
|
|
|
const deletePromises: Promise<any>[] = [];
|
|
|
|
for (const reminder of remindersToDelete) {
|
|
const deletePromise = client.request({
|
|
url: `/v3/user/scheduled_sends/${reminder.referenceId}`,
|
|
method: "DELETE",
|
|
});
|
|
deletePromises.push(deletePromise);
|
|
}
|
|
|
|
Promise.allSettled(deletePromises).then((results) => {
|
|
results.forEach((result) => {
|
|
if (result.status === "rejected") {
|
|
logger.error(`Error deleting batch id from scheduled_sends: ${result.reason}`);
|
|
}
|
|
});
|
|
});
|
|
|
|
//delete workflow reminders with past scheduled date
|
|
await prisma.workflowReminder.deleteMany({
|
|
where: {
|
|
method: WorkflowMethods.EMAIL,
|
|
scheduledDate: {
|
|
lte: dayjs().toISOString(),
|
|
},
|
|
},
|
|
});
|
|
|
|
//cancel reminders for cancelled/rescheduled bookings that are scheduled within the next hour
|
|
const remindersToCancel: { referenceId: string | null; id: number }[] = await getAllRemindersToCancel();
|
|
|
|
const cancelUpdatePromises: Promise<any>[] = [];
|
|
|
|
for (const reminder of remindersToCancel) {
|
|
const cancelPromise = client.request({
|
|
url: "/v3/user/scheduled_sends",
|
|
method: "POST",
|
|
body: {
|
|
batch_id: reminder.referenceId,
|
|
status: "cancel",
|
|
},
|
|
});
|
|
|
|
const updatePromise = prisma.workflowReminder.update({
|
|
where: {
|
|
id: reminder.id,
|
|
},
|
|
data: {
|
|
scheduled: false, // to know which reminder already got cancelled (to avoid error from cancelling the same reminders again)
|
|
},
|
|
});
|
|
|
|
cancelUpdatePromises.push(cancelPromise, updatePromise);
|
|
}
|
|
|
|
Promise.allSettled(cancelUpdatePromises).then((results) => {
|
|
results.forEach((result) => {
|
|
if (result.status === "rejected") {
|
|
logger.error(`Error cancelling scheduled_sends: ${result.reason}`);
|
|
}
|
|
});
|
|
});
|
|
|
|
// schedule all unscheduled reminders within the next 72 hours
|
|
const sendEmailPromises: Promise<any>[] = [];
|
|
|
|
const unscheduledReminders: PartialWorkflowReminder[] = await getAllUnscheduledReminders();
|
|
|
|
if (!unscheduledReminders.length) {
|
|
res.status(200).json({ message: "No Emails to schedule" });
|
|
return;
|
|
}
|
|
|
|
for (const reminder of unscheduledReminders) {
|
|
if (!reminder.booking) {
|
|
continue;
|
|
}
|
|
if (!reminder.isMandatoryReminder && reminder.workflowStep) {
|
|
try {
|
|
let sendTo;
|
|
|
|
switch (reminder.workflowStep.action) {
|
|
case WorkflowActions.EMAIL_HOST:
|
|
sendTo = reminder.booking.user?.email;
|
|
break;
|
|
case WorkflowActions.EMAIL_ATTENDEE:
|
|
sendTo = reminder.booking.attendees[0].email;
|
|
break;
|
|
case WorkflowActions.EMAIL_ADDRESS:
|
|
sendTo = reminder.workflowStep.sendTo;
|
|
}
|
|
|
|
const name =
|
|
reminder.workflowStep.action === WorkflowActions.EMAIL_ATTENDEE
|
|
? reminder.booking.attendees[0].name
|
|
: reminder.booking.user?.name;
|
|
|
|
const attendeeName =
|
|
reminder.workflowStep.action === WorkflowActions.EMAIL_ATTENDEE
|
|
? reminder.booking.user?.name
|
|
: reminder.booking.attendees[0].name;
|
|
|
|
const timeZone =
|
|
reminder.workflowStep.action === WorkflowActions.EMAIL_ATTENDEE
|
|
? reminder.booking.attendees[0].timeZone
|
|
: reminder.booking.user?.timeZone;
|
|
|
|
const locale =
|
|
reminder.workflowStep.action === WorkflowActions.EMAIL_ATTENDEE ||
|
|
reminder.workflowStep.action === WorkflowActions.SMS_ATTENDEE
|
|
? reminder.booking.attendees[0].locale
|
|
: reminder.booking.user?.locale;
|
|
|
|
let emailContent = {
|
|
emailSubject: reminder.workflowStep.emailSubject || "",
|
|
emailBody: `<body style="white-space: pre-wrap;">${
|
|
reminder.workflowStep.reminderBody || ""
|
|
}</body>`,
|
|
};
|
|
|
|
let emailBodyEmpty = false;
|
|
|
|
if (reminder.workflowStep.reminderBody) {
|
|
const { responses } = getCalEventResponses({
|
|
bookingFields: reminder.booking.eventType?.bookingFields ?? null,
|
|
booking: reminder.booking,
|
|
});
|
|
|
|
const variables: VariablesType = {
|
|
eventName: reminder.booking.eventType?.title || "",
|
|
organizerName: reminder.booking.user?.name || "",
|
|
attendeeName: reminder.booking.attendees[0].name,
|
|
attendeeEmail: reminder.booking.attendees[0].email,
|
|
eventDate: dayjs(reminder.booking.startTime).tz(timeZone),
|
|
eventEndTime: dayjs(reminder.booking?.endTime).tz(timeZone),
|
|
timeZone: timeZone,
|
|
location: reminder.booking.location || "",
|
|
additionalNotes: reminder.booking.description,
|
|
responses: responses,
|
|
meetingUrl: bookingMetadataSchema.parse(reminder.booking.metadata || {})?.videoCallUrl,
|
|
cancelLink: `/booking/${reminder.booking.uid}?cancel=true`,
|
|
rescheduleLink: `/${reminder.booking.user?.username}/${reminder.booking.eventType?.slug}?rescheduleUid=${reminder.booking.uid}`,
|
|
};
|
|
const emailLocale = locale || "en";
|
|
const emailSubject = customTemplate(
|
|
reminder.workflowStep.emailSubject || "",
|
|
variables,
|
|
emailLocale,
|
|
getTimeFormatStringFromUserTimeFormat(reminder.booking.user?.timeFormat),
|
|
!!reminder.booking.user?.hideBranding
|
|
).text;
|
|
emailContent.emailSubject = emailSubject;
|
|
emailContent.emailBody = customTemplate(
|
|
reminder.workflowStep.reminderBody || "",
|
|
variables,
|
|
emailLocale,
|
|
getTimeFormatStringFromUserTimeFormat(reminder.booking.user?.timeFormat),
|
|
!!reminder.booking.user?.hideBranding
|
|
).html;
|
|
|
|
emailBodyEmpty =
|
|
customTemplate(
|
|
reminder.workflowStep.reminderBody || "",
|
|
variables,
|
|
emailLocale,
|
|
getTimeFormatStringFromUserTimeFormat(reminder.booking.user?.timeFormat)
|
|
).text.length === 0;
|
|
} else if (reminder.workflowStep.template === WorkflowTemplates.REMINDER) {
|
|
emailContent = emailReminderTemplate(
|
|
false,
|
|
reminder.workflowStep.action,
|
|
getTimeFormatStringFromUserTimeFormat(reminder.booking.user?.timeFormat),
|
|
reminder.booking.startTime.toISOString() || "",
|
|
reminder.booking.endTime.toISOString() || "",
|
|
reminder.booking.eventType?.title || "",
|
|
timeZone || "",
|
|
attendeeName || "",
|
|
name || "",
|
|
!!reminder.booking.user?.hideBranding
|
|
);
|
|
}
|
|
|
|
if (emailContent.emailSubject.length > 0 && !emailBodyEmpty && sendTo) {
|
|
const batchIdResponse = await client.request({
|
|
url: "/v3/mail/batch",
|
|
method: "POST",
|
|
});
|
|
|
|
const batchId = batchIdResponse[1].batch_id;
|
|
|
|
if (reminder.workflowStep.action !== WorkflowActions.EMAIL_ADDRESS) {
|
|
sendEmailPromises.push(
|
|
sendSendgridMail(
|
|
{
|
|
to: sendTo,
|
|
subject: emailContent.emailSubject,
|
|
html: emailContent.emailBody,
|
|
batchId: batchId,
|
|
sendAt: dayjs(reminder.scheduledDate).unix(),
|
|
replyTo: reminder.booking.user?.email,
|
|
attachments: reminder.workflowStep.includeCalendarEvent
|
|
? [
|
|
{
|
|
content: Buffer.from(getiCalEventAsString(reminder.booking) || "").toString(
|
|
"base64"
|
|
),
|
|
filename: "event.ics",
|
|
type: "text/calendar; method=REQUEST",
|
|
disposition: "attachment",
|
|
contentId: uuidv4(),
|
|
},
|
|
]
|
|
: undefined,
|
|
},
|
|
{ sender: reminder.workflowStep.sender }
|
|
)
|
|
);
|
|
}
|
|
|
|
await prisma.workflowReminder.update({
|
|
where: {
|
|
id: reminder.id,
|
|
},
|
|
data: {
|
|
scheduled: true,
|
|
referenceId: batchId,
|
|
},
|
|
});
|
|
}
|
|
} catch (error) {
|
|
logger.error(`Error scheduling Email with error ${error}`);
|
|
}
|
|
} else if (reminder.isMandatoryReminder) {
|
|
try {
|
|
const sendTo = reminder.booking.attendees[0].email;
|
|
const name = reminder.booking.attendees[0].name;
|
|
const attendeeName = reminder.booking.user?.name;
|
|
const timeZone = reminder.booking.attendees[0].timeZone;
|
|
|
|
let emailContent = {
|
|
emailSubject: "",
|
|
emailBody: "",
|
|
};
|
|
|
|
const emailBodyEmpty = false;
|
|
|
|
emailContent = emailReminderTemplate(
|
|
false,
|
|
WorkflowActions.EMAIL_ATTENDEE,
|
|
getTimeFormatStringFromUserTimeFormat(reminder.booking.user?.timeFormat),
|
|
reminder.booking.startTime.toISOString() || "",
|
|
reminder.booking.endTime.toISOString() || "",
|
|
reminder.booking.eventType?.title || "",
|
|
timeZone || "",
|
|
attendeeName || "",
|
|
name || "",
|
|
!!reminder.booking.user?.hideBranding
|
|
);
|
|
if (emailContent.emailSubject.length > 0 && !emailBodyEmpty && sendTo) {
|
|
const batchIdResponse = await client.request({
|
|
url: "/v3/mail/batch",
|
|
method: "POST",
|
|
});
|
|
|
|
const batchId = batchIdResponse[1].batch_id;
|
|
|
|
sendEmailPromises.push(
|
|
sendSendgridMail(
|
|
{
|
|
to: sendTo,
|
|
subject: emailContent.emailSubject,
|
|
html: emailContent.emailBody,
|
|
batchId: batchId,
|
|
sendAt: dayjs(reminder.scheduledDate).unix(),
|
|
replyTo: reminder.booking.user?.email,
|
|
},
|
|
{ sender: reminder.workflowStep?.sender }
|
|
)
|
|
);
|
|
|
|
await prisma.workflowReminder.update({
|
|
where: {
|
|
id: reminder.id,
|
|
},
|
|
data: {
|
|
scheduled: true,
|
|
referenceId: batchId,
|
|
},
|
|
});
|
|
}
|
|
} catch (error) {
|
|
logger.error(`Error scheduling Email with error ${error}`);
|
|
}
|
|
}
|
|
}
|
|
|
|
Promise.allSettled(sendEmailPromises).then((results) => {
|
|
results.forEach((result) => {
|
|
if (result.status === "rejected") {
|
|
logger.error("Email sending failed", result.reason);
|
|
}
|
|
});
|
|
});
|
|
|
|
res.status(200).json({ message: `${unscheduledReminders.length} Emails scheduled` });
|
|
}
|
|
|
|
export default defaultHandler({
|
|
POST: Promise.resolve({ default: handler }),
|
|
});
|