Merge branch 'main' into liquid-templates-metrics

Author: nick-Ag

packages/destination-actions/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/action-destinations",
   "description": "Destination Actions engine and definitions.",
-  "version": "3.404.0",
+  "version": "3.405.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/segmentio/action-destinations",

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

@@ -203,6 +203,7 @@ register('683ef14a3f9aac157e3a3446', './amazon-conversions-api')
 register('684a923b272a5d1e02f33914', './google-data-manager')
 register('68516bd8ca73bd53f38a0104', './roadwayai')
 register('68516c107fc235f3572f8a64', './posthog')
+register('6863e71f2a1e1ddc4b4612bf', './nudge')
 
 function register(id: MetadataId, destinationPath: string) {
   // eslint-disable-next-line @typescript-eslint/no-var-requires

packages/destination-actions/src/destinations/nudge/common/baseRequestInterface.ts

@@ -0,0 +1,42 @@
+import { RequestClient } from '@segment/actions-core'
+import { Settings } from '../generated-types'
+import type { Payload as TrackPayload } from '../trackEvent/generated-types'
+import type { Payload as IdentifyPayload } from '../identifyUser/generated-types'
+
+export default class BaseRequestInterface {
+  private static baseURL = 'https://main-api.nudgenow.com/api/integration/segment'
+  private static platform = '17'
+
+  public static async track(request: RequestClient, settings: Settings, payload: TrackPayload) {
+    return await request(this.baseURL + '/events/batch', {
+      method: 'POST',
+      json: [payload],
+      headers: {
+        apikey: settings.apikey,
+        p: this.platform
+      }
+    })
+  }
+
+  public static async batchTrack(request: RequestClient, settings: Settings, payload: TrackPayload[]) {
+    return await request(this.baseURL + '/events/batch', {
+      method: 'POST',
+      json: payload,
+      headers: {
+        apikey: settings.apikey,
+        p: this.platform
+      }
+    })
+  }
+
+  public static async identify(request: RequestClient, settings: Settings, payload: IdentifyPayload) {
+    return await request(this.baseURL + '/identify', {
+      method: 'PUT',
+      json: payload,
+      headers: {
+        apikey: settings.apikey,
+        p: this.platform
+      }
+    })
+  }
+}

packages/destination-actions/src/destinations/nudge/common/transforms.ts

@@ -0,0 +1,24 @@
+import { Payload as IdentifyPayload } from '../identifyUser/generated-types'
+
+/**
+ * returns the transformed value by converting all spaces to '_' and converting everything to lower case
+ */
+export function sanitize(value: string) {
+  return value.replace(/ /g, '_').toLowerCase()
+}
+
+/**
+ * returns the cleaned props by removing the name, email and phone fields from the traits payload object for identify
+ */
+export function modifyProps(props?: IdentifyPayload['props']) {
+  if (!props) return {}
+
+  const mutatedProps: { [key: string]: unknown } = {}
+  for (const key in props) {
+    if (!['name', 'phone', 'email'].includes(key)) {
+      mutatedProps[key] = props[key]
+    }
+  }
+
+  return mutatedProps
+}

packages/destination-actions/src/destinations/nudge/generated-types.ts

@@ -0,0 +1,21 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Testing snapshot for Nudge's identifyUser destination action: all fields 1`] = `
+Object {
+  "email": "[email protected]",
+  "ext_id": "olu!sgnptmy",
+  "name": "oLU!sgnPTMy",
+  "phone": "oLU!sgnPTMy",
+  "props": Object {
+    "testType": "oLU!sgnPTMy",
+  },
+  "tz": "oLU!sgnPTMy",
+}
+`;
+
+exports[`Testing snapshot for Nudge's identifyUser destination action: required fields 1`] = `
+Object {
+  "ext_id": "olu!sgnptmy",
+  "props": Object {},
+}
+`;

packages/destination-actions/src/destinations/nudge/identifyUser/__tests__/__snapshots__/snapshot.test.ts.snap

@@ -0,0 +1,60 @@
+import nock from 'nock'
+import { createTestEvent, createTestIntegration } from '@segment/actions-core'
+import Destination from '../../index'
+
+const testDestination = createTestIntegration(Destination)
+const API_KEY = 'sample-api-token'
+const API_URL = 'https://main-api.nudgenow.com/api/'
+const timestamp = '2025-05-12T12:35:12.826Z'
+
+describe('Nudge.identifyUser', () => {
+  it('should successfully identify a new user', async () => {
+    const event = createTestEvent({
+      timestamp,
+      traits: {
+        phone: '9999999999',
+        email: '[email protected]',
+        name: 'John Doe'
+      },
+      userId: 'test-user'
+    })
+
+    nock(API_URL).put('/integration/segment/identify').reply(200, {})
+
+    const responses = await testDestination.testAction('identifyUser', {
+      event,
+      useDefaultMappings: true,
+      settings: {
+        apikey: API_KEY
+      }
+    })
+
+    expect(responses[0].status).toBe(200)
+  })
+
+  it('should throw error on invalid ext_id', async () => {
+    const event = createTestEvent({
+      timestamp,
+      traits: {
+        phone: '9999999999',
+        email: '[email protected]',
+        name: 'John Doe'
+      },
+      userId: 'Invalid User'
+    })
+
+    nock(API_URL).put('/integration/segment/identify').reply(400, {
+      message: 'VALIDATION_FAILED'
+    })
+
+    const responses = testDestination.testAction('identifyUser', {
+      event,
+      useDefaultMappings: true,
+      settings: {
+        apikey: API_KEY
+      }
+    })
+
+    await expect(responses).rejects.toThrowError()
+  })
+})

packages/destination-actions/src/destinations/nudge/identifyUser/__tests__/index.test.ts

@@ -0,0 +1,75 @@
+import { createTestEvent, createTestIntegration } from '@segment/actions-core'
+import { generateTestData } from '../../../../lib/test-data'
+import destination from '../../index'
+import nock from 'nock'
+
+const testDestination = createTestIntegration(destination)
+const actionSlug = 'identifyUser'
+const destinationSlug = 'Nudge'
+const seedName = `${destinationSlug}#${actionSlug}`
+
+describe(`Testing snapshot for ${destinationSlug}'s ${actionSlug} destination action:`, () => {
+  it('required fields', async () => {
+    const action = destination.actions[actionSlug]
+    const [eventData, settingsData] = generateTestData(seedName, destination, action, true)
+
+    nock(/.*/).persist().get(/.*/).reply(200)
+    nock(/.*/).persist().post(/.*/).reply(200)
+    nock(/.*/).persist().put(/.*/).reply(200)
+
+    const event = createTestEvent({
+      properties: eventData
+    })
+
+    const responses = await testDestination.testAction(actionSlug, {
+      event: event,
+      mapping: event.properties,
+      settings: settingsData,
+      auth: undefined
+    })
+
+    const request = responses[0].request
+    const rawBody = await request.text()
+
+    try {
+      const json = JSON.parse(rawBody)
+      expect(json).toMatchSnapshot()
+      return
+    } catch (err) {
+      expect(rawBody).toMatchSnapshot()
+    }
+
+    expect(request.headers).toMatchSnapshot()
+  })
+
+  it('all fields', async () => {
+    const action = destination.actions[actionSlug]
+    const [eventData, settingsData] = generateTestData(seedName, destination, action, false)
+
+    nock(/.*/).persist().get(/.*/).reply(200)
+    nock(/.*/).persist().post(/.*/).reply(200)
+    nock(/.*/).persist().put(/.*/).reply(200)
+
+    const event = createTestEvent({
+      properties: eventData
+    })
+
+    const responses = await testDestination.testAction(actionSlug, {
+      event: event,
+      mapping: event.properties,
+      settings: settingsData,
+      auth: undefined
+    })
+
+    const request = responses[0].request
+    const rawBody = await request.text()
+
+    try {
+      const json = JSON.parse(rawBody)
+      expect(json).toMatchSnapshot()
+      return
+    } catch (err) {
+      expect(rawBody).toMatchSnapshot()
+    }
+  })
+})

packages/destination-actions/src/destinations/nudge/identifyUser/__tests__/snapshot.test.ts

@@ -0,0 +1,76 @@
+import type { ActionDefinition } from '@segment/actions-core'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import BaseRequestInterface from '../common/baseRequestInterface'
+import { modifyProps, sanitize } from '../common/transforms'
+
+const action: ActionDefinition<Settings, Payload> = {
+  title: 'Identify User',
+  description: 'Identify a user in Nudge',
+  defaultSubscription: 'type = "identify"',
+  fields: {
+    ext_id: {
+      label: 'User ID',
+      type: 'string',
+      description: 'The ID of the user performing the action.',
+      required: true,
+      default: {
+        '@path': '$.userId'
+      }
+    },
+    name: {
+      label: 'User Name',
+      type: 'string',
+      description: 'The name of the user',
+      required: false,
+      default: {
+        '@path': '$.traits.name'
+      }
+    },
+    phone: {
+      label: 'Phone Number',
+      type: 'string',
+      description: 'The phone number of the user',
+      required: false,
+      default: {
+        '@path': '$.traits.phone'
+      }
+    },
+    email: {
+      label: 'Email',
+      type: 'string',
+      description: 'The email of the user.',
+      required: false,
+      default: {
+        '@path': '$.traits.email'
+      }
+    },
+    tz: {
+      label: 'Timezone',
+      type: 'string',
+      description: 'The timezone of the user.',
+      required: false,
+      default: {
+        '@path': '$.context.timezone'
+      }
+    },
+    props: {
+      label: 'Properties',
+      type: 'object',
+      description: 'Properties for the user',
+      required: false,
+      default: {
+        '@path': '$.traits'
+      }
+    }
+  },
+
+  perform: async (request, { settings, payload }) => {
+    payload.ext_id = sanitize(payload.ext_id)
+    payload.props = modifyProps(payload.props)
+
+    return BaseRequestInterface.identify(request, settings, payload)
+  }
+}
+
+export default action