STRATCONN-6008 - [Twilio Messaging] - WIP tags support (#3101)

* [Twilio Messaging] - WIP tags support

* adding some more validation

* regen key

* saving test status

* tested and ready to deploy

* removing test mappings

* cleaning up linting issue

* More linting issues

Author: joe-ayoub-segment

packages/destination-actions/src/destinations/twilio-messaging/sendMessage/__tests__/index.test.ts

@@ -38,6 +38,59 @@ describe('TwilioMessaging.sendMessage', () => {
     })
   })
 
+  it('should send messsage with tags', async () => {
+    const body = "To=%2B1234567890&From=%2B19876543210&Body=Hello+World%21&Tags=%7B%22campaign_name%22%3A%22Spring+Sale+2022%22%2C%22message_type%22%3A%22cart_abandoned%22%2C%22number_tag%22%3A%2212345%22%2C%22boolean_tag%22%3A%22true%22%7D"
+    nock('https://api.twilio.com')
+      .post(`/2010-04-01/Accounts/${defaultSettings.accountSID}/Messages.json`, body)
+      .reply(200, {
+        sid: 'SM1234567890abcdef1234567890abcdef',
+        status: 'sent'
+      })
+
+    await testDestination.testAction('sendMessage', {
+      settings: defaultSettings,
+      mapping: {
+        channel: CHANNELS.SMS,
+        senderType: SENDER_TYPE.PHONE_NUMBER,
+        toPhoneNumber: '+1234567890',
+        fromPhoneNumber: '+19876543210',
+        contentTemplateType: 'Inline',
+        inlineBody: 'Hello World!',
+        tags: {
+          campaign_name: 'Spring Sale 2022',
+          message_type: 'cart_abandoned',
+          number_tag: 12345,
+          boolean_tag: true,
+          null_tag: null,
+          empty_string_tag: ''
+        }
+      }
+    })
+  })
+
+  it('should thow error if tags malformed', async () => {
+     await expect( testDestination.testAction('sendMessage', {
+      settings: defaultSettings,
+      mapping: {
+        channel: CHANNELS.SMS,
+        senderType: SENDER_TYPE.PHONE_NUMBER,
+        toPhoneNumber: '+1234567890',
+        fromPhoneNumber: '+19876543210',
+        contentTemplateType: 'Inline',
+        inlineBody: 'Hello World!',
+        tags: {
+          campaign_name: 'Spring Sale 2022',
+          message_type: 'cart_abandoned',
+          number_tag: 12345,
+          boolean_tag: true,
+          null_tag: null,
+          empty_string_tag: '',
+          super_bad_tag: "$%^&*&^%$"
+        }
+      }
+    })).rejects.toThrow("Tag value \"$%^&*&^%$\" for key \"super_bad_tag\" contains invalid characters. Only alphanumeric, space, hyphen (-), and underscore (_) are allowed.")
+  })
+
   it('should send MMS with messaging service', async () => {
     nock('https://api.twilio.com').post(`/2010-04-01/Accounts/${defaultSettings.accountSID}/Messages.json`).reply(200, {
       sid: 'SM1234567890abcdef1234567890abcdef',

packages/destination-actions/src/destinations/twilio-messaging/sendMessage/fields.ts

@@ -10,7 +10,7 @@ export const fields: Record<string, InputField> = {
     choices: [
       { label: 'SMS', value: CHANNELS.SMS },
       { label: 'MMS', value: CHANNELS.MMS },
-      { label: 'WhatsApp', value: CHANNELS.WHATSAPP },
+      { label: 'WhatsApp', value: CHANNELS.WHATSAPP }
       //{ label: 'RCS', value: CHANNELS.RCS } Will be hidden for private beta
     ]
   },
@@ -213,5 +213,12 @@ export const fields: Record<string, InputField> = {
     format: 'date-time',
     required: false,
     default: undefined
+  },
+  tags: {
+    label: 'Tags',
+    description: 'Custom tags to be included in the message. Key:value pairs of strings are allowed.',
+    type: 'object',
+    required: false,
+    defaultObjectUI: 'keyvalue'
   }
 }

packages/destination-actions/src/destinations/twilio-messaging/sendMessage/generated-types.ts

@@ -5,6 +5,7 @@ export type TwilioPayload = {
   SendAt?: string
   ValidityPeriod?: number
   MediaUrl?: string[]
+  Tags?: string
 } & Sender &
   Content
 

packages/destination-actions/src/destinations/twilio-messaging/sendMessage/types.ts

@@ -26,7 +26,8 @@ export async function send(request: RequestClient, payload: Payload, settings: S
     sendAt,
     inlineMediaUrls,
     inlineBody,
-    contentTemplateType
+    contentTemplateType,
+    tags
   } = payload
 
   const getTo = (): string => {
@@ -146,13 +147,66 @@ export async function send(request: RequestClient, payload: Payload, settings: S
     return urls.length > 0 ? { MediaUrl: urls } : {}
   }
 
+  const getTags = (): { [k: string]: string } | undefined => {
+    if (!tags || typeof tags !== 'object') return undefined
+
+    const allowedPattern = /^[a-zA-Z0-9 _-]+$/
+
+    for (const k in tags) {
+      const v = tags[k]
+
+      if (v === null || String(v).trim() === '') {
+        delete tags[k]
+        continue
+      }
+
+      if (typeof v === 'object') {
+        throw new PayloadValidationError(`Tag value for key "${k}" cannot be an object or array.`)
+      }
+
+      if (k.length > 128) {
+        throw new PayloadValidationError(`Tag key "${k}" exceeds the maximum tag key length of 128 characters.`)
+      }
+
+      const trimmedValue = String(v).trim()
+
+      // Validate allowed characters in key and value
+      if (!allowedPattern.test(k)) {
+        throw new PayloadValidationError(
+          `Tag key "${k}" contains invalid characters. Only alphanumeric, space, hyphen (-), and underscore (_) are allowed.`
+        )
+      }
+
+      if (!allowedPattern.test(trimmedValue)) {
+        throw new PayloadValidationError(
+          `Tag value "${trimmedValue}" for key "${k}" contains invalid characters. Only alphanumeric, space, hyphen (-), and underscore (_) are allowed.`
+        )
+      }
+
+      if (trimmedValue.length > 128) {
+        throw new PayloadValidationError(
+          `Tag value for key "${k}" exceeds the maximum tag value length of 128 characters.`
+        )
+      }
+
+      tags[k] = trimmedValue
+    }
+
+    if (Object.keys(tags as { [k: string]: string }).length > 10) {
+      throw new PayloadValidationError('Tags cannot contain more than 10 key-value pairs.')
+    }
+
+    return Object.keys(tags as { [k: string]: string }).length > 0 ? { Tags: JSON.stringify(tags) } : undefined
+  }
+
   const twilioPayload: TwilioPayload = (() => ({
     To: getTo(),
     ...getSendAt(),
     ...getValidityPeriod(),
     ...getSender(),
     ...getContent(),
-    ...getInlineMediaUrls()
+    ...getInlineMediaUrls(),
+    ...getTags()
   }))()
 
   const encodedBody = encode(twilioPayload)
@@ -186,6 +240,7 @@ function encode(twilioPayload: TwilioPayload): string {
 
   return encodedSmsBody.toString()
 }
+
 export function validateContentSid(contentSid: string) {
   return /^HX[0-9a-fA-F]{32}$/.test(contentSid)
 }