feat(analytics-remote-config): add string type to sessionId for custo…

…m session id
amplitude · Dec 6, 2024 · 45e131c · 45e131c
1 parent ec1f760
commit 45e131c
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 12 deletions.
diff --git a/packages/analytics-remote-config/src/remote-config.ts b/packages/analytics-remote-config/src/remote-config.ts
@@ -23,7 +23,7 @@ export class RemoteConfigFetch<RemoteConfig extends { [key: string]: object }>
   localConfig: Config;
   retryTimeout = 1000;
   attempts = 0;
-  lastFetchedSessionId: number | undefined;
+  lastFetchedSessionId: number | string | undefined;
   sessionTargetingMatch = false;
   configKeys: string[];
   metrics: RemoteConfigMetric = {};
@@ -36,7 +36,7 @@ export class RemoteConfigFetch<RemoteConfig extends { [key: string]: object }>
   getRemoteConfig = async <K extends keyof RemoteConfig>(
     configNamespace: string,
     key: K,
-    sessionId?: number,
+    sessionId?: number | string,
   ): Promise<RemoteConfig[K] | undefined> => {
     const fetchStartTime = Date.now();
     // Finally fetch via API
@@ -64,7 +64,7 @@ export class RemoteConfigFetch<RemoteConfig extends { [key: string]: object }>
     return REMOTE_CONFIG_SERVER_URL;
   }
 
-  fetchWithTimeout = async (sessionId?: number): Promise<RemoteConfigAPIResponse<RemoteConfig> | void> => {
+  fetchWithTimeout = async (sessionId?: number | string): Promise<RemoteConfigAPIResponse<RemoteConfig> | void> => {
     const controller = new AbortController();
     const timeoutId = setTimeout(() => controller.abort(), 5000);
     const remoteConfig = await this.fetchRemoteConfig(controller.signal, sessionId);
@@ -74,7 +74,7 @@ export class RemoteConfigFetch<RemoteConfig extends { [key: string]: object }>
 
   fetchRemoteConfig = async (
     signal: AbortController['signal'],
-    sessionId?: number,
+    sessionId?: number | string,
   ): Promise<RemoteConfigAPIResponse<RemoteConfig> | void> => {
     if (sessionId === this.lastFetchedSessionId && this.attempts >= this.localConfig.flushMaxRetries) {
       return this.completeRequest({ err: MAX_RETRIES_EXCEEDED_MESSAGE });
@@ -128,7 +128,7 @@ export class RemoteConfigFetch<RemoteConfig extends { [key: string]: object }>
 
   retryFetch = async (
     signal: AbortController['signal'],
-    sessionId?: number,
+    sessionId?: number | string,
   ): Promise<RemoteConfigAPIResponse<RemoteConfig> | void> => {
     await new Promise((resolve) => setTimeout(resolve, this.attempts * this.retryTimeout));
     return this.fetchRemoteConfig(signal, sessionId);

diff --git a/packages/analytics-remote-config/src/types.ts b/packages/analytics-remote-config/src/types.ts
@@ -10,7 +10,7 @@ export interface BaseRemoteConfigFetch<T> {
   getRemoteConfig: <K extends keyof T>(
     configNamespace: string,
     key: K,
-    sessionId?: number,
+    sessionId?: number | string,
   ) => Promise<T[K] | undefined>;
 }
 

diff --git a/packages/session-replay-browser/src/config/joined-config.ts b/packages/session-replay-browser/src/config/joined-config.ts
@@ -46,7 +46,7 @@ export class SessionReplayJoinedConfigGenerator {
     this.remoteConfigFetch = remoteConfigFetch;
   }
 
-  async generateJoinedConfig(_sessionId?: string | number): Promise<SessionReplayJoinedConfig> {
+  async generateJoinedConfig(sessionId?: string | number): Promise<SessionReplayJoinedConfig> {
     const config: SessionReplayJoinedConfig = { ...this.localConfig };
     // Special case here as optOut is implemented via getter/setter
     config.optOut = this.localConfig.optOut;
@@ -55,12 +55,24 @@ export class SessionReplayJoinedConfigGenerator {
     config.captureEnabled = true;
     let remoteConfig: SessionReplayRemoteConfig | undefined;
     try {
-      const samplingConfig = await this.remoteConfigFetch.getRemoteConfig('sessionReplay', 'sr_sampling_config');
+      const samplingConfig = await this.remoteConfigFetch.getRemoteConfig(
+        'sessionReplay',
+        'sr_sampling_config',
+        sessionId,
+      );
 
-      const privacyConfig = await this.remoteConfigFetch.getRemoteConfig('sessionReplay', 'sr_privacy_config');
+      const privacyConfig = await this.remoteConfigFetch.getRemoteConfig(
+        'sessionReplay',
+        'sr_privacy_config',
+        sessionId,
+      );
 
       // This is intentionally forced to only be set through the remote config.
-      config.interactionConfig = await this.remoteConfigFetch.getRemoteConfig('sessionReplay', 'sr_interaction_config');
+      config.interactionConfig = await this.remoteConfigFetch.getRemoteConfig(
+        'sessionReplay',
+        'sr_interaction_config',
+        sessionId,
+      );
 
       if (samplingConfig || privacyConfig) {
         remoteConfig = {};

diff --git a/packages/session-replay-browser/src/events/events-manager.ts b/packages/session-replay-browser/src/events/events-manager.ts
@@ -67,7 +67,6 @@ export const createEventsManager = async <Type extends EventType>({
     events: string[];
     sessionId: string | number;
     deviceId: string;
-    customSessionId?: string;
     sequenceId?: number;
   }) => {
     if (config.debugMode) {
@@ -138,7 +137,6 @@ export const createEventsManager = async <Type extends EventType>({
     event: { type: Type; data: string };
     sessionId: number;
     deviceId: string;
-    customSessionId: string | null;
   }) => {
     store
       .addEventToCurrentSequence(sessionId, event.data)