Skip to content
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.

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

feat: onboard linkedin audience destination #3857

Merged
merged 14 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
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
10 changes: 10 additions & 0 deletions src/cdk/v2/destinations/linkedin_audience/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
export const SUPPORTED_EVENT_TYPE = 'record';
export const ACTION_TYPES = ['insert', 'delete'];
export const BASE_ENDPOINT = 'https://api.linkedin.com/rest';
export const USER_ENDPOINT = '/dmpSegments/audienceId/users';
export const COMPANY_ENDPOINT = '/dmpSegments/audienceId/companies';
export const FIELD_MAP = {
sha256Email: 'SHA256_EMAIL',
sha512Email: 'SHA512_EMAIL',
googleAid: 'GOOGLE_AID',
};
97 changes: 97 additions & 0 deletions src/cdk/v2/destinations/linkedin_audience/procWorkflow.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
bindings:
- path: ./config
exportAll: true
- path: ./utils
exportAll: true
- name: defaultRequestConfig
path: ../../../../v0/util

steps:
- name: validateInput
description: Validate input, if all the required fields are available or not.
template: |
const config = .connection.config.destination;
const secret = .metadata.secret;
let messageType = .message.type;
$.assertConfig(config.audienceId, "Audience Id is not present. Aborting");
$.assertConfig(secret.accessToken, "Access Token is not present. Aborting");
$.assertConfig(config.audienceType, "audienceType is not present. Aborting");
$.assert(messageType, "Message Type is not present. Aborting message.");
$.assert(messageType.toLowerCase() === $.SUPPORTED_EVENT_TYPE, "Event type " + .message.type.toLowerCase() + " is not supported. Aborting message.");
$.assert(.message.fields, "`fields` is not present. Aborting message.");
$.assert(.message.identifiers, "`identifiers` is not present inside properties. Aborting message.");
$.assert($.containsAll([.message.action], $.ACTION_TYPES), "Unsupported action type. Aborting message.")

- name: getConfigs
description: This step fetches the configs from different places and combines them.
template: |
const config = .connection.config.destination;
const secret = .metadata.secret;
const audienceType = config.audienceType;
const audienceId = config.audienceId;
const accessToken = secret.accessToken;
{
audienceType,
audienceId,
accessToken,
isHashRequired: config.isHashRequired,
}

- name: hashIdentifiers
description: Hash identifiers
condition: $.outputs.getConfigs.isHashRequired === true && $.outputs.getConfigs.audienceType === 'user'
template: |
const hashedIdentifiers = $.hashIdentifiers(.message.identifiers);
hashedIdentifiers;

- name: prepareUserIds
description: Prepare user ids for user audience type
condition: $.outputs.getConfigs.audienceType === 'user'
template: |
const userIds = $.outputs.getConfigs.isHashRequired ? $.prepareUserIds($.outputs.hashIdentifiers) : $.prepareUserIds(.message.identifiers);
userIds;

- name: prepareUserTypeBasePayload
description: Prepare base payload for user audiences
condition: $.outputs.getConfigs.audienceType === 'user'
template: |
const payload = {
'elements': [
{
'action': $.generateActionType(.message.action),
'userIds': $.outputs.prepareUserIds,
....message.fields
}
]
}
payload;

- name: prepareCompanyTypeBasePayload
description: Prepare base payload for company audiences
condition: $.outputs.getConfigs.audienceType === 'company'
template: |
const payload = {
'elements': [
{
'action': $.generateActionType(.message.action),
....message.identifiers,
....message.fields
}
]
}
payload;

- name: buildResponseForProcessTransformation
description: build response depending upon batch size
template: |
const response = $.defaultRequestConfig();
response.body.JSON = {...$.outputs.prepareUserTypeBasePayload, ...$.outputs.prepareCompanyTypeBasePayload};
response.endpoint = $.generateEndpoint($.outputs.getConfigs.audienceType, $.outputs.getConfigs.audienceId);
response.headers = {
"Authorization": "Bearer " + $.outputs.getConfigs.accessToken,
"Content-Type": "application/json",
"X-RestLi-Method": "BATCH_CREATE",
"X-Restli-Protocol-Version": "2.0.0",
"LinkedIn-Version": "202409"
};
response;
40 changes: 40 additions & 0 deletions src/cdk/v2/destinations/linkedin_audience/rtWorkflow.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
bindings:
- path: ./utils
- name: handleRtTfSingleEventError
path: ../../../../v0/util/index

steps:
- name: validateInput
template: |
$.assert(Array.isArray(^) && ^.length > 0, "Invalid event array")

- name: transform
externalWorkflow:
path: ./procWorkflow.yaml
bindings:
- name: batchMode
value: true
loopOverInput: true

- name: successfulEvents
template: |
$.outputs.transform#idx.output.({
"message": .[],
"destination": ^ [idx].destination,
"metadata": ^ [idx].metadata
})[]

- name: failedEvents
template: |
$.outputs.transform#idx.error.(
$.handleRtTfSingleEventError(^[idx], .originalError ?? ., {})
)[]

- name: batchSuccessfulEvents
description: Batches the successfulEvents
template: |
$.batchResponseBuilder($.outputs.successfulEvents);

- name: finalPayload
template: |
[...$.outputs.batchSuccessfulEvents, ...$.outputs.failedEvents]
87 changes: 87 additions & 0 deletions src/cdk/v2/destinations/linkedin_audience/utils.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
import lodash from 'lodash';
import { hashToSha256 } from '@rudderstack/integrations-lib';
import { createHash } from 'crypto';
import { BASE_ENDPOINT, COMPANY_ENDPOINT, FIELD_MAP, USER_ENDPOINT } from './config';

export function hashIdentifiers(identifiers: string[]): Record<string, string> {
const hashedIdentifiers = {};
Object.keys(identifiers).forEach((key) => {
if (key === 'sha256Email') {
hashedIdentifiers[key] = hashToSha256(identifiers[key]);
} else if (key === 'sha512Email') {
hashedIdentifiers[key] = createHash('sha512').update(identifiers[key]).digest('hex');
} else {
hashedIdentifiers[key] = identifiers[key];

Check warning on line 14 in src/cdk/v2/destinations/linkedin_audience/utils.ts

View check run for this annotation

Codecov / codecov/patch

src/cdk/v2/destinations/linkedin_audience/utils.ts#L13-L14

Added lines #L13 - L14 were not covered by tests
}
});
return hashedIdentifiers;
}

export function prepareUserIds(
identifiers: Record<string, string>,
): { idType: string; idValue: string }[] {
const userIds: { idType: string; idValue: string }[] = [];
Object.keys(identifiers).forEach((key) => {
userIds.push({ idType: FIELD_MAP[key], idValue: identifiers[key] });
});
return userIds;
}

export function generateEndpoint(audienceType: string, audienceId: string) {
if (audienceType === 'user') {
return BASE_ENDPOINT + USER_ENDPOINT.replace('audienceId', audienceId);
}
return BASE_ENDPOINT + COMPANY_ENDPOINT.replace('audienceId', audienceId);
}

export function batchResponseBuilder(successfulEvents) {
const chunkOnActionType = lodash.groupBy(
successfulEvents,
(event) => event.message[0].body.JSON.elements[0].action,
);
const result: any = [];
Object.keys(chunkOnActionType).forEach((actionType) => {
const firstEvent = chunkOnActionType[actionType][0];
const { method, endpoint, headers, type, version } = firstEvent.message[0];
const batchEvent = {
batchedRequest: {
body: {
JSON: { elements: firstEvent.message[0].body.JSON.elements },
JSON_ARRAY: {},
XML: {},
FORM: {},
},
version,
type,
method,
endpoint,
headers,
params: {},
files: {},
},
metadata: [firstEvent.metadata],
batched: true,
statusCode: 200,
destination: firstEvent.destination,
};
firstEvent.metadata = [firstEvent.metadata];
chunkOnActionType[actionType].forEach((element, index) => {
if (index !== 0) {
batchEvent.batchedRequest.body.JSON.elements.push(element.message[0].body.JSON.elements[0]);
batchEvent.metadata.push(element.metadata);
}
});
result.push(batchEvent);
});
return result;
}

export const generateActionType = (actionType: string): string => {
if (actionType === 'insert') {
return 'ADD';
}
if (actionType === 'delete') {
return 'REMOVE';

Check warning on line 84 in src/cdk/v2/destinations/linkedin_audience/utils.ts

View check run for this annotation

Codecov / codecov/patch

src/cdk/v2/destinations/linkedin_audience/utils.ts#L84

Added line #L84 was not covered by tests
}
return actionType;

Check warning on line 86 in src/cdk/v2/destinations/linkedin_audience/utils.ts

View check run for this annotation

Codecov / codecov/patch

src/cdk/v2/destinations/linkedin_audience/utils.ts#L86

Added line #L86 was not covered by tests
};
1 change: 1 addition & 0 deletions src/features.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ const defaultFeaturesConfig: FeaturesConfig = {
HTTP: true,
AMAZON_AUDIENCE: true,
INTERCOM_V2: true,
LINKEDIN_AUDIENCE: true,
},
regulations: [
'BRAZE',
Expand Down
Loading
Loading