fix(session-replay-browser): support disabling batching for interaction events (#853)

Author: lewgordon-amplitude

packages/session-replay-browser/src/config/types.ts

@@ -8,6 +8,7 @@ export interface SamplingConfig {
 export interface InteractionConfig {
   trackEveryNms?: number;
   enabled: boolean; // defaults to false
+  batch: boolean; // defaults to false
 }
 
 export type SessionReplayRemoteConfig = {

packages/session-replay-browser/src/session-replay.ts

@@ -105,13 +105,14 @@ export class SessionReplay implements AmplitudeSessionReplay {
     managers.push({ name: 'replay', manager: rrwebEventManager });
 
     if (this.config.interactionConfig?.enabled) {
+      const payloadBatcher = this.config.interactionConfig.batch ? clickBatcher : undefined;
       const interactionEventManager = await createEventsManager<'interaction'>({
         config: this.config,
         sessionId: this.identifiers.sessionId,
         type: 'interaction',
         minInterval: this.config.interactionConfig.trackEveryNms ?? INTERACTION_MIN_INTERVAL,
         maxInterval: INTERACTION_MAX_INTERVAL,
-        payloadBatcher: clickBatcher,
+        payloadBatcher,
       });
       managers.push({ name: 'interaction', manager: interactionEventManager });
     }

packages/session-replay-browser/test/session-replay.test.ts

@@ -201,6 +201,7 @@ describe('SessionReplay', () => {
         },
         async (config: SessionReplayJoinedConfig) => {
           expect(config.interactionConfig?.enabled).toBe(true);
+          expect(config.interactionConfig?.batch).toBeUndefined();
           expect(config.interactionConfig?.trackEveryNms).toBe(500);
         },
       ],
@@ -210,6 +211,7 @@ describe('SessionReplay', () => {
         },
         async (config: SessionReplayJoinedConfig) => {
           expect(config.interactionConfig?.enabled).toBe(true);
+          expect(config.interactionConfig?.batch).toBeUndefined();
           expect(config.interactionConfig?.trackEveryNms).toBeUndefined();
         },
       ],
@@ -220,13 +222,37 @@ describe('SessionReplay', () => {
         },
         async (config: SessionReplayJoinedConfig) => {
           expect(config.interactionConfig?.enabled).toBe(false);
+          expect(config.interactionConfig?.batch).toBeUndefined();
           expect(config.interactionConfig?.trackEveryNms).toBe(1_000);
         },
       ],
       [
         undefined,
         async (config: SessionReplayJoinedConfig) => {
           expect(config.interactionConfig?.enabled).toBeUndefined();
+          expect(config.interactionConfig?.batch).toBeUndefined();
+          expect(config.interactionConfig?.trackEveryNms).toBeUndefined();
+        },
+      ],
+      [
+        {
+          enabled: true,
+          batch: true,
+        },
+        async (config: SessionReplayJoinedConfig) => {
+          expect(config.interactionConfig?.enabled).toBe(true);
+          expect(config.interactionConfig?.batch).toBe(true);
+          expect(config.interactionConfig?.trackEveryNms).toBeUndefined();
+        },
+      ],
+      [
+        {
+          enabled: true,
+          batch: false,
+        },
+        async (config: SessionReplayJoinedConfig) => {
+          expect(config.interactionConfig?.enabled).toBe(true);
+          expect(config.interactionConfig?.batch).toBe(false);
           expect(config.interactionConfig?.trackEveryNms).toBeUndefined();
         },
       ],