Merge 88f0885 into 8b43600

Sources/Extensions/OptimizelyClient+Extension.swift

@@ -51,6 +51,7 @@ extension OptimizelyClient {
     ///   - eventDispatcher: custom EventDispatcher (optional)
     ///   - datafileHandler: custom datafile handler (optional)
     ///   - userProfileService: custom UserProfileService (optional)
+    ///   - odpManager: custom OdpManager (optional)
     ///   - periodicDownloadInterval: interval in secs for periodic background datafile download.
     ///         The recommended value is 10 * 60 secs (you can also set this to nil to use the recommended value).
     ///         Set this to 0 to disable periodic downloading.

Sources/ODP/OdpEventApiManager.swift

@@ -30,7 +30,7 @@ import Foundation
  {"title":"Accepted","status":202,"timestamp":"2022-06-30T20:59:52.046Z"}
 */
 
-public class OdpEventApiManager {
+open class OdpEventApiManager {
     let resourceTimeoutInSecs: Int?
 
     /// OdpEventApiManager init

Sources/ODP/OdpEventManager.swift

@@ -101,6 +101,7 @@ open class OdpEventManager {
 
     // MARK: - dispatch
 
+    // open for FSC testing support
     open func dispatch(_ event: OdpEvent) {
         if eventQueue.count < maxQueueSize {
             eventQueue.save(item: event)

Sources/ODP/OdpManager.swift

@@ -116,17 +116,35 @@ public class OdpManager {
     ///   - identifiers: a dictionary for identifiers.
     ///   - data: a dictionary for associated data. The default event data will be added to this data before sending to the ODP server.
     /// - Throws: `OptimizelyError` if error is detected
-    func sendEvent(type: String, action: String, identifiers: [String: String], data: [String: Any?]) throws {
+    func sendEvent(type: String?, action: String, identifiers: [String: String], data: [String: Any?]) throws {
         guard enabled else { throw OptimizelyError.odpNotEnabled }
         guard odpConfig.eventQueueingAllowed else { throw OptimizelyError.odpNotIntegrated }
         guard eventManager.isDataValidType(data) else { throw OptimizelyError.odpInvalidData }
+
+        if action.isEmpty { throw OptimizelyError.odpInvalidAction }
+
+        let typeUpdated = (type ?? "").isEmpty ? Constants.ODP.eventType : type!
+
+        // add vuid to all events by default
 
-        var identifiersWithVuid = identifiers
+        var identifiersUpdated = identifiers
         if identifiers[Constants.ODP.keyForVuid] == nil {
-            identifiersWithVuid[Constants.ODP.keyForVuid] = vuidManager.vuid
+            identifiersUpdated[Constants.ODP.keyForVuid] = vuidManager.vuid
+        }
+
+        // replace aliases (fs-user-id, FS_USER_ID, FS-USER-ID) with "fs_user_id".
+
+        for (idKey, idValue) in identifiersUpdated {
+            if idKey == Constants.ODP.keyForUserId { break }
+
+            if [Constants.ODP.keyForUserId, Constants.ODP.keyForUserIdAlias].contains(idKey.lowercased()) {
+                identifiersUpdated.removeValue(forKey: idKey)
+                identifiersUpdated[Constants.ODP.keyForUserId] = idValue
+                break
+            }
         }
 
-        eventManager.sendEvent(type: type, action: action, identifiers: identifiersWithVuid, data: data)
+        eventManager.sendEvent(type: typeUpdated, action: action, identifiers: identifiersUpdated, data: data)
     }
 
     func updateOdpConfig(apiKey: String?, apiHost: String?, segmentsToCheck: [String]) {

Sources/ODP/OdpSegmentManager.swift

@@ -16,7 +16,7 @@
 
 import Foundation
 
-public class OdpSegmentManager {    
+open class OdpSegmentManager {    
     var odpConfig = OdpConfig()
     var segmentsCache: LruCache<String, [String]>
     var apiMgr: OdpSegmentApiManager
@@ -33,7 +33,6 @@ public class OdpSegmentManager {
                 cacheTimeoutInSecs: Int,
                 apiManager: OdpSegmentApiManager? = nil,
                 resourceTimeoutInSecs: Int? = nil) {
-        self.odpConfig = odpConfig ?? OdpConfig()
         self.apiMgr = apiManager ?? OdpSegmentApiManager(timeout: resourceTimeoutInSecs)
 
         self.segmentsCache = LruCache<String, [String]>(size: cacheSize,

Sources/Optimizely+Decide/OptimizelyClient+Decide.swift

@@ -44,8 +44,7 @@ extension OptimizelyClient {
         return createUserContext(userId: userId,
                                  attributes: (attributes ?? [:]) as [String: Any])
     }
-
-
+
     /// Create a user context to be used internally without sending an ODP identify event.
     ///
     /// - Parameters:

Sources/Optimizely/OptimizelyClient.swift

@@ -59,7 +59,7 @@ open class OptimizelyClient: NSObject {
 
     var decisionService: OPTDecisionService!
     public var notificationCenter: OPTNotificationCenter?
-    var odpManager: OdpManager!
+    public var odpManager: OdpManager!
     let sdkSettings: OptimizelySdkSettings
 
     // MARK: - Public interfaces
@@ -72,6 +72,7 @@ open class OptimizelyClient: NSObject {
     ///   - eventDispatcher: custom EventDispatcher (optional)
     ///   - datafileHandler: custom datafile handler (optional)
     ///   - userProfileService: custom UserProfileService (optional)
+    ///   - odpManager: custom OdpManager (optional)
     ///   - defaultLogLevel: default log level (optional. default = .info)
     ///   - defaultDecisionOptions: default decision options (optional)
     ///   - settings: SDK configuration (optional)
@@ -941,7 +942,7 @@ extension OptimizelyClient {
                              action: String,
                              identifiers: [String: String] = [:],
                              data: [String: Any?] = [:]) throws {
-        try odpManager.sendEvent(type: type ?? Constants.ODP.eventType,
+        try odpManager.sendEvent(type: type,
                              action: action,
                              identifiers: identifiers,
                              data: data)

Sources/Optimizely/OptimizelyError.swift

@@ -88,6 +88,7 @@ public enum OptimizelyError: Error {
     case odpNotIntegrated
     case odpNotEnabled
     case odpInvalidData
+    case odpInvalidAction
 }
 
 // MARK: - CustomStringConvertible
@@ -163,6 +164,7 @@ extension OptimizelyError: CustomStringConvertible, ReasonProtocol {
         case .odpNotIntegrated:                             message = "ODP is not integrated."
         case .odpNotEnabled:                                message = "ODP is not enabled."
         case .odpInvalidData:                               message = "ODP data is not valid."
+        case .odpInvalidAction:                             message = "ODP action is not valid (cannot be empty)."
         }
 
         return message

Sources/Utils/Constants.swift

@@ -26,6 +26,7 @@ struct Constants {
     struct ODP {
         static let keyForVuid = "vuid"
         static let keyForUserId = "fs_user_id"
+        static let keyForUserIdAlias = "fs-user-id"   // reserved (auto-converted to "fs_user_id")
         static let eventType = "fullstack"
     }
 

Tests/OptimizelyTests-APIs/OptimizelyClientTests_ODP.swift

@@ -79,7 +79,7 @@ class OptimizelyClientTests_ODP: XCTestCase {
 
         try? optimizely.sendOdpEvent(action: "a2")
 
-        XCTAssertEqual("fullstack", odpManager.eventType)
+        XCTAssertEqual(nil, odpManager.eventType)
         XCTAssertEqual("a2", odpManager.eventAction)
         XCTAssertEqual([:], odpManager.eventIdentifiers)
         XCTAssertEqual([:], odpManager.eventData as! [String: String])
@@ -165,7 +165,7 @@ class OptimizelyClientTests_ODP: XCTestCase {
             XCTFail("Should accept all valid data value types.")
         }
     }
-
+    
     // MARK: - vuid
 
     func testVuid() {
@@ -223,7 +223,7 @@ extension OptimizelyClientTests_ODP {
         var apiHost: String?
         var segmentsToCheck = [String]()
 
-        override func sendEvent(type: String, action: String, identifiers: [String : String], data: [String : Any?]) {
+        override func sendEvent(type: String?, action: String, identifiers: [String : String], data: [String : Any?]) {
             self.eventType = type
             self.eventAction = action
             self.eventIdentifiers = identifiers

Tests/OptimizelyTests-Common/OdpManagerTests.swift

@@ -196,6 +196,42 @@ class OdpManagerTests: XCTestCase {
 
         XCTAssertNil(eventManager.receivedType, "sendEvent requeut should be discarded if ODP disabled.")
     }
+
+    func testSendEvent_emptyAction() {
+        do {
+            try manager.sendEvent(type: nil, action: "", identifiers: [:], data: [:])
+            XCTFail()
+        } catch OptimizelyError.odpInvalidAction {
+            XCTAssert(true)
+        } catch {
+            XCTFail("OptimizelyError expected if data has an empty action.")
+        }
+    }
+
+    func testSendEvent_emptyOrNilType() {
+        try? manager.sendEvent(type: nil, action: "a1", identifiers: [:], data: [:])
+        XCTAssertEqual(eventManager.receivedType, "fullstack")
+
+        try? manager.sendEvent(type: "", action: "a1", identifiers: [:], data: [:])
+        XCTAssertEqual(eventManager.receivedType, "fullstack")
+    }
+
+    func testSendEvent_aliasIdentifiers() {
+        try? manager.sendEvent(type: nil, action: "a1", identifiers: ["fs_user_id": "v1"], data: [:])
+        XCTAssertEqual(eventManager.receivedIdentifiers, ["fs_user_id": "v1", "vuid": manager.vuid])
+
+        try? manager.sendEvent(type: nil, action: "a1", identifiers: ["fs-user-id": "v1"], data: [:])
+        XCTAssertEqual(eventManager.receivedIdentifiers, ["fs_user_id": "v1", "vuid": manager.vuid])
+
+        try? manager.sendEvent(type: nil, action: "a1", identifiers: ["FS_USER_ID": "v1"], data: [:])
+        XCTAssertEqual(eventManager.receivedIdentifiers, ["fs_user_id": "v1", "vuid": manager.vuid])
+
+        try? manager.sendEvent(type: nil, action: "a1", identifiers: ["FS-USER-ID": "v1"], data: [:])
+        XCTAssertEqual(eventManager.receivedIdentifiers, ["fs_user_id": "v1", "vuid": manager.vuid])
+
+        try? manager.sendEvent(type: nil, action: "a1", identifiers: ["email": "e1", "FS-USER-ID": "v1"], data: [:])
+        XCTAssertEqual(eventManager.receivedIdentifiers, ["email": "e1", "fs_user_id": "v1", "vuid": manager.vuid])
+    }
 
     // MARK: - updateConfig