bugfix: make queryID optional in Algolia insights destination action (s…

…egmentio#1345)

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

@@ -38,7 +38,6 @@ Object {
           "product_id": "U[ABpE$k",
         },
       ],
-      "queryID": "U[ABpE$k",
       "userToken": "U[ABpE$k",
     },
   ],
@@ -83,7 +82,6 @@ Object {
       "positions": Array [
         -1912532923056128,
       ],
-      "queryID": "LLjxSD^^GnH",
       "userToken": "LLjxSD^^GnH",
     },
   ],
@@ -120,7 +118,6 @@ Object {
       "objectIDs": Array [
         "BLFCPcmz",
       ],
-      "queryID": "BLFCPcmz",
       "userToken": "BLFCPcmz",
     },
   ],

packages/destination-actions/src/destinations/algolia-insights/algolia-insight-api.ts

@@ -10,6 +10,7 @@ type EventCommon = {
   userToken: string
   objectIDs: string[]
   timestamp?: number
+  queryID?: string
 }
 
 export type AlgoliaProductViewedEvent = EventCommon & {
@@ -18,7 +19,6 @@ export type AlgoliaProductViewedEvent = EventCommon & {
 
 export type AlgoliaProductClickedEvent = EventCommon & {
   eventType: 'click'
-  queryID: string
   positions: number[]
 }
 

packages/destination-actions/src/destinations/algolia-insights/conversionEvents/__tests__/__snapshots__/snapshot.test.ts.snap

@@ -38,7 +38,6 @@ Object {
           "product_id": ")j)vR5%1AP*epuo8A%R",
         },
       ],
-      "queryID": ")j)vR5%1AP*epuo8A%R",
       "timestamp": 1674843786677,
       "userToken": ")j)vR5%1AP*epuo8A%R",
     },

packages/destination-actions/src/destinations/algolia-insights/conversionEvents/__tests__/index.test.ts

@@ -64,7 +64,6 @@ describe('AlgoliaInsights.conversionEvents', () => {
       type: 'track',
       event: 'Order Completed',
       properties: {
-        query_id: '1234',
         search_index: 'fashion_1',
         products: [
           {
@@ -81,4 +80,27 @@ describe('AlgoliaInsights.conversionEvents', () => {
     const algoliaEvent = await testAlgoliaDestination(event)
     expect(algoliaEvent.timestamp).toBe(new Date(event.timestamp as string).valueOf())
   })
+
+  it('should pass queryID if present', async () => {
+    const event = createTestEvent({
+      type: 'track',
+      event: 'Order Completed',
+      properties: {
+        query_id: '1234',
+        search_index: 'fashion_1',
+        products: [
+          {
+            product_id: '9876',
+            product_name: 'skirt 1'
+          },
+          {
+            product_id: '5432',
+            product_name: 'skirt 2'
+          }
+        ]
+      }
+    })
+    const algoliaEvent = await testAlgoliaDestination(event)
+    expect(algoliaEvent.queryID).toBe(event.properties?.query_id)
+  })
 })

packages/destination-actions/src/destinations/algolia-insights/conversionEvents/index.ts

@@ -31,9 +31,9 @@ export const conversionEvents: ActionDefinition<Settings, Payload> = {
     },
     queryID: {
       label: 'Query ID',
-      description: 'Query ID of the list on which the item was clicked.',
+      description: 'Query ID of the list on which the item was purchased.',
       type: 'string',
-      required: true,
+      required: false,
       default: {
         '@path': '$.properties.query_id'
       }

packages/destination-actions/src/destinations/algolia-insights/productClickedEvents/__tests__/__snapshots__/snapshot.test.ts.snap

@@ -38,7 +38,6 @@ Object {
       "positions": Array [
         -8127732168785920,
       ],
-      "queryID": "tTO6#",
       "timestamp": 1674843786677,
       "userToken": "tTO6#",
     },

packages/destination-actions/src/destinations/algolia-insights/productClickedEvents/__tests__/index.test.ts

@@ -56,7 +56,6 @@ describe('AlgoliaInsights.productClickedEvents', () => {
       type: 'track',
       event: 'Product Clicked',
       properties: {
-        query_id: '1234',
         search_index: 'fashion_1',
         product_id: '9876',
         position: 5
@@ -65,4 +64,19 @@ describe('AlgoliaInsights.productClickedEvents', () => {
     const algoliaEvent = await testAlgoliaDestination(event)
     expect(algoliaEvent.timestamp).toBe(new Date(event.timestamp as string).valueOf())
   })
+
+  it('should pass queryID if present', async () => {
+    const event = createTestEvent({
+      type: 'track',
+      event: 'Product Clicked',
+      properties: {
+        query_id: '1234',
+        search_index: 'fashion_1',
+        product_id: '9876',
+        position: 5
+      }
+    })
+    const algoliaEvent = await testAlgoliaDestination(event)
+    expect(algoliaEvent.queryID).toBe(event.properties?.query_id)
+  })
 })

packages/destination-actions/src/destinations/algolia-insights/productClickedEvents/index.ts

@@ -30,7 +30,7 @@ export const productClickedEvents: ActionDefinition<Settings, Payload> = {
       label: 'Query ID',
       description: 'Query ID of the list on which the item was clicked.',
       type: 'string',
-      required: true,
+      required: false,
       default: {
         '@path': '$.properties.query_id'
       }

packages/destination-actions/src/destinations/algolia-insights/productViewedEvents/__tests__/__snapshots__/snapshot.test.ts.snap

@@ -30,7 +30,6 @@ Object {
       "objectIDs": Array [
         "og&DCP)aINw@qxe)",
       ],
-      "queryID": "og&DCP)aINw@qxe)",
       "timestamp": 1674843786677,
       "userToken": "og&DCP)aINw@qxe)",
     },

packages/destination-actions/src/destinations/algolia-insights/productViewedEvents/__tests__/index.test.ts

@@ -53,7 +53,6 @@ describe('AlgoliaInsights.productViewedEvents', () => {
       type: 'track',
       event: 'Product Viewed',
       properties: {
-        query_id: '1234',
         search_index: 'fashion_1',
         product_id: '9876'
       },
@@ -62,4 +61,19 @@ describe('AlgoliaInsights.productViewedEvents', () => {
     const algoliaEvent = await testAlgoliaDestination(event)
     expect(algoliaEvent.timestamp).toBe(new Date(event.timestamp as string).valueOf())
   })
+
+  it('should pass queryId if present', async () => {
+    const event = createTestEvent({
+      type: 'track',
+      event: 'Product Viewed',
+      properties: {
+        query_id: '1234',
+        search_index: 'fashion_1',
+        product_id: '9876'
+      },
+      userId: undefined
+    })
+    const algoliaEvent = await testAlgoliaDestination(event)
+    expect(algoliaEvent.queryID).toBe(event.properties?.query_id)
+  })
 })

packages/destination-actions/src/destinations/algolia-insights/productViewedEvents/index.ts

@@ -28,9 +28,9 @@ export const productViewedEvents: ActionDefinition<Settings, Payload> = {
     },
     queryID: {
       label: 'Query ID',
-      description: 'Query ID of the list on which the item was clicked.',
+      description: 'Query ID of the list on which the item was viewed.',
       type: 'string',
-      required: true,
+      required: false,
       default: {
         '@path': '$.properties.query_id'
       }