rollbar 2.26.3 → 3.0.0-alpha.1

package/src/browser/transforms.js

@@ -3,7 +3,7 @@ var errorParser = require('../errorParser');
 var logger = require('./logger');
 
 function handleDomException(item, options, callback) {
-  if(item.err && errorParser.Stack(item.err).name === 'DOMException') {
+  if (item.err && errorParser.Stack(item.err).name === 'DOMException') {
     var originalError = new Error();
     originalError.name = item.err.name;
     originalError.message = item.err.message;
@@ -18,7 +18,9 @@ function handleItemWithError(item, options, callback) {
   item.data = item.data || {};
   if (item.err) {
     try {
-      item.stackInfo = item.err._savedStackTrace || errorParser.parse(item.err, item.skipFrames);
+      item.stackInfo =
+        item.err._savedStackTrace ||
+        errorParser.parse(item.err, item.skipFrames);
 
       if (options.addErrorContext) {
         addErrorContext(item);
@@ -26,7 +28,11 @@ function handleItemWithError(item, options, callback) {
     } catch (e) {
       logger.error('Error while parsing the error object.', e);
       try {
-        item.message = item.err.message || item.err.description || item.message || String(item.err);
+        item.message =
+          item.err.message ||
+          item.err.description ||
+          item.message ||
+          String(item.err);
       } catch (e2) {
         item.message = String(item.err) || String(e2);
       }
@@ -58,7 +64,8 @@ function ensureItemHasSomethingToSay(item, options, callback) {
 }
 
 function addBaseInfo(item, options, callback) {
-  var environment = (options.payload && options.payload.environment) || options.environment;
+  var environment =
+    (options.payload && options.payload.environment) || options.environment;
   item.data = _.merge(item.data, {
     environment: environment,
     level: item.level,
@@ -70,15 +77,15 @@ function addBaseInfo(item, options, callback) {
     uuid: item.uuid,
     notifier: {
       name: 'rollbar-browser-js',
-      version: options.version
+      version: options.version,
     },
-    custom: item.custom
+    custom: item.custom,
   });
   callback(null, item);
 }
 
 function addRequestInfo(window) {
-  return function(item, options, callback) {
+  return function (item, options, callback) {
     var requestInfo = {};
 
     if (window && window.location) {
@@ -103,7 +110,7 @@ function addRequestInfo(window) {
 }
 
 function addClientInfo(window) {
-  return function(item, options, callback) {
+  return function (item, options, callback) {
     if (!window) {
       return callback(null, item);
     }
@@ -118,25 +125,25 @@ function addClientInfo(window) {
         cookie_enabled: nav.cookieEnabled,
         screen: {
           width: scr.width,
-          height: scr.height
-        }
-      }
+          height: scr.height,
+        },
+      },
     });
     callback(null, item);
   };
 }
 
 function addPluginInfo(window) {
-  return function(item, options, callback) {
+  return function (item, options, callback) {
     if (!window || !window.navigator) {
       return callback(null, item);
     }
     var plugins = [];
     var navPlugins = window.navigator.plugins || [];
     var cur;
-    for (var i=0, l=navPlugins.length; i < l; ++i) {
+    for (var i = 0, l = navPlugins.length; i < l; ++i) {
       cur = navPlugins[i];
-      plugins.push({name: cur.name, description: cur.description});
+      plugins.push({ name: cur.name, description: cur.description });
     }
     _.set(item, 'data.client.javascript.plugins', plugins);
     callback(null, item);
@@ -163,21 +170,26 @@ function addBodyMessage(item, options, callback) {
     message = 'Item sent with null or missing arguments.';
   }
   var result = {
-    body: message
+    body: message,
   };
 
   if (custom) {
     result.extra = _.merge(custom);
   }
 
-  _.set(item, 'data.body', {message: result});
+  _.set(item, 'data.body', { message: result });
   callback(null, item);
 }
 
 function stackFromItem(item) {
   // Transform a TraceKit stackInfo object into a Rollbar trace
   var stack = item.stackInfo.stack;
-  if (stack && stack.length === 0 && item._unhandledStackInfo && item._unhandledStackInfo.stack) {
+  if (
+    stack &&
+    stack.length === 0 &&
+    item._unhandledStackInfo &&
+    item._unhandledStackInfo.stack
+  ) {
     stack = item._unhandledStackInfo.stack;
   }
   return stack;
@@ -193,7 +205,7 @@ function addBodyTraceChain(item, options, callback) {
     traces.push(trace);
   }
 
-  _.set(item, 'data.body', {trace_chain: traces});
+  _.set(item, 'data.body', { trace_chain: traces });
   callback(null, item);
 }
 
@@ -202,7 +214,7 @@ function addBodyTrace(item, options, callback) {
 
   if (stack) {
     var trace = buildTrace(item, item.stackInfo, options);
-    _.set(item, 'data.body', {trace: trace});
+    _.set(item, 'data.body', { trace: trace });
     callback(null, item);
   } else {
     var stackInfo = item.stackInfo;
@@ -225,9 +237,9 @@ function buildTrace(item, stackInfo, options) {
   var message = guess[1];
   var trace = {
     exception: {
-      'class': className,
-      message: message
-    }
+      class: className,
+      message: message,
+    },
   };
 
   if (description) {
@@ -253,13 +265,20 @@ function buildTrace(item, stackInfo, options) {
       frame = {
         filename: stackFrame.url ? _.sanitizeUrl(stackFrame.url) : '(unknown)',
         lineno: stackFrame.line || null,
-        method: (!stackFrame.func || stackFrame.func === '?') ? '[anonymous]' : stackFrame.func,
-        colno: stackFrame.column
+        method:
+          !stackFrame.func || stackFrame.func === '?'
+            ? '[anonymous]'
+            : stackFrame.func,
+        colno: stackFrame.column,
       };
       if (options.sendFrameUrl) {
         frame.url = stackFrame.url;
       }
-      if (frame.method && frame.method.endsWith && frame.method.endsWith('_rollbar_wrapped')) {
+      if (
+        frame.method &&
+        frame.method.endsWith &&
+        frame.method.endsWith('_rollbar_wrapped')
+      ) {
         continue;
       }
 
@@ -322,7 +341,7 @@ function addScrubber(scrubFn) {
       item.data = scrubFn(item.data, scrubFields, scrubPaths);
     }
     callback(null, item);
-  }
+  };
 }
 
 module.exports = {
@@ -334,5 +353,5 @@ module.exports = {
   addClientInfo: addClientInfo,
   addPluginInfo: addPluginInfo,
   addBody: addBody,
-  addScrubber: addScrubber
+  addScrubber: addScrubber,
 };

package/src/browser/transport/fetch.js

@@ -5,9 +5,11 @@ function makeFetchRequest(accessToken, url, method, data, callback, timeout) {
   var controller;
   var timeoutId;
 
-  if(_.isFiniteNumber(timeout)) {
+  if (_.isFiniteNumber(timeout)) {
     controller = new AbortController();
-    timeoutId = setTimeout(function () {controller.abort()}, timeout);
+    timeoutId = setTimeout(function () {
+      controller.abort();
+    }, timeout);
   }
 
   fetch(url, {
@@ -15,21 +17,31 @@ function makeFetchRequest(accessToken, url, method, data, callback, timeout) {
     headers: {
       'Content-Type': 'application/json',
       'X-Rollbar-Access-Token': accessToken,
-      signal: controller && controller.signal
+      signal: controller && controller.signal,
     },
     body: data,
   })
-  .then(function (response) {
-    if (timeoutId) clearTimeout(timeoutId);
-    return response.json();
-  })
-  .then(function (data) {
-    callback(null, data);
-  })
-  .catch(function (error) {
-    logger.error(error.message);
-    callback(error);
-  });
+    .then(function (response) {
+      if (timeoutId) clearTimeout(timeoutId);
+      const respHeaders = response.headers;
+      const headers = {
+        'Rollbar-Replay-Enabled': respHeaders.get(
+          'Rollbar-Replay-Enabled'
+        ),
+        'Rollbar-Replay-RateLimit-Remaining': respHeaders.get(
+          'Rollbar-Replay-RateLimit-Remaining'
+        ),
+        'Rollbar-Replay-RateLimit-Reset': respHeaders.get(
+          'Rollbar-Replay-RateLimit-Reset'
+        ),
+      };
+      const json = response.json();
+      callback(null, json, headers);
+    })
+    .catch(function (error) {
+      logger.error(error.message);
+      callback(error);
+    });
 }
 
 module.exports = makeFetchRequest;

package/src/browser/transport/xhr.js

@@ -3,7 +3,15 @@
 var _ = require('../../utility');
 var logger = require('../logger');
 
-function makeXhrRequest(accessToken, url, method, data, callback, requestFactory, timeout) {
+function makeXhrRequest(
+  accessToken,
+  url,
+  method,
+  data,
+  callback,
+  requestFactory,
+  timeout,
+) {
   var request;
   if (requestFactory) {
     request = requestFactory();
@@ -16,19 +24,31 @@ function makeXhrRequest(accessToken, url, method, data, callback, requestFactory
   }
   try {
     try {
-      var onreadystatechange = function() {
+      var onreadystatechange = function () {
         try {
           if (onreadystatechange && request.readyState === 4) {
             onreadystatechange = undefined;
 
             var parseResponse = _.jsonParse(request.responseText);
             if (_isSuccess(request)) {
-              callback(parseResponse.error, parseResponse.value);
+              const headers = {
+                'Rollbar-Replay-Enabled': request.getResponseHeader(
+                  'Rollbar-Replay-Enabled'
+                ),
+                'Rollbar-Replay-RateLimit-Remaining': request.getResponseHeader(
+                  'Rollbar-Replay-RateLimit-Remaining'
+                ),
+                'Rollbar-Replay-RateLimit-Reset': request.getResponseHeader(
+                  'Rollbar-Replay-RateLimit-Reset'
+                ),
+              }
+              callback(parseResponse.error, parseResponse.value, headers);
               return;
             } else if (_isNormalFailure(request)) {
               if (request.status === 403) {
                 // likely caused by using a server access token
-                var message = parseResponse.value && parseResponse.value.message;
+                var message =
+                  parseResponse.value && parseResponse.value.message;
                 logger.error(message);
               }
               // return valid http status codes
@@ -37,7 +57,8 @@ function makeXhrRequest(accessToken, url, method, data, callback, requestFactory
               // IE will return a status 12000+ on some sort of connection failure,
               // so we return a blank error
               // http://msdn.microsoft.com/en-us/library/aa383770%28VS.85%29.aspx
-              var msg = 'XHR response had no status code (likely connection failure)';
+              var msg =
+                'XHR response had no status code (likely connection failure)';
               callback(_newRetriableError(msg));
             }
           }
@@ -61,7 +82,7 @@ function makeXhrRequest(accessToken, url, method, data, callback, requestFactory
         request.setRequestHeader('X-Rollbar-Access-Token', accessToken);
       }
 
-      if(_.isFiniteNumber(timeout)) {
+      if (_.isFiniteNumber(timeout)) {
         request.timeout = timeout;
       }
 
@@ -70,31 +91,37 @@ function makeXhrRequest(accessToken, url, method, data, callback, requestFactory
     } 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:
         // http://blogs.msdn.com/b/ieinternals/archive/2010/05/13/xdomainrequest-restrictions-limitations-and-workarounds.aspx
 
         // Extreme paranoia: if we have XDomainRequest then we have a window, but just in case
         if (!window || !window.location) {
-          return callback(new Error('No window available during request, unknown environment'));
+          return callback(
+            new Error(
+              'No window available during request, unknown environment',
+            ),
+          );
         }
 
         // If the current page is http, try and send over http
-        if (window.location.href.substring(0, 5) === 'http:' && url.substring(0, 5) === 'https') {
+        if (
+          window.location.href.substring(0, 5) === 'http:' &&
+          url.substring(0, 5) === 'https'
+        ) {
           url = 'http' + url.substring(5);
         }
 
         var xdomainrequest = new XDomainRequest();
-        xdomainrequest.onprogress = function() {};
-        xdomainrequest.ontimeout = function() {
+        xdomainrequest.onprogress = function () {};
+        xdomainrequest.ontimeout = function () {
           var msg = 'Request timed out';
           var code = 'ETIMEDOUT';
           callback(_newRetriableError(msg, code));
         };
-        xdomainrequest.onerror = function() {
+        xdomainrequest.onerror = function () {
           callback(new Error('Error during request'));
         };
-        xdomainrequest.onload = function() {
+        xdomainrequest.onload = function () {
           var parseResponse = _.jsonParse(xdomainrequest.responseText);
           callback(parseResponse.error, parseResponse.value);
         };
@@ -124,7 +151,7 @@ function _createXMLHTTPObject() {
     },
     function () {
       return new ActiveXObject('Microsoft.XMLHTTP');
-    }
+    },
   ];
   var xmlhttp;
   var i;

package/src/browser/transport.js

@@ -24,22 +24,41 @@ function Transport(truncation) {
   this.truncation = truncation;
 }
 
-Transport.prototype.get = function(accessToken, options, params, callback, requestFactory) {
+Transport.prototype.get = function (
+  accessToken,
+  options,
+  params,
+  callback,
+  requestFactory,
+) {
   if (!callback || !_.isFunction(callback)) {
-    callback = function() {};
+    callback = function () {};
   }
   _.addParamsAndAccessTokenToPath(accessToken, options, params);
 
   var method = 'GET';
   var url = _.formatUrl(options);
   this._makeZoneRequest(
-    accessToken, url, method, null, callback, requestFactory, options.timeout, options.transport
+    accessToken,
+    url,
+    method,
+    null,
+    callback,
+    requestFactory,
+    options.timeout,
+    options.transport,
   );
-}
-
-Transport.prototype.post = function(accessToken, options, payload, callback, requestFactory) {
+};
+
+Transport.prototype.post = function (
+  accessToken,
+  options,
+  payload,
+  callback,
+  requestFactory,
+) {
   if (!callback || !_.isFunction(callback)) {
-    callback = function() {};
+    callback = function () {};
   }
 
   if (!payload) {
@@ -47,10 +66,11 @@ Transport.prototype.post = function(accessToken, options, payload, callback, req
   }
 
   var stringifyResult;
-  if (this.truncation) {
+  // Check payload.body to ensure only items are truncated.
+  if (this.truncation && payload.body) {
     stringifyResult = this.truncation.truncate(payload);
   } else {
-    stringifyResult = _.stringify(payload)
+    stringifyResult = _.stringify(payload);
   }
   if (stringifyResult.error) {
     return callback(stringifyResult.error);
@@ -60,34 +80,57 @@ Transport.prototype.post = function(accessToken, options, payload, callback, req
   var method = 'POST';
   var url = _.formatUrl(options);
   this._makeZoneRequest(
-    accessToken, url, method, writeData, callback, requestFactory, options.timeout, options.transport
+    accessToken,
+    url,
+    method,
+    writeData,
+    callback,
+    requestFactory,
+    options.timeout,
+    options.transport,
   );
-}
-
-Transport.prototype.postJsonPayload = function (accessToken, options, jsonPayload, callback, requestFactory) {
+};
+
+Transport.prototype.postJsonPayload = function (
+  accessToken,
+  options,
+  jsonPayload,
+  callback,
+  requestFactory,
+) {
   if (!callback || !_.isFunction(callback)) {
-    callback = function() {};
+    callback = function () {};
   }
 
   var method = 'POST';
   var url = _.formatUrl(options);
   this._makeZoneRequest(
-    accessToken, url, method, jsonPayload, callback, requestFactory, options.timeout, options.transport
+    accessToken,
+    url,
+    method,
+    jsonPayload,
+    callback,
+    requestFactory,
+    options.timeout,
+    options.transport,
   );
-}
-
+};
 
-// Wraps _makeRequest and if Angular 2+ Zone.js is detected, changes scope
-// so Angular change detection isn't triggered on each API call.
-// This is the equivalent of runOutsideAngular().
-//
+// Wraps `_makeRequest` if zone.js is being used, ensuring that Rollbar
+// API calls are not intercepted by any child forked zones.
+// This is equivalent to `NgZone.runOutsideAngular` in Angular.
 Transport.prototype._makeZoneRequest = function () {
-  var gWindow = ((typeof window != 'undefined') && window) || ((typeof self != 'undefined') && self);
-  var currentZone = gWindow && gWindow.Zone && gWindow.Zone.current;
+  var gWindow =
+    (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
+  // framework zone.js is used with.
+  var rootZone = gWindow && gWindow.Zone && gWindow.Zone.root;
   var args = Array.prototype.slice.call(arguments);
 
-  if (currentZone && currentZone._name === 'angular') {
-    var rootZone = currentZone._parent;
+  if (rootZone) {
     var self = this;
     rootZone.run(function () {
       self._makeRequest.apply(undefined, args);
@@ -95,31 +138,48 @@ Transport.prototype._makeZoneRequest = function () {
   } else {
     this._makeRequest.apply(undefined, args);
   }
-}
+};
 
 Transport.prototype._makeRequest = function (
-  accessToken, url, method, data, callback, requestFactory, timeout, transport
+  accessToken,
+  url,
+  method,
+  data,
+  callback,
+  requestFactory,
+  timeout,
+  transport,
 ) {
   if (typeof RollbarProxy !== 'undefined') {
     return _proxyRequest(data, callback);
   }
 
   if (transport === 'fetch') {
-    makeFetchRequest(accessToken, url, method, data, callback, timeout)
+    makeFetchRequest(accessToken, url, method, data, callback, timeout);
   } else {
-    makeXhrRequest(accessToken, url, method, data, callback, requestFactory, timeout)
+    makeXhrRequest(
+      accessToken,
+      url,
+      method,
+      data,
+      callback,
+      requestFactory,
+      timeout,
+    );
   }
-}
+};
 
 /* global RollbarProxy */
 function _proxyRequest(json, callback) {
   var rollbarProxy = new RollbarProxy();
   rollbarProxy.sendJsonPayload(
     json,
-    function(_msg) { /* do nothing */ }, // eslint-disable-line no-unused-vars
-    function(err) {
+    function (_msg) {
+      /* do nothing */
+    }, // eslint-disable-line no-unused-vars
+    function (err) {
       callback(new Error(err));
-    }
+    },
   );
 }
 

package/src/browser/url.js

@@ -1,24 +1,32 @@
 // See https://nodejs.org/docs/latest/api/url.html
 function parse(url) {
   var result = {
-    protocol: null, auth: null, host: null, path: null,
-    hash: null, href: url, hostname: null, port: null,
-    pathname: null, search: null, query: null
+    protocol: null,
+    auth: null,
+    host: null,
+    path: null,
+    hash: null,
+    href: url,
+    hostname: null,
+    port: null,
+    pathname: null,
+    search: null,
+    query: null,
   };
 
   var i, last;
   i = url.indexOf('//');
   if (i !== -1) {
-    result.protocol = url.substring(0,i);
-    last = i+2;
+    result.protocol = url.substring(0, i);
+    last = i + 2;
   } else {
     last = 0;
   }
-  
+
   i = url.indexOf('@', last);
   if (i !== -1) {
     result.auth = url.substring(last, i);
-    last = i+1;
+    last = i + 1;
   }
 
   i = url.indexOf('/', last);
@@ -75,5 +83,5 @@ function parse(url) {
 }
 
 module.exports = {
-  parse: parse
+  parse: parse,
 };

package/src/browser/wrapGlobals.js

@@ -1,7 +1,12 @@
 function wrapGlobals(window, handler, shim) {
-  if (!window) { return; }
+  if (!window) {
+    return;
+  }
   // Adapted from https://github.com/bugsnag/bugsnag-js
-  var globals = 'EventTarget,Window,Node,ApplicationCache,AudioTrackList,ChannelMergerNode,CryptoOperation,EventSource,FileReader,HTMLUnknownElement,IDBDatabase,IDBRequest,IDBTransaction,KeyOperation,MediaController,MessagePort,ModalWindow,Notification,SVGElementInstance,Screen,TextTrack,TextTrackCue,TextTrackList,WebSocket,WebSocketWorker,Worker,XMLHttpRequest,XMLHttpRequestEventTarget,XMLHttpRequestUpload'.split(',');
+  var globals =
+    'EventTarget,Window,Node,ApplicationCache,AudioTrackList,ChannelMergerNode,CryptoOperation,EventSource,FileReader,HTMLUnknownElement,IDBDatabase,IDBRequest,IDBTransaction,KeyOperation,MediaController,MessagePort,ModalWindow,Notification,SVGElementInstance,Screen,TextTrack,TextTrackCue,TextTrackList,WebSocket,WebSocketWorker,Worker,XMLHttpRequest,XMLHttpRequestEventTarget,XMLHttpRequestUpload'.split(
+      ',',
+    );
   var i, global;
   for (i = 0; i < globals.length; ++i) {
     global = globals[i];
@@ -13,12 +18,18 @@ function wrapGlobals(window, handler, shim) {
 }
 
 function _extendListenerPrototype(handler, prototype, shim) {
-  if (prototype.hasOwnProperty && prototype.hasOwnProperty('addEventListener')) {
+  if (
+    prototype.hasOwnProperty &&
+    prototype.hasOwnProperty('addEventListener')
+  ) {
     var oldAddEventListener = prototype.addEventListener;
-    while (oldAddEventListener._rollbarOldAdd && oldAddEventListener.belongsToShim) {
+    while (
+      oldAddEventListener._rollbarOldAdd &&
+      oldAddEventListener.belongsToShim
+    ) {
       oldAddEventListener = oldAddEventListener._rollbarOldAdd;
     }
-    var addFn = function(event, callback, bubble) {
+    var addFn = function (event, callback, bubble) {
       oldAddEventListener.call(this, event, handler.wrap(callback), bubble);
     };
     addFn._rollbarOldAdd = oldAddEventListener;
@@ -26,11 +37,19 @@ function _extendListenerPrototype(handler, prototype, shim) {
     prototype.addEventListener = addFn;
 
     var oldRemoveEventListener = prototype.removeEventListener;
-    while (oldRemoveEventListener._rollbarOldRemove && oldRemoveEventListener.belongsToShim) {
+    while (
+      oldRemoveEventListener._rollbarOldRemove &&
+      oldRemoveEventListener.belongsToShim
+    ) {
       oldRemoveEventListener = oldRemoveEventListener._rollbarOldRemove;
     }
-    var removeFn = function(event, callback, bubble) {
-      oldRemoveEventListener.call(this, event, callback && callback._rollbar_wrapped || callback, bubble);
+    var removeFn = function (event, callback, bubble) {
+      oldRemoveEventListener.call(
+        this,
+        event,
+        (callback && callback._rollbar_wrapped) || callback,
+        bubble,
+      );
     };
     removeFn._rollbarOldRemove = oldRemoveEventListener;
     removeFn.belongsToShim = shim;