Encapsulate *Persistence responsibilities (#305)

Do not leave the choice of a repository context up to the library
consumer. Instead, provide a specific factory (*Persistence) for each
module.

Passepartout/AppShared/Context/CoreContext.swift

@@ -33,18 +33,18 @@ import TunnelKitManager
 final class CoreContext {
     let store: KeyValueStore
 
-    private let profilesPersistence: CoreDataPersistentStore
+    private let providersPersistence: ProvidersPersistence
 
-    private let providersPersistence: CoreDataPersistentStore
+    private let vpnPersistence: VPNPersistence
-
-    var urlsForProfiles: [URL]? {
-        profilesPersistence.containerURLs
-    }
 
     var urlsForProviders: [URL]? {
         providersPersistence.containerURLs
     }
 
+    var urlsForProfiles: [URL]? {
+        vpnPersistence.containerURLs
+    }
+
     let upgradeManager: UpgradeManager
 
     let providerManager: ProviderManager
@@ -67,7 +67,7 @@ final class CoreContext {
         pp_log.info("Logging to: \(logger.logFile!)")
 
         let persistenceManager = PersistenceManager(store: store)
-        profilesPersistence = persistenceManager.profilesPersistence(
+        vpnPersistence = persistenceManager.vpnPersistence(
             withName: Constants.Persistence.profilesContainerName
         )
         providersPersistence = persistenceManager.providersPersistence(
@@ -89,17 +89,17 @@ final class CoreContext {
                 Constants.Repos.api,
                 timeout: Constants.Services.connectivityTimeout
             ),
-            webServicesRepository: PassepartoutPersistence.webServicesRepository(providersPersistence)
+            webServicesRepository: providersPersistence.webServicesRepository()
         )
         providerManager = ProviderManager(
-            localProvidersRepository: PassepartoutPersistence.localProvidersRepository(providersPersistence),
+            localProvidersRepository: providersPersistence.localProvidersRepository(),
             remoteProvidersStrategy: remoteProvidersStrategy
         )
 
         profileManager = ProfileManager(
             store: store,
             providerManager: providerManager,
-            profileRepository: PassepartoutPersistence.profileRepository(profilesPersistence),
+            profileRepository: vpnPersistence.profileRepository(),
             keychain: KeychainSecretRepository(appGroup: Constants.App.appGroupId),
             keychainEntry: Unlocalized.Keychain.passwordEntry,
             keychainLabel: Unlocalized.Keychain.passwordLabel

Passepartout/AppShared/Context/PersistenceManager.swift

@@ -39,12 +39,12 @@ final class PersistenceManager {
         }
     }
 
-    func profilesPersistence(withName containerName: String) -> CoreDataPersistentStore {
+    func vpnPersistence(withName containerName: String) -> VPNPersistence {
-        PassepartoutPersistence.profilesStore(withName: containerName, cloudKit: true, author: persistenceAuthor)
+        VPNPersistence(withName: containerName, cloudKit: true, author: persistenceAuthor)
     }
 
-    func providersPersistence(withName containerName: String) -> CoreDataPersistentStore {
+    func providersPersistence(withName containerName: String) -> ProvidersPersistence {
-        PassepartoutPersistence.providersStore(withName: containerName, cloudKit: false, author: persistenceAuthor)
+        ProvidersPersistence(withName: containerName, cloudKit: false, author: persistenceAuthor)
     }
 }
 

PassepartoutLibrary/Sources/PassepartoutCore/Passepartout.swift

@@ -35,9 +35,6 @@ public class Passepartout {
     public var logger: Logger = DefaultLogger()
 }
 
-public enum PassepartoutPersistence {
-}
-
 public struct PassepartoutError: Error, Equatable {
     private let string: String
 

PassepartoutLibrary/Sources/PassepartoutProvidersImpl/Data/ProvidersPersistence.swift

@@ -1,5 +1,5 @@
 //
-//  Persistence.swift
+//  ProvidersPersistence.swift
 //  Passepartout
 //
 //  Created by Davide De Rosa on 4/7/22.
@@ -29,30 +29,34 @@ import PassepartoutCore
 import PassepartoutProviders
 import PassepartoutServices
 
-extension PassepartoutPersistence {
+public final class ProvidersPersistence {
-    private static let providersDataModel: NSManagedObjectModel = {
+    private static let dataModel: NSManagedObjectModel = {
         guard let model = NSManagedObjectModel.mergedModel(from: [.module]) else {
             fatalError("Could not load PassepartoutProviders model")
         }
         return model
     }()
 
-    public static func providersStore(withName containerName: String, cloudKit: Bool, author: String?) -> CoreDataPersistentStore {
+    private let store: CoreDataPersistentStore
-        .init(
+
+    public var containerURLs: [URL]? {
+        store.containerURLs
+    }
+
+    public init(withName containerName: String, cloudKit: Bool, author: String?) {
+        store = .init(
             withName: containerName,
-            model: providersDataModel,
+            model: Self.dataModel,
             cloudKit: cloudKit,
             author: author
         )
     }
-}
 
-extension PassepartoutPersistence {
+    public func webServicesRepository() -> WebServicesRepository {
-    public static func webServicesRepository(_ store: CoreDataPersistentStore) -> WebServicesRepository {
         CDWebServicesRepository(store.context)
     }
 
-    public static func localProvidersRepository(_ store: CoreDataPersistentStore) -> LocalProvidersRepository {
+    public func localProvidersRepository() -> LocalProvidersRepository {
         CDLocalProvidersRepository(store.context)
     }
 }

PassepartoutLibrary/Sources/PassepartoutVPNImpl/Data/VPNPersistence.swift

@@ -1,5 +1,5 @@
 //
-//  Persistence.swift
+//  VPNPersistence.swift
 //  Passepartout
 //
 //  Created by Davide De Rosa on 4/7/22.
@@ -28,25 +28,30 @@ import Foundation
 import PassepartoutCore
 import PassepartoutVPN
 
-extension PassepartoutPersistence {
+public final class VPNPersistence {
-    private static let profilesDataModel: NSManagedObjectModel = {
+    private static let dataModel: NSManagedObjectModel = {
         guard let model = NSManagedObjectModel.mergedModel(from: [.module]) else {
             fatalError("Could not load PassepartoutProfiles model")
         }
         return model
     }()
 
-    public static func profilesStore(withName containerName: String, cloudKit: Bool, author: String?) -> CoreDataPersistentStore {
+    private let store: CoreDataPersistentStore
-        .init(
+
+    public var containerURLs: [URL]? {
+        store.containerURLs
+    }
+
+    public init(withName containerName: String, cloudKit: Bool, author: String?) {
+        store = .init(
             withName: containerName,
-            model: profilesDataModel,
+            model: Self.dataModel,
             cloudKit: cloudKit,
             author: author
         )
     }
-}
+
-extension PassepartoutPersistence {
+    public func profileRepository() -> ProfileRepository {
-    public static func profileRepository(_ store: CoreDataPersistentStore) -> ProfileRepository {
         CDProfileRepository(store.context)
     }
 }

PassepartoutLibrary/Tests/PassepartoutProvidersTests/ProvidersTests.swift

@@ -31,7 +31,7 @@ import PassepartoutProviders
 import XCTest
 
 final class ProvidersTests: XCTestCase {
-    private var persistence: CoreDataPersistentStore!
+    private var persistence: ProvidersPersistence!
 
     private var manager: ProviderManager!
 
@@ -39,16 +39,16 @@ final class ProvidersTests: XCTestCase {
 
     override func setUp() {
         let model = NSManagedObjectModel.mergedModel(from: [.module])!
-        persistence = CoreDataPersistentStore(withName: "ProvidersTests", model: model, cloudKit: false, author: nil)
+        persistence = ProvidersPersistence(withName: "ProvidersTests", cloudKit: false, author: nil)
 
         let remoteStrategy = APIRemoteProvidersStrategy(
             appBuild: 10000,
             bundleServices: APIWebServices.bundledServices(withVersion: "v5"),
             remoteServices: APIWebServices("v5", URL(string: "https://passepartoutvpn.app/api/")!, timeout: nil),
-            webServicesRepository: PassepartoutPersistence.webServicesRepository(persistence)
+            webServicesRepository: persistence.webServicesRepository()
         )
         manager = ProviderManager(
-            localProvidersRepository: PassepartoutPersistence.localProvidersRepository(persistence),
+            localProvidersRepository: persistence.localProvidersRepository(),
             remoteProvidersStrategy: remoteStrategy
         )
 //        persistence.truncate()