add support for Product List Viewed events

Author: jkaho

packages/browser-destinations/destinations/algolia-plugins/src/algoliaInsights/generated-types.ts

@@ -155,6 +155,41 @@ Object {
 }
 `;
 
+exports[`Testing snapshot for actions-algolia-insights destination: productListViewedEvents action - all fields 1`] = `
+Object {
+  "events": Array [
+    Object {
+      "eventName": "rV6HQ[S7QuqZWEj%HvC",
+      "eventType": "click",
+      "index": "rV6HQ[S7QuqZWEj%HvC",
+      "objectIDs": Array [
+        "rV6HQ[S7QuqZWEj%HvC",
+      ],
+      "queryID": "rV6HQ[S7QuqZWEj%HvC",
+      "testType": "rV6HQ[S7QuqZWEj%HvC",
+      "timestamp": null,
+      "userToken": "rV6HQ[S7QuqZWEj%HvC",
+    },
+  ],
+}
+`;
+
+exports[`Testing snapshot for actions-algolia-insights destination: productListViewedEvents action - required fields 1`] = `
+Object {
+  "events": Array [
+    Object {
+      "eventName": "Product List Viewed",
+      "eventType": "view",
+      "index": "rV6HQ[S7QuqZWEj%HvC",
+      "objectIDs": Array [
+        "rV6HQ[S7QuqZWEj%HvC",
+      ],
+      "userToken": "rV6HQ[S7QuqZWEj%HvC",
+    },
+  ],
+}
+`;
+
 exports[`Testing snapshot for actions-algolia-insights destination: productViewedEvents action - all fields 1`] = `
 Object {
   "events": Array [

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

@@ -11,6 +11,7 @@ import { AlgoliaApiPermissions, algoliaApiPermissionsUrl } from './algolia-insig
 import { productAddedEvents } from './productAddedEvents'
 
 import { productListFilteredEvents, productListFilteredPresets } from './productListFilteredEvents'
+import { productListViewedEvents, productListViewedPresets } from './productListViewedEvents'
 
 export const ALGOLIA_INSIGHTS_USER_AGENT = 'algolia-segment-action-destination: 0.1'
 
@@ -67,14 +68,16 @@ const destination: DestinationDefinition<Settings> = {
     purchasePreset,
     addToCartPreset,
     productViewedPresets,
-    productListFilteredPresets
+    productListFilteredPresets,
+    productListViewedPresets
   ],
   actions: {
     productClickedEvents,
     conversionEvents,
     productViewedEvents,
     productAddedEvents,
-    productListFilteredEvents
+    productListFilteredEvents,
+    productListViewedEvents
   }
 }
 

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

@@ -0,0 +1,37 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Testing snapshot for AlgoliaInsights's productListViewedEvents destination action: all fields 1`] = `
+Object {
+  "events": Array [
+    Object {
+      "eventName": "lx7Lx",
+      "eventType": "view",
+      "index": "lx7Lx",
+      "objectIDs": Array [
+        "lx7Lx",
+      ],
+      "queryID": "lx7Lx",
+      "testType": "lx7Lx",
+      "timestamp": null,
+      "userToken": "lx7Lx",
+    },
+  ],
+}
+`;
+
+exports[`Testing snapshot for AlgoliaInsights's productListViewedEvents destination action: required fields 1`] = `
+Object {
+  "events": Array [
+    Object {
+      "eventName": "Product List Viewed",
+      "eventType": "view",
+      "index": "lx7Lx",
+      "objectIDs": Array [
+        "lx7Lx",
+      ],
+      "timestamp": 1674843786677,
+      "userToken": "lx7Lx",
+    },
+  ],
+}
+`;

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

@@ -0,0 +1,88 @@
+import nock from 'nock'
+import { createTestEvent, createTestIntegration, SegmentEvent } from '@segment/actions-core'
+import Destination, { ALGOLIA_INSIGHTS_USER_AGENT } from '../../index'
+import { AlgoliaProductViewedEvent, BaseAlgoliaInsightsURL } from '../../algolia-insight-api'
+
+const testDestination = createTestIntegration(Destination)
+
+const algoliaDestinationActionSettings = {
+  appId: 'algolia-application-id',
+  apiKey: 'algolia-api-key'
+}
+const testAlgoliaDestination = async (event: SegmentEvent): Promise<AlgoliaProductViewedEvent> => {
+  nock(BaseAlgoliaInsightsURL).post('/1/events').reply(200, {})
+  const segmentEvent = {
+    event: { ...event },
+    settings: algoliaDestinationActionSettings,
+    useDefaultMappings: true
+  }
+  const actionResponse = await testDestination.testAction('productListViewedEvents', segmentEvent)
+  const actionRequest = actionResponse[0].request
+
+  expect(actionResponse.length).toBe(1)
+  expect(actionRequest.headers.get('X-Algolia-Application-Id')).toBe(algoliaDestinationActionSettings.appId)
+  expect(actionRequest.headers.get('X-Algolia-API-Key')).toBe(algoliaDestinationActionSettings.apiKey)
+  expect(actionRequest.headers.get('X-Algolia-Agent')).toBe(ALGOLIA_INSIGHTS_USER_AGENT)
+
+  const rawBody = await actionRequest.text()
+  return JSON.parse(rawBody)['events'][0]
+}
+
+describe('AlgoliaInsights.productListViewedEvents', () => {
+  it('should submit click on track "Product List Viewed" event', async () => {
+    const event = createTestEvent({
+      type: 'track',
+      event: 'Product List Viewed',
+      properties: {
+        query_id: '1234',
+        search_index: 'fashion_1',
+        products: [
+          { product_id: '9876', name: 'foo', price: 10 },
+          { product_id: '5432', category: 'bar' }
+        ]
+      }
+    })
+    const algoliaEvent = await testAlgoliaDestination(event)
+
+    expect(algoliaEvent.eventName).toBe('Product List Viewed')
+    expect(algoliaEvent.eventType).toBe('view')
+    expect(algoliaEvent.index).toBe(event.properties?.search_index)
+    expect(algoliaEvent.userToken).toBe(event.userId)
+    expect(algoliaEvent.objectIDs).toEqual(['9876', '5432'])
+  })
+
+  it('should pass timestamp if present', async () => {
+    const event = createTestEvent({
+      type: 'track',
+      event: 'Product List Viewed',
+      properties: {
+        search_index: 'fashion_1',
+        products: [
+          { product_id: '9876', name: 'foo', price: 10 },
+          { product_id: '5432', category: 'bar' }
+        ]
+      },
+      userId: undefined
+    })
+    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 List Viewed',
+      properties: {
+        query_id: '1234',
+        search_index: 'fashion_1',
+        products: [
+          { product_id: '9876', name: 'foo', price: 10 },
+          { product_id: '5432', category: 'bar' }
+        ]
+      },
+      userId: undefined
+    })
+    const algoliaEvent = await testAlgoliaDestination(event)
+    expect(algoliaEvent.queryID).toBe(event.properties?.query_id)
+  })
+})

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

@@ -0,0 +1,79 @@
+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 = 'productListViewedEvents'
+const destinationSlug = 'AlgoliaInsights'
+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({
+      timestamp: new Date('2023-01-27T18:23:06.677Z').toISOString(),
+      properties: eventData
+    })
+
+    const responses = await testDestination.testAction(actionSlug, {
+      useDefaultMappings: true,
+      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({
+      timestamp: new Date('2023-01-27T18:23:06.677Z').toISOString(),
+      properties: eventData
+    })
+
+    const responses = await testDestination.testAction(actionSlug, {
+      useDefaultMappings: true,
+      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()
+    }
+  })
+})