Changed trackUnstructEvent to take a JSON containing schema and data fields (snowplow#197)

fblundun · fblundun · commit edda1232da5c · 2014-06-30T09:28:49.000+01:00
Added hardcoded schema to unstructured events (snowplow#196)
diff --git a/CHANGELOG b/CHANGELOG
@@ -35,7 +35,9 @@ Added pageUnloadTimer option to argmap (#171)
 Added event vendor as argument to trackUnstructEvent (#157)
 Added custom context vendor configuration option (#180)
 Removed type hints from unstructured events and custom contexts (#163)
-Added hardcoded header to custom context arrays (#199)
+Added hardcoded schema to custom context arrays (#199)
+Added hardcoded schema to unstructured events (#196)
+Changed trackUnstructEvent to take a JSON containing schema and data fields (#197)
 
 Version 1.0.3 (2014-06-27)
 --------------------------
diff --git a/examples/web/async-medium.html b/examples/web/async-medium.html
@@ -51,14 +51,14 @@
         // window.new_name_here('trackPageView', 'Async Test'); // Track the page view with custom title
         window.new_name_here('trackPageView', null , [ // Auto-set page title; add page context
           {
-            schema: "com.example_company/page/1.2.1",
+            schema: "com.example_company/page/json/1-2-1",
             data: {
               pageType: 'test',
               lastUpdated: new Date(2014,1,26)
             }
           },
           {
-            schema: "com.example_company/user/2.0.0",
+            schema: "com.example_company/user/json/2-0-0",
             data: {
               userType: 'tester',
             }
@@ -87,16 +87,18 @@
             alert("Viewing a product");
 
             // Only the "uri" tracker will track the Viewed Product event
-            window.new_name_here('com.acme_company', 'trackUnstructEvent:uri', 'Viewed Product',
-                {
+            window.new_name_here('trackUnstructEvent:uri', {
+                schema: 'com.acme_company/viewed_product/json/5.0.0',
+                data: {
                     productId: 'ASO01043',
                     category: 'Dresses',
                     brand: 'ACME',
                     returning: true,
                     price: 49.95,
                     sizes: ['xs', 's', 'l', 'xl', 'xxl'],
                     availableSince: new Date(2013,3,7)
-                });
+              }
+            });
         }
 
         function addEcommerceTransaction() {
@@ -130,7 +132,7 @@
               '2',                    // quantity - required
               'JPY',                  // currency
               [{                      // context
-                schema: "com.example_company/products/1.0.0",
+                schema: "com.example_company/products/json/1-0-0",
                 data: {
                   "launchDate": new Date(2013,3,7)
                 }
diff --git a/examples/web/async-small.html b/examples/web/async-small.html
@@ -40,14 +40,14 @@
         // window.snowplow('trackPageView', 'Async Test'); // Track the page view with custom title
         window.snowplow('trackPageView', null , [ // Auto-set page title; add page context
           {
-            schema: "com.example_company/page/1.2.1",
+            schema: "com.example_company/page/json/1-2-1",
             data: {
               pageType: 'test',
               lastUpdated: new Date(2014,1,26)
             }
           },
           {
-            schema: "com.example_company/user/2.0.0",
+            schema: "com.example_company/user/json/2-0-0",
             data: {
               userType: 'tester',
             }
@@ -70,16 +70,18 @@
         }
         function viewProduct() {
             alert("Viewing a product");
-            window.snowplow('trackUnstructEvent', 'com.example_company', 'Viewed Product',
-                {
+            window.snowplow('trackUnstructEvent', {
+                schema: 'com.acme_company/viewed_product/json/5.0.0',
+                data: {
                     productId: 'ASO01043',
                     category: 'Dresses',
                     brand: 'ACME',
                     returning: true,
                     price: 49.95,
                     sizes: ['xs', 's', 'l', 'xl', 'xxl'],
                     availableSince: new Date(2013,3,7)
-                });
+              }
+            });
         }
 
         function addEcommerceTransaction() {
@@ -111,7 +113,7 @@
               '2',                    // quantity - required
               'JPY',                  // currency
               [{                      // context
-                schema: "com.example_company/products/1.0.0",
+                schema: "com.example_company/products/json/1-0-0",
                 data: {
                   "launchDate": new Date(2013,3,7)
                 }
diff --git a/src/js/tracker.js b/src/js/tracker.js
@@ -97,7 +97,10 @@
 			configDefaultVendor = 'com.snowplowanalytics',
 
 			// The schema against which custom context arrays should be validated
-			configContextSchema = "com.snowplowanalytics/contexts/1.0.0",
+			configContextSchema = 'com.snowplowanalytics/contexts/json/1-0-0',
+
+			// The schema against which unstructured event envelopes should be validated
+			configUnstructEventSchema = 'com.snowplowanalytics/unstruct_event/json/1-0-0',
 
 			// Platform defaults to web for this tracker
 			configPlatform = argmap.hasOwnProperty('platform') ? argmap.platform : 'web',
@@ -673,20 +676,23 @@
 		/**
 		 * Log an unstructured event happening on this page
 		 *
-		 * @param string name The name of the event
-		 * @param object properties The properties of the event
-		 * @param string eventVendor The author of the event
+		 * @param object eventJson Contains the properties and schema location for the event
 		 * @param object context Custom context relating to the event
 		 */
-		function logUnstructEvent(eventVendor, name, properties, context) {
-			var sb = payload.payloadBuilder(configEncodeBase64);
-			sb.add('e', 'ue'); // 'ue' for Unstructured Event
-			sb.add('ue_na', name);
-			sb.addJson('ue_px', 'ue_pr', properties);
-			sb.addJson('cx', 'co', completeContext(context));
-			sb.add('evn', eventVendor);
-			var request = getRequest(sb);
-			sendRequest(request, configTrackerPause);
+		function logUnstructEvent(eventJson, context) {
+			helpers.deleteEmptyProperties(eventJson.data);
+			if (!lodash.isEmpty(eventJson.data)) {
+				var envelope = {
+					schema: configUnstructEventSchema,
+					data: eventJson
+				},
+					sb = payload.payloadBuilder(configEncodeBase64);
+				sb.add('e', 'ue'); // 'ue' for Unstructured Event
+				sb.addJson('ue_px', 'ue_pr', envelope);
+				sb.addJson('cx', 'co', completeContext(context));
+				var request = getRequest(sb);
+				sendRequest(request, configTrackerPause);
+			}
 		}
 
 		/**
@@ -768,14 +774,17 @@
 		// TODO: this functionality is not yet fully implemented.
 		// See https://github.com/snowplow/snowplow/issues/75
 		function logLink(targetUrl, elementId, elementClasses, elementTarget, context) {
-			var linkClickJson = {
-				targetUrl: targetUrl,				
-				elementId: elementId,
-				elementClasses: elementClasses,
-				elementTarget: elementTarget
+			var eventJson = {
+				schema: configDefaultVendor + '/link_click/json/1-0-0',
+				data: {
+					targetUrl: targetUrl,				
+					elementId: elementId,
+					elementClasses: elementClasses,
+					elementTarget: elementTarget
+				},
 			};
 
-			logUnstructEvent(configDefaultVendor, 'link_click', helpers.deleteEmptyProperties(linkClickJson), context);
+			logUnstructEvent(eventJson, context);
 		}
 
 		/**
@@ -1355,13 +1364,11 @@
 			/**
 			 * Track an unstructured event happening on this page.
 			 *
-			 * @param string eventVendor The author of the event
-			 * @param string name The name of the event
-			 * @param object properties The properties of the event			 
-			 * @param object Custom context relating to the event
+			 * @param object eventJson Contains the properties and schema location for the event
+			 * @param object context Custom context relating to the event
 			 */
-			trackUnstructEvent: function (eventVendor, name, properties, context) {
-				logUnstructEvent(eventVendor, name, properties, context);
+			trackUnstructEvent: function (eventJson, context) {
+				logUnstructEvent(eventJson, context);
 			},
 
 			/**
@@ -1504,18 +1511,21 @@
 			 */			
 			trackAdImpression: function(impressionId, costModel, cost, targetUrl, bannerId, zoneId, advertiserId, campaignId, context) {
 				trackCallback(function () {
-					var adImpressionJson = {
-						impressionId: impressionId,
-						costModel: costModel,						
-						cost: cost,
-						bannerId: bannerId,
-						targetUrl: targetUrl,
-						zoneId: zoneId,
-						advertiserId: advertiserId,
-						campaignId: campaignId
+					var eventJson = {
+						schema: configDefaultVendor + '/ad_impression/json/1-0-0',
+						data: {
+							impressionId: impressionId,
+							costModel: costModel,						
+							cost: cost,
+							bannerId: bannerId,
+							targetUrl: targetUrl,
+							zoneId: zoneId,
+							advertiserId: advertiserId,
+							campaignId: campaignId
+						}
 					};
 
-					logUnstructEvent(configDefaultVendor, 'ad_impression', helpers.deleteEmptyProperties(adImpressionJson), context);
+					logUnstructEvent(eventJson, context);
 				});
 			},
 			
@@ -1534,19 +1544,22 @@
 			 * @param object Custom context relating to the event
 			 */
 			trackAdClick: function(targetUrl, clickId, costModel, cost, bannerId, zoneId, impressionId, advertiserId, campaignId, context) {
-				var adClickJson = {
-					targetUrl: targetUrl,					
-					clickId: clickId,
-					costModel: costModel,					
-					cost: cost,
-					bannerId: bannerId,
-					zoneId: zoneId,
-					impressionId: impressionId,
-					advertiserId: advertiserId,
-					campaignId: campaignId
+				var eventJson = {
+					schema: configDefaultVendor + '/ad_click/json/1-0-0',
+					data: {
+						targetUrl: targetUrl,					
+						clickId: clickId,
+						costModel: costModel,					
+						cost: cost,
+						bannerId: bannerId,
+						zoneId: zoneId,
+						impressionId: impressionId,
+						advertiserId: advertiserId,
+						campaignId: campaignId
+					}
 				};
 
-				logUnstructEvent(configDefaultVendor, 'ad_click', helpers.deleteEmptyProperties(adClickJson), context);
+				logUnstructEvent(eventJson, context);
 			},
 
 			/**
@@ -1564,19 +1577,22 @@
 			 * @param object Custom context relating to the event
 			 */
 			trackAdConversion: function(conversionId, costModel, cost, category, action, property, initialValue, advertiserId, campaignId, context) {
-				var adConversionJson = {
-					conversionId: conversionId,
-					costModel: costModel,					
-					cost: cost,
-					category: category,
-					action: action,
-					property: property,
-					initialValue: initialValue,
-					advertiserId: advertiserId,
-					campaignId: campaignId					
+				var eventJson = {
+					schema: configDefaultVendor + '/ad_conversion/json/1-0-0',
+					data: {
+						conversionId: conversionId,
+						costModel: costModel,					
+						cost: cost,
+						category: category,
+						action: action,
+						property: property,
+						initialValue: initialValue,
+						advertiserId: advertiserId,
+						campaignId: campaignId					
+					}
 				};
 
-				logUnstructEvent(configDefaultVendor, 'ad_conversion', helpers.deleteEmptyProperties(adConversionJson), context);
+				logUnstructEvent(eventJson, context);
 			}
 		}
 	}
