Capture breadcrumbs from XHRs and transfer in _send

Author: benvinegar

src/raven.js

@@ -58,6 +58,8 @@ function Raven() {
     this._plugins = [];
     this._startTime = now();
     this._wrappedBuiltIns = [];
+    this._breadcrumbs = [];
+    this._breadcrumbLimit = 20;
 
     for (var method in this._originalConsole) {  // eslint-disable-line guard-for-in
       this._originalConsoleMethods[method] = this._originalConsole[method];
@@ -345,6 +347,15 @@ Raven.prototype = {
         return this;
     },
 
+    captureBreadcrumb: function (obj) {
+        obj.timestamp = now();
+
+        this._breadcrumbs.push(obj);
+        if (this._breadcrumbs.length > this._breadcrumbLimit) {
+            this._breadcrumbs.shift();
+        }
+    },
+
     addPlugin: function(plugin /*arg1, arg2, ... argN*/) {
         var pluginArgs = Array.prototype.slice.call(arguments, 1);
 
@@ -665,12 +676,35 @@ Raven.prototype = {
         });
 
         if ('XMLHttpRequest' in window) {
-            fill(XMLHttpRequest.prototype, 'send', function(origSend) {
+            var xhrproto = XMLHttpRequest.prototype;
+            fill(xhrproto, 'open', function(origOpen) {
+                return function (method, url) { // preserve arity
+                    this.__raven_xhr = {
+                        method: method,
+                        url: url,
+                        statusCode: null
+                    };
+                    return origOpen.apply(this, arguments);
+                };
+            });
+
+            fill(xhrproto, 'send', function(origSend) {
                 return function (data) { // preserve arity
                     var xhr = this;
                     'onreadystatechange onload onerror onprogress'.replace(/\w+/g, function (prop) {
-                        if (prop in xhr && Object.prototype.toString.call(xhr[prop]) === '[object Function]') {
+                        if (prop in xhr && isFunction(xhr[prop])) {
                             fill(xhr, prop, function (orig) {
+                                if (prop === 'onreadystatechange' && xhr.__raven_xhr && (xhr.readyState === 1 || xhr.readyState === 4)) {
+                                    try {
+                                        // touching statusCode in some platforms throws
+                                        // an exception
+                                        xhr.__raven_xhr.statusCode = xhr.status;
+                                    } catch (e) { /* do nothing */ }
+                                    self.captureBreadcrumb({
+                                        type: 'request',
+                                        data: xhr.__raven_xhr
+                                    });
+                                }
                                 return self.wrap(orig);
                             }, true /* noUndo */); // don't track filled methods on XHR instances
                         }
@@ -952,6 +986,8 @@ Raven.prototype = {
         // Send along our own collected metadata with extra
         data.extra['session:duration'] = now() - this._startTime;
 
+        data.breadcrumbs = this._breadcrumbs;
+
         // If there are no tags/extra, strip the key from the payload alltogther.
         if (isEmptyObject(data.tags)) delete data.tags;
 

test/raven.test.js

@@ -718,6 +718,9 @@ describe('globals', function() {
                 logger: 'javascript',
                 maxMessageLength: 100
             };
+            Raven._breadcrumbs = [
+                { type: 'request', data: { method: 'POST', url: 'http://example.org/api/0/auth/' }}
+            ];
 
             Raven._send({message: 'bar'});
             assert.deepEqual(Raven._makeRequest.lastCall.args[0].data, {
@@ -732,7 +735,8 @@ describe('globals', function() {
                 },
                 event_id: 'abc123',
                 message: 'bar',
-                extra: {'session:duration': 100}
+                extra: {'session:duration': 100},
+                breadcrumbs: [{ type: 'request', data: { method: 'POST', url: 'http://example.org/api/0/auth/' }}]
             });
         });
 
@@ -767,7 +771,8 @@ describe('globals', function() {
                     name: 'Matt'
                 },
                 message: 'bar',
-                extra: {'session:duration': 100}
+                extra: {'session:duration': 100},
+                breadcrumbs: []
             });
         });
 
@@ -800,7 +805,8 @@ describe('globals', function() {
                 event_id: 'abc123',
                 message: 'bar',
                 tags: {tag1: 'value1', tag2: 'value2'},
-                extra: {'session:duration': 100}
+                extra: {'session:duration': 100},
+                breadcrumbs: []
             });
 
 
@@ -842,7 +848,8 @@ describe('globals', function() {
 
                 event_id: 'abc123',
                 message: 'bar',
-                extra: {key1: 'value1', key2: 'value2', 'session:duration': 100}
+                extra: {key1: 'value1', key2: 'value2', 'session:duration': 100},
+                breadcrumbs: []
             });
 
             assert.deepEqual(Raven._globalOptions, {
@@ -2144,6 +2151,43 @@ describe('Raven (public API)', function() {
         });
     });
 
+    describe('.captureBreadcrumb', function () {
+        it('should store the passed object in _breadcrumbs', function() {
+            var breadcrumb = {
+                type: 'request',
+                timestamp: 100,
+                data: {
+                    url: 'http://example.org/api/0/auth/',
+                    statusCode: 200
+                }
+            };
+
+            Raven.captureBreadcrumb(breadcrumb);
+
+            assert.equal(Raven._breadcrumbs[0], breadcrumb);
+        });
+
+        it('should dequeue the oldest breadcrumb when over limit', function() {
+            Raven._breadcrumbLimit = 5;
+            Raven._breadcrumbs = [
+                { id: 1 },
+                { id: 2 },
+                { id: 3 },
+                { id: 4 },
+                { id: 5 }
+            ];
+
+            Raven.captureBreadcrumb({ id: 6 });
+            assert.deepEqual(Raven._breadcrumbs, [
+                { id: 2 },
+                { id: 3 },
+                { id: 4 },
+                { id: 5 },
+                { id: 6 }
+            ]);
+        });
+    });
+
     describe('.Raven.isSetup', function() {
         it('should work as advertised', function() {
             var isSetup = this.sinon.stub(Raven, 'isSetup');