refact(odp): Allows support for ODP testing using FSC.

Sources/Extensions/OptimizelyClient+Extension.swift

@@ -1,5 +1,5 @@
 //
-// Copyright 2019-2021, Optimizely, Inc. and contributors
+// Copyright 2019-2021,2023 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.
@@ -62,6 +62,7 @@ extension OptimizelyClient {
                             eventDispatcher: OPTEventDispatcher? = nil,
                             datafileHandler: OPTDatafileHandler? = nil,
                             userProfileService: OPTUserProfileService? = nil,
+                            odpManager: OdpManager? = nil,
                             periodicDownloadInterval: Int?,
                             defaultLogLevel: OptimizelyLogLevel? = nil,
                             defaultDecideOptions: [OptimizelyDecideOption]? = nil,
@@ -72,6 +73,7 @@ extension OptimizelyClient {
                   eventDispatcher: eventDispatcher,
                   datafileHandler: datafileHandler,
                   userProfileService: userProfileService,
+                  odpManager: odpManager,
                   defaultLogLevel: defaultLogLevel,
                   defaultDecideOptions: defaultDecideOptions,
                   settings: settings)

Sources/ODP/OdpEvent.swift

@@ -1,5 +1,5 @@
 //
-// Copyright 2022, Optimizely, Inc. and contributors 
+// Copyright 2022-2023, 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.
@@ -16,7 +16,7 @@
 
 import Foundation
 
-struct OdpEvent: Codable {
+public struct OdpEvent: Codable {
     let type: String
     let action: String
     let identifiers: [String: String]
@@ -25,7 +25,7 @@ struct OdpEvent: Codable {
     let data: [String: Any?]
     let dataSerial: Data
 
-    init(type: String, action: String, identifiers: [String: String], data: [String: Any?]) {
+    public init(type: String, action: String, identifiers: [String: String], data: [String: Any?]) {
         self.type = type
         self.action = action
         self.identifiers = identifiers
@@ -44,7 +44,7 @@ struct OdpEvent: Codable {
         case dataSerial
     }
 
-    init(from decoder: Decoder) throws {
+    public init(from decoder: Decoder) throws {
         let values = try decoder.container(keyedBy: CodingKeys.self)
 
         self.type = try values.decode(String.self, forKey: .type)
@@ -57,7 +57,7 @@ struct OdpEvent: Codable {
 
     // For JSON encoding (POST request body)
 
-    var dict: [String: Any] {
+    public var dict: [String: Any] {
         return [
             "type": type,
             "action": action,

Sources/ODP/OdpEventApiManager.swift

@@ -1,5 +1,5 @@
 //
-// Copyright 2022, Optimizely, Inc. and contributors
+// Copyright 2022-2023, 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.
@@ -30,13 +30,13 @@ import Foundation
  {"title":"Accepted","status":202,"timestamp":"2022-06-30T20:59:52.046Z"}
 */
 
-class OdpEventApiManager {
+public class OdpEventApiManager {
     let resourceTimeoutInSecs: Int?
 
     /// OdpEventApiManager init
     /// - Parameters:
     ///   - timeout: timeout for segment fetch
-    init(timeout: Int? = nil) {
+    public init(timeout: Int? = nil) {
         self.resourceTimeoutInSecs = timeout
     }
 

Sources/ODP/OdpEventManager.swift

@@ -1,5 +1,5 @@
 //
-// Copyright 2022-2023, Optimizely, Inc. and contributors 
+// Copyright 2022-2023, 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.
@@ -17,7 +17,7 @@
 import Foundation
 import UIKit
 
-class OdpEventManager {
+open class OdpEventManager {
     var odpConfig = OdpConfig()
     var apiMgr: OdpEventApiManager
 
@@ -33,9 +33,9 @@ class OdpEventManager {
     ///   - sdkKey: datafile sdkKey
     ///   - apiManager: OdpEventApiManager
     ///   - resourceTimeoutInSecs: timeout for event dispatch
-    init(sdkKey: String,
-         apiManager: OdpEventApiManager? = nil,
-         resourceTimeoutInSecs: Int? = nil) {
+    public init(sdkKey: String,
+                apiManager: OdpEventApiManager? = nil,
+                resourceTimeoutInSecs: Int? = nil) {
         self.apiMgr = apiManager ?? OdpEventApiManager(timeout: resourceTimeoutInSecs)
 
         self.queueLock = DispatchQueue(label: "event")
@@ -101,7 +101,7 @@ class OdpEventManager {
 
     // MARK: - dispatch
 
-    func dispatch(_ event: OdpEvent) {
+    open func dispatch(_ event: OdpEvent) {
         if eventQueue.count < maxQueueSize {
             eventQueue.save(item: event)
         } else {

Sources/ODP/OdpManager.swift

@@ -16,7 +16,7 @@
 
 import Foundation
 
-class OdpManager {
+public class OdpManager {
     var enabled: Bool
     var vuidManager: OdpVuidManager
 
@@ -40,14 +40,14 @@ class OdpManager {
     ///   - timeoutForEventDispatchInSecs: timeout for event dispatch
     ///   - segmentManager: ODPSegmentManager
     ///   - eventManager: ODPEventManager
-    init(sdkKey: String,
-         disable: Bool,
-         cacheSize: Int,
-         cacheTimeoutInSecs: Int,
-         timeoutForSegmentFetchInSecs: Int? = nil,
-         timeoutForEventDispatchInSecs: Int? = nil,
-         segmentManager: OdpSegmentManager? = nil,
-         eventManager: OdpEventManager? = nil) {
+    public init(sdkKey: String,
+                disable: Bool,
+                cacheSize: Int,
+                cacheTimeoutInSecs: Int,
+                timeoutForSegmentFetchInSecs: Int? = nil,
+                timeoutForEventDispatchInSecs: Int? = nil,
+                segmentManager: OdpSegmentManager? = nil,
+                eventManager: OdpEventManager? = nil) {
 
         self.enabled = !disable
         self.vuidManager = OdpVuidManager.shared

Sources/ODP/OdpSegmentApiManager.swift

@@ -1,5 +1,5 @@
 //
-// Copyright 2022, Optimizely, Inc. and contributors
+// Copyright 2022-2023, 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.
@@ -95,23 +95,23 @@ import Foundation
  }
 */
 
-class OdpSegmentApiManager {
+open class OdpSegmentApiManager {
     let logger = OPTLoggerFactory.getLogger()
     let resourceTimeoutInSecs: Int?
 
     /// OdpSegmentApiManager init
     /// - Parameters:
     ///   - timeout: timeout for segment fetch
-    init(timeout: Int? = nil) {
+    public init(timeout: Int? = nil) {
         self.resourceTimeoutInSecs = timeout
     }
 
-    func fetchSegments(apiKey: String,
-                       apiHost: String,
-                       userKey: String,
-                       userValue: String,
-                       segmentsToCheck: [String],
-                       completionHandler: @escaping ([String]?, OptimizelyError?) -> Void) {
+    open func fetchSegments(apiKey: String,
+                            apiHost: String,
+                            userKey: String,
+                            userValue: String,
+                            segmentsToCheck: [String],
+                            completionHandler: @escaping ([String]?, OptimizelyError?) -> Void) {
 
         let query = makeQuery(userKey: userKey, userValue: userValue, segmentsToCheck: segmentsToCheck)
         guard let httpBody = try? JSONSerialization.data(withJSONObject: query) else {

Sources/ODP/OdpSegmentManager.swift

@@ -16,7 +16,7 @@
 
 import Foundation
 
-class OdpSegmentManager {    
+public class OdpSegmentManager {    
     var odpConfig = OdpConfig()
     var segmentsCache: LruCache<String, [String]>
     var apiMgr: OdpSegmentApiManager
@@ -29,10 +29,11 @@ class OdpSegmentManager {
     ///   - cacheTimeoutInSecs: segment cache timeout
     ///   - apiManager: OdpSegmentApiManager
     ///   - resourceTimeoutInSecs: timeout for segment fetch
-    init(cacheSize: Int,
-         cacheTimeoutInSecs: Int,
-         apiManager: OdpSegmentApiManager? = nil,
-         resourceTimeoutInSecs: Int? = nil) {
+    public init(cacheSize: Int,
+                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/OptimizelyClient.swift

@@ -1,5 +1,5 @@
 //
-// Copyright 2019-2022, Optimizely, Inc. and contributors
+// Copyright 2019-2023, 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.
@@ -59,7 +59,7 @@ open class OptimizelyClient: NSObject {
 
     var decisionService: OPTDecisionService!
     public var notificationCenter: OPTNotificationCenter?
-    var odpManager: OdpManager
+    var odpManager: OdpManager!
     let sdkSettings: OptimizelySdkSettings
 
     // MARK: - Public interfaces
@@ -80,23 +80,23 @@ open class OptimizelyClient: NSObject {
                 eventDispatcher: OPTEventDispatcher? = nil,
                 datafileHandler: OPTDatafileHandler? = nil,
                 userProfileService: OPTUserProfileService? = nil,
+                odpManager: OdpManager? = nil,
                 defaultLogLevel: OptimizelyLogLevel? = nil,
                 defaultDecideOptions: [OptimizelyDecideOption]? = nil,
                 settings: OptimizelySdkSettings? = nil) {
 
         self.sdkKey = sdkKey
         self.sdkSettings = settings ?? OptimizelySdkSettings()
         self.defaultDecideOptions = defaultDecideOptions ?? []
-
-        self.odpManager = OdpManager(sdkKey: sdkKey,
-                                     disable: sdkSettings.disableOdp,
-                                     cacheSize: sdkSettings.segmentsCacheSize,
-                                     cacheTimeoutInSecs: sdkSettings.segmentsCacheTimeoutInSecs,
-                                     timeoutForSegmentFetchInSecs: sdkSettings.timeoutForSegmentFetchInSecs,
-                                     timeoutForEventDispatchInSecs: sdkSettings.timeoutForOdpEventInSecs)
-
+
         super.init()
 
+        self.odpManager = odpManager ?? OdpManager(sdkKey: sdkKey,
+                                                   disable: sdkSettings.disableOdp,
+                                                   cacheSize: sdkSettings.segmentsCacheSize,
+                                                   cacheTimeoutInSecs: sdkSettings.segmentsCacheTimeoutInSecs,
+                                                   timeoutForSegmentFetchInSecs: sdkSettings.timeoutForSegmentFetchInSecs,
+                                                   timeoutForEventDispatchInSecs: sdkSettings.timeoutForOdpEventInSecs)
         let userProfileService = userProfileService ?? DefaultUserProfileService()
         let logger = logger ?? DefaultLogger()
         type(of: logger).logLevel = defaultLogLevel ?? .info

Tests/OptimizelyTests-Common/DecisionListenerTests.swift

@@ -1,5 +1,5 @@
 //
-// Copyright 2019-2021, Optimizely, Inc. and contributors
+// Copyright 2019-2021,2023 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.
@@ -1212,6 +1212,7 @@ class FakeManager: OptimizelyClient {
                   eventDispatcher: OPTEventDispatcher? = nil,
                   datafileHandler: OPTDatafileHandler? = nil,
                   userProfileService: OPTUserProfileService? = nil,
+                  odpManager: OdpManager? = nil,
                   defaultLogLevel: OptimizelyLogLevel? = nil,
                   defaultDecideOptions: [OptimizelyDecideOption]? = nil,
                   settings: OptimizelySdkSettings? = nil) {
@@ -1224,6 +1225,7 @@ class FakeManager: OptimizelyClient {
                    eventDispatcher: eventDispatcher,
                    datafileHandler: datafileHandler,
                    userProfileService: userProfileService,
+                   odpManager: odpManager,
                    defaultLogLevel: defaultLogLevel,
                    defaultDecideOptions: defaultDecideOptions,
                    settings: settings)