@statsig/session-replay 3.16.2 → 3.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statsig/session-replay",
-  "version": "3.16.2",
+  "version": "3.17.0",
   "license": "ISC",
   "homepage": "https://github.com/statsig-io/js-client-monorepo",
   "repository": {
@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "rrweb": "2.0.0-alpha.14",
-    "@statsig/client-core": "3.16.2"
+    "@statsig/client-core": "3.17.0"
   },
   "devDependencies": {
     "@rrweb/types": "2.0.0-alpha.14"

package/src/SessionReplay.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SessionReplay = exports.runStatsigSessionReplay = exports.StatsigSessionReplayPlugin = void 0;
 const client_core_1 = require("@statsig/client-core");
 const SessionReplayBase_1 = require("./SessionReplayBase");
+const SessionReplayUtils_1 = require("./SessionReplayUtils");
 class StatsigSessionReplayPlugin {
     constructor(options) {
         this.options = options;
@@ -34,7 +35,14 @@ class SessionReplay extends SessionReplayBase_1.SessionReplayBase {
     }
     _attemptToStartRecording(force = false) {
         var _a, _b;
+        if (this._totalLogs >= SessionReplayUtils_1.MAX_LOGS) {
+            return;
+        }
         const values = this._client.getContext().values;
+        if ((values === null || values === void 0 ? void 0 : values.recording_blocked) === true) {
+            this._shutdown();
+            return;
+        }
         if (!force && (values === null || values === void 0 ? void 0 : values.can_record_session) !== true) {
             this._shutdown();
             return;

package/src/SessionReplayBase.d.ts

@@ -15,6 +15,7 @@ export declare abstract class SessionReplayBase {
     protected _replayer: SessionReplayClient;
     protected _wasStopped: boolean;
     protected _currentEventIndex: number;
+    protected _totalLogs: number;
     constructor(client: PrecomputedEvaluationsInterface, options?: SessionReplayOptions);
     forceStartRecording(): void;
     stopRecording(): void;

package/src/SessionReplayBase.js

@@ -15,6 +15,7 @@ class SessionReplayBase {
         this._events = [];
         this._wasStopped = false;
         this._currentEventIndex = 0;
+        this._totalLogs = 0;
         this._client = client;
         this._options = options;
         const { sdkKey, errorBoundary } = this._client.getContext();
@@ -87,6 +88,7 @@ class SessionReplayBase {
             if (endReason) {
                 event.metadata[endReason] = 'true';
             }
+            this._totalLogs++;
             this._client.logEvent(event);
             if (slicedID != null) {
                 this._client.flush().catch((e) => {
@@ -95,6 +97,9 @@ class SessionReplayBase {
             }
         }
         this._events = [];
+        if (this._totalLogs > SessionReplayUtils_1.MAX_LOGS) {
+            this._shutdown();
+        }
     }
     _bumpSessionIdleTimerAndLogRecording() {
         this._getSessionIdFromClient();
@@ -104,8 +109,10 @@ class SessionReplayBase {
         return this._client.getContext().session.data.sessionID;
     }
     _shutdownImpl(endReason) {
-        this._replayer.stop();
-        client_core_1.StatsigMetadataProvider.add({ isRecordingSession: 'false' });
+        if (this._replayer.isRecording()) {
+            this._replayer.stop();
+            client_core_1.StatsigMetadataProvider.add({ isRecordingSession: 'false' });
+        }
         if (this._events.length === 0) {
             // only reset if session expired otherwise we might start recording again
             if (endReason === 'session_expired') {
@@ -134,6 +141,10 @@ class SessionReplayBase {
             this._shutdown('session_expired');
             return;
         }
+        if (this._totalLogs >= SessionReplayUtils_1.MAX_LOGS) {
+            this._shutdown();
+            return;
+        }
         event.eventIndex = this._currentEventIndex++;
         // Update the session data
         this._sessionData.clickCount += data.clickCount;

package/src/SessionReplayUtils.d.ts

@@ -16,6 +16,7 @@ export type RRWebPayload = {
 };
 export declare const REPLAY_ENQUEUE_TRIGGER_BYTES: number;
 export declare const MAX_INDIVIDUAL_EVENT_BYTES: number;
+export declare const MAX_LOGS = 10000;
 export declare function _makeLoggableRrwebEvent(slice: string, payload: string, sessionID: string, data: ReplaySessionData): StatsigEvent & {
     metadata: RRWebPayload;
 };

package/src/SessionReplayUtils.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._appendSlicedMetadata = exports._slicePayload = exports._makeLoggableRrwebEvent = exports.MAX_INDIVIDUAL_EVENT_BYTES = exports.REPLAY_ENQUEUE_TRIGGER_BYTES = void 0;
+exports._appendSlicedMetadata = exports._slicePayload = exports._makeLoggableRrwebEvent = exports.MAX_LOGS = exports.MAX_INDIVIDUAL_EVENT_BYTES = exports.REPLAY_ENQUEUE_TRIGGER_BYTES = void 0;
 const client_core_1 = require("@statsig/client-core");
 const REPLAY_SLICE_BYTES = 1024 * 1024; // 1 MB
 exports.REPLAY_ENQUEUE_TRIGGER_BYTES = 1024 * 10; // 10 KB
 exports.MAX_INDIVIDUAL_EVENT_BYTES = 1024 * 1024 * 10; // 10 MB
+exports.MAX_LOGS = 10000; // 10K logs
 function _makeLoggableRrwebEvent(slice, payload, sessionID, data) {
     const metadata = {
         session_start_ts: String(data.startTime),

package/src/TriggeredSessionReplay.d.ts

@@ -23,6 +23,12 @@ export declare class TriggeredSessionReplay extends SessionReplayBase {
     private _runningEventData;
     private _isActiveRecording;
     constructor(client: PrecomputedEvaluationsInterface, options?: TriggeredSessionReplayOptions);
+    private _subscribeToClientEvents;
+    private _subscribeToValuesUpdated;
+    private _subscribeToLogEventCalled;
+    private _subscribeToGateEvaluation;
+    private _subscribeToExperimentEvaluation;
+    private _tryStartExposureRecording;
     startRecording(): void;
     forceStartRecording(): void;
     stopRecording(): void;

package/src/TriggeredSessionReplay.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TriggeredSessionReplay = exports.stopRecording = exports.forceStartRecording = exports.startRecording = exports.runStatsigSessionReplay = exports.StatsigTriggeredSessionReplayPlugin = void 0;
 const client_core_1 = require("@statsig/client-core");
 const SessionReplayBase_1 = require("./SessionReplayBase");
+const SessionReplayUtils_1 = require("./SessionReplayUtils");
 class StatsigTriggeredSessionReplayPlugin {
     constructor(options) {
         this.options = options;
@@ -47,6 +48,21 @@ class TriggeredSessionReplay extends SessionReplayBase_1.SessionReplayBase {
         super(client, options);
         this._runningEventData = [];
         this._isActiveRecording = false;
+        this._subscribeToClientEvents(options);
+        if (options === null || options === void 0 ? void 0 : options.autoStartRecording) {
+            this._attemptToStartRecording((_a = this._options) === null || _a === void 0 ? void 0 : _a.forceRecording);
+        }
+        else if (options === null || options === void 0 ? void 0 : options.keepRollingWindow) {
+            this._attemptToStartRollingWindow();
+        }
+    }
+    _subscribeToClientEvents(options) {
+        this._subscribeToValuesUpdated(options);
+        this._subscribeToLogEventCalled();
+        this._subscribeToGateEvaluation();
+        this._subscribeToExperimentEvaluation();
+    }
+    _subscribeToValuesUpdated(options) {
         this._client.$on('values_updated', () => {
             var _a;
             if (!this._wasStopped) {
@@ -58,6 +74,8 @@ class TriggeredSessionReplay extends SessionReplayBase_1.SessionReplayBase {
                 }
             }
         });
+    }
+    _subscribeToLogEventCalled() {
         this._client.$on('log_event_called', (event) => {
             var _a;
             if (this._wasStopped) {
@@ -73,6 +91,9 @@ class TriggeredSessionReplay extends SessionReplayBase_1.SessionReplayBase {
             if (trigger == null) {
                 return;
             }
+            if (trigger.passes_sampling === false) {
+                return;
+            }
             const targetValues = trigger.values;
             if (targetValues == null) {
                 this._attemptToStartRecording(true);
@@ -83,36 +104,44 @@ class TriggeredSessionReplay extends SessionReplayBase_1.SessionReplayBase {
                 return;
             }
         });
+    }
+    _subscribeToGateEvaluation() {
         this._client.$on('gate_evaluation', (event) => {
-            var _a, _b;
-            if (this._wasStopped) {
-                return;
-            }
-            const values = this._client.getContext().values;
-            const passedTargeting = values === null || values === void 0 ? void 0 : values.passes_session_recording_targeting;
-            if (passedTargeting === false ||
-                (values === null || values === void 0 ? void 0 : values.session_recording_exposure_triggers) == null) {
-                return;
-            }
-            const trigger = (_a = values.session_recording_exposure_triggers[event.gate.name]) !== null && _a !== void 0 ? _a : values.session_recording_exposure_triggers[(0, client_core_1._DJB2)(event.gate.name)];
-            if (trigger == null) {
-                return;
-            }
-            const targetValues = trigger.values;
-            if (targetValues == null) {
-                this._attemptToStartRecording(true);
-                return;
-            }
-            if (targetValues.includes(String((_b = event.gate.value) !== null && _b !== void 0 ? _b : false))) {
-                this._attemptToStartRecording(true);
-                return;
-            }
+            this._tryStartExposureRecording(event.gate.name, String(event.gate.value));
         });
-        if (options === null || options === void 0 ? void 0 : options.autoStartRecording) {
-            this._attemptToStartRecording((_a = this._options) === null || _a === void 0 ? void 0 : _a.forceRecording);
+    }
+    _subscribeToExperimentEvaluation() {
+        this._client.$on('experiment_evaluation', (event) => {
+            var _a;
+            this._tryStartExposureRecording(event.experiment.name, (_a = event.experiment.groupName) !== null && _a !== void 0 ? _a : '');
+        });
+    }
+    _tryStartExposureRecording(name, value) {
+        var _a;
+        if (this._wasStopped) {
+            return;
         }
-        else if (options === null || options === void 0 ? void 0 : options.keepRollingWindow) {
-            this._attemptToStartRollingWindow();
+        const values = this._client.getContext().values;
+        const passedTargeting = values === null || values === void 0 ? void 0 : values.passes_session_recording_targeting;
+        if (passedTargeting === false ||
+            (values === null || values === void 0 ? void 0 : values.session_recording_exposure_triggers) == null) {
+            return;
+        }
+        const trigger = (_a = values.session_recording_exposure_triggers[name]) !== null && _a !== void 0 ? _a : values.session_recording_exposure_triggers[(0, client_core_1._DJB2)(name)];
+        if (trigger == null) {
+            return;
+        }
+        if (trigger.passes_sampling === false) {
+            return;
+        }
+        const targetValues = trigger.values;
+        if (targetValues == null) {
+            this._attemptToStartRecording(true);
+            return;
+        }
+        if (targetValues.includes(value)) {
+            this._attemptToStartRecording(true);
+            return;
         }
     }
     startRecording() {
@@ -200,7 +229,14 @@ class TriggeredSessionReplay extends SessionReplayBase_1.SessionReplayBase {
     }
     _attemptToStartRecording(force = false) {
         var _a, _b;
+        if (this._totalLogs >= SessionReplayUtils_1.MAX_LOGS) {
+            return;
+        }
         const values = this._client.getContext().values;
+        if ((values === null || values === void 0 ? void 0 : values.recording_blocked) === true) {
+            this._shutdown();
+            return;
+        }
         if (!force && (values === null || values === void 0 ? void 0 : values.can_record_session) !== true) {
             this._shutdown();
             return;