feat: allow sampling based on decide response

src/__tests__/posthog-persistence.js → src/__tests__/posthog-persistence.test.ts

@@ -1,55 +1,66 @@
+/// <reference lib="dom" />
 import { PostHogPersistence } from '../posthog-persistence'
 import { SESSION_ID, USER_STATE } from '../constants'
-
-given('lib', () => new PostHogPersistence({ name: 'bla', persistence: 'cookie' }))
+import { PostHogConfig } from '../types'
+import Mock = jest.Mock
 
 let referrer = '' // No referrer by default
 Object.defineProperty(document, 'referrer', { get: () => referrer })
 
+function makePostHogConfig(name: string, persistenceMode: string): PostHogConfig {
+    return <PostHogConfig>{
+        name,
+        persistence: persistenceMode as 'cookie' | 'localStorage' | 'localStorage+cookie' | 'memory' | 'sessionStorage',
+    }
+}
+
 describe('persistence', () => {
+    let library: PostHogPersistence
+
     afterEach(() => {
-        given.lib.clear()
+        library.clear()
         document.cookie = ''
         referrer = ''
     })
 
     describe.each([`cookie`, `localStorage`, `localStorage+cookie`])('persistence modes: %p', (persistenceMode) => {
         // Common tests for all storage modes
         beforeEach(() => {
-            given('lib', () => new PostHogPersistence({ name: 'test', persistence: persistenceMode }))
-            given.lib.clear()
+            library = new PostHogPersistence(makePostHogConfig('test', persistenceMode))
+            library.clear()
         })
 
         it('should register_once', () => {
-            given.lib.register_once({ distinct_id: 'hi', test_prop: 'test_val' })
+            library.register_once({ distinct_id: 'hi', test_prop: 'test_val' }, undefined, undefined)
 
-            let lib2 = new PostHogPersistence({ name: 'test', persistence: persistenceMode })
+            const lib2 = new PostHogPersistence(makePostHogConfig('test', persistenceMode))
             expect(lib2.props).toEqual({ distinct_id: 'hi', test_prop: 'test_val' })
         })
 
         it('should save user state', () => {
-            let lib = new PostHogPersistence({ name: 'bla', persistence: 'cookie' })
+            const lib = new PostHogPersistence(makePostHogConfig('bla', persistenceMode))
             lib.set_user_state('identified')
             expect(lib.props[USER_STATE]).toEqual('identified')
         })
 
         it('can load user state', () => {
-            let lib = new PostHogPersistence({ name: 'bla', persistence: 'cookie' })
+            const lib = new PostHogPersistence(makePostHogConfig('bla', persistenceMode))
             lib.set_user_state('identified')
             expect(lib.get_user_state()).toEqual('identified')
         })
 
         it('has user state as a reserved property key', () => {
-            let lib = new PostHogPersistence({ name: 'bla', persistence: 'cookie' })
+            const lib = new PostHogPersistence(makePostHogConfig('bla', persistenceMode))
             lib.register({ distinct_id: 'testy', test_prop: 'test_value' })
             lib.set_user_state('identified')
             expect(lib.properties()).toEqual({ distinct_id: 'testy', test_prop: 'test_value' })
         })
 
         it(`should only call save if props changes`, () => {
-            let lib = new PostHogPersistence({ name: 'test', persistence: 'localStorage+cookie' })
+            const lib = new PostHogPersistence(makePostHogConfig('test', 'localStorage+cookie'))
             lib.register({ distinct_id: 'hi', test_prop: 'test_val' })
-            lib.save = jest.fn()
+            const saveMock: Mock = jest.fn()
+            lib.save = saveMock
 
             lib.register({ distinct_id: 'hi', test_prop: 'test_val' })
             lib.register({})
@@ -58,41 +69,41 @@ describe('persistence', () => {
 
             lib.register({ distinct_id: 'hi2' })
             expect(lib.save).toHaveBeenCalledTimes(1)
-            lib.save.mockClear()
+            saveMock.mockClear()
 
             lib.register({ new_key: '1234' })
             expect(lib.save).toHaveBeenCalledTimes(1)
-            lib.save.mockClear()
+            saveMock.mockClear()
         })
 
         it('should set direct referrer', () => {
             referrer = ''
-            given.lib.update_referrer_info()
+            library.update_referrer_info()
 
-            expect(given.lib.props['$referring_domain']).toBe('$direct')
-            expect(given.lib.props['$referrer']).toBe('$direct')
+            expect(library.props['$referring_domain']).toBe('$direct')
+            expect(library.props['$referrer']).toBe('$direct')
         })
 
         it('should set external referrer', () => {
             referrer = 'https://www.google.com'
-            given.lib.update_referrer_info()
+            library.update_referrer_info()
 
-            expect(given.lib.props['$referring_domain']).toBe('www.google.com')
-            expect(given.lib.props['$referrer']).toBe('https://www.google.com')
+            expect(library.props['$referring_domain']).toBe('www.google.com')
+            expect(library.props['$referrer']).toBe('https://www.google.com')
         })
 
         it('should set internal referrer', () => {
             referrer = 'https://hedgebox.net/files/abc.png'
-            given.lib.update_referrer_info()
+            library.update_referrer_info()
 
-            expect(given.lib.props['$referring_domain']).toBe('hedgebox.net')
-            expect(given.lib.props['$referrer']).toBe('https://hedgebox.net/files/abc.png')
+            expect(library.props['$referring_domain']).toBe('hedgebox.net')
+            expect(library.props['$referrer']).toBe('https://hedgebox.net/files/abc.png')
         })
 
         it('extracts enabled feature flags', () => {
-            given.lib.register({ $enabled_feature_flags: { flag: 'variant', other: true } })
-            expect(given.lib.props['$enabled_feature_flags']).toEqual({ flag: 'variant', other: true })
-            expect(given.lib.properties()).toEqual({
+            library.register({ $enabled_feature_flags: { flag: 'variant', other: true } })
+            expect(library.props['$enabled_feature_flags']).toEqual({ flag: 'variant', other: true })
+            expect(library.properties()).toEqual({
                 '$feature/flag': 'variant',
                 '$feature/other': true,
             })
@@ -101,27 +112,27 @@ describe('persistence', () => {
 
     describe('localStorage+cookie', () => {
         it('should migrate data from cookies to localStorage', () => {
-            let lib = new PostHogPersistence({ name: 'bla', persistence: 'cookie' })
-            lib.register_once({ distinct_id: 'testy', test_prop: 'test_value' })
+            const lib = new PostHogPersistence(makePostHogConfig('bla', 'cookie'))
+            lib.register_once({ distinct_id: 'testy', test_prop: 'test_value' }, undefined, undefined)
             expect(document.cookie).toContain(
                 'ph__posthog=%7B%22distinct_id%22%3A%22testy%22%2C%22test_prop%22%3A%22test_value%22%7D'
             )
-            let lib2 = new PostHogPersistence({ name: 'bla', persistence: 'localStorage+cookie' })
+            const lib2 = new PostHogPersistence(makePostHogConfig('bla', 'localStorage+cookie'))
             expect(document.cookie).toContain('ph__posthog=%7B%22distinct_id%22%3A%22testy%22%7D')
             lib2.register({ test_prop2: 'test_val', distinct_id: 'test2' })
             expect(document.cookie).toContain('ph__posthog=%7B%22distinct_id%22%3A%22test2%22%7D')
             expect(lib2.props).toEqual({ distinct_id: 'test2', test_prop: 'test_value', test_prop2: 'test_val' })
-            lib2.remove('ph__posthog')
+            lib2.remove()
             expect(localStorage.getItem('ph__posthog')).toEqual(null)
             expect(document.cookie).toEqual('')
         })
 
         it(`should additionally store certain values in cookies if localStorage+cookie`, () => {
             expect(document.cookie).toEqual('')
 
-            const encode = (props) => encodeURIComponent(JSON.stringify(props))
+            const encode = (props: any) => encodeURIComponent(JSON.stringify(props))
 
-            let lib = new PostHogPersistence({ name: 'test', persistence: 'localStorage+cookie' })
+            const lib = new PostHogPersistence(makePostHogConfig('test', 'localStorage+cookie'))
             lib.register({ distinct_id: 'test', test_prop: 'test_val' })
             expect(document.cookie).toContain(
                 `ph__posthog=${encode({
@@ -147,7 +158,7 @@ describe('persistence', () => {
             // Clear localstorage to simulate being on a different domain
             localStorage.clear()
 
-            const newLib = new PostHogPersistence({ name: 'test', persistence: 'localStorage+cookie' })
+            const newLib = new PostHogPersistence(makePostHogConfig('test', 'localStorage+cookie'))
 
             expect(newLib.props).toEqual({
                 distinct_id: 'test',

src/constants.ts

@@ -14,7 +14,9 @@ export const AUTOCAPTURE_DISABLED_SERVER_SIDE = '$autocapture_disabled_server_si
 export const SESSION_RECORDING_ENABLED_SERVER_SIDE = '$session_recording_enabled_server_side'
 export const CONSOLE_LOG_RECORDING_ENABLED_SERVER_SIDE = '$console_log_recording_enabled_server_side'
 export const SESSION_RECORDING_RECORDER_VERSION_SERVER_SIDE = '$session_recording_recorder_version_server_side' // follows rrweb versioning
+export const SESSION_RECORDING_SAMPLE_RATE = '$session_recording_sample_rate'
 export const SESSION_ID = '$sesid'
+export const SESSION_RECORDING_IS_SAMPLED = '$session_is_sampled'
 export const ENABLED_FEATURE_FLAGS = '$enabled_feature_flags'
 export const PERSISTENCE_EARLY_ACCESS_FEATURES = '$early_access_features'
 export const STORED_PERSON_PROPERTIES_KEY = '$stored_person_properties'

src/extensions/exceptions/exception-autocapture.ts

@@ -105,11 +105,6 @@ export class ExceptionObserver {
         if (this.isEnabled()) {
             this.startCapturing()
             this.debugLog('Remote config for exception autocapture is enabled, starting', autocaptureExceptionsResponse)
-        } else {
-            this.debugLog(
-                'Remote config for exception autocapture is disabled, not starting',
-                autocaptureExceptionsResponse
-            )
         }
     }