Added option mapping field for messageId in segment profiles (#1942)

* Added option mapping field for messageId in segment profiles * Updated snapshots for failing test cases * Added messageId for sendTrack action * Updated the message_id mapping for segment profiles * Updated the snapshot tests for segment profiles sendTrack action * Removed unwanted lint changes * Removed unwanted lint changes --------- Co-authored-by: Harsh Vardhan <harsh.vardhan@segment.com>
segmentio · Apr 23, 2024 · db71edd · db71edd
1 parent 267a1bc
commit db71edd
Show file tree

Hide file tree

Showing 18 changed files with 77 additions and 8 deletions.
diff --git a/...n-actions/src/destinations/segment-profiles/__tests__/__snapshots__/snapshot.test.ts.snap b/...n-actions/src/destinations/segment-profiles/__tests__/__snapshots__/snapshot.test.ts.snap
@@ -10,6 +10,7 @@ Object {
         "integrations": Object {
           "All": false,
         },
+        "messageId": "cZE8HyAL0!BF#)WQb^",
         "timestamp": "2021-02-01T00:00:00.000Z",
         "traits": Object {
           "testType": "cZE8HyAL0!BF#)WQb^",
@@ -33,6 +34,7 @@ Object {
         "integrations": Object {
           "All": false,
         },
+        "messageId": "cZE8HyAL0!BF#)WQb^",
         "timestamp": undefined,
         "traits": Object {},
         "type": "group",
@@ -54,6 +56,7 @@ Object {
         "integrations": Object {
           "All": false,
         },
+        "messageId": "hIC1OAmWa[Q!&d%o",
         "timestamp": "2021-02-01T00:00:00.000Z",
         "traits": Object {
           "testType": "hIC1OAmWa[Q!&d%o",
@@ -77,6 +80,7 @@ Object {
         "integrations": Object {
           "All": false,
         },
+        "messageId": "hIC1OAmWa[Q!&d%o",
         "timestamp": undefined,
         "traits": Object {},
         "type": "identify",
@@ -126,6 +130,7 @@ Object {
         "integrations": Object {
           "All": false,
         },
+        "messageId": undefined,
         "timestamp": undefined,
         "traits": Object {},
         "type": "identify",
@@ -175,6 +180,7 @@ Object {
         "integrations": Object {
           "All": false,
         },
+        "messageId": undefined,
         "timestamp": undefined,
         "traits": Object {},
         "type": "identify",
@@ -196,6 +202,7 @@ Object {
         "integrations": Object {
           "All": false,
         },
+        "messageId": "[2uovRzxThJj",
         "properties": Object {
           "testType": "[2uovRzxThJj",
         },
@@ -219,6 +226,7 @@ Object {
         "integrations": Object {
           "All": false,
         },
+        "messageId": "[2uovRzxThJj",
         "properties": Object {},
         "timestamp": undefined,
         "type": "track",

diff --git a/packages/destination-actions/src/destinations/segment-profiles/segment-properties.ts b/packages/destination-actions/src/destinations/segment-profiles/segment-properties.ts
@@ -45,6 +45,14 @@ export const timestamp: InputField = {
   }
 }
 
+export const message_id: InputField = {
+  type: 'string',
+  label: 'MessageId',
+  description: 'The Segment messageId.',
+  default: { '@path': '$.messageId' },
+  unsafe_hidden: true
+}
+
 export const event_name: InputField = {
   label: 'Event Name',
   description: 'Name of the action that a user has performed.',

diff --git a/...ns/src/destinations/segment-profiles/sendGroup/__tests__/__snapshots__/index.test.ts.snap b/...ns/src/destinations/segment-profiles/sendGroup/__tests__/__snapshots__/index.test.ts.snap
@@ -9,6 +9,7 @@ Object {
       "integrations": Object {
         "All": false,
       },
+      "messageId": undefined,
       "timestamp": "2023-09-26T09:46:28.290Z",
       "traits": Object {
         "industry": "Technology",

diff --git a/...src/destinations/segment-profiles/sendGroup/__tests__/__snapshots__/snapshot.test.ts.snap b/...src/destinations/segment-profiles/sendGroup/__tests__/__snapshots__/snapshot.test.ts.snap
@@ -10,6 +10,7 @@ Object {
         "integrations": Object {
           "All": false,
         },
+        "messageId": "tKaa(2A",
         "timestamp": "2021-02-01T00:00:00.000Z",
         "traits": Object {
           "testType": "tKaa(2A",
@@ -33,6 +34,7 @@ Object {
         "integrations": Object {
           "All": false,
         },
+        "messageId": "tKaa(2A",
         "timestamp": undefined,
         "traits": Object {},
         "type": "group",

diff --git a/packages/destination-actions/src/destinations/segment-profiles/sendGroup/generated-types.ts b/packages/destination-actions/src/destinations/segment-profiles/sendGroup/generated-types.ts
diff --git a/packages/destination-actions/src/destinations/segment-profiles/sendGroup/index.ts b/packages/destination-actions/src/destinations/segment-profiles/sendGroup/index.ts
@@ -1,7 +1,7 @@
 import type { ActionDefinition } from '@segment/actions-core'
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
-import { user_id, anonymous_id, group_id, traits, engage_space, timestamp } from '../segment-properties'
+import { user_id, anonymous_id, group_id, traits, engage_space, timestamp, message_id } from '../segment-properties'
 import { MissingUserOrAnonymousIdThrowableError } from '../errors'
 
 const action: ActionDefinition<Settings, Payload> = {
@@ -14,7 +14,8 @@ const action: ActionDefinition<Settings, Payload> = {
     anonymous_id,
     group_id: { ...group_id, required: true },
     traits,
-    timestamp
+    timestamp,
+    message_id
   },
   perform: (_request, { payload, statsContext }) => {
     if (!payload.anonymous_id && !payload.user_id) {
@@ -24,6 +25,7 @@ const action: ActionDefinition<Settings, Payload> = {
       userId: payload?.user_id,
       anonymousId: payload?.anonymous_id,
       groupId: payload?.group_id,
+      messageId: payload?.message_id,
       traits: {
         ...payload?.traits
       },

diff --git a/...src/destinations/segment-profiles/sendIdentify/__tests__/__snapshots__/index.test.ts.snap b/...src/destinations/segment-profiles/sendIdentify/__tests__/__snapshots__/index.test.ts.snap
@@ -9,6 +9,7 @@ Object {
       "integrations": Object {
         "All": false,
       },
+      "messageId": undefined,
       "timestamp": "2023-09-26T09:46:28.290Z",
       "traits": Object {
         "email": "test-user@test-company.com",

diff --git a/.../destinations/segment-profiles/sendIdentify/__tests__/__snapshots__/snapshot.test.ts.snap b/.../destinations/segment-profiles/sendIdentify/__tests__/__snapshots__/snapshot.test.ts.snap
@@ -10,6 +10,7 @@ Object {
         "integrations": Object {
           "All": false,
         },
+        "messageId": "mV[ZQcEVgZO$MX",
         "timestamp": "2021-02-01T00:00:00.000Z",
         "traits": Object {
           "testType": "mV[ZQcEVgZO$MX",
@@ -33,6 +34,7 @@ Object {
         "integrations": Object {
           "All": false,
         },
+        "messageId": "mV[ZQcEVgZO$MX",
         "timestamp": undefined,
         "traits": Object {},
         "type": "identify",

diff --git a/...ges/destination-actions/src/destinations/segment-profiles/sendIdentify/generated-types.ts b/...ges/destination-actions/src/destinations/segment-profiles/sendIdentify/generated-types.ts
diff --git a/packages/destination-actions/src/destinations/segment-profiles/sendIdentify/index.ts b/packages/destination-actions/src/destinations/segment-profiles/sendIdentify/index.ts
@@ -1,7 +1,7 @@
 import type { ActionDefinition } from '@segment/actions-core'
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
-import { user_id, anonymous_id, group_id, traits, engage_space, timestamp } from '../segment-properties'
+import { user_id, anonymous_id, group_id, traits, engage_space, timestamp, message_id } from '../segment-properties'
 import { MissingUserOrAnonymousIdThrowableError } from '../errors'
 
 const action: ActionDefinition<Settings, Payload> = {
@@ -15,7 +15,8 @@ const action: ActionDefinition<Settings, Payload> = {
     anonymous_id,
     group_id,
     traits,
-    timestamp
+    timestamp,
+    message_id
   },
   perform: (_request, { payload, statsContext }) => {
     if (!payload.anonymous_id && !payload.user_id) {
@@ -25,6 +26,7 @@ const action: ActionDefinition<Settings, Payload> = {
       userId: payload?.user_id,
       anonymousId: payload?.anonymous_id,
       groupId: payload?.group_id,
+      messageId: payload?.message_id,
       traits: {
         ...payload?.traits
       },

diff --git a/...destinations/segment-profiles/sendSubscription/__tests__/__snapshots__/index.test.ts.snap b/...destinations/segment-profiles/sendSubscription/__tests__/__snapshots__/index.test.ts.snap
@@ -64,6 +64,7 @@ Object {
       "integrations": Object {
         "All": false,
       },
+      "messageId": undefined,
       "timestamp": "2023-10-10T07:24:07.036Z",
       "traits": Object {
         "email": "test-user@test-company.com",
@@ -113,6 +114,7 @@ Object {
       "integrations": Object {
         "All": false,
       },
+      "messageId": undefined,
       "timestamp": "2023-10-10T07:24:07.036Z",
       "traits": Object {
         "email": "test-user@test-company.com",

diff --git a/...tinations/segment-profiles/sendSubscription/__tests__/__snapshots__/snapshot.test.ts.snap b/...tinations/segment-profiles/sendSubscription/__tests__/__snapshots__/snapshot.test.ts.snap
@@ -79,6 +79,7 @@ Object {
         "integrations": Object {
           "All": false,
         },
+        "messageId": undefined,
         "timestamp": undefined,
         "traits": Object {},
         "type": "identify",
@@ -128,6 +129,7 @@ Object {
         "integrations": Object {
           "All": false,
         },
+        "messageId": undefined,
         "timestamp": undefined,
         "traits": Object {},
         "type": "identify",

diff --git a/...destination-actions/src/destinations/segment-profiles/sendSubscription/generated-types.ts b/...destination-actions/src/destinations/segment-profiles/sendSubscription/generated-types.ts
diff --git a/packages/destination-actions/src/destinations/segment-profiles/sendSubscription/index.ts b/packages/destination-actions/src/destinations/segment-profiles/sendSubscription/index.ts
@@ -15,7 +15,8 @@ import {
   android_push_token,
   android_push_subscription_status,
   ios_push_subscription_status,
-  ios_push_token
+  ios_push_token,
+  message_id
 } from './subscription-properties'
 import {
   InvalidSubscriptionStatusError,
@@ -278,7 +279,8 @@ const action: ActionDefinition<Settings, Payload> = {
     ios_push_token,
     ios_push_subscription_status,
     traits,
-    timestamp
+    timestamp,
+    message_id
   },
   perform: (_request, { payload, statsContext }) => {
     const statsClient = statsContext?.statsClient
@@ -308,6 +310,7 @@ const action: ActionDefinition<Settings, Payload> = {
         // to any destinations which is connected to the Segment Profiles space
         All: false
       },
+      messageId: payload?.message_id,
       type: 'identify'
     }
 

diff --git a/...ion-actions/src/destinations/segment-profiles/sendSubscription/subscription-properties.ts b/...ion-actions/src/destinations/segment-profiles/sendSubscription/subscription-properties.ts
@@ -102,3 +102,11 @@ export const subscription_groups: InputField = {
   additionalProperties: true,
   defaultObjectUI: 'keyvalue'
 }
+
+export const message_id: InputField = {
+  type: 'string',
+  label: 'MessageId',
+  description: 'The Segment messageId.',
+  default: { '@path': '$.messageId' },
+  unsafe_hidden: true
+}
diff --git a/...ns/src/destinations/segment-profiles/sendTrack/__tests__/__snapshots__/index.test.ts.snap b/...ns/src/destinations/segment-profiles/sendTrack/__tests__/__snapshots__/index.test.ts.snap
@@ -9,6 +9,7 @@ Object {
       "integrations": Object {
         "All": false,
       },
+      "messageId": undefined,
       "properties": Object {
         "plan": "Business",
       },

diff --git a/packages/destination-actions/src/destinations/segment-profiles/sendTrack/generated-types.ts b/packages/destination-actions/src/destinations/segment-profiles/sendTrack/generated-types.ts
diff --git a/packages/destination-actions/src/destinations/segment-profiles/sendTrack/index.ts b/packages/destination-actions/src/destinations/segment-profiles/sendTrack/index.ts
@@ -1,7 +1,16 @@
 import type { ActionDefinition } from '@segment/actions-core'
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
-import { user_id, anonymous_id, timestamp, event_name, group_id, properties, engage_space } from '../segment-properties'
+import {
+  user_id,
+  anonymous_id,
+  timestamp,
+  event_name,
+  group_id,
+  properties,
+  engage_space,
+  message_id
+} from '../segment-properties'
 import { MissingUserOrAnonymousIdThrowableError } from '../errors'
 
 const action: ActionDefinition<Settings, Payload> = {
@@ -14,7 +23,8 @@ const action: ActionDefinition<Settings, Payload> = {
     timestamp,
     event_name,
     group_id,
-    properties
+    properties,
+    message_id
   },
   perform: (_, { payload, statsContext }) => {
     if (!payload.anonymous_id && !payload.user_id) {
@@ -29,6 +39,7 @@ const action: ActionDefinition<Settings, Payload> = {
           anonymousId: payload?.anonymous_id,
           timestamp: payload?.timestamp,
           event: payload?.event_name,
+          messageId: payload?.message_id,
           integrations: {
             // Setting 'integrations.All' to false will ensure that we don't send events
             // to any destinations which is connected to the Segment Profiles space.