rollbar 3.0.0-beta.5 → 3.0.0

package/src/browser/telemetry.js

@@ -1,9 +1,14 @@
-import * as _ from '../utility.js';
+/* eslint-disable @typescript-eslint/no-this-alias */
+// TODO(matux): refactor to remove no-this-alias disable
+
+import logger from '../logger.js';
+import scrub from '../scrub.js';
 import headers from '../utility/headers.js';
 import replace from '../utility/replace.js';
-import scrub from '../scrub.js';
-import * as urlparser from './url.js';
+import * as _ from '../utility.js';
+
 import * as domUtil from './domUtility.js';
+import * as urlparser from './url.js';
 
 const defaults = {
   network: true,
@@ -98,8 +103,8 @@ class Instrumenter {
 
   configureScrubbing() {
     const options = this.options;
-    this.scrubTelemetryInputs = !!(
-      options.scrubTelemetryInputs ?? options.replay?.maskAllInputs
+    this.scrubTelemetryInputs = Boolean(
+      options.scrubTelemetryInputs ?? options.replay?.maskAllInputs,
     );
     this.telemetryScrubber = options.telemetryScrubber;
     this.defaultValueScrubber = defaultValueScrubber(options.scrubFields);
@@ -326,7 +331,7 @@ class Instrumenter {
                           headers[h] = xhr.getResponseHeader(h);
                         }
                       }
-                    } catch (e) {
+                    } catch (_e) {
                       /* we ignore the errors here that could come from different
                        * browser issues with the xhr methods */
                     }
@@ -335,7 +340,7 @@ class Instrumenter {
                   if (self.autoInstrument.networkResponseBody) {
                     try {
                       body = xhr.responseText;
-                    } catch (e) {
+                    } catch (_e) {
                       /* ignore errors from reading responseText */
                     }
                   }
@@ -372,7 +377,7 @@ class Instrumenter {
                     xhr.__rollbar_event.level =
                       self.telemeter.levelFromStatus(code);
                     self.errorOnHttpStatus(xhr.__rollbar_xhr);
-                  } catch (e) {
+                  } catch (_e) {
                     /* ignore possible exception from xhr.status */
                   }
                 }
@@ -413,7 +418,7 @@ class Instrumenter {
         this._window,
         'fetch',
         function (orig) {
-          return function (fn, t) {
+          return function (_fn, _t) {
             const args = [...arguments];
             const input = args[0];
             let method = 'GET';
@@ -584,7 +589,7 @@ class Instrumenter {
           outHeaders[h] = inHeaders.get(h);
         }
       }
-    } catch (e) {
+    } catch (_e) {
       /* ignore probable IE errors */
     }
     return outHeaders;
@@ -629,6 +634,7 @@ class Instrumenter {
     const c = this._window.console;
 
     function wrapConsole(method) {
+      // eslint-disable-next-line strict
       'use strict'; // See https://github.com/rollbar/rollbar.js/pull/778
 
       const orig = c[method];
@@ -659,7 +665,6 @@ class Instrumenter {
   }
 
   instrumentDom() {
-    const self = this;
     this.addListener(
       'dom',
       this._window,
@@ -701,12 +706,12 @@ class Instrumenter {
         contentLoaded: this.handleContentLoaded,
       }[name].call(this, evt);
     } catch (exc) {
-      console.log(`${name} handler error`, evt, exc, exc.stack);
+      logger.log(`${name} handler error`, evt, exc, exc.stack);
     }
   }
 
-  handleContentLoaded(evt) {
-    const replayId = this.rollbar.triggerReplay({
+  handleContentLoaded(_evt) {
+    this.rollbar.triggerReplay({
       type: 'navigation',
       path: new URL(this._location.href).pathname,
     });
@@ -738,13 +743,12 @@ class Instrumenter {
     });
   }
 
-  handleForm(evt) {
+  handleForm(_evt) {
     // TODO: implement form event handling
-    const type = evt.type;
-    const elementString = evt.target?.window
-      ? 'window'
-      : domUtil.elementString(evt.target);
-    console.log('handleForm', type, elementString, evt);
+    //const type = evt.type;
+    //const elementString = evt.target?.window
+    //  ? 'window'
+    //  : domUtil.elementString(evt.target);
   }
 
   handleResize(evt) {
@@ -928,7 +932,7 @@ class Instrumenter {
         return function () {
           const url = arguments.length > 2 ? arguments[2] : undefined;
           if (url) {
-            self.handleUrlChange(self._lastHref, url + '');
+            self.handleUrlChange(self._lastHref, String(url));
           }
           return orig.apply(this, arguments);
         };
@@ -956,7 +960,7 @@ class Instrumenter {
       from = parsedFrom.path + (parsedFrom.hash || '');
     }
     this.telemeter.captureNavigation(from, to, null, _.now());
-    const replayId = this.rollbar.triggerReplay({
+    this.rollbar.triggerReplay({
       type: 'navigation',
       path: to,
     });

package/src/browser/transforms.js

@@ -1,6 +1,6 @@
-import * as _ from '../utility.js';
 import errorParser from '../errorParser.js';
 import logger from '../logger.js';
+import * as _ from '../utility.js';
 
 function handleDomException(item, options, callback) {
   if (item.err && errorParser.Stack(item.err).name === 'DOMException') {
@@ -181,9 +181,9 @@ function addBodyMessage(item, options, callback) {
   callback(null, item);
 }
 
-function stackFromItem(item) {
+function stackFromItem(item, stackInfo = null) {
   // Transform a TraceKit stackInfo object into a Rollbar trace
-  var stack = item.stackInfo.stack;
+  let stack = (stackInfo || item.stackInfo).stack;
   if (
     stack &&
     stack.length === 0 &&
@@ -230,7 +230,7 @@ function addBodyTrace(item, options, callback) {
 function buildTrace(item, stackInfo, options) {
   var description = item && item.data.description;
   var custom = item && item.custom;
-  var stack = stackFromItem(item);
+  var stack = stackFromItem(item, stackInfo);
 
   var guess = errorParser.guessErrorClass(stackInfo.message);
   var className = errorClass(stackInfo, guess[0], options);

package/src/browser/transport/xhr.js

@@ -1,7 +1,7 @@
 /*global XDomainRequest*/
 
-import * as _ from '../../utility.js';
 import logger from '../../logger.js';
+import * as _ from '../../utility.js';
 
 function makeXhrRequest({
   accessToken,
@@ -97,7 +97,7 @@ function makeXhrRequest({
 
       request.onreadystatechange = onreadystatechange;
       request.send(payload);
-    } catch (e1) {
+    } catch (_e1) {
       // Sending using the normal xmlhttprequest object didn't work, try XDomainRequest
       if (typeof XDomainRequest !== 'undefined') {
         // Assume we are in a really old browser which has a bunch of limitations:
@@ -121,7 +121,7 @@ function makeXhrRequest({
         }
 
         var xdomainrequest = new XDomainRequest();
-        xdomainrequest.onprogress = function () {};
+        xdomainrequest.onprogress = () => {};
         xdomainrequest.ontimeout = function () {
           var msg = 'Request timed out';
           var code = 'ETIMEDOUT';
@@ -169,7 +169,7 @@ function _createXMLHTTPObject() {
     try {
       xmlhttp = factories[i]();
       break;
-    } catch (e) {
+    } catch (_e) {
       // pass
     }
   }

package/src/browser/transport.js

@@ -1,4 +1,5 @@
 import * as _ from '../utility.js';
+
 import makeFetchRequest from './transport/fetch.js';
 import makeXhrRequest from './transport/xhr.js';
 
@@ -32,7 +33,7 @@ Transport.prototype.get = function (
   requestFactory,
 ) {
   if (!callback || !_.isFunction(callback)) {
-    callback = function () {};
+    callback = () => {};
   }
   _.addParamsAndAccessTokenToPath(accessToken, options, params);
 
@@ -58,7 +59,7 @@ Transport.prototype.post = function ({
   requestFactory,
 }) {
   if (!callback || !_.isFunction(callback)) {
-    callback = function () {};
+    callback = () => {};
   }
 
   if (!payload) {
@@ -76,14 +77,13 @@ Transport.prototype.post = function ({
     return callback(stringifyResult.error);
   }
 
-  var payload = stringifyResult.value;
   var method = 'POST';
   var url = _.formatUrl(options);
   this._makeZoneRequest({
     accessToken,
     url,
     method,
-    payload,
+    payload: stringifyResult.value,
     headers,
     callback,
     requestFactory,
@@ -100,7 +100,7 @@ Transport.prototype.postJsonPayload = function (
   requestFactory,
 ) {
   if (!callback || !_.isFunction(callback)) {
-    callback = function () {};
+    callback = () => {};
   }
 
   var method = 'POST';
@@ -122,8 +122,8 @@ Transport.prototype.postJsonPayload = function (
 // This is equivalent to `NgZone.runOutsideAngular` in Angular.
 Transport.prototype._makeZoneRequest = function () {
   var gWindow =
-    (typeof window != 'undefined' && window) ||
-    (typeof self != 'undefined' && self);
+    (typeof window !== 'undefined' && window) ||
+    (typeof self !== 'undefined' && self);
   // Whenever zone.js is loaded and `Zone` is exposed globally, access
   // the root zone to ensure that requests are always made within it.
   // This approach is framework-agnostic, regardless of which
@@ -132,9 +132,8 @@ Transport.prototype._makeZoneRequest = function () {
   var args = Array.prototype.slice.call(arguments);
 
   if (rootZone) {
-    var self = this;
-    rootZone.run(function () {
-      self._makeRequest.apply(undefined, args);
+    rootZone.run(() => {
+      this._makeRequest.apply(undefined, args);
     });
   } else {
     this._makeRequest.apply(undefined, args);

package/src/browser/wrapGlobals.js

@@ -1,3 +1,5 @@
+import { hasOwn } from '../utility.js';
+
 function wrapGlobals(window, handler, shim) {
   if (!window) {
     return;
@@ -18,10 +20,7 @@ function wrapGlobals(window, handler, shim) {
 }
 
 function _extendListenerPrototype(handler, prototype, shim) {
-  if (
-    prototype.hasOwnProperty &&
-    prototype.hasOwnProperty('addEventListener')
-  ) {
+  if (hasOwn(prototype, 'addEventListener')) {
     var oldAddEventListener = prototype.addEventListener;
     while (
       oldAddEventListener._rollbarOldAdd &&

package/src/defaults.js

@@ -1,7 +1,7 @@
 /**
  * Default options shared across platforms
  */
-export const version = '3.0.0-beta.5';
+export const version = '3.0.0';
 export const endpoint = 'api.rollbar.com/api/1/item/';
 export const logLevel = 'debug';
 export const reportLevel = 'debug';

package/src/errorParser.js

@@ -37,7 +37,7 @@ function Stack(exception, skip) {
 
     try {
       parserStack = parseErrorStack(exception);
-    } catch (e) {
+    } catch (_e) {
       parserStack = [];
     }
 

package/src/logger.js

@@ -20,6 +20,7 @@ const logger = {
 
       args.unshift('Rollbar:');
 
+      // eslint-disable-next-line no-console
       console[level].apply(console, args);
     };
   },

package/src/notifier.js

@@ -1,122 +1,124 @@
-import * as _ from './utility.js';
+import { merge, isFunction } from './utility.js';
 
 /*
- * Notifier - the internal object responsible for delegating between the client exposed API, the
- * chain of transforms necessary to turn an item into something that can be sent to Rollbar, and the
+ * Notifier - delegates between the client exposed API, the chain of transforms
+ * necessary to turn an item into something that can be sent to Rollbar, and the
  * queue which handles the communcation with the Rollbar API servers.
- *
- * @param queue - an object that conforms to the interface: addItem(item, callback)
- * @param options - an object representing the options to be set for this notifier, this should have
- * any defaults already set by the caller
  */
-function Notifier(queue, options) {
-  this.queue = queue;
-  this.options = options;
-  this.transforms = [];
-  this.diagnostic = {};
-}
-
-/*
- * configure - updates the options for this notifier with the passed in object
- *
- * @param options - an object which gets merged with the current options set on this notifier
- * @returns this
- */
-Notifier.prototype.configure = function (options) {
-  this.queue && this.queue.configure(options);
-  var oldOptions = this.options;
-  this.options = _.merge(oldOptions, options);
-  return this;
-};
-
-/*
- * addTransform - adds a transform onto the end of the queue of transforms for this notifier
- *
- * @param transform - a function which takes three arguments:
- *    * item: An Object representing the data to eventually be sent to Rollbar
- *    * options: The current value of the options for this notifier
- *    * callback: function(err: (Null|Error), item: (Null|Object)) the transform must call this
- *    callback with a null value for error if it wants the processing chain to continue, otherwise
- *    with an error to terminate the processing. The item should be the updated item after this
- *    transform is finished modifying it.
- */
-Notifier.prototype.addTransform = function (transform) {
-  if (_.isFunction(transform)) {
-    this.transforms.push(transform);
+export default class Notifier {
+  /**
+   *
+   * @param {Object} queue - an object that conforms to the interface:
+   *    `addItem(item, callback)`
+   * @param {Object} options - an object representing the options to be set for
+   *    this notifier, this should have any defaults already set by the caller
+   */
+  constructor(queue, options) {
+    this.queue = queue;
+    this.options = options;
+    this.transforms = [];
+    this.diagnostic = {};
   }
-  return this;
-};
 
-/*
- * log - the internal log function which applies the configured transforms and then pushes onto the
- * queue to be sent to the backend.
- *
- * @param item - An object with the following structure:
- *    message [String] - An optional string to be sent to rollbar
- *    error [Error] - An optional error
- *
- * @param callback - A function of type function(err, resp) which will be called with exactly one
- * null argument and one non-null argument. The callback will be called once, either during the
- * transform stage if an error occurs inside a transform, or in response to the communication with
- * the backend. The second argument will be the response from the backend in case of success.
- */
-Notifier.prototype.log = function (item, callback) {
-  if (!callback || !_.isFunction(callback)) {
-    callback = function () {};
+  /**
+   * configure - updates the options for this notifier with the passed in object
+   *
+   * @param {Object} options - an object which gets merged with the current
+   *    options set on this notifier
+   * @returns this
+   */
+  configure(options) {
+    this.queue?.configure(options);
+    const oldOptions = this.options;
+    this.options = merge(oldOptions, options);
+    return this;
   }
 
-  if (!this.options.enabled) {
-    return callback(new Error('Rollbar is not enabled'));
+  /**
+   * Adds a transform onto the end of the queue of transforms for this notifier
+   *
+   * @param {Function} transform - a function which takes three arguments:
+   *    - item: An Object representing the data to eventually be sent to Rollbar
+   *    - options: The current value of the options for this notifier
+   *    - callback: `function(err: (Null|Error), item: (Null|Object))` the
+   *      transform must call this callback with a null value for error if it
+   *      wants the processing chain to continue, otherwise with an error to
+   *      terminate the processing. The item should be the updated item after
+   *      this transform is finished modifying it.
+   */
+  addTransform(transform) {
+    if (isFunction(transform)) {
+      this.transforms.push(transform);
+    }
+    return this;
   }
 
-  this.queue.addPendingItem(item);
-  var originalError = item.err;
-  this._applyTransforms(
-    item,
-    function (err, i) {
+  /**
+   * The internal log function which applies the configured transforms and then
+   * pushes onto the queue to be sent to the backend.
+   *
+   * @param {Object} item - An object with the following structure:
+   *    - message [String] - An optional string to be sent to rollbar
+   *    - error [Error] - An optional error
+   * @param {Function} callback - A function of type `function(err, resp)` which
+   *    will be called with exactly one null argument and one non-null argument.
+   *    The callback will be called once, either during the transform stage if
+   *    an error occurs inside a transform, or in response to the communication
+   *    with the backend. The second argument will be the response from the
+   *    backend in case of success.
+   */
+  log(item, callback) {
+    callback = isFunction(callback) ? callback : () => {};
+
+    if (!this.options.enabled) {
+      return callback(new Error('Rollbar is not enabled'), null);
+    }
+
+    this.queue.addPendingItem(item);
+    const originalError = item.err;
+    this._applyTransforms(item, (err, i) => {
       if (err) {
         this.queue.removePendingItem(item);
         return callback(err, null);
       }
       this.queue.addItem(i, callback, originalError, item);
-    }.bind(this),
-  );
-};
-
-/* Internal */
+    });
+  }
 
-/*
- * _applyTransforms - Applies the transforms that have been added to this notifier sequentially. See
- * `addTransform` for more information.
- *
- * @param item - An item to be transformed
- * @param callback - A function of type function(err, item) which will be called with a non-null
- * error and a null item in the case of a transform failure, or a null error and non-null item after
- * all transforms have been applied.
- */
-Notifier.prototype._applyTransforms = function (item, callback) {
-  var transformIndex = -1;
-  var transformsLength = this.transforms.length;
-  var transforms = this.transforms;
-  var options = this.options;
+  /* Internal */
 
-  var cb = function (err, i) {
-    if (err) {
-      callback(err, null);
-      return;
-    }
+  /**
+   * Applies the transforms that have been added to this notifier sequentially.
+   * See `addTransform` for more information.
+   *
+   * @param {Object} item - An item to be transformed
+   * @param {Function} callback - A function of type `function(err, item)` which
+   *    will be called with a non-null error and a null item in the case of a
+   *    transform failure, or a null error and non-null item after all
+   *    transforms have been applied.
+   */
+  _applyTransforms(item, callback) {
+    let transformIndex = -1;
+    const transformsLength = this.transforms.length;
+    const transforms = this.transforms;
+    const options = this.options;
 
-    transformIndex++;
+    const next = (err, i) => {
+      if (err) {
+        callback(err, null);
+        return;
+      }
 
-    if (transformIndex === transformsLength) {
-      callback(null, i);
-      return;
-    }
+      transformIndex++;
 
-    transforms[transformIndex](i, options, cb);
-  };
+      if (transformIndex === transformsLength) {
+        callback(null, i);
+        return;
+      }
 
-  cb(null, item);
-};
+      transforms[transformIndex](i, options, next);
+    };
 
-export default Notifier;
+    next(null, item);
+  }
+}

package/src/predicates.js

@@ -14,7 +14,7 @@ function checkLevel(item, settings) {
 
 function userCheckIgnore(logger) {
   return function (item, settings) {
-    var isUncaught = !!item._isUncaught;
+    var isUncaught = Boolean(item._isUncaught);
     delete item._isUncaught;
     var args = item._originalArgs;
     delete item._originalArgs;
@@ -168,7 +168,7 @@ function messageIsIgnored(logger) {
         }
       }
     } catch (
-      e
+      _e
       /* istanbul ignore next */
     ) {
       settings.ignoredMessages = null;
@@ -190,8 +190,7 @@ function messagesFromItem(item) {
   // So here we preserve the ability to collect strings from any combination of these keys.
   if (body.trace_chain) {
     var traceChain = body.trace_chain;
-    for (var i = 0; i < traceChain.length; i++) {
-      var trace = traceChain[i];
+    for (const trace of traceChain) {
       messages.push(_.get(trace, 'exception.message'));
     }
   }