Adding support for bot filtering. WIP.

Author: aliabbasrizvi

packages/optimizely-sdk/lib/core/event_builder/index.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2016-2017, Optimizely
+ * Copyright 2016-2018, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,10 +19,12 @@ var eventTagUtils = require('../../utils/event_tag_utils');
 var projectConfig = require('../project_config');
 
 var ACTIVATE_EVENT_KEY = 'campaign_activated';
+var BOT_FILTERING_FEATURE_KEY = '$opt_bot_filtering';
 var CUSTOM_ATTRIBUTE_FEATURE_TYPE = 'custom';
 var ENDPOINT = 'https://logx.optimizely.com/v1/events';
 var HTTP_VERB = 'POST';
 
+
 /**
  * Get params which are used same in both conversion and impression events
  * @param  {Object} options.attributes    Object representing user attributes and values which need to be recorded
@@ -36,7 +38,7 @@ function getCommonEventParams(options) {
   var attributes = options.attributes;
   var configObj = options.configObj;
   var anonymize_ip = configObj.anonymizeIP;
-
+  var botFiltering = configObj.botFiltering;
   if (anonymize_ip === null || anonymize_ip === undefined) {
     anonymize_ip = false;
   }
@@ -60,15 +62,30 @@ function getCommonEventParams(options) {
   fns.forOwn(attributes, function(attributeValue, attributeKey){
     var attributeId = projectConfig.getAttributeId(options.configObj, attributeKey);
     if (attributeId) {
-      var feature = {
+      commonParams.visitors[0].attributes.push({
         entity_id: attributeId,
         key: attributeKey,
         type: CUSTOM_ATTRIBUTE_FEATURE_TYPE,
         value: attributes[attributeKey],
-      };
-      commonParams.visitors[0].attributes.push(feature);
+      });      
+    } else if (enums.RESERVED_ATTRIBUTES.hasOwnProperty(attributeKey)) {
+      commonParams.visitors[0].attributes.push({
+        entity_id: attributeKey,
+        key: attributeKey,
+        type: CUSTOM_ATTRIBUTE_FEATURE_TYPE,
+        value: attributes[attributeKey],
+      });
     }
   });
+
+  if (typeof botFiltering === 'boolean') {
+    commonParams.visitors[0].attributes.push({
+      entity_id: BOT_FILTERING_FEATURE_KEY,
+      key: BOT_FILTERING_FEATURE_KEY,
+      type: CUSTOM_ATTRIBUTE_FEATURE_TYPE,
+      value: botFiltering,
+    });
+  };
   return commonParams;
 }
 

packages/optimizely-sdk/lib/optimizely/index.tests.js

@@ -2549,6 +2549,11 @@ describe('lib/optimizely', function() {
                         'key': 'test_attribute',
                         'type': 'custom',
                         'value': 'test_value',
+                      }, {
+                        'entity_id': '$opt_bot_filtering',
+                        'key': '$opt_bot_filtering',
+                        'type': 'custom',
+                        'value': true,
                       },
                     ],
                   }

packages/optimizely-sdk/lib/tests/test_data.js

@@ -531,6 +531,7 @@ var configWithFeatures = {
     }
   ],
   'anonymizeIP': true,
+  'botFiltering': true,
   'audiences': [
     {
       'id': '594017',

packages/optimizely-sdk/lib/utils/enums/index.js

@@ -128,6 +128,10 @@ exports.RESERVED_EVENT_KEYWORDS = {
   VALUE: 'value',
 };
 
+exports.RESERVED_ATTRIBUTES = {
+  USER_AGENT: '$opt_user_agent',
+};
+
 exports.JAVASCRIPT_CLIENT_ENGINE = 'javascript-sdk';
 exports.NODE_CLIENT_ENGINE = 'node-sdk';
 exports.NODE_CLIENT_VERSION = '2.0.1';