tested TikTok Offline Conversions migration code (segmentio#1898)

* tested tt offline conversions migration code * fixing Integtation name
attio · Feb 27, 2024 · 103b81a · 103b81a
1 parent dc572ac
commit 103b81a
Show file tree

Hide file tree

Showing 14 changed files with 1,475 additions and 494 deletions.
diff --git a/...src/destinations/tiktok-offline-conversions/__tests__/__snapshots__/snapshot.test.ts.snap b/...src/destinations/tiktok-offline-conversions/__tests__/__snapshots__/snapshot.test.ts.snap
diff --git a/...s/destination-actions/src/destinations/tiktok-offline-conversions/__tests__/index.test.ts b/...s/destination-actions/src/destinations/tiktok-offline-conversions/__tests__/index.test.ts
@@ -4,7 +4,7 @@ import Definition from '../index'
 import { Settings } from '../generated-types'
 
 const testDestination = createTestIntegration(Definition)
-const timestamp = '2023-04-17T15:21:15.449Z'
+const timestamp = '2024-01-08T13:52:50.212Z'
 const settings: Settings = {
   accessToken: 'test-token',
   eventSetID: 'test-event-set-id'
@@ -29,7 +29,7 @@ describe('TikTok Offline Conversions', () => {
         userId: 'testId123-contact'
       })
 
-      nock('https://business-api.tiktok.com/open_api/v1.3/offline/track/').post('/').reply(200, {})
+      nock('https://business-api.tiktok.com/open_api/v1.3/event/track/').post('/').reply(200, {})
 
       const responses = await testDestination.testAction('trackNonPaymentOfflineConversion', {
         event,
@@ -43,28 +43,50 @@ describe('TikTok Offline Conversions', () => {
       expect(responses.length).toBe(1)
       expect(responses[0].status).toBe(200)
       expect(responses[0].options.json).toMatchObject({
-        event_set_id: settings.eventSetID,
-        event: 'Contact',
-        event_id: event.messageId,
-        timestamp: timestamp,
+        event_source: 'offline',
+        event_source_id: settings.eventSetID,
         partner_name: 'Segment',
-        context: {
-          user: {
-            emails: [
-              '522a233963af49ceac13a2f68719d86a0b4cfb306b9a7959db697e1d7a52676a',
-              'c4821c6d488a9a27653e59b7c1f576e1434ed3e11cd0b6b86440fe56ea6c2d97'
-            ],
-            phone_numbers: [
-              '910a625c4ba147b544e6bd2f267e130ae14c591b6ba9c25cb8573322dedbebd0',
-              '46563a86074ccb92653d9f0666885030f5e921563bfa19c423b60a8c9ef7f85e'
-            ]
+        data: [
+          {
+            event: 'Contact',
+            event_time: 1704721970,
+            event_id: 'test-message-id-contact',
+            user: {
+              ttclid: 'test-ttclid-contact',
+              external_id: ['f18c018187c833dc00fb68f0517a135356fd947df08b0d22eaa145f623edc13e'],
+              email: [
+                '522a233963af49ceac13a2f68719d86a0b4cfb306b9a7959db697e1d7a52676a',
+                'c4821c6d488a9a27653e59b7c1f576e1434ed3e11cd0b6b86440fe56ea6c2d97'
+              ],
+              phone: [
+                '910a625c4ba147b544e6bd2f267e130ae14c591b6ba9c25cb8573322dedbebd0',
+                '46563a86074ccb92653d9f0666885030f5e921563bfa19c423b60a8c9ef7f85e'
+              ],
+              lead_id: undefined,
+              ttp: undefined,
+              ip: '8.8.8.8',
+              user_agent:
+                'Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1',
+              locale: 'en-US'
+            },
+            properties: {
+              contents: [],
+              content_type: 'product',
+              currency: undefined,
+              value: undefined,
+              query: undefined,
+              description: undefined,
+              order_id: 'test-order-id-contact',
+              shop_id: 'test-shop-id-contact'
+            },
+            page: {
+              url: 'https://segment.com/academy/',
+              referrer: undefined
+            },
+            limited_data_use: false,
+            test_event_code: undefined
           }
-        },
-        properties: {
-          order_id: 'test-order-id-contact',
-          shop_id: 'test-shop-id-contact',
-          event_channel: 'in_store'
-        }
+        ]
       })
     })
 
@@ -85,7 +107,7 @@ describe('TikTok Offline Conversions', () => {
         userId: 'testId123-subscribe'
       })
 
-      nock('https://business-api.tiktok.com/open_api/v1.3/offline/track/').post('/').reply(200, {})
+      nock('https://business-api.tiktok.com/open_api/v1.3/event/track/').post('/').reply(200, {})
 
       const responses = await testDestination.testAction('trackNonPaymentOfflineConversion', {
         event,
@@ -99,28 +121,50 @@ describe('TikTok Offline Conversions', () => {
       expect(responses.length).toBe(1)
       expect(responses[0].status).toBe(200)
       expect(responses[0].options.json).toMatchObject({
-        event_set_id: settings.eventSetID,
-        event: 'Subscribe',
-        event_id: event.messageId,
-        timestamp: timestamp,
+        event_source: 'offline',
+        event_source_id: settings.eventSetID,
         partner_name: 'Segment',
-        context: {
-          user: {
-            emails: [
-              '522a233963af49ceac13a2f68719d86a0b4cfb306b9a7959db697e1d7a52676a',
-              'c4821c6d488a9a27653e59b7c1f576e1434ed3e11cd0b6b86440fe56ea6c2d97'
-            ],
-            phone_numbers: [
-              '910a625c4ba147b544e6bd2f267e130ae14c591b6ba9c25cb8573322dedbebd0',
-              '46563a86074ccb92653d9f0666885030f5e921563bfa19c423b60a8c9ef7f85e'
-            ]
+        data: [
+          {
+            event: 'Subscribe',
+            event_time: 1704721970,
+            event_id: 'test-message-id-subscribe',
+            user: {
+              ttclid: 'test-ttclid-subscribe',
+              external_id: ['e3b83f59446a2f66722aa4947be585da59b37072dd76edfee189422417db5879'],
+              email: [
+                '522a233963af49ceac13a2f68719d86a0b4cfb306b9a7959db697e1d7a52676a',
+                'c4821c6d488a9a27653e59b7c1f576e1434ed3e11cd0b6b86440fe56ea6c2d97'
+              ],
+              phone: [
+                '910a625c4ba147b544e6bd2f267e130ae14c591b6ba9c25cb8573322dedbebd0',
+                '46563a86074ccb92653d9f0666885030f5e921563bfa19c423b60a8c9ef7f85e'
+              ],
+              lead_id: undefined,
+              ttp: undefined,
+              ip: '8.8.8.8',
+              user_agent:
+                'Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1',
+              locale: 'en-US'
+            },
+            properties: {
+              contents: [],
+              content_type: 'product',
+              currency: undefined,
+              value: undefined,
+              query: undefined,
+              description: undefined,
+              order_id: 'test-order-id-subscribe',
+              shop_id: 'test-shop-id-subscribe'
+            },
+            page: {
+              url: 'https://segment.com/academy/',
+              referrer: undefined
+            },
+            limited_data_use: false,
+            test_event_code: undefined
           }
-        },
-        properties: {
-          order_id: 'test-order-id-subscribe',
-          shop_id: 'test-shop-id-subscribe',
-          event_channel: 'in_store'
-        }
+        ]
       })
     })
 
@@ -140,7 +184,7 @@ describe('TikTok Offline Conversions', () => {
         userId: 'testId123-submit-form'
       })
 
-      nock('https://business-api.tiktok.com/open_api/v1.3/offline/track/').post('/').reply(200, {})
+      nock('https://business-api.tiktok.com/open_api/v1.3/event/track/').post('/').reply(200, {})
 
       const responses = await testDestination.testAction('trackNonPaymentOfflineConversion', {
         event,
@@ -154,28 +198,50 @@ describe('TikTok Offline Conversions', () => {
       expect(responses.length).toBe(1)
       expect(responses[0].status).toBe(200)
       expect(responses[0].options.json).toMatchObject({
-        event_set_id: settings.eventSetID,
-        event: 'SubmitForm',
-        event_id: event.messageId,
-        timestamp: timestamp,
+        event_source: 'offline',
+        event_source_id: settings.eventSetID,
         partner_name: 'Segment',
-        context: {
-          user: {
-            emails: [
-              '522a233963af49ceac13a2f68719d86a0b4cfb306b9a7959db697e1d7a52676a',
-              'c4821c6d488a9a27653e59b7c1f576e1434ed3e11cd0b6b86440fe56ea6c2d97'
-            ],
-            phone_numbers: [
-              '910a625c4ba147b544e6bd2f267e130ae14c591b6ba9c25cb8573322dedbebd0',
-              '46563a86074ccb92653d9f0666885030f5e921563bfa19c423b60a8c9ef7f85e'
-            ]
+        data: [
+          {
+            event: 'SubmitForm',
+            event_time: 1704721970,
+            event_id: 'test-message-id-submit-form',
+            user: {
+              ttclid: undefined,
+              external_id: ['ad1d0a79ae249b682fa21961d26120ee17b89aec332fee649002cd387742bd97'],
+              email: [
+                '522a233963af49ceac13a2f68719d86a0b4cfb306b9a7959db697e1d7a52676a',
+                'c4821c6d488a9a27653e59b7c1f576e1434ed3e11cd0b6b86440fe56ea6c2d97'
+              ],
+              phone: [
+                '910a625c4ba147b544e6bd2f267e130ae14c591b6ba9c25cb8573322dedbebd0',
+                '46563a86074ccb92653d9f0666885030f5e921563bfa19c423b60a8c9ef7f85e'
+              ],
+              lead_id: undefined,
+              ttp: undefined,
+              ip: '8.8.8.8',
+              user_agent:
+                'Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1',
+              locale: 'en-US'
+            },
+            properties: {
+              contents: [],
+              content_type: 'product',
+              currency: undefined,
+              value: undefined,
+              query: undefined,
+              description: undefined,
+              order_id: 'test-order-id-submit-form',
+              shop_id: 'test-shop-id-submit-form'
+            },
+            page: {
+              url: 'https://segment.com/academy/',
+              referrer: undefined
+            },
+            limited_data_use: false,
+            test_event_code: undefined
           }
-        },
-        properties: {
-          order_id: 'test-order-id-submit-form',
-          shop_id: 'test-shop-id-submit-form',
-          event_channel: 'in_store'
-        }
+        ]
       })
     })
   })
@@ -201,7 +267,7 @@ describe('TikTok Offline Conversions', () => {
         userId: 'testId123-complete-payment'
       })
 
-      nock('https://business-api.tiktok.com/open_api/v1.3/offline/track/').post('/').reply(200, {})
+      nock('https://business-api.tiktok.com/open_api/v1.3/event/track/').post('/').reply(200, {})
 
       const responses = await testDestination.testAction('trackPaymentOfflineConversion', {
         event,
@@ -234,38 +300,56 @@ describe('TikTok Offline Conversions', () => {
       expect(responses.length).toBe(1)
       expect(responses[0].status).toBe(200)
       expect(responses[0].options.json).toMatchObject({
-        event_set_id: settings.eventSetID,
-        event: 'CompletePayment',
-        event_id: event.messageId,
-        timestamp: timestamp,
+        event_source: 'offline',
+        event_source_id: settings.eventSetID,
         partner_name: 'Segment',
-        context: {
-          user: {
-            emails: [
-              '522a233963af49ceac13a2f68719d86a0b4cfb306b9a7959db697e1d7a52676a',
-              'c4821c6d488a9a27653e59b7c1f576e1434ed3e11cd0b6b86440fe56ea6c2d97'
-            ],
-            phone_numbers: [
-              '910a625c4ba147b544e6bd2f267e130ae14c591b6ba9c25cb8573322dedbebd0',
-              '46563a86074ccb92653d9f0666885030f5e921563bfa19c423b60a8c9ef7f85e'
-            ]
+        data: [
+          {
+            event: 'CompletePayment',
+            event_time: 1704721970,
+            event_id: 'test-message-id-complete-payment',
+            user: {
+              ttclid: undefined,
+              external_id: ['5da716ea2a24e8d05cea64167903ed983a273f897e3befc875cde15e9a8b5145'],
+              email: [
+                '522a233963af49ceac13a2f68719d86a0b4cfb306b9a7959db697e1d7a52676a',
+                'c4821c6d488a9a27653e59b7c1f576e1434ed3e11cd0b6b86440fe56ea6c2d97'
+              ],
+              phone: [
+                '910a625c4ba147b544e6bd2f267e130ae14c591b6ba9c25cb8573322dedbebd0',
+                '46563a86074ccb92653d9f0666885030f5e921563bfa19c423b60a8c9ef7f85e'
+              ],
+              lead_id: undefined,
+              ttp: undefined,
+              ip: '8.8.8.8',
+              user_agent:
+                'Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1',
+              locale: 'en-US'
+            },
+            properties: {
+              contents: [
+                {
+                  content_id: 'abc123',
+                  price: 100,
+                  quantity: 2
+                }
+              ],
+              content_type: 'product',
+              currency: 'USD',
+              value: 100,
+              query: 'shoes',
+              description: undefined,
+              order_id: 'test-order-id-complete-payment',
+              shop_id: 'test-shop-id-complete-payment'
+            },
+            page: {
+              url: 'https://segment.com/academy/',
+              referrer: undefined
+            },
+            limited_data_use: false,
+            test_event_code: undefined
           }
-        },
-        properties: {
-          order_id: 'test-order-id-complete-payment',
-          shop_id: 'test-shop-id-complete-payment',
-          event_channel: 'in_store',
-          contents: [
-            {
-              price: 100,
-              quantity: 2,
-              content_type: 'Air Force One (Size S)',
-              content_id: 'abc123'
-            }
-          ],
-          currency: 'USD',
-          value: 100
-        }
+        ]
       })
     })
   })