bot filtering

OptimizelySDK.Tests/DecisionServiceTest.cs

@@ -388,13 +388,13 @@ public void TestGetVariationWithBucketingId()
                 {"device_type", "iPhone"},
                 {"company", "Optimizely"},
                 {"location", "San Francisco"},
-                {DecisionService.RESERVED_ATTRIBUTE_KEY_BUCKETING_ID, testBucketingIdVariation}
+                {DecisionService.BUCKETING_ID_ATTRIBUTE, testBucketingIdVariation}
             };
 
             var invalidUserAttributesWithBucketingId = new UserAttributes
             {
                 {"company", "Optimizely"},
-                {DecisionService.RESERVED_ATTRIBUTE_KEY_BUCKETING_ID, testBucketingIdControl}
+                {DecisionService.BUCKETING_ID_ATTRIBUTE, testBucketingIdControl}
             };
 
             var optlyObject = new Optimizely(TestData.Datafile, new ValidEventDispatcher(), LoggerMock.Object);

OptimizelySDK.Tests/OptimizelyTest.cs

@@ -515,8 +515,7 @@ public void TestTrackInvalidAttributes()
 
             Optimizely.Track("purchase", TestUserId, attributes);
 
-            //LoggerMock.Verify(l => l.Log(LogLevel.ERROR, "Provided attributes are in an invalid format."), Times.Once);
-            ErrorHandlerMock.Verify(e => e.HandleError(It.IsAny<InvalidAttributeException>()), Times.Once);
+            LoggerMock.Verify(l => l.Log(LogLevel.ERROR, @"Attribute key ""abc"" is not in datafile."), Times.Once);
         }
 
         [Test]
@@ -1111,7 +1110,7 @@ public void TestGetVariationBucketingIdAttribute()
                { "device_type", "iPhone" },
                { "company", "Optimizely" },
                { "location", "San Francisco" },
-               { DecisionService.RESERVED_ATTRIBUTE_KEY_BUCKETING_ID, testBucketingIdVariation }
+               { DecisionService.BUCKETING_ID_ATTRIBUTE, testBucketingIdVariation }
             };
 
             // confirm that a valid variation is bucketed without the bucketing ID

OptimizelySDK.Tests/ProjectConfigTest.cs

@@ -1,5 +1,5 @@
 /* 
- * Copyright 2017, Optimizely
+ * Copyright 2017-2018, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +22,8 @@
 using OptimizelySDK.Exceptions;
 using NUnit.Framework;
 using OptimizelySDK.Entity;
+using Newtonsoft.Json;
+using OptimizelySDK.Event.Builder;
 
 namespace OptimizelySDK.Tests
 {
@@ -810,5 +812,55 @@ public void TestVariationFeatureEnabledProperty()
             var variation = Config.GetVariationFromKey("test_experiment", "control");
             Assert.IsFalse(variation.IsFeatureEnabled);
         }
+
+        [Test]
+        public void TestBotFilteringValues()
+        {
+            // Verify that bot filtering value is true as defined in Config data.
+            Assert.True(Config.BotFiltering.GetValueOrDefault());
+
+            // Remove botFilering node and verify returned value in null.
+            JObject projConfig = JObject.Parse(TestData.Datafile);
+            if (projConfig.TryGetValue("botFiltering", out JToken token))
+            {
+                projConfig.Property("botFiltering").Remove();
+                var configWithoutBotFilter = ProjectConfig.Create(JsonConvert.SerializeObject(projConfig),
+                    LoggerMock.Object, ErrorHandlerMock.Object);
+
+                // Verify that bot filtering is null when not defined in datafile.
+                Assert.Null(configWithoutBotFilter.BotFiltering);
+            }
+        }
+
+        [Test]
+        public void TestGetAttributeIdWithReservedPrefix()
+        {
+            // Verify that attribute key is returned for reserved attribute key.
+            Assert.AreEqual(Config.GetAttributeId(EventBuilder.USER_AGENT_ATTRIBUTE), EventBuilder.USER_AGENT_ATTRIBUTE);
+
+            // Verify that attribute Id is returned for attribute key with reserved prefix that does not exist in datafile.
+            Assert.AreEqual(Config.GetAttributeId(EventBuilder.USER_AGENT_ATTRIBUTE), EventBuilder.USER_AGENT_ATTRIBUTE);
+
+            // Create config file copy with additional resered prefix attribute.
+            string reservedPrefixAttrKey = "$opt_user_defined_attribute";
+            JObject projConfig = JObject.Parse(TestData.Datafile);
+            var attributes = (JArray)projConfig["attributes"];
+
+            var reservedAttr = new Entity.Attribute { Id = "7723348204", Key = reservedPrefixAttrKey };
+            attributes.Add((JObject)JToken.FromObject(reservedAttr));
+
+            // Verify that attribute Id is returned and warning is logged for attribute key with reserved prefix that exists in datafile.
+            var reservedAttrConfig = ProjectConfig.Create(JsonConvert.SerializeObject(projConfig), LoggerMock.Object, ErrorHandlerMock.Object);
+            Assert.AreEqual(reservedAttrConfig.GetAttributeId(reservedPrefixAttrKey), reservedAttrConfig.GetAttribute(reservedPrefixAttrKey).Id);
+            LoggerMock.Verify(l => l.Log(LogLevel.WARN, $@"Attribute {reservedPrefixAttrKey} unexpectedly has reserved prefix {ProjectConfig.RESERVED_ATTRIBUTE_PREFIX}; using attribute ID instead of reserved attribute name."));
+        }
+
+        [Test]
+        public void TestGetAttributeIdWithInvalidAttributeKey()
+        {
+            // Verify that null is returned when provided attribute key is invalid.
+            Assert.Null(Config.GetAttributeId("invalid_attribute"));
+            LoggerMock.Verify(l => l.Log(LogLevel.ERROR, @"Attribute key ""invalid_attribute"" is not in datafile."));
+        }
     }
 }

OptimizelySDK.Tests/TestData.json

@@ -634,5 +634,6 @@
 		"key": "purchase"
 	}],
 	"revision": "15",
-	"anonymizeIP": "false"
+	"anonymizeIP": "false",
+	"botFiltering": "true"
 }

OptimizelySDK/Bucketing/DecisionService.cs

@@ -35,7 +35,7 @@ namespace OptimizelySDK.Bucketing
     /// </summary>
     public class DecisionService
     {
-        public const string RESERVED_ATTRIBUTE_KEY_BUCKETING_ID = "$opt_bucketing_id";
+        public const string BUCKETING_ID_ATTRIBUTE = "$opt_bucketing_id";
 
         private Bucketer Bucketer;
         private IErrorHandler ErrorHandler;
@@ -401,9 +401,9 @@ private string GetBucketingId(string userId, UserAttributes filteredAttributes)
             string bucketingId = userId;
 
             // If the bucketing ID key is defined in attributes, then use that in place of the userID for the murmur hash key
-            if (filteredAttributes != null && filteredAttributes.ContainsKey(RESERVED_ATTRIBUTE_KEY_BUCKETING_ID))
+            if (filteredAttributes != null && filteredAttributes.ContainsKey(BUCKETING_ID_ATTRIBUTE))
             {
-                bucketingId = filteredAttributes[RESERVED_ATTRIBUTE_KEY_BUCKETING_ID];
+                bucketingId = filteredAttributes[BUCKETING_ID_ATTRIBUTE];
                 Logger.Log(LogLevel.DEBUG, string.Format("Setting the bucketing ID to \"{0}\"", bucketingId));
             }
 

OptimizelySDK/Event/Builder/EventBuilder.cs

@@ -35,7 +35,9 @@ public class EventBuilder
 
         private const string ACTIVATE_EVENT_KEY = "campaign_activated";
 
-        public const string RESERVED_ATTRIBUTE_KEY_BUCKETING_ID_EVENT_PARAM_KEY = "optimizely_bucketing_id";
+        public const string BOT_FILTERING_ATTRIBUTE = "$opt_bot_filtering";
+
+        public const string USER_AGENT_ATTRIBUTE = "$opt_user_agent";
 
         private static readonly Dictionary<string, string> HTTP_HEADERS = new Dictionary<string, string>
         {
@@ -103,37 +105,31 @@ private Dictionary<string, object> GetCommonParams(ProjectConfig config, string
 
             foreach (var userAttribute in userAttributes.Where(a => !string.IsNullOrEmpty(a.Key)))
             {
-                if (string.Equals(userAttribute.Key, DecisionService.RESERVED_ATTRIBUTE_KEY_BUCKETING_ID))
+                var attributeId = config.GetAttributeId(userAttribute.Key);
+                if (!string.IsNullOrEmpty(attributeId))
                 {
-                    var userFeature = new Dictionary<string, object>
+                    userFeatures.Add(new Dictionary<string, object>
                     {
-                        { "entity_id", DecisionService.RESERVED_ATTRIBUTE_KEY_BUCKETING_ID },
-                        { "key", RESERVED_ATTRIBUTE_KEY_BUCKETING_ID_EVENT_PARAM_KEY },
+                        { "entity_id", attributeId },
+                        { "key", userAttribute.Key },
                         { "type", CUSTOM_ATTRIBUTE_FEATURE_TYPE },
                         { "value", userAttribute.Value}
-                    };
-                    userFeatures.Add(userFeature);
-                }
-                else
-                {
-                    var attributeEntity = config.GetAttribute(userAttribute.Key);
-                    if (attributeEntity != null && attributeEntity.Key != null)
-                    {
-                        var userFeature = new Dictionary<string, object>
-                        {
-                            { "entity_id", attributeEntity.Id },
-                            { "key", attributeEntity.Key },
-                            { "type", CUSTOM_ATTRIBUTE_FEATURE_TYPE },
-                            { "value",  userAttribute.Value}
-                        };
-                        userFeatures.Add(userFeature);
-                    }
+                    });
                 }
             }
 
-
+            if (config.BotFiltering.HasValue)
+            {
+                userFeatures.Add(new Dictionary<string, object>
+                {
+                    { "entity_id", BOT_FILTERING_ATTRIBUTE },
+                    { "key", BOT_FILTERING_ATTRIBUTE },
+                    { "type", CUSTOM_ATTRIBUTE_FEATURE_TYPE },
+                    { "value",  config.BotFiltering}
+                });
+            }
+
             visitor["attributes"] = userFeatures;
-
             return comonParams;
         }
 

OptimizelySDK/Logger/ILogger.cs

@@ -20,6 +20,7 @@ public enum LogLevel
         DEBUG,
         INFO,
         ERROR,
+        WARN,
     }
 
     public interface ILogger

OptimizelySDK/ProjectConfig.cs

@@ -1,5 +1,5 @@
 /* 
- * Copyright 2017, Optimizely
+ * Copyright 2017-2018, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,8 @@ namespace OptimizelySDK
 {
     public class ProjectConfig
     {
+        public const string RESERVED_ATTRIBUTE_PREFIX = "$opt_";
+
         /// <summary>
         /// Version of the datafile.
         /// </summary>
@@ -53,6 +55,11 @@ public class ProjectConfig
         /// </summary>
         public bool AnonymizeIP { get; set; }
 
+        /// <summary>
+        /// Bot filtering flag.
+        /// </summary>
+        public bool? BotFiltering { get; set; }
+
         //========================= Mappings ===========================
 
         /// <summary>
@@ -552,5 +559,32 @@ public Rollout GetRolloutFromId(string rolloutId)
             ErrorHandler.HandleError(new Exceptions.InvalidRolloutException("Provided rollout is not in datafile."));
             return new Rollout();
         }
+
+        /// <summary>
+        /// Get attribute ID for the provided attribute key
+        /// </summary>
+        /// <param name="attributeKey">Key of the Attribute</param>
+        /// <returns>Attribute ID corresponding to the provided attribute key. Attribute key if it is a reserved attribute</returns>
+        public string GetAttributeId(string attributeKey)
+        {
+
+            var hasReservedPrefix = attributeKey.StartsWith(RESERVED_ATTRIBUTE_PREFIX);
+
+            if (_AttributeKeyMap.ContainsKey(attributeKey))
+            {
+                var attribute = _AttributeKeyMap[attributeKey];
+                if (hasReservedPrefix)
+                    Logger.Log(LogLevel.WARN, $@"Attribute {attributeKey} unexpectedly has reserved prefix {RESERVED_ATTRIBUTE_PREFIX}; using attribute ID instead of reserved attribute name.");
+
+                return attribute.Id;
+            }
+            else if (hasReservedPrefix)
+            {
+                return attributeKey;
+            }
+
+            Logger.Log(LogLevel.ERROR, $@"Attribute key ""{attributeKey}"" is not in datafile.");
+            return null;
+        }
     }
 }