@statsig/session-replay 3.16.2 → 3.17.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statsig/session-replay",
-  "version": "3.16.2",
+  "version": "3.17.1",
   "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.1"
   },
   "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

@@ -5,6 +5,9 @@ type SessionReplayOptions = {
     forceRecording?: boolean;
 };
 export type EndReason = 'is_leaving_page' | 'session_expired';
+export declare function stopRecording(sdkKey?: string): void;
+export declare function startRecording(sdkKey?: string): void;
+export declare function forceStartRecording(sdkKey?: string): void;
 export declare abstract class SessionReplayBase {
     protected _sessionData: ReplaySessionData;
     protected _events: ReplayEvent[];
@@ -15,9 +18,11 @@ 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;
+    startRecording(): void;
     isRecording(): boolean;
     protected abstract _attemptToStartRecording(force?: boolean): void;
     protected _logRecording(endReason?: EndReason): void;

package/src/SessionReplayBase.js

@@ -1,10 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SessionReplayBase = void 0;
+exports.SessionReplayBase = exports.forceStartRecording = exports.startRecording = exports.stopRecording = void 0;
 const client_core_1 = require("@statsig/client-core");
 const SessionReplayClient_1 = require("./SessionReplayClient");
 const SessionReplayUtils_1 = require("./SessionReplayUtils");
 const SizeOf_1 = require("./SizeOf");
+function stopRecording(sdkKey) {
+    var _a;
+    (_a = _getInstanceFromSdkKey(sdkKey)) === null || _a === void 0 ? void 0 : _a.stopRecording();
+}
+exports.stopRecording = stopRecording;
+function startRecording(sdkKey) {
+    var _a;
+    (_a = _getInstanceFromSdkKey(sdkKey)) === null || _a === void 0 ? void 0 : _a.startRecording();
+}
+exports.startRecording = startRecording;
+function forceStartRecording(sdkKey) {
+    var _a;
+    (_a = _getInstanceFromSdkKey(sdkKey)) === null || _a === void 0 ? void 0 : _a.forceStartRecording();
+}
+exports.forceStartRecording = forceStartRecording;
+function _getInstanceFromSdkKey(sdkKey) {
+    var _a, _b;
+    const inst = sdkKey == null
+        ? (0, client_core_1._getStatsigGlobal)().firstSRInstance
+        : (_b = (_a = (0, client_core_1._getStatsigGlobal)()) === null || _a === void 0 ? void 0 : _a.srInstances) === null || _b === void 0 ? void 0 : _b[sdkKey];
+    return inst instanceof SessionReplayBase ? inst : null;
+}
 class SessionReplayBase {
     constructor(client, options) {
         this._sessionData = {
@@ -15,6 +37,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();
@@ -28,6 +51,9 @@ class SessionReplayBase {
         if (!(0, client_core_1._isServerEnv)()) {
             const statsigGlobal = (0, client_core_1._getStatsigGlobal)();
             statsigGlobal.srInstances = Object.assign(Object.assign({}, statsigGlobal.srInstances), { [sdkKey]: this });
+            if (!statsigGlobal.firstSRInstance) {
+                statsigGlobal.firstSRInstance = this;
+            }
         }
         this._currentSessionID = this._getSessionIdFromClient();
         this._subscribeToVisibilityChanged();
@@ -40,6 +66,11 @@ class SessionReplayBase {
         this._wasStopped = true;
         this._shutdown();
     }
+    startRecording() {
+        var _a;
+        this._wasStopped = false;
+        this._attemptToStartRecording((_a = this._options) === null || _a === void 0 ? void 0 : _a.forceRecording);
+    }
     isRecording() {
         return this._replayer.isRecording();
     }
@@ -87,6 +118,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 +127,9 @@ class SessionReplayBase {
             }
         }
         this._events = [];
+        if (this._totalLogs > SessionReplayUtils_1.MAX_LOGS) {
+            this._shutdown();
+        }
     }
     _bumpSessionIdleTimerAndLogRecording() {
         this._getSessionIdFromClient();
@@ -104,8 +139,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 +171,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

@@ -15,15 +15,17 @@ export declare class StatsigTriggeredSessionReplayPlugin implements StatsigPlugi
     constructor(options?: TriggeredSessionReplayOptions | undefined);
     bind(client: PrecomputedEvaluationsInterface): void;
 }
-export declare function runStatsigSessionReplay(client: PrecomputedEvaluationsInterface, options?: SessionReplayOptions): void;
-export declare function startRecording(sdkKey: string): void;
-export declare function forceStartRecording(sdkKey: string): void;
-export declare function stopRecording(sdkKey: string): void;
+export declare function runStatsigTriggeredSessionReplay(client: PrecomputedEvaluationsInterface, options?: SessionReplayOptions): void;
 export declare class TriggeredSessionReplay extends SessionReplayBase {
     private _runningEventData;
     private _isActiveRecording;
     constructor(client: PrecomputedEvaluationsInterface, options?: TriggeredSessionReplayOptions);
-    startRecording(): void;
+    private _subscribeToClientEvents;
+    private _subscribeToValuesUpdated;
+    private _subscribeToLogEventCalled;
+    private _subscribeToGateEvaluation;
+    private _subscribeToExperimentEvaluation;
+    private _tryStartExposureRecording;
     forceStartRecording(): void;
     stopRecording(): void;
     private _handleStartActiveRecording;

package/src/TriggeredSessionReplay.js

@@ -1,52 +1,44 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TriggeredSessionReplay = exports.stopRecording = exports.forceStartRecording = exports.startRecording = exports.runStatsigSessionReplay = exports.StatsigTriggeredSessionReplayPlugin = void 0;
+exports.TriggeredSessionReplay = exports.runStatsigTriggeredSessionReplay = 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;
         this.__plugin = 'triggered-session-replay';
     }
     bind(client) {
-        runStatsigSessionReplay(client, this.options);
+        runStatsigTriggeredSessionReplay(client, this.options);
     }
 }
 exports.StatsigTriggeredSessionReplayPlugin = StatsigTriggeredSessionReplayPlugin;
-function runStatsigSessionReplay(client, options) {
+function runStatsigTriggeredSessionReplay(client, options) {
     new TriggeredSessionReplay(client, options);
 }
-exports.runStatsigSessionReplay = runStatsigSessionReplay;
-function startRecording(sdkKey) {
-    var _a, _b;
-    const inst = (_b = (_a = (0, client_core_1._getStatsigGlobal)()) === null || _a === void 0 ? void 0 : _a.srInstances) === null || _b === void 0 ? void 0 : _b[sdkKey];
-    if (inst instanceof TriggeredSessionReplay) {
-        inst.startRecording();
-    }
-}
-exports.startRecording = startRecording;
-function forceStartRecording(sdkKey) {
-    var _a, _b;
-    const inst = (_b = (_a = (0, client_core_1._getStatsigGlobal)()) === null || _a === void 0 ? void 0 : _a.srInstances) === null || _b === void 0 ? void 0 : _b[sdkKey];
-    if (inst instanceof TriggeredSessionReplay) {
-        inst.forceStartRecording();
-    }
-}
-exports.forceStartRecording = forceStartRecording;
-function stopRecording(sdkKey) {
-    var _a, _b;
-    const inst = (_b = (_a = (0, client_core_1._getStatsigGlobal)()) === null || _a === void 0 ? void 0 : _a.srInstances) === null || _b === void 0 ? void 0 : _b[sdkKey];
-    if (inst instanceof TriggeredSessionReplay) {
-        inst.stopRecording();
-    }
-}
-exports.stopRecording = stopRecording;
+exports.runStatsigTriggeredSessionReplay = runStatsigTriggeredSessionReplay;
 class TriggeredSessionReplay extends SessionReplayBase_1.SessionReplayBase {
     constructor(client, options) {
         var _a;
         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 +50,8 @@ class TriggeredSessionReplay extends SessionReplayBase_1.SessionReplayBase {
                 }
             }
         });
+    }
+    _subscribeToLogEventCalled() {
         this._client.$on('log_event_called', (event) => {
             var _a;
             if (this._wasStopped) {
@@ -73,6 +67,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,42 +80,45 @@ 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));
+        });
+    }
+    _subscribeToExperimentEvaluation() {
+        this._client.$on('experiment_evaluation', (event) => {
+            var _a;
+            this._tryStartExposureRecording(event.experiment.name, (_a = event.experiment.groupName) !== null && _a !== void 0 ? _a : '');
         });
-        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();
-        }
     }
-    startRecording() {
+    _tryStartExposureRecording(name, value) {
         var _a;
-        this._wasStopped = false;
-        this._attemptToStartRecording((_a = this._options) === null || _a === void 0 ? void 0 : _a.forceRecording);
+        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[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;
+        }
     }
     forceStartRecording() {
         super.forceStartRecording();
@@ -200,7 +200,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;

package/src/index.d.ts

@@ -1,5 +1,6 @@
 import { SessionReplay, StatsigSessionReplayPlugin, runStatsigSessionReplay } from './SessionReplay';
+import { forceStartRecording, startRecording, stopRecording } from './SessionReplayBase';
 import { SessionReplayClient } from './SessionReplayClient';
-import { StatsigTriggeredSessionReplayPlugin, forceStartRecording, startRecording, stopRecording } from './TriggeredSessionReplay';
+import { StatsigTriggeredSessionReplayPlugin, runStatsigTriggeredSessionReplay } from './TriggeredSessionReplay';
 export type { ReplaySessionData as ReplayData, ReplayEvent, } from './SessionReplayClient';
-export { SessionReplayClient, SessionReplay, runStatsigSessionReplay, StatsigSessionReplayPlugin, StatsigTriggeredSessionReplayPlugin, startRecording, stopRecording, forceStartRecording, };
+export { SessionReplayClient, SessionReplay, runStatsigSessionReplay, runStatsigTriggeredSessionReplay, StatsigSessionReplayPlugin, StatsigTriggeredSessionReplayPlugin, startRecording, stopRecording, forceStartRecording, };

package/src/index.js

@@ -1,21 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.forceStartRecording = exports.stopRecording = exports.startRecording = exports.StatsigTriggeredSessionReplayPlugin = exports.StatsigSessionReplayPlugin = exports.runStatsigSessionReplay = exports.SessionReplay = exports.SessionReplayClient = void 0;
+exports.forceStartRecording = exports.stopRecording = exports.startRecording = exports.StatsigTriggeredSessionReplayPlugin = exports.StatsigSessionReplayPlugin = exports.runStatsigTriggeredSessionReplay = exports.runStatsigSessionReplay = exports.SessionReplay = exports.SessionReplayClient = void 0;
 const client_core_1 = require("@statsig/client-core");
 const SessionReplay_1 = require("./SessionReplay");
 Object.defineProperty(exports, "SessionReplay", { enumerable: true, get: function () { return SessionReplay_1.SessionReplay; } });
 Object.defineProperty(exports, "StatsigSessionReplayPlugin", { enumerable: true, get: function () { return SessionReplay_1.StatsigSessionReplayPlugin; } });
 Object.defineProperty(exports, "runStatsigSessionReplay", { enumerable: true, get: function () { return SessionReplay_1.runStatsigSessionReplay; } });
+const SessionReplayBase_1 = require("./SessionReplayBase");
+Object.defineProperty(exports, "forceStartRecording", { enumerable: true, get: function () { return SessionReplayBase_1.forceStartRecording; } });
+Object.defineProperty(exports, "startRecording", { enumerable: true, get: function () { return SessionReplayBase_1.startRecording; } });
+Object.defineProperty(exports, "stopRecording", { enumerable: true, get: function () { return SessionReplayBase_1.stopRecording; } });
 const SessionReplayClient_1 = require("./SessionReplayClient");
 Object.defineProperty(exports, "SessionReplayClient", { enumerable: true, get: function () { return SessionReplayClient_1.SessionReplayClient; } });
 const TriggeredSessionReplay_1 = require("./TriggeredSessionReplay");
 Object.defineProperty(exports, "StatsigTriggeredSessionReplayPlugin", { enumerable: true, get: function () { return TriggeredSessionReplay_1.StatsigTriggeredSessionReplayPlugin; } });
-Object.defineProperty(exports, "forceStartRecording", { enumerable: true, get: function () { return TriggeredSessionReplay_1.forceStartRecording; } });
-Object.defineProperty(exports, "startRecording", { enumerable: true, get: function () { return TriggeredSessionReplay_1.startRecording; } });
-Object.defineProperty(exports, "stopRecording", { enumerable: true, get: function () { return TriggeredSessionReplay_1.stopRecording; } });
+Object.defineProperty(exports, "runStatsigTriggeredSessionReplay", { enumerable: true, get: function () { return TriggeredSessionReplay_1.runStatsigTriggeredSessionReplay; } });
 Object.assign((0, client_core_1._getStatsigGlobal)(), {
     SessionReplayClient: SessionReplayClient_1.SessionReplayClient,
     SessionReplay: SessionReplay_1.SessionReplay,
     runStatsigSessionReplay: SessionReplay_1.runStatsigSessionReplay,
+    runStatsigTriggeredSessionReplay: TriggeredSessionReplay_1.runStatsigTriggeredSessionReplay,
     StatsigSessionReplayPlugin: SessionReplay_1.StatsigSessionReplayPlugin,
+    StatsigTriggeredSessionReplayPlugin: TriggeredSessionReplay_1.StatsigTriggeredSessionReplayPlugin,
+    startRecording: SessionReplayBase_1.startRecording,
+    stopRecording: SessionReplayBase_1.stopRecording,
+    forceStartRecording: SessionReplayBase_1.forceStartRecording,
 });