Merge pull request #454 from Iterable/bug/mob-2614-core-data-init

[MOB-2614] - Offline mode not initialized when including IterableSDK from a framework bundle.

Author: tapashmajumder

swift-sdk/Internal/IterableCoreDataPersistence.swift

@@ -23,17 +23,27 @@ enum PersistenceConst {
 
 @available(iOS 10.0, *)
 class PersistentContainer: NSPersistentContainer {
-    static let shared: PersistentContainer? = {
-        guard let url = ResourceHelper.url(forResource: PersistenceConst.dataModelFileName, withExtension: PersistenceConst.dataModelExtension, fromBundle: Bundle(for: PersistentContainer.self)) else {
-            ITBError("Could not find \(PersistenceConst.dataModelFileName) in bundle")
-            return nil
+    static var shared: PersistentContainer?
+    
+    static func initialize(fromBundle bundle: Bundle) -> PersistentContainer? {
+        if shared == nil {
+            shared = create(fromBundle: bundle)
         }
-        ITBInfo("DB Bundle url: \(url)")
-        guard let managedObjectModel = NSManagedObjectModel(contentsOf: url) else {
+        return shared
+    }
+    
+    override func newBackgroundContext() -> NSManagedObjectContext {
+        let backgroundContext = super.newBackgroundContext()
+        backgroundContext.automaticallyMergesChangesFromParent = true
+        backgroundContext.mergePolicy = NSMergePolicy(merge: NSMergePolicyType.mergeByPropertyStoreTrumpMergePolicyType)
+        return backgroundContext
+    }
+
+    private static func create(fromBundle bundle: Bundle) -> PersistentContainer? {
+        guard let managedObjectModel = createManagedObjectModel(fromBundle: bundle) else {
             ITBError("Could not initialize managed object model")
             return nil
         }
-        
         let container = PersistentContainer(name: PersistenceConst.dataModelFileName, managedObjectModel: managedObjectModel)
         container.loadPersistentStores { desc, error in
             if let error = error {
@@ -47,20 +57,29 @@ class PersistentContainer: NSPersistentContainer {
         container.viewContext.mergePolicy = NSMergePolicy(merge: NSMergePolicyType.mergeByPropertyStoreTrumpMergePolicyType)
 
         return container
-    }()
+    }
 
-    override func newBackgroundContext() -> NSManagedObjectContext {
-        let backgroundContext = super.newBackgroundContext()
-        backgroundContext.automaticallyMergesChangesFromParent = true
-        backgroundContext.mergePolicy = NSMergePolicy(merge: NSMergePolicyType.mergeByPropertyStoreTrumpMergePolicyType)
-        return backgroundContext
+    private static func createManagedObjectModel(fromBundle bundle: Bundle) -> NSManagedObjectModel? {
+        guard let url = managedObjectUrl(fromBundle: bundle) else {
+            ITBError("Could not find \(PersistenceConst.dataModelFileName).\(PersistenceConst.dataModelExtension) in bundle")
+            return nil
+        }
+        ITBInfo("DB Bundle url: \(url)")
+        return NSManagedObjectModel(contentsOf: url)
+    }
+    
+    private static func managedObjectUrl(fromBundle bundle: Bundle) -> URL? {
+        ResourceHelper.url(forResource: PersistenceConst.dataModelFileName,
+                           withExtension: PersistenceConst.dataModelExtension,
+                           fromBundle: bundle)
     }
 }
 
 @available(iOS 10.0, *)
 struct CoreDataPersistenceContextProvider: IterablePersistenceContextProvider {
-    init?(dateProvider: DateProviderProtocol = SystemDateProvider()) {
-        guard let persistentContainer = PersistentContainer.shared else {
+    init?(dateProvider: DateProviderProtocol = SystemDateProvider(),
+          fromBundle bundle: Bundle = Bundle.main) {
+        guard let persistentContainer = PersistentContainer.initialize(fromBundle: bundle) else {
             return nil
         }
         self.persistentContainer = persistentContainer

tests/endpoint-tests/OfflineModeE2ETests.swift

@@ -116,7 +116,7 @@ class OfflineModeEndpointTests: XCTestCase {
     private static let pushTemplateId = Environment.pushTemplateId!
     private static let inAppCampaignId = Environment.inAppCampaignId!
     private lazy var persistenceContextProvider: IterablePersistenceContextProvider = {
-        let provider = CoreDataPersistenceContextProvider()!
+        let provider = CoreDataPersistenceContextProvider(fromBundle: Bundle(for: PersistentContainer.self))!
         return provider
     }()
 }

tests/offline-events-tests/RequestHandlerTests.swift

@@ -941,7 +941,8 @@ class RequestHandlerTests: XCTestCase {
     private let dateProvider = MockDateProvider()
 
     private lazy var persistenceContextProvider: IterablePersistenceContextProvider = {
-        let provider = CoreDataPersistenceContextProvider(dateProvider: dateProvider)!
+        let provider = CoreDataPersistenceContextProvider(dateProvider: dateProvider,
+                                                          fromBundle: Bundle(for: PersistentContainer.self))!
         return provider
     }()
 }

tests/offline-events-tests/TaskProcessorTests.swift

@@ -255,7 +255,7 @@ class TaskProcessorTests: XCTestCase {
                                                 appPackageName: Bundle.main.appPackageName ?? "")
 
     private lazy var persistenceProvider: IterablePersistenceContextProvider = {
-        let provider = CoreDataPersistenceContextProvider()!
+        let provider = CoreDataPersistenceContextProvider(fromBundle: Bundle(for: PersistentContainer.self))!
         try! provider.mainQueueContext().deleteAllTasks()
         try! provider.mainQueueContext().save()
         return provider

tests/offline-events-tests/TaskRunnerTests.swift

@@ -334,7 +334,7 @@ class TaskRunnerTests: XCTestCase {
                                                 appPackageName: Bundle.main.appPackageName ?? "")
 
     private lazy var persistenceContextProvider: IterablePersistenceContextProvider = {
-        let provider = CoreDataPersistenceContextProvider()!
+        let provider = CoreDataPersistenceContextProvider(fromBundle: Bundle(for: PersistentContainer.self))!
         return provider
     }()
 }

tests/offline-events-tests/TaskSchedulerTests.swift

@@ -59,7 +59,8 @@ class TaskSchedulerTests: XCTestCase {
                                                 appPackageName: Bundle.main.appPackageName ?? "")
 
     private lazy var persistenceContextProvider: IterablePersistenceContextProvider = {
-        let provider = CoreDataPersistenceContextProvider(dateProvider: dateProvider)!
+        let provider = CoreDataPersistenceContextProvider(dateProvider: dateProvider,
+                                                          fromBundle: Bundle(for: PersistentContainer.self))!
         return provider
     }()
 

tests/offline-events-tests/TasksCRUDTests.swift

@@ -167,10 +167,10 @@ class TasksCRUDTests: XCTestCase {
     private let dateProvider = MockDateProvider()
 
     private lazy var persistenceProvider: IterablePersistenceContextProvider = {
-        let provider = CoreDataPersistenceContextProvider(dateProvider: dateProvider)!
+        let provider = CoreDataPersistenceContextProvider(dateProvider: dateProvider,
+                                                          fromBundle: Bundle(for: PersistentContainer.self))!
         try! provider.mainQueueContext().deleteAllTasks()
         try! provider.mainQueueContext().save()
         return provider
     }()
 }
-