Merge pull request #8 from amplitude/utm-flag

allanca · allanca · commit 56af796624e0 · 2015-03-02T14:05:24.000-08:00
Put utm parameter sending behind an option.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ Amplitude-Javascript
 
         <script type="text/javascript">
           (function(h,a){var f=h.amplitude||{};var b=a.createElement("script");b.type="text/javascript";
-          b.async=true;b.src="https://d24n15hnbwhuhn.cloudfront.net/libs/amplitude-2.0.3-min.js";
+          b.async=true;b.src="https://d24n15hnbwhuhn.cloudfront.net/libs/amplitude-2.0.4-min.js";
           var g=a.getElementsByTagName("script")[0];g.parentNode.insertBefore(b,g);
           f._q=[];function e(i){f[i]=function(){f._q.push([i].concat(Array.prototype.slice.call(arguments,0)))}}
           var c=["init","logEvent","setUserId","setUserProperties","setVersionName","setDomain","setDeviceId",
diff --git a/amplitude.js b/amplitude.js
@@ -135,7 +135,8 @@ var DEFAULT_OPTIONS = {
   domain: undefined,
   sessionTimeout: 30 * 60 * 1000,
   platform: 'Web',
-  language: language.language
+  language: language.language,
+  includeUtm: false
 };
 var LocalStorageKeys = {
   LAST_EVENT_ID: 'amplitude_lastEventId',
@@ -165,8 +166,7 @@ Amplitude.prototype._newSession = false;
  * opt_userId An identifier for this user
  * opt_config Configuration options
  *   - saveEvents (boolean) Whether to save events to local storage. Defaults to true.
- *   - utmParams (string) Optional utm data in query string format.
- *                        Pulled from location.search otherwise.
+ *   - includeUtm (boolean) Whether to send utm parameters with events. Defaults to false.
  */
 Amplitude.prototype.init = function(apiKey, opt_userId, opt_config) {
   try {
@@ -178,6 +178,9 @@ Amplitude.prototype.init = function(apiKey, opt_userId, opt_config) {
       if (opt_config.domain !== undefined) {
         this.options.domain = opt_config.domain;
       }
+      if (opt_config.includeUtm !== undefined) {
+        this.options.includeUtm = !!opt_config.includeUtm;
+      }
       this.options.platform = opt_config.platform || this.options.platform;
       this.options.language = opt_config.language || this.options.language;
       this.options.sessionTimeout = opt_config.sessionTimeout || this.options.sessionTimeout;
@@ -214,9 +217,9 @@ Amplitude.prototype.init = function(apiKey, opt_userId, opt_config) {
       this.sendEvents();
     }
 
-    // Parse the utm properties out of cookies and query for adding to user properties.
-    var utmParams = opt_config && opt_config.utmParams || location.search;
-    this._utmProperties = Amplitude._getUtmData(Cookie.get('__utmz'), utmParams);
+    if (this.options.includeUtm) {
+      this._initUtmData();
+    }
 
     this._lastEventTime = parseInt(localStorage.getItem(LocalStorageKeys.LAST_EVENT_TIME)) || null;
     this._sessionId = parseInt(localStorage.getItem(LocalStorageKeys.SESSION_ID)) || null;
@@ -291,6 +294,15 @@ Amplitude._getUtmData = function(rawCookie, query) {
   };
 };
 
+/**
+ * Parse the utm properties out of cookies and query for adding to user properties.
+ */
+Amplitude.prototype._initUtmData = function(queryParams, cookieParams) {
+  queryParams = queryParams || location.search;
+  cookieParams = cookieParams || Cookie.get('__utmz');
+  this._utmProperties = Amplitude._getUtmData(cookieParams, queryParams);
+};
+
 Amplitude.prototype.saveEvents = function() {
   try {
     localStorage.setItem(this.options.unsentKey, JSON.stringify(this._unsentEvents));
@@ -375,7 +387,7 @@ Amplitude.prototype.logEvent = function(eventType, eventProperties) {
 
     // Add the utm properties, if any, onto the user properties.
     var userProperties = {};
-    object.merge(userProperties, this.options.userProperties || {}, this._utmProperties);
+    object.merge(userProperties, this.options.userProperties || {});
     object.merge(userProperties, this._utmProperties);
 
     eventProperties = eventProperties || {};
@@ -2489,7 +2501,7 @@ exports.isEmpty = function(obj){
 };
 }, {}],
 14: [function(require, module, exports) {
-module.exports = '2.0.3';
+module.exports = '2.0.4';
 
 }, {}]}, {}, {"1":""})
 );
diff --git a/amplitude.min.js b/amplitude.min.js
diff --git a/component.json b/component.json
@@ -3,7 +3,7 @@
   "main": "src/index.js",
   "repo": "amplitude/amplitude-javascript",
   "description": "Javascript library for Amplitude Analytics",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "keywords": [
     "analytics",
     "amplitude"
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "amplitude-js",
   "author": "Amplitude <support@amplitude.com>",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "license": "MIT",
   "description": "Javascript library for Amplitude Analytics",
   "keywords": [
diff --git a/scripts/version.js b/scripts/version.js
@@ -2,15 +2,29 @@ var fs = require('fs');
 var path = require('path');
 var package = require('../package');
 var component = require('../component');
+var previous = require('../src/version');
 
 var version = package.version;
-component.version = version;
 
 var cwd = process.cwd();
 
+function replaceVersion(filepath) {
+  var filename = path.join(cwd, filepath);
+  fs.writeFileSync(filename, fs.readFileSync(filename, 'utf-8').replace(previous, version));
+  console.log('Updated ', filepath);
+}
+
 console.log('Updating to version ' + version);
+
+component.version = version;
 fs.writeFileSync(path.join(cwd, 'component.json'), JSON.stringify(component, null, 2) + '\n');
 console.log('Updated component.json');
 
-fs.writeFileSync(path.join(cwd, 'src', 'version.js'), "module.exports = '" + version + "';\n");
-console.log('Updated src/version.js');
+var files = [
+  'README.md',
+  path.join('src', 'amplitude-snippet.js'),
+  path.join('src', 'version.js'),
+];
+files.map(replaceVersion);
+
+console.log('Updated version from', previous, 'to', version);
diff --git a/src/amplitude-snippet.js b/src/amplitude-snippet.js
@@ -3,7 +3,7 @@
   var as = document.createElement('script');
   as.type = 'text/javascript';
   as.async = true;
-  as.src = 'https://d24n15hnbwhuhn.cloudfront.net/libs/amplitude-2.0.1-min.js';
+  as.src = 'https://d24n15hnbwhuhn.cloudfront.net/libs/amplitude-2.0.4-min.js';
   var s = document.getElementsByTagName('script')[0];
   s.parentNode.insertBefore(as, s);
   amplitude._q = [];
diff --git a/src/amplitude.js b/src/amplitude.js
@@ -25,7 +25,8 @@ var DEFAULT_OPTIONS = {
   domain: undefined,
   sessionTimeout: 30 * 60 * 1000,
   platform: 'Web',
-  language: language.language
+  language: language.language,
+  includeUtm: false
 };
 var LocalStorageKeys = {
   LAST_EVENT_ID: 'amplitude_lastEventId',
@@ -55,8 +56,7 @@ Amplitude.prototype._newSession = false;
  * opt_userId An identifier for this user
  * opt_config Configuration options
  *   - saveEvents (boolean) Whether to save events to local storage. Defaults to true.
- *   - utmParams (string) Optional utm data in query string format.
- *                        Pulled from location.search otherwise.
+ *   - includeUtm (boolean) Whether to send utm parameters with events. Defaults to false.
  */
 Amplitude.prototype.init = function(apiKey, opt_userId, opt_config) {
   try {
@@ -68,6 +68,9 @@ Amplitude.prototype.init = function(apiKey, opt_userId, opt_config) {
       if (opt_config.domain !== undefined) {
         this.options.domain = opt_config.domain;
       }
+      if (opt_config.includeUtm !== undefined) {
+        this.options.includeUtm = !!opt_config.includeUtm;
+      }
       this.options.platform = opt_config.platform || this.options.platform;
       this.options.language = opt_config.language || this.options.language;
       this.options.sessionTimeout = opt_config.sessionTimeout || this.options.sessionTimeout;
@@ -104,9 +107,9 @@ Amplitude.prototype.init = function(apiKey, opt_userId, opt_config) {
       this.sendEvents();
     }
 
-    // Parse the utm properties out of cookies and query for adding to user properties.
-    var utmParams = opt_config && opt_config.utmParams || location.search;
-    this._utmProperties = Amplitude._getUtmData(Cookie.get('__utmz'), utmParams);
+    if (this.options.includeUtm) {
+      this._initUtmData();
+    }
 
     this._lastEventTime = parseInt(localStorage.getItem(LocalStorageKeys.LAST_EVENT_TIME)) || null;
     this._sessionId = parseInt(localStorage.getItem(LocalStorageKeys.SESSION_ID)) || null;
@@ -181,6 +184,15 @@ Amplitude._getUtmData = function(rawCookie, query) {
   };
 };
 
+/**
+ * Parse the utm properties out of cookies and query for adding to user properties.
+ */
+Amplitude.prototype._initUtmData = function(queryParams, cookieParams) {
+  queryParams = queryParams || location.search;
+  cookieParams = cookieParams || Cookie.get('__utmz');
+  this._utmProperties = Amplitude._getUtmData(cookieParams, queryParams);
+};
+
 Amplitude.prototype.saveEvents = function() {
   try {
     localStorage.setItem(this.options.unsentKey, JSON.stringify(this._unsentEvents));
diff --git a/src/version.js b/src/version.js
@@ -1 +1 @@
-module.exports = '2.0.3';
+module.exports = '2.0.4';
diff --git a/test/amplitude.js b/test/amplitude.js
@@ -196,13 +196,42 @@ describe('Amplitude', function() {
       reset();
     });
 
-    it('should add utm params to the user properties', function() {
+    it('should not send utm data when the includeUtm flag is false', function() {
       cookie.set('__utmz', '133232535.1424926227.1.1.utmcct=top&utmccn=new');
+      reset();
+      amplitude.init(apiKey, undefined, {});
 
+      amplitude.setUserProperties({user_prop: true});
+      amplitude.logEvent('UTM Test Event', {});
+      assert.lengthOf(server.requests, 1);
+      var events = JSON.parse(querystring.parse(server.requests[0].requestBody).e);
+      assert.equal(events[0].user_properties.utm_campaign, undefined);
+      assert.equal(events[0].user_properties.utm_content, undefined);
+      assert.equal(events[0].user_properties.utm_medium, undefined);
+      assert.equal(events[0].user_properties.utm_source, undefined);
+      assert.equal(events[0].user_properties.utm_term, undefined);
+    });
+
+    it('should send utm data when the includeUtm flag is true', function() {
+      cookie.set('__utmz', '133232535.1424926227.1.1.utmcct=top&utmccn=new');
       reset();
-      amplitude.init(apiKey, undefined, {
-        utmParams: '?utm_source=amplitude&utm_medium=email&utm_term=terms'
+      amplitude.init(apiKey, undefined, {includeUtm: true});
+
+      amplitude.logEvent('UTM Test Event', {});
+
+      assert.lengthOf(server.requests, 1);
+      var events = JSON.parse(querystring.parse(server.requests[0].requestBody).e);
+      assert.deepEqual(events[0].user_properties, {
+        utm_campaign: 'new',
+        utm_content: 'top'
       });
+    });
+
+    it('should add utm params to the user properties', function() {
+      cookie.set('__utmz', '133232535.1424926227.1.1.utmcct=top&utmccn=new');
+
+      var utmParams = '?utm_source=amplitude&utm_medium=email&utm_term=terms';
+      amplitude._initUtmData(utmParams);
 
       amplitude.setUserProperties({user_prop: true});
       amplitude.logEvent('UTM Test Event', {});
@@ -217,7 +246,6 @@ describe('Amplitude', function() {
         utm_source: 'amplitude',
         utm_term: 'terms'
       });
-
     });
 
     it('should get utm params from the query string', function() {

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "amplitude-js",`
`3`	`3`	`"author": "Amplitude <[email protected]>",`
`4`		`- "version": "2.0.3",`
	`4`	`+ "version": "2.0.4",`
`5`	`5`	`"license": "MIT",`
`6`	`6`	`"description": "Javascript library for Amplitude Analytics",`
`7`	`7`	`"keywords": [`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-module.exports = '2.0.3';`
	`1`	`+module.exports = '2.0.4';`