posthog-js 1.30.0 → 1.31.1

package/dist/module.d.ts

@@ -159,7 +159,7 @@ interface PostHogConfig {
     disable_session_recording: boolean;
     disable_persistence: boolean;
     disable_cookie: boolean;
-    enable_recording_console_log: boolean;
+    enable_recording_console_log?: boolean;
     secure_cookie: boolean;
     ip: boolean;
     opt_out_capturing_by_default: boolean;
@@ -272,6 +272,7 @@ interface DecideResponse {
     featureFlags: Record<string, string | boolean>;
     sessionRecording?: {
         endpoint?: string;
+        consoleLogRecordingEnabled?: boolean;
     };
     editorParams: EditorParams;
     toolbarVersion: 'toolbar'; /** deprecated, moved to editorParams */
@@ -781,6 +782,7 @@ declare class SessionRecording {
     started(): boolean;
     stopRecording(): void;
     isRecordingEnabled(): boolean;
+    isConsoleLogCaptureEnabled(): boolean;
     afterDecideResponse(response: DecideResponse): void;
     startCaptureAndTrySendingQueuedSnapshots(): void;
     _startCapture(): void;
@@ -818,6 +820,7 @@ declare class SessionIdManager {
     _windowId: string | null | undefined;
     _sessionId: string | null | undefined;
     window_id_storage_key: string;
+    primary_window_exists_storage_key: string;
     _sessionStartTimestamp: number | null;
     _sessionActivityTimestamp: number | null;
     constructor(config: Partial<PostHogConfig>, persistence: PostHogPersistence);
@@ -826,6 +829,7 @@ declare class SessionIdManager {
     _setSessionId(sessionId: string | null, sessionActivityTimestamp: number | null, sessionStartTimestamp: number | null): void;
     _getSessionId(): [number, string, number];
     resetSessionId(): void;
+    _listenToReloadWindow(): void;
     checkAndGetSessionAndWindowId(readOnly?: boolean, _timestamp?: number | null): {
         sessionId: string;
         windowId: string;

package/dist/module.js

@@ -885,7 +885,7 @@ var LZString = {
   }
 };
 
-var version = "1.30.0";
+var version = "1.31.1";
 
 // e.g.     Config.DEBUG = Config.DEBUG || instance.get_config('debug')
 
@@ -3381,6 +3381,7 @@ var ALIAS_ID_KEY = '__alias';
 var CAMPAIGN_IDS_KEY = '__cmpns';
 var EVENT_TIMERS_KEY = '__timers';
 var SESSION_RECORDING_ENABLED_SERVER_SIDE = '$session_recording_enabled_server_side';
+var CONSOLE_LOG_RECORDING_ENABLED_SERVER_SIDE = '$console_log_recording_enabled_server_side';
 var SESSION_ID = '$sesid';
 var ENABLED_FEATURE_FLAGS = '$enabled_feature_flags';
 var RESERVED_PROPERTIES = [SET_QUEUE_KEY, SET_ONCE_QUEUE_KEY, UNSET_QUEUE_KEY, ADD_QUEUE_KEY, APPEND_QUEUE_KEY, REMOVE_QUEUE_KEY, UNION_QUEUE_KEY, PEOPLE_DISTINCT_ID_KEY, ALIAS_ID_KEY, CAMPAIGN_IDS_KEY, EVENT_TIMERS_KEY, SESSION_RECORDING_ENABLED_SERVER_SIDE, SESSION_ID, ENABLED_FEATURE_FLAGS];
@@ -3794,21 +3795,30 @@ var SessionRecording = /*#__PURE__*/function () {
       var enabled_client_side = !this.instance.get_config('disable_session_recording');
       return enabled_server_side && enabled_client_side;
     }
+  }, {
+    key: "isConsoleLogCaptureEnabled",
+    value: function isConsoleLogCaptureEnabled() {
+      var enabled_server_side = !!this.instance.get_property(CONSOLE_LOG_RECORDING_ENABLED_SERVER_SIDE);
+      var enabled_client_side = this.instance.get_config('enable_recording_console_log');
+      return enabled_client_side !== null && enabled_client_side !== void 0 ? enabled_client_side : enabled_server_side;
+    }
   }, {
     key: "afterDecideResponse",
     value: function afterDecideResponse(response) {
-      var _response$sessionReco;
+      var _response$sessionReco2;
 
       this.receivedDecide = true;
 
       if (this.instance.persistence) {
-        this.instance.persistence.register(_defineProperty({}, SESSION_RECORDING_ENABLED_SERVER_SIDE, !!response['sessionRecording']));
+        var _response$sessionReco, _this$instance$persis;
+
+        this.instance.persistence.register((_this$instance$persis = {}, _defineProperty(_this$instance$persis, SESSION_RECORDING_ENABLED_SERVER_SIDE, !!response['sessionRecording']), _defineProperty(_this$instance$persis, CONSOLE_LOG_RECORDING_ENABLED_SERVER_SIDE, (_response$sessionReco = response.sessionRecording) === null || _response$sessionReco === void 0 ? void 0 : _response$sessionReco.consoleLogRecordingEnabled), _this$instance$persis));
       }
 
-      if ((_response$sessionReco = response.sessionRecording) !== null && _response$sessionReco !== void 0 && _response$sessionReco.endpoint) {
-        var _response$sessionReco2;
+      if ((_response$sessionReco2 = response.sessionRecording) !== null && _response$sessionReco2 !== void 0 && _response$sessionReco2.endpoint) {
+        var _response$sessionReco3;
 
-        this.endpoint = (_response$sessionReco2 = response.sessionRecording) === null || _response$sessionReco2 === void 0 ? void 0 : _response$sessionReco2.endpoint;
+        this.endpoint = (_response$sessionReco3 = response.sessionRecording) === null || _response$sessionReco3 === void 0 ? void 0 : _response$sessionReco3.endpoint;
       }
 
       this.startRecordingIfEnabled();
@@ -3934,7 +3944,7 @@ var SessionRecording = /*#__PURE__*/function () {
             _this2.snapshots.push(properties);
           }
         },
-        plugins: window.rrwebConsoleRecord && this.instance.get_config('enable_recording_console_log') ? [window.rrwebConsoleRecord.getRecordConsolePlugin()] : []
+        plugins: window.rrwebConsoleRecord && this.isConsoleLogCaptureEnabled() ? [window.rrwebConsoleRecord.getRecordConsolePlugin()] : []
       }, sessionRecordingOptions)); // :TRICKY: rrweb does not capture navigation within SPA-s, so hook into our $pageview events to get access to all events.
       //   Dropping the initial event is fine (it's always captured by rrweb).
 
@@ -5549,12 +5559,28 @@ var SessionIdManager = /*#__PURE__*/function () {
     this._sessionId = undefined;
     this._sessionStartTimestamp = null;
     this._sessionActivityTimestamp = null;
+    var persistenceName = config['persistence_name'] || config['token'];
+    this.window_id_storage_key = 'ph_' + persistenceName + '_window_id';
+    this.primary_window_exists_storage_key = 'ph_' + persistenceName + '_primary_window_exists'; // primary_window_exists is set when the DOM has been loaded and is cleared on unload
+    // if it exists here it means there was no unload which suggests this window is opened as a tab duplication, window.open, etc.
+
+    if (!this.persistence.disabled && sessionStore.is_supported()) {
+      var lastWindowId = sessionStore.parse(this.window_id_storage_key);
+      var primaryWindowExists = sessionStore.parse(this.primary_window_exists_storage_key);
+
+      if (lastWindowId && !primaryWindowExists) {
+        // Persist window from previous storage state
+        this._windowId = lastWindowId;
+      } else {
+        // Wipe any reference to previous window id
+        sessionStore.remove(this.window_id_storage_key);
+      } // Flag this session as having a primary window
 
-    if (config['persistence_name']) {
-      this.window_id_storage_key = 'ph_' + config['persistence_name'] + '_window_id';
-    } else {
-      this.window_id_storage_key = 'ph_' + config['token'] + '_window_id';
+
+      sessionStore.set(this.primary_window_exists_storage_key, true);
     }
+
+    this._listenToReloadWindow();
   } // Note: this tries to store the windowId in sessionStorage. SessionStorage is unique to the current window/tab,
   // and persists page loads/reloads. So it's uniquely suited for storing the windowId. This function also respects
   // when persistence is disabled (by user config) and when sessionStorage is not supported (it *should* be supported on all browsers),
@@ -5581,7 +5607,8 @@ var SessionIdManager = /*#__PURE__*/function () {
 
       if (!this.persistence.disabled && sessionStore.is_supported()) {
         return sessionStore.parse(this.window_id_storage_key);
-      }
+      } // New window id will be generated
+
 
       return null;
     } // Note: 'this.persistence.register' can be disabled in the config.
@@ -5620,6 +5647,24 @@ var SessionIdManager = /*#__PURE__*/function () {
     value: function resetSessionId() {
       this._setSessionId(null, null, null);
     }
+    /*
+     * Listens to window unloads and removes the primaryWindowExists key from sessionStorage.
+     * Reloaded or fresh tabs created after a DOM unloads (reloading the same tab) WILL NOT have this primaryWindowExists flag in session storage.
+     * Cloned sessions (new tab, tab duplication, window.open(), ...) WILL have this primaryWindowExists flag in their copied session storage.
+     * We conditionally check the primaryWindowExists value in the constructor to decide if the window id in the last session storage should be carried over.
+     */
+
+  }, {
+    key: "_listenToReloadWindow",
+    value: function _listenToReloadWindow() {
+      var _this = this;
+
+      window.addEventListener('beforeunload', function () {
+        if (!_this.persistence.disabled && sessionStore.is_supported()) {
+          sessionStore.remove(_this.primary_window_exists_storage_key);
+        }
+      });
+    }
     /*
      * This function returns the current sessionId and windowId. It should be used to
      * access these values over directly calling `._sessionId` or `._windowId`. In addition
@@ -5830,6 +5875,8 @@ var SentryIntegration = /*#__PURE__*/_createClass(function SentryIntegration(_po
 
   this.setupOnce = function (addGlobalEventProcessor) {
     addGlobalEventProcessor(function (event) {
+      var _event$exception, _exceptions$, _exceptions$2;
+
       if (event.level !== 'error' || !_posthog.__loaded) return event;
       if (!event.tags) event.tags = {};
       event.tags['PostHog Person URL'] = _posthog.config.api_host + '/person/' + _posthog.get_distinct_id();
@@ -5838,9 +5885,13 @@ var SentryIntegration = /*#__PURE__*/_createClass(function SentryIntegration(_po
         event.tags['PostHog Recording URL'] = _posthog.config.api_host + '/recordings/#sessionRecordingId=' + _posthog.sessionManager.checkAndGetSessionAndWindowId(true).sessionId;
       }
 
+      var exceptions = ((_event$exception = event.exception) === null || _event$exception === void 0 ? void 0 : _event$exception.values) || [];
       var data = {
         $sentry_event_id: event.event_id,
-        $sentry_exception: event.exception
+        $sentry_exception: event.exception,
+        $sentry_exception_message: (_exceptions$ = exceptions[0]) === null || _exceptions$ === void 0 ? void 0 : _exceptions$.value,
+        $sentry_exception_type: (_exceptions$2 = exceptions[0]) === null || _exceptions$2 === void 0 ? void 0 : _exceptions$2.type,
+        $sentry_tags: event.tags
       };
       if (organization && projectId) data['$sentry_url'] = (prefix || 'https://sentry.io/organizations/') + organization + '/issues/?project=' + projectId + '&query=' + event.event_id;
 
@@ -5915,7 +5966,8 @@ var defaultConfig = function defaultConfig() {
     disable_session_recording: false,
     disable_persistence: false,
     disable_cookie: false,
-    enable_recording_console_log: false,
+    enable_recording_console_log: undefined,
+    // When undefined, it falls back to the server-side setting
     secure_cookie: (win === null || win === void 0 ? void 0 : (_window$location = win.location) === null || _window$location === void 0 ? void 0 : _window$location.protocol) === 'https:',
     ip: true,
     opt_out_capturing_by_default: false,