Skip to content

[Vibe] Add Vibe Audience destination #3244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 15, 2025
Merged

[Vibe] Add Vibe Audience destination #3244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b64ad35
Add Vibe Audience destination with authentication, audience managemen…
Max0u Sep 8, 2025
bfc4769
Refactor Vibe Audience sync
Max0u Sep 11, 2025
6165bf2
Update Vibe Audience destination description
Max0u Sep 12, 2025
135090a
Update Vibe Audience base URL to production endpoint
Max0u Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
398 changes: 398 additions & 0 deletions packages/destination-actions/src/destinations/vibe-audience/__tests__/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,398 @@
import nock from 'nock'
import { createTestIntegration, createTestEvent } from '@segment/actions-core'
import Definition from '../index'
import { BASE_URL, API_VERSION } from '../constants'

const testDestination = createTestIntegration(Definition)

describe('Vibe Audience', () => {
describe('testAuthentication', () => {
it('should validate authentication inputs', async () => {
const baseUrlParts = new URL(BASE_URL)
nock(baseUrlParts.origin).get(`/${API_VERSION}/webhooks/twilio/test-advertiser-id`).reply(200, { success: true })

// This should match your authentication.fields
const authData = {
advertiserId: 'test-advertiser-id',
authToken: 'test-auth-token'
}

await expect(testDestination.testAuthentication(authData)).resolves.not.toThrowError()
})
})

describe('sync action', () => {
it('should sync audience data with add and remove emails', async () => {
const baseUrlParts = new URL(BASE_URL)
nock(baseUrlParts.origin)
.post(`/${API_VERSION}/webhooks/twilio/test-advertiser-id/audience/sync`)
.reply(200, { success: true })

const settings = {
advertiserId: 'test-advertiser-id',
authToken: 'test-auth-token'
}

const event = createTestEvent({
traits: {
email: '[email protected]',
'Test Audience': true
}
})

const mapping = {
email: '[email protected]',
audience_name: 'Test Audience',
audience_id: 'test-audience-id',
traits_or_props: {
'Test Audience': true
},
enable_batching: true,
batch_size: 1000,
batch_keys: ['audience_id', 'audience_name']
}

const responses = await testDestination.testAction('sync', {
event,
mapping,
settings
})

expect(responses).toHaveLength(1)
expect(responses[0].status).toBe(200)
})

it('should sync audience data with personal information (first name, last name, phone)', async () => {
const baseUrlParts = new URL(BASE_URL)
nock(baseUrlParts.origin)
.post(`/${API_VERSION}/webhooks/twilio/test-advertiser-id/audience/sync`)
.reply(200, { success: true })

const settings = {
advertiserId: 'test-advertiser-id',
authToken: 'test-auth-token'
}

const event = createTestEvent({
traits: {
email: '[email protected]',
first_name: 'John',
last_name: 'Doe',
phone: '+1234567890',
'Test Audience': true
}
})

const mapping = {
email: '[email protected]',
audience_name: 'Test Audience',
audience_id: 'test-audience-id',
traits_or_props: {
'Test Audience': true
},
personal_information: {
first_name: 'John',
last_name: 'Doe',
phone: '+1234567890'
},
enable_batching: true,
batch_size: 1000,
batch_keys: ['audience_id', 'audience_name']
}

const responses = await testDestination.testAction('sync', {
event,
mapping,
settings
})

expect(responses).toHaveLength(1)
expect(responses[0].status).toBe(200)

// Verify the request body contains personal information
const requestBody = JSON.parse(responses[0].options.body as string)
expect(requestBody.addProfiles).toHaveLength(1)
expect(requestBody.addProfiles[0]).toEqual({
email: '[email protected]',
profileDetails: {
first_name: 'John',
last_name: 'Doe',
phone: '+1234567890'
}
})
})

it('should sync audience data with partial personal information (first name only)', async () => {
const baseUrlParts = new URL(BASE_URL)
nock(baseUrlParts.origin)
.post(`/${API_VERSION}/webhooks/twilio/test-advertiser-id/audience/sync`)
.reply(200, { success: true })

const settings = {
advertiserId: 'test-advertiser-id',
authToken: 'test-auth-token'
}

const event = createTestEvent({
traits: {
email: '[email protected]',
first_name: 'Jane',
'Test Audience': true
}
})

const mapping = {
email: '[email protected]',
audience_name: 'Test Audience',
audience_id: 'test-audience-id',
traits_or_props: {
'Test Audience': true
},
personal_information: {
first_name: 'Jane'
},
enable_batching: true,
batch_size: 1000,
batch_keys: ['audience_id', 'audience_name']
}

const responses = await testDestination.testAction('sync', {
event,
mapping,
settings
})

expect(responses).toHaveLength(1)
expect(responses[0].status).toBe(200)

// Verify the request body contains only first name
const requestBody = JSON.parse(responses[0].options.body as string)
expect(requestBody.addProfiles).toHaveLength(1)
expect(requestBody.addProfiles[0]).toEqual({
email: '[email protected]',
profileDetails: {
first_name: 'Jane'
}
})
})

it('should sync audience data with phone number only', async () => {
const baseUrlParts = new URL(BASE_URL)
nock(baseUrlParts.origin)
.post(`/${API_VERSION}/webhooks/twilio/test-advertiser-id/audience/sync`)
.reply(200, { success: true })

const settings = {
advertiserId: 'test-advertiser-id',
authToken: 'test-auth-token'
}

const event = createTestEvent({
traits: {
email: '[email protected]',
phone: '+1-555-0123',
'Test Audience': true
}
})

const mapping = {
email: '[email protected]',
audience_name: 'Test Audience',
audience_id: 'test-audience-id',
traits_or_props: {
'Test Audience': true
},
personal_information: {
phone: '+1-555-0123'
},
enable_batching: true,
batch_size: 1000,
batch_keys: ['audience_id', 'audience_name']
}

const responses = await testDestination.testAction('sync', {
event,
mapping,
settings
})

expect(responses).toHaveLength(1)
expect(responses[0].status).toBe(200)

// Verify the request body contains only phone
const requestBody = JSON.parse(responses[0].options.body as string)
expect(requestBody.addProfiles).toHaveLength(1)
expect(requestBody.addProfiles[0]).toEqual({
email: '[email protected]',
profileDetails: {
phone: '+1-555-0123'
}
})
})

it('should handle batch sync with multiple payloads', async () => {
const baseUrlParts = new URL(BASE_URL)
nock(baseUrlParts.origin)
.post(`/${API_VERSION}/webhooks/twilio/test-advertiser-id/audience/sync`)
.reply(200, { success: true })

const settings = {
advertiserId: 'test-advertiser-id',
authToken: 'test-auth-token'
}

const events = [
createTestEvent({
traits: {
email: '[email protected]',
'Test Audience': true
}
}),
createTestEvent({
traits: {
email: '[email protected]',
'Test Audience': false
}
})
]

const mapping = {
email: {
'@if': {
exists: { '@path': '$.traits.email' },
then: { '@path': '$.traits.email' },
else: { '@path': '$.properties.email' }
}
},
audience_name: 'Test Audience',
audience_id: 'test-audience-id',
traits_or_props: {
'@if': {
exists: { '@path': '$.properties' },
then: { '@path': '$.properties' },
else: { '@path': '$.traits' }
}
},
enable_batching: true,
batch_size: 1000,
batch_keys: ['audience_id', 'audience_name']
}

const responses = await testDestination.testBatchAction('sync', {
events,
mapping,
settings
})

expect(responses).toHaveLength(1)
expect(responses[0].status).toBe(200)
})

it('should handle batch sync with personal information', async () => {
const baseUrlParts = new URL(BASE_URL)
nock(baseUrlParts.origin)
.post(`/${API_VERSION}/webhooks/twilio/test-advertiser-id/audience/sync`)
.reply(200, { success: true })

const settings = {
advertiserId: 'test-advertiser-id',
authToken: 'test-auth-token'
}

const events = [
createTestEvent({
traits: {
email: '[email protected]',
first_name: 'John',
last_name: 'Smith',
phone: '+1234567890',
'Test Audience': true
}
}),
createTestEvent({
traits: {
email: '[email protected]',
first_name: 'Jane',
last_name: 'Doe',
'Test Audience': false
}
}),
createTestEvent({
traits: {
email: '[email protected]',
phone: '+9876543210',
'Test Audience': true
}
})
]

const mapping = {
email: {
'@path': '$.traits.email'
},
audience_name: 'Test Audience',
audience_id: 'test-audience-id',
traits_or_props: {
'@path': '$.traits'
},
personal_information: {
first_name: {
'@path': '$.traits.first_name'
},
last_name: {
'@path': '$.traits.last_name'
},
phone: {
'@path': '$.traits.phone'
}
},
enable_batching: true,
batch_size: 1000,
batch_keys: ['audience_id', 'audience_name']
}

const responses = await testDestination.testBatchAction('sync', {
events,
mapping,
settings
})

expect(responses).toHaveLength(1)
expect(responses[0].status).toBe(200)

// Verify the request body contains proper profile details
const requestBody = JSON.parse(responses[0].options.body as string)

// Check add profiles (users with audience = true)
expect(requestBody.addProfiles).toHaveLength(2)
expect(requestBody.addProfiles).toEqual([
{
email: '[email protected]',
profileDetails: {
first_name: 'John',
last_name: 'Smith',
phone: '+1234567890'
}
},
{
email: '[email protected]',
profileDetails: {
phone: '+9876543210'
}
}
])

// Check remove profiles (users with audience = false)
expect(requestBody.removeProfiles).toHaveLength(1)
expect(requestBody.removeProfiles).toEqual([
{
email: '[email protected]',
profileDetails: {
first_name: 'Jane',
last_name: 'Doe'
}
}
])
})
})
})
Loading
Loading