Add support for tracking releases

Fixes #325

Author: mattrobenolt

docs/config/index.rst

@@ -35,6 +35,19 @@ The name of the logger used by Sentry. Default: ``javascript``
       logger: 'javascript'
     }
 
+release
+-------
+
+Track the version of your application in Sentry.
+
+.. code-block:: javascript
+
+    {
+      release: '721e41770371db95eee98ca2707686226b993eda'
+    }
+
+Can also be defined with ``Raven.setReleaseContext('721e41770371db95eee98ca2707686226b993eda')``.
+
 .. _config-whitelist-urls:
 
 tags

src/raven.js

@@ -314,6 +314,18 @@ var Raven = {
        return Raven;
     },
 
+    /*
+     * Set release version of application
+     *
+     * @param {string} release Typically something like a git SHA to identify version
+     * @return {Raven}
+     */
+    setReleaseContext: function(release) {
+        globalOptions.release = release;
+
+        return Raven;
+    },
+
     /*
      * Get the latest raw exception that was captured by Raven.
      *
@@ -683,6 +695,9 @@ function send(data) {
         data.user = globalUser;
     }
 
+    // Include the release iff it's defined in globalOptions
+    if (globalOptions.release) data.release = globalOptions.release;
+
     if (isFunction(globalOptions.dataCallback)) {
         data = globalOptions.dataCallback(data);
     }

test/raven.test.js

@@ -8,6 +8,7 @@ function flushRavenState() {
     globalProject = undefined;
     globalOptions = {
         logger: 'javascript',
+        release: undefined,
         ignoreErrors: [],
         ignoreUrls: [],
         whitelistUrls: [],
@@ -1008,6 +1009,38 @@ describe('globals', function() {
                 extra: {'session:duration': 100}
             });
         });
+
+        it('should attach release if available', function() {
+            this.sinon.stub(window, 'isSetup').returns(true);
+            this.sinon.stub(window, 'makeRequest');
+            this.sinon.stub(window, 'getHttpData').returns({
+                url: 'http://localhost/?a=b',
+                headers: {'User-Agent': 'lolbrowser'}
+            });
+
+            globalOptions = {
+                projectId: 2,
+                logger: 'javascript',
+                release: 'abc123',
+            };
+
+            send({foo: 'bar'});
+            assert.deepEqual(window.makeRequest.lastCall.args[0], {
+                project: '2',
+                release: 'abc123',
+                logger: 'javascript',
+                platform: 'javascript',
+                request: {
+                    url: 'http://localhost/?a=b',
+                    headers: {
+                        'User-Agent': 'lolbrowser'
+                    }
+                },
+                event_id: 'abc123',
+                foo: 'bar',
+                extra: {'session:duration': 100}
+            });
+        });
     });
 
     describe('makeRequest', function() {
@@ -1560,6 +1593,19 @@ describe('Raven (public API)', function() {
         });
     });
 
+    describe('.setReleaseContext', function() {
+        it('should set the globalOptions.release attribute', function() {
+            Raven.setReleaseContext('abc123');
+            assert.equal(globalOptions.release, 'abc123');
+        });
+
+        it('should clear globalOptions.release with no arguments', function() {
+            globalOptions.release = 'abc123';
+            Raven.setReleaseContext();
+            assert.isUndefined(globalOptions.release);
+        });
+    });
+
     describe('.captureMessage', function() {
         it('should work as advertised', function() {
             this.sinon.stub(window, 'send');