Merge branch 'release/2.6.0'

Author: alexanderdean

.travis.yml

@@ -5,14 +5,14 @@ language: node_js
 install:
   - npm install
   - npm install -g grunt-cli
-  - wget https://api.equinox.io/1/Applications/ap_pJSFC5wQYkAyI0FIVwKYs9h1hW/Updates/Asset/ngrok.zip\?os\=linux\&arch\=386\&channel\=stable
-  - unzip ./ngrok.zip\?os=linux\&arch=386\&channel=stable
+  - wget https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip
+  - unzip ./ngrok-stable-linux-amd64.zip
 before_script:
   - node tests/integration/request_recorder.js &
 
   # Create a random ngrok subdomain
   - export SUBDOMAIN=$RANDOM$RANDOM
-  - ./ngrok -authtoken $NGROK_AUTH -subdomain $SUBDOMAIN -log=stdout 8500 > /dev/null &
+  - ./ngrok http -authtoken $NGROK_AUTH -subdomain $SUBDOMAIN -log=stdout 8500 > /dev/null &
 script:
   - grunt travis
 after_script:

CHANGELOG

@@ -1,3 +1,25 @@
+Version 2.6.0 (2016-03-03)
+--------------------------
+Bumped ngrok version used in CI to 2.x (#460)
+Allowed random upload path in grunt task (#461)
+Ensured that PerformanceTiming context doesn't contain properties inherited from Object.prototype (#458)
+Added `forceUnsecureTracker` Tracker argument, thanks @bloodyowl! (#374)
+Added subset of Augur data as a new context (#386)
+Added deprecation warning to setSessionCookieTimeout (#394)
+Added setting to automatically use top-level domain for duid (#409)
+Added Optimizely contexts (#448)
+Added trackEnhancedEcommerceAction() method (#452)
+Added addEnhancedEcommerceActionContext() method (#453)
+Added addEnhancedEcommerceImpressionContext() method (#454)
+Added addEnhancedEcommerceProductContext() method (#455)
+Added addEnhancedEcommercePromoContext() method (#456)
+Made domainUserId a UUID (#274)
+Attached device sent timestamp (stm) to events at last possible moment (#355)
+Attempting to create a new tracker using an existing namespace should do nothing (#411)
+Using a different library to publish to S3 (#422)
+Prevented error running grunt-cloudfront (#426)
+Respected doNotTrack in IE 11 and Safari 7.1.3+, thanks @grzegorzewald! (#440)
+
 Version 2.5.3 (2015-11-10)
 --------------------------
 Bumped Node version to 4.1.2 in .travis.yml (#420)

Gruntfile.js

@@ -181,8 +181,7 @@ module.exports = function(grunt) {
 
   grunt.loadNpmTasks('grunt-contrib-concat');
   grunt.loadNpmTasks('grunt-yui-compressor');
-  grunt.loadNpmTasks('grunt-s3');
-  grunt.loadNpmTasks('grunt-cloudfront');
+  grunt.loadNpmTasks('grunt-aws');
   grunt.loadNpmTasks('grunt-browserify');
   grunt.loadNpmTasks('intern');
   grunt.loadNpmTasks('grunt-lodash');
@@ -194,63 +193,60 @@ module.exports = function(grunt) {
 
     grunt.config('s3', {
       options: {
-        key: '<%= aws.key %>',
-        secret: '<%= aws.secret %>',
+        accessKeyId: '<%= aws.key %>',
+        secretAccessKey: '<%= aws.secret %>',
         bucket: '<%= aws.bucket %>',
         access: 'public-read',
-        gzip: true
+        region: '<%= aws.region %>',
+        gzip: true,
+        cache: false
       },
       not_pinned: {
         options: {
           headers: {
-            'Cache-Control': 'max-age=315360000'
+            CacheControl: "max-age=315360000"
           }
         },
-        upload: [
+        files: [
           {
-            src: 'dist/sp.js',
-            dest: '<%= pkg.version %>/sp.js'
+            src: ["dist/sp.js"],
+            dest: "<%= aws.uploadPath %>"
           }
         ]
       },
       pinned: {
         options: {
           headers: {
-            'Cache-Control': 'max-age=3600'
+            CacheControl: "max-age=3600"
           }
         },
-        upload: [
+        files: [
           {
-            src: 'dist/sp.js',
-            dest: '<%= pkg.pinnedVersion %>/sp.js'
-          }        
+            src: ["dist/sp.js"],
+            dest: "<%= aws.uploadPath %>"
+          }
         ]
-      },  
+      }
     });
 
     grunt.config('cloudfront', {
       options: {
-        region: 'eu-east-1',
-        distributionId: '<%= aws.distribution %>',
-        listInvalidations: true,
-        listDistributions: true,
-        credentials: {
-          accessKeyId: '<%= aws.key %>',
-          secretAccessKey: '<%= aws.secret %>'
-        }
+        accessKeyId: '<%= aws.key %>',
+        secretAccessKey: '<%= aws.secret %>',
+        distributionId: '<%= aws.distribution %>'
       },
       not_pinned: {
-        CallerReference: Date.now().toString(),
-        Paths: {
-          Quantity: 1,
-          Items: ['/<%= pkg.version %>/sp.js']
+        options: {
+          invalidations: [
+            '/<%= aws.uploadPath %>'
+          ]
         }
       },
       pinned: {
-        CallerReference: Date.now().toString(),
-        Paths: {
-          Quantity: 1,
-          Items: ['/<%= pkg.pinnedVersion %>/sp.js']
+        options: {
+          invalidations: [
+            '/<%= aws.uploadPath %>'
+          ]
         }
       }
     });

aws.sample.json

@@ -2,5 +2,7 @@
   "key":    "ADD HERE",
   "secret": "ADD HERE",
   "bucket": "ADD HERE",
-  "distribution": "ADD HERE"
+  "region": "ADD HERE",
+  "distribution": "ADD HERE",
+  "uploadPath": "ADD HERE"
 }

package.json

@@ -1,15 +1,14 @@
 {
   "name": "snowplow-tracker",
-  "version": "2.5.3",
+  "version": "2.6.0",
   "devDependencies": {
     "JSON": "~1.0.0",
     "browser-cookie-lite": "~0.3.1",
     "grunt": "~0.4.2",
     "grunt-browserify": "~4.0.1",
-    "grunt-cloudfront": "^0.2.0",
     "grunt-contrib-concat": "~0.3.0",
     "grunt-lodash": "~0.3.0",
-    "grunt-s3": "~0.2.0-alpha.3",
+    "grunt-aws": "~0.6.1",
     "grunt-yui-compressor": "git://github.com/snowplow/grunt-yui-compressor.git#0.4.0",
     "intern": "^3.0.6",
     "jstimezonedetect": "1.0.5",
@@ -25,7 +24,8 @@
     "Alex Dean",
     "Simon Andersson",
     "Anthon Pang",
-    "Fred Blundun"
+    "Fred Blundun",
+    "Joshua Beemster"
   ],
   "description": "JavaScript tracker for Snowplow",
   "repository": {

src/js/in_queue.js

@@ -112,8 +112,13 @@
 		 */
 		function createNewNamespace(namespace, endpoint, argmap) {
 			argmap = argmap || {};
-			trackerDictionary[namespace] = new TrackerConstructor(functionName, namespace, version, pageViewId, mutSnowplowState, argmap);
-			trackerDictionary[namespace].setCollectorUrl(endpoint);
+
+			if (!trackerDictionary.hasOwnProperty(namespace)) {
+				trackerDictionary[namespace] = new TrackerConstructor(functionName, namespace, version, pageViewId, mutSnowplowState, argmap);
+				trackerDictionary[namespace].setCollectorUrl(endpoint);
+			} else {
+				helpers.warn('Tracker namespace ' + namespace + ' already exists.');
+			}
 		}
 
 		/**

src/js/lib/helpers.js

@@ -35,6 +35,7 @@
 
 	var 
 		lodash = require('../lib_managed/lodash'),
+		cookie = require('browser-cookie-lite'),
 
 		object = typeof exports !== 'undefined' ? exports : this; // For eventual node.js environment support
 
@@ -290,4 +291,102 @@
 		}
 	};
 
+	/**
+	 * Finds the root domain
+	 */
+	object.findRootDomain = function () {
+		var cookiePrefix = '_sp_root_domain_test_';
+		var cookieName = cookiePrefix + new Date().getTime();
+		var cookieValue = '_test_value_' + new Date().getTime();
+
+		var split = window.location.hostname.split('.');
+		var position = split.length - 1;
+		while (position >= 0) {
+			var currentDomain = split.slice(position, split.length).join('.');
+			cookie.cookie(cookieName, cookieValue, 0, '/', currentDomain);
+			if (cookie.cookie(cookieName) === cookieValue) {
+
+				// Clean up created cookie(s)
+				object.deleteCookie(cookieName, currentDomain);
+				var cookieNames = object.getCookiesWithPrefix(cookiePrefix);
+				for (var i = 0; i < cookieNames.length; i++) {
+					object.deleteCookie(cookieNames[i], currentDomain);
+				}
+
+				return currentDomain;
+			}
+			position -= 1;
+		}
+
+		// Cookies cannot be read
+		return window.location.hostname;
+	};
+
+	/**
+	 * Checks whether a value is present within an array
+	 *
+	 * @param val The value to check for
+	 * @param array The array to check within
+	 * @return boolean Whether it exists
+	 */
+	object.isValueInArray = function (val, array) {
+		for (var i = 0; i < array.length; i++) {
+			if (array[i] === val) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+	/**
+	 * Deletes an arbitrary cookie by setting the expiration date to the past
+	 *
+	 * @param cookieName The name of the cookie to delete
+	 * @param domainName The domain the cookie is in
+	 */
+	object.deleteCookie = function (cookieName, domainName) {
+		cookie.cookie(cookieName, '', -1, '/', domainName);
+	};
+
+	/**
+	 * Fetches the name of all cookies beginning with a certain prefix
+	 *
+	 * @param cookiePrefix The prefix to check for
+	 * @return array The cookies that begin with the prefix
+	 */
+	object.getCookiesWithPrefix = function (cookiePrefix) {
+		var cookies = document.cookie.split("; ");
+		var cookieNames = [];
+		for (var i = 0; i < cookies.length; i++) {
+			if (cookies[i].startsWith(cookiePrefix)) {
+				cookieNames.push(cookies[i]);
+			}
+		}
+		return cookieNames;
+	};
+
+	/**
+	 * Parses an object and returns either the
+	 * integer or undefined.
+	 *
+	 * @param obj The object to parse
+	 * @return the result of the parse operation
+	 */
+	object.parseInt = function (obj) {
+		var result = parseInt(obj);
+		return isNaN(result) ? undefined : result;
+	}
+
+	/**
+	 * Parses an object and returns either the
+	 * number or undefined.
+	 *
+	 * @param obj The object to parse
+	 * @return the result of the parse operation
+	 */
+	object.parseFloat = function (obj) {
+		var result = parseFloat(obj);
+		return isNaN(result) ? undefined : result;
+	}
+
 }());

src/js/out_queue.js

@@ -179,7 +179,7 @@
 				if (body.bytes >= maxPostBytes) {
 					helpers.warn("Event of size " + body.bytes + " is too long - the maximum size is " + maxPostBytes);
 					var xhr = initializeXMLHttpRequest(configCollectorUrl);
-					xhr.send(encloseInPayloadDataEnvelope([body.evt]));
+					xhr.send(encloseInPayloadDataEnvelope(attachStmToEvent([body.evt])));
 					return;
 				} else {
 					outQueue.push(body);
@@ -268,8 +268,9 @@
 				var batch = lodash.map(outQueue.slice(0, numberToSend), function (x) {
 					return x.evt;
 				});
+
 				if (batch.length > 0) {
-					xhr.send(encloseInPayloadDataEnvelope(batch));
+					xhr.send(encloseInPayloadDataEnvelope(attachStmToEvent(batch)));
 				}
 
 			} else {
@@ -288,7 +289,7 @@
 					executingQueue = false;
 				};
 
-				image.src = configCollectorUrl + nextRequest;
+				image.src = configCollectorUrl + nextRequest.replace('?', '?stm=' + new Date().getTime() + '&');
 			}
 		}
 
@@ -319,6 +320,19 @@
 			});
 		}
 
+		/**
+		 * Attaches the STM field to outbound POST events.
+		 *
+		 * @param events the events to attach the STM to
+		 */
+		function attachStmToEvent(events) {
+			var stm = new Date().getTime().toString();
+			for (var i = 0; i < events.length; i++) {
+				events[i]['stm'] = stm;
+			}
+			return events
+		}
+
 		return {
 			enqueueRequest: enqueueRequest,
 			executeQueue: executeQueue