feat(session replay): adding timeout into config

amplitude · Sep 24, 2024 · fd67792 · fd67792
1 parent ecde7f2
commit fd67792
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 5 deletions.
diff --git a/packages/plugin-session-replay-browser/src/typings/session-replay.ts b/packages/plugin-session-replay-browser/src/typings/session-replay.ts
@@ -12,6 +12,7 @@ export interface SessionReplayPrivacyConfig {
 
 export interface SessionReplayPerformanceConfig {
   enabled: boolean;
+  timeout?: number;
 }
 
 export interface SessionReplayOptions {

diff --git a/packages/session-replay-browser/src/config/types.ts b/packages/session-replay-browser/src/config/types.ts
@@ -75,6 +75,7 @@ export interface SessionReplayVersion {
 
 export interface SessionReplayPerformanceConfig {
   enabled: boolean;
+  timeout?: number;
 }
 
 export type SessionReplayType = 'standalone' | 'plugin' | 'segment';
diff --git a/packages/session-replay-browser/src/events/event-compressor.ts b/packages/session-replay-browser/src/events/event-compressor.ts
@@ -9,13 +9,15 @@ interface TaskQueue {
   sessionId: number;
 }
 
+const DEFAULT_TIMEOUT = 2000;
 export class EventCompressor {
   taskQueue: TaskQueue[] = [];
   isProcessing = false;
   eventsManager?: SessionReplayEventsManager<'replay' | 'interaction', string>;
   config: SessionReplayJoinedConfig;
   deviceId: string | undefined;
   canUseIdleCallback: boolean | undefined;
+  timeout: number;
 
   constructor(
     eventsManager: SessionReplayEventsManager<'replay' | 'interaction', string>,
@@ -27,6 +29,7 @@ export class EventCompressor {
     this.eventsManager = eventsManager;
     this.config = config;
     this.deviceId = deviceId;
+    this.timeout = config.performanceConfig?.timeout || DEFAULT_TIMEOUT;
   }
 
   // Schedule processing during idle time
@@ -37,7 +40,7 @@ export class EventCompressor {
         (idleDeadline) => {
           this.processQueue(idleDeadline);
         },
-        { timeout: 2000 },
+        { timeout: this.timeout },
       );
     }
   }
@@ -69,20 +72,20 @@ export class EventCompressor {
         (idleDeadline) => {
           this.processQueue(idleDeadline);
         },
-        { timeout: 2000 },
+        { timeout: this.timeout },
       );
     } else {
       this.isProcessing = false;
     }
   }
 
-  compressEvents = (event: eventWithTime) => {
+  compressEvent = (event: eventWithTime) => {
     const packedEvent = pack(event);
     return JSON.stringify(packedEvent);
   };
 
   public addCompressedEvent = (event: eventWithTime, sessionId: number) => {
-    const compressedEvent = this.compressEvents(event);
+    const compressedEvent = this.compressEvent(event);
 
     if (this.eventsManager && this.deviceId) {
       this.eventsManager.addEvent({

diff --git a/packages/session-replay-browser/src/session-replay.ts b/packages/session-replay-browser/src/session-replay.ts
@@ -315,7 +315,6 @@ export class SessionReplay implements AmplitudeSessionReplay {
   recordEvents() {
     const shouldRecord = this.getShouldRecord();
     const sessionId = this.identifiers?.sessionId;
-    // const canDelayCompression = globalScope && 'requestIdleCallback' in globalScope;
     if (!shouldRecord || !sessionId || !this.config) {
       return;
     }

diff --git a/packages/session-replay-browser/test/event-compressor.test.ts b/packages/session-replay-browser/test/event-compressor.test.ts
@@ -39,6 +39,7 @@ describe('EventCompressor', () => {
     sampleRate: 1,
     performanceConfig: {
       enabled: true,
+      timeout: 2000,
     },
   });