rollbar 2.25.2 → 2.26.0

package/index.d.ts

@@ -75,7 +75,7 @@ declare namespace Rollbar {
         hostBlockList?: string[];
         hostWhiteList?: string[]; // deprecated
         hostSafeList?: string[];
-        ignoredMessages?: string[];
+        ignoredMessages?: (string | RegExp)[];
         ignoreDuplicateErrors?: boolean;
         includeItemsInTelemetry?: boolean;
         inspectAnonymousErrors?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rollbar",
-  "version": "2.25.2",
+  "version": "2.26.0",
   "repository": {
     "type": "git",
     "url": "http://github.com/rollbar/rollbar.js"

package/src/apiUtility.js

@@ -25,6 +25,7 @@ function getTransportFromOptions(options, defaults, url) {
   var path = defaults.path;
   var search = defaults.search;
   var timeout = options.timeout;
+  var transport = detectTransport(options)
 
   var proxy = options.proxy;
   if (options.endpoint) {
@@ -42,16 +43,26 @@ function getTransportFromOptions(options, defaults, url) {
     port: port,
     path: path,
     search: search,
-    proxy: proxy
+    proxy: proxy,
+    transport: transport
   };
 }
 
+function detectTransport(options) {
+  var gWindow = ((typeof window != 'undefined') && window) || ((typeof self != 'undefined') && self);
+  var transport = options.defaultTransport || 'xhr';
+  if (typeof gWindow.fetch === 'undefined') transport = 'xhr';
+  if (typeof gWindow.XMLHttpRequest === 'undefined') transport = 'fetch';
+  return transport;
+}
+
 function transportOptions(transport, method) {
   var protocol = transport.protocol || 'https:';
   var port = transport.port || (protocol === 'http:' ? 80 : protocol === 'https:' ? 443 : undefined);
   var hostname = transport.hostname;
   var path = transport.path;
   var timeout = transport.timeout;
+  var transportAPI = transport.transport;
   if (transport.search) {
     path = path + transport.search;
   }
@@ -67,7 +78,8 @@ function transportOptions(transport, method) {
     hostname: hostname,
     path: path,
     port: port,
-    method: method
+    method: method,
+    transport: transportAPI
   };
 }
 

package/src/browser/telemetry.js

@@ -383,6 +383,9 @@ Instrumenter.prototype.instrumentNetwork = function() {
         if (self.trackHttpErrors()) {
           metadata.stack = (new Error()).stack;
         }
+
+        // Start our handler before returning the promise. This allows resp.clone()
+        // to execute before other handlers touch the response.
         return orig.apply(this, args).then(function (resp) {
           metadata.end_time_ms = _.now();
           metadata.status_code = resp.status;
@@ -395,6 +398,7 @@ Instrumenter.prototype.instrumentNetwork = function() {
           if (self.autoInstrument.networkResponseBody) {
             if (typeof resp.text === 'function') { // Response.text() is not implemented on some platforms
               // The response must be cloned to prevent reading (and locking) the original stream.
+              // This must be done before other handlers touch the response.
               body = resp.clone().text(); //returns a Promise
             }
           }

package/src/browser/transport/fetch.js

@@ -0,0 +1,35 @@
+var logger = require('../logger');
+var _ = require('../../utility');
+
+function makeFetchRequest(accessToken, url, method, data, callback, timeout) {
+  var controller;
+  var timeoutId;
+
+  if(_.isFiniteNumber(timeout)) {
+    controller = new AbortController();
+    timeoutId = setTimeout(() => controller.abort(), timeout);
+  }
+
+  fetch(url, {
+    method: method,
+    headers: {
+      'Content-Type': 'application/json',
+      'X-Rollbar-Access-Token': accessToken,
+      signal: controller && controller.signal
+    },
+    body: data,
+  })
+  .then((response) => {
+    if (timeoutId) clearTimeout(timeoutId);
+    return response.json();
+  })
+  .then((data) => {
+    callback(null, data);
+  })
+  .catch((error) => {
+    logger.error(error.message);
+    callback(error);
+  });
+}
+
+module.exports = makeFetchRequest;

package/src/browser/transport/xhr.js

@@ -0,0 +1,159 @@
+/*global XDomainRequest*/
+
+var _ = require('../../utility');
+var logger = require('../logger');
+
+function makeXhrRequest(accessToken, url, method, data, callback, requestFactory, timeout) {
+  var request;
+  if (requestFactory) {
+    request = requestFactory();
+  } else {
+    request = _createXMLHTTPObject();
+  }
+  if (!request) {
+    // Give up, no way to send requests
+    return callback(new Error('No way to send a request'));
+  }
+  try {
+    try {
+      var onreadystatechange = function() {
+        try {
+          if (onreadystatechange && request.readyState === 4) {
+            onreadystatechange = undefined;
+
+            var parseResponse = _.jsonParse(request.responseText);
+            if (_isSuccess(request)) {
+              callback(parseResponse.error, parseResponse.value);
+              return;
+            } else if (_isNormalFailure(request)) {
+              if (request.status === 403) {
+                // likely caused by using a server access token
+                var message = parseResponse.value && parseResponse.value.message;
+                logger.error(message);
+              }
+              // return valid http status codes
+              callback(new Error(String(request.status)));
+            } else {
+              // 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)';
+              callback(_newRetriableError(msg));
+            }
+          }
+        } catch (ex) {
+          //jquery source mentions firefox may error out while accessing the
+          //request members if there is a network error
+          //https://github.com/jquery/jquery/blob/a938d7b1282fc0e5c52502c225ae8f0cef219f0a/src/ajax/xhr.js#L111
+          var exc;
+          if (ex && ex.stack) {
+            exc = ex;
+          } else {
+            exc = new Error(ex);
+          }
+          callback(exc);
+        }
+      };
+
+      request.open(method, url, true);
+      if (request.setRequestHeader) {
+        request.setRequestHeader('Content-Type', 'application/json');
+        request.setRequestHeader('X-Rollbar-Access-Token', accessToken);
+      }
+
+      if(_.isFiniteNumber(timeout)) {
+        request.timeout = timeout;
+      }
+
+      request.onreadystatechange = onreadystatechange;
+      request.send(data);
+    } 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'));
+        }
+
+        // If the current page is http, try and send over http
+        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() {
+          var msg = 'Request timed out';
+          var code = 'ETIMEDOUT';
+          callback(_newRetriableError(msg, code));
+        };
+        xdomainrequest.onerror = function() {
+          callback(new Error('Error during request'));
+        };
+        xdomainrequest.onload = function() {
+          var parseResponse = _.jsonParse(xdomainrequest.responseText);
+          callback(parseResponse.error, parseResponse.value);
+        };
+        xdomainrequest.open(method, url, true);
+        xdomainrequest.send(data);
+      } else {
+        callback(new Error('Cannot find a method to transport a request'));
+      }
+    }
+  } catch (e2) {
+    callback(e2);
+  }
+}
+
+function _createXMLHTTPObject() {
+  /* global ActiveXObject:false */
+
+  var factories = [
+    function () {
+      return new XMLHttpRequest();
+    },
+    function () {
+      return new ActiveXObject('Msxml2.XMLHTTP');
+    },
+    function () {
+      return new ActiveXObject('Msxml3.XMLHTTP');
+    },
+    function () {
+      return new ActiveXObject('Microsoft.XMLHTTP');
+    }
+  ];
+  var xmlhttp;
+  var i;
+  var numFactories = factories.length;
+  for (i = 0; i < numFactories; i++) {
+    /* eslint-disable no-empty */
+    try {
+      xmlhttp = factories[i]();
+      break;
+    } catch (e) {
+      // pass
+    }
+    /* eslint-enable no-empty */
+  }
+  return xmlhttp;
+}
+
+function _isSuccess(r) {
+  return r && r.status && r.status === 200;
+}
+
+function _isNormalFailure(r) {
+  return r && _.isType(r.status, 'number') && r.status >= 400 && r.status < 600;
+}
+
+function _newRetriableError(message, code) {
+  var err = new Error(message);
+  err.code = code || 'ENOTFOUND';
+  return err;
+}
+
+module.exports = makeXhrRequest;

package/src/browser/transport.js

@@ -1,7 +1,6 @@
-/*global XDomainRequest*/
-
 var _ = require('../utility');
-var logger = require('./logger');
+var makeFetchRequest = require('./transport/fetch');
+var makeXhrRequest = require('./transport/xhr');
 
 /*
  * accessToken may be embedded in payload but that should not
@@ -13,6 +12,7 @@ var logger = require('./logger');
  *   path
  *   port
  *   method
+ *   transport ('xhr' | 'fetch')
  * }
  *
  *  params is an object containing key/value pairs. These
@@ -32,7 +32,9 @@ Transport.prototype.get = function(accessToken, options, params, callback, reque
 
   var method = 'GET';
   var url = _.formatUrl(options);
-  _makeZoneRequest(accessToken, url, method, null, callback, requestFactory, options.timeout);
+  this._makeZoneRequest(
+    accessToken, url, method, null, callback, requestFactory, options.timeout, options.transport
+  );
 }
 
 Transport.prototype.post = function(accessToken, options, payload, callback, requestFactory) {
@@ -57,7 +59,9 @@ Transport.prototype.post = function(accessToken, options, payload, callback, req
   var writeData = stringifyResult.value;
   var method = 'POST';
   var url = _.formatUrl(options);
-  _makeZoneRequest(accessToken, url, method, writeData, callback, requestFactory, options.timeout);
+  this._makeZoneRequest(
+    accessToken, url, method, writeData, callback, requestFactory, options.timeout, options.transport
+  );
 }
 
 Transport.prototype.postJsonPayload = function (accessToken, options, jsonPayload, callback, requestFactory) {
@@ -67,7 +71,9 @@ Transport.prototype.postJsonPayload = function (accessToken, options, jsonPayloa
 
   var method = 'POST';
   var url = _.formatUrl(options);
-  _makeZoneRequest(accessToken, url, method, jsonPayload, callback, requestFactory, options.timeout);
+  this._makeZoneRequest(
+    accessToken, url, method, jsonPayload, callback, requestFactory, options.timeout, options.transport
+  );
 }
 
 
@@ -75,7 +81,7 @@ Transport.prototype.postJsonPayload = function (accessToken, options, jsonPayloa
 // so Angular change detection isn't triggered on each API call.
 // This is the equivalent of runOutsideAngular().
 //
-function _makeZoneRequest() {
+Transport.prototype._makeZoneRequest = function () {
   var gWindow = ((typeof window != 'undefined') && window) || ((typeof self != 'undefined') && self);
   var currentZone = gWindow && gWindow.Zone && gWindow.Zone.current;
   var args = Array.prototype.slice.call(arguments);
@@ -83,10 +89,24 @@ function _makeZoneRequest() {
   if (currentZone && currentZone._name === 'angular') {
     var rootZone = currentZone._parent;
     rootZone.run(function () {
-      _makeRequest.apply(undefined, args);
+      this._makeRequest.apply(undefined, args);
     });
   } else {
-    _makeRequest.apply(undefined, args);
+    this._makeRequest.apply(undefined, args);
+  }
+}
+
+Transport.prototype._makeRequest = function (
+  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)
+  } else {
+    makeXhrRequest(accessToken, url, method, data, callback, requestFactory, timeout)
   }
 }
 
@@ -102,161 +122,4 @@ function _proxyRequest(json, callback) {
   );
 }
 
-function _makeRequest(accessToken, url, method, data, callback, requestFactory, timeout) {
-  if (typeof RollbarProxy !== 'undefined') {
-    return _proxyRequest(data, callback);
-  }
-
-  var request;
-  if (requestFactory) {
-    request = requestFactory();
-  } else {
-    request = _createXMLHTTPObject();
-  }
-  if (!request) {
-    // Give up, no way to send requests
-    return callback(new Error('No way to send a request'));
-  }
-  try {
-    try {
-      var onreadystatechange = function() {
-        try {
-          if (onreadystatechange && request.readyState === 4) {
-            onreadystatechange = undefined;
-
-            var parseResponse = _.jsonParse(request.responseText);
-            if (_isSuccess(request)) {
-              callback(parseResponse.error, parseResponse.value);
-              return;
-            } else if (_isNormalFailure(request)) {
-              if (request.status === 403) {
-                // likely caused by using a server access token
-                var message = parseResponse.value && parseResponse.value.message;
-                logger.error(message);
-              }
-              // return valid http status codes
-              callback(new Error(String(request.status)));
-            } else {
-              // 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)';
-              callback(_newRetriableError(msg));
-            }
-          }
-        } catch (ex) {
-          //jquery source mentions firefox may error out while accessing the
-          //request members if there is a network error
-          //https://github.com/jquery/jquery/blob/a938d7b1282fc0e5c52502c225ae8f0cef219f0a/src/ajax/xhr.js#L111
-          var exc;
-          if (ex && ex.stack) {
-            exc = ex;
-          } else {
-            exc = new Error(ex);
-          }
-          callback(exc);
-        }
-      };
-
-      request.open(method, url, true);
-      if (request.setRequestHeader) {
-        request.setRequestHeader('Content-Type', 'application/json');
-        request.setRequestHeader('X-Rollbar-Access-Token', accessToken);
-      }
-
-      if(_.isFiniteNumber(timeout)) {
-        request.timeout = timeout;
-      }
-
-      request.onreadystatechange = onreadystatechange;
-      request.send(data);
-    } 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'));
-        }
-
-        // If the current page is http, try and send over http
-        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() {
-          var msg = 'Request timed out';
-          var code = 'ETIMEDOUT';
-          callback(_newRetriableError(msg, code));
-        };
-        xdomainrequest.onerror = function() {
-          callback(new Error('Error during request'));
-        };
-        xdomainrequest.onload = function() {
-          var parseResponse = _.jsonParse(xdomainrequest.responseText);
-          callback(parseResponse.error, parseResponse.value);
-        };
-        xdomainrequest.open(method, url, true);
-        xdomainrequest.send(data);
-      } else {
-        callback(new Error('Cannot find a method to transport a request'));
-      }
-    }
-  } catch (e2) {
-    callback(e2);
-  }
-}
-
-function _createXMLHTTPObject() {
-  /* global ActiveXObject:false */
-
-  var factories = [
-    function () {
-      return new XMLHttpRequest();
-    },
-    function () {
-      return new ActiveXObject('Msxml2.XMLHTTP');
-    },
-    function () {
-      return new ActiveXObject('Msxml3.XMLHTTP');
-    },
-    function () {
-      return new ActiveXObject('Microsoft.XMLHTTP');
-    }
-  ];
-  var xmlhttp;
-  var i;
-  var numFactories = factories.length;
-  for (i = 0; i < numFactories; i++) {
-    /* eslint-disable no-empty */
-    try {
-      xmlhttp = factories[i]();
-      break;
-    } catch (e) {
-      // pass
-    }
-    /* eslint-enable no-empty */
-  }
-  return xmlhttp;
-}
-
-function _isSuccess(r) {
-  return r && r.status && r.status === 200;
-}
-
-function _isNormalFailure(r) {
-  return r && _.isType(r.status, 'number') && r.status >= 400 && r.status < 600;
-}
-
-function _newRetriableError(message, code) {
-  var err = new Error(message);
-  err.code = code || 'ENOTFOUND';
-  return err;
-}
-
 module.exports = Transport;

package/src/defaults.js

@@ -1,5 +1,5 @@
 module.exports = {
-  version: '2.25.2',
+  version: '2.26.0',
   endpoint: 'api.rollbar.com/api/1/item/',
   logLevel: 'debug',
   reportLevel: 'debug',

package/test/apiUtility.test.js

@@ -105,6 +105,60 @@ describe('getTransportFromOptions', function() {
     expect(t.proxy).to.eql(options.proxy);
     expect(t.timeout).to.eql(undefined);
   });
+  describe('getTransportFromOptions', function() {
+    var defaults = {
+      hostname: 'api.com',
+      protocol: 'https:',
+      path: '/api/1',
+      search: '?abc=456',
+    };
+    var url = {
+      parse: function(_) {
+        return {
+          hostname: 'whatever.com',
+          protocol: 'http:',
+          pathname: '/api/42'
+        };
+      }
+    };
+    it('should use xhr by default', function(done) {
+      var options = {};
+      var t = u.getTransportFromOptions(options, defaults, url);
+      expect(t.transport).to.eql('xhr');
+      done();
+    });
+    it('should use fetch when requested', function(done) {
+      var options = {defaultTransport: 'fetch'};
+      var t = u.getTransportFromOptions(options, defaults, url);
+      expect(t.transport).to.eql('fetch');
+      done();
+    });
+    it('should use xhr when requested', function(done) {
+      var options = {defaultTransport: 'xhr'};
+      var t = u.getTransportFromOptions(options, defaults, url);
+      expect(t.transport).to.eql('xhr');
+      done();
+    });
+    it('should use xhr when fetch is unavailable', function(done) {
+      var options = {defaultTransport: 'fetch'};
+      var oldFetch = window.fetch;
+      self.fetch = undefined;
+      var t = u.getTransportFromOptions(options, defaults, url);
+      expect(t.transport).to.eql('xhr');
+      self.fetch = oldFetch;
+      done();
+    });
+    it('should use fetch when xhr is unavailable', function(done) {
+      var options = {defaultTransport: 'xhr'};
+      var oldXhr = window.XMLHttpRequest;
+      self.XMLHttpRequest = undefined;
+      var t = u.getTransportFromOptions(options, defaults, url);
+      expect(t.transport).to.eql('fetch');
+      self.XMLHttpRequest = oldXhr;
+      done();
+    });
+  });
+
 });
 
 describe('transportOptions', function() {

package/test/browser.rollbar.test.js

@@ -1529,15 +1529,9 @@ describe('options.autoInstrument', function() {
 
     window.fetchStub = sinon.stub(window, 'fetch');
 
-    var readableStream = new ReadableStream({
-      start(controller) {
-        controller.enqueue(JSON.stringify({name: 'foo', password: '123456'}));
-        controller.close();
-      }
-    });
-
+    var responseBody = JSON.stringify({name: 'foo', password: '123456'});
     window.fetch.returns(Promise.resolve(new Response(
-      readableStream,
+      responseBody,
       { status: 200, statusText: 'OK', headers: { 'content-type': 'application/json', 'password': '123456' }}
     )));
 
@@ -1561,11 +1555,18 @@ describe('options.autoInstrument', function() {
     const fetchInit = {
       method: 'POST',
       headers: fetchHeaders,
-      body: JSON.stringify({name: 'bar', secret: 'xhr post'})
+      body: JSON.stringify({name: 'bar', secret: 'fetch post'})
     };
-    var fetchRequest = new Request('https://example.com/xhr-test');
+    var fetchRequest = new Request('https://example.com/fetch-test');
     window.fetch(fetchRequest, fetchInit)
     .then(function(response) {
+      // Assert that the original stream reader hasn't been read.
+      expect(response.bodyUsed).to.eql(false);
+      return response.text()
+    })
+    .then(function(text) {
+      expect(text).to.eql(responseBody);
+
       try {
         rollbar.log('test'); // generate a payload to inspect
       } catch (e) {
@@ -1577,8 +1578,9 @@ describe('options.autoInstrument', function() {
         try {
           server.respond();
 
-          expect(server.requests.length).to.eql(2);
-          var body = JSON.parse(server.requests[1].requestBody);
+          expect(window.fetchStub.called).to.be.ok();
+          expect(server.requests.length).to.eql(1);
+          var body = JSON.parse(server.requests[0].requestBody);
 
           // Verify request capture and scrubbing
           expect(body.data.body.telemetry[0].body.request).to.eql('{"name":"bar","secret":"********"}');
@@ -1586,19 +1588,12 @@ describe('options.autoInstrument', function() {
           // Verify request headers capture and case-insensitive scrubbing
           expect(body.data.body.telemetry[0].body.request_headers).to.eql({'content-type': 'application/json', secret: '********'});
 
-          // When using the Sinon test stub, the response body is populated in Headless Chrome 73,
-          // but not in 77. When using the Fetch API normally, it is populated in all tested Chrome versions.
-          // Disable here due to the Sinon limitation.
-          //
           // Verify response capture and scrubbing
-          // expect(body.data.body.telemetry[0].body.response.body).to.eql('{"name":"foo","password":"********"}');
+          expect(body.data.body.telemetry[0].body.response.body).to.eql('{"name":"foo","password":"********"}');
 
           // Verify response headers capture and case-insensitive scrubbing
           expect(body.data.body.telemetry[0].body.response.headers).to.eql({'content-type': 'application/json', password: '********'});
 
-          // Assert that the original stream reader hasn't been read.
-          expect(response.bodyUsed).to.eql(false);
-
           rollbar.configure({ autoInstrument: false });
           window.fetch.restore();
           done();