make args better

PostHog · Jan 16, 2025 · 5ac2ec1 · 5ac2ec1
1 parent 8483166
commit 5ac2ec1
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 15 deletions.
diff --git a/src/__tests__/utils/event-utils.test.ts b/src/__tests__/utils/event-utils.test.ts
@@ -8,7 +8,7 @@ import { detectBrowser } from '../../utils/user-agent-utils'
 describe(`event-utils`, () => {
     describe('properties', () => {
         it('should have $host and $pathname in properties', () => {
-            const properties = Info.properties()
+            const properties = Info.properties(false, [])
             expect(properties['$current_url']).toBeDefined()
             expect(properties['$host']).toBeDefined()
             expect(properties['$pathname']).toBeDefined()
@@ -19,7 +19,7 @@ describe(`event-utils`, () => {
             // eslint-disable-next-line @typescript-eslint/ban-ts-comment
             // @ts-ignore
             globals['userAgent'] = 'blah'
-            const properties = Info.properties()
+            const properties = Info.properties(false, [])
             expect(properties['$raw_user_agent']).toBe('blah')
         })
 
@@ -32,6 +32,23 @@ describe(`event-utils`, () => {
             expect(properties['$raw_user_agent'].length).toBe(1000)
             expect(properties['$raw_user_agent'].substring(995)).toBe('aa...')
         })
+
+        it('should mask out personal data from URL', () => {
+            // @ts-expect-error ok to set global in test
+            globals.location = { href: 'https://www.example.com/path?gclid=12345&other=true' }
+            const properties = Info.properties({ maskPersonalDataProperties: true })
+            expect(properties['$current_url']).toEqual('https://www.example.com/path?gclid=<masked>&other=true')
+        })
+
+        it('should mask out custom personal data', () => {
+            // @ts-expect-error ok to set global in test
+            globals.location = { href: 'https://www.example.com/path?gclid=12345&other=true' }
+            const properties = Info.properties({
+                maskPersonalDataProperties: true,
+                customPersonalDataProperties: ['other'],
+            })
+            expect(properties['$current_url']).toEqual('https://www.example.com/path?gclid=<masked>&other=<masked>')
+        })
     })
 
     describe('user agent', () => {

diff --git a/src/customizations/setAllPersonProfilePropertiesAsPersonPropertiesForFlags.ts b/src/customizations/setAllPersonProfilePropertiesAsPersonPropertiesForFlags.ts
@@ -4,7 +4,19 @@ import { each, extend } from '../utils'
 import { includes } from '../utils/string-utils'
 
 export const setAllPersonProfilePropertiesAsPersonPropertiesForFlags = (posthog: PostHog): void => {
-    const allProperties = extend({}, Info.properties(), Info.campaignParams(), Info.referrerInfo())
+    const allProperties = extend(
+        {},
+        Info.properties({
+            maskPersonalDataProperties: posthog.config.mask_personal_data_properties,
+            customPersonalDataProperties: posthog.config.custom_personal_data_properties,
+        }),
+        Info.campaignParams({
+            customTrackedParams: posthog.config.custom_campaign_params,
+            maskPersonalDataProperties: posthog.config.mask_personal_data_properties,
+            customPersonalDataProperties: posthog.config.custom_personal_data_properties,
+        }),
+        Info.referrerInfo()
+    )
     const personProperties: Record<string, string> = {}
     each(allProperties, function (v, k: string) {
         if (includes(CAMPAIGN_PARAMS, k) || includes(EVENT_TO_PERSON_PROPERTIES, k)) {

diff --git a/src/posthog-core.ts b/src/posthog-core.ts
@@ -963,10 +963,10 @@ export class PostHog {
             return properties
         }
 
-        const infoProperties = Info.properties(
-            this.config.mask_personal_data_properties,
-            this.config.custom_personal_data_properties
-        )
+        const infoProperties = Info.properties({
+            maskPersonalDataProperties: this.config.mask_personal_data_properties,
+            customPersonalDataProperties: this.config.custom_personal_data_properties,
+        })
 
         if (this.sessionManager) {
             const { sessionId, windowId } = this.sessionManager.checkAndGetSessionAndWindowId()

diff --git a/src/utils/event-utils.ts b/src/utils/event-utils.ts
@@ -64,11 +64,15 @@ export const EVENT_TO_PERSON_PROPERTIES = [
 export const MASKED = '<masked>'
 
 export const Info = {
-    campaignParams: function (
-        customTrackedParams?: string[],
-        maskPersonalDataProperties?: boolean,
+    campaignParams: function ({
+        customTrackedParams,
+        maskPersonalDataProperties,
+        customPersonalDataProperties,
+    }: {
+        customTrackedParams?: string[]
+        maskPersonalDataProperties?: boolean
         customPersonalDataProperties?: string[] | undefined
-    ): Record<string, string> {
+    }): Record<string, string> {
         if (!document) {
             return {}
         }
@@ -244,10 +248,13 @@ export const Info = {
         }
     },
 
-    properties: function (
-        maskPersonalDataProperties: boolean,
-        customPersonalDataProperties: string[] | undefined
-    ): Properties {
+    properties: function ({
+        maskPersonalDataProperties,
+        customPersonalDataProperties,
+    }: {
+        maskPersonalDataProperties?: boolean
+        customPersonalDataProperties?: string[]
+    } = {}): Properties {
         if (!userAgent) {
             return {}
         }