APP-86828 Pendo browser destination (#1683)

* APP-86828 update pendo browser destination * APP-86828 set fields to readOnly, will need to test if this works as expected * APP-86828 change default region to value from label * APP-86828 update region labels and add jp * APP-86828 add CNAME configuration support * APP-86828 add parentAccount field for group() * APP-86828 remove flushNow call and update identify unit test
segmentio · Nov 15, 2023 · b3c039b · b3c039b
1 parent 6a97cb3
commit b3c039b
Show file tree

Hide file tree

Showing 11 changed files with 107 additions and 206 deletions.
diff --git a/packages/browser-destinations/destinations/pendo-web-actions/src/generated-types.ts b/packages/browser-destinations/destinations/pendo-web-actions/src/generated-types.ts
diff --git a/...ges/browser-destinations/destinations/pendo-web-actions/src/group/__tests__/index.test.ts b/...ges/browser-destinations/destinations/pendo-web-actions/src/group/__tests__/index.test.ts
@@ -46,7 +46,8 @@ describe('Pendo.group', () => {
         initialize: jest.fn(),
         isReady: jest.fn(),
         track: jest.fn(),
-        identify: jest.fn()
+        identify: jest.fn(),
+        flushNow: jest.fn()
       }
       return Promise.resolve(mockPendo)
     })

diff --git a/packages/browser-destinations/destinations/pendo-web-actions/src/group/generated-types.ts b/packages/browser-destinations/destinations/pendo-web-actions/src/group/generated-types.ts
diff --git a/packages/browser-destinations/destinations/pendo-web-actions/src/group/index.ts b/packages/browser-destinations/destinations/pendo-web-actions/src/group/index.ts
@@ -1,7 +1,7 @@
 import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
-import type { PendoSDK, identifyPayload } from '../types'
+import type { PendoSDK, PendoOptions } from '../types'
 
 const action: BrowserActionDefinition<Settings, PendoSDK, Payload> = {
   title: 'Send Group Event',
@@ -11,59 +11,62 @@ const action: BrowserActionDefinition<Settings, PendoSDK, Payload> = {
   fields: {
     visitorId: {
       label: 'Visitor ID',
-      description: 'Pendo Visitor ID. Defaults to Segment userId',
+      description: 'Pendo Visitor ID. Maps to Segment userId',
       type: 'string',
       required: true,
       default: {
         '@path': '$.userId'
-      }
+      },
+      readOnly: true
     },
     accountId: {
       label: 'Account ID',
-      description: 'Pendo Account ID. This overrides the Pendo Account ID setting',
+      description: 'Pendo Account ID',
       type: 'string',
       required: true,
-      default: { '@path': '$.groupId' }
+      default: { '@path': '$.groupId' },
+      readOnly: true
     },
     accountData: {
       label: 'Account Metadata',
       description: 'Additional Account data to send',
       type: 'object',
-      required: false
-    },
-    parentAccountId: {
-      label: 'Parent Account ID',
-      description:
-        'Pendo Parent Account ID. This overrides the Pendo Parent Account ID setting. Note: Contact Pendo to request enablement of Parent Account feature.',
-      type: 'string',
-      required: false
+      required: false,
+      default: { '@path': '$.traits' },
+      readOnly: true
     },
     parentAccountData: {
       label: 'Parent Account Metadata',
       description:
         'Additional Parent Account data to send. Note: Contact Pendo to request enablement of Parent Account feature.',
       type: 'object',
+      properties: {
+        id: {
+          label: 'Parent Account ID',
+          type: 'string',
+          required: true
+        }
+      },
+      additionalProperties: true,
+      default: { '@path': '$.traits.parentAccount' },
       required: false
     }
   },
   perform: (pendo, event) => {
-    const payload: identifyPayload = {
+    const payload: PendoOptions = {
       visitor: {
         id: event.payload.visitorId
+      },
+      account: {
+        ...event.payload.accountData,
+        id: event.payload.accountId
       }
     }
-    if (event.payload.accountId || event.settings.accountId) {
-      payload.account = {
-        id: event.payload.accountId ?? (event.settings.accountId as string),
-        ...event.payload.accountData
-      }
-    }
-    if (event.payload.parentAccountId || event.settings.parentAccountId) {
-      payload.parentAccount = {
-        id: (event.payload.parentAccountId as string) ?? (event.settings.parentAccountId as string),
-        ...event.payload.parentAccountData
-      }
+
+    if (event.payload.parentAccountData) {
+      payload.parentAccount = event.payload.parentAccountData
     }
+
     pendo.identify(payload)
   }
 }

diff --git a/.../browser-destinations/destinations/pendo-web-actions/src/identify/__tests__/index.test.ts b/.../browser-destinations/destinations/pendo-web-actions/src/identify/__tests__/index.test.ts
@@ -15,9 +15,6 @@ const subscriptions: Subscription[] = [
       },
       visitorData: {
         '@path': '$.traits'
-      },
-      accountId: {
-        '@path': '$.context.group_id'
       }
     }
   }
@@ -26,7 +23,6 @@ const subscriptions: Subscription[] = [
 describe('Pendo.identify', () => {
   const settings = {
     apiKey: 'abc123',
-    setVisitorIdOnLoad: 'disabled',
     region: 'io'
   }
 
@@ -46,7 +42,8 @@ describe('Pendo.identify', () => {
         initialize: jest.fn(),
         isReady: jest.fn(),
         track: jest.fn(),
-        identify: jest.fn()
+        identify: jest.fn(),
+        flushNow: jest.fn()
       }
       return Promise.resolve(mockPendo)
     })
@@ -59,15 +56,11 @@ describe('Pendo.identify', () => {
       userId: 'testUserId',
       traits: {
         first_name: 'Jimbo'
-      },
-      context: {
-        group_id: 'company_id_1'
       }
     })
     await identifyAction.identify?.(context)
 
     expect(mockPendo.identify).toHaveBeenCalledWith({
-      account: { id: 'company_id_1' },
       visitor: { first_name: 'Jimbo', id: 'testUserId' }
     })
   })

diff --git a/packages/browser-destinations/destinations/pendo-web-actions/src/identify/generated-types.ts b/packages/browser-destinations/destinations/pendo-web-actions/src/identify/generated-types.ts
diff --git a/packages/browser-destinations/destinations/pendo-web-actions/src/identify/index.ts b/packages/browser-destinations/destinations/pendo-web-actions/src/identify/index.ts
@@ -1,7 +1,7 @@
 import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
-import type { PendoSDK, identifyPayload } from '../types'
+import type { PendoSDK, PendoOptions } from '../types'
 
 const action: BrowserActionDefinition<Settings, PendoSDK, Payload> = {
   title: 'Send Identify Event',
@@ -11,74 +11,32 @@ const action: BrowserActionDefinition<Settings, PendoSDK, Payload> = {
   fields: {
     visitorId: {
       label: 'Visitor ID',
-      description: 'Pendo Visitor ID. Defaults to Segment userId',
+      description: 'Pendo Visitor ID. Maps to Segment userId',
       type: 'string',
       required: true,
       default: {
         '@path': '$.userId'
-      }
+      },
+      readOnly: true
     },
     visitorData: {
       label: 'Visitor Metadata',
       description: 'Additional Visitor data to send',
       type: 'object',
       default: {
         '@path': '$.traits'
-      }
-    },
-    accountId: {
-      label: 'Account ID',
-      description: 'Pendo Account ID. This overrides the Pendo Account ID setting',
-      type: 'string',
-      required: false,
-      default: {
-        '@if': {
-          exists: { '@path': '$.context.group_id' },
-          then: { '@path': '$.context.group_id' },
-          else: { '@path': '$.groupId' }
-        }
-      }
-    },
-    accountData: {
-      label: 'Account Metadata',
-      description: 'Additional Account data to send',
-      type: 'object',
-      required: false
-    },
-    parentAccountId: {
-      label: 'Parent Account ID',
-      description:
-        'Pendo Parent Account ID. This overrides the Pendo Parent Account ID setting. Note: Contact Pendo to request enablement of Parent Account feature.',
-      type: 'string',
-      required: false
-    },
-    parentAccountData: {
-      label: 'Parent Account Metadata',
-      description:
-        'Additional Parent Account data to send. Note: Contact Pendo to request enablement of Parent Account feature.',
-      type: 'object',
-      required: false
+      },
+      readOnly: true
     }
   },
   perform: (pendo, event) => {
-    const payload: identifyPayload = {
+    const payload: PendoOptions = {
       visitor: {
-        id: event.payload.visitorId,
-        ...event.payload.visitorData
-      }
-    }
-    if (event.payload.accountId || event.settings.accountId) {
-      payload.account = {
-        id: (event.payload.accountId as string) ?? (event.settings.accountId as string),
-        ...event.payload.accountData
-      }
-    }
-    if (event.payload.parentAccountId || event.settings.parentAccountId) {
-      payload.parentAccount = {
-        id: (event.payload.parentAccountId as string) ?? (event.settings.parentAccountId as string),
-        ...event.payload.parentAccountData
+        ...event.payload.visitorData,
+        id: event.payload.visitorId
       }
     }
+
     pendo.identify(payload)
   }
 }