rollbar 2.25.1 → 2.25.2

package/package.json

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

package/src/browser/telemetry.js

@@ -1,4 +1,5 @@
 var _ = require('../utility');
+var headers = require('../utility/headers');
 var scrub = require('../scrub');
 var urlparser = require('./url');
 var domUtil = require('./domUtility');
@@ -362,7 +363,7 @@ Instrumenter.prototype.instrumentNetwork = function() {
         if (args[1] && args[1].headers) {
           // Argument may be a Headers object, or plain object. Ensure here that
           // we are working with a Headers object with case-insensitive keys.
-          var reqHeaders = new Headers(args[1].headers);
+          var reqHeaders = headers(args[1].headers);
 
           metadata.request_content_type = reqHeaders.get('Content-Type');
 

package/src/browser/transforms.js

@@ -79,20 +79,25 @@ function addBaseInfo(item, options, callback) {
 
 function addRequestInfo(window) {
   return function(item, options, callback) {
-    if (!window || !window.location) {
-      return callback(null, item);
+    var requestInfo = {};
+
+    if (window && window.location) {
+      requestInfo.url = window.location.href;
+      requestInfo.query_string = window.location.search;
     }
+
     var remoteString = '$remote_ip';
     if (!options.captureIp) {
       remoteString = null;
     } else if (options.captureIp !== true) {
       remoteString += '_anonymize';
     }
-    _.set(item, 'data.request', {
-      url: window.location.href,
-      query_string: window.location.search,
-      user_ip: remoteString
-    });
+    if (remoteString) requestInfo.user_ip = remoteString;
+
+    if (Object.keys(requestInfo).length > 0) {
+      _.set(item, 'data.request', requestInfo);
+    }
+
     callback(null, item);
   };
 }

package/src/defaults.js

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

package/src/utility/headers.js

@@ -0,0 +1,94 @@
+/*
+ * headers - Detect when fetch Headers are undefined and use a partial polyfill.
+ *
+ * A full polyfill is not used in order to keep package size as small as possible.
+ * Since this is only used internally and is not added to the window object,
+ * the full interface doesn't need to be supported.
+ *
+ * This implementation is modified from whatwg-fetch:
+ * https://github.com/github/fetch
+ */
+function headers(headers) {
+  if (typeof Headers === 'undefined') {
+    return new FetchHeaders(headers);
+  }
+
+  return new Headers(headers);
+}
+
+function normalizeName(name) {
+  if (typeof name !== 'string') {
+    name = String(name)
+  }
+  return name.toLowerCase()
+}
+
+function normalizeValue(value) {
+  if (typeof value !== 'string') {
+    value = String(value)
+  }
+  return value
+}
+
+function iteratorFor(items) {
+  var iterator = {
+    next: function() {
+      var value = items.shift()
+      return {done: value === undefined, value: value}
+    }
+  }
+
+  return iterator
+}
+
+function FetchHeaders(headers) {
+  this.map = {}
+
+  if (headers instanceof FetchHeaders) {
+    headers.forEach(function(value, name) {
+      this.append(name, value)
+    }, this)
+  } else if (Array.isArray(headers)) {
+    headers.forEach(function(header) {
+      this.append(header[0], header[1])
+    }, this)
+  } else if (headers) {
+    Object.getOwnPropertyNames(headers).forEach(function(name) {
+      this.append(name, headers[name])
+    }, this)
+  }
+}
+
+FetchHeaders.prototype.append = function(name, value) {
+  name = normalizeName(name)
+  value = normalizeValue(value)
+  var oldValue = this.map[name]
+  this.map[name] = oldValue ? oldValue + ', ' + value : value
+}
+
+FetchHeaders.prototype.get = function(name) {
+  name = normalizeName(name)
+  return this.has(name) ? this.map[name] : null
+}
+
+FetchHeaders.prototype.has = function(name) {
+  return this.map.hasOwnProperty(normalizeName(name))
+}
+
+FetchHeaders.prototype.forEach = function(callback, thisArg) {
+  for (var name in this.map) {
+    if (this.map.hasOwnProperty(name)) {
+      callback.call(thisArg, this.map[name], name, this)
+    }
+  }
+}
+
+FetchHeaders.prototype.entries = function() {
+  var items = []
+  this.forEach(function(value, name) {
+    items.push([name, value])
+  })
+  return iteratorFor(items)
+}
+
+module.exports = headers;

package/test/browser.rollbar.test.js

@@ -1495,17 +1495,21 @@ describe('options.autoInstrument', function() {
       if(xhr.readyState === 4) {
         try {
           setTimeout(function() {
-            server.respond();
+            try {
+              server.respond();
 
-            expect(server.requests.length).to.eql(2);
-            var body = JSON.parse(server.requests[1].requestBody);
+              expect(server.requests.length).to.eql(2);
+              var body = JSON.parse(server.requests[1].requestBody);
 
-            expect(body.data.body.trace.exception.message).to.eql('HTTP request failed with Status 404');
+              expect(body.data.body.trace.exception.message).to.eql('HTTP request failed with Status 404');
 
-            // Just knowing a stack is present is enough for this test.
-            expect(body.data.body.trace.frames.length).to.be.above(1);
+              // Just knowing a stack is present is enough for this test.
+              expect(body.data.body.trace.frames.length).to.be.above(1);
 
-            done();
+              done();
+            } catch (e) {
+              done(e);
+            }
           }, 1);
         } catch (e) {
           done(e);
@@ -1606,7 +1610,7 @@ describe('options.autoInstrument', function() {
     })
   });
 
-  it('should add telemetry events for fetch calls', function(done) {
+  it('should report error for http 4xx fetch calls, when enabled', function(done) {
     var server = window.server;
     stubResponse(server);
     server.requests.length = 0;
@@ -1659,6 +1663,80 @@ describe('options.autoInstrument', function() {
     })
   });
 
+  it('should add telemetry headers when fetch Headers object is undefined', function(done) {
+    var server = window.server;
+    stubResponse(server);
+    server.requests.length = 0;
+
+    window.fetchStub = sinon.stub(window, 'fetch');
+
+    var readableStream = new ReadableStream({
+      start(controller) {
+        controller.enqueue(JSON.stringify({name: 'foo', password: '123456'}));
+        controller.close();
+      }
+    });
+
+    window.fetch.returns(Promise.resolve(new Response(
+      readableStream,
+      { status: 200, statusText: 'OK', headers: { 'content-type': 'application/json', 'password': '123456' }}
+    )));
+
+    var options = {
+      accessToken: 'POST_CLIENT_ITEM_TOKEN',
+      autoInstrument: {
+        log: false,
+        network: true,
+        networkResponseHeaders: true,
+        networkRequestHeaders: true
+      }
+    };
+    var rollbar = window.rollbar = new Rollbar(options);
+
+    // Remove Headers from window object
+    var originalHeaders = window.Headers;
+    delete window.Headers;
+
+    const fetchInit = {
+      method: 'POST',
+      headers: {'Content-Type': 'application/json', Secret: '123456'},
+      body: JSON.stringify({name: 'bar', secret: 'xhr post'})
+    };
+    var fetchRequest = new Request('https://example.com/xhr-test');
+    window.fetch(fetchRequest, fetchInit)
+    .then(function(response) {
+      try {
+        rollbar.log('test'); // generate a payload to inspect
+        setTimeout(function() {
+          try {
+            server.respond();
+
+            expect(server.requests.length).to.eql(1);
+            var body = JSON.parse(server.requests[0].requestBody);
+
+            // Verify request headers capture and case-insensitive scrubbing
+            expect(body.data.body.telemetry[0].body.request_headers).to.eql({'content-type': 'application/json', secret: '********'});
+
+            // 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();
+            window.Headers = originalHeaders;
+            done();
+          } catch (e) {
+            done(e);
+          }
+        });
+      } catch (e) {
+        done(e);
+      }
+    })
+  });
+
   it('should add a diagnostic message when wrapConsole fails', function(done) {
     var server = window.server;
     stubResponse(server);

package/test/browser.transforms.test.js

@@ -226,9 +226,10 @@ describe('addRequestInfo', function() {
   it('should use window info to set request properties', function(done) {
     var args = ['a message'];
     var item = itemFromArgs(args);
-    var options = {};
+    var options = { captureIp: 'anonymize' };
     t.addRequestInfo(window)(item, options, function(e, i) {
       expect(i.data.request).to.be.ok();
+      expect(i.data.request.user_ip).to.eql('$remote_ip_anonymize');
       done(e);
     });
   });
@@ -243,6 +244,19 @@ describe('addRequestInfo', function() {
       done(e);
     });
   });
+  it('should honor captureIp without window', function(done) {
+    var args = ['a message'];
+    var item = itemFromArgs(args);
+    item.data = {};
+    var options = { captureIp: true };
+    var w = null;
+    t.addRequestInfo(w)(item, options, function(e, i) {
+      expect(i.data.request.url).to.not.be.ok();
+      expect(i.data.request.query_string).to.not.be.ok();
+      expect(i.data.request.user_ip).to.eql('$remote_ip');
+      done(e);
+    });
+  });
 });
 
 describe('addClientInfo', function() {