[Sendgrid] - sendgrid new email action (segmentio#2533)

* sendgrid email action

* fixing build

packages/destination-actions/src/destinations/sendgrid/index.ts

@@ -3,6 +3,8 @@ import type { Settings } from './generated-types'
 
 import updateUserProfile from './updateUserProfile'
 
+import sendEmail from './sendEmail'
+
 const destination: DestinationDefinition<Settings> = {
   name: 'SendGrid Marketing Campaigns',
   slug: 'actions-sendgrid',
@@ -37,7 +39,8 @@ const destination: DestinationDefinition<Settings> = {
   },
 
   actions: {
-    updateUserProfile
+    updateUserProfile,
+    sendEmail
   }
 }
 

packages/destination-actions/src/destinations/sendgrid/sendEmail/__tests__/__snapshots__/snapshot.test.ts.snap

@@ -0,0 +1,93 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Testing snapshot for Sendgrid's sendEmail destination action: all fields 1`] = `
+Object {
+  "asm": Object {
+    "group_id": 343234,
+  },
+  "categories": Array [
+    "!s3p^",
+  ],
+  "from": Object {
+    "email": "[email protected]",
+  },
+  "ip_pool_name": "!s3p^",
+  "mail_settings": Object {
+    "sandbox_mode": true,
+  },
+  "personalizations": Array [
+    Object {
+      "bcc": Array [
+        Object {
+          "email": "[email protected]",
+          "name": "!s3p^",
+        },
+      ],
+      "cc": Array [
+        Object {
+          "email": "[email protected]",
+          "name": "!s3p^",
+        },
+      ],
+      "custom_args": Object {
+        "testType": "!s3p^",
+      },
+      "dynamic_template_data": Object {
+        "testType": "!s3p^",
+      },
+      "headers": Object {
+        "testType": "!s3p^",
+      },
+      "to": Array [
+        Object {
+          "email": "[email protected]",
+          "name": "!s3p^",
+        },
+      ],
+    },
+  ],
+  "reply_to": Object {
+    "email": "[email protected]",
+  },
+  "template_id": "d-1234567890",
+  "tracking_settings": Object {
+    "ganalytics": Object {
+      "enable": true,
+      "utm_campaign": "!s3p^",
+      "utm_content": "!s3p^",
+      "utm_medium": "!s3p^",
+      "utm_source": "!s3p^",
+      "utm_term": "!s3p^",
+    },
+    "subscription_tracking": Object {
+      "enable": true,
+      "html": "!s3p^",
+      "substitution_tag": "!s3p^",
+      "text": "!s3p^",
+    },
+  },
+}
+`;
+
+exports[`Testing snapshot for Sendgrid's sendEmail destination action: required fields 1`] = `
+Object {
+  "from": Object {
+    "email": "[email protected]",
+  },
+  "personalizations": Array [
+    Object {
+      "headers": Object {},
+      "to": Array [
+        Object {
+          "email": "[email protected]",
+        },
+      ],
+    },
+  ],
+  "reply_to": Object {
+    "email": "[email protected]",
+  },
+  "template_id": "d-1234567890",
+  "tracking_settings": Object {},
+}
+`;

packages/destination-actions/src/destinations/sendgrid/sendEmail/__tests__/index.test.ts

@@ -0,0 +1,284 @@
+import nock from 'nock'
+import { createTestEvent, createTestIntegration, SegmentEvent, PayloadValidationError } from '@segment/actions-core'
+import Definition from '../../index'
+import { Settings } from '../../generated-types'
+import { RESERVED_HEADERS } from '../constants'
+
+let testDestination = createTestIntegration(Definition)
+
+const timestamp = '2024-01-08T13:52:50.212Z'
+const settings: Settings = {
+  sendGridApiKey: 'test-api-key'
+}
+const validPayload = {
+  timestamp: timestamp,
+  event: 'Send Email From Template',
+  messageId: 'aaa-bbb-ccc',
+  type: 'track',
+  userId: 'user_id_1',
+  context: {
+    campaign: {
+      source: 'source1',
+      medium: 'medium1',
+      term: 'term1',
+      content: 'content1',
+      name: 'name1'
+    }
+  },
+  properties: {
+    from: {
+      email: '[email protected]',
+      name: 'Billy Joe'
+    },
+    to: {
+      email: '[email protected]',
+      name: 'Mary Jane'
+    },
+    cc: [
+      {
+        email: '[email protected]',
+        name: 'CC 1'
+      },
+      {
+        email: '[email protected]',
+        name: 'CC 2'
+      }
+    ],
+    bcc: [
+      {
+        email: '[email protected]',
+        name: 'BCC 1'
+      },
+      {
+        email: '[email protected]',
+        name: 'BCC 2'
+      }
+    ],
+    headers: {
+      testHeader1: 'testHeaderValue1'
+    },
+    dynamic_template_data: {
+      stringVal: 'stringVal',
+      numVal: 123456,
+      boolVal: true,
+      objVal: {
+        key1: 'value1',
+        key2: 'value2'
+      },
+      arrayVal: ['value1', 'value2']
+    },
+    template_id: 'd-1234567890',
+    custom_args: {
+      custom_arg1: 'custom_arg_value1',
+      custom_arg2: 'custom_arg_value2'
+    },
+    reply_to: {
+      reply_to_equals_from: true
+    },
+    subscription_tracking: {
+      enable: false
+    },
+    categories: ['category1', 'category2'],
+    google_analytics: {
+      enable: true
+    },
+    ip_pool_name: 'ip_pool_name1',
+    group_id: '123 - blah',
+    sandbox_mode: false
+  }
+} as Partial<SegmentEvent>
+const mapping = {
+  from: { '@path': '$.properties.from' },
+  to: { '@path': '$.properties.to' },
+  cc: { '@path': '$.properties.cc' },
+  bcc: { '@path': '$.properties.bcc' },
+  headers: { '@path': '$.properties.headers' },
+  dynamic_template_data: { '@path': '$.properties.dynamic_template_data' },
+  template_id: { '@path': '$.properties.template_id' },
+  custom_args: { '@path': '$.properties.custom_args' },
+  reply_to: { '@path': '$.properties.reply_to' },
+  subscription_tracking: { '@path': '$.properties.subscription_tracking' },
+  categories: { '@path': '$.properties.categories' },
+  google_analytics: {
+    enable: { '@path': '$.properties.google_analytics.enable' },
+    utm_source: { '@path': '$.context.campaign.source' },
+    utm_medium: { '@path': '$.context.campaign.medium' },
+    utm_term: { '@path': '$.context.campaign.term' },
+    utm_content: { '@path': '$.context.campaign.content' },
+    utm_campaign: { '@path': '$.context.campaign.name' }
+  },
+  ip_pool_name: { '@path': '$.properties.ip_pool_name' },
+  group_id: { '@path': '$.properties.group_id' },
+  sandbox_mode: { '@path': '$.properties.sandbox_mode' },
+  send_at: { '@path': '$.properties.send_at' }
+}
+const expectedSendgridPayload = {
+  personalizations: [
+    {
+      to: [
+        {
+          email: '[email protected]',
+          name: 'Mary Jane'
+        }
+      ],
+      cc: [
+        {
+          email: '[email protected]',
+          name: 'CC 1'
+        },
+        {
+          email: '[email protected]',
+          name: 'CC 2'
+        }
+      ],
+      bcc: [
+        {
+          email: '[email protected]',
+          name: 'BCC 1'
+        },
+        {
+          email: '[email protected]',
+          name: 'BCC 2'
+        }
+      ],
+      headers: {
+        testHeader1: 'testHeaderValue1'
+      },
+      dynamic_template_data: {
+        stringVal: 'stringVal',
+        numVal: 123456,
+        boolVal: true,
+        objVal: {
+          key1: 'value1',
+          key2: 'value2'
+        },
+        arrayVal: ['value1', 'value2']
+      },
+      custom_args: {
+        custom_arg1: 'custom_arg_value1',
+        custom_arg2: 'custom_arg_value2'
+      }
+    }
+  ],
+  from: {
+    email: '[email protected]',
+    name: 'Billy Joe'
+  },
+  reply_to: {
+    email: '[email protected]',
+    name: 'Billy Joe'
+  },
+  template_id: 'd-1234567890',
+  categories: ['category1', 'category2'],
+  asm: {
+    group_id: 123
+  },
+  ip_pool_name: 'ip_pool_name1',
+  tracking_settings: {
+    subscription_tracking: {
+      enable: false
+    },
+    ganalytics: {
+      enable: true,
+      utm_source: 'source1',
+      utm_medium: 'medium1',
+      utm_term: 'term1',
+      utm_content: 'content1',
+      utm_campaign: 'name1'
+    }
+  },
+  mail_settings: {
+    sandbox_mode: false
+  }
+}
+
+beforeEach((done) => {
+  testDestination = createTestIntegration(Definition)
+  nock.cleanAll()
+  done()
+})
+
+describe('Sendgrid.sendEmail', () => {
+  it('should send an email', async () => {
+    const event = createTestEvent(validPayload)
+    // send email via Sendgrid
+    nock('https://api.sendgrid.com').post('/v3/mail/send', expectedSendgridPayload).reply(200, {})
+    const responses = await testDestination.testAction('sendEmail', {
+      event,
+      settings,
+      useDefaultMappings: true,
+      mapping
+    })
+    expect(responses.length).toBe(1)
+    expect(responses[0].status).toBe(200)
+  })
+
+  it('should throw error if bad headers', async () => {
+    const badPayload = {
+      ...validPayload,
+      properties: {
+        ...validPayload.properties,
+        headers: {
+          testHeader1: 'testHeaderValue1',
+          'dkim-signature': 'baaaad illegal header'
+        }
+      }
+    }
+    const event = createTestEvent(badPayload)
+    await expect(
+      testDestination.testAction('sendEmail', {
+        event,
+        settings,
+        useDefaultMappings: true,
+        mapping
+      })
+    ).rejects.toThrowError(
+      new PayloadValidationError(
+        `Headers cannot contain any of the following reserved headers: ${RESERVED_HEADERS.join(', ')}`
+      )
+    )
+  })
+
+  it('should throw error if bad template ID', async () => {
+    const badPayload = { ...validPayload, properties: { ...validPayload.properties, template_id: '1234567890' } }
+    const event = createTestEvent(badPayload)
+    await expect(
+      testDestination.testAction('sendEmail', {
+        event,
+        settings,
+        useDefaultMappings: true,
+        mapping
+      })
+    ).rejects.toThrowError(
+      new PayloadValidationError(`Template ID must refer to a Dynamic Template. Dynamic Template IDs start with "d-"`)
+    )
+  })
+
+  it('should throw error if send_at more than 72h in future', async () => {
+    const send_at = new Date(Date.now() + 73 * 60 * 60 * 1000)
+    const badPayload = { ...validPayload, properties: { ...validPayload.properties, send_at: send_at.toISOString() } }
+    const event = createTestEvent(badPayload)
+    await expect(
+      testDestination.testAction('sendEmail', {
+        event,
+        settings,
+        useDefaultMappings: true,
+        mapping
+      })
+    ).rejects.toThrowError(new PayloadValidationError(`send_at should be less than 72 hours from now`))
+  })
+
+  it('should throw error if send_at in the past', async () => {
+    const send_at = new Date(Date.now() - 100 * 60 * 60 * 1000)
+    const badPayload = { ...validPayload, properties: { ...validPayload.properties, send_at: send_at.toISOString() } }
+    const event = createTestEvent(badPayload)
+    await expect(
+      testDestination.testAction('sendEmail', {
+        event,
+        settings,
+        useDefaultMappings: true,
+        mapping
+      })
+    ).rejects.toThrowError(new PayloadValidationError(`send_at should be less than 72 hours from now`))
+  })
+})