Merge pull request #127 from optimizely/yasir/ondecision-activate-getvariation

aliabbasrizvi · web-flow · commit 043d3f2a248c · 2019-04-04T11:06:08.000-07:00
diff --git a/DemoSwiftApp/Customization/CustomNotificationCenter.swift b/DemoSwiftApp/Customization/CustomNotificationCenter.swift
@@ -10,6 +10,7 @@ import Foundation
 import Optimizely
 
 class CustomNotificationCenter: OPTNotificationCenter {
+    
     func addFeatureFlagRolloutChangeListener(featureListener: @escaping FeatureFlagRolloutChangeListener) -> Int? {
         return nil
     }
@@ -53,6 +54,12 @@ class CustomNotificationCenter: OPTNotificationCenter {
         //
         return nil
     }
+    
+    func addDecisionNotificationListener(decisionListener: @escaping DecisionListener) -> Int? {
+        //
+        return nil
+    }
+    
     func addDatafileChangeNotificationListener(datafileListener: @escaping DatafileChangeListener) -> Int? {
         return nil
     }
diff --git a/OptimizelySDK/Implementation/DefaultNotificationCenter.swift b/OptimizelySDK/Implementation/DefaultNotificationCenter.swift
@@ -84,6 +84,26 @@ public class DefaultNotificationCenter : OPTNotificationCenter {
         return incrementNotificationId()
     }
     
+    public func addDecisionNotificationListener(decisionListener: @escaping (String, String, OptimizelyAttributes?, [String: Any]) -> Void) -> Int? {
+        notificationListeners[notificationId] = (NotificationType.Decision.rawValue,  { (args:Any...) in
+            guard let myArgs = args[0] as? [Any?] else {
+                return
+            }
+            if myArgs.count < 4 {
+                return
+            }
+            if let type = myArgs[0] as? String,
+                let userId = myArgs[1] as? String,
+                let attributes = myArgs[2] as? OptimizelyAttributes?,
+                let decisionInfo = myArgs[3] as? Dictionary<String,Any>
+            {
+                decisionListener(type, userId, attributes, decisionInfo)
+            }
+        })
+        
+        return incrementNotificationId()
+    }
+
     public func addDatafileChangeNotificationListener(datafileListener: @escaping DatafileChangeListener) -> Int? {
         notificationListeners[notificationId] = (NotificationType.DatafileChange.rawValue,  { (args:Any...) in
             guard let myArgs = args[0] as? [Any?] else {
@@ -137,5 +157,12 @@ public class DefaultNotificationCenter : OPTNotificationCenter {
         }
     }
     
-    
+    public func getArgumentsForDecisionListener(notificationType: String, userId: String, attributes: OptimizelyAttributes?) -> Array<Any?> {
+        var args = Array<Any?>()
+        args.append(notificationType)
+        args.append(userId)
+        args.append(attributes ?? OptimizelyAttributes())
+        return args
+    }
+
 }
diff --git a/OptimizelySDK/Optimizely/OptimizelyManager.swift b/OptimizelySDK/Optimizely/OptimizelyManager.swift
@@ -323,12 +323,25 @@ open class OptimizelyManager: NSObject {
         guard let experiment = config.getExperiment(key: experimentKey) else {
             throw OptimizelyError.experimentUnknown
         }
+    
+        var args: Array<Any?> = (self.notificationCenter as! DefaultNotificationCenter).getArgumentsForDecisionListener(notificationType: Constants.DecisionTypeKeys.experiment, userId: userId, attributes: attributes)
+
+        var decisionInfo = Dictionary<String,Any>()
+        decisionInfo[Constants.NotificationKeys.experiment] = nil
+        decisionInfo[Constants.NotificationKeys.variation] = nil
         
         // fix DecisionService to throw error
         guard let variation = decisionService.getVariation(config: config, userId: userId, experiment: experiment, attributes: attributes ?? OptimizelyAttributes()) else {
+            args.append(decisionInfo)
+            self.notificationCenter.sendNotifications(type: NotificationType.Decision.rawValue, args: args)
             throw OptimizelyError.variationUnknown
         }
         
+        decisionInfo[Constants.NotificationKeys.experiment] = experimentKey
+        decisionInfo[Constants.NotificationKeys.variation] = variation.key
+        args.append(decisionInfo)
+        self.notificationCenter.sendNotifications(type: NotificationType.Decision.rawValue, args: args)
+        
         return variation
     }
     
diff --git a/OptimizelySDK/OptimizelySwiftSDK.xcodeproj/project.pbxproj b/OptimizelySDK/OptimizelySwiftSDK.xcodeproj/project.pbxproj
@@ -1076,6 +1076,8 @@
 		6EF4B51C2239C7D9002DE8B6 /* BatchEventBuilderTests_Corners.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6EF4B51B2239C7D9002DE8B6 /* BatchEventBuilderTests_Corners.swift */; };
 		6EF4B51D2239C7D9002DE8B6 /* BatchEventBuilderTests_Corners.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6EF4B51B2239C7D9002DE8B6 /* BatchEventBuilderTests_Corners.swift */; };
 		825A305DA92576A5327962F4 /* Pods_OptimizelyTests_Common_tvOS.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 8093F8A983E68BDB49E29737 /* Pods_OptimizelyTests_Common_tvOS.framework */; };
+		C79F9D862251F58F002B0BC9 /* DecisionListenerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = C79F9D852251F58F002B0BC9 /* DecisionListenerTests.swift */; };
+		C79F9D872251F597002B0BC9 /* DecisionListenerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = C79F9D852251F58F002B0BC9 /* DecisionListenerTests.swift */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -1299,6 +1301,7 @@
 		7C392E11ABAA00DDA1F864B9 /* Pods_OptimizelyTests_APIs_iOS.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_OptimizelyTests_APIs_iOS.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		8093F8A983E68BDB49E29737 /* Pods_OptimizelyTests_Common_tvOS.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_OptimizelyTests_Common_tvOS.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		AED4B61B2F7C775E23D39EBB /* Pods-OptimizelyTests-Common-iOS.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OptimizelyTests-Common-iOS.release.xcconfig"; path = "Target Support Files/Pods-OptimizelyTests-Common-iOS/Pods-OptimizelyTests-Common-iOS.release.xcconfig"; sourceTree = "<group>"; };
+		C79F9D852251F58F002B0BC9 /* DecisionListenerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DecisionListenerTests.swift; sourceTree = "<group>"; };
 		EAF81B0DD7CB1C74984C7538 /* Pods-OptimizelyTests-Common-iOS.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OptimizelyTests-Common-iOS.debug.xcconfig"; path = "Target Support Files/Pods-OptimizelyTests-Common-iOS/Pods-OptimizelyTests-Common-iOS.debug.xcconfig"; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
@@ -1707,6 +1710,7 @@
 				0B894EBB224163FF004A2ADB /* EventDispatcherTest.swift */,
 				0BC47BD52242F7EF00E5C2CD /* DatafileHandlerTests.swift */,
 				0BC47BE42243012E00E5C2CD /* MurmurTests.swift */,
+				C79F9D852251F58F002B0BC9 /* DecisionListenerTests.swift */,
 			);
 			path = "OptimizelyTests-Common";
 			sourceTree = "<group>";
@@ -2881,6 +2885,7 @@
 				6EA4253E2218E4A300B074B5 /* Audience.swift in Sources */,
 				6EA425532218E4A300B074B5 /* Result.swift in Sources */,
 				0B77D05F22370526005AA83F /* BackgroundingCallbacks.swift in Sources */,
+				C79F9D872251F597002B0BC9 /* DecisionListenerTests.swift in Sources */,
 				6EA4254F2218E4A300B074B5 /* EventForDispatch+Extension.swift in Sources */,
 				6EA425262218E4A300B074B5 /* DefaultLogger.swift in Sources */,
 				6EA425282218E4A300B074B5 /* DefaultUserProfileService.swift in Sources */,
@@ -3357,6 +3362,7 @@
 				6E4DD8F321E530A900B0C2C7 /* OptimizelyResult.swift in Sources */,
 				6E4DD8A721E5260600B0C2C7 /* OPTUserProfileService.swift in Sources */,
 				6E4DD8A521E5260600B0C2C7 /* OPTEventDispatcher.swift in Sources */,
+				C79F9D862251F58F002B0BC9 /* DecisionListenerTests.swift in Sources */,
 				6E4DD8BD21E5261500B0C2C7 /* TrafficAllocation.swift in Sources */,
 				0B7B18882232DB8300A1F85D /* DataStoreMemory.swift in Sources */,
 				6EA4265122191EEC00B074B5 /* Array+Extension.swift in Sources */,
diff --git a/OptimizelySDK/OptimizelyTests/OptimizelyTests-Common/DecisionListenerTests.swift b/OptimizelySDK/OptimizelyTests/OptimizelyTests-Common/DecisionListenerTests.swift
@@ -0,0 +1,116 @@
+//
+/****************************************************************************
+* Copyright 2019, 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.         *
+* You may obtain a copy of the License at                                  *
+*                                                                          *
+*    http://www.apache.org/licenses/LICENSE-2.0                            *
+*                                                                          *
+* Unless required by applicable law or agreed to in writing, software      *
+* distributed under the License is distributed on an "AS IS" BASIS,        *
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
+* See the License for the specific language governing permissions and      *
+* limitations under the License.                                           *
+***************************************************************************/
+    
+
+import XCTest
+
+class DecisionListenerTests: XCTestCase {
+
+    func testDecisionListenerWithActivateWhenUserInExperiment() {
+        let attributes: [String: Any?] = ["s_foo": "foo",
+                                          "b_true": "N/A",
+                                          "i_42": 44,
+                                          "d_4_2": "N/A"]
+        let optimizely = OTUtils.createOptimizely(datafileName: "audience_targeting", clearUserProfileService: true)
+        var notificationVariation : String?
+        var notificationExperiment : String?
+        var notificationType: String?
+        
+        _ = optimizely?.notificationCenter.addDecisionNotificationListener(decisionListener: { (type, userId, attributes, decisionInfo) in
+            notificationExperiment = decisionInfo[Constants.NotificationKeys.experiment] as? String
+            notificationVariation = decisionInfo[Constants.NotificationKeys.variation] as? String
+            notificationType = type
+        })
+        
+        let variation = try? optimizely?.activate(experimentKey:
+            "ab_running_exp_audience_combo_empty_conditions",
+                                                  userId: "test_user_1",
+                                                  attributes: attributes)
+        
+        XCTAssertEqual(variation, "all_traffic_variation")
+        XCTAssertEqual(notificationExperiment, "ab_running_exp_audience_combo_empty_conditions")
+        XCTAssertEqual(notificationVariation, "all_traffic_variation")
+        XCTAssertEqual(notificationType, Constants.DecisionTypeKeys.experiment)
+    }
+
+    func testDecisionListenerWithActivateWhenUserNotInExperiment() {
+        let optimizely = OTUtils.createOptimizely(datafileName: "audience_targeting", clearUserProfileService: true)
+        var notificationVariation : String?
+        var notificationExperiment : String?
+        var notificationType: String?
+        
+        _ = optimizely?.notificationCenter.addDecisionNotificationListener(decisionListener: { (type, userId, attributes, decisionInfo) in
+            notificationExperiment = decisionInfo[Constants.NotificationKeys.experiment] as? String
+            notificationVariation = decisionInfo[Constants.NotificationKeys.variation] as? String
+            notificationType = type
+        })
+    
+        _ = try? optimizely?.activate(experimentKey:
+            "ab_running_exp_audience_combo_exact_foo_or_true__and__42_or_4_2",
+                                                  userId: "test_user_1",
+                                                  attributes: nil)
+        
+        XCTAssertEqual(notificationExperiment, nil)
+        XCTAssertEqual(notificationVariation, nil)
+        XCTAssertEqual(notificationType, Constants.DecisionTypeKeys.experiment)
+    }
+    
+    func testDecisionListenerWithGetVariationWhenUserInExperiment() {
+        let attributes: [String: Any?] = ["s_foo": "foo",
+                                          "b_true": "N/A",
+                                          "i_42": 44,
+                                          "d_4_2": "N/A"]
+        let optimizely = OTUtils.createOptimizely(datafileName: "audience_targeting", clearUserProfileService: true)
+        var notificationVariation : String?
+        var notificationExperiment : String?
+        var notificationType: String?
+        
+        _ = optimizely?.notificationCenter.addDecisionNotificationListener(decisionListener: { (type, userId, _attributes, decisionInfo) in
+            notificationExperiment = decisionInfo[Constants.NotificationKeys.experiment] as? String
+            notificationVariation = decisionInfo[Constants.NotificationKeys.variation] as? String
+            notificationType = type
+        })
+        
+        _ = try? optimizely?.getVariation(experimentKey: "ab_running_exp_audience_combo_empty_conditions",
+                                                      userId: "test_user_1",
+                                                      attributes: attributes)
+        
+        XCTAssertEqual(notificationExperiment, "ab_running_exp_audience_combo_empty_conditions")
+        XCTAssertEqual(notificationVariation, "all_traffic_variation")
+        XCTAssertEqual(notificationType, Constants.DecisionTypeKeys.experiment)
+    }
+    
+    func testDecisionListenerWithGetVariationWhenUserNotInExperiment() {
+        let optimizely = OTUtils.createOptimizely(datafileName: "audience_targeting", clearUserProfileService: true)
+        var notificationVariation : String?
+        var notificationExperiment : String?
+        var notificationType: String?
+        
+        _ = optimizely?.notificationCenter.addDecisionNotificationListener(decisionListener: { (type, userId, attributes, decisionInfo) in
+            notificationExperiment = decisionInfo[Constants.NotificationKeys.experiment] as? String
+            notificationVariation = decisionInfo[Constants.NotificationKeys.variation] as? String
+            notificationType = type
+        })
+        
+        _ = try? optimizely?.getVariation(experimentKey: "ab_running_exp_audience_combo_exact_foo_or_true__and__42_or_4_2", userId: "test_user_1")
+        
+        XCTAssertEqual(notificationExperiment, nil)
+        XCTAssertEqual(notificationVariation, nil)
+        XCTAssertEqual(notificationType, Constants.DecisionTypeKeys.experiment)
+    }
+
+}
diff --git a/OptimizelySDK/OptimizelyTests/OptimizelyTests-Common/NotificationCenterTests.swift b/OptimizelySDK/OptimizelyTests/OptimizelyTests-Common/NotificationCenterTests.swift
@@ -54,6 +54,11 @@ class NotificationCenterTests: XCTestCase {
         notificationCenter.sendNotifications(type: NotificationType.Track.rawValue, args: ["eventKey", "userId", nil, nil, ["url":"https://url.com/", "body": Data()]])
         
     }
+    
+    func sendDecision() {
+        notificationCenter.sendNotifications(type: NotificationType.Decision.rawValue, args: [Constants.DecisionTypeKeys.experiment, "userId", nil, ["url":"https://url.com/", "body": Data()]])
+        
+    }
 
     func sendDatafileChange() {
         notificationCenter.sendNotifications(type: NotificationType.DatafileChange.rawValue, args: [Data()])
@@ -133,6 +138,40 @@ class NotificationCenterTests: XCTestCase {
         XCTAssertTrue(called)
     }
 
+    func testNotificationCenterAddRemoveDecision() {
+        // This is an example of a functional test case.
+        // Use XCTAssert and related functions to verify your tests produce the correct results.
+        var called = false
+        
+        let _ = notificationCenter.addDecisionNotificationListener { (type, userId, attr, decisionInfo) in
+            called = true
+        }
+        
+        notificationCenter.clearNotificationListeners(type: .Decision)
+        
+        sendDecision()
+        
+        XCTAssertFalse(called)
+        
+        let id = notificationCenter.addDecisionNotificationListener { (type, userId, attr, decisionInfo) in
+            called = true
+        }
+        
+        notificationCenter.removeNotificationListener(notificationId: id!)
+        
+        sendDecision()
+        
+        XCTAssertFalse(called)
+        
+        let _ = notificationCenter.addDecisionNotificationListener { (type, userId, attr, decisionInfo) in
+            called = true
+        }
+        
+        sendDecision()
+        
+        XCTAssertTrue(called)
+    }
+
     func testNotificationCenterAddRemoveDatafileChange() {
         // This is an example of a functional test case.
         // Use XCTAssert and related functions to verify your tests produce the correct results.
diff --git a/OptimizelySDK/Protocols/OPTNotificationCenter.swift b/OptimizelySDK/Protocols/OPTNotificationCenter.swift
@@ -22,6 +22,7 @@ public enum NotificationType : Int {
     case Track
     case DatafileChange
     case FeatureFlagRolloutToggle
+    case Decision
 }
 
 public enum FeatureFlagToggle {
@@ -41,6 +42,8 @@ public typealias ActivateListener = (_ experiment:OptimizelyExperimentData, _ us
 
 public typealias TrackListener = (_ eventKey:String, _ userId:String, _ attributes: OptimizelyAttributes?, _ eventTags:Dictionary<String, Any>?, _ event:Dictionary<String, Any>) -> Void
 
+public typealias DecisionListener = (_ type:String, _ userId:String, _ attributes: OptimizelyAttributes?, _ decisionInfo:Dictionary<String, Any>) -> Void
+
 public typealias DatafileChangeListener = (_ datafile:Data) -> Void
 
 public typealias FeatureFlagRolloutChangeListener = (_ featureFlagKey:String, _ toggle:FeatureFlagToggle ) -> Void
@@ -72,6 +75,13 @@ func addActivateNotificationListener(activateListener:@escaping ActivateListener
  */
 func addTrackNotificationListener(trackListener:@escaping TrackListener) -> Int?
 
+/**
+ Add a decision notification listener to the notification center.
+ - Parameter decisionListener: Notification to add.
+ - Returns: the notification id used to remove the notification. It is greater than 0 on success.
+ */
+func addDecisionNotificationListener(decisionListener:@escaping DecisionListener) -> Int?
+
 /**
  Add a datafile change notification listener
  - Parameter datafileChangeListener: Notification to add.
diff --git a/OptimizelySDK/Utils/Constants.swift b/OptimizelySDK/Utils/Constants.swift
@@ -14,4 +14,32 @@ struct Constants {
         static let OptimizelyBotFilteringAttribute = "$opt_bot_filtering";
         static let OptimizelyUserAgent = "$opt_user_agent";
     }
+    
+    struct NotificationKeys {
+        static let experiment = "experiment"
+        static let variation = "variation"
+    }
+    
+    struct DecisionTypeKeys {
+        static let featureVariable  = "feature_variable"
+        static let isFeatureEnabled  = "feature"
+        static let experiment = "experiment"
+    }
+    
+    struct DecisionInfoKeys {
+        static let feature = "featureKey"
+        static let featureEnabled = "featureEnabled"
+        static let sourceExperiment = "sourceExperimentKey"
+        static let sourceVariation = "sourceVariationKey"
+        static let source = "source"
+        static let variable = "variableKey"
+        static let variableType = "variableType"
+        static let variableValue = "variableValue"
+    }
+    
+    struct DecisionSource {
+        static let Experiment = "EXPERIMENT"
+        static let Rollout = "ROLLOUT"
+    }
+
 }
diff --git a/Podfile.lock b/Podfile.lock
@@ -57,4 +57,4 @@ SPEC CHECKSUMS:
 
 PODFILE CHECKSUM: 4f4ce5504801dbc19d61fee45d7740aa732a995c
 
-COCOAPODS: 1.6.1
+COCOAPODS: 1.6.0

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ import Foundation`
`10`	`10`	`import Optimizely`
`11`	`11`
`12`	`12`	`class CustomNotificationCenter: OPTNotificationCenter {`
	`13`	`+`
`13`	`14`	`func addFeatureFlagRolloutChangeListener(featureListener: @escaping FeatureFlagRolloutChangeListener) -> Int? {`
`14`	`15`	`return nil`
`15`	`16`	`}`
`@@ -53,6 +54,12 @@ class CustomNotificationCenter: OPTNotificationCenter {`
`53`	`54`	`//`
`54`	`55`	`return nil`
`55`	`56`	`}`
	`57`	`+`
	`58`	`+ func addDecisionNotificationListener(decisionListener: @escaping DecisionListener) -> Int? {`
	`59`	`+ //`
	`60`	`+ return nil`
	`61`	`+ }`
	`62`	`+`
`56`	`63`	`func addDatafileChangeNotificationListener(datafileListener: @escaping DatafileChangeListener) -> Int? {`
`57`	`64`	`return nil`
`58`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,4 +57,4 @@ SPEC CHECKSUMS:`
`57`	`57`
`58`	`58`	`PODFILE CHECKSUM: 4f4ce5504801dbc19d61fee45d7740aa732a995c`
`59`	`59`
`60`		`-COCOAPODS: 1.6.1`
	`60`	`+COCOAPODS: 1.6.0`