feat: Compare workflow reminder bodies to default template #19060

joeauyeung · 2025-02-03T15:02:26Z

Stacked on #18822

What does this PR do?

Abstracts logic to get a workflow template body when passing the workflow action and template enum
For the scanning workflow body task, checks if the reminder body is the default template

Mandatory Tasks (DO NOT REMOVE)

I have self-reviewed the code (A decent size PR without self-review might be rejected).
I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

In the workflow editing screen, change the action and template
- The body should change
Trigger the scanning workflow body task on a step that has the default body and one that does not

vercel · 2025-02-03T15:02:35Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
cal-com-ui-playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 3, 2025 5:29pm

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
cal	⬜️ Ignored (Inspect)	Visit Preview		Feb 3, 2025 5:29pm
calcom-web-canary	⬜️ Ignored (Inspect)	Visit Preview		Feb 3, 2025 5:29pm

github-actions · 2025-02-03T15:02:40Z

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details:

No release type found in pull request title "Abstract getting workflow templates". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

…orkflow-templates

joeauyeung · 2025-02-03T17:44:41Z

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


-  if (step && form.getValues(`steps.${step.stepNumber - 1}.template`) === WorkflowTemplates.REMINDER) {


This type of logic was repeated through out the component. I decided to abstract this to getTemplateBodyForAction so it can be be used in other parts of the codebase

joeauyeung · 2025-02-03T17:44:51Z

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

-    const templateBody = getWhatsappTemplateForAction(step.action, i18n.language, step.template, timeFormat);
-    form.setValue(`steps.${step.stepNumber - 1}.reminderBody`, templateBody);
+  if (step && !form.getValues(`steps.${step.stepNumber - 1}.emailSubject`)) {
+    const subjectTemplate = emailReminderTemplate({


Emails are the only one with subjects so keeping it as is

joeauyeung · 2025-02-03T17:45:21Z

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

@@ -492,65 +484,6 @@ export default function WorkflowStepContainer(props: WorkflowStepProps) {
                              setIsEmailSubjectNeeded(true);
                            }

-                            if (


Handled with getTemplateBodyForAction

joeauyeung · 2025-02-03T17:46:51Z

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

@@ -95,3 +109,28 @@ export function getWhatsappTemplateForAction(
  const templateFunction = getWhatsappTemplateFunction(template);
  return templateFunction(true, locale, action, timeFormat);
 }
+
+export function getTemplateBodyForAction({


This function is used in WorkflowStepContainer when changing the template or action. Also used in tasker to grab the default template

joeauyeung · 2025-02-03T17:52:23Z

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

I found that the workflow editor was adding HTML tags that weren't in the standard template. I decided that to compare if the workflow body was the same as the template is to stripe all of the HTML tags out of the reminder body and template and compare the content.

joeauyeung · 2025-02-03T17:52:55Z

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

+  reminderBody: string;
+  template: string;
+}) => {
+  const stripHTML = (html: string) => html.replace(/<[^>]+>/g, "").replace(/&amp;/g, "&");


& is encoded / not encoded between the editor and the template. Decided to keep both templates the same by adding &

joeauyeung · 2025-02-03T17:53:54Z

packages/features/ee/workflows/lib/reminders/templates/emailRatingTemplate.ts

@@ -79,3 +79,6 @@ const emailRatingTemplate = ({
 };

 export default emailRatingTemplate;
+
+export const plainTextTemplate =


For tests, it wouldn't make sense to strip the templates twice with the same function since it would always pass. By adding the plain text templates, we can detect whether the template was changed or something changed with the comparison function.

joeauyeung · 2025-02-03T17:54:22Z

packages/features/ee/workflows/lib/reminders/templates/emailReminderTemplate.ts

-  name?: string,
-  isBrandingDisabled?: boolean
-) => {
+const emailReminderTemplate = ({


Refactored this function to take in an object as a param for readability and to align with other template functions.

joeauyeung · 2025-02-03T17:54:56Z

packages/features/tasker/tasks/scanWorkflowBody.ts

+    });
+
+    if (
+      compareReminderBodyToTemplate({ reminderBody: workflowStep.reminderBody, template: defaultTemplate })


Only call Akismet for spam detection if the reminder body is not a default template

joeauyeung added 9 commits January 29, 2025 13:17

Add getTemplateForAction function

7491884

Use getTemplateForAction when creating a new step

0518177

Use getTemplateForAction when action changes

8736701

Have emailReminderTemplate accept an object as a param

dcdf238

Rename getTemplateForAction to getTemplateBodyForAction

a8f1601

Simplify changing body when changing templates

e510870

Create compareReminderBodyToTemplate

574da22

In task, compare if reminderBody is a template

5849851

Linting

f6e962e

keithwillcode added consumer core area: core, team members only labels Feb 3, 2025

vercel bot had a problem deploying to Preview – api February 3, 2025 15:06 Failure

joeauyeung changed the title ~~Abstract getting workflow templates~~ refactor: Abstract getting workflow templates Feb 3, 2025

Merge branch 'tasker-scan-workflow-templates' into abstract-getting-w…

2f1cecb

…orkflow-templates

vercel bot had a problem deploying to Preview – api February 3, 2025 15:32 Failure

vercel bot deployed to Preview – cal-com-ui-playground February 3, 2025 15:33 View deployment

Add tests

73ac145

vercel bot had a problem deploying to Preview – api February 3, 2025 17:27 Failure

vercel bot deployed to Preview – cal-com-ui-playground February 3, 2025 17:29 View deployment

joeauyeung changed the title ~~refactor: Abstract getting workflow templates~~ refactor: Compare workflow reminder bodies to default template Feb 3, 2025

joeauyeung changed the title ~~refactor: Compare workflow reminder bodies to default template~~ feat: Compare workflow reminder bodies to default template Feb 3, 2025

joeauyeung commented Feb 3, 2025

View reviewed changes

joeauyeung added the ready-for-e2e label Feb 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Compare workflow reminder bodies to default template #19060

feat: Compare workflow reminder bodies to default template #19060

joeauyeung commented Feb 3, 2025 •

edited

Loading

vercel bot commented Feb 3, 2025 •

edited

Loading

github-actions bot commented Feb 3, 2025

joeauyeung Feb 3, 2025

joeauyeung Feb 3, 2025

joeauyeung Feb 3, 2025

joeauyeung Feb 3, 2025

joeauyeung Feb 3, 2025

joeauyeung Feb 3, 2025

joeauyeung Feb 3, 2025

joeauyeung Feb 3, 2025

joeauyeung Feb 3, 2025


		if (step && form.getValues(`steps.${step.stepNumber - 1}.template`) === WorkflowTemplates.REMINDER) {

feat: Compare workflow reminder bodies to default template #19060

Are you sure you want to change the base?

feat: Compare workflow reminder bodies to default template #19060

Conversation

joeauyeung commented Feb 3, 2025 • edited Loading

Stacked on #18822

What does this PR do?

Mandatory Tasks (DO NOT REMOVE)

How should this be tested?

vercel bot commented Feb 3, 2025 • edited Loading

github-actions bot commented Feb 3, 2025

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

joeauyeung commented Feb 3, 2025 •

edited

Loading

vercel bot commented Feb 3, 2025 •

edited

Loading