posthog-js 1.286.0 → 1.287.0

package/dist/src/extensions/replay/external/flushed-size-tracker.d.ts

@@ -0,0 +1,9 @@
+import { PostHog } from '../../../posthog-core';
+export declare class FlushedSizeTracker {
+    private readonly _getProperty;
+    private readonly _setProperty;
+    constructor(posthog: PostHog);
+    trackSize(size: number): void;
+    reset(): void;
+    get currentTrackedSize(): number;
+}

package/dist/src/extensions/replay/external/lazy-loaded-session-recorder.d.ts

@@ -79,6 +79,7 @@ export declare class LazyLoadedSessionRecording implements LazyLoadedSessionReco
     private _buffer;
     private _removePageViewCaptureHook;
     private _removeEventTriggerCaptureHook;
+    private _flushedSizeTracker;
     private get _sessionManager();
     private get _sessionIdleThresholdMilliseconds();
     private get _isSampled();

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "posthog-js",
-    "version": "1.286.0",
+    "version": "1.287.0",
     "description": "Posthog-js allows you to automatically capture usage and send events to PostHog.",
     "repository": "https://github.com/PostHog/posthog-js",
     "author": "hey@posthog.com",

package/lib/src/extensions/replay/external/flushed-size-tracker.d.ts

@@ -0,0 +1,9 @@
+import { PostHog } from '../../../posthog-core';
+export declare class FlushedSizeTracker {
+    private readonly _getProperty;
+    private readonly _setProperty;
+    constructor(posthog: PostHog);
+    trackSize(size: number): void;
+    reset(): void;
+    get currentTrackedSize(): number;
+}

package/lib/src/extensions/replay/external/flushed-size-tracker.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlushedSizeTracker = void 0;
+var SESSION_RECORDING_FLUSHED_SIZE = '$sess_rec_flush_size';
+var FlushedSizeTracker = /** @class */ (function () {
+    function FlushedSizeTracker(posthog) {
+        if (!posthog.persistence) {
+            throw new Error('it is not valid to not have persistence and be this far into setting up the application');
+        }
+        this._getProperty = posthog.get_property.bind(posthog);
+        this._setProperty = posthog.persistence.set_property.bind(posthog.persistence);
+    }
+    FlushedSizeTracker.prototype.trackSize = function (size) {
+        var currentFlushed = Number(this._getProperty(SESSION_RECORDING_FLUSHED_SIZE)) || 0;
+        var newValue = currentFlushed + size;
+        this._setProperty(SESSION_RECORDING_FLUSHED_SIZE, newValue);
+    };
+    FlushedSizeTracker.prototype.reset = function () {
+        return this._setProperty(SESSION_RECORDING_FLUSHED_SIZE, 0);
+    };
+    Object.defineProperty(FlushedSizeTracker.prototype, "currentTrackedSize", {
+        get: function () {
+            return Number(this._getProperty(SESSION_RECORDING_FLUSHED_SIZE)) || 0;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return FlushedSizeTracker;
+}());
+exports.FlushedSizeTracker = FlushedSizeTracker;
+//# sourceMappingURL=flushed-size-tracker.js.map

package/lib/src/extensions/replay/external/flushed-size-tracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flushed-size-tracker.js","sourceRoot":"","sources":["../../../../../src/extensions/replay/external/flushed-size-tracker.ts"],"names":[],"mappings":";;;AAGA,IAAM,8BAA8B,GAAG,sBAAsB,CAAA;AAE7D;IAII,4BAAY,OAAgB;QACxB,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,yFAAyF,CAAC,CAAA;QAC9G,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACtD,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;IAClF,CAAC;IAED,sCAAS,GAAT,UAAU,IAAY;QAClB,IAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,8BAA8B,CAAC,CAAC,IAAI,CAAC,CAAA;QACrF,IAAM,QAAQ,GAAG,cAAc,GAAG,IAAI,CAAA;QACtC,IAAI,CAAC,YAAY,CAAC,8BAA8B,EAAE,QAAQ,CAAC,CAAA;IAC/D,CAAC;IAED,kCAAK,GAAL;QACI,OAAO,IAAI,CAAC,YAAY,CAAC,8BAA8B,EAAE,CAAC,CAAC,CAAA;IAC/D,CAAC;IAED,sBAAI,kDAAkB;aAAtB;YACI,OAAO,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,8BAA8B,CAAC,CAAC,IAAI,CAAC,CAAA;QACzE,CAAC;;;OAAA;IACL,yBAAC;AAAD,CAAC,AA1BD,IA0BC;AA1BY,gDAAkB","sourcesContent":["import { PostHog } from '../../../posthog-core'\nimport { Property } from '../../../types'\n\nconst SESSION_RECORDING_FLUSHED_SIZE = '$sess_rec_flush_size'\n\nexport class FlushedSizeTracker {\n    private readonly _getProperty: (property_name: string) => Property | undefined\n    private readonly _setProperty: (prop: string, to: any) => void\n\n    constructor(posthog: PostHog) {\n        if (!posthog.persistence) {\n            throw new Error('it is not valid to not have persistence and be this far into setting up the application')\n        }\n\n        this._getProperty = posthog.get_property.bind(posthog)\n        this._setProperty = posthog.persistence.set_property.bind(posthog.persistence)\n    }\n\n    trackSize(size: number) {\n        const currentFlushed = Number(this._getProperty(SESSION_RECORDING_FLUSHED_SIZE)) || 0\n        const newValue = currentFlushed + size\n        this._setProperty(SESSION_RECORDING_FLUSHED_SIZE, newValue)\n    }\n\n    reset() {\n        return this._setProperty(SESSION_RECORDING_FLUSHED_SIZE, 0)\n    }\n\n    get currentTrackedSize(): number {\n        return Number(this._getProperty(SESSION_RECORDING_FLUSHED_SIZE)) || 0\n    }\n}\n"]}

package/lib/src/extensions/replay/external/lazy-loaded-session-recorder.d.ts

@@ -79,6 +79,7 @@ export declare class LazyLoadedSessionRecording implements LazyLoadedSessionReco
     private _buffer;
     private _removePageViewCaptureHook;
     private _removeEventTriggerCaptureHook;
+    private _flushedSizeTracker;
     private get _sessionManager();
     private get _sessionIdleThresholdMilliseconds();
     private get _isSampled();

package/lib/src/extensions/replay/external/lazy-loaded-session-recorder.js

@@ -66,6 +66,7 @@ var constants_1 = require("../../../constants");
 var request_utils_1 = require("../../../utils/request-utils");
 var config_2 = __importDefault(require("../../../config"));
 var sampling_1 = require("../../sampling");
+var flushed_size_tracker_1 = require("./flushed-size-tracker");
 var BASE_ENDPOINT = '/s/';
 var DEFAULT_CANVAS_QUALITY = 0.4;
 var DEFAULT_CANVAS_FPS = 4;
@@ -202,6 +203,7 @@ var LazyLoadedSessionRecording = /** @class */ (function () {
         this._samplingSessionListener = undefined;
         this._forceIdleSessionIdListener = undefined;
         this._onSessionIdCallback = function (sessionId, windowId, changeReason) {
+            var _a;
             if (!changeReason)
                 return;
             var wasLikelyReset = changeReason.noSessionId;
@@ -217,8 +219,13 @@ var LazyLoadedSessionRecording = /** @class */ (function () {
                     // we'll need to correct the time of this if it's captured when idle
                     // so we don't extend reported session time with a debug event
                     lastActivityTimestamp: _this._lastActivityTimestamp,
+                    flushed_size: (_a = _this._flushedSizeTracker) === null || _a === void 0 ? void 0 : _a.currentTrackedSize,
                 });
             }
+            // reset flushed size tracker after capturing the ending event
+            if (_this._flushedSizeTracker) {
+                _this._flushedSizeTracker.reset();
+            }
             _this._tryAddCustomEvent('$session_id_change', { sessionId: sessionId, windowId: windowId, changeReason: changeReason });
             _this._clearConditionalRecordingPersistence();
             if (!_this._stopRrweb) {
@@ -264,6 +271,7 @@ var LazyLoadedSessionRecording = /** @class */ (function () {
         if (this._sessionIdleThresholdMilliseconds >= this._sessionManager.sessionTimeoutMs) {
             logger.warn("session_idle_threshold_ms (".concat(this._sessionIdleThresholdMilliseconds, ") is greater than the session timeout (").concat(this._sessionManager.sessionTimeoutMs, "). Session will never be detected as idle"));
         }
+        this._flushedSizeTracker = new flushed_size_tracker_1.FlushedSizeTracker(this._instance);
     }
     Object.defineProperty(LazyLoadedSessionRecording.prototype, "sessionId", {
         get: function () {
@@ -897,6 +905,8 @@ var LazyLoadedSessionRecording = /** @class */ (function () {
         if (this._buffer.data.length > 0) {
             var snapshotEvents = splitBuffer(this._buffer);
             snapshotEvents.forEach(function (snapshotBuffer) {
+                var _a;
+                (_a = _this._flushedSizeTracker) === null || _a === void 0 ? void 0 : _a.trackSize(snapshotBuffer.size);
                 _this._captureSnapshot({
                     $snapshot_bytes: snapshotBuffer.size,
                     $snapshot_data: snapshotBuffer.data,
@@ -1115,6 +1125,7 @@ var LazyLoadedSessionRecording = /** @class */ (function () {
     };
     Object.defineProperty(LazyLoadedSessionRecording.prototype, "sdkDebugProperties", {
         get: function () {
+            var _a;
             var sessionStartTimestamp = this._sessionManager.checkAndGetSessionAndWindowId(true).sessionStartTimestamp;
             return {
                 $recording_status: this.status,
@@ -1122,6 +1133,7 @@ var LazyLoadedSessionRecording = /** @class */ (function () {
                 $sdk_debug_replay_internal_buffer_size: this._buffer.size,
                 $sdk_debug_current_session_duration: this._sessionDuration,
                 $sdk_debug_session_start: sessionStartTimestamp,
+                $sdk_debug_replay_flushed_size: (_a = this._flushedSizeTracker) === null || _a === void 0 ? void 0 : _a.currentTrackedSize,
             };
         },
         enumerable: false,