Feature flag & rollout bucket decision (#206)

* Feature flag & rollout parsing

* New Models added

* variation variable usage mapping

* Feature variable and its usage parsing

* demoTestDatafile version upgraded to 4 and maintain compatibility to v3

* Test cases added for new models

* get back to Asynchronous Initialization of OPTLYManager

* CR updated

* Feature flag & rollout bucketing decision

* Decision Service Logic added

* Test cases for getVariationForFeatureExperiment

* Test cases for getVariationForFeatureRollout

* CR updated

* fix - file references

* replaced experimentId & variationId with their objects in FeatureDecision

* Removed xcode analyze warnings

* copyright years changed

* Increase code coverage for Optimizely

* replaced macros with categories and static methods

* getVariationForFeature revamped for mutex group

* increase code coverage for Optimizely

* Categories replaced with private static methods

* categories replaced with private static methods

* fix - OPTLYMacros.h reference in OptimizelySDKUniversal

* fix - CI Checks failure

*  OPTLYFeatureFlag.m+h property "Key" changed to "key"

* OPTLYFeatureFlag.m+h property "Key" changed to "key"

* method name changed

Author: arafay-folio3

OptimizelyDemoApp/AppDelegate.swift

@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2016-2017, Optimizely, Inc. and contributors                   *
+ * Copyright 2017, Optimizely, Inc. and contributors                        *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *

OptimizelySDKCore/OptimizelySDKCore.xcodeproj/project.pbxproj

@@ -74,6 +74,10 @@
 		3E35DCCA1F47AD3D00018732 /* withoutOptProp.json in Resources */ = {isa = PBXBuildFile; fileRef = 3E35DCBB1F47AD3D00018732 /* withoutOptProp.json */; };
 		3E35DCE61F47B42E00018732 /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3E35DCE51F47B42E00018732 /* UIKit.framework */; };
 		3E35DCE81F47B44900018732 /* CoreGraphics.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3E35DCE71F47B44900018732 /* CoreGraphics.framework */; };
+		3E44F64A1FEAA2340044C005 /* OPTLYFeatureDecision.h in Headers */ = {isa = PBXBuildFile; fileRef = 3E44F6471FEAA22F0044C005 /* OPTLYFeatureDecision.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		3E44F64B1FEAA2340044C005 /* OPTLYFeatureDecision.m in Sources */ = {isa = PBXBuildFile; fileRef = 3E44F6481FEAA22F0044C005 /* OPTLYFeatureDecision.m */; };
+		3E44F64C1FEAA2340044C005 /* OPTLYFeatureDecision.h in Headers */ = {isa = PBXBuildFile; fileRef = 3E44F6471FEAA22F0044C005 /* OPTLYFeatureDecision.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		3E44F64D1FEAA2340044C005 /* OPTLYFeatureDecision.m in Sources */ = {isa = PBXBuildFile; fileRef = 3E44F6481FEAA22F0044C005 /* OPTLYFeatureDecision.m */; };
 		3E858C601F42277B00D53856 /* LICENSE in Resources */ = {isa = PBXBuildFile; fileRef = 3E858C5E1F42277B00D53856 /* LICENSE */; };
 		3E858C661F4227BA00D53856 /* OPTLYJSONModelLib.h in Headers */ = {isa = PBXBuildFile; fileRef = 3E858C651F4227BA00D53856 /* OPTLYJSONModelLib.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		3E858C6D1F4227CD00D53856 /* OPTLYJSONModel.h in Headers */ = {isa = PBXBuildFile; fileRef = 3E858C671F4227CD00D53856 /* OPTLYJSONModel.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -277,8 +281,6 @@
 		EA2FAB591DC6F5BE00B1D81B /* OPTLYLoggerMessages.h in Headers */ = {isa = PBXBuildFile; fileRef = EA2FAB4F1DC6F5BE00B1D81B /* OPTLYLoggerMessages.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		EA2FAB731DC6F5F400B1D81B /* OPTLYLog.h in Headers */ = {isa = PBXBuildFile; fileRef = EA2FAB6D1DC6F5F400B1D81B /* OPTLYLog.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		EA2FAB741DC6F5F400B1D81B /* OPTLYLog.h in Headers */ = {isa = PBXBuildFile; fileRef = EA2FAB6D1DC6F5F400B1D81B /* OPTLYLog.h */; settings = {ATTRIBUTES = (Public, ); }; };
-		EA2FAB791DC6F5F400B1D81B /* OPTLYMacros.h in Headers */ = {isa = PBXBuildFile; fileRef = EA2FAB6F1DC6F5F400B1D81B /* OPTLYMacros.h */; settings = {ATTRIBUTES = (Private, ); }; };
-		EA2FAB7A1DC6F5F400B1D81B /* OPTLYMacros.h in Headers */ = {isa = PBXBuildFile; fileRef = EA2FAB6F1DC6F5F400B1D81B /* OPTLYMacros.h */; settings = {ATTRIBUTES = (Private, ); }; };
 		EA2FAB821DC6FA7D00B1D81B /* OptimizelySDKCore.h in Headers */ = {isa = PBXBuildFile; fileRef = EA3C68081DC1E66C00C578CA /* OptimizelySDKCore.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		EA2FAB831DC6FCD300B1D81B /* OptimizelySDKCore.h in Headers */ = {isa = PBXBuildFile; fileRef = EA3C68081DC1E66C00C578CA /* OptimizelySDKCore.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		EA2FAB9C1DC6FDFA00B1D81B /* OptimizelySDKCoreTests.m in Sources */ = {isa = PBXBuildFile; fileRef = EA2FAB841DC6FDFA00B1D81B /* OptimizelySDKCoreTests.m */; };
@@ -533,6 +535,8 @@
 		3E35DCBB1F47AD3D00018732 /* withoutOptProp.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; name = withoutOptProp.json; path = Data/withoutOptProp.json; sourceTree = "<group>"; };
 		3E35DCE51F47B42E00018732 /* UIKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = UIKit.framework; path = System/Library/Frameworks/UIKit.framework; sourceTree = SDKROOT; };
 		3E35DCE71F47B44900018732 /* CoreGraphics.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreGraphics.framework; path = System/Library/Frameworks/CoreGraphics.framework; sourceTree = SDKROOT; };
+		3E44F6471FEAA22F0044C005 /* OPTLYFeatureDecision.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = OPTLYFeatureDecision.h; path = OptimizelySDKCore/OPTLYFeatureDecision.h; sourceTree = "<group>"; };
+		3E44F6481FEAA22F0044C005 /* OPTLYFeatureDecision.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = OPTLYFeatureDecision.m; path = OptimizelySDKCore/OPTLYFeatureDecision.m; sourceTree = "<group>"; };
 		3E858C5E1F42277B00D53856 /* LICENSE */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; name = LICENSE; path = OPTLYJSONModel/LICENSE; sourceTree = "<group>"; };
 		3E858C5F1F42277B00D53856 /* README.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; name = README.md; path = OPTLYJSONModel/README.md; sourceTree = "<group>"; };
 		3E858C651F4227BA00D53856 /* OPTLYJSONModelLib.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = OPTLYJSONModelLib.h; path = OPTLYJSONModel/OPTLYJSONModel/OPTLYJSONModelLib.h; sourceTree = "<group>"; };
@@ -654,7 +658,6 @@
 		EA2FAB501DC6F5BE00B1D81B /* OPTLYLoggerMessages.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OPTLYLoggerMessages.m; sourceTree = "<group>"; };
 		EA2FAB6D1DC6F5F400B1D81B /* OPTLYLog.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OPTLYLog.h; sourceTree = "<group>"; };
 		EA2FAB6E1DC6F5F400B1D81B /* OPTLYLog.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OPTLYLog.m; sourceTree = "<group>"; };
-		EA2FAB6F1DC6F5F400B1D81B /* OPTLYMacros.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OPTLYMacros.h; sourceTree = "<group>"; };
 		EA2FAB841DC6FDFA00B1D81B /* OptimizelySDKCoreTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OptimizelySDKCoreTests.m; sourceTree = "<group>"; };
 		EA2FAB861DC6FDFA00B1D81B /* OptimizelyTest.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OptimizelyTest.m; sourceTree = "<group>"; };
 		EA2FAB871DC6FDFA00B1D81B /* OPTLYAudienceTest.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OPTLYAudienceTest.m; sourceTree = "<group>"; };
@@ -942,7 +945,6 @@
 			children = (
 				EA2FAB6D1DC6F5F400B1D81B /* OPTLYLog.h */,
 				EA2FAB6E1DC6F5F400B1D81B /* OPTLYLog.m */,
-				EA2FAB6F1DC6F5F400B1D81B /* OPTLYMacros.h */,
 				EA064BC51DD3FC8800DF7537 /* OPTLYQueue.h */,
 				EA064BC61DD3FC8800DF7537 /* OPTLYQueue.m */,
 			);
@@ -1195,6 +1197,8 @@
 			children = (
 				EA16D9401ECCC5C600C4C998 /* OPTLYDecisionService.h */,
 				EA16D9411ECCC5C600C4C998 /* OPTLYDecisionService.m */,
+				3E44F6471FEAA22F0044C005 /* OPTLYFeatureDecision.h */,
+				3E44F6481FEAA22F0044C005 /* OPTLYFeatureDecision.m */,
 				EAC5F3511E7B7EEF00C087B8 /* OPTLYUserProfileServiceBasic.h */,
 				EAC5F3521E7B7EEF00C087B8 /* OPTLYUserProfileServiceBasic.m */,
 			);
@@ -1223,6 +1227,7 @@
 				EA16D9421ECCC5C600C4C998 /* OPTLYDecisionService.h in Headers */,
 				3E858C6F1F4227CD00D53856 /* OPTLYJSONModelClassProperty.h in Headers */,
 				3E858C851F4227E300D53856 /* OPTLYJSONValueTransformer.h in Headers */,
+				3E44F64A1FEAA2340044C005 /* OPTLYFeatureDecision.h in Headers */,
 				3E858C831F4227E300D53856 /* OPTLYJSONKeyMapper.h in Headers */,
 				3E858C711F4227CD00D53856 /* OPTLYJSONModelError.h in Headers */,
 				3ECB81FE1FD926FE006505E6 /* OPTLYVariableUsage.h in Headers */,
@@ -1271,7 +1276,6 @@
 				EA16D9361ECBA9B200C4C998 /* OPTLYUserProfile.h in Headers */,
 				EA16D93C1ECBD90E00C4C998 /* OPTLYExperimentBucketMapEntity.h in Headers */,
 				EA8FD0DF1DE9798E00D950AD /* OPTLYNetworkService.h in Headers */,
-				EA2FAB791DC6F5F400B1D81B /* OPTLYMacros.h in Headers */,
 				EA2FA9771DC6F3CF00B1D81B /* murmur3.h in Headers */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -1283,6 +1287,7 @@
 				EA16D9431ECCC5C600C4C998 /* OPTLYDecisionService.h in Headers */,
 				3E858C871F4227ED00D53856 /* OPTLYJSONModel.h in Headers */,
 				3E858C8B1F4227F900D53856 /* OPTLYJSONModelError.h in Headers */,
+				3E44F64C1FEAA2340044C005 /* OPTLYFeatureDecision.h in Headers */,
 				3E858C931F42280500D53856 /* OPTLYJSONModelLib.h in Headers */,
 				3E858C961F42280900D53856 /* OPTLYJSONValueTransformer.h in Headers */,
 				3ECB81FF1FD926FE006505E6 /* OPTLYVariableUsage.h in Headers */,
@@ -1331,7 +1336,6 @@
 				EA16D93D1ECBD90E00C4C998 /* OPTLYExperimentBucketMapEntity.h in Headers */,
 				EAC5F3541E7B7EEF00C087B8 /* OPTLYUserProfileServiceBasic.h in Headers */,
 				EA2FAAA71DC6F57200B1D81B /* OPTLYDecisionEventTicket.h in Headers */,
-				EA2FAB7A1DC6F5F400B1D81B /* OPTLYMacros.h in Headers */,
 				EA2FAC7B1DC70EBC00B1D81B /* murmur3.h in Headers */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -1876,6 +1880,7 @@
 				3E858C861F4227E300D53856 /* OPTLYJSONValueTransformer.m in Sources */,
 				3E858C701F4227CD00D53856 /* OPTLYJSONModelClassProperty.m in Sources */,
 				EA2FAC261DC6FFC600B1D81B /* OPTLYLoggerMessages.m in Sources */,
+				3E44F64B1FEAA2340044C005 /* OPTLYFeatureDecision.m in Sources */,
 				3E9CADFF1FD90E6200EBC49A /* OPTLYFeatureFlag.m in Sources */,
 				3E858C6E1F4227CD00D53856 /* OPTLYJSONModel.m in Sources */,
 				EA2FAC291DC6FFC600B1D81B /* OPTLYLog.m in Sources */,
@@ -1956,6 +1961,7 @@
 				3E858C8A1F4227F900D53856 /* OPTLYJSONModelClassProperty.m in Sources */,
 				EA2FAC001DC6FFA100B1D81B /* OPTLYLogger.m in Sources */,
 				3E858C951F42280900D53856 /* OPTLYJSONKeyMapper.m in Sources */,
+				3E44F64D1FEAA2340044C005 /* OPTLYFeatureDecision.m in Sources */,
 				3E9CAE011FD90E6200EBC49A /* OPTLYFeatureFlag.m in Sources */,
 				EA2FAC011DC6FFA100B1D81B /* OPTLYLoggerMessages.m in Sources */,
 				EA2FAC041DC6FFA100B1D81B /* OPTLYLog.m in Sources */,

OptimizelySDKCore/OptimizelySDKCore/OPTLYBucketer.h

@@ -18,7 +18,7 @@
 
 @class OPTLYVariation;
 @class OPTLYExperiment;
-@class OPTLYProjectConfig;
+@class OPTLYProjectConfig, OPTLYGroup;
 
 NS_ASSUME_NONNULL_BEGIN
 extern NSString *const OPTLYBucketerMutexPolicy;
@@ -54,6 +54,14 @@ NS_ASSUME_NONNULL_END
  */
 - (nullable instancetype)initWithConfig:(nonnull OPTLYProjectConfig *)config;
 
+/**
+ * Bucket experiment based on bucket value and traffic allocations.
+ * @param group representing OPTLYGroup from which experiment belongs to.
+ * @param bucketingId Id to be used for bucketing the user.
+ * @return experiment which represent OPTLYExperiment.
+ */
+- (nullable OPTLYExperiment *)bucketToExperiment:(nonnull OPTLYGroup *)group withBucketingId:(nonnull NSString *)bucketingId;
+
 /**
  * Hash the bucketing ID and map it to the range [0, 10000).
  * @param bucketingId The ID for which to generate the hash and bucket values.

OptimizelySDKCore/OptimizelySDKCore/OPTLYDatafileKeys.h

@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2016, Optimizely, Inc. and contributors                        *
+ * Copyright 2017, Optimizely, Inc. and contributors                        *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *

OptimizelySDKCore/OptimizelySDKCore/OPTLYDatafileKeys.m

@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2016, Optimizely, Inc. and contributors                        *
+ * Copyright 2017, Optimizely, Inc. and contributors                        *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *

OptimizelySDKCore/OptimizelySDKCore/OPTLYDecisionService.h

@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2017, Optimizely, Inc. and contributors                        *
+ * Copyright 2017-2018, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -31,7 +31,7 @@
 // of user IDs that all map to the same experiment variation.
 extern NSString * _Nonnull const OptimizelyBucketId;
 
-@class OPTLYExperiment, OPTLYVariation;
+@class OPTLYExperiment, OPTLYVariation, OPTLYFeatureFlag, OPTLYFeatureDecision;
 
 @interface OPTLYDecisionService : OPTLYJSONModel
 
@@ -66,5 +66,16 @@ extern NSString * _Nonnull const OptimizelyBucketId;
 - (nullable OPTLYVariation *)getVariation:(nonnull NSString *)userId
                                experiment:(nonnull OPTLYExperiment *)experiment
                                attributes:(nullable NSDictionary *)attributes;
-    
+
+/**
+ * Get a variation the user is bucketed into for the given FeatureFlag
+ * @param featureFlag The feature flag the user wants to access.
+ * @param userId The ID of the user.
+ * @param attributes User attributes
+ * @return The variation assigned to the specified user ID for a feature flag.
+ */
+- (nullable OPTLYFeatureDecision *)getVariationForFeature:(nonnull OPTLYFeatureFlag *)featureFlag
+                                             userId:(nonnull NSString *)userId
+                                         attributes:(nullable NSDictionary *)attributes;
+
 @end