feat: swap the default to identified_only

src/__tests__/personProcessing.test.ts

@@ -55,7 +55,7 @@ describe('person processing', () => {
  }
 
  describe('init', () => {
- it("should default to 'always' person_profiles", async () => {
+ it("should default to 'identified_only' person_profiles", async () => {
  // arrange
  const token = uuidv7()
 
@@ -65,7 +65,7 @@ describe('person processing', () => {
  })
 
  // assert
- expect(posthog.config.person_profiles).toEqual('always')
+ expect(posthog.config.person_profiles).toEqual('identified_only')
  })
  it('should read person_profiles from init config', async () => {
  // arrange

src/__tests__/posthog-core.ts

@@ -345,6 +345,20 @@ describe('posthog core', () => {
 
  expect(posthog.compression).toEqual('gzip-js')
  })
+ it('uses defaultIdentifiedOnly from decide response', () => {
+ const posthog = posthogWith({})
+
+ posthog._afterDecideResponse({ defaultIdentifiedOnly: true } as DecideResponse)
+ expect(posthog.config.person_profiles).toEqual('identified_only')
+
+ posthog._afterDecideResponse({ defaultIdentifiedOnly: false } as DecideResponse)
+ expect(posthog.config.person_profiles).toEqual('always')
+ })
+ it('defaultIdentifiedOnly does not override person_profiles if already set', () => {
+ const posthog = posthogWith({ person_profiles: 'always' })
+ posthog._afterDecideResponse({ defaultIdentifiedOnly: true } as DecideResponse)
+ expect(posthog.config.person_profiles).toEqual('always')
+ })
 
  it('enables compression from decide response when only one received', () => {
  const posthog = posthogWith({})
@@ -387,6 +401,7 @@ describe('posthog core', () => {
  properties: () => ({ distinct_id: 'abc', persistent: 'prop', $is_identified: false }),
  remove_event_timer: jest.fn(),
  get_property: () => 'anonymous',
+ props: { $groups: {} },
  } as unknown as PostHogPersistence,
  sessionPersistence: {
  properties: () => ({ distinct_id: 'abc', persistent: 'prop' }),
@@ -425,7 +440,7 @@ describe('posthog core', () => {
  $window_id: 'windowId',
  $session_id: 'sessionId',
  $is_identified: false,
- $process_person_profile: true,
+ $process_person_profile: false,
  })
  })
 
@@ -447,7 +462,7 @@ describe('posthog core', () => {
  $session_id: 'sessionId',
  $lib_custom_api_host: 'https://custom.posthog.com',
  $is_identified: false,
- $process_person_profile: true,
+ $process_person_profile: false,
  })
  })
 
@@ -465,7 +480,7 @@ describe('posthog core', () => {
  posthog._calculate_event_properties('custom_event', { event: 'prop' }, new Date())[
  '$process_person_profile'
  ]
- ).toEqual(true)
+ ).toEqual(false)
  })
 
  it('only adds token and distinct_id if event_name is $snapshot', () => {
@@ -496,7 +511,7 @@ describe('posthog core', () => {
  expect(posthog._calculate_event_properties('custom_event', { event: 'prop' }, new Date())).toEqual({
  event_name: 'custom_event',
  token: 'testtoken',
- $process_person_profile: true,
+ $process_person_profile: false,
  })
  })
 

src/posthog-core.ts

@@ -179,7 +179,7 @@ export const defaultConfig = (): PostHogConfig => ({
  bootstrap: {},
  disable_compression: false,
  session_idle_timeout_seconds: 30 * 60, // 30 minutes
- person_profiles: 'always',
+ person_profiles: 'identified_only',
  __add_tracing_headers: false,
 })
 
@@ -272,6 +272,7 @@ export class PostHog {
  decideEndpointWasHit: boolean
  analyticsDefaultEndpoint: string
  version = Config.LIB_VERSION
+ _initialPersonProfilesConfig: 'always' | 'never' | 'identified_only' | null
 
  SentryIntegration: typeof SentryIntegration
  sentryIntegration: (options?: SentryIntegrationOptions) => ReturnType<typeof sentryIntegration>
@@ -294,6 +295,7 @@ export class PostHog {
  this.__loaded = false
  this.analyticsDefaultEndpoint = '/e/'
  this._initialPageviewCaptured = false
+ this._initialPersonProfilesConfig = null
 
  this.featureFlags = new PostHogFeatureFlags(this)
  this.toolbar = new Toolbar(this)
@@ -390,6 +392,10 @@ export class PostHog {
  this.config = {} as PostHogConfig // will be set right below
  this._triggered_notifs = []
 
+ if (config.person_profiles) {
+ this._initialPersonProfilesConfig = config.person_profiles
+ }
+
  this.set_config(
  extend({}, defaultConfig(), configRenames(config), {
  name: name,
@@ -408,6 +414,8 @@ export class PostHog {
  this.config.persistence === 'sessionStorage'
  ? this.persistence
  : new PostHogPersistence({ ...this.config, persistence: 'sessionStorage' })
+
+ // should I store the initial person profiles config in persistence?
  const initialPersistenceProps = { ...this.persistence.props }
  const initialSessionProps = { ...this.sessionPersistence.props }
 
@@ -538,6 +546,12 @@ export class PostHog {
  this.analyticsDefaultEndpoint = response.analytics.endpoint
  }
 
+ this.config.person_profiles = this._initialPersonProfilesConfig
+ ? this._initialPersonProfilesConfig
+ : response['defaultIdentifiedOnly']
+ ? 'identified_only'
+ : 'always'
+
  this.sessionRecording?.afterDecideResponse(response)
  this.autocapture?.afterDecideResponse(response)
  this.heatmaps?.afterDecideResponse(response)

src/types.ts

@@ -398,6 +398,7 @@ export interface DecideResponse {
  isAuthenticated: boolean
  siteApps: { id: number; url: string }[]
  heatmaps?: boolean
+ defaultIdentifiedOnly?: boolean
 }
 
 export type FeatureFlagsCallback = (