(chore): Update injection service to support global registered services (event processor) and (#249)

* make the binder an atomic property thus making sure that even if we did do a reinit that it would work

* fix coveralls tag

* add 'global' elements which don't have a sdk key

* event handler is still per sdk key for now

* fix tests

Author: thomaszurkan-optimizely

OptimizelySDK/Extensions/OptimizelyClient+Extension.swift

@@ -35,7 +35,9 @@ extension OptimizelyClient {
         // the decision service is also a singleton that will reCreate on re-initalize
         HandlerRegistryService.shared.registerBinding(binder: Binder<OPTDecisionService>(service: OPTDecisionService.self).singetlon().using(instance: decisionService).reInitializeStrategy(strategy: .reUse).sdkKey(key: sdkKey))
 
-        // An event dispatcher.  We rely on the factory to create and mantain. Again, recreate on re-initalize.
+        // An event dispatcher.  We use a singleton and use the same Event dispatcher for all
+        // projects.  If you change the event dispatcher, you can potentially lose data if you
+        // don't use the same backingstore.
         HandlerRegistryService.shared.registerBinding(binder: Binder<OPTEventDispatcher>(service: OPTEventDispatcher.self).singetlon().reInitializeStrategy(strategy: .reUse).using(instance: eventDispatcher).sdkKey(key: sdkKey))
 
         // This is a singleton and might be a good candidate for reuse.  The handler supports mulitple

OptimizelySDK/Optimizely/OptimizelyClient.swift

@@ -167,7 +167,7 @@ open class OptimizelyClient: NSObject {
 
                         // call reinit on the services we know we are reinitializing.
 
-                        for component in HandlerRegistryService.shared.lookupComponents(sdkKey: self.sdkKey) {
+                        for component in HandlerRegistryService.shared.lookupComponents(sdkKey: self.sdkKey) ?? [] {
                             HandlerRegistryService.shared.reInitializeComponent(service: component, sdkKey: self.sdkKey)
                         }
 

OptimizelySDK/OptimizelyTests/OptimizelyTests-APIs/OptimizelyClientTests_DatafileHandler.swift

@@ -76,7 +76,7 @@ class OptimizelyClientTests_DatafileHandler: XCTestCase {
 
         client.datafileHandler.stopAllUpdates()
 
-        HandlerRegistryService.shared.binders.removeAll()
+        HandlerRegistryService.shared.binders.property?.removeAll()
 
         // This is an example of a functional test case.
         // Use XCTAssert and related functions to verify your tests produce the correct results.

OptimizelySDK/OptimizelyTests/OptimizelyTests-APIs/OptimizelyClientTests_Others.swift

@@ -265,24 +265,24 @@ class OptimizelyClientTests_Others: XCTestCase {
 
         // all handlers before transfer
 
-        var handlersForCurrentSdkKey = HandlerRegistryService.shared.binders.keys.filter { $0.sdkKey == kNotRealSdkKey }
-        let oldHandlersCount = handlersForCurrentSdkKey.count
+        var handlersForCurrentSdkKey = HandlerRegistryService.shared.binders.property?.keys.filter { $0.sdkKey == kNotRealSdkKey }
+        let oldHandlersCount = handlersForCurrentSdkKey?.count
 
         // remove one of the handler to test nil-handlers
 
-        let testKey = handlersForCurrentSdkKey.filter { $0.service.contains("EventDispatcher") }.first!
-        HandlerRegistryService.shared.binders[testKey] = nil
-        
+        let testKey = handlersForCurrentSdkKey!.filter { $0.service.contains("EventDispatcher")}.first!
+        HandlerRegistryService.shared.binders.property?[testKey] = nil
+    
         // this will replace config, which will transfer all handlers
 
         try? optimizely.configSDK(datafile: OTUtils.loadJSONDatafile("api_datafile")!)
 
         // nil handlers must be cleaned up when re-init
 
-        handlersForCurrentSdkKey = HandlerRegistryService.shared.binders.keys.filter { $0.sdkKey == kNotRealSdkKey }
-        let newHandlersCount = handlersForCurrentSdkKey.count
+        handlersForCurrentSdkKey = HandlerRegistryService.shared.binders.property?.keys.filter { $0.sdkKey == kNotRealSdkKey }
+        let newHandlersCount = handlersForCurrentSdkKey?.count
 
-        XCTAssertEqual(newHandlersCount, oldHandlersCount - 1, "nil handlers should be filtered out")
+        XCTAssertEqual(newHandlersCount, oldHandlersCount! - 1, "nil handlers should be filtered out")
     }
 
 

OptimizelySDK/OptimizelyTests/OptimizelyTests-Common/DatafileHandlerTests.swift

@@ -20,7 +20,7 @@ class DatafileHandlerTests: XCTestCase {
 
     override func setUp() {
 
-        HandlerRegistryService.shared.binders.removeAll()
+        HandlerRegistryService.shared.binders.property?.removeAll()
         // Put setup code here. This method is called before the invocation of each test method in the class.
         if let url = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first {
             if (!FileManager.default.fileExists(atPath: url.path)) {
@@ -37,7 +37,7 @@ class DatafileHandlerTests: XCTestCase {
 
     override func tearDown() {
         // Put teardown code here. This method is called after the invocation of each test method in the class.
-        HandlerRegistryService.shared.binders.removeAll()
+        HandlerRegistryService.shared.binders.property?.removeAll()
     }
 
     func testDatafileHandler() {

OptimizelySDK/OptimizelyTests/OptimizelyTests-Common/DecisionListenerTests.swift

@@ -605,6 +605,6 @@ class FakeDecisionService: DefaultDecisionService {
 
 fileprivate extension HandlerRegistryService {
     func removeAll() {
-        self.binders.removeAll()
+        self.binders.property?.removeAll()
     }
 }

OptimizelySDK/Utils/HandlerRegistryService.swift

@@ -25,24 +25,34 @@ class HandlerRegistryService {
         var sdkKey: String?
     }
 
-    var binders: [ServiceKey: BinderProtocol] = [ServiceKey: BinderProtocol]()
+    var binders: AtomicProperty<[ServiceKey: BinderProtocol]> = {
+        
+        var binders = AtomicProperty<[ServiceKey: BinderProtocol]>()
+        binders.property = [ServiceKey: BinderProtocol]()
+        return binders
+    }()
 
     private init() {
 
     }
 
     func registerBinding(binder: BinderProtocol) {
         let sk = ServiceKey(service: "\(type(of: binder.service))", sdkKey: binder.sdkKey)
-        if binders[sk] != nil {
+        if binders.property?[sk] != nil {
         } else {
-            binders[sk] = binder
+            binders.property?[sk] = binder
         }
     }
 
     func injectComponent(service: Any, sdkKey: String? = nil, isReintialize: Bool=false) -> Any? {
         var result: Any?
-        let sk = ServiceKey(service: "\(type(of: service))", sdkKey: sdkKey)
-        if var binder = binders[sk] {
+        // first look up global.  Then look up if there is a local.
+        let skLocal = ServiceKey(service: "\(type(of: service))", sdkKey: sdkKey)
+        let skGlobal = ServiceKey(service: "\(type(of: service))", sdkKey: nil)
+        
+        let binderToUse = binders.property?[skLocal] ?? binders.property?[skGlobal]
+        
+        if var binder = binderToUse {
             if isReintialize && binder.strategy == .reCreate {
                 binder.instance = binder.factory()
                 result = binder.instance
@@ -61,12 +71,14 @@ class HandlerRegistryService {
             _ = injectComponent(service: service, sdkKey: sdkKey, isReintialize: true)
     }
 
-    func lookupComponents(sdkKey: String)->[Any] {
-        let value = self.binders.keys
+    func lookupComponents(sdkKey: String)->[Any]? {
+        if let value = self.binders.property?.keys
             .filter({$0.sdkKey == sdkKey})
-            .compactMap({ self.injectComponent(service: self.binders[$0]!.service, sdkKey: sdkKey) })
+            .compactMap({ self.injectComponent(service: self.binders.property![$0]!.service, sdkKey: sdkKey) }) {
+            return value
+        }
 
-        return value
+        return nil
     }
 }
 

README.md

@@ -2,7 +2,7 @@
 [![Apache 2.0](https://img.shields.io/github/license/nebula-plugins/gradle-extra-configurations-plugin.svg)](http://www.apache.org/licenses/LICENSE-2.0)
 [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/carthage/carthage)
 [![Build Status](https://travis-ci.com/optimizely/swift-sdk.svg?branch=master)](https://travis-ci.com/optimizely/swift-sdk)
-[![Coverage Status](https://coveralls.io/repos/github/optimizely/swift-sdk/badge.svg)](https://coveralls.io/github/optimizely/swift-sdk)
+[![Coverage Status](https://coveralls.io/repos/github/optimizely/swift-sdk/badge.svg?branch=master)](https://coveralls.io/github/optimizely/swift-sdk?branch=master)
 
 This repository houses the Swift SDK for use with Optimizely Full Stack and Optimizely Rollouts for Mobile and OTT.