Supporting Group event in Userpilot cloud destination (#2838)

Author: ThabetIbrahim

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

@@ -1,5 +1,22 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`Testing snapshot for actions-userpilot destination: identifyCompany action - all fields 1`] = `
+Object {
+  "company_id": "89X4YJ9nBQcMn%#",
+  "metadata": Object {
+    "created_at": "2021-02-01T00:00:00.000Z",
+    "testType": "89X4YJ9nBQcMn%#",
+  },
+}
+`;
+
+exports[`Testing snapshot for actions-userpilot destination: identifyCompany action - required fields 1`] = `
+Object {
+  "company_id": "89X4YJ9nBQcMn%#",
+  "metadata": Object {},
+}
+`;
+
 exports[`Testing snapshot for actions-userpilot destination: identifyUser action - all fields 1`] = `
 Object {
   "metadata": Object {

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

@@ -0,0 +1,18 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Testing snapshot for Userpilot's identifyCompany destination action: all fields 1`] = `
+Object {
+  "company_id": "%F6H5r8FNR",
+  "metadata": Object {
+    "created_at": "2021-02-01T00:00:00.000Z",
+    "testType": "%F6H5r8FNR",
+  },
+}
+`;
+
+exports[`Testing snapshot for Userpilot's identifyCompany destination action: required fields 1`] = `
+Object {
+  "company_id": "%F6H5r8FNR",
+  "metadata": Object {},
+}
+`;

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

@@ -0,0 +1,49 @@
+import nock from 'nock'
+import { createTestEvent, createTestIntegration } from '@segment/actions-core'
+import Destination from '../../index'
+
+const testDestination = createTestIntegration(Destination)
+
+const companyId = 'fake-company-id'
+const apiKey = 'fake-api-key'
+const baseUrl = 'https://analytex.userpilot.io/'
+
+describe('Userpilot.identifyCompany', () => {
+  it('should call identifyCompany successfully', async () => {
+    nock(baseUrl).post('/v1/companies/identify').reply(202, {})
+
+    const event = createTestEvent({
+      groupId: companyId,
+      traits: {
+        name: 'Company Name',
+        primary_email: '[email protected]',
+        createdAt: '2021-01-01'
+      }
+    })
+
+    const responses = await testDestination.testAction('identifyCompany', {
+      event,
+      settings: {
+        apiKey: apiKey,
+        endpoint: baseUrl
+      },
+      mapping: {
+        groupId: companyId,
+        traits: {
+          name: 'Company Name',
+          primary_email: '[email protected]',
+          createdAt: '2021-01-01'
+        }
+      }
+    })
+
+    expect(responses.length).toBe(1)
+    expect(responses[0].status).toBe(202)
+
+    expect(responses[0].options.body).toMatchInlineSnapshot(
+      `"{\\"company_id\\":\\"fake-company-id\\",\\"metadata\\":{\\"name\\":\\"Company Name\\",\\"primary_email\\":\\"[email protected]\\"}}"`
+    )
+
+    expect(nock.isDone()).toBe(true)
+  })
+})

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

@@ -0,0 +1,75 @@
+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 = 'identifyCompany'
+const destinationSlug = 'Userpilot'
+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({
+      properties: eventData
+    })
+
+    const responses = await testDestination.testAction(actionSlug, {
+      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({
+      properties: eventData
+    })
+
+    const responses = await testDestination.testAction(actionSlug, {
+      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()
+    }
+  })
+})

packages/destination-actions/src/destinations/userpilot/identifyCompany/generated-types.ts

@@ -0,0 +1,55 @@
+import type { ActionDefinition } from '@segment/actions-core'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+
+import { getCompanyIdentifyRequestParams } from '../request-utils'
+
+const action: ActionDefinition<Settings, Payload> = {
+  title: 'Identify Company',
+  description:
+    'Defines a company in Userpilot, you can visit [Userpilot docs](https://docs.userpilot.com/article/23-identify-users-track-custom-events) for more information.',
+  defaultSubscription: 'type = "group"',
+  fields: {
+    groupId: {
+      type: 'string',
+      required: true,
+      description: 'The ID of the company.',
+      label: 'Company ID',
+      default: {
+        '@path': '$.groupId'
+      }
+    },
+    createdAt: {
+      type: 'datetime',
+      required: false,
+      description: 'The date the company profile was created at',
+      label: 'Company Created At Date',
+      default: {
+        '@path': '$.traits.createdAt'
+      }
+    },
+    traits: {
+      type: 'object',
+      required: false,
+      description: 'Segment traits',
+      label: 'Traits',
+      default: {
+        '@path': '$.traits'
+      }
+    }
+  },
+  perform: (request, { settings, payload }) => {
+    const { traits, groupId, createdAt } = payload
+
+    traits?.createdAt && delete traits.createdAt
+
+    const { url, options } = getCompanyIdentifyRequestParams(settings, {
+      traits: { ...traits, created_at: createdAt || traits?.created_at },
+      groupId
+    })
+
+    return request(url, options)
+  }
+}
+
+export default action

packages/destination-actions/src/destinations/userpilot/identifyCompany/index.ts

@@ -1,4 +1,5 @@
 import type { DestinationDefinition } from '@segment/actions-core'
+
 import { defaultValues } from '@segment/actions-core'
 
 import type { Settings } from './generated-types'
@@ -9,6 +10,8 @@ import identifyUser from './identifyUser'
 
 import trackEvent from './trackEvent'
 
+import identifyCompany from './identifyCompany'
+
 const destination: DestinationDefinition<Settings> = {
   name: 'Userpilot Cloud (Actions)',
   slug: 'actions-userpilot-cloud',
@@ -21,6 +24,13 @@ const destination: DestinationDefinition<Settings> = {
       mapping: defaultValues(identifyUser.fields),
       type: 'automatic'
     },
+    {
+      name: 'Identify Company',
+      subscribe: 'type = "group"',
+      partnerAction: 'identifyCompany',
+      mapping: defaultValues(identifyCompany.fields),
+      type: 'automatic'
+    },
     {
       name: 'Track Event',
       subscribe: 'type = "track"',
@@ -72,7 +82,8 @@ const destination: DestinationDefinition<Settings> = {
 
   actions: {
     identifyUser,
-    trackEvent
+    trackEvent,
+    identifyCompany
   }
 }
 

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

@@ -1,6 +1,7 @@
 import type { Settings } from './generated-types'
 import type { Payload as IdentifyPayload } from './identifyUser/generated-types'
 import type { Payload as TrackPayload } from './trackEvent/generated-types'
+import type { Payload as GroupPayload } from './identifyCompany/generated-types'
 
 import { RequestOptions } from '@segment/actions-core'
 
@@ -45,6 +46,20 @@ export const getIdentifyRequestParams = (settings: Settings, payload: IdentifyPa
     }
   }
 }
+export const getCompanyIdentifyRequestParams = (settings: Settings, payload: GroupPayload): RequestParams => {
+  const { traits, groupId } = payload
+
+  return {
+    url: `${validateEndpoint(settings.endpoint)}v1/companies/identify`,
+    options: {
+      method: 'POST',
+      json: {
+        company_id: groupId,
+        metadata: traits
+      }
+    }
+  }
+}
 
 export const getTrackEventParams = (settings: Settings, payload: TrackPayload): RequestParams => {
   const { userId, name, properties } = payload