Support channel id as audience identifier

Author: jumpingGrendel

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

@@ -13,7 +13,7 @@ Array [
     },
     "occurred": false,
     "user": Object {
-      "named_user_id": "Z8PnKI8*YgWA",
+      "Z8PnKI8*YgWA": "Z8PnKI8*YgWA",
     },
   },
 ]
@@ -31,7 +31,7 @@ Array [
     },
     "occurred": false,
     "user": Object {
-      "named_user_id": "Z8PnKI8*YgWA",
+      "channel": "Z8PnKI8*YgWA",
     },
   },
 ]
@@ -40,15 +40,15 @@ Array [
 exports[`Testing snapshot for actions-airship destination: manageTags action - all fields 1`] = `
 Object {
   "audience": Object {
-    "named_user_id": "XvmIpuaw",
+    "XvmIpuaw": "XvmIpuaw",
   },
 }
 `;
 
 exports[`Testing snapshot for actions-airship destination: manageTags action - required fields 1`] = `
 Object {
   "audience": Object {
-    "named_user_id": "XvmIpuaw",
+    "channel": "XvmIpuaw",
   },
 }
 `;
@@ -207,7 +207,7 @@ Object {
     },
   ],
   "audience": Object {
-    "named_user_id": "*N75*",
+    "*N75*": "*N75*",
   },
 }
 `;
@@ -216,7 +216,7 @@ exports[`Testing snapshot for actions-airship destination: setAttributes action
 Object {
   "attributes": Array [],
   "audience": Object {
-    "named_user_id": "*N75*",
+    "channel": "*N75*",
   },
 }
 `;

packages/destination-actions/src/destinations/airship/__tests__/airship.test.ts

@@ -129,6 +129,72 @@ describe('Airship', () => {
     })
   })
 
+  describe('setAttribute with channel_id', () => {
+    it('should use channel audience', async () => {
+      const now = new Date().toISOString()
+      const event = createTestEvent({
+        timestamp: now,
+        traits: { trait1: 1 }
+      })
+
+      nock('https://go.urbanairship.com').post('/api/channels/attributes').reply(200, {})
+
+      const responses = await testDestination.testAction('setAttributes', {
+        event,
+        settings: { access_token: 'foo', app_key: 'bar', endpoint: 'US' },
+        mapping: {
+          channel_id: 'chan-abc',
+          channel_type: 'email',
+          occurred: now,
+          attributes: { trait1: 1 }
+        }
+      })
+      expect(responses[0].status).toBe(200)
+    })
+  })
+
+  describe('customEvents with channel_id', () => {
+    it('should use channel audience', async () => {
+      const now = new Date().toISOString()
+      const event = createTestEvent({ type: 'track', timestamp: now })
+
+      nock('https://go.urbanairship.com').post('/api/custom-events').reply(200, {})
+
+      const responses = await testDestination.testAction('customEvents', {
+        event,
+        settings: { access_token: 'foo', app_key: 'bar', endpoint: 'US' },
+        mapping: {
+          channel_id: 'chan-abc',
+          channel_type: 'email',
+          name: 'Test Event',
+          occurred: now,
+          enable_batching: false
+        }
+      })
+      expect(responses[0].status).toBe(200)
+    })
+  })
+
+  describe('manageTags with channel_id', () => {
+    it('should use channel audience', async () => {
+      const event = createTestEvent({ traits: { airship_tags: { tag1: true } } })
+
+      nock('https://go.urbanairship.com').post('/api/channels/tags').reply(200, {})
+
+      const responses = await testDestination.testAction('manageTags', {
+        event,
+        settings: { access_token: 'foo', app_key: 'bar', endpoint: 'US' },
+        mapping: {
+          channel_id: 'chan-abc',
+          channel_type: 'sms',
+          tags: { tag1: true },
+          tag_group: 'segment-integration'
+        }
+      })
+      expect(responses[0].status).toBe(200)
+    })
+  })
+
   describe('delete', () => {
     it('should support deletes', async () => {
       const event = createTestEvent({

packages/destination-actions/src/destinations/airship/__tests__/utilities.test.ts

@@ -269,3 +269,62 @@ describe('Testing _parse_and_format_date', () => {
     expect(_private._parse_and_format_date('foo')).toEqual('foo')
   })
 })
+
+describe('Testing _build_audience', () => {
+  it('should return named_user_id audience when only named_user_id is provided', () => {
+    expect(_private._build_audience({ named_user_id: 'user-123' })).toEqual({ named_user_id: 'user-123' })
+  })
+
+  it('should return channel audience when channel_id and channel_type are provided', () => {
+    expect(_private._build_audience({ channel_id: 'chan-abc', channel_type: 'email' })).toEqual({
+      email: 'chan-abc'
+    })
+  })
+
+  it('should use channel selector when all three fields are provided (channel_id takes precedence)', () => {
+    expect(_private._build_audience({ named_user_id: 'user-123', channel_id: 'chan-abc', channel_type: 'email' })).toEqual({
+      email: 'chan-abc'
+    })
+  })
+
+  it('should use generic channel audience when channel_id provided without channel_type', () => {
+    expect(_private._build_audience({ channel_id: 'chan-abc' })).toEqual({ channel: 'chan-abc' })
+  })
+
+  it('should use generic channel audience when channel_id provided without channel_type even if named_user_id is present', () => {
+    expect(_private._build_audience({ named_user_id: 'user-123', channel_id: 'chan-abc' })).toEqual({
+      channel: 'chan-abc'
+    })
+  })
+
+  it('should throw when neither named_user_id nor channel_id is provided', () => {
+    expect(() => _private._build_audience({})).toThrow('Either Named User ID or Channel ID must be provided')
+  })
+})
+
+describe('Testing _build_custom_event_object with channel_id', () => {
+  it('should use channel audience when channel_id is provided', () => {
+    const payload: CustomEventsPayload = {
+      channel_id: 'chan-abc',
+      channel_type: 'email',
+      name: 'Test Event',
+      occurred: occurred.toISOString(),
+      enable_batching: false
+    }
+    const result = _private._build_custom_event_object(payload) as any
+    expect(result.user).toEqual({ email: 'chan-abc' })
+  })
+})
+
+describe('Testing _build_tags_object with channel_id', () => {
+  it('should use channel audience when channel_id is provided', () => {
+    const payload: ManageTagsPayload = {
+      channel_id: 'chan-abc',
+      channel_type: 'sms',
+      tag_group: 'segment-integration',
+      tags: { trait3: true }
+    }
+    const result = _private._build_tags_object(payload) as any
+    expect(result.audience).toEqual({ sms: 'chan-abc' })
+  })
+})

packages/destination-actions/src/destinations/airship/customEvents/__tests__/__snapshots__/index.test.ts.snap

@@ -12,7 +12,7 @@ Array [
     },
     "occurred": false,
     "user": Object {
-      "named_user_id": "5C5XZ3fWrH)z48",
+      "channel": "5C5XZ3fWrH)z48",
     },
   },
 ]

packages/destination-actions/src/destinations/airship/customEvents/__tests__/__snapshots__/snapshot.test.ts.snap

@@ -13,7 +13,7 @@ Array [
     },
     "occurred": false,
     "user": Object {
-      "named_user_id": "5C5XZ3fWrH)z48",
+      "5C5XZ3fWrH)z48": "5C5XZ3fWrH)z48",
     },
   },
 ]
@@ -31,7 +31,7 @@ Array [
     },
     "occurred": false,
     "user": Object {
-      "named_user_id": "5C5XZ3fWrH)z48",
+      "channel": "5C5XZ3fWrH)z48",
     },
   },
 ]

packages/destination-actions/src/destinations/airship/customEvents/generated-types.ts

@@ -10,13 +10,25 @@ const action: ActionDefinition<Settings, Payload> = {
   fields: {
     named_user_id: {
       label: 'Airship Named User ID',
-      description: 'The identifier assigned in Airship as the Named User',
+      description: 'The identifier assigned in Airship as the Named User. Provide either this or Channel ID.',
       type: 'string',
-      required: true,
+      required: false,
       default: {
         '@path': '$.userId'
       }
     },
+    channel_id: {
+      label: 'Channel ID',
+      description: 'Airship Channel ID. Provide either this or Named User ID.',
+      type: 'string',
+      required: false
+    },
+    channel_type: {
+      label: 'Channel Type',
+      description: 'The Airship audience key for the channel type (e.g. android_channel, ios_channel, amazon_channel, web_channel). If omitted, the generic channel key is used and Airship will resolve the type, which may introduce a slight delay.',
+      type: 'string',
+      required: false
+    },
     name: {
       label: 'Name',
       description: 'Event Name',

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

@@ -24,14 +24,14 @@ const destination: DestinationDefinition<Settings> = {
         label: 'Access Token',
         description: 'Create in the Airship Go dashboard in Settings->Partner Integrations->Segment',
         type: 'password',
-        // default: process.env.DEFAULT_ACCESS_TOKEN,
+        default: process.env.DEFAULT_ACCESS_TOKEN,
         required: true
       },
       app_key: {
         label: 'App Key',
         description: 'The App Key identifies the Airship Project to which API requests are made.',
         type: 'password',
-        // default: process.env.DEFAULT_APP_KEY,
+        default: process.env.DEFAULT_APP_KEY,
         required: true
       },
       endpoint: {

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

@@ -3,15 +3,15 @@
 exports[`Testing snapshot for Airship's manageTags destination action: all fields 1`] = `
 Object {
   "audience": Object {
-    "named_user_id": "s0s43LdN(JFJswcY3#g3",
+    "s0s43LdN(JFJswcY3#g3": "s0s43LdN(JFJswcY3#g3",
   },
 }
 `;
 
 exports[`Testing snapshot for Airship's manageTags destination action: required fields 1`] = `
 Object {
   "audience": Object {
-    "named_user_id": "s0s43LdN(JFJswcY3#g3",
+    "channel": "s0s43LdN(JFJswcY3#g3",
   },
 }
 `;

packages/destination-actions/src/destinations/airship/manageTags/__tests__/__snapshots__/index.test.ts.snap

@@ -3,15 +3,15 @@
 exports[`Testing snapshot for Airship's manageTags destination action: all fields 1`] = `
 Object {
   "audience": Object {
-    "named_user_id": "s0s43LdN(JFJswcY3#g3",
+    "s0s43LdN(JFJswcY3#g3": "s0s43LdN(JFJswcY3#g3",
   },
 }
 `;
 
 exports[`Testing snapshot for Airship's manageTags destination action: required fields 1`] = `
 Object {
   "audience": Object {
-    "named_user_id": "s0s43LdN(JFJswcY3#g3",
+    "channel": "s0s43LdN(JFJswcY3#g3",
   },
 }
 `;