-
Notifications
You must be signed in to change notification settings - Fork 143
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add person processing mode preview (#1109)
* Add process_person init config option * Add $process_person property * Default true * Add init test * Use new common method _isIdentified * Ensure that $process_person is not denylisted * Test fixes * Add tests for $process_person * Send initial referrer and campaign params with personful events * Tidy up tests * Fix mocks * Fix tests * Fix tests * Rename to __preview_process_person * Ensure default behaviour is identical to current behaviour * Help the minifier * Simplify test setup * Simplify test setup * Combine initial props functions * Simplify $set and $set_once handling * Fix functional tests * Fix overzealous test pruning
- Loading branch information
Showing
11 changed files
with
313 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| import { createPosthogInstance } from './helpers/posthog-instance' | ||
| import { uuidv7 } from '../uuidv7' | ||
| import { logger } from '../utils/logger' | ||
| jest.mock('../utils/logger') | ||
|
|
||
| describe('person processing', () => { | ||
| const distinctId = '123' | ||
|
|
||
| beforeEach(() => { | ||
| console.error = jest.fn() | ||
| }) | ||
|
|
||
| const setup = async (processPerson: 'always' | 'identified_only' | 'never' | undefined) => { | ||
| const token = uuidv7() | ||
| const onCapture = jest.fn() | ||
| const posthog = await createPosthogInstance(token, { | ||
| _onCapture: onCapture, | ||
| __preview_process_person: processPerson, | ||
| }) | ||
| return { token, onCapture, posthog } | ||
| } | ||
|
|
||
| describe('init', () => { | ||
| it("should default to 'always' process_person", async () => { | ||
| // arrange | ||
| const token = uuidv7() | ||
|
|
||
| // act | ||
| const posthog = await createPosthogInstance(token, { | ||
| __preview_process_person: undefined, | ||
| }) | ||
|
|
||
| // assert | ||
| expect(posthog.config.__preview_process_person).toEqual('always') | ||
| }) | ||
| it('should read process_person from init config', async () => { | ||
| // arrange | ||
| const token = uuidv7() | ||
|
|
||
| // act | ||
| const posthog = await createPosthogInstance(token, { | ||
| __preview_process_person: 'never', | ||
| }) | ||
|
|
||
| // assert | ||
| expect(posthog.config.__preview_process_person).toEqual('never') | ||
| }) | ||
| }) | ||
|
|
||
| describe('identify', () => { | ||
| it('should fail if process_person is set to never', async () => { | ||
| // arrange | ||
| const { posthog, onCapture } = await setup('never') | ||
|
|
||
| // act | ||
| posthog.identify(distinctId) | ||
|
|
||
| // assert | ||
| expect(jest.mocked(logger).error).toBeCalledTimes(1) | ||
| expect(jest.mocked(logger).error).toHaveBeenCalledWith( | ||
| 'posthog.identify was called, but the process_person configuration is set to "never". This call will be ignored.' | ||
| ) | ||
| expect(onCapture).toBeCalledTimes(0) | ||
| }) | ||
|
|
||
| it('should switch events to $person_process=true if process_person is identified_only', async () => { | ||
| // arrange | ||
| const { posthog, onCapture } = await setup('identified_only') | ||
|
|
||
| // act | ||
| posthog.capture('custom event before identify') | ||
| posthog.identify(distinctId) | ||
| posthog.capture('custom event after identify') | ||
| // assert | ||
| expect(jest.mocked(logger).error).toBeCalledTimes(0) | ||
| const eventBeforeIdentify = onCapture.mock.calls[0] | ||
| expect(eventBeforeIdentify[1].properties.$process_person).toEqual(false) | ||
| const identifyCall = onCapture.mock.calls[1] | ||
| expect(identifyCall[0]).toEqual('$identify') | ||
| expect(identifyCall[1].properties.$process_person).toEqual(true) | ||
| const eventAfterIdentify = onCapture.mock.calls[2] | ||
| expect(eventAfterIdentify[1].properties.$process_person).toEqual(true) | ||
| }) | ||
|
|
||
| it('should not change $person_process if process_person is always', async () => { | ||
| // arrange | ||
| const { posthog, onCapture } = await setup('always') | ||
|
|
||
| // act | ||
| posthog.capture('custom event before identify') | ||
| posthog.identify(distinctId) | ||
| posthog.capture('custom event after identify') | ||
| // assert | ||
| expect(jest.mocked(logger).error).toBeCalledTimes(0) | ||
| const eventBeforeIdentify = onCapture.mock.calls[0] | ||
| expect(eventBeforeIdentify[1].properties.$process_person).toEqual(true) | ||
| const identifyCall = onCapture.mock.calls[1] | ||
| expect(identifyCall[0]).toEqual('$identify') | ||
| expect(identifyCall[1].properties.$process_person).toEqual(true) | ||
| const eventAfterIdentify = onCapture.mock.calls[2] | ||
| expect(eventAfterIdentify[1].properties.$process_person).toEqual(true) | ||
| }) | ||
|
|
||
| it('should include initial referrer info in identify event if identified_only', async () => { | ||
| // arrange | ||
| const { posthog, onCapture } = await setup('identified_only') | ||
|
|
||
| // act | ||
| posthog.identify(distinctId) | ||
|
|
||
| // assert | ||
| const identifyCall = onCapture.mock.calls[0] | ||
| expect(identifyCall[0]).toEqual('$identify') | ||
| expect(identifyCall[1].$set_once).toEqual({ | ||
| $initial_referrer: '$direct', | ||
| $initial_referring_domain: '$direct', | ||
| }) | ||
| }) | ||
|
|
||
| it('should not include initial referrer info in identify event if always', async () => { | ||
| // arrange | ||
| const { posthog, onCapture } = await setup('always') | ||
|
|
||
| // act | ||
| posthog.identify(distinctId) | ||
|
|
||
| // assert | ||
| const identifyCall = onCapture.mock.calls[0] | ||
| expect(identifyCall[0]).toEqual('$identify') | ||
| expect(identifyCall[1].$set_once).toEqual({}) | ||
| }) | ||
| }) | ||
|
|
||
| describe('capture', () => { | ||
| it('should include initial referrer info iff the event has person processing when in identified_only mode', async () => { | ||
| // arrange | ||
| const { posthog, onCapture } = await setup('identified_only') | ||
|
|
||
| // act | ||
| posthog.capture('custom event before identify') | ||
| posthog.identify(distinctId) | ||
| posthog.capture('custom event after identify') | ||
|
|
||
| // assert | ||
| const eventBeforeIdentify = onCapture.mock.calls[0] | ||
| expect(eventBeforeIdentify[1].$set_once).toBeUndefined() | ||
| const eventAfterIdentify = onCapture.mock.calls[2] | ||
| expect(eventAfterIdentify[1].$set_once).toEqual({ | ||
| $initial_referrer: '$direct', | ||
| $initial_referring_domain: '$direct', | ||
| }) | ||
| }) | ||
|
|
||
| it('should not add initial referrer to set_once when in always mode', async () => { | ||
| // arrange | ||
| const { posthog, onCapture } = await setup('always') | ||
|
|
||
| // act | ||
| posthog.capture('custom event before identify') | ||
| posthog.identify(distinctId) | ||
| posthog.capture('custom event after identify') | ||
|
|
||
| // assert | ||
| const eventBeforeIdentify = onCapture.mock.calls[0] | ||
| expect(eventBeforeIdentify[1].$set_once).toEqual(undefined) | ||
| const eventAfterIdentify = onCapture.mock.calls[2] | ||
| expect(eventAfterIdentify[1].$set_once).toEqual(undefined) | ||
| }) | ||
| }) | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.