Updating event registration to occur on start/stop of the scheduler. Updating scheduler unit tests

Author: ssathy2

Examples/GroceryExpress/SettingsViewController.swift

@@ -57,6 +57,10 @@ class SettingsViewController: UIViewController {
     }
     @IBAction func loginTapped(_ sender: Any) {
         attemptLogin()
+        ConnectButtonController.activate(
+            connections: [DisplayInformation.locationConnection.connectionId],
+            lifecycleSynchronizationOptions: .all
+        )
     }
     @IBAction func logoutTapped(_ sender: Any) {
         ConnectionCredentials(settings: settings).logout()

IFTTT SDK.xcodeproj/project.pbxproj

@@ -54,6 +54,7 @@
 		B556033C25A851EE00A29A01 /* Localizable_cs.strings in Resources */ = {isa = PBXBuildFile; fileRef = B556032425A851EE00A29A01 /* Localizable_cs.strings */; };
 		B556033D25A851EE00A29A01 /* Localizable_nl.strings in Resources */ = {isa = PBXBuildFile; fileRef = B556032525A851EE00A29A01 /* Localizable_nl.strings */; };
 		DE25265623D8C49D0019C9CB /* Analytics.swift in Sources */ = {isa = PBXBuildFile; fileRef = DE25265523D8C49D0019C9CB /* Analytics.swift */; };
+		DE260F6B26CAFC20004191D1 /* SynchronizationSchedulerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = DE260F6A26CAFC20004191D1 /* SynchronizationSchedulerTests.swift */; };
 		DE2906D3242BF66E00CC2825 /* Connection+Parsing.swift in Sources */ = {isa = PBXBuildFile; fileRef = DE2906D2242BF66E00CC2825 /* Connection+Parsing.swift */; };
 		DE2F524A2429404200EF986A /* Connection+Location.swift in Sources */ = {isa = PBXBuildFile; fileRef = DE2F52492429404200EF986A /* Connection+Location.swift */; };
 		DE2F524C242940AD00EF986A /* CLCircularRegion+Parsing.swift in Sources */ = {isa = PBXBuildFile; fileRef = DE2F524B242940AD00EF986A /* CLCircularRegion+Parsing.swift */; };
@@ -226,6 +227,7 @@
 		B556032525A851EE00A29A01 /* Localizable_nl.strings */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.strings; name = Localizable_nl.strings; path = Resources/Localizable_nl.strings; sourceTree = "<group>"; };
 		DE1712BC2565B295000B13E6 /* RegionEventsRegistryTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RegionEventsRegistryTests.swift; sourceTree = "<group>"; };
 		DE25265523D8C49D0019C9CB /* Analytics.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Analytics.swift; sourceTree = "<group>"; };
+		DE260F6A26CAFC20004191D1 /* SynchronizationSchedulerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SynchronizationSchedulerTests.swift; sourceTree = "<group>"; };
 		DE2906D2242BF66E00CC2825 /* Connection+Parsing.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "Connection+Parsing.swift"; sourceTree = "<group>"; };
 		DE2F52492429404200EF986A /* Connection+Location.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Connection+Location.swift"; sourceTree = "<group>"; };
 		DE2F524B242940AD00EF986A /* CLCircularRegion+Parsing.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "CLCircularRegion+Parsing.swift"; sourceTree = "<group>"; };
@@ -439,6 +441,7 @@
 				DEC29DE525840DE300BF56EE /* LocationServiceTests.swift */,
 				DEC29EE7258419FC00BF56EE /* Info.plist */,
 				DEF4A4962587BA1A00735E98 /* ArrayHelpersTests.swift */,
+				DE260F6A26CAFC20004191D1 /* SynchronizationSchedulerTests.swift */,
 			);
 			path = SDKHostAppTests;
 			sourceTree = "<group>";
@@ -864,6 +867,7 @@
 				DEC29F0125841A0800BF56EE /* String_EmailDataDetectorTests.swift in Sources */,
 				DEC29F0525841A0800BF56EE /* RegionsMonitorTests.swift in Sources */,
 				DEC29F0625841A0800BF56EE /* Connection_ParsingTests.swift in Sources */,
+				DE260F6B26CAFC20004191D1 /* SynchronizationSchedulerTests.swift in Sources */,
 				DEF4A4972587BA1A00735E98 /* ArrayHelpersTests.swift in Sources */,
 				DEC29F0225841A0800BF56EE /* EventPublisherTests.swift in Sources */,
 			);

IFTTT SDK/ConnectButtonController+Public.swift

@@ -70,25 +70,24 @@ extension ConnectButtonController {
         }
     }
 
-    /// Performs setup of the SDK. Starts the synchronization of in the SDK. Registers background process with the system if desired.
+    /// Performs setup of the SDK.Activated synchronization 
     ///
     /// - Parameters:
     ///     - credentials: An optional object conforming to `ConnectionCredentialProvider` which is used to setup the SDK. If this is nil, the SDK will attempt to use cached values.
-    ///     - lifecycleSynchronizationOptions: An instance of `ApplicationLifecycleSynchronizationOptions` that defines which app lifecycle events the synchronization should occur on. If this parameter is not set, a default value of `ApplicationLifecycleSynchronizationOptions.all` will be used.
-    public static func setup(with credentials: ConnectionCredentialProvider?,
-                             lifecycleSynchronizationOptions: ApplicationLifecycleSynchronizationOptions = .all) {
+    public static func setup(with credentials: ConnectionCredentialProvider?) {
         if let credentials = credentials {
             Keychain.update(with: credentials)
         }
-        ConnectionsSynchronizer.shared.setup(lifecycleSynchronizationOptions: lifecycleSynchronizationOptions)
     }
 
     /// Call this method to activate the synchronization. This starts synchronization for the parameter connections.
     ///
     /// - Parameters:
     ///     - connections: An optional list of `Connection` to activate synchronization with.
-    public static func activate(connections ids: [String]? = nil) {
-        ConnectionsSynchronizer.shared.activate(connections: ids)
+    ///     - lifecycleSynchronizationOptions: An instance of `ApplicationLifecycleSynchronizationOptions` that defines which app lifecycle events the synchronization should occur on. If this parameter is not set, a default value of `ApplicationLifecycleSynchronizationOptions.all` will be used.
+    public static func activate(connections ids: [String]? = nil,
+                                lifecycleSynchronizationOptions: ApplicationLifecycleSynchronizationOptions = .all) {
+        ConnectionsSynchronizer.shared.activate(connections: ids, lifecycleSynchronizationOptions: lifecycleSynchronizationOptions)
     }
 
     /// Call this method to deactivate the synchronization of connection and native service data. This stops synchronization and performs cleanup of any stored data. This will also remove any registered geofences.

IFTTT SDK/ConnectionsSynchronizer.swift

@@ -133,14 +133,6 @@ final class ConnectionsSynchronizer {
         location.start()
     }
 
-    /// Performs basic setup of the SDK with Application lifecycle synchronization options.
-    ///
-    /// - Parameters:
-    ///     - lifecycleSynchronizationOptions: The synchronization options to use in setting up App Lifecycle notification observers.
-    func setup(lifecycleSynchronizationOptions: ApplicationLifecycleSynchronizationOptions) {
-        scheduler.setup(lifecycleSynchronizationOptions: lifecycleSynchronizationOptions)
-    }
-    
     /// Can be used to force a synchronization.
     ///
     /// - Parameters:
@@ -151,18 +143,19 @@ final class ConnectionsSynchronizer {
         eventPublisher.onNext(event)
     }
 
-    /// Used to start the synchronization with an optional list of connection ids to monitor.
+    /// Used to start the synchronization.
     ///
     /// - Parameters:
     ///     - connections: An optional list of connections to start monitoring.
-    func activate(connections ids: [String]? = nil) {
+    ///     - lifecycleSynchronizationOptions: The app lifecycle synchronization options to use with the scheduler
+    func activate(connections ids: [String]? = nil, lifecycleSynchronizationOptions: ApplicationLifecycleSynchronizationOptions) {
         if let ids = ids {
             registry.addConnections(with: ids, shouldNotify: false)
             ConnectButtonController.synchronizationLog("Activated synchronization with connection ids: \(ids)")
         } else {
             ConnectButtonController.synchronizationLog("Activated synchronization")
         }
-        start()
+        start(lifecycleSynchronizationOptions: lifecycleSynchronizationOptions)
         update(isActivation: true)
     }
 
@@ -174,19 +167,17 @@ final class ConnectionsSynchronizer {
     }
 
     /// Call this to start the synchronization. Safe to be called multiple times.
-    private func start() {
+    private func start(lifecycleSynchronizationOptions: ApplicationLifecycleSynchronizationOptions) {
         if state == .running { return }
 
-        setupNotifications()
         performPreflightChecks()
         Keychain.resetIfNecessary(force: false)
-        scheduler.start()
+        scheduler.start(lifecycleSynchronizationOptions: lifecycleSynchronizationOptions)
         state = .running
     }
 
     /// Call this to stop the synchronization completely. Safe to be called multiple times.
     private func stop() {
-        stopNotifications()
         Keychain.resetIfNecessary(force: true)
         scheduler.stop()
         state = .stopped
@@ -198,22 +189,7 @@ final class ConnectionsSynchronizer {
             ConnectButtonController.synchronizationLog("Background location not enabled for this target! Enable background location to allow location updates to be delivered to the app in the background.")
         }
     }
-    
-    /// Peforms internal setup to allow the SDK to perform work in response to notification center notifications.
-    private func setupNotifications() {
-        if #available(iOS 13.0, *) {
-            NotificationCenter.default.addObserver(self,
-                                                   selector: #selector(applicationDidEnterBackground),
-                                                   name: UIApplication.didEnterBackgroundNotification,
-                                                   object: nil)
-        }
-    }
-    
-    /// Stops notification observation
-    private func stopNotifications() {
-        NotificationCenter.default.removeObserver(self)
-    }
-    
+        
     private func setupRegistryNotifications() {
         NotificationCenter.default.addObserver(forName: .UpdateConnectionsName,
                                                object: nil,

IFTTT SDK/SynchronizationManager.swift

@@ -36,7 +36,7 @@ final class SynchronizationManager {
     /// Creates a `SyncManager`
     ///
     /// - Parameter subscribers: The `SyncSubscribers to perform during syncs
-    init(subscribers: Array<SynchronizationSubscriber>) {
+    init(subscribers: [SynchronizationSubscriber]) {
         self.subscribers = subscribers
     }
 
@@ -126,7 +126,7 @@ extension SynchronizationManager {
             finish()
         }
 
-        private(set) var subscribers: Array<SynchronizationSubscriber> = []
+        private(set) var subscribers = [SynchronizationSubscriber]()
 
         private var resultsBySubscriber: [String : UIBackgroundFetchResult] = [:]
 

IFTTT SDK/SynchronizationScheduler.swift

@@ -18,16 +18,16 @@ final class SynchronizationScheduler {
     private let manager: SynchronizationManager
 
     /// The token corresponding to the subscriber.
-    private var subscriberToken: UUID?
+    private(set) var subscriberToken: UUID?
 
     /// The tokens that get generated when the SDK sets up application lifecycle NotificationCenter observers
-    private var applicationLifecycleNotificationCenterTokens: [Any] = []
+    private(set) var applicationLifecycleNotificationCenterTokens: [Any] = []
 
     /// The tokens that get generated when the SDK sets up other NotificationCenter observers
-    private var sdkGeneratedNotificationCenterTokens: [Any] = []
+    private(set) var sdkGeneratedNotificationCenterTokens: [Any] = []
 
     /// Has the app opted into using background process?
-    private var optedInToUsingSDKBackgroundProcess: Bool = false
+    private(set) var optedInToUsingSDKBackgroundProcess: Bool = false
 
     /// The triggers to kick off synchronizations
     private let triggers: EventPublisher<SynchronizationTriggerEvent>
@@ -49,53 +49,29 @@ final class SynchronizationScheduler {
     /// - Parameters:
     ///   - syncManager: The `SyncManager` to use when scheduling a sync
     ///   - triggers: The publisher to use in publishing any possible events we might need to.
-    init(manager: SynchronizationManager,
-         triggers: EventPublisher<SynchronizationTriggerEvent>) {
+    init(manager: SynchronizationManager, triggers: EventPublisher<SynchronizationTriggerEvent>) {
         self.manager = manager
         self.triggers = triggers
-        setupSubscribers()
-    }
-    
-    func setup(lifecycleSynchronizationOptions: ApplicationLifecycleSynchronizationOptions) {
-        removeLifecycleNotificationObservers()
-        
-        // Start synchronization on system events
-        var appLifecycleEventTuples = [(NSNotification.Name, SynchronizationSource, Bool)]()
-        
-        if lifecycleSynchronizationOptions.contains(.applicationDidBecomeActive) {
-            appLifecycleEventTuples.append((UIApplication.didBecomeActiveNotification, .appDidBecomeActive, false))
-        }
-        if lifecycleSynchronizationOptions.contains(.applicationDidEnterBackground) {
-            appLifecycleEventTuples.append((UIApplication.didEnterBackgroundNotification, .appBackgrounded, true))
-        }
-        
-        self.applicationLifecycleNotificationCenterTokens = appLifecycleEventTuples.map {
-            return scheduleSynchronization(on: $0.0,
-                                          source: $0.1,
-                                          shouldRunInBackground: $0.2)
-        }
+        startAppSubscribers()
     }
 
     /// Performs registration for system and SDK generated events for kicking off synchronizations
     /// Should get called when the scheduler is to start.
-    func start() {
-        // Remove any previous tokens that might still be aroind
+    func start(lifecycleSynchronizationOptions: ApplicationLifecycleSynchronizationOptions) {
+        // Remove any previous tokens that might still be around
         removeSDKGeneratedNotificationObservers()
+        removeLifecycleNotificationObservers()
+        removeAppSubscribers()
 
         // Start the manager
         manager.start()
 
-        // Start monitoring the notifications related to Connection CRUD operations
-        let eventTuples: [(NSNotification.Name, SynchronizationSource, Bool)] = [
-            (.ConnectionUpdatedNotification, .connectionsUpdate, true),
-            (.ConnectionAddedNotification, .connectionAddition, true)
-        ]
-        
-        self.sdkGeneratedNotificationCenterTokens = eventTuples.map {
-            return scheduleSynchronization(on: $0.0,
-                                           source: $0.1,
-                                           shouldRunInBackground: $0.2)
-        }
+        // Start SDK generated subscribers
+        startSDKGeneratedSubscribers()
+        // Start app lifecycle subscribers
+        startApplicationLifecycleSubscribers(lifecycleSynchronizationOptions: lifecycleSynchronizationOptions)
+        // Start app generated subscribers()
+        startAppSubscribers()
     }
 
     /// Unregisters from system and SDK generated events for synchronizations.
@@ -104,39 +80,72 @@ final class SynchronizationScheduler {
         // Reset the manager
         manager.reset()
 
-        // Unregister from background process
         // Remove observers from notification center
         removeLifecycleNotificationObservers()
         removeSDKGeneratedNotificationObservers()
-        
-        applicationLifecycleNotificationCenterTokens = []
-        sdkGeneratedNotificationCenterTokens = []
+        removeAppSubscribers()
 
         // Cancel background tasks associated with the SDK
         cancelBackgroundProcess()
-        
-        if let subscriberToken = subscriberToken {
-            triggers.removeSubscriber(subscriberToken)
-        }
-        
-        // Nil out the subscriber token
-        subscriberToken = nil
     }
 
     private func removeLifecycleNotificationObservers() {
         applicationLifecycleNotificationCenterTokens.forEach {
             NotificationCenter.default.removeObserver($0)
         }
+        applicationLifecycleNotificationCenterTokens = []
     }
 
     private func removeSDKGeneratedNotificationObservers() {
         sdkGeneratedNotificationCenterTokens.forEach {
             NotificationCenter.default.removeObserver($0)
         }
+        sdkGeneratedNotificationCenterTokens = []
+    }
+    
+    private func removeAppSubscribers() {
+        if let subscriberToken = subscriberToken {
+            triggers.removeSubscriber(subscriberToken)
+        }
+        
+        // Nil out the subscriber token
+        subscriberToken = nil
     }
 
-    /// Sets up subscriber with app generated triggers.
-    private func setupSubscribers() {
+    /// Sets up subscribers with app lifecycle events
+    private func startApplicationLifecycleSubscribers(lifecycleSynchronizationOptions: ApplicationLifecycleSynchronizationOptions) {
+        // Start synchronization on system events
+        var appLifecycleEventTuples = [(NSNotification.Name, SynchronizationSource, Bool)]()
+        
+        if lifecycleSynchronizationOptions.contains(.applicationDidBecomeActive) {
+            appLifecycleEventTuples.append((UIApplication.didBecomeActiveNotification, .appDidBecomeActive, false))
+        }
+        if lifecycleSynchronizationOptions.contains(.applicationDidEnterBackground) {
+            appLifecycleEventTuples.append((UIApplication.didEnterBackgroundNotification, .appBackgrounded, true))
+        }
+        
+        var tokens = appLifecycleEventTuples.map {
+            return scheduleSynchronization(on: $0.0,
+                                           source: $0.1,
+                                           shouldRunInBackground: $0.2)
+        }
+        
+        if #available(iOS 13.0, *) {
+            let token = NotificationCenter.default.addObserver(
+                forName: UIApplication.didEnterBackgroundNotification,
+                object: nil,
+                queue: nil)
+            { [weak self] _ in
+                self?.applicationDidEnterBackground()
+            }
+            tokens.append(token)
+        }
+        
+        self.applicationLifecycleNotificationCenterTokens = tokens
+    }
+    
+    /// Starts subscribers with app generated triggers.
+    private func startAppSubscribers() {
         guard subscriberToken == nil else { return }
 
         self.subscriberToken = triggers.addSubscriber { [weak self] (triggerEvent) in
@@ -150,6 +159,21 @@ final class SynchronizationScheduler {
         }
     }
 
+    /// Starts subscribers with SDK generated triggers.
+    private func startSDKGeneratedSubscribers() {
+        // Start monitoring the notifications related to Connection CRUD operations
+        let eventTuples: [(NSNotification.Name, SynchronizationSource, Bool)] = [
+            (.ConnectionUpdatedNotification, .connectionsUpdate, true),
+            (.ConnectionAddedNotification, .connectionAddition, true)
+        ]
+        
+        self.sdkGeneratedNotificationCenterTokens = eventTuples.map {
+            return scheduleSynchronization(on: $0.0,
+                                           source: $0.1,
+                                           shouldRunInBackground: $0.2)
+        }
+    }
+    
     /// Helper method to schedule a synchronization with a `NSNotification`.
     ///
     /// - Parameters:
@@ -215,7 +239,7 @@ final class SynchronizationScheduler {
     }
 
     /// Hook that should get called when the app enters the background. Schedules background process with the system.
-    func applicationDidEnterBackground() {            
+    @objc func applicationDidEnterBackground() {
         if #available(iOS 13.0, *) {
             guard Bundle.main.backgroundProcessingEnabled else { return }
             guard Bundle.main.containsIFTTTBackgroundProcessingIdentifier else { return }