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

[SMART-HASHING] [STRATCONN-5550] Updated hashing utils for tiktok-audiences #2796

Merged
merged 1 commit into from
Mar 20, 2025
Merged
Show file tree
Hide file tree
Changes from all 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
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ describe('TikTok Audiences Functions', () => {
audience_id: '1234567890'
}

const result: any[][] = extractUsers([payload])
const result: any[][] = extractUsers([payload], { 'smart-hashing': true })
expect(result[0][0].id).toEqual('77bc071241f37b4736df28c0c1cb0a99163d1050696134325b99246b2183d408')
})

Expand All @@ -20,7 +20,7 @@ describe('TikTok Audiences Functions', () => {
audience_id: '1234567890'
}

const result: any[][] = extractUsers([payload])
const result: any[][] = extractUsers([payload], { 'smart-hashing': true })
expect(result[0][0].id).toEqual('77bc071241f37b4736df28c0c1cb0a99163d1050696134325b99246b2183d408')
})

Expand All @@ -32,7 +32,7 @@ describe('TikTok Audiences Functions', () => {
advertising_id: '12345'
}

const result: any[][] = extractUsers([payload])
const result: any[][] = extractUsers([payload], { 'smart-hashing': true })
expect(result[0][0].id).toEqual('e5aaca26e304714083dccf6d2dbc16466e9cde94ca54feefa3dca412e2eeb74e')
})

Expand All @@ -44,7 +44,7 @@ describe('TikTok Audiences Functions', () => {
advertising_id: '12345'
}

const result: any[][] = extractUsers([payload])
const result: any[][] = extractUsers([payload], { 'smart-hashing': true })
expect(result[0][0].id).toEqual('e5aaca26e304714083dccf6d2dbc16466e9cde94ca54feefa3dca412e2eeb74e')
})
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const action: ActionDefinition<Settings, Payload, AudienceSettings> = {
enable_batching: { ...enable_batching },
external_audience_id: { ...external_audience_id }
},
perform: async (request, { audienceSettings, payload, statsContext }) => {
perform: async (request, { audienceSettings, payload, statsContext, features }) => {
const statsClient = statsContext?.statsClient
const statsTag = statsContext?.tags

Expand All @@ -42,9 +42,9 @@ const action: ActionDefinition<Settings, Payload, AudienceSettings> = {
statsClient?.incr('addToAudience', 1, statsTag)
}

return processPayload(request, audienceSettings, [payload], 'add')
return processPayload(request, audienceSettings, [payload], 'add', features || {})
},
performBatch: async (request, { payload, audienceSettings, statsContext }) => {
performBatch: async (request, { payload, audienceSettings, statsContext, features }) => {
const statsClient = statsContext?.statsClient
const statsTag = statsContext?.tags

Expand All @@ -56,7 +56,7 @@ const action: ActionDefinition<Settings, Payload, AudienceSettings> = {
statsClient?.incr('addToAudience', 1, statsTag)
}

return processPayload(request, audienceSettings, payload, 'add')
return processPayload(request, audienceSettings, payload, 'add', features || {})
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,13 @@ const action: ActionDefinition<Settings, Payload> = {
}
}
},
perform: async (request, { settings, payload, statsContext }) => {
perform: async (request, { settings, payload, statsContext, features }) => {
statsContext?.statsClient?.incr('addUserLegacy', 1, statsContext?.tags)
return processPayload(request, settings, [payload], 'add')
return processPayload(request, settings, [payload], 'add', features || {})
},
performBatch: async (request, { settings, payload, statsContext }) => {
performBatch: async (request, { settings, payload, statsContext, features }) => {
statsContext?.statsClient?.incr('addUserLegacy', 1, statsContext?.tags)
return processPayload(request, settings, payload, 'add')
return processPayload(request, settings, payload, 'add', features || {})
}
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import { IntegrationError, RequestClient, PayloadValidationError, ModifiedResponse } from '@segment/actions-core'
import { createHash } from 'crypto'
import {
IntegrationError,
RequestClient,
PayloadValidationError,
ModifiedResponse,
Features
} from '@segment/actions-core'
import { TikTokAudiences } from './api'
import { Payload as AddUserPayload } from './addUser/generated-types'
import { Payload as AddToAudiencePayload } from './addToAudience/generated-types'
Expand All @@ -8,6 +13,7 @@ import { Payload as CreateAudiencePayload } from './createAudience/generated-typ
import { Settings } from './generated-types'
import { CreateAudienceAPIResponse } from './types'
import { AudienceSettings } from './generated-types'
import { processHashing } from '../../lib/hashing-utils'

type LegacyPayload = AddUserPayload | RemoveUserPayload
type GenericPayload = LegacyPayload | AddToAudiencePayload
Expand All @@ -17,7 +23,8 @@ export async function processPayload(
request: RequestClient,
settings: GenericSettings,
payloads: GenericPayload[],
action: string
action: string,
features: Features
) {
validate(payloads)
let selected_advertiser_id
Expand All @@ -42,7 +49,7 @@ export async function processPayload(
const id_schema = getIDSchema(payloads[0])
const TikTokApiClient: TikTokAudiences = new TikTokAudiences(request, selected_advertiser_id)

const users = extractUsers(payloads)
const users = extractUsers(payloads, features)

let res
if (users.length > 0) {
Expand Down Expand Up @@ -101,7 +108,11 @@ export function getIDSchema(payload: GenericPayload): string[] {

const isHashedInformation = (information: string): boolean => new RegExp(/[0-9abcdef]{64}/gi).test(information)

export function extractUsers(payloads: GenericPayload[]): {}[][] {
const hash = (value: string, features: Features): string => {
return processHashing(value, 'sha256', 'hex', features, 'actions-tiktok-audiences')
}

export function extractUsers(payloads: GenericPayload[], features: Features): {}[][] {
const batch_data: {}[][] = []

payloads.forEach((payload: GenericPayload) => {
Expand Down Expand Up @@ -132,7 +143,7 @@ export function extractUsers(payloads: GenericPayload[]): {}[][] {
// If email is already hashed, don't hash it again
let hashedEmail = payload.email
if (!isHashedInformation(payload.email)) {
hashedEmail = createHash('sha256').update(payload.email).digest('hex')
hashedEmail = hash(payload.email, features)
}

email_id = {
Expand All @@ -149,7 +160,7 @@ export function extractUsers(payloads: GenericPayload[]): {}[][] {
// If phone is already hashed, don't hash it again
let hashedPhone = payload.phone
if (!isHashedInformation(payload.phone)) {
hashedPhone = createHash('sha256').update(payload.phone).digest('hex')
hashedPhone = hash(payload.phone, features)
}

phone_id = {
Expand All @@ -164,7 +175,7 @@ export function extractUsers(payloads: GenericPayload[]): {}[][] {
let advertising_id = {}
if (payload.advertising_id) {
advertising_id = {
id: createHash('sha256').update(payload.advertising_id).digest('hex'),
id: hash(payload.advertising_id, features),
audience_ids: [external_audience_id]
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const action: ActionDefinition<Settings, Payload, AudienceSettings> = {
enable_batching: { ...enable_batching },
external_audience_id: { ...external_audience_id }
},
perform: async (request, { audienceSettings, payload, statsContext }) => {
perform: async (request, { audienceSettings, payload, statsContext, features }) => {
const statsClient = statsContext?.statsClient
const statsTag = statsContext?.tags

Expand All @@ -39,9 +39,9 @@ const action: ActionDefinition<Settings, Payload, AudienceSettings> = {
}

statsClient?.incr('removeFromAudience', 1, statsTag)
return processPayload(request, audienceSettings, [payload], 'delete')
return processPayload(request, audienceSettings, [payload], 'delete', features || {})
},
performBatch: async (request, { audienceSettings, payload, statsContext }) => {
performBatch: async (request, { audienceSettings, payload, statsContext, features }) => {
const statsClient = statsContext?.statsClient
const statsTag = statsContext?.tags

Expand All @@ -50,7 +50,7 @@ const action: ActionDefinition<Settings, Payload, AudienceSettings> = {
}

statsClient?.incr('removeFromAudience', 1, statsTag)
return processPayload(request, audienceSettings, payload, 'delete')
return processPayload(request, audienceSettings, payload, 'delete', features || {})
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,13 +77,13 @@ const action: ActionDefinition<Settings, Payload> = {
}
}
},
perform: async (request, { settings, payload, statsContext }) => {
perform: async (request, { settings, payload, statsContext, features }) => {
statsContext?.statsClient?.incr('removeUserLegacy', 1, statsContext?.tags)
return processPayload(request, settings, [payload], 'delete')
return processPayload(request, settings, [payload], 'delete', features || {})
},
performBatch: async (request, { settings, payload, statsContext }) => {
performBatch: async (request, { settings, payload, statsContext, features }) => {
statsContext?.statsClient?.incr('removeUserLegacy', 1, statsContext?.tags)
return processPayload(request, settings, payload, 'delete')
return processPayload(request, settings, payload, 'delete', features || {})
}
}

Expand Down
Loading