mirror of
https://github.com/hanzoai/insights.git
synced 2026-10-30 16:15:31 +00:00
zeekay
bc4ddf332b
Mechanically re-derived: bin/debrand runs over a fresh import of posthog/posthog@fa1a9a60d4 (2026-08-06). The pipeline (.hanzo/workflows), the Dockerfiles and bin/docker* entrypoints, compose files, LLM.md and the squashed initial migration are restored from the shipped tree, same as the previous import. The prune's import-closure guard kept 21 products the new core now imports; dropping them is a refactor now, recorded rather than forced.
184 lines
8.1 KiB
TypeScript
184 lines
8.1 KiB
TypeScript
import { personInitialAndUTMProperties } from '~/common/utils/db/utils'
|
|
|
|
describe('personInitialAndUTMProperties()', () => {
|
|
it('adds initial and utm properties', () => {
|
|
const properties = {
|
|
distinct_id: 2,
|
|
$browser: 'Chrome',
|
|
$current_url: 'https://test.com',
|
|
$os: 'Mac OS X',
|
|
$os_version: '10.15.7',
|
|
$browser_version: '95',
|
|
$referring_domain: 'https://google.com',
|
|
$referrer: 'https://google.com/?q=insights',
|
|
utm_medium: 'twitter',
|
|
gclid: 'GOOGLE ADS ID',
|
|
msclkid: 'BING ADS ID',
|
|
$elements: [
|
|
{ tag_name: 'a', nth_child: 1, nth_of_type: 2, attr__class: 'btn btn-sm' },
|
|
{ tag_name: 'div', nth_child: 1, nth_of_type: 2, $el_text: '💻' },
|
|
],
|
|
$app_build: 2,
|
|
$app_name: 'my app',
|
|
$app_namespace: 'com.insights.myapp',
|
|
$app_version: '1.2.3',
|
|
$set: { $browser_version: 'manually $set value wins' },
|
|
$set_once: { $initial_os_version: 'manually $set_once value wins' },
|
|
}
|
|
expect(personInitialAndUTMProperties(properties)).toMatchInlineSnapshot(
|
|
`
|
|
{
|
|
"$app_build": 2,
|
|
"$app_name": "my app",
|
|
"$app_namespace": "com.insights.myapp",
|
|
"$app_version": "1.2.3",
|
|
"$browser": "Chrome",
|
|
"$browser_version": "95",
|
|
"$current_url": "https://test.com",
|
|
"$elements": [
|
|
{
|
|
"attr__class": "btn btn-sm",
|
|
"nth_child": 1,
|
|
"nth_of_type": 2,
|
|
"tag_name": "a",
|
|
},
|
|
{
|
|
"$el_text": "💻",
|
|
"nth_child": 1,
|
|
"nth_of_type": 2,
|
|
"tag_name": "div",
|
|
},
|
|
],
|
|
"$os": "Mac OS X",
|
|
"$os_version": "10.15.7",
|
|
"$referrer": "https://google.com/?q=insights",
|
|
"$referring_domain": "https://google.com",
|
|
"$set": {
|
|
"$app_build": 2,
|
|
"$app_name": "my app",
|
|
"$app_namespace": "com.insights.myapp",
|
|
"$app_version": "1.2.3",
|
|
"$browser": "Chrome",
|
|
"$browser_version": "manually $set value wins",
|
|
"$current_url": "https://test.com",
|
|
"$os": "Mac OS X",
|
|
"$os_version": "10.15.7",
|
|
"$referrer": "https://google.com/?q=insights",
|
|
"$referring_domain": "https://google.com",
|
|
"gclid": "GOOGLE ADS ID",
|
|
"msclkid": "BING ADS ID",
|
|
"utm_medium": "twitter",
|
|
},
|
|
"$set_once": {
|
|
"$initial_app_build": 2,
|
|
"$initial_app_name": "my app",
|
|
"$initial_app_namespace": "com.insights.myapp",
|
|
"$initial_app_version": "1.2.3",
|
|
"$initial_browser": "Chrome",
|
|
"$initial_browser_version": "95",
|
|
"$initial_current_url": "https://test.com",
|
|
"$initial_gclid": "GOOGLE ADS ID",
|
|
"$initial_msclkid": "BING ADS ID",
|
|
"$initial_os": "Mac OS X",
|
|
"$initial_os_version": "manually $set_once value wins",
|
|
"$initial_referrer": "https://google.com/?q=insights",
|
|
"$initial_referring_domain": "https://google.com",
|
|
"$initial_utm_medium": "twitter",
|
|
},
|
|
"distinct_id": 2,
|
|
"gclid": "GOOGLE ADS ID",
|
|
"msclkid": "BING ADS ID",
|
|
"utm_medium": "twitter",
|
|
}
|
|
`
|
|
)
|
|
})
|
|
it('initial current domain regression test', () => {
|
|
const properties = { $current_url: 'https://test.com' }
|
|
expect(personInitialAndUTMProperties(properties)).toEqual({
|
|
$current_url: 'https://test.com',
|
|
$set_once: { $initial_current_url: 'https://test.com' },
|
|
$set: { $current_url: 'https://test.com' },
|
|
})
|
|
})
|
|
it('treats $os_name as fallback for $os', () => {
|
|
const propertiesOsNameOnly = { $os_name: 'Android' }
|
|
expect(personInitialAndUTMProperties(propertiesOsNameOnly)).toEqual({
|
|
$os: 'Android',
|
|
$os_name: 'Android',
|
|
$set_once: { $initial_os: 'Android' },
|
|
$set: { $os: 'Android' },
|
|
})
|
|
// Test that $os takes precedence, with $os_name preserved (although this should not happen in the wild)
|
|
const propertiesBothOsKeys = { $os: 'Windows', $os_name: 'Android' }
|
|
expect(personInitialAndUTMProperties(propertiesBothOsKeys)).toEqual({
|
|
$os: 'Windows',
|
|
$os_name: 'Android',
|
|
$set_once: { $initial_os: 'Windows' },
|
|
$set: { $os: 'Windows' },
|
|
})
|
|
})
|
|
it('does not lift device context from an $is_server event, but keeps campaign params', () => {
|
|
// A server SDK (is_server: true) stamps its host $os; it must not reach $set/$set_once or
|
|
// it permanently poisons $initial_os. utm is real attribution and still flows through.
|
|
const properties = {
|
|
$is_server: true,
|
|
$os: 'Linux',
|
|
$os_version: '5.15.0',
|
|
utm_source: 'newsletter',
|
|
}
|
|
expect(personInitialAndUTMProperties(properties)).toEqual({
|
|
$is_server: true,
|
|
$os: 'Linux',
|
|
$os_version: '5.15.0',
|
|
utm_source: 'newsletter',
|
|
$set: { utm_source: 'newsletter' },
|
|
$set_once: { $initial_utm_source: 'newsletter' },
|
|
})
|
|
})
|
|
it('does not let a server $os_name alias into $initial_os', () => {
|
|
const result = personInitialAndUTMProperties({ $is_server: true, $os_name: 'Linux' })
|
|
expect((result.$set_once as Record<string, any> | undefined)?.$initial_os).toBeUndefined()
|
|
})
|
|
// Browser SDKs send every absent campaign param as an explicit null whenever at least one is
|
|
// present. $set_once only applies while the person property is missing, so a null there would
|
|
// permanently block the real first-touch value. $set intentionally keeps the nulls (last-touch).
|
|
it.each([
|
|
[
|
|
'null campaign params stay in $set but never claim $set_once',
|
|
{ utm_source: 'google', gclid: null },
|
|
{ utm_source: 'google', gclid: null },
|
|
{ $initial_utm_source: 'google' },
|
|
],
|
|
[
|
|
'all-null campaign params leave $set_once empty',
|
|
{ gclid: null, msclkid: null },
|
|
{ gclid: null, msclkid: null },
|
|
{},
|
|
],
|
|
['a null $os_name does not claim $initial_os', { $os_name: null }, { $os: null }, {}],
|
|
])('never writes null first-touch values: %s', (_desc, input, expectedSet, expectedSetOnce) => {
|
|
const result = personInitialAndUTMProperties({ ...input })
|
|
expect(result.$set).toEqual(expectedSet)
|
|
expect(result.$set_once).toEqual(expectedSetOnce)
|
|
})
|
|
|
|
it.each([
|
|
['client event maps $os', { $lib: 'web', $os: 'Linux' }, 'Linux'],
|
|
['client mobile via $os_name', { $lib: 'insights-ios', $os_name: 'iOS' }, 'iOS'],
|
|
['no $is_server is treated as client', { $os: 'Linux' }, 'Linux'],
|
|
['$is_server false is treated as client', { $os: 'Linux', $is_server: false }, 'Linux'],
|
|
['$is_server true skips $os', { $os: 'Linux', $is_server: true }, undefined],
|
|
['$is_server true skips regardless of lib', { $lib: 'web', $os: 'Linux', $is_server: true }, undefined],
|
|
])('maps $os to $initial_os unless $is_server is true: %s', (_desc, properties, expected) => {
|
|
const result = personInitialAndUTMProperties({ ...properties })
|
|
const setOnce = result.$set_once as Record<string, any> | undefined
|
|
const set = result.$set as Record<string, any> | undefined
|
|
expect(setOnce?.$initial_os).toBe(expected)
|
|
if (expected === undefined) {
|
|
// host $os must not reach current $set either, not just $set_once
|
|
expect(set?.$os).toBeUndefined()
|
|
}
|
|
})
|
|
})
|