feat: org-wide workflows #15083

CarinaWolli · 2024-05-16T17:03:40Z

What does this PR do?

Org-workflow can be set active on teams and will trigger for all the team event types + all the user event types of the team members.
- if a user is member of several active teams, the workflow only triggers once
Add 'apply to all, including future teams/event-types'
workflows/update.handler is refactored into smaller functions that can be reused and tested.
Also fixes some small existing bugs that I found when refactoring the code

Fixes #14638
Fixes CAL-3489

Mandatory Tasks (DO NOT REMOVE)

I have self-reviewed the code (A decent size PR without self-review might be rejected)
I have added a Docs issue here if this PR makes changes that would require a documentation change --> Created an issue for that: Org-wide workflows docs#93
I have added or modified automated tests that prove my fix is effective or that my feature works (PRs might be rejected if logical changes are not properly tested)

How should this be tested?

Basic test:

Create an org workflow
Set active on a team (or all teams)
Book a team event type --> see if workflow triggers
Book a user event type of a team member --> see if workflow triggers

Test other cases, for example:

test with several teams when some team members are part of several teams --> a workflow should always just trigger once
Test updating a 'before event' workflow and see if WorkflowReminders are correctly adjusted
Test removing team workflow and see if reminders are deleted (if user is still part of another team that is active, the reminder should stay)
delete/add reminders for deleted/added steps
Add reminders for new active teams
Test if 'active on all teams/even-types, including future ones' works with new event types/teams

CarinaWolli · 2024-06-04T20:37:55Z

packages/features/ee/workflows/lib/reminders/reminderScheduler.ts

-const reminderMethods: { [x: string]: (id: number, referenceId: string | null) => void } = {
-  [WorkflowMethods.EMAIL]: deleteScheduledEmailReminder,
-  [WorkflowMethods.SMS]: deleteScheduledSMSReminder,
-  [WorkflowMethods.WHATSAPP]: deleteScheduledWhatsappReminder,
-};
-
-export const cancelWorkflowReminders = async (
-  workflowReminders: { method: WorkflowMethods; id: number; referenceId: string | null }[]
-) => {
-  await Promise.all(
-    workflowReminders.map((reminder) => {
-      return reminderMethods[reminder.method](reminder.id, reminder.referenceId);
-    })
-  );
-};


moved to viewer/workflows/util.ts and renamed to deleteWorkflowReminders

CarinaWolli · 2024-06-04T20:40:06Z

packages/features/ee/workflows/lib/reminders/reminderScheduler.ts

+
+  if (orgId) {
+    if (teamId) {
+      const orgTeamWorkflowsRel = await prisma.workflowsOnTeams.findMany({


all active org workflows that are active on the team of the event type

CarinaWolli · 2024-06-04T20:40:41Z

packages/features/ee/workflows/lib/reminders/reminderScheduler.ts

+      const orgTeamWorkflows = orgTeamWorkflowsRel?.map((workflowRel) => workflowRel.workflow) ?? [];
+      allWorkflows.push(...orgTeamWorkflows);
+    } else if (userId) {
+      const orgUserWorkflowsRel = await prisma.workflowsOnTeams.findMany({


all active org workflows where user is part of a team that is active on workflow

CarinaWolli · 2024-06-04T20:41:42Z

packages/features/ee/workflows/lib/reminders/reminderScheduler.ts

+      allWorkflows.push(...orgUserWorkflows);
+    }
+
+    const activeOnAllOrgWorkflows = await prisma.workflow.findMany({


all org workflows where isActiveOnAll is true, duplicated are removed later

CarinaWolli · 2024-06-04T20:43:02Z

packages/features/ee/workflows/lib/reminders/reminderScheduler.ts

+  }
+
+  if (teamId) {
+    const activeOnAllTeamWorkflows = await prisma.workflow.findMany({


All normal team workflows where isActiveOnAll is true. Other active workflows are already included in eventTypeWorkflows

CarinaWolli · 2024-06-06T13:22:36Z

packages/trpc/server/routers/viewer/workflows/update.handler.ts

-const verifyEmailSender = async (
-  email: string,
-  userId: number,
-  teamId: number | null,
-  prisma: PrismaClient
-) => {
-  const verifiedEmail = await prisma.verifiedEmail.findFirst({
-    where: {
-      email,
-      OR: [{ userId }, { teamId }],
-    },
-  });
-
-  if (!verifiedEmail) {
-    throw new TRPCError({ code: "NOT_FOUND", message: "Email not verified" });
-  }
-
-  if (teamId) {
-    if (!verifiedEmail.teamId) {
-      await prisma.verifiedEmail.update({
-        where: {
-          id: verifiedEmail.id,
-        },
-        data: {
-          teamId,
-        },
-      });
-    } else if (verifiedEmail.teamId !== teamId) {
-      await prisma.verifiedEmail.create({
-        data: {
-          email,
-          userId,
-          teamId,
-        },
-      });
-    }
-  }
-};


verifyEmailSender was moved to workfows/utils.ts https://github.com/calcom/cal.com/pull/15083/files#diff-f6ef6880041c2afa0023a8b231030af6fc89b5c067f3920efa906890c100734fR71

CarinaWolli · 2024-06-06T13:31:27Z

packages/trpc/server/routers/viewer/workflows/update.handler.ts

-  for (const newEventTypeId of newActiveEventTypes) {
-    const newEventType = await ctx.prisma.eventType.findFirst({
+  if (!isOrg) {
+    // activeOn are event types ids


This code didn't change much from before

CarinaWolli · 2024-06-06T13:32:17Z

packages/trpc/server/routers/viewer/workflows/update.handler.ts

+        eventTypeId,
+      })),
+    });
+  } else {


the else part handles updating org workflows, that's new code

CarinaWolli · 2024-06-06T13:44:00Z

packages/trpc/server/routers/viewer/workflows/update.handler.ts

+  }
+
+  //todo: test this
+  if (userWorkflow.trigger !== trigger) {


updating already scheduled reminders when trigger is changed was not handled before, this was a bug

CarinaWolli · 2024-06-10T20:07:22Z

packages/features/ee/workflows/components/WorkflowDetailsPage.tsx

-  const eventTypeOptions = useMemo(
-    () =>
-      data?.eventTypeGroups.reduce((options, group) => {
-        /** don't show team event types for user workflow */
-        if (!teamId && group.teamId) return options;
-        /** only show correct team event types for team workflows */
-        if (teamId && teamId !== group.teamId) return options;
-        return [
-          ...options,
-          ...group.eventTypes
-            .filter(
-              (evType) =>
-                !evType.metadata?.managedEventConfig ||
-                !!evType.metadata?.managedEventConfig.unlockedFields?.workflows ||
-                !!teamId
-            )
-            .map((eventType) => ({
-              value: String(eventType.id),
-              label: `${eventType.title} ${
-                eventType.children && eventType.children.length ? `(+${eventType.children.length})` : ``
-              }`,
-            })),
-        ];
-      }, [] as Option[]) || [],
-    [data]
-  );
-
-  let allEventTypeOptions = eventTypeOptions;
-  const distinctEventTypes = new Set();
-
-  if (!teamId && isMixedEventType) {
-    allEventTypeOptions = [...eventTypeOptions, ...selectedEventTypes];
-    allEventTypeOptions = allEventTypeOptions.filter((option) => {
-      const duplicate = distinctEventTypes.has(option.value);
-      distinctEventTypes.add(option.value);
-      return !duplicate;
-    });
-  }
-


moved to parent component workflow.tsx

graphite-app · 2024-06-11T13:55:11Z

Graphite Automations

"Add foundation team as reviewer" took an action on this PR • (06/11/24)

1 reviewer was added to this PR based on Keith Williams's automation.

"Add consumer team as reviewer" took an action on this PR • (06/11/24)

1 reviewer was added to this PR based on Keith Williams's automation.

hariombalhara · 2024-06-12T12:22:44Z

Workflow count is wrong on the left. This is the case for Acme's owner's event

Also, the Org workflow toggle isn't in its disabled state visually

hariombalhara · 2024-06-12T12:26:20Z

I think to clearly communicate the meaning, we should change the message to Active on all teams and their members

Initially I thought it could be just the team events but it is those team's members' events as well.

hariombalhara

Getting my head around workflows right now. So, submitting partial review

hariombalhara · 2024-06-12T11:58:18Z

packages/features/ee/workflows/lib/test/workflows.test.ts

+  return workflow;
+}
+
+describe("deleteRemindersFromRemovedActiveOn", () => {


Suggested change

describe("deleteRemindersFromRemovedActiveOn", () => {

describe("deleteRemindersOfActiveOnIds", () => {

hariombalhara · 2024-06-12T12:13:42Z

packages/trpc/server/routers/viewer/workflows/util.ts

+            //team event types + children managed event types
+            booking: {
+              eventType: {
+                OR: [{ teamId: teamId }, { parentId: teamId, teamId: null }],


Isn't parentId an eventTypeId ?

hariombalhara

Getting my head around workflows right now. So, submitting partial review

hariombalhara · 2024-06-12T14:26:34Z

Have we handled the cleanup of workflows when a user is removed from a team. In my testing I found that the reminder remains even when there is no team.

No Team is there. The user was a member of a team earlier

But workflow that came from Org is still there

CarinaWolli added 30 commits April 25, 2024 13:08

add org to create workflow button

8e15673

add save button for testing in dev mode

03d1aa0

add select all to multi select dropdown

333f7f6

fix select all

35e1bb6

Merge branch 'main' into feat/org-wide-workflows

70bd85e

pass isOrg to WorkflowDetailsPage

baec108

add checkbox to apply to all including future

2a35068

fix count text on select

65520de

WIP schema

01484b4

Merge branch 'main' into feat/org-wide-workflows

4986700

shows teams in dropdown

b55440b

add team option to UI

9a195c6

[WIP] refactor for update handler

a400c2b

Merge branch 'main' into feat/org-wide-workflows

f3a1095

filter out "all" from activeOn

8780c4c

fix type error

3716e46

create more helper functions

51f5484

create reusable function for scheduling all booking reminders

297a76d

finish update workflows for orgs (without testing)

24f1160

fix isAuthorized check for orgs

04530ac

fix getting newActiveOn

515eb2b

move all helper functions to util file

12d4808

more code clean up

91d84c0

fix deleting reminders for org workflows

349f62f

fix adding and editing steps

3de7180

update form data when workflow is saved

68ab037

Merge branch 'main' into feat/org-wide-workflows

1a384f7

code clean up

1c68170

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

d9594f3

fix setting activeOn for teams in useffect

fdb796b

fix managed event types on select all user workflows

8698d92

vercel bot deployed to Preview – ai June 10, 2024 19:43 View deployment

vercel bot deployed to Preview – api June 10, 2024 19:46 View deployment

vercel bot deployed to Preview – dev June 10, 2024 19:52 View deployment

CarinaWolli added 2 commits June 10, 2024 20:24

code clean up

7268fef

Merge branch 'main' into feat/org-wide-workflows

d8436ea

vercel bot deployed to Preview – ai June 10, 2024 20:44 View deployment

vercel bot deployed to Preview – api June 10, 2024 20:53 View deployment

vercel bot deployed to Preview – dev June 10, 2024 21:05 View deployment

better variable name

77af1dc

vercel bot deployed to Preview – api June 10, 2024 23:50 View deployment

vercel bot deployed to Preview – dev June 10, 2024 23:55 View deployment

CarinaWolli added 2 commits June 11, 2024 13:41

small fixes in update handler

ec27c9c

Merge branch 'main' into feat/org-wide-workflows

f661e6a

CarinaWolli commented Jun 11, 2024

View reviewed changes

vercel bot deployed to Preview – api June 11, 2024 13:50 View deployment

CarinaWolli marked this pull request as ready for review June 11, 2024 13:54

CarinaWolli requested a review from a team June 11, 2024 13:54

graphite-app bot requested a review from a team June 11, 2024 13:54

dosubot bot added bookings area: bookings, availability, timezones, double booking teams area: teams, round robin, collective, managed event-types workflows area: workflows, automations ✨ feature New feature or request labels Jun 11, 2024

vercel bot deployed to Preview – dev June 11, 2024 13:56 View deployment

hariombalhara reviewed Jun 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: org-wide workflows #15083

feat: org-wide workflows #15083

CarinaWolli commented May 16, 2024 •

edited

CarinaWolli Jun 4, 2024

CarinaWolli Jun 4, 2024

CarinaWolli Jun 4, 2024

CarinaWolli Jun 4, 2024

CarinaWolli Jun 4, 2024

CarinaWolli Jun 6, 2024

CarinaWolli Jun 6, 2024

CarinaWolli Jun 6, 2024

CarinaWolli Jun 6, 2024

CarinaWolli Jun 10, 2024

graphite-app bot commented Jun 11, 2024

hariombalhara commented Jun 12, 2024 •

edited

hariombalhara commented Jun 12, 2024 •

edited

hariombalhara left a comment

hariombalhara Jun 12, 2024

hariombalhara Jun 12, 2024

hariombalhara left a comment

hariombalhara commented Jun 12, 2024

	describe("deleteRemindersFromRemovedActiveOn", () => {
	describe("deleteRemindersOfActiveOnIds", () => {

feat: org-wide workflows #15083

Are you sure you want to change the base?

feat: org-wide workflows #15083

Conversation

CarinaWolli commented May 16, 2024 • edited

What does this PR do?

Mandatory Tasks (DO NOT REMOVE)

How should this be tested?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

graphite-app bot commented Jun 11, 2024

Graphite Automations

hariombalhara commented Jun 12, 2024 • edited

hariombalhara commented Jun 12, 2024 • edited

hariombalhara left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hariombalhara left a comment

Choose a reason for hiding this comment

hariombalhara commented Jun 12, 2024

CarinaWolli commented May 16, 2024 •

edited

hariombalhara commented Jun 12, 2024 •

edited

hariombalhara commented Jun 12, 2024 •

edited