Release 2.5.0

Author: Peripheral1994

HISTORY.md

@@ -1,3 +1,8 @@
+2.5.0 / 2017-04-11
+==================
+
+  * Add customVersionProperty option
+
 2.4.0 / 2017-03-27
 ==================
 

lib/index.js

@@ -23,6 +23,7 @@ var Sentry = module.exports = integration('Sentry')
   .option('includePaths', [])
   .option('maxMessageLength', null)
   .option('logger', null)
+  .option('customVersionProperty', null)
   .tag('<script src="https://cdn.ravenjs.com/3.12.1/raven.min.js" crossorigin="anonymous">');
 
 /**
@@ -35,16 +36,18 @@ var Sentry = module.exports = integration('Sentry')
 
 Sentry.prototype.initialize = function() {
   var dsnPublic = this.options.config;
+  var customRelease = this.options.customVersionProperty ? window[this.options.customVersionProperty] : null;
   var options = {
     logger: this.options.logger,
-    release: this.options.release,
+    release: customRelease || this.options.release,
     serverName: this.options.serverName,
     whitelistUrls: this.options.whitelistUrls,
     ignoreErrors: this.options.ignoreErrors,
     ignoreUrls: this.options.ignoreUrls,
     includePaths: this.options.includePaths,
     maxMessageLength: this.options.maxMessageLength
   };
+
   window.RavenConfig = {
     dsn: dsnPublic,
     config: reject(options)

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/analytics.js-integration-sentry",
   "description": "The Sentry analytics.js integration.",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "keywords": [
     "analytics.js",
     "analytics.js-integration",

test/index.test.js

@@ -18,7 +18,8 @@ describe('Sentry', function() {
     ignoreErrors: ['fb_xd_fragment'],
     ignoreUrls: ['/graph\.facebook\.com/', 'http://example.com/script2.js'],
     includePaths: ['/https?:\/\/getsentry\.com/', '/https?:\/\/cdn\.getsentry\.com/'],
-    maxMessageLength: 50
+    maxMessageLength: 50,
+    customVersionProperty: null
   };
 
   beforeEach(function() {
@@ -48,7 +49,8 @@ describe('Sentry', function() {
       .option('whitelistUrls', [])
       .option('includePaths', [])
       .option('maxMessageLength', null)
-      .option('logger', null));
+      .option('logger', null)
+      .option('customVersionProperty', null));
   });
 
   describe('before loading', function() {
@@ -80,6 +82,29 @@ describe('Sentry', function() {
         analytics.assert.deepEqual(window.RavenConfig.config, config);
       });
 
+      it('should allow and set custom versions', function() {
+        var config = {
+          logger: options.logger,
+          serverName: options.serverName,
+          whitelistUrls: options.whitelistUrls,
+          ignoreErrors: options.ignoreErrors,
+          ignoreUrls: options.ignoreUrls,
+          includePaths: options.includePaths,
+          maxMessageLength: options.maxMessageLength,
+          release: '2.4.0'
+        };
+
+        sentry.options.customVersionProperty = 'my_custom_version_property';
+        window.my_custom_version_property = '2.4.0';
+        analytics.initialize();
+
+        // Need to delete before asserts to prevent leaking effects in case of failure.
+        delete window.my_custom_version_property;
+
+        analytics.assert(window.RavenConfig.dsn === options.config);
+        analytics.assert.deepEqual(window.RavenConfig.config, config);
+      });
+
       it('should reject null settings', function() {
         sentry.options.release = null;
         analytics.initialize();