Ortto Action Destination

package.json

@@ -53,7 +53,6 @@
     "eslint-plugin-lodash": "^7.3.0",
     "express": "^4.18.2",
     "husky": "^7.0.0",
-    "jest": "^27.3.1",
     "jest-browser-globals": "^25.1.0-beta",
     "jest-mock": "^29.3.1",
     "karma": "^6.4.1",

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

@@ -0,0 +1,77 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Testing snapshot for actions-ortto destination: trackActivity action - all fields 1`] = `
+Array [
+  Object {
+    "anonymous_id": "]25AcEh01MO",
+    "enable_batching": true,
+    "event": "]25AcEh01MO",
+    "ip": "107.255.187.198",
+    "location": Object {
+      "city": "]25AcEh01MO",
+      "country": "]25AcEh01MO",
+      "post_code": "]25AcEh01MO",
+      "state": "]25AcEh01MO",
+    },
+    "message_id": "]25AcEh01MO",
+    "namespace": "]25AcEh01MO",
+    "properties": Object {
+      "testType": "]25AcEh01MO",
+    },
+    "timestamp": "2125-06-22T08:21:01.417Z",
+    "traits": Object {
+      "email": "[email protected]",
+      "first_name": "]25AcEh01MO",
+      "last_name": "]25AcEh01MO",
+      "phone": "]25AcEh01MO",
+    },
+    "user_id": "]25AcEh01MO",
+  },
+]
+`;
+
+exports[`Testing snapshot for actions-ortto destination: trackActivity action - required fields 1`] = `
+Array [
+  Object {
+    "anonymous_id": "]25AcEh01MO",
+    "event": "]25AcEh01MO",
+    "message_id": "]25AcEh01MO",
+    "user_id": "]25AcEh01MO",
+  },
+]
+`;
+
+exports[`Testing snapshot for actions-ortto destination: upsertContactProfile action - all fields 1`] = `
+Array [
+  Object {
+    "anonymous_id": "TBOtXZm4yQy]54s",
+    "enable_batching": false,
+    "ip": "169.155.93.138",
+    "location": Object {
+      "city": "TBOtXZm4yQy]54s",
+      "country": "TBOtXZm4yQy]54s",
+      "post_code": "TBOtXZm4yQy]54s",
+      "state": "TBOtXZm4yQy]54s",
+    },
+    "message_id": "TBOtXZm4yQy]54s",
+    "timestamp": "2086-08-12T02:15:40.692Z",
+    "traits": Object {
+      "email": "[email protected]",
+      "first_name": "TBOtXZm4yQy]54s",
+      "last_name": "TBOtXZm4yQy]54s",
+      "phone": "TBOtXZm4yQy]54s",
+    },
+    "user_id": "TBOtXZm4yQy]54s",
+  },
+]
+`;
+
+exports[`Testing snapshot for actions-ortto destination: upsertContactProfile action - required fields 1`] = `
+Array [
+  Object {
+    "anonymous_id": "TBOtXZm4yQy]54s",
+    "message_id": "TBOtXZm4yQy]54s",
+    "user_id": "TBOtXZm4yQy]54s",
+  },
+]
+`;

packages/destination-actions/src/destinations/ortto/__tests__/index.test.ts

@@ -0,0 +1,42 @@
+import nock from 'nock'
+import { createTestIntegration, InvalidAuthenticationError } from '@segment/actions-core'
+import Definition from '../index'
+import { API_VERSION } from '../ortto-client'
+import { TEST_API_KEY } from '../utils'
+
+const testDestination = createTestIntegration(Definition)
+describe('Ortto', () => {
+  describe('authentication', () => {
+    it('should reject empty api keys', async () => {
+      try {
+        await testDestination.testAuthentication({ api_key: '' })
+      } catch (err) {
+        expect(err instanceof InvalidAuthenticationError)
+      }
+    })
+
+    it('should reject whitespace api keys', async () => {
+      try {
+        await testDestination.testAuthentication({ api_key: '    ' })
+      } catch (err) {
+        expect(err instanceof InvalidAuthenticationError)
+      }
+    })
+
+    it('should reject invalid api keys', async () => {
+      try {
+        await testDestination.testAuthentication({ api_key: 'invalid' })
+      } catch (err) {
+        expect(err instanceof InvalidAuthenticationError)
+      }
+    })
+
+    it('should accept valid api keys', async () => {
+      nock('https://segment-action-api-au.ortto.app')
+        .get(`/${API_VERSION}/me`)
+        .matchHeader('authorization', `Bearer ${TEST_API_KEY}`)
+        .reply(200, {})
+      await expect(testDestination.testAuthentication({ api_key: TEST_API_KEY })).resolves.not.toThrowError()
+    })
+  })
+})

packages/destination-actions/src/destinations/ortto/__tests__/snapshot.test.ts

@@ -0,0 +1,78 @@
+import { createTestEvent, createTestIntegration } from '@segment/actions-core'
+import { generateTestData } from '../../../lib/test-data'
+import destination from '../index'
+import nock from 'nock'
+import { TEST_API_KEY } from '../utils'
+
+const testDestination = createTestIntegration(destination)
+const destinationSlug = 'actions-ortto'
+
+describe(`Testing snapshot for ${destinationSlug} destination:`, () => {
+  for (const actionSlug in destination.actions) {
+    it(`${actionSlug} action - required fields`, async () => {
+      const seedName = `${destinationSlug}#${actionSlug}`
+      const action = destination.actions[actionSlug]
+      const [eventData] = generateTestData(seedName, destination, action, true)
+
+      nock(/.*/).persist().get(/.*/).reply(200)
+      nock(/.*/).persist().post(/.*/).reply(200)
+      nock(/.*/).persist().put(/.*/).reply(200)
+
+      const event = createTestEvent({
+        properties: eventData
+      })
+
+      const responses = await testDestination.testAction(actionSlug, {
+        event: event,
+        mapping: event.properties,
+        settings: { api_key: TEST_API_KEY },
+        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(`${actionSlug} action - all fields`, async () => {
+      const seedName = `${destinationSlug}#${actionSlug}`
+      const action = destination.actions[actionSlug]
+      const [eventData] = generateTestData(seedName, destination, action, false)
+
+      nock(/.*/).persist().get(/.*/).reply(200)
+      nock(/.*/).persist().post(/.*/).reply(200)
+      nock(/.*/).persist().put(/.*/).reply(200)
+
+      const event = createTestEvent({
+        properties: eventData
+      })
+
+      const responses = await testDestination.testAction(actionSlug, {
+        event: event,
+        mapping: event.properties,
+        settings: { api_key: TEST_API_KEY },
+        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()
+      }
+    })
+  }
+})

packages/destination-actions/src/destinations/ortto/__tests__/utils.test.ts

@@ -0,0 +1,106 @@
+import { cleanObject } from '../utils'
+
+describe('Ortto', () => {
+  describe('utils', () => {
+    it('cleanobject must remove empty keys with value', async () => {
+      expect(cleanObject({ '': 'v', k: 'v' })).toStrictEqual({ k: 'v' })
+    })
+  })
+
+  describe('utils', () => {
+    it('cleanobject must remove empty keys with empty value', async () => {
+      expect(cleanObject({ '': '', k: 'v' })).toStrictEqual({ k: 'v' })
+    })
+  })
+
+  describe('utils', () => {
+    it('cleanobject must remove multiple empty keys', async () => {
+      expect(cleanObject({ '': '', '': 'v', k: 'v' })).toStrictEqual({ k: 'v' })
+    })
+  })
+
+  describe('utils', () => {
+    it('cleanobject should not remove empty values', async () => {
+      expect(
+        cleanObject({
+          k1: '',
+          k2: 'v2',
+          k3: 0,
+          k4: false,
+          k5: [],
+          k6: {},
+          k7: null,
+          k8: undefined
+        })
+      ).toStrictEqual({
+        k1: '',
+        k2: 'v2',
+        k3: 0,
+        k4: false,
+        k5: [],
+        k6: {},
+        k7: null,
+        k8: undefined
+      })
+    })
+  })
+
+  describe('utils', () => {
+    it('cleanobject should not process arrays', async () => {
+      expect(
+        cleanObject({
+          k1: ['', undefined, null, 'v', { x: 'y', '': '', k1: undefined, k2: null }],
+          '': '',
+          k2: {},
+          k3: ['', undefined, null, 'v', { x: 'y', '': '' }],
+          k4: {
+            '': '',
+            k: 100
+          }
+        })
+      ).toStrictEqual({
+        k1: ['', undefined, null, 'v', { x: 'y', '': '', k1: undefined, k2: null }],
+        k2: {},
+        k3: ['', undefined, null, 'v', { x: 'y', '': '' }],
+        k4: {
+          k: 100
+        }
+      })
+    })
+  })
+
+  describe('utils', () => {
+    it('cleanobject must clean nested objects', async () => {
+      expect(
+        cleanObject({
+          '': 'v',
+          k: 'v',
+          l1: {
+            '': '',
+            k2: undefined,
+            k3: null,
+            k4: 'v4',
+            l2: {
+              '': '',
+              k2: undefined,
+              k5: 'v5',
+              k3: null
+            }
+          }
+        })
+      ).toStrictEqual({
+        k: 'v',
+        l1: {
+          k2: undefined,
+          k3: null,
+          k4: 'v4',
+          l2: {
+            k2: undefined,
+            k5: 'v5',
+            k3: null
+          }
+        }
+      })
+    })
+  })
+})

packages/destination-actions/src/destinations/ortto/common-fields.ts

@@ -0,0 +1,45 @@
+import { InputField } from '@segment/actions-core'
+
+export const commonFields: Record<string, InputField> = {
+  timestamp: {
+    label: 'Timestamp',
+    description: 'Event timestamp',
+    type: 'string',
+    readOnly: true,
+    format: 'date-time',
+    default: {
+      '@path': '$.timestamp'
+    }
+  },
+  message_id: {
+    label: 'Message ID',
+    description: 'Message ID',
+    type: 'string',
+    readOnly: true,
+    default: {
+      '@path': '$.messageId'
+    }
+  },
+  enable_batching: {
+    type: 'boolean',
+    label: 'Batch data',
+    description: 'When enabled, events will be sent to Ortto in batches for improved efficiency.',
+    default: true
+  },
+  user_id: {
+    label: 'User ID',
+    description: 'The unique user identifier',
+    type: 'string',
+    default: {
+      '@path': '$.userId'
+    }
+  },
+  anonymous_id: {
+    label: 'Anonymous ID',
+    description: 'Anonymous user identifier',
+    type: 'string',
+    default: {
+      '@path': '$.anonymousId'
+    }
+  }
+}