(chore):refactor data file handler to be more generic and allow for addition … (#186)

* refactor data file handler to be more generic and allow for addition of other types of data file handers (i.e. push notification, server side events, etc.)

* make the datafilehandler interface accessable so to allow stopping of updates and general access to datafile handler services

* add exposure to the endpoint per sdk key so that they can go to different cdns if necessary

* update test

* fix broken datafile manager

* refactored out the fact that we don't set the timer if the interval is <= 0

* remove event test update

Author: thomaszurkan-optimizely

DemoSwiftApp/AppDelegate.swift

@@ -55,6 +55,8 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
 
     func initializeOptimizelySDKAsynchronous() {
         optimizely = OptimizelyClient(sdkKey: sdkKey)
+        var handler = optimizely.datafileHandler
+        handler.endPointStringFormat = "https://cdn.optimizely.com/datafiles/%@.json"
 
         optimizely.start { result in
             switch result {

OptimizelySDK/Extensions/OptimizelyClient+Extension.swift

@@ -42,4 +42,32 @@ extension OptimizelyClient {
         // sdk keys without having to be created for every key.
         HandlerRegistryService.shared.registerBinding(binder:Binder<OPTDatafileHandler>(service: OPTDatafileHandler.self).singetlon().reInitializeStrategy(strategy: .reUse).to(factory: type(of:datafileHandler).init).using(instance: datafileHandler).sdkKey(key: sdkKey))
     }
+    
+    /// Optimizely Manager
+    ///
+    /// - Parameters:
+    ///   - sdkKey: sdk key
+    ///   - logger: custom Logger
+    ///   - eventDispatcher: custom EventDispatcher (optional)
+    ///   - userProfileService: custom UserProfileService (optional)
+    ///   - periodicDownloadInterval: custom interval for periodic background datafile download (optional. default = 10 * 60 secs)
+    ///   - defaultLogLevel: default log level (optional. default = .info)
+    public convenience init(sdkKey: String,
+                logger: OPTLogger? = nil,
+                eventDispatcher: OPTEventDispatcher? = nil,
+                userProfileService: OPTUserProfileService? = nil,
+                periodicDownloadInterval:Int? = nil,
+                defaultLogLevel: OptimizelyLogLevel? = nil) {
+        let interval = periodicDownloadInterval ?? 10 * 60
+        
+        
+        self.init(sdkKey: sdkKey, logger: logger, eventDispatcher: eventDispatcher, userProfileService: userProfileService, defaultLogLevel: defaultLogLevel)
+        
+        if let handler = datafileHandler as? DefaultDatafileHandler, interval > 0 {
+            handler.setTimer(sdkKey: sdkKey, interval: interval)
+        }
+        
+        
+    }
+
 }

OptimizelySDK/Implementation/DefaultDatafileHandler.swift

@@ -17,9 +17,9 @@
 import Foundation
 
 class DefaultDatafileHandler : OPTDatafileHandler {
-    static public var endPointStringFormat = "https://cdn.optimizely.com/datafiles/%@.json"
+    public var endPointStringFormat = "https://cdn.optimizely.com/datafiles/%@.json"
     lazy var logger = HandlerRegistryService.shared.injectLogger()
-    var timers:AtomicProperty<[String:(timer:Timer, interval:Int)]> = AtomicProperty(property: [String:(Timer,Int)]())
+    var timers:AtomicProperty<[String:(timer:Timer?, interval:Int)]> = AtomicProperty(property: [String:(Timer?,Int)]())
     let dataStore = DataStoreUserDefaults()
 
     let downloadQueue = DispatchQueue(label: "DefaultDatafileHandlerQueue", qos: DispatchQoS.default, attributes: DispatchQueue.Attributes.concurrent, autoreleaseFrequency: DispatchQueue.AutoreleaseFrequency.inherit, target: nil)
@@ -28,6 +28,15 @@ class DefaultDatafileHandler : OPTDatafileHandler {
 
     }
 
+    func setTimer(sdkKey:String, interval:Int) {
+        timers.performAtomic { (timers) in
+            guard let _ = timers[sdkKey] else {
+                timers[sdkKey] = (nil, interval)
+                return
+            }
+        }
+    }
+    
     func downloadDatafile(sdkKey: String) -> Data? {
 
         var datafile:Data?
@@ -60,7 +69,7 @@ class DefaultDatafileHandler : OPTDatafileHandler {
     }
 
     open func getRequest(sdkKey:String) -> URLRequest? {
-        let str = String(format: DefaultDatafileHandler.endPointStringFormat, sdkKey)
+        let str = String(format: endPointStringFormat, sdkKey)
         guard let url = URL(string: str) else { return nil }
 
         var request = URLRequest(url: url)
@@ -231,20 +240,36 @@ class DefaultDatafileHandler : OPTDatafileHandler {
             if let timer = timers[sdkKey] {
                 logger?.i("Stopping timer for datafile updates sdkKey: \(sdkKey)")
 
-                timer.timer.invalidate()
+                timer.timer?.invalidate()
                 timers.removeValue(forKey: sdkKey)
             }
 
         }
     }
 
     func stopPeriodicUpdates() {
-        for key in timers.property?.keys ?? Dictionary<String, (timer: Timer, interval: Int)>().keys {
+        for key in timers.property?.keys ?? Dictionary<String, (timer: Timer?, interval: Int)>().keys {
             logger?.i("Stopping timer for all datafile updates")
             stopPeriodicUpdates(sdkKey: key)
         }
 
     }
+    
+    func startUpdates(sdkKey: String, datafileChangeNotification: ((Data) -> Void)?) {
+        if let value = timers.property?[sdkKey], !(value.timer?.isValid ?? false) {
+            startPeriodicUpdates(sdkKey: sdkKey, updateInterval: value.interval, datafileChangeNotification: datafileChangeNotification)
+        }
+    }
+    
+    func stopUpdates(sdkKey: String) {
+        stopPeriodicUpdates(sdkKey: sdkKey)
+    }
+    
+    func stopAllUpdates() {
+        stopPeriodicUpdates()
+    }
+    
+
 
 
     func saveDatafile(sdkKey: String, dataFile: Data) {

OptimizelySDK/Optimizely/OptimizelyClient.swift

@@ -34,7 +34,6 @@ open class OptimizelyClient: NSObject {
     var eventDispatcher: OPTEventDispatcher {
         return HandlerRegistryService.shared.injectEventDispatcher(sdkKey: self.sdkKey)!
     }
-    let periodicDownloadInterval: Int
 
     // MARK: - Default Services
 
@@ -43,7 +42,8 @@ open class OptimizelyClient: NSObject {
     var decisionService: OPTDecisionService {
         return HandlerRegistryService.shared.injectDecisionService(sdkKey: self.sdkKey)!
     }
-    var datafileHandler: OPTDatafileHandler {
+    
+    public var datafileHandler: OPTDatafileHandler {
         return HandlerRegistryService.shared.injectDatafileHandler(sdkKey: self.sdkKey)!
     }
 
@@ -68,11 +68,9 @@ open class OptimizelyClient: NSObject {
                 logger: OPTLogger? = nil,
                 eventDispatcher: OPTEventDispatcher? = nil,
                 userProfileService: OPTUserProfileService? = nil,
-                periodicDownloadInterval: Int? = nil,
                 defaultLogLevel: OptimizelyLogLevel? = nil) {
 
         self.sdkKey = sdkKey
-        self.periodicDownloadInterval = periodicDownloadInterval ?? 10 * 60
 
         super.init()
 
@@ -158,34 +156,30 @@ open class OptimizelyClient: NSObject {
             // this isn't really necessary because the try would throw if there is a problem.  But, we want to avoid using bang so we do another let binding.
             guard let config = self.config else { throw OptimizelyError.dataFileInvalid }
 
-            if periodicDownloadInterval > 0 {
-                datafileHandler.stopPeriodicUpdates(sdkKey: self.sdkKey)
-                datafileHandler.startPeriodicUpdates(sdkKey: self.sdkKey, updateInterval: periodicDownloadInterval) { data in
-                    // new datafile came in...
-                    self.reInitLock.wait(); defer { self.reInitLock.signal() }
-                    if let config = try? ProjectConfig(datafile: data) {
-                        do {
-                            if let users = self.config?.whitelistUsers {
-                                config.whitelistUsers = users
-                            }
-                            
-                            self.config = config
-                            
-                            // call reinit on the services we know we are reinitializing.
-                            
-                            for component in HandlerRegistryService.shared.lookupComponents(sdkKey: self.sdkKey) ?? [] {
-                                guard let component = component else { continue }
-                                HandlerRegistryService.shared.reInitializeComponent(service: component, sdkKey: self.sdkKey)
-                            }
-                            
+            datafileHandler.startUpdates(sdkKey: self.sdkKey) { data in
+                // new datafile came in...
+                self.reInitLock.wait(); defer { self.reInitLock.signal() }
+                if let config = try? ProjectConfig(datafile: data) {
+                    do {
+                        if let users = self.config?.whitelistUsers {
+                            config.whitelistUsers = users
                         }
 
-                        self.notificationCenter.sendNotifications(type:
-                            NotificationType.DatafileChange.rawValue, args: [data])
+                        self.config = config
+                        
+                        // call reinit on the services we know we are reinitializing.
+                        
+                        for component in HandlerRegistryService.shared.lookupComponents(sdkKey: self.sdkKey) ?? [] {
+                            guard let component = component else { continue }
+                            HandlerRegistryService.shared.reInitializeComponent(service: component, sdkKey: self.sdkKey)
+                        }
 
                     }
+                    
+                    self.notificationCenter.sendNotifications(type:
+                        NotificationType.DatafileChange.rawValue, args: [data])
+                    
                 }
-                
             }
         } catch let error as OptimizelyError {
             // .datafileInvalid

OptimizelySDK/OptimizelyTests/OptimizelyTests-Common/DatafileHandlerTests.swift

@@ -125,7 +125,7 @@ class DatafileHandlerTests: XCTestCase {
         let _ = optimizely.notificationCenter.addDatafileChangeNotificationListener { (data) in
             count += 1
             if count == 9 {
-                optimizely.datafileHandler.stopPeriodicUpdates()
+                optimizely.datafileHandler.stopAllUpdates()
                 expection.fulfill()
             }
         }

OptimizelySDK/OptimizelyTests/OptimizelyTests-Common/DecisionListenerTests.swift

@@ -571,9 +571,9 @@ class FakeManager: OptimizelyClient {
         }
     }
 
-    override init(sdkKey: String, logger:OPTLogger? = nil, eventDispatcher:OPTEventDispatcher? = nil, userProfileService:OPTUserProfileService? = nil, periodicDownloadInterval:Int? = nil, defaultLogLevel: OptimizelyLogLevel? = nil) {
+    override init(sdkKey: String, logger:OPTLogger? = nil, eventDispatcher:OPTEventDispatcher? = nil, userProfileService:OPTUserProfileService? = nil, defaultLogLevel: OptimizelyLogLevel? = nil) {
 
-        super.init(sdkKey: sdkKey, logger: logger, eventDispatcher: eventDispatcher, userProfileService: userProfileService, periodicDownloadInterval: periodicDownloadInterval, defaultLogLevel: defaultLogLevel)
+        super.init(sdkKey: sdkKey, logger: logger, eventDispatcher: eventDispatcher, userProfileService: userProfileService, defaultLogLevel: defaultLogLevel)
         HandlerRegistryService.shared.removeAll()
 
         let userProfileService = userProfileService ?? DefaultUserProfileService()

OptimizelySDK/Protocols/OPTDatafileHandler.swift

@@ -23,6 +23,8 @@ public typealias DatafileDownloadCompletionHandler = (OptimizelyResult<Data?>) -
 ///
 public protocol OPTDatafileHandler {
     init()
+    
+    var endPointStringFormat:String { get set }
     /**
     Synchronous call to download the datafile.
 
@@ -43,24 +45,23 @@ public protocol OPTDatafileHandler {
                           completionHandler:@escaping DatafileDownloadCompletionHandler)
 
     /**
-      Start periodic updates to the project datafile .
+      Start updates to the project datafile .
 
       - Parameter sdkKey: SdkKey for the datafile
-      - Parameter updateInterval: frequency of updates in seconds
      */
-    func startPeriodicUpdates(sdkKey:String, updateInterval:Int, datafileChangeNotification:((Data)->Void)?)
+    func startUpdates(sdkKey:String, datafileChangeNotification:((Data)->Void)?)
 
     /**
      Stop the periodic updates. This should be called when the app goes to background
 
      - Parameter sdkKey: sdk key for datafile.
      */
-    func stopPeriodicUpdates(sdkKey:String)
+    func stopUpdates(sdkKey:String)
 
     /**
      Stop all periodic updates. This should be called when the app goes to background
      */
-    func stopPeriodicUpdates()
+    func stopAllUpdates()
 
     /**
      Save the datafile to cache.