rollbar 3.0.0-beta.5 → 3.0.0

package/src/browser/core.js

@@ -1,19 +1,20 @@
-import Client from '../rollbar.js';
-import * as _ from '../utility.js';
 import API from '../api.js';
+import defaults from '../defaults.js';
+import errorParser from '../errorParser.js';
 import logger from '../logger.js';
-import * as globals from './globalSetup.js';
-
-import Transport from './transport.js';
-import * as urllib from './url.js';
-
-import * as transforms from './transforms.js';
+import * as sharedPredicates from '../predicates.js';
+import Client from '../rollbar.js';
+import tracingDefaults from '../tracing/defaults.js';
 import * as sharedTransforms from '../transforms.js';
+import * as _ from '../utility.js';
+
+import browserDefaults from './defaults.js';
+import * as globals from './globalSetup.js';
 import * as predicates from './predicates.js';
-import * as sharedPredicates from '../predicates.js';
-import errorParser from '../errorParser.js';
 import replayDefaults from './replay/defaults.js';
-import tracingDefaults from '../tracing/defaults.js';
+import * as transforms from './transforms.js';
+import Transport from './transport.js';
+import * as urllib from './url.js';
 
 // Used to support global `Rollbar` instance.
 let _instance = null;
@@ -67,7 +68,7 @@ class Rollbar {
         'browser',
       );
     var gWindow = _gWindow();
-    var gDocument = typeof document != 'undefined' && document;
+    var gDocument = typeof document !== 'undefined' && document;
     this.isChrome = gWindow.chrome && gWindow.chrome.runtime; // check .runtime to avoid Edge browsers
     this.anonymousErrorsPending = 0;
     addTransformsToNotifier(this.client.notifier, this, gWindow);
@@ -126,7 +127,7 @@ class Rollbar {
     );
 
     this.tracing?.configure(this.options);
-    this.replay?.configure(this.options);
+    this.replay?.configure(this.options.replay);
     this.client.configure(this.options, payloadData);
     this.instrumenter?.configure(this.options);
     this.setupUnhandledCapture();
@@ -294,16 +295,15 @@ class Rollbar {
       return;
     }
 
-    var r = this;
-    function prepareStackTrace(error, _stack) {
-      if (r.options.inspectAnonymousErrors) {
-        if (r.anonymousErrorsPending) {
+    const prepareStackTrace = (error, _stack) => {
+      if (this.options.inspectAnonymousErrors) {
+        if (this.anonymousErrorsPending) {
           // This is the only known way to detect that onerror saw an anonymous error.
           // It depends on onerror reliably being called before Error.prepareStackTrace,
           // which so far holds true on tested versions of Chrome. If versions of Chrome
           // are tested that behave differently, this logic will need to be updated
           // accordingly.
-          r.anonymousErrorsPending -= 1;
+          this.anonymousErrorsPending -= 1;
 
           if (!error) {
             // Not likely to get here, but calling handleUncaughtException from here
@@ -318,13 +318,13 @@ class Rollbar {
           // url, lineno, colno shouldn't be needed for these errors.
           // If that changes, update this accordingly, using the unused
           // _stack param as needed (rather than parse error.toString()).
-          r.handleUncaughtException(error.message, null, null, null, error);
+          this.handleUncaughtException(error.message, null, null, null, error);
         }
       }
 
       // Workaround to ensure stack is preserved for normal errors.
       return error.stack;
-    }
+    };
 
     // https://v8.dev/docs/stack-trace-api
     try {
@@ -424,17 +424,15 @@ class Rollbar {
 
         f._rollbar_wrapped._isWrap = true;
 
-        if (f.hasOwnProperty) {
-          for (var prop in f) {
-            if (f.hasOwnProperty(prop) && prop !== '_rollbar_wrapped') {
-              f._rollbar_wrapped[prop] = f[prop];
-            }
+        for (var prop in f) {
+          if (_.hasOwn(f, prop) && prop !== '_rollbar_wrapped') {
+            f._rollbar_wrapped[prop] = f[prop];
           }
         }
       }
 
       return f._rollbar_wrapped;
-    } catch (e) {
+    } catch (_e) {
       // Return the original function if the wrap fails.
       return f;
     }
@@ -582,28 +580,19 @@ function _getFirstFunction(args) {
 
 function _gWindow() {
   return (
-    (typeof window != 'undefined' && window) ||
-    (typeof self != 'undefined' && self)
+    (typeof window !== 'undefined' && window) ||
+    (typeof self !== 'undefined' && self)
   );
 }
 
-import {
-  version,
-  logLevel,
-  reportLevel,
-  uncaughtErrorLevel,
-  endpoint,
-} from '../defaults.js';
-import browserDefaults from './defaults.js';
-
 const defaultOptions = {
   environment: 'unknown',
-  version: version,
+  version: defaults.version,
   scrubFields: browserDefaults.scrubFields,
-  logLevel: logLevel,
-  reportLevel: reportLevel,
-  uncaughtErrorLevel: uncaughtErrorLevel,
-  endpoint: endpoint,
+  logLevel: defaults.logLevel,
+  reportLevel: defaults.reportLevel,
+  uncaughtErrorLevel: defaults.uncaughtErrorLevel,
+  endpoint: defaults.endpoint,
   verbose: false,
   enabled: true,
   transmit: true,

package/src/browser/domUtility.js

@@ -9,9 +9,9 @@ function isDescribedElement(element, type, subtypes) {
   if (!subtypes) {
     return true;
   }
-  element = getElementType(element);
-  for (var i = 0; i < subtypes.length; i++) {
-    if (subtypes[i] === element) {
+  const elementType = getElementType(element);
+  for (const subtype of subtypes) {
+    if (subtype === elementType) {
       return true;
     }
   }
@@ -34,7 +34,7 @@ function treeToArray(elem) {
   var nextDescription;
   for (var height = 0; elem && height < MAX_HEIGHT; height++) {
     nextDescription = describeElement(elem);
-    if (nextDescription.tagName === 'html') {
+    if (!nextDescription || nextDescription.tagName === 'html') {
       break;
     }
     out.unshift(nextDescription);
@@ -80,10 +80,8 @@ function descriptionToString(desc) {
   if (desc.classes) {
     out.push('.' + desc.classes.join('.'));
   }
-  for (var i = 0; i < desc.attributes.length; i++) {
-    out.push(
-      '[' + desc.attributes[i].key + '="' + desc.attributes[i].value + '"]',
-    );
+  for (const attribute of desc.attributes) {
+    out.push('[' + attribute.key + '="' + attribute.value + '"]');
   }
 
   return out.join('');
@@ -109,10 +107,7 @@ function describeElement(elem) {
     return null;
   }
   var out = {},
-    className,
-    key,
-    attr,
-    i;
+    className;
   out.tagName = elem.tagName.toLowerCase();
   if (elem.id) {
     out.id = elem.id;
@@ -123,11 +118,10 @@ function describeElement(elem) {
   }
   var attributes = ['type', 'name', 'title', 'alt'];
   out.attributes = [];
-  for (i = 0; i < attributes.length; i++) {
-    key = attributes[i];
-    attr = elem.getAttribute(key);
+  for (const attribute of attributes) {
+    const attr = elem.getAttribute(attribute);
     if (attr) {
-      out.attributes.push({ key: key, value: attr });
+      out.attributes.push({ key: attribute, value: attr });
     }
   }
   return out;
@@ -161,7 +155,7 @@ function isMatchingElement(element, classes, selectors) {
         return true;
       }
     }
-  } catch (e) {
+  } catch (_e) {
     // ignore errors from invalid arguments
   }
   return false;

package/src/browser/globalSetup.js

@@ -67,12 +67,12 @@ function captureUnhandledRejections(window, handler, shim) {
     var reason, promise, detail;
     try {
       reason = evt.reason;
-    } catch (e) {
+    } catch (_e) {
       reason = undefined;
     }
     try {
       promise = evt.promise;
-    } catch (e) {
+    } catch (_e) {
       promise = '[unhandledrejection] error getting `promise` from event';
     }
     try {
@@ -81,7 +81,7 @@ function captureUnhandledRejections(window, handler, shim) {
         reason = detail.reason;
         promise = detail.promise;
       }
-    } catch (e) {
+    } catch (_e) {
       // Ignore
     }
     if (!reason) {

package/src/browser/replay/checkoutWatchdog.js

@@ -0,0 +1,104 @@
+import logger from '../../logger.js';
+
+/**
+ * Schedules forced rrweb checkouts when the recorder has been idle too long.
+ *
+ * Recorder notifies the watchdog whenever rrweb performs a checkout. If
+ * another checkout doesn't happen within the configured window, the watchdog
+ * calls `forceCheckout` so buffers stay within max pre-duration limits.
+ */
+export default class CheckoutWatchdog {
+  _getIntervalMs;
+  _forceCheckout;
+  _marginMs;
+  _now;
+
+  _timerId = null;
+  _lastCheckoutAt = null;
+  _running = false;
+
+  /**
+   * @param {Object} params
+   * @param {() => number} params.getIntervalMs - Returns checkout interval
+   * @param {() => void} params.forceCheckout - Invoked to force a checkout
+   * @param {number} [params.marginMs] - Safety margin before forcing checkout, default: 1000ms
+   * @param {() => number} [params.now] - Clock function (primarily for tests), default: Date.now
+   */
+  constructor({
+    getIntervalMs,
+    forceCheckout,
+    marginMs = 1000,
+    now = () => Date.now(),
+  }) {
+    this._getIntervalMs = getIntervalMs;
+    this._forceCheckout = forceCheckout;
+    this._marginMs = marginMs;
+    this._now = now;
+  }
+
+  start() {
+    if (this._running) return;
+
+    this._running = true;
+    this._lastCheckoutAt = this._now();
+    this._arm();
+  }
+
+  stop() {
+    if (!this._running) return;
+
+    this._running = false;
+    this._lastCheckoutAt = null;
+    this._clearTimer();
+  }
+
+  /**
+   * Notifies the watchdog that rrweb just performed a checkout.
+   *
+   * @param {number} [timestamp] - Timestamp of checkout (ms)
+   */
+  notify(timestamp = this._now()) {
+    if (!this._running) return;
+
+    this._lastCheckoutAt = timestamp;
+    this._arm();
+  }
+
+  _arm() {
+    this._clearTimer();
+
+    if (!this._running) return;
+
+    const delay = this._getIntervalMs() + this._marginMs;
+    this._timerId = setTimeout(() => this._maybeForceCheckout(), delay);
+  }
+
+  _maybeForceCheckout() {
+    if (!this._running) return;
+
+    const interval = this._getIntervalMs();
+    const lastCheckoutAt = this._lastCheckoutAt ?? this._now();
+    const delta = this._now() - lastCheckoutAt;
+
+    if (delta < interval) {
+      this._arm();
+      return;
+    }
+
+    try {
+      this._forceCheckout();
+    } catch (error) {
+      logger.error('Replay: Forced checkout failed', error);
+    }
+
+    this._lastCheckoutAt = this._now();
+    this._arm();
+  }
+
+  _clearTimer() {
+    if (this._timerId) {
+      clearTimeout(this._timerId);
+      this._timerId = null;
+    }
+  }
+}

package/src/browser/replay/recorder.d.ts

@@ -1,5 +1,5 @@
 /** A point-in-time cursor into the active Recorder's two-slot ring buffer. */
-export type BufferCursor = {
+export interface BufferCursor {
   /** Index (0|1) of the active buffer's slot at snapshot time. */
   slot: 0 | 1;
   /**
@@ -7,7 +7,7 @@ export type BufferCursor = {
    * May be -1 when empty.
    */
   offset: number;
-};
+}
 
 export default class Recorder {
   constructor(options: Record<string, any>);
@@ -28,4 +28,7 @@ export default class Recorder {
   start(): this;
   stop(): this;
   clear(): void;
+
+  // Internal only - for testing
+  get _recordFn(): (event: any) => void;
 }

package/src/browser/replay/recorder.js

@@ -1,8 +1,11 @@
 import { record as rrwebRecordFn } from '@rrweb/record';
 import { EventType } from '@rrweb/types';
 
-import hrtime from '../../tracing/hrtime.js';
 import logger from '../../logger.js';
+import hrtime from '../../tracing/hrtime.js';
+import { isFunction } from '../../utility.js';
+
+import CheckoutWatchdog from './checkoutWatchdog.js';
 
 /** @typedef {import('./recorder.js').BufferCursor} BufferCursor */
 
@@ -13,6 +16,7 @@ export default class Recorder {
   _isReady = false;
   _stopFn = null;
   _recordFn;
+  _checkoutWatchdog;
 
   /** A two-slot ring buffer for storing events. */
   _buffers = [[], []];
@@ -28,11 +32,20 @@ export default class Recorder {
    *
    * @param {Object} options - Configuration options for the recorder
    */
-  constructor(options) {
+  constructor(options = {}) {
     this.options = options;
 
     // Tests inject a custom rrweb record function or mock.
     this._recordFn = options.recordFn || rrwebRecordFn;
+
+    if (!isFunction(this._recordFn?.takeFullSnapshot)) {
+      throw new Error('Recorder requires a valid rrweb record function');
+    }
+
+    this._checkoutWatchdog = new CheckoutWatchdog({
+      getIntervalMs: () => this.checkoutEveryNms(),
+      forceCheckout: () => this._recordFn.takeFullSnapshot(true),
+    });
   }
 
   get isRecording() {
@@ -60,8 +73,8 @@ export default class Recorder {
       debug,
 
       // disallowed rrweb options
-      emit,
-      checkoutEveryNms,
+      emit: _emit,
+      checkoutEveryNms: _checkoutEveryNms,
 
       // rrweb options
       ...rrwebOptions
@@ -176,6 +189,7 @@ export default class Recorder {
         if (isCheckout && event.type === EventType.Meta) {
           this._currentSlot = this._previousSlot;
           this._buffers[this._currentSlot] = [];
+          this._checkoutWatchdog.notify(event.timestamp);
         }
 
         this._buffers[this._currentSlot].push(event);
@@ -190,6 +204,8 @@ export default class Recorder {
       ...this._rrwebOptions,
     });
 
+    this._checkoutWatchdog.start();
+
     return this;
   }
 
@@ -201,6 +217,7 @@ export default class Recorder {
     this._stopFn();
     this._stopFn = null;
     this._isReady = false;
+    this._checkoutWatchdog.stop();
 
     return this;
   }
@@ -209,6 +226,7 @@ export default class Recorder {
     this._buffers = [[], []];
     this._currentSlot = 0;
     this._isReady = false;
+    this._checkoutWatchdog.stop();
   }
 
   /**

package/src/browser/replay/replay.js

@@ -1,10 +1,10 @@
-import * as _ from '../../utility.js';
+import logger from '../../logger.js';
 import hrtime from '../../tracing/hrtime.js';
 import id from '../../tracing/id.js';
-import logger from '../../logger.js';
+import * as _ from '../../utility.js';
+
 import Recorder from './recorder.js';
 import ReplayPredicates from './replayPredicates.js';
-import ScheduledCapture from './scheduledCapture.js';
 import ScheduledStreamCapture from './scheduledStreamCapture.js';
 
 /** @typedef {import('./recorder.js').BufferCursor} BufferCursor */
@@ -28,6 +28,7 @@ const TrailingStatus = Object.freeze({
  */
 export default class Replay {
   _map;
+  _options;
   /** @type {Recorder} */
   _recorder;
   _tracing;
@@ -48,6 +49,7 @@ export default class Replay {
     }
 
     this._map = new Map();
+    this._options = options;
     this._predicates = new ReplayPredicates(options);
     this._recorder = new Recorder({
       ...options,
@@ -93,6 +95,7 @@ export default class Replay {
   }
 
   configure(options) {
+    this._options = options;
     this._predicates.configure(options);
     this._recorder.configure({
       ...options,
@@ -125,6 +128,7 @@ export default class Replay {
         'rollbar.replay.trigger.context': JSON.stringify(triggerContext),
         'rollbar.replay.trigger': JSON.stringify(trigger),
         'rollbar.replay.url.full': _.sanitizeHref(window.location.href),
+        'rollbar.replay.options': JSON.stringify(this._options || {}),
       });
     } catch (error) {
       // TODO(matux): No events probably, this is expected, be more graceful.
@@ -227,7 +231,7 @@ export default class Replay {
 
     try {
       await this.send(replayId);
-    } catch (error) {
+    } catch (_error) {
       this.discard(replayId);
       return null;
     }

package/src/browser/replay/replayPredicates.js

@@ -170,7 +170,7 @@ export default class ReplayPredicates {
   isSampled(trigger, context) {
     const ratio = trigger.samplingRatio ?? 1;
 
-    if (ratio == 1) {
+    if (ratio === 1) {
       return true;
     }
     const rv = context.replayId.slice(-14);

package/src/browser/rollbar.js

@@ -1,10 +1,11 @@
-import Rollbar from './core.js';
+import scrub from '../scrub.js';
 import Telemeter from '../telemetry.js';
+import Tracing from '../tracing/tracing.js';
+import truncation from '../truncation.js';
+
+import Rollbar from './core.js';
 import Instrumenter from './telemetry.js';
 import wrapGlobals from './wrapGlobals.js';
-import scrub from '../scrub.js';
-import truncation from '../truncation.js';
-import Tracing from '../tracing/tracing.js';
 
 Rollbar.setComponents({
   telemeter: Telemeter,

package/src/browser/rollbarReplay.js

@@ -1,11 +1,12 @@
-import Rollbar from './core.js';
-import Telemeter from '../telemetry.js';
-import Instrumenter from './telemetry.js';
-import wrapGlobals from './wrapGlobals.js';
 import scrub from '../scrub.js';
-import truncation from '../truncation.js';
+import Telemeter from '../telemetry.js';
 import Tracing from '../tracing/tracing.js';
+import truncation from '../truncation.js';
+
+import Rollbar from './core.js';
 import Replay from './replay/replay.js';
+import Instrumenter from './telemetry.js';
+import wrapGlobals from './wrapGlobals.js';
 
 Rollbar.setComponents({
   telemeter: Telemeter,

package/src/browser/rollbarWrapper.js

@@ -18,8 +18,8 @@ function _setupForwarding(prototype) {
     'log,debug,info,warn,warning,error,critical,global,configure,handleUncaughtException,handleAnonymousErrors,handleUnhandledRejection,_createItem,wrap,loadFull,shimId,captureEvent,captureDomContentLoaded,captureLoad'.split(
       ',',
     );
-  for (var i = 0; i < _methods.length; i++) {
-    prototype[_methods[i]] = _forward(_methods[i]);
+  for (const method of _methods) {
+    prototype[method] = _forward(method);
   }
 }
 

package/src/browser/shim.js

@@ -1,4 +1,8 @@
+import logger from '../logger.js';
+import { hasOwn } from '../utility.js';
+
 import * as globals from './globalSetup.js';
+import Wrapper from './rollbarWrapper.js';
 import wrapGlobals from './wrapGlobals.js';
 
 function _wrapInternalErr(f) {
@@ -7,8 +11,8 @@ function _wrapInternalErr(f) {
       return f.apply(this, arguments);
     } catch (e) {
       try {
-        console.error('[Rollbar]: Internal error', e);
-      } catch (e2) {
+        logger.error('[Rollbar]: Internal error', e);
+      } catch (_e2) {
         // Ignore
       }
     }
@@ -28,7 +32,6 @@ function Shim(options, wrap) {
   }
 }
 
-import Wrapper from './rollbarWrapper.js';
 var ShimImpl = function (options, wrap) {
   return new Shim(options, wrap);
 };
@@ -144,7 +147,7 @@ Shim.prototype.loadFull = function (
       s.onload = s.onreadystatechange = null;
       try {
         parentNode.removeChild(s);
-      } catch (e) {
+      } catch (_e) {
         // pass
       }
       done = true;
@@ -198,17 +201,15 @@ Shim.prototype.wrap = function (f, context, _before) {
 
       f._rollbar_wrapped._isWrap = true;
 
-      if (f.hasOwnProperty) {
-        for (var prop in f) {
-          if (f.hasOwnProperty(prop)) {
-            f._rollbar_wrapped[prop] = f[prop];
-          }
+      for (var prop in f) {
+        if (hasOwn(f, prop)) {
+          f._rollbar_wrapped[prop] = f[prop];
         }
       }
     }
 
     return f._rollbar_wrapped;
-  } catch (e) {
+  } catch (_e) {
     // Return the original function if the wrap fails.
     return f;
   }
@@ -216,9 +217,8 @@ Shim.prototype.wrap = function (f, context, _before) {
 
 function stub(method) {
   return _wrapInternalErr(function () {
-    var shim = this;
-    var args = Array.prototype.slice.call(arguments, 0);
-    var data = { shim: shim, method: method, args: args, ts: new Date() };
+    const args = Array.prototype.slice.call(arguments, 0);
+    const data = { shim: this, method: method, args: args, ts: new Date() };
     window._rollbarShims[this.shimId()].messages.push(data);
   });
 }
@@ -228,8 +228,8 @@ var _methods =
     ',',
   );
 
-for (var i = 0; i < _methods.length; ++i) {
-  Shim.prototype[_methods[i]] = stub(_methods[i]);
+for (const method of _methods) {
+  Shim.prototype[method] = stub(method);
 }
 
 export { setupShim, Rollbar };