♻️ Async session manager #4131

chatgpt-codex-connector · 2026-01-29T12:38:51Z

Subscribe to consent changes before async init

The consent change handler is registered only inside the expandOrRenewSession callback. If the session store is locked (e.g., Chromium cookie locking) and that callback is delayed, a trackingConsentState.update(NOT_GRANTED) during that window will be missed, so sessionStore.expire(false) never runs and the session can stay active despite revoked consent. This is a regression from the previous synchronous subscription and can leak data in the lock-wait scenario.

Useful? React with 👍 / 👎.

-Original file line number
+Diff line change
@@ Expand Up / @@ -73,6 +73,8 @@ scripts/ # Build, deploy, release automation @@
     - Spec files co-located with implementation: `feature.ts` → `feature.spec.ts`
     - Use `registerCleanupTask()` for cleanup, NOT `afterEach()`
     - Test framework: Jasmine + Karma
+    - Prefer `collectAsyncCalls(spy, n)` over `waitFor(() => spy.calls.count() > 0)` for waiting on spy calls
+    - Don't destructure methods from `spy.calls` (e.g., `argsFor`, `mostRecent`) - use `calls.argsFor()` to avoid `@typescript-eslint/unbound-method` errors
     ## Commit Messages
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -21,6 +21,7 @@ import { toSessionState } from './sessionState' @@
     import { retrieveSessionCookie } from './storeStrategies/sessionInCookie'
     import { SESSION_STORE_KEY } from './storeStrategies/sessionStoreStrategy'
     import { retrieveSessionFromLocalStorage } from './storeStrategies/sessionInLocalStorage'
+    import { resetSessionStoreOperations } from './sessionStoreOperations'
     export interface SessionManager<TrackingType extends string> {
       findSession: (
@@ Expand Down Expand Up @@
       configuration: Configuration,
       productKey: string,
       computeTrackingType: (rawTrackingType?: string) => TrackingType,
-      trackingConsentState: TrackingConsentState
-    ): SessionManager<TrackingType> {
+      trackingConsentState: TrackingConsentState,
+      onReady: (sessionManager: SessionManager<TrackingType>) => void
+    ) {
       const renewObservable = new Observable<void>()
       const expireObservable = new Observable<void>()
@@ Expand All @@
       })
       stopCallbacks.push(() => sessionContextHistory.stop())
-      sessionStore.renewObservable.subscribe(() => {
-        sessionContextHistory.add(buildSessionContext(), relativeNow())
-        renewObservable.notify()
-      })
-      sessionStore.expireObservable.subscribe(() => {
-        expireObservable.notify()
-        sessionContextHistory.closeActive(relativeNow())
-      })
-      // We expand/renew session unconditionally as tracking consent is always granted when the session
-      // manager is started.
-      sessionStore.expandOrRenewSession()
-      sessionContextHistory.add(buildSessionContext(), clocksOrigin().relative)
-      if (isExperimentalFeatureEnabled(ExperimentalFeature.SHORT_SESSION_INVESTIGATION)) {
-        const session = sessionStore.getSession()
-        if (session) {
-          detectSessionIdChange(configuration, session)
+      // Tracking consent is always granted when the session manager is started, but it may be revoked
+      // during the async initialization (e.g., while waiting for cookie lock). We check
+      // consent status in the callback to handle this case.
+      sessionStore.expandOrRenewSession(() => {
+        const hasConsent = trackingConsentState.isGranted()
+        if (!hasConsent) {
+          sessionStore.expire(hasConsent)
+          return
         }
-      }
-      trackingConsentState.observable.subscribe(() => {
-        if (trackingConsentState.isGranted()) {
-          sessionStore.expandOrRenewSession()
-        } else {
-          sessionStore.expire(false)
+        sessionStore.renewObservable.subscribe(() => {
+          sessionContextHistory.add(buildSessionContext(), relativeNow())
+          renewObservable.notify()
+        })
+        sessionStore.expireObservable.subscribe(() => {
+          expireObservable.notify()
+          sessionContextHistory.closeActive(relativeNow())
+        })
+        sessionContextHistory.add(buildSessionContext(), clocksOrigin().relative)
+        if (isExperimentalFeatureEnabled(ExperimentalFeature.SHORT_SESSION_INVESTIGATION)) {
+          const session = sessionStore.getSession()
+          if (session) {
+            detectSessionIdChange(configuration, session)
+          }
         }
-      })
-      trackActivity(configuration, () => {
-        if (trackingConsentState.isGranted()) {
-          sessionStore.expandOrRenewSession()
-        }
+        trackingConsentState.observable.subscribe(() => {
+          if (trackingConsentState.isGranted()) {
+            sessionStore.expandOrRenewSession()
+          } else {
+            sessionStore.expire(false)
+          }
+        })
+        trackActivity(configuration, () => {
+          if (trackingConsentState.isGranted()) {
+            sessionStore.expandOrRenewSession()
+          }
+        })
+        trackVisibility(configuration, () => sessionStore.expandSession())
+        trackResume(configuration, () => sessionStore.restartSession())
+        onReady({
+          findSession: (startTime, options) => sessionContextHistory.find(startTime, options),
+          renewObservable,
+          expireObservable,
+          sessionStateUpdateObservable: sessionStore.sessionStateUpdateObservable,
+          expire: sessionStore.expire,
+          updateSessionState: sessionStore.updateSessionState,
+        })
       })
-      trackVisibility(configuration, () => sessionStore.expandSession())
-      trackResume(configuration, () => sessionStore.restartSession())
       function buildSessionContext() {
         const session = sessionStore.getSession()
@@ Expand All @@
           anonymousId: session.anonymousId,
         }
       }
-      return {
-        findSession: (startTime, options) => sessionContextHistory.find(startTime, options),
-        renewObservable,
-        expireObservable,
-        sessionStateUpdateObservable: sessionStore.sessionStateUpdateObservable,
-        expire: sessionStore.expire,
-        updateSessionState: sessionStore.updateSessionState,
-      }
     }
     export function stopSessionManager() {
       stopCallbacks.forEach((e) => e())
       stopCallbacks = []
+      resetSessionStoreOperations()
     }
     function trackActivity(configuration: Configuration, expandOrRenewSession: () => void) {
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -11,6 +11,7 @@ import { @@
       SessionPersistence,
     } from './sessionConstants'
     import type { SessionState } from './sessionState'
+    import { LOCK_RETRY_DELAY, createLock } from './sessionStoreOperations'
     const enum FakeTrackingType {
       TRACKED = 'tracked',
@@ Expand Down Expand Up / @@ -413,6 +414,51 @@ describe('session store', () => { @@
             expect(sessionStoreManager.getSession().id).toBeUndefined()
             expect(renewSpy).not.toHaveBeenCalled()
           })
+          it('should execute callback after session expansion', () => {
+            setupSessionStore(createSessionState(FakeTrackingType.TRACKED, FIRST_ID))
+            const callbackSpy = jasmine.createSpy('callback')
+            sessionStoreManager.expandOrRenewSession(callbackSpy)
+            expect(callbackSpy).toHaveBeenCalledTimes(1)
+          })
+          it('should execute callback after lock is released', () => {
+            const sessionStoreStrategyType = selectSessionStoreStrategyType(DEFAULT_INIT_CONFIGURATION)
+            if (sessionStoreStrategyType?.type !== SessionPersistence.COOKIE) {
+              fail('Unable to initialize cookie storage')
+              return
+            }
+            // Create a locked session state
+            const lockedSession: SessionState = {
+              ...createSessionState(FakeTrackingType.TRACKED, FIRST_ID),
+              lock: createLock(),
+            }
+            sessionStoreStrategy = createFakeSessionStoreStrategy({ isLockEnabled: true, initialSession: lockedSession })
+            sessionStoreManager = startSessionStore(
+              sessionStoreStrategyType,
+              DEFAULT_CONFIGURATION,
+              PRODUCT_KEY,
+              () => FakeTrackingType.TRACKED,
+              sessionStoreStrategy
+            )
+            const callbackSpy = jasmine.createSpy('callback')
+            sessionStoreManager.expandOrRenewSession(callbackSpy)
+            expect(callbackSpy).not.toHaveBeenCalled()
+            // Remove the lock from the session
+            sessionStoreStrategy.planRetrieveSession(0, createSessionState(FakeTrackingType.TRACKED, FIRST_ID))
+            clock.tick(LOCK_RETRY_DELAY)
+            expect(callbackSpy).toHaveBeenCalledTimes(1)
+          })
         })
         describe('expand session', () => {
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up @@
     import { SESSION_NOT_TRACKED, SessionPersistence } from './sessionConstants'
     export interface SessionStore {
-      expandOrRenewSession: () => void
+      expandOrRenewSession: (callback?: () => void) => void
       expandSession: () => void
       getSession: () => SessionState
       restartSession: () => void
@@ Expand Down Expand Up @@
       const watchSessionTimeoutId = setInterval(watchSession, STORAGE_POLL_DELAY)
       let sessionCache: SessionState
-      startSession()
-      const { throttled: throttledExpandOrRenewSession, cancel: cancelExpandOrRenewSession } = throttle(() => {
-        processSessionStoreOperations(
-          {
-            process: (sessionState) => {
-              if (isSessionInNotStartedState(sessionState)) {
-                return
-              }
-              const synchronizedSession = synchronizeSession(sessionState)
-              expandOrRenewSessionState(synchronizedSession)
-              return synchronizedSession
-            },
-            after: (sessionState) => {
-              if (isSessionStarted(sessionState) && !hasSessionInCache()) {
-                renewSessionInCache(sessionState)
-              }
-              sessionCache = sessionState
+      const { throttled: throttledExpandOrRenewSession, cancel: cancelExpandOrRenewSession } = throttle(
+        (callback?: () => void) => {
+          processSessionStoreOperations(
+            {
+              process: (sessionState) => {
+                if (isSessionInNotStartedState(sessionState)) {
+                  return
+                }
+                const synchronizedSession = synchronizeSession(sessionState)
+                expandOrRenewSessionState(synchronizedSession)
+                return synchronizedSession
+              },
+              after: (sessionState) => {
+                if (isSessionStarted(sessionState) && !hasSessionInCache()) {
+                  renewSessionInCache(sessionState)
+                }
+                sessionCache = sessionState
+                callback?.()
+              },
             },
-          },
-          sessionStoreStrategy
-        )
-      }, STORAGE_POLL_DELAY)
+            sessionStoreStrategy
+          )
+        },
+        STORAGE_POLL_DELAY
+      )
+      startSession()
       function expandSession() {
         processSessionStoreOperations(
@@ Expand Down Expand Up @@
         return sessionState
       }
-      function startSession() {
+      function startSession(callback?: () => void) {
         processSessionStoreOperations(
           {
             process: (sessionState) => {
@@ Expand All @@
             },
             after: (sessionState) => {
               sessionCache = sessionState
+              callback?.()
             },
           },
           sessionStoreStrategy
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -19,9 +19,14 @@ export const LOCK_MAX_TRIES = 100 @@
     export const LOCK_EXPIRATION_DELAY = ONE_SECOND
     const LOCK_SEPARATOR = '--'
-    const bufferedOperations: Operations[] = []
+    let bufferedOperations: Operations[] = []
     let ongoingOperations: Operations | undefined
+    export function resetSessionStoreOperations() {
+      bufferedOperations = []
+      ongoingOperations = undefined
+    }
     export function processSessionStoreOperations(
       operations: Operations,
       sessionStoreStrategy: SessionStoreStrategy,
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

♻️ Async session manager #4131

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

chatgpt-codex-connector bot Jan 29, 2026

Uh oh!

Uh oh!

-Original file line number
+Diff line change
@@ Expand Up / @@ -41,4 +41,22 @@ describe('createTrackingConsentState', () => { @@
         trackingConsentState.tryToInit(TrackingConsent.NOT_GRANTED)
         expect(trackingConsentState.isGranted()).toBeTrue()
       })
+      describe('onGrantedOnce', () => {
+        it('calls onGrantedOnce when consent was already granted', () => {
+          const trackingConsentState = createTrackingConsentState(TrackingConsent.GRANTED)
+          const spy = jasmine.createSpy()
+          trackingConsentState.onGrantedOnce(spy)
+          expect(spy).toHaveBeenCalledTimes(1)
+        })
+        it('calls onGrantedOnce when consent is granted', () => {
+          const trackingConsentState = createTrackingConsentState()
+          const spy = jasmine.createSpy()
+          trackingConsentState.onGrantedOnce(spy)
+          expect(spy).toHaveBeenCalledTimes(0)
+          trackingConsentState.update(TrackingConsent.GRANTED)
+          expect(spy).toHaveBeenCalledTimes(1)
+        })
+      })
     })

-Original file line number
+Diff line change
@@ Expand Up / @@ -11,24 +11,39 @@ export interface TrackingConsentState { @@
       update: (trackingConsent: TrackingConsent) => void
       isGranted: () => boolean
       observable: Observable<void>
+      onGrantedOnce: (callback: () => void) => void
     }
     export function createTrackingConsentState(currentConsent?: TrackingConsent): TrackingConsentState {
       const observable = new Observable<void>()
+      function isGranted() {
+        return currentConsent === TrackingConsent.GRANTED
+      }
       return {
         tryToInit(trackingConsent: TrackingConsent) {
           if (!currentConsent) {
             currentConsent = trackingConsent
           }
         },
+        onGrantedOnce(fn) {
+          if (isGranted()) {
+            fn()
+          } else {
+            const subscription = observable.subscribe(() => {
+              if (isGranted()) {
+                fn()
+                subscription.unsubscribe()
+              }
+            })
+          }
+        },
         update(trackingConsent: TrackingConsent) {
           currentConsent = trackingConsent
           observable.notify()
         },
-        isGranted() {
-          return currentConsent === TrackingConsent.GRANTED
-        },
+        isGranted,
         observable,
       }
     }

♻️ Async session manager #4131

Are you sure you want to change the base?

Uh oh!

♻️ Async session manager #4131

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

chatgpt-codex-connector bot Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!