Change captureBreadcrumb api to accept crumb name, crumb data

Author: benvinegar

src/raven.js

@@ -354,10 +354,14 @@ Raven.prototype = {
         return this;
     },
 
-    captureBreadcrumb: function (obj) {
-        obj.timestamp = (obj.timestamp || now()) / 1000;
+    captureBreadcrumb: function (type, data) {
+        var crumb = {
+            type: type,
+            timestamp: now() / 1000,
+            data: data
+        };
 
-        this._breadcrumbs.push(obj);
+        this._breadcrumbs.push(crumb);
         if (this._breadcrumbs.length > this._breadcrumbLimit) {
             this._breadcrumbs.shift();
         }
@@ -631,12 +635,9 @@ Raven.prototype = {
 
             self._lastCapturedEvent = evt;
             var elem = evt.target;
-            self.captureBreadcrumb({
-                type: 'ui_event',
-                data: {
-                    type: evtName,
-                    target: htmlElementAsString(elem)
-                }
+            self.captureBreadcrumb('ui_event', {
+                type: evtName,
+                target: htmlElementAsString(elem)
             });
         };
     },
@@ -750,10 +751,7 @@ Raven.prototype = {
                                         // an exception
                                         xhr.__raven_xhr.statusCode = xhr.status;
                                     } catch (e) { /* do nothing */ }
-                                    self.captureBreadcrumb({
-                                        type: 'http_request',
-                                        data: xhr.__raven_xhr
-                                    });
+                                    self.captureBreadcrumb('http_request', xhr.__raven_xhr);
                                 }
                                 return self.wrap(orig);
                             }, true /* noUndo */); // don't track filled methods on XHR instances
@@ -769,12 +767,9 @@ Raven.prototype = {
             // TODO: remove onpopstate handler on uninstall()
             var oldOnPopState = window.onpopstate;
             window.onpopstate = function () {
-                self.captureBreadcrumb({
-                    type: 'navigation',
-                    data: {
-                        from: self._lastHref,
-                        to: location.href
-                    }
+                self.captureBreadcrumb('navigation', {
+                    from: self._lastHref,
+                    to: location.href
                 });
 
                 // because onpopstate only tells you the "new" (to) value of location.href, and
@@ -791,12 +786,9 @@ Raven.prototype = {
                 // params to preserve 0 arity
                 return function(/* state, title, url */) {
                     var url = arguments.length > 2 ? arguments[2] : undefined;
-                    self.captureBreadcrumb({
-                        type: 'navigation',
-                        data: {
-                            to: url,
-                            from: location.href
-                        }
+                    self.captureBreadcrumb('navigation', {
+                        to: url,
+                        from: location.href
                     });
                     if (url) self._lastHref = url;
                     return origPushState.apply(this, arguments);
@@ -809,13 +801,10 @@ Raven.prototype = {
             consolePlugin(self, console, {
                 levels: ['debug', 'info', 'warn', 'error', 'log'],
                 callback: function (msg, data) {
-                    self.captureBreadcrumb({
-                        type: 'message',
-                        data: {
-                            level: data.level,
-                            message: msg
-                        }
-                    })
+                    self.captureBreadcrumb('message', {
+                        level: data.level,
+                        message: msg
+                    });
                 }
             });
         }
@@ -1147,12 +1136,9 @@ Raven.prototype = {
             auth.sentry_secret = this._globalSecret;
         }
 
-        this.captureBreadcrumb({
-            type: 'sentry',
-            data: {
-                message: data.message,
-                eventId: data.event_id
-            }
+        this.captureBreadcrumb('sentry', {
+            message: data.message,
+            eventId: data.event_id
         });
 
         var url = this._globalEndpoint;

test/integration/test.js

@@ -173,7 +173,6 @@ describe('integration', function () {
             iframeExecute(iframe, done,
               function () {
                   setTimeout(done);
-                  debugger;
 
                   var div = document.createElement('div');
                   document.body.appendChild(div);

test/raven.test.js

@@ -1537,7 +1537,15 @@ describe('globals', function() {
 describe('Raven (public API)', function() {
 
     beforeEach(function () {
+        this.clock = sinon.useFakeTimers();
+        this.clock.tick(0); // Raven initialized at time "0"
         Raven = new _Raven();
+
+        this.clock.tick(100); // tick 100 ms
+    });
+
+    afterEach(function () {
+        this.clock.restore();
     });
 
     describe('.VERSION', function() {
@@ -2153,37 +2161,38 @@ describe('Raven (public API)', function() {
 
     describe('.captureBreadcrumb', function () {
         it('should store the passed object in _breadcrumbs', function() {
-            var breadcrumb = {
-                type: 'request',
-                timestamp: 100,
+            Raven.captureBreadcrumb('http_request', {
+                url: 'http://example.org/api/0/auth/',
+                statusCode: 200
+            });
+
+            assert.deepEqual(Raven._breadcrumbs[0], {
+                type: 'http_request',
+                timestamp: 0.1,
                 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 }
+                { type: 'message', timestamp: 0.1, data: { message: '1' }},
+                { type: 'message', timestamp: 0.1, data: { message: '2' }},
+                { type: 'message', timestamp: 0.1, data: { message: '3' }},
+                { type: 'message', timestamp: 0.1, data: { message: '4' }},
+                { type: 'message', timestamp: 0.1, data: { message: '5' }}
             ];
 
-            Raven.captureBreadcrumb({ id: 6, timestamp: 100 });
+            Raven.captureBreadcrumb('message', { message: 'lol' });
             assert.deepEqual(Raven._breadcrumbs, [
-                { id: 2 },
-                { id: 3 },
-                { id: 4 },
-                { id: 5 },
-                { id: 6, timestamp: 0.1 }
+                { type: 'message', timestamp: 0.1, data: { message: '2' }},
+                { type: 'message', timestamp: 0.1, data: { message: '3' }},
+                { type: 'message', timestamp: 0.1, data: { message: '4' }},
+                { type: 'message', timestamp: 0.1, data: { message: '5' }},
+                { type: 'message', timestamp: 0.1, data: { message: 'lol' }}
             ]);
         });
     });