Merge pull request #71 from amplitude/only_save_nonnull_utm_properties

only save nonnull utm properties

Author: djih

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## Unreleased
 
+* Silence console warnings for various UTM property keys with undefined values.
+
 ### 2.12.0 (April 20, 2016)
 
 * Add support for setting groups for users and events. See the [Readme](https://github.com/amplitude/Amplitude-Javascript#setting-groups) for more information.

amplitude.js

@@ -2629,34 +2629,49 @@ module.exports = localStorage;
 
 }, {}],
 5: [function(require, module, exports) {
-var getUtmParam = function(name, query) {
+var utils = require('./utils');
+
+var getUtmParam = function getUtmParam(name, query) {
   name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
   var regex = new RegExp("[\\?&]" + name + "=([^&#]*)");
   var results = regex.exec(query);
   return results === null ? undefined : decodeURIComponent(results[1].replace(/\+/g, " "));
 };
 
-var getUtmData = function(rawCookie, query) {
+var getUtmData = function getUtmData(rawCookie, query) {
   // Translate the utmz cookie format into url query string format.
   var cookie = rawCookie ? '?' + rawCookie.split('.').slice(-1)[0].replace(/\|/g, '&') : '';
 
-  var fetchParam = function (queryName, query, cookieName, cookie) {
+  var fetchParam = function fetchParam(queryName, query, cookieName, cookie) {
     return getUtmParam(queryName, query) ||
            getUtmParam(cookieName, cookie);
   };
 
-  return {
-    utm_source: fetchParam('utm_source', query, 'utmcsr', cookie),
-    utm_medium: fetchParam('utm_medium', query, 'utmcmd', cookie),
-    utm_campaign: fetchParam('utm_campaign', query, 'utmccn', cookie),
-    utm_term: fetchParam('utm_term', query, 'utmctr', cookie),
-    utm_content: fetchParam('utm_content', query, 'utmcct', cookie),
+  var utmSource = fetchParam('utm_source', query, 'utmcsr', cookie);
+  var utmMedium = fetchParam('utm_medium', query, 'utmcmd', cookie);
+  var utmCampaign = fetchParam('utm_campaign', query, 'utmccn', cookie);
+  var utmTerm = fetchParam('utm_term', query, 'utmctr', cookie);
+  var utmContent = fetchParam('utm_content', query, 'utmcct', cookie);
+
+  var utmData = {};
+  var addIfNotNull = function addIfNotNull(key, value) {
+    if (!utils.isEmptyString(value)) {
+      utmData[key] = value;
+    }
   };
+
+  addIfNotNull('utm_source', utmSource);
+  addIfNotNull('utm_medium', utmMedium);
+  addIfNotNull('utm_campaign', utmCampaign);
+  addIfNotNull('utm_term', utmTerm);
+  addIfNotNull('utm_content', utmContent);
+
+  return utmData;
 };
 
 module.exports = getUtmData;
 
-}, {}],
+}, {"./utils":15}],
 6: [function(require, module, exports) {
 var type = require('./type');
 var utils = require('./utils');

amplitude.min.js

@@ -1,26 +1,41 @@
-var getUtmParam = function(name, query) {
+var utils = require('./utils');
+
+var getUtmParam = function getUtmParam(name, query) {
   name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
   var regex = new RegExp("[\\?&]" + name + "=([^&#]*)");
   var results = regex.exec(query);
   return results === null ? undefined : decodeURIComponent(results[1].replace(/\+/g, " "));
 };
 
-var getUtmData = function(rawCookie, query) {
+var getUtmData = function getUtmData(rawCookie, query) {
   // Translate the utmz cookie format into url query string format.
   var cookie = rawCookie ? '?' + rawCookie.split('.').slice(-1)[0].replace(/\|/g, '&') : '';
 
-  var fetchParam = function (queryName, query, cookieName, cookie) {
+  var fetchParam = function fetchParam(queryName, query, cookieName, cookie) {
     return getUtmParam(queryName, query) ||
            getUtmParam(cookieName, cookie);
   };
 
-  return {
-    utm_source: fetchParam('utm_source', query, 'utmcsr', cookie),
-    utm_medium: fetchParam('utm_medium', query, 'utmcmd', cookie),
-    utm_campaign: fetchParam('utm_campaign', query, 'utmccn', cookie),
-    utm_term: fetchParam('utm_term', query, 'utmctr', cookie),
-    utm_content: fetchParam('utm_content', query, 'utmcct', cookie),
+  var utmSource = fetchParam('utm_source', query, 'utmcsr', cookie);
+  var utmMedium = fetchParam('utm_medium', query, 'utmcmd', cookie);
+  var utmCampaign = fetchParam('utm_campaign', query, 'utmccn', cookie);
+  var utmTerm = fetchParam('utm_term', query, 'utmctr', cookie);
+  var utmContent = fetchParam('utm_content', query, 'utmcct', cookie);
+
+  var utmData = {};
+  var addIfNotNull = function addIfNotNull(key, value) {
+    if (!utils.isEmptyString(value)) {
+      utmData[key] = value;
+    }
   };
+
+  addIfNotNull('utm_source', utmSource);
+  addIfNotNull('utm_medium', utmMedium);
+  addIfNotNull('utm_campaign', utmCampaign);
+  addIfNotNull('utm_term', utmTerm);
+  addIfNotNull('utm_content', utmContent);
+
+  return utmData;
 };
 
 module.exports = getUtmData;

src/utm.js

@@ -80,7 +80,7 @@
     }
 </script>
 <script>
-    amplitude.init('a2dbce0e18dfe5f8e74493843ff5c053', null, {includeReferrer: true}, function() {
+    amplitude.init('a2dbce0e18dfe5f8e74493843ff5c053', null, {includeReferrer: true, includeUtm: true}, function() {
         alert(amplitude.options.deviceId);
     });
     amplitude.setVersionName('Web');