STRATCONN-6127 - [Pendo Audiences] - post partner meeting updates (#3646)

* post partner meeting updates

* unit tests

* tidy up

* fixing tests

* adding region support

Author: joe-ayoub-segment

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

@@ -1,12 +1,13 @@
 import nock from 'nock'
 import { createTestIntegration } from '@segment/actions-core'
 import Destination from '../index'
-import { CONSTANTS } from '../constants'
+import { REGIONS, SEGMENT_ENDPOINT } from '../constants'
 
 const testDestination = createTestIntegration(Destination)
 
 const settings = {
-  integrationKey: 'test-integration-key'
+  integrationKey: 'test-integration-key',
+  region: REGIONS.DEFAULT.name
 }
 
 describe('Pendo Audiences - createAudience', () => {
@@ -15,8 +16,8 @@ describe('Pendo Audiences - createAudience', () => {
   })
 
   it('should create a segment and return the segmentId', async () => {
-    nock(CONSTANTS.API_BASE_URL)
-      .post(`${CONSTANTS.SEGMENT_ENDPOINT}/upload`, { name: 'My Audience', visitors: [] })
+    nock(REGIONS.DEFAULT.domain)
+      .post(`/${SEGMENT_ENDPOINT}/upload`, { name: 'My Audience', visitors: ['empty-visitor'] })
       .reply(200, { segmentId: 'seg-abc123' })
 
     const result = await testDestination.createAudience({
@@ -29,8 +30,8 @@ describe('Pendo Audiences - createAudience', () => {
   })
 
   it('should use audienceSettings.audienceName over audienceName when provided', async () => {
-    nock(CONSTANTS.API_BASE_URL)
-      .post(`${CONSTANTS.SEGMENT_ENDPOINT}/upload`, { name: 'Custom Name', visitors: [] })
+    nock(REGIONS.DEFAULT.domain)
+      .post(`/${SEGMENT_ENDPOINT}/upload`, { name: 'Custom Name', visitors: ['empty-visitor'] })
       .reply(200, { segmentId: 'seg-custom' })
 
     const result = await testDestination.createAudience({
@@ -61,8 +62,8 @@ describe('Pendo Audiences - getAudience', () => {
   it('should return the segmentId when the segment exists', async () => {
     const segmentId = 'seg-abc123'
 
-    nock(CONSTANTS.API_BASE_URL)
-      .get(`${CONSTANTS.SEGMENT_ENDPOINT}/${segmentId}`)
+    nock(REGIONS.DEFAULT.domain)
+      .get(`/${SEGMENT_ENDPOINT}/${segmentId}`)
       .reply(200, { id: segmentId, name: 'My Audience' })
 
     const result = await testDestination.getAudience({
@@ -76,8 +77,8 @@ describe('Pendo Audiences - getAudience', () => {
   it('should throw IntegrationError when segment ID in response does not match', async () => {
     const segmentId = 'seg-abc123'
 
-    nock(CONSTANTS.API_BASE_URL)
-      .get(`${CONSTANTS.SEGMENT_ENDPOINT}/${segmentId}`)
+    nock(REGIONS.DEFAULT.domain)
+      .get(`/${SEGMENT_ENDPOINT}/${segmentId}`)
       .reply(200, { id: 'seg-different', name: 'Other Audience' })
 
     await expect(
@@ -91,8 +92,8 @@ describe('Pendo Audiences - getAudience', () => {
   it('should throw when Pendo returns 404', async () => {
     const segmentId = 'seg-missing'
 
-    nock(CONSTANTS.API_BASE_URL)
-      .get(`${CONSTANTS.SEGMENT_ENDPOINT}/${segmentId}`)
+    nock(REGIONS.DEFAULT.domain)
+      .get(`/${SEGMENT_ENDPOINT}/${segmentId}`)
       .reply(404, { message: 'Not Found' })
 
     await expect(

packages/destination-actions/src/destinations/pendo-audiences/constants.ts

@@ -1,4 +1,24 @@
-export const CONSTANTS = {
-  API_BASE_URL: 'https://app.pendo.io',
-  SEGMENT_ENDPOINT: '/api/v1/segment'
-}
+export const SEGMENT_ENDPOINT = 'api/v1/segment'
+
+export const REGIONS = {
+  DEFAULT: {
+    name: 'US',
+    domain: 'https://app.pendo.io'
+  },
+  US1: {
+    name: 'US1',
+    domain: 'https://us1.app.pendo.io'
+  },
+  EUROPE: {
+    name: 'EU',
+    domain: 'https://app.eu.pendo.io'
+  },
+  JAPAN: {
+    name: 'JP',
+    domain: 'https://app.jpn.pendo.io'
+  },
+  AUSTRALIA: {
+    name: 'AU',
+    domain: 'https://app.au.pendo.io'
+  }
+}

packages/destination-actions/src/destinations/pendo-audiences/functions.ts

@@ -1,11 +1,15 @@
-import { RequestClient, IntegrationError } from '@segment/actions-core'
-import { CONSTANTS } from './constants'
+import { RequestClient, IntegrationError, ErrorCodes } from '@segment/actions-core'
+import { PendoDomain } from './types'
 import type { CreateSegmentJSON, CreateSegmentResponse, GetSegmentResponse } from './types'
+import { REGIONS, SEGMENT_ENDPOINT } from './constants'
 
-export async function createSegment(request: RequestClient, name: string): Promise<string> {
-  const json: CreateSegmentJSON = { name, visitors: [] }
+export async function createSegment(request: RequestClient, region: string, name: string): Promise<string> {
+  const json: CreateSegmentJSON = { 
+    name, 
+    visitors: ["empty-visitor"] // Pendo requires at least one visitor to create a segment, but it can be an empty placeholder since we'll be updating the segment with the actual visitors in the syncAudience function
+  }
   const response = await request<CreateSegmentResponse>(
-    `${CONSTANTS.API_BASE_URL}${CONSTANTS.SEGMENT_ENDPOINT}/upload`,
+    `${getDomain(region)}/${SEGMENT_ENDPOINT}/upload`,
     {
       method: 'POST',
       json
@@ -15,9 +19,9 @@ export async function createSegment(request: RequestClient, name: string): Promi
   return response.data.segmentId
 }
 
-export async function getSegment(request: RequestClient, segmentId: string): Promise<string> {
+export async function getSegment(request: RequestClient, region: string, segmentId: string): Promise<string> {
   const response = await request<GetSegmentResponse>(
-    `${CONSTANTS.API_BASE_URL}${CONSTANTS.SEGMENT_ENDPOINT}/${segmentId}`,
+    `${getDomain(region)}/${SEGMENT_ENDPOINT}/${segmentId}`,
     {
       method: 'GET'
     }
@@ -29,3 +33,13 @@ export async function getSegment(request: RequestClient, segmentId: string): Pro
 
   return segmentId
 }
+
+export function getDomain(regionName: string): PendoDomain {
+  const region = Object.values(REGIONS).find(r => r.name === regionName)
+
+  if (!region) {
+    throw new IntegrationError(`Invalid region: ${regionName}`, ErrorCodes.NOT_IMPLEMENTED, 400);
+  }
+
+  return region.domain
+}

packages/destination-actions/src/destinations/pendo-audiences/generated-types.ts

@@ -1,8 +1,8 @@
 import { AudienceDestinationDefinition, IntegrationError, defaultValues } from '@segment/actions-core'
 import type { Settings, AudienceSettings } from './generated-types'
 import syncAudience from './syncAudience'
-import { createSegment, getSegment } from './functions'
-import { CONSTANTS } from './constants'
+import { getDomain, createSegment, getSegment } from './functions'
+import { REGIONS } from './constants'
 
 const destination: AudienceDestinationDefinition<Settings, AudienceSettings> = {
   name: 'Pendo Audiences',
@@ -18,12 +18,23 @@ const destination: AudienceDestinationDefinition<Settings, AudienceSettings> = {
           'Your Pendo Integration Key. Found in Pendo under Settings > Integrations > Integration Keys.',
         type: 'password',
         required: true
+      },
+      region: {
+        label: 'Region',
+        description: 'The region your Pendo account is hosted in.',
+        type: 'string',
+        required: true,
+        choices: (Object.keys(REGIONS) as Array<keyof typeof REGIONS>).map((key) => ({
+          label: REGIONS[key].name,
+          value: REGIONS[key].name
+        })),
+        default: 'DEFAULT'
       }
     },
-    testAuthentication: async (request) => {
-      return await request(`${CONSTANTS.API_BASE_URL}/api/v1/feature`, {
-        method: 'GET',
-        skipResponseCloning: true
+    testAuthentication: async (request, { settings }) => {
+      const { region } = settings
+      return await request(`${getDomain(region)}/api/v1/token/verify`, {
+        method: 'GET'
       })
     }
   },
@@ -52,7 +63,8 @@ const destination: AudienceDestinationDefinition<Settings, AudienceSettings> = {
     async createAudience(request, createAudienceInput) {
       const {
         audienceName,
-        audienceSettings
+        audienceSettings,
+        settings: { region }
       } = createAudienceInput
 
       const segmentName = audienceSettings?.audienceName ?? audienceName
@@ -61,12 +73,12 @@ const destination: AudienceDestinationDefinition<Settings, AudienceSettings> = {
         throw new IntegrationError('A Pendo Segment name is required', 'MISSING_REQUIRED_FIELD', 422)
       }
 
-      const segmentId = await createSegment(request, segmentName)
+      const segmentId = await createSegment(request, region, segmentName)
       return { externalId: segmentId }
     },
     async getAudience(request, getAudienceInput) {
-      const { externalId } = getAudienceInput
-      const segmentId = await getSegment(request, externalId)
+      const { externalId, settings: { region } } = getAudienceInput
+      const segmentId = await getSegment(request, region, externalId)
       return { externalId: segmentId }
     }
   },