👌 add documentation

DataDog · Jan 5, 2022 · 1d5db83 · 1d5db83
1 parent 167d3a8
commit 1d5db83
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/packages/core/src/domain/session/sessionCookieStore.ts b/packages/core/src/domain/session/sessionCookieStore.ts
@@ -79,6 +79,8 @@ export function withCookieLockAccess(operations: Operations, numberOfRetries = 0
       processedSession = currentSession
     }
   }
+  // call after even if session is not persisted in order to perform operations on
+  // up to date cookie value, the value could have been modified by another tab
   operations.after?.(processedSession || currentSession)
   next()
 }

diff --git a/packages/core/src/domain/session/sessionStore.ts b/packages/core/src/domain/session/sessionStore.ts
@@ -67,6 +67,11 @@ export function startSessionStore<TrackingType extends string>(
     })
   }
 
+  /**
+   * allows two behaviors:
+   * - if the session is active, synchronize the session cache without updating the session cookie
+   * - if the session is not active, clear the session cookie and expire the session cache
+   */
   function watchSession() {
     withCookieLockAccess({
       options,