feat: SMS workflow action for form triggers #3

[CarinaWolli]

What does this PR do?

On top of #23716

Adds SMS action for form triggers.

• Fixes SMS actions #23747
• Fixes CAL-6399

How should this be tested?

• Test SMS actions with form triggers

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (3)

apps/api/v2/src/modules/workflows/inputs/update-form-workflow.input.ts (1)

44-47: Typo in example description ("Rounting" → "Routing")

Fix spelling to avoid leaking into API docs.

-  @ApiPropertyOptional({ description: "Name of the workflow", example: "Rounting-form Test Workflow" })
+  @ApiPropertyOptional({ description: "Name of the workflow", example: "Routing-form Test Workflow" })

apps/api/v2/src/modules/workflows/inputs/create-form-workflow.ts (2)

46-53: Swagger: Missing ApiExtraModels for phone step DTOs (schemas may not render)

Without registering WorkflowPhoneAttendeeStepDto and WorkflowPhoneNumberStepDto, the $ref targets in oneOf/discriminator can be absent in the OpenAPI output. Add them here.

 @ApiExtraModels(
   OnFormSubmittedTriggerDto,
   OnFormSubmittedNoEventTriggerDto,
   WorkflowEmailAddressStepDto,
   WorkflowEmailAttendeeStepDto,
+  WorkflowPhoneAttendeeStepDto,
+  WorkflowPhoneNumberStepDto,
   RoutingFormWorkflowTriggerDto,
   WorkflowFormActivationDto
 )

---

35-43: Validation and Swagger type bugs in WorkflowFormActivationDto

• ValidateIf checks a non-existent property isActiveOnAllEventTypes. Should be isActiveOnAllRoutingForms.
• Swagger type hints list Number[], but the field is string[].

Fix both to avoid incorrect validation behavior and wrong OpenAPI docs.

   @ApiPropertyOptional({
     description: "List of routing form IDs the workflow applies to",
     example: ["abd1-123edf-a213d-123dfwf"],
-    type: [Number],
+    type: [String],
   })
-  @ValidateIf((o) => !o.isActiveOnAllEventTypes)
+  @ValidateIf((o) => !o.isActiveOnAllRoutingForms)
   @IsOptional()
   @IsString({ each: true })
   activeOnRoutingFormIds: string[] = [];

🧹 Nitpick comments (1)

apps/api/v2/src/modules/workflows/inputs/update-form-workflow.input.ts (1)

30-42: Optional: Trim unused ApiExtraModels entries

If WhatsApp steps aren’t allowed for routing-form workflows, drop UpdatePhoneWhatsAppNumberWorkflowStepDto and UpdateWhatsAppAttendeePhoneWorkflowStepDto from ApiExtraModels to keep the OpenAPI clean.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 2a4aeb3 and e0d09b1.

📒 Files selected for processing (2)

• apps/api/v2/src/modules/workflows/inputs/create-form-workflow.ts (3 hunks)
• apps/api/v2/src/modules/workflows/inputs/update-form-workflow.input.ts (3 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

**/*.ts

📄 CodeRabbit inference engine (.cursor/rules/review.mdc)

**/*.ts: For Prisma queries, only select data you need; never use include, always use select
Ensure the credential.key field is never returned from tRPC endpoints or APIs

Files:

• apps/api/v2/src/modules/workflows/inputs/update-form-workflow.input.ts
• apps/api/v2/src/modules/workflows/inputs/create-form-workflow.ts

**/*.{ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/review.mdc)

Flag excessive Day.js use in performance-critical code; prefer native Date or Day.js .utc() in hot paths like loops

Files:

• apps/api/v2/src/modules/workflows/inputs/update-form-workflow.input.ts
• apps/api/v2/src/modules/workflows/inputs/create-form-workflow.ts

**/*.{ts,tsx,js,jsx}

⚙️ CodeRabbit configuration file

Flag default exports and encourage named exports. Named exports provide better tree-shaking, easier refactoring, and clearer imports. Exempt main components like pages, layouts, and components that serve as the primary export of a module.

Files:

• apps/api/v2/src/modules/workflows/inputs/update-form-workflow.input.ts
• apps/api/v2/src/modules/workflows/inputs/create-form-workflow.ts

🧬 Code graph analysis (2)

apps/api/v2/src/modules/workflows/inputs/update-form-workflow.input.ts (1)

apps/api/v2/src/modules/workflows/inputs/workflow-step.input.ts (4)

• UpdatePhoneAttendeeWorkflowStepDto (381-389)
• UpdatePhoneNumberWorkflowStepDto (390-398)
• SMS_ATTENDEE (10-10)
• SMS_NUMBER (11-11)

apps/api/v2/src/modules/workflows/inputs/create-form-workflow.ts (1)

apps/api/v2/src/modules/workflows/inputs/workflow-step.input.ts (4)

• WorkflowPhoneAttendeeStepDto (251-281)
• WorkflowPhoneNumberStepDto (283-307)
• SMS_ATTENDEE (10-10)
• SMS_NUMBER (11-11)

🔇 Additional comments (8)

apps/api/v2/src/modules/workflows/inputs/update-form-workflow.input.ts (4)

11-12: LGTM: SMS action constants imported

Constants are correctly added for discriminator mapping and docs.

---

75-82: LGTM: Added phone step schemas to steps oneOf

Phone step DTOs are correctly referenced in the OpenAPI oneOf for steps.

---

97-99: LGTM: Discriminator updated for SMS steps

Discriminator subTypes now include SMS attendee/number actions.

---

102-107: LGTM: Steps union expanded to include phone steps

Type union matches discriminator and oneOf. Good.

apps/api/v2/src/modules/workflows/inputs/create-form-workflow.ts (4)

10-16: LGTM: Introduced SMS constants and phone step DTOs

Imports are correct and align with added step support.

---

92-94: LGTM (but see next comment): Phone step schemas referenced in oneOf

References are correct; however, you must add these DTOs to ApiExtraModels to ensure Swagger generates component schemas.

---

108-110: LGTM: Discriminator updated for SMS steps

Subtypes include SMS_ATTENDEE and SMS_NUMBER.

---

113-118: LGTM: Steps union expanded to include phone steps

Type union matches the discriminator and oneOf.

[ThyMinimalDev]

LGTM

[cubic-dev-ai]

4 issues found across 12 files

Prompt for AI agents (all 4 issues)

Understand the root cause of the following 4 issues and fix them.


<file name="packages/features/ee/workflows/lib/reminders/smsReminderManager.ts">

<violation number="1" location="packages/features/ee/workflows/lib/reminders/smsReminderManager.ts:141">
Rule violated: **Avoid Logging Sensitive Information**

Remove the `reminderPhone` from this warning; phone numbers are PII and must not be logged per the &quot;Avoid Logging Sensitive Information&quot; guideline.</violation>

<violation number="2" location="packages/features/ee/workflows/lib/reminders/smsReminderManager.ts:217">
This mirrors the event path bug: smsMessageWithoutOptOut now contains the opt-out footer, but smsMessage stays unchanged. As a result, SMS messages are sent without the opt-out while fallback emails receive it. Please assign the opt-out-augmented message to smsMessage (or another variable) and keep the original string for bodyWithoutOptOut.</violation>
</file>

<file name="packages/features/ee/workflows/api/scheduleSMSReminders.ts">

<violation number="1" location="packages/features/ee/workflows/api/scheduleSMSReminders.ts:174">
This assigns the opt-out footer to `smsMessageWithoutOptOut` so the SMS body stays unchanged, causing scheduled SMS messages to miss the required opt-out text while the fallback email gains it. Please append the opt-out footer to `message` (the SMS body) and keep `smsMessageWithoutOptOut` equal to the original message.</violation>
</file>

<file name="apps/api/v2/src/modules/workflows/inputs/create-form-workflow.ts">

<violation number="1" location="apps/api/v2/src/modules/workflows/inputs/create-form-workflow.ts:14">
Please add the new SMS step DTOs to @ApiExtraModels so their schemas are emitted for the getSchemaPath references; otherwise the generated OpenAPI spec points to missing components.</violation>
</file>

_{React with 👍 or 👎 to teach cubic. Mention @cubic-dev-ai to give feedback, ask questions, or re-run the review.}

[cubic-dev-ai]

Rule violated: Avoid Logging Sensitive Information

Remove the reminderPhone from this warning; phone numbers are PII and must not be logged per the "Avoid Logging Sensitive Information" guideline.

Prompt for AI agents

Address the following comment on packages/features/ee/workflows/lib/reminders/smsReminderManager.ts at line 141:

<comment>Remove the `reminderPhone` from this warning; phone numbers are PII and must not be logged per the &quot;Avoid Logging Sensitive Information&quot; guideline.</comment>

<file context>
@@ -138,141 +134,224 @@ export const scheduleSMSReminder = async (args: ScheduleTextReminderArgs &amp; { evt
   const isNumberVerified = await getIsNumberVerified();
 
+  if (!isNumberVerified) {
+    log.warn(`Phone number not verified`, safeStringify({ reminderPhone, isNumberVerified }));
+    return;
+  }
</file context>

Suggested change

	log.warn(`Phone number not verified`, safeStringify({ reminderPhone, isNumberVerified }));
	log.warn(`Phone number not verified`, safeStringify({ isNumberVerified }));

[cubic-dev-ai]

This assigns the opt-out footer to smsMessageWithoutOptOut so the SMS body stays unchanged, causing scheduled SMS messages to miss the required opt-out text while the fallback email gains it. Please append the opt-out footer to message (the SMS body) and keep smsMessageWithoutOptOut equal to the original message.

Prompt for AI agents

Address the following comment on packages/features/ee/workflows/api/scheduleSMSReminders.ts at line 174:

<comment>This assigns the opt-out footer to `smsMessageWithoutOptOut` so the SMS body stays unchanged, causing scheduled SMS messages to miss the required opt-out text while the fallback email gains it. Please append the opt-out footer to `message` (the SMS body) and keep `smsMessageWithoutOptOut` equal to the original message.</comment>

<file context>
@@ -171,11 +171,7 @@ export async function handler(req: NextRequest) {
-        if (process.env.TWILIO_OPT_OUT_ENABLED === &quot;true&quot;) {
-          message = await WorkflowOptOutService.addOptOutMessage(message, locale || &quot;en&quot;);
-        }
+        const smsMessageWithoutOptOut = await WorkflowOptOutService.addOptOutMessage(message, locale || &quot;en&quot;);
 
         const scheduledNotification = await scheduleSmsOrFallbackEmail({
</file context>

[cubic-dev-ai]

Please add the new SMS step DTOs to @ApiExtraModels so their schemas are emitted for the getSchemaPath references; otherwise the generated OpenAPI spec points to missing components.

Prompt for AI agents

Address the following comment on apps/api/v2/src/modules/workflows/inputs/create-form-workflow.ts at line 14:

<comment>Please add the new SMS step DTOs to @ApiExtraModels so their schemas are emitted for the getSchemaPath references; otherwise the generated OpenAPI spec points to missing components.</comment>

<file context>
@@ -7,8 +7,12 @@ import {
   WorkflowEmailAddressStepDto,
   WorkflowEmailAttendeeStepDto,
+  WorkflowPhoneNumberStepDto,
+  WorkflowPhoneAttendeeStepDto,
+  SMS_ATTENDEE,
 } from &quot;./workflow-step.input&quot;;
</file context>

[cubic-dev-ai]

This mirrors the event path bug: smsMessageWithoutOptOut now contains the opt-out footer, but smsMessage stays unchanged. As a result, SMS messages are sent without the opt-out while fallback emails receive it. Please assign the opt-out-augmented message to smsMessage (or another variable) and keep the original string for bodyWithoutOptOut.

Prompt for AI agents

Address the following comment on packages/features/ee/workflows/lib/reminders/smsReminderManager.ts at line 217:

<comment>This mirrors the event path bug: smsMessageWithoutOptOut now contains the opt-out footer, but smsMessage stays unchanged. As a result, SMS messages are sent without the opt-out while fallback emails receive it. Please assign the opt-out-augmented message to smsMessage (or another variable) and keep the original string for bodyWithoutOptOut.</comment>

<file context>
@@ -138,141 +134,224 @@ export const scheduleSMSReminder = async (args: ScheduleTextReminderArgs &amp; { evt
+    }
+
+    if (smsMessage.trim().length &gt; 0) {
+      const smsMessageWithoutOptOut = await WorkflowOptOutService.addOptOutMessage(
+        smsMessage,
+        evt.organizer.language.locale
</file context>

[github-actions]

E2E results are ready!

• Workflow #84274.2 latest results

[cubic-dev-ai]

No issues found across 1 file

[cubic-dev-ai]

No issues found across 1 file