Files
calendar/packages/trpc/server/routers/viewer/workflows/update.handler.ts
T
c4104af8a2 feat: org-wide workflows (#15083)
* add org to create workflow button

* add save button for testing in dev mode

* add select all to multi select dropdown

* fix select all

* pass isOrg to WorkflowDetailsPage

* add checkbox to apply to all including future

* fix count text on select

* WIP schema

* shows teams in dropdown

* add team option to UI

* [WIP] refactor for update handler

* filter out "all" from activeOn

* fix type error

* create more helper functions

* create reusable function for scheduling all booking reminders

* finish update workflows for orgs (without testing)

* fix isAuthorized check for orgs

* fix getting newActiveOn

* move all helper functions to util file

* more code clean up

* fix deleting reminders for org workflows

* fix adding and editing steps

* update form data when workflow is saved

* code clean up

* fixing creating/deleting reminders when user is member of several teams

* fix setting activeOn for teams in useffect

* add on delete cascade

* make multiSelectSchenbox searchable

* set activeOn correctly when checkbox true

* WIP

* fix type errors in MultiSelectCheckboxes

* implemented scheduling org-wide workfow notifications (not yet tested)

* fix type errors

* type error

* add missing changes from merge conflict

* remote not needed include statement

* fix type errors

* code clean up + some todo comments

* support org workflows for cancelled workflows

* delete reminders from removed members

* remove reminders if isActiveOnAll is turned off

* fix unti test and type error

* code clean up

* create basis for testing to book org team event

* create org workflow with active team

* fix getting active org workflows on team + test setup

* fix creating workflow step for tests

* fix first org test

* add test for user event type with org workflow active

* use deleteAllWorkflowReminders everywhere

* add test for deleteRemindersFromRemovedActiveOn

* fix type errors

* make all tests pass

* fix type error

* fix getSchedule test

* code clean up

* add missing import

* fix type error

* fix tests

* code clean up

* fix imports

* update reminders when trigger was changed

* check for teamId before userId in reminderScheduler

* move getOrgIdFromMemberOrTeamId to different folder

* code clean up

* fix tests

* test setup for scheduleBookingReminders

* fix typo

* add tests for scheduleBookingReminders

* fix prisma default import

* fix workflowStep type

* add scheduleBookingReminders test for sms

* return dummy sid for scheduleSMS testMode

* clean up + fixes

* add lost changes from merge

* get teamId and userId from incoming evt object

* removing not needed select

* add org support for scheduleMandatory email reminder

* add other teams to dropdown

* move getAllWorkflows to seperate file and call it in parent function

* include org wide workflows in createNewSeat

* some fixes + code clean up

* add new team to select text count when including future teams is checked

* fix upsert and remove sms reminder field

* correctly update activeOn if 'including future ...' is enabled

* list active Org workflows in event workflows settings

* fix sms reminder field in all handlers

* add helper function to check if step was edited

* fix active on badge on workflow

* fix type error

* fix double reminders

* add teamId: null for userWorkflow query

* fix activeOnAll with managed event types

* add missing teamId in getAllWorkflows

* add a dafaut to prisma param

* fix managed event types on select all user workflows

* code clean up

* better variable name

* small fixes in update handler

* fix test name to match function name

* add info badge

* fix workflow count in event type settings

* fix getting bookings from children manged event types

* delete reminders when user is not part of any time no more

* implement feedback

* fix disbale workflow in event type settings

* fix remove member

* create new function getAllWorkflowsFromEventType

* add some removed code

* use promise.allSettled when deleting workflow reminders

* create new function deleteWorkflowRemindersOfRemovedMember.ts

* fix userId param

* delete org worklfows when team is disbanded

* don't trigger active on all workflow if not part of any team

* fix active on count badge

* add test for deleteWorkflowRemidnersOfRemovedMember

* trigger workflow also if not member of any subteam

* fix failing test

* remove unused code

* use testId for go back button

* fixes for managed event types & activateEventTypeHandler

* code clean up

* don't activate workflow on locked managed event type

* fix type error

* type error

* more type fixes

* feedback

---------

Co-authored-by: CarinaWolli <wollencarina@gmail.com>
Co-authored-by: Hariom Balhara <hariombalhara@gmail.com>
Co-authored-by: Keith Williams <keithwillcode@gmail.com>
Co-authored-by: Udit Takkar <53316345+Udit-takkar@users.noreply.github.com>
2024-07-08 17:44:11 +05:30

522 lines
14 KiB
TypeScript
Executable File

import { isSMSOrWhatsappAction } from "@calcom/features/ee/workflows/lib/actionHelperFunctions";
import { IS_SELF_HOSTED } from "@calcom/lib/constants";
import hasKeyInMetadata from "@calcom/lib/hasKeyInMetadata";
import type { PrismaClient } from "@calcom/prisma";
import { WorkflowActions } from "@calcom/prisma/enums";
import type { TrpcSessionUser } from "@calcom/trpc/server/trpc";
import { TRPCError } from "@trpc/server";
import { hasTeamPlanHandler } from "../teams/hasTeamPlan.handler";
import type { TUpdateInputSchema } from "./update.schema";
import {
getSender,
isAuthorized,
upsertSmsReminderFieldForEventTypes,
deleteRemindersOfActiveOnIds,
isAuthorizedToAddActiveOnIds,
deleteAllWorkflowReminders,
scheduleWorkflowNotifications,
verifyEmailSender,
removeSmsReminderFieldForEventTypes,
isStepEdited,
} from "./util";
type UpdateOptions = {
ctx: {
user: NonNullable<TrpcSessionUser>;
prisma: PrismaClient;
};
input: TUpdateInputSchema;
};
export const updateHandler = async ({ ctx, input }: UpdateOptions) => {
const { user } = ctx;
const { id, name, activeOn, steps, trigger, time, timeUnit, isActiveOnAll } = input;
const userWorkflow = await ctx.prisma.workflow.findUnique({
where: {
id,
},
select: {
id: true,
userId: true,
isActiveOnAll: true,
trigger: true,
time: true,
timeUnit: true,
team: {
select: {
isOrganization: true,
},
},
teamId: true,
user: {
select: {
teams: true,
},
},
steps: true,
activeOn: true,
activeOnTeams: true,
},
});
const isOrg = !!userWorkflow?.team?.isOrganization;
const isUserAuthorized = await isAuthorized(userWorkflow, ctx.user.id, true);
if (!isUserAuthorized || !userWorkflow) {
throw new TRPCError({ code: "UNAUTHORIZED" });
}
if (steps.find((step) => step.workflowId != id)) {
throw new TRPCError({ code: "UNAUTHORIZED" });
}
const isCurrentUsernamePremium = hasKeyInMetadata(user, "isPremium") ? !!user.metadata.isPremium : false;
let isTeamsPlan = false;
if (!isCurrentUsernamePremium) {
const { hasTeamPlan } = await hasTeamPlanHandler({ ctx });
isTeamsPlan = !!hasTeamPlan;
}
const hasPaidPlan = IS_SELF_HOSTED || isCurrentUsernamePremium || isTeamsPlan;
let newActiveOn: number[] = [];
let removedActiveOnIds: number[] = [];
let activeOnWithChildren: number[] = activeOn;
let oldActiveOnIds: number[] = [];
if (!isOrg) {
// activeOn are event types ids
const activeOnEventTypes = await ctx.prisma.eventType.findMany({
where: {
id: {
in: activeOn,
},
...(userWorkflow.teamId && { parentId: null }), //all children managed event types are added after
},
select: {
id: true,
children: {
select: {
id: true,
},
},
},
});
activeOnWithChildren = activeOnEventTypes
.map((eventType) => [eventType.id].concat(eventType.children.map((child) => child.id)))
.flat();
let oldActiveOnEventTypes: { id: number; children: { id: number }[] }[];
if (userWorkflow.isActiveOnAll) {
oldActiveOnEventTypes = await ctx.prisma.eventType.findMany({
where: {
...(userWorkflow.teamId ? { teamId: userWorkflow.teamId } : { userId: userWorkflow.userId }),
},
select: {
id: true,
children: {
select: {
id: true,
},
},
},
});
} else {
oldActiveOnEventTypes = (
await ctx.prisma.workflowsOnEventTypes.findMany({
where: {
workflowId: id,
},
select: {
eventTypeId: true,
eventType: {
select: {
children: {
select: {
id: true,
},
},
},
},
},
})
).map((eventTypeRel) => {
return { id: eventTypeRel.eventTypeId, children: eventTypeRel.eventType.children };
});
}
oldActiveOnIds = oldActiveOnEventTypes.flatMap((eventType) => [
eventType.id,
...eventType.children.map((child) => child.id),
]);
newActiveOn = activeOn.filter((eventTypeId) => !oldActiveOnIds.includes(eventTypeId));
const isAuthorizedToAddIds = await isAuthorizedToAddActiveOnIds(
newActiveOn,
isOrg,
userWorkflow?.teamId,
userWorkflow?.userId
);
if (!isAuthorizedToAddIds) {
throw new TRPCError({ code: "UNAUTHORIZED" });
}
//remove all scheduled Email and SMS reminders for eventTypes that are not active any more
removedActiveOnIds = oldActiveOnIds.filter((eventTypeId) => !activeOnWithChildren.includes(eventTypeId));
await deleteRemindersOfActiveOnIds({ removedActiveOnIds, workflowSteps: userWorkflow.steps, isOrg });
//update active on
await ctx.prisma.workflowsOnEventTypes.deleteMany({
where: {
workflowId: id,
},
});
//create all workflow - eventtypes relationships
await ctx.prisma.workflowsOnEventTypes.createMany({
data: activeOnWithChildren.map((eventTypeId) => ({
workflowId: id,
eventTypeId,
})),
});
} else {
// activeOn are team ids
if (userWorkflow.isActiveOnAll) {
oldActiveOnIds = (
await ctx.prisma.team.findMany({
where: {
parent: {
id: userWorkflow.teamId ?? 0,
},
},
select: {
id: true,
},
})
).map((team) => team.id);
} else {
oldActiveOnIds = (
await ctx.prisma.workflowsOnTeams.findMany({
where: {
workflowId: id,
},
select: {
teamId: true,
},
})
).map((teamRel) => teamRel.teamId);
}
newActiveOn = activeOn.filter((teamId) => !oldActiveOnIds.includes(teamId));
const isAuthorizedToAddIds = await isAuthorizedToAddActiveOnIds(
newActiveOn,
isOrg,
userWorkflow?.teamId,
userWorkflow?.userId
);
if (!isAuthorizedToAddIds) {
throw new TRPCError({ code: "UNAUTHORIZED" });
}
removedActiveOnIds = oldActiveOnIds.filter((teamId) => !activeOn.includes(teamId));
await deleteRemindersOfActiveOnIds({
removedActiveOnIds,
workflowSteps: userWorkflow.steps,
isOrg,
activeOnIds: activeOn.filter((activeOn) => !newActiveOn.includes(activeOn)),
});
//update active on
await ctx.prisma.workflowsOnTeams.deleteMany({
where: {
workflowId: id,
},
});
await ctx.prisma.workflowsOnTeams.createMany({
data: activeOn.map((teamId) => ({
workflowId: id,
teamId,
})),
});
}
if (userWorkflow.trigger !== trigger || userWorkflow.time !== time || userWorkflow.timeUnit !== timeUnit) {
//if trigger changed, delete all reminders from steps before change
await deleteRemindersOfActiveOnIds({
removedActiveOnIds: oldActiveOnIds,
workflowSteps: userWorkflow.steps,
isOrg,
});
await scheduleWorkflowNotifications(
activeOn, // schedule for activeOn that stayed the same + new active on (old reminders were deleted)
isOrg,
userWorkflow.steps, // use old steps here, edited and deleted steps are handled below
time,
timeUnit,
trigger,
user.id,
userWorkflow.teamId
);
} else {
// if trigger didn't change, only schedule reminders for all new activeOn
await scheduleWorkflowNotifications(
newActiveOn,
isOrg,
userWorkflow.steps, // use old steps here, edited and deleted steps are handled below
time,
timeUnit,
trigger,
user.id,
userWorkflow.teamId,
activeOn.filter((activeOn) => !newActiveOn.includes(activeOn)) // alreadyScheduledActiveOnIds
);
}
// handle deleted and edited workflow steps
userWorkflow.steps.map(async (oldStep) => {
const foundStep = steps.find((s) => s.id === oldStep.id);
let newStep;
if (foundStep) {
const { senderName, ...rest } = {
...foundStep,
numberVerificationPending: false,
sender: getSender({
action: foundStep.action,
sender: foundStep.sender || null,
senderName: foundStep.senderName,
}),
};
newStep = rest;
}
const remindersFromStep = await ctx.prisma.workflowReminder.findMany({
where: {
workflowStepId: oldStep.id,
},
select: {
id: true,
referenceId: true,
method: true,
booking: {
select: {
eventTypeId: true,
},
},
},
});
//step was deleted
if (!newStep) {
// cancel all workflow reminders from deleted steps
await deleteAllWorkflowReminders(remindersFromStep);
await ctx.prisma.workflowStep.delete({
where: {
id: oldStep.id,
},
});
} else if (isStepEdited(oldStep, newStep)) {
// check if step that require team plan already existed before
if (!hasPaidPlan && !isSMSOrWhatsappAction(oldStep.action) && isSMSOrWhatsappAction(newStep.action)) {
throw new TRPCError({ code: "UNAUTHORIZED", message: "Not available on free plan" });
}
// update step
const requiresSender =
newStep.action === WorkflowActions.SMS_NUMBER ||
newStep.action === WorkflowActions.WHATSAPP_NUMBER ||
newStep.action === WorkflowActions.EMAIL_ADDRESS;
if (newStep.action === WorkflowActions.EMAIL_ADDRESS) {
await verifyEmailSender(newStep.sendTo || "", user.id, userWorkflow.teamId);
}
await ctx.prisma.workflowStep.update({
where: {
id: oldStep.id,
},
data: {
action: newStep.action,
sendTo: requiresSender ? newStep.sendTo : null,
stepNumber: newStep.stepNumber,
workflowId: newStep.workflowId,
reminderBody: newStep.reminderBody,
emailSubject: newStep.emailSubject,
template: newStep.template,
numberRequired: newStep.numberRequired,
sender: newStep.sender,
numberVerificationPending: false,
includeCalendarEvent: newStep.includeCalendarEvent,
},
});
// cancel all notifications of edited step
await deleteAllWorkflowReminders(remindersFromStep);
// schedule notifications for edited steps
await scheduleWorkflowNotifications(
activeOn,
isOrg,
[newStep],
time,
timeUnit,
trigger,
user.id,
userWorkflow.teamId
);
}
});
// handle added workflow steps
const addedSteps = await Promise.all(
steps
.filter((step) => step.id <= 0)
.map(async (newStep) => {
if (isSMSOrWhatsappAction(newStep.action) && !hasPaidPlan) {
throw new TRPCError({ code: "UNAUTHORIZED", message: "Not available on free plan" });
}
if (newStep.action === WorkflowActions.EMAIL_ADDRESS) {
await verifyEmailSender(newStep.sendTo || "", user.id, userWorkflow.teamId);
}
const {
id: _stepId,
senderName,
...stepToAdd
} = {
...newStep,
sender: getSender({
action: newStep.action,
sender: newStep.sender || null,
senderName: newStep.senderName,
}),
};
return stepToAdd;
})
);
if (addedSteps.length) {
//create new steps
const createdSteps = await Promise.all(
addedSteps.map((step) =>
ctx.prisma.workflowStep.create({
data: { ...step, numberVerificationPending: false },
})
)
);
// schedule notification for new step
await scheduleWorkflowNotifications(
activeOn,
isOrg,
createdSteps,
time,
timeUnit,
trigger,
user.id,
userWorkflow.teamId
);
}
//update trigger, name, time, timeUnit
await ctx.prisma.workflow.update({
where: {
id,
},
data: {
name,
trigger,
time,
timeUnit,
isActiveOnAll,
},
});
const workflow = await ctx.prisma.workflow.findFirst({
where: {
id,
},
include: {
activeOn: {
select: {
eventType: true,
},
},
activeOnTeams: {
select: {
team: true,
},
},
team: {
select: {
id: true,
slug: true,
members: true,
name: true,
isOrganization: true,
},
},
steps: {
orderBy: {
stepNumber: "asc",
},
},
},
});
// Remove or add booking field for sms reminder number
const smsReminderNumberNeeded =
activeOn.length &&
steps.some(
(step) =>
step.action === WorkflowActions.SMS_ATTENDEE || step.action === WorkflowActions.WHATSAPP_ATTENDEE
);
await removeSmsReminderFieldForEventTypes({
activeOnToRemove: removedActiveOnIds,
workflowId: id,
isOrg,
activeOn,
});
if (!smsReminderNumberNeeded) {
await removeSmsReminderFieldForEventTypes({
activeOnToRemove: activeOnWithChildren,
workflowId: id,
isOrg,
});
} else {
await upsertSmsReminderFieldForEventTypes({
activeOn: activeOnWithChildren,
workflowId: id,
isSmsReminderNumberRequired: steps.some(
(s) =>
(s.action === WorkflowActions.SMS_ATTENDEE || s.action === WorkflowActions.WHATSAPP_ATTENDEE) &&
s.numberRequired
),
isOrg,
});
}
return {
workflow,
};
};