More work on the new InQueueManager. Relocated custom lodash library to src/js/lib_managed.

Author: fblundun

CHANGELOG

@@ -25,6 +25,8 @@ Implement enableLinkTracking support (#51) (TODO)
 Replaced hard-coded version with template value (#120) (TODO)
 Added Sauce Labs small button at top of README (#123) (TODO)
 Added Sauce full test summary widget (long bar) at bottom of README (#124) (TODO)
+Added support for namespacing (#4) (TODO)
+Passed tracker namespace through to collector in Tracker Protocol (#126) (TODO)
 
 Version 1.0.1 (2014-04-09)
 --------------------------

Gruntfile.js

@@ -79,7 +79,7 @@ module.exports = function(grunt) {
 
     lodash: {
       build: {
-        dest: 'src/js/lib/lodash.js',
+        dest: 'src/js/lib_managed/lodash.js',
         options: {
           exports: 'node',
           include: 'isArray, isFunction, isString, isObject, isDate, isUndefined, isNull, map',

src/js/in_queue.js

@@ -35,7 +35,9 @@
 ;(function() {
 
 	var
-		lodash = require('./lib/lodash'),
+		lodash = require('./lib_managed/lodash'),
+		tracker = require('./tracker'),
+
 		object = typeof exports !== 'undefined' ? exports : this; // For eventual node.js environment support
 
 	/************************************************************
@@ -44,7 +46,81 @@
 	 *   after the Tracker has been initialized and loaded
 	 ************************************************************/
 
-	object.AsyncQueueProxy = function(asyncTracker, asyncQueue) {
+	object.InQueueManager = function(version, mutSnowplowState, asyncQueue) {
+
+		var trackerDictionary = {};
+
+		/*
+		 * Get an array of trackers to which a function should be applied.
+		 *
+		 * @param names array List of namespaces to use. If empty, use all namespaces.
+		 */
+		function getNamedTrackers(names) {
+			var namedTrackers = [];
+			if (!names || names.length === 0) {
+				namedTrackers = lodash.values(trackerDictionary);
+			} else {
+				for (var i = 0; i < names.length; i++) {
+					if (trackerDictionary.hasOwnProperty(names[i])) {
+						namedTrackers.push(trackerDictionary[names[i]]);
+					} else if (!lodash.isUndefined(console)) {
+						console.log('Warning: Tracker namespace "' + names[i] + '" not configured');
+					}
+				}
+			}
+			
+			return namedTrackers;
+		}
+
+		/*
+		 * Legacy support for input of the form _snaq.push(['setCollectorCf', 'd34uzc5hjrimh8'])
+		 * 
+		 * @param f string Either 'setCollectorCf' or 'setCollectorUrl'
+		 * @param endpoint string
+		 * @param namespace string Optional tracker name
+		 * 
+		 * TODO: remove this in 1.2.0
+		 */
+		function legacyCreateNewNamespace(f, endpoint, namespace) {
+			if (!lodash.isUndefined(console)) {
+				console.log(f, 'is deprecated.'); //TODO: more instructions for switching
+			}
+
+			var name;
+
+			if (lodash.isUndefined(namespace)) {
+				name = 'default'    // TODO: make default names work properly
+			} else {
+				name = namespace;
+			}
+
+			createNewNamespace(name);
+			trackerDictionary[name][f](endpoint);
+		}
+
+		/*
+		 * Initiate a new tracker namespace
+		 *
+		 * @param namespace string
+		 * @param endpoint string Of the form d3rkrsqld9gmqf.cloudfront.net
+		 */
+		function createNewNamespace(namespace, endpoint) {
+			trackerDictionary[namespace] = new tracker.Tracker(version, mutSnowplowState) // TODO: what of argmap?
+			trackerDictionary[namespace].setCollectorUrl(endpoint);
+		}
+
+		/*
+		 * Output an array of the form ['functionName', [trackerName1, trackerName2, ...]]
+		 *
+		 * @param inputString String
+		 */
+		function parseInputString(inputString) {
+			var separatedString = inputString.split(':'),
+				extractedFunction = separatedString[0],
+				extractedNames = (separatedString.length > 1) ? separatedString[1].split(';') : [];
+
+			return [extractedFunction, extractedNames];
+		}
 
 		/*
 		 * apply wrapper
@@ -60,6 +136,23 @@
 			for (i = 0; i < arguments.length; i += 1) {
 				parameterArray = arguments[i];
 				f = parameterArray.shift();
+				inputString = parameterArray.shift();
+				parsedString = parseInputString(inputString);
+				f = parsedString[0];
+				names = parsedString[1];
+
+				if (f === 'newTracker') {
+					createNewNamespace(parameterArray[0], parameterArray[1]);
+					continue;
+				}
+
+				if ((f === 'setCollectorCf' || f === 'setCollectorUrl') && (!names || names.length === 0)) {
+					legacyCreateNewNamespace(f, parameterArray[0], parameterArray[1]);
+
+					continue;
+				}
+
+				namedTrackers = getNamedTrackers(names);
 
 				if (lodash.isString(f)) {
 					asyncTracker[f].apply(asyncTracker, parameterArray);

src/js/lib/detectors.js

@@ -35,7 +35,7 @@
 ;(function() {
 
 	var 
-		lodash = require('./lodash'),
+		lodash = require('../lib_managed/lodash'),
 		helpers = require('./helpers'),
 		cookie = require('./cookie'),
 		murmurhash3_32_gc = require('murmurhash').v3,

src/js/lib/helpers.js

@@ -34,7 +34,7 @@
 ;(function () {
 
 	var 
-		lodash = require('./lodash'),
+		lodash = require('../lib_managed/lodash'),
 
 		object = typeof exports !== 'undefined' ? exports : this; // For eventual node.js environment support
 

src/js/out_queue.js

@@ -36,33 +36,34 @@
 
 	var
 		json2 = require('JSON'),
+		lodash = require('./lib_managed/lodash'),
 		localStorageAccessible = require('./lib/detectors').localStorageAccessible(),
 		object = typeof exports !== 'undefined' ? exports : this, // For eventual node.js environment support
 
 		executingQueue = false,
-		imageQueue;
+		outQueue;
 
 	if (localStorageAccessible) {
 		// Catch any JSON parse errors that might be thrown
 		try {
-			imageQueue = json2.parse(localStorage.getItem('snaqImageQueue'));
+			outQueue = json2.parse(localStorage.getItem('snaqoutQueue'));
 		}
 		catch(e) {}
 	}
 
 	// Initialize to and empty array if we didn't get anything out of localStorage
-	if (typeof imageQueue === 'undefined' || imageQueue == null) {
-		imageQueue = [];
+	if (typeof outQueue === 'undefined' || outQueue == null) {
+		outQueue = [];
 	}
 
 	/*
 	 * Queue an image beacon for submission to the collector.
 	 * If we're not processing the queue, we'll start.
 	 */
-	object.queueImage = function(request, configCollectorUrl) {
-		imageQueue.push(request);
+	object.enqueueImage = function(request, configCollectorUrl) {
+		outQueue.push([request, configCollectorUrl]);
 		if (localStorageAccessible) {
-			localStorage.setItem('snaqImageQueue', json2.stringify(imageQueue));
+			localStorage.setItem('snaqoutQueue', json2.stringify(outQueue));
 		}
 
 		if (!executingQueue) {
@@ -74,14 +75,15 @@
 	 * Run through the queue of image beacons, sending them one at a time.
 	 * Stops processing when we run out of queued requests, or we get an error.
 	 */
-	function executeQueue(configCollectorUrl) {
-		if (imageQueue.length < 1) {
+	function executeQueue() {
+		if (outQueue.length < 1) {
 			executingQueue = false;
 			return;
 		}
 
 		executingQueue = true;
-		var nextRequest = imageQueue[0];
+		var nextRequest = outQueue[0][0],
+			collectorUrl = outQueue[0][1];
 
 		/*
 		 * Send image request to the Snowplow Collector using GET.
@@ -97,9 +99,9 @@
 		// Okay? Let's proceed.
 		image.onload = function() {
 			// We succeeded, let's remove this request from the queue
-			imageQueue.shift();
+			outQueue.shift();
 			if (localStorageAccessible) {
-				localStorage.setItem('snaqImageQueue', json2.stringify(imageQueue));
+				localStorage.setItem('snaqoutQueue', json2.stringify(outQueue));
 			}
 			executeQueue(configCollectorUrl);
 		}

src/js/payload.js

@@ -35,7 +35,7 @@
 ;(function() {
 
 	var
-		lodash = require('./lib/lodash'),
+		lodash = require('./lib_managed/lodash'),
 		json2 = require('JSON'),
 		base64 = require('./lib/base64'),
 

src/js/snowplow.js

@@ -200,10 +200,8 @@
 		helpers.addEventListener(windowAlias, 'beforeunload', beforeUnloadHandler, false);
 		addReadyListener();
 
-		asyncTracker = new tracker.Tracker(version, mutSnowplowState); // No argmap
-
-		// Now replace initialization array with proxy object
-		windowAlias._snaq = new queue.AsyncQueueProxy(asyncTracker, windowAlias._snaq);
+		// Now replace initialization array with queue manager object
+		windowAlias._snaq = new queue.InQueueManager(version, mutSnowplowState, windowAlias._snaq);
 
 		/************************************************************
 		 * Public data and methods