Merge branch 'feature/2.4.0'

fblundun · fblundun · commit 29dbff6cf6fa · 2015-03-16T14:59:46.000Z
diff --git a/.gitignore b/.gitignore
@@ -20,6 +20,7 @@ node_modules
 
 **/lodash.js
 tests/pages/*.js
+tests/pages/integration.html
 tags/tag.min.js
 
 # creds for Grunt
diff --git a/.travis.yml b/.travis.yml
@@ -9,7 +9,10 @@ install:
   - unzip ./ngrok.zip\?os=linux\&arch=386\&channel=stable
 before_script:
   - node tests/integration/request_recorder.js &
-  - ./ngrok -authtoken $NGROK_AUTH -subdomain=snowplow -log=stdout 8500 > /dev/null &
+
+  # Create a random ngrok subdomain
+  - export SUBDOMAIN=$RANDOM$RANDOM
+  - ./ngrok -authtoken $NGROK_AUTH -subdomain $SUBDOMAIN -log=stdout 8500 > /dev/null &
 script:
   - grunt travis
 after_script:
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,14 @@
+Version 2.4.0 (2015-03-16)
+--------------------------
+Added ability to modify links allowing cross-domain tracking (#109)
+Added timing event (#320)
+Increased safety of document size detection (#334)
+Started randomly generating ngrok subdomain in integration tests (#333)
+Fixed Vagrant setup to use latest Peru version (#336)
+Stopped caching page URL and referrer URL (#337)
+Stopped caching PerformanceTiming context (#339)
+Added common contexts to link_click, change_form, and submit_form events (#340)
+
 Version 2.3.0 (2015-03-03)
 -------------------------
 Added support for sending events via POST (#168)
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -77,6 +77,8 @@ module.exports = function(grunt) {
 
     pkg: pkg,
 
+    subdomain: process.env.SUBDOMAIN,
+
     lodash: {
       build: {
         dest: 'src/js/lib_managed/lodash.js',
@@ -119,6 +121,13 @@ module.exports = function(grunt) {
         },
         src: ['tags/tag.min.js'],
         dest: 'tags/tag.min.js'
+      },
+      test: {
+        options: {
+          'process': true
+        },
+        src: ['tests/pages/integration-template.html'],
+        dest: 'tests/pages/integration.html'
       }
     },
 
@@ -154,6 +163,7 @@ module.exports = function(grunt) {
           runType: 'client',
           config: 'tests/intern.js',
           suites: [
+            'tests/nonfunctional/helpers.js',
             'tests/nonfunctional/in_queue.js',
             'tests/nonfunctional/proxies.js'
             ]
@@ -250,6 +260,6 @@ module.exports = function(grunt) {
   grunt.registerTask('publish', 'Upload to S3 and invalidate Cloudfront (full semantic version only)', ['upload_setup', 'lodash', 'browserify:main', 'concat:deploy', 'min:deploy', 's3:not_pinned', 'cloudfront:not_pinned']);
   grunt.registerTask('publish-pinned', 'Upload to S3 and invalidate Cloudfront (full semantic version and semantic major version)', ['upload_setup', 'lodash', 'browserify:main', 'concat:deploy', 'min:deploy', 's3', 'cloudfront']);
   grunt.registerTask('test', 'Intern tests', ['browserify:test', 'intern']);
-  grunt.registerTask('travis', 'Intern tests for Travis CI',  ['lodash','browserify:test','intern']);
+  grunt.registerTask('travis', 'Intern tests for Travis CI',  ['lodash','concat:test', 'browserify:test','intern']);
   grunt.registerTask('tags', 'Minifiy the Snowplow invocation tag', ['min:tag', 'concat:tag']);
 }
diff --git a/examples/ads/async.html b/examples/ads/async.html
@@ -38,7 +38,7 @@ <h1>Asynchronous ad tracking examples for snowplow.js</h1>
         ;(function(p,l,o,w,i,n,g){if(!p[i]){p.GlobalSnowplowNamespace=p.GlobalSnowplowNamespace||[];
         p.GlobalSnowplowNamespace.push(i);p[i]=function(){(p[i].q=p[i].q||[]).push(arguments)
         };p[i].q=p[i].q||[];n=l.createElement(o);g=l.getElementsByTagName(o)[0];n.async=1;
-        n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.3.0/sp.js","adTracker"));
+        n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.4.0/sp.js","adTracker"));
 
         window.adTracker('newTracker', rnd, 'd3rkrsqld9gmqf.cloudfront.net', {
             'encodeBase64': false
@@ -110,7 +110,7 @@ <h1>Asynchronous ad tracking examples for snowplow.js</h1>
         ;(function(p,l,o,w,i,n,g){if(!p[i]){p.GlobalSnowplowNamespace=p.GlobalSnowplowNamespace||[];
         p.GlobalSnowplowNamespace.push(i);p[i]=function(){(p[i].q=p[i].q||[]).push(arguments)
         };p[i].q=p[i].q||[];n=l.createElement(o);g=l.getElementsByTagName(o)[0];n.async=1;
-        n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.3.0/sp.js","adTracker"));
+        n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.4.0/sp.js","adTracker"));
 
         window.adTracker('newTracker', rnd, 'd3rkrsqld9gmqf.cloudfront.net', {
             'encodeBase64': false
@@ -141,7 +141,7 @@ <h1>Asynchronous ad tracking examples for snowplow.js</h1>
         ;(function(p,l,o,w,i,n,g){if(!p[i]){p.GlobalSnowplowNamespace=p.GlobalSnowplowNamespace||[];
         p.GlobalSnowplowNamespace.push(i);p[i]=function(){(p[i].q=p[i].q||[]).push(arguments)
         };p[i].q=p[i].q||[];n=l.createElement(o);g=l.getElementsByTagName(o)[0];n.async=1;
-        n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.3.0/sp.js","adTracker"));
+        n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.4.0/sp.js","adTracker"));
         
         window.adTracker('newTracker', rnd, 'd3rkrsqld9gmqf.cloudfront.net', {
             'encodeBase64': false
diff --git a/examples/web/async-large.html b/examples/web/async-large.html
@@ -23,12 +23,13 @@
         ;(function(p,l,o,w,i,n,g){if(!p[i]){p.GlobalSnowplowNamespace=p.GlobalSnowplowNamespace||[];
         p.GlobalSnowplowNamespace.push(i);p[i]=function(){(p[i].q=p[i].q||[]).push(arguments)
         };p[i].q=p[i].q||[];n=l.createElement(o);g=l.getElementsByTagName(o)[0];n.async=1;
-        n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.3.0/sp.js","snowplow_1"));
+        n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.4.0/sp.js","snowplow_1"));
 
         window.snowplow_1('newTracker', 'cf', 'd3rkrsqld9gmqf.cloudfront.net', { // Initialise a tracker
           encodeBase64: false, // Default is true
           appId: 'CFe23a', // Site ID can be anything you want. Set it if you're tracking more than one site in this account
           platform: 'mob',
+          crossDomainLinker: function (link) {return link.id === 'legal'}, // Add duid and timestamp to the link with id "legal"
           contexts: {
             performanceTiming: true
           }
@@ -81,7 +82,7 @@
         ;(function(p,l,o,w,i,n,g){if(!p[i]){p.GlobalSnowplowNamespace=p.GlobalSnowplowNamespace||[];
         p.GlobalSnowplowNamespace.push(i);p[i]=function(){(p[i].q=p[i].q||[]).push(arguments)
         };p[i].q=p[i].q||[];n=l.createElement(o);g=l.getElementsByTagName(o)[0];n.async=1;
-        n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.3.0/sp.js","snowplow_2"));
+        n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.4.0/sp.js","snowplow_2"));
 
         window.snowplow_2('newTracker', 'cf', 'd3rkrsqld9gmqf.cloudfront.net', { // Initialise a tracker
           encodeBase64: false, // Default is true
@@ -243,7 +244,8 @@ <h2>This shows how two users can simultaneously use Snowplow on the same page wi
     </p>
     <p>
       Middle click the links to trigger link click tracking:<br>
-      <a href=http://en.wikipedia.org/wiki/Main_Page id=legal target="_blank" class="link out">Link</a>
+      <!-- crossDomain functionality correctly alters a link with a multiple question marks and a fragment -->
+      <a href=http://en.wikipedia.org/wiki/Main_Page?a=b?c#fragment id=legal target="_blank" class="link out">Link</a>
       <br>
       <a href=http://en.wikipedia.org/wiki/Main_Page id=illegal class="class barred">Link ignored by one user</a>
     </p>
diff --git a/examples/web/async-medium.html b/examples/web/async-medium.html
@@ -24,7 +24,7 @@
         ;(function(p,l,o,w,i,n,g){if(!p[i]){p.GlobalSnowplowNamespace=p.GlobalSnowplowNamespace||[];
         p.GlobalSnowplowNamespace.push(i);p[i]=function(){(p[i].q=p[i].q||[]).push(arguments)
         };p[i].q=p[i].q||[];n=l.createElement(o);g=l.getElementsByTagName(o)[0];n.async=1;
-        n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.3.0/sp.js","new_name_here"));
+        n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.4.0/sp.js","new_name_here"));
 
         window.new_name_here('newTracker', 'cf', 'd3rkrsqld9gmqf.cloudfront.net', {
           encodeBase64: false,
diff --git a/examples/web/async-small.html b/examples/web/async-small.html
@@ -23,7 +23,7 @@
         ;(function(p,l,o,w,i,n,g){if(!p[i]){p.GlobalSnowplowNamespace=p.GlobalSnowplowNamespace||[];
         p.GlobalSnowplowNamespace.push(i);p[i]=function(){(p[i].q=p[i].q||[]).push(arguments)
         };p[i].q=p[i].q||[];n=l.createElement(o);g=l.getElementsByTagName(o)[0];n.async=1;
-        n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.3.0/sp.js","snowplow"));
+        n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.4.0/sp.js","snowplow"));
 
         window.snowplow('newTracker', 'cf', 'd3rkrsqld9gmqf.cloudfront.net', { // Initialise a tracker
           encodeBase64: false, // Default is true
diff --git a/examples/web/sync.html b/examples/web/sync.html
@@ -19,7 +19,7 @@
 
     <!-- Snowplow starts plowing -->
     <script type="text/javascript">
-    var spSrc = ('https:' == document.location.protocol ? 'https' : 'http') + '://d1fc8wv8zag5ca.cloudfront.net/2.3.0/sp.js';
+    var spSrc = ('https:' == document.location.protocol ? 'https' : 'http') + '://d1fc8wv8zag5ca.cloudfront.net/2.4.0/sp.js';
     document.write(unescape("%3Cscript src='" + spSrc + "' type='text/javascript'%3E%3C/script%3E"));
     </script>
     <script type="text/javascript">
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "snowplow-tracker",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "devDependencies": {
     "JSON": "~1.0.0",
     "browser-cookie-lite": "~0.3.1",
diff --git a/src/js/forms.js b/src/js/forms.js
@@ -41,9 +41,10 @@ var lodash = require('./lib_managed/lodash'),
  *
  * @param object core The tracker core
  * @param string trackerId Unique identifier for the tracker instance, used to mark tracked elements
+ * @param function contextAdder Function to add common contexts like PerformanceTiming to all events
  * @return object formTrackingManager instance
  */
-object.getFormTrackingManager = function (core, trackerId) {
+object.getFormTrackingManager = function (core, trackerId, contextAdder) {
 
 	// Tag names of mutable elements inside a form
 	var innerElementTags = ['textarea', 'input', 'select'];
@@ -123,7 +124,7 @@ object.getFormTrackingManager = function (core, trackerId) {
 			var elt = e.target;
 			var type = elt.nodeName.toUpperCase() === 'INPUT' ? elt.type : null;
 			var value = (elt.type === 'checkbox' && !elt.checked) ? null : elt.value;
-			core.trackFormChange(getParentFormName(elt), getFormElementName(elt), elt.nodeName, type, lodash.map(elt.classList), value, context);
+			core.trackFormChange(getParentFormName(elt), getFormElementName(elt), elt.nodeName, type, lodash.map(elt.classList), value, contextAdder(context));
 		};
 	}
 
@@ -134,7 +135,7 @@ object.getFormTrackingManager = function (core, trackerId) {
 		return function (e) {
 			var elt = e.target;
 			var innerElements = getInnerFormElements(elt);
-			core.trackFormSubmission(getFormElementName(elt), lodash.map(elt.classList), innerElements, context);
+			core.trackFormSubmission(getFormElementName(elt), lodash.map(elt.classList), innerElements, contextAdder(context));
 		};
 	}
 
diff --git a/src/js/lib/detectors.js b/src/js/lib/detectors.js
@@ -170,10 +170,12 @@
 	 */
 	object.detectDocumentSize = function() {
 		var de = documentAlias.documentElement, // Alias
-			be = documentAlias.body;
+			be = documentAlias.body,
+
+			// document.body may not have rendered, so check whether be.offsetHeight is null
+			bodyHeight = be ? Math.max(be.offsetHeight, be.scrollHeight) : 0;
 		var w = Math.max(de.clientWidth, de.offsetWidth, de.scrollWidth);
-		var h = Math.max(de.clientHeight, de.offsetHeight, de.scrollHeight,
-		                 be.offsetHeight, be.scrollHeight);
+		var h = Math.max(de.clientHeight, de.offsetHeight, de.scrollHeight, bodyHeight);
 		return isNaN(w) || isNaN(h) ? '' : w + 'x' + h;
 	};
 
diff --git a/src/js/lib/helpers.js b/src/js/lib/helpers.js
@@ -81,10 +81,16 @@
 		return domain;
 	};
 
-	/*
-	 * Get page referrer
+	/**
+	 * Get page referrer. In the case of a single-page app,
+	 * if the URL changes without the page reloading, pass
+	 * in the old URL. It will be returned unless overriden
+	 * by a "refer(r)er" parameter in the querystring.
+	 *
+	 * @param string oldLocation Optional.
+	 * @return string The referrer
 	 */
-	object.getReferrer = function () {
+	object.getReferrer = function (oldLocation) {
 
 		var referrer = '';
 		
@@ -96,6 +102,11 @@
 			return fromQs;
 		}
 
+		// In the case of a single-page app, return the old URL
+		if (oldLocation) {
+			return oldLocation;
+		}
+
 		try {
 			referrer = window.top.document.referrer;
 		} catch (e) {
@@ -207,4 +218,40 @@
 		}
 	}
 
+	/**
+	 * Add a name-value pair to the querystring of a URL
+	 *
+	 * @param string url URL to decorate
+	 * @param string name Name of the querystring pair
+	 * @param string value Value of the querystring pair
+	 */
+	object.decorateQuerystring = function (url, name, value) {
+		var initialQsParams = name + '=' + value;
+		var hashSplit = url.split('#');
+		var qsSplit = hashSplit[0].split('?');
+		var beforeQuerystring = qsSplit.shift();
+		// Necessary because a querystring may contain multiple question marks
+		var querystring = qsSplit.join('?');
+		if (!querystring) {
+			querystring = initialQsParams;
+		} else {
+			// Whether this is the first time the link has been decorated
+			var initialDecoration = true;
+			var qsFields = querystring.split('&');
+			for (var i=0; i<qsFields.length; i++) {
+				if (qsFields[i].substr(0, name.length + 1) === name + '=') {
+					initialDecoration = false;
+					qsFields[i] = initialQsParams;
+					querystring = qsFields.join('&');
+					break;
+				}
+			}
+			if (initialDecoration) {
+				querystring = initialQsParams + '&' + querystring;
+			}
+		}
+		hashSplit[0] = beforeQuerystring + '?' + querystring;
+		return hashSplit.join('#');
+	}
+
 }());
diff --git a/src/js/links.js b/src/js/links.js
@@ -41,9 +41,10 @@ var lodash = require('./lib_managed/lodash'),
  *
  * @param object core The tracker core
  * @param string trackerId Unique identifier for the tracker instance, used to mark tracked links
+ * @param function contextAdder Function to add common contexts like PerformanceTiming to all events
  * @return object linkTrackingManager instance
  */
-object.getLinkTrackingManager = function (core, trackerId) {
+object.getLinkTrackingManager = function (core, trackerId, contextAdder) {
 
 	// Filter function used to determine whether clicks on a link should be tracked
 	var linkTrackingFilter,
@@ -96,7 +97,7 @@ object.getLinkTrackingManager = function (core, trackerId) {
 
 				// decodeUrl %xx
 				sourceHref = unescape(sourceHref);
-				core.trackLinkClick(sourceHref, elementId, elementClasses, elementTarget, elementContent, context);
+				core.trackLinkClick(sourceHref, elementId, elementClasses, elementTarget, elementContent, contextAdder(context));
 			}
 		}
 	}
diff --git a/src/js/tracker.js b/src/js/tracker.js
diff --git a/tests/functional/detectors.js b/tests/functional/detectors.js
diff --git a/tests/nonfunctional/helpers.js b/tests/nonfunctional/helpers.js
diff --git a/tests/pages/integration-template.html b/tests/pages/integration-template.html
diff --git a/vagrant/peru.yaml b/vagrant/peru.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "snowplow-tracker",`
`3`		`- "version": "2.3.0",`
	`3`	`+ "version": "2.4.0",`
`4`	`4`	`"devDependencies": {`
`5`	`5`	`"JSON": "~1.0.0",`
`6`	`6`	`"browser-cookie-lite": "~0.3.1",`