passepartout-apple/Passepartout/App/Context/AppContext+Shared.swift
Davide ffb8829f4f
Reorganize Core Data containers (#1017)
Before anything, remove any code related to App Group containers from
tvOS target because they are not available. Include the beta receipt
override, it's broken for that reason.

In short:

- Store all Core Data containers locally. Do not use the App Group for
Core Data for consistency across platforms.
- Store logs in the App Group on iOS/macOS, but locally on tvOS (see
`urlForCaches`).

Then, rather than one container per model, merge models into:

- Local: Providers
- Remote: Profiles + Preferences (now in the same CloudKit container)

Reuse the remote model for backups too.

This change is safe because:

- Local profiles are stored via Network Extension in the keychain, not
Core Data
- Remote profiles are re-imported via CloudKit sync
- Providers are re-downloaded on first use
- Preferences are lost, but they are "cheap" data
- Profile backups are lost, but they were hidden anyway
2024-12-15 20:20:33 +01:00

302 lines
10 KiB
Swift

//
// AppContext+Shared.swift
// Passepartout
//
// Created by Davide De Rosa on 2/24/24.
// Copyright (c) 2024 Davide De Rosa. All rights reserved.
//
// https://github.com/passepartoutvpn
//
// This file is part of Passepartout.
//
// Passepartout is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Passepartout is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Passepartout. If not, see <http://www.gnu.org/licenses/>.
//
import AppData
import AppDataPreferences
import AppDataProfiles
import AppDataProviders
import CommonLibrary
import CommonUtils
import CoreData
import Foundation
import LegacyV2
import PassepartoutKit
import UIAccessibility
import UILibrary
extension AppContext {
static let shared: AppContext = {
let dependencies: Dependencies = .shared
guard let cdRemoteModel = NSManagedObjectModel.mergedModel(from: [
AppData.profilesBundle,
AppData.preferencesBundle
]) else {
fatalError("Unable to load remote model")
}
guard let cdLocalModel = NSManagedObjectModel.mergedModel(from: [
AppData.providersBundle
]) else {
fatalError("Unable to load local model")
}
let iapManager = IAPManager(
customUserLevel: dependencies.customUserLevel,
inAppHelper: dependencies.simulatedAppProductHelper(),
receiptReader: dependencies.simulatedAppReceiptReader(),
betaChecker: dependencies.betaChecker(),
productsAtBuild: dependencies.productsAtBuild()
)
let processor = dependencies.appProcessor(with: iapManager)
let tunnelEnvironment = dependencies.tunnelEnvironment()
let profileManager: ProfileManager = {
let remoteRepositoryBlock: (Bool) -> ProfileRepository = {
let remoteStore = CoreDataPersistentStore(
logger: dependencies.coreDataLogger(),
containerName: Constants.shared.containers.remote,
model: cdRemoteModel,
cloudKitIdentifier: $0 ? BundleConfiguration.mainString(for: .cloudKitId) : nil,
author: nil
)
return AppData.cdProfileRepositoryV3(
registry: dependencies.registry,
coder: CodableProfileCoder(),
context: remoteStore.context,
observingResults: true,
onResultError: {
pp_log(.App.profiles, .error, "Unable to decode remote profile: \($0)")
return .ignore
}
)
}
return ProfileManager(
repository: dependencies.mainProfileRepository(
model: cdRemoteModel,
environment: tunnelEnvironment
),
backupRepository: dependencies.backupProfileRepository(
model: cdRemoteModel
),
remoteRepositoryBlock: remoteRepositoryBlock,
mirrorsRemoteRepository: dependencies.mirrorsRemoteRepository,
processor: processor
)
}()
let tunnel = ExtendedTunnel(
tunnel: Tunnel(strategy: dependencies.tunnelStrategy(environment: tunnelEnvironment)),
environment: tunnelEnvironment,
processor: processor,
interval: Constants.shared.tunnel.refreshInterval
)
let providerManager: ProviderManager = {
let store = CoreDataPersistentStore(
logger: dependencies.coreDataLogger(),
containerName: Constants.shared.containers.local,
model: cdLocalModel,
cloudKitIdentifier: nil,
author: nil
)
let repository = AppData.cdProviderRepositoryV3(context: store.backgroundContext())
return ProviderManager(repository: repository)
}()
let migrationManager: MigrationManager = {
let profileStrategy = ProfileV2MigrationStrategy(
coreDataLogger: dependencies.coreDataLogger(),
profilesContainer: .init(
Constants.shared.containers.legacyV2,
BundleConfiguration.mainString(for: .legacyV2CloudKitId)
),
tvProfilesContainer: .init(
Constants.shared.containers.legacyV2TV,
BundleConfiguration.mainString(for: .legacyV2TVCloudKitId)
)
)
let migrationSimulation: MigrationManager.Simulation?
if AppCommandLine.contains(.fakeMigration) {
migrationSimulation = MigrationManager.Simulation(
fakeProfiles: true,
maxMigrationTime: 3.0,
randomFailures: true
)
} else {
migrationSimulation = nil
}
return MigrationManager(profileStrategy: profileStrategy, simulation: migrationSimulation)
}()
let preferencesManager: PreferencesManager = {
let preferencesStore = CoreDataPersistentStore(
logger: dependencies.coreDataLogger(),
containerName: Constants.shared.containers.remote,
model: cdRemoteModel,
cloudKitIdentifier: BundleConfiguration.mainString(for: .cloudKitId),
author: nil
)
return PreferencesManager(
modulesFactory: {
try AppData.cdModulePreferencesRepositoryV3(
context: preferencesStore.context,
moduleId: $0
)
},
providersFactory: {
try AppData.cdProviderPreferencesRepositoryV3(
context: preferencesStore.context,
providerId: $0
)
}
)
}()
return AppContext(
iapManager: iapManager,
migrationManager: migrationManager,
profileManager: profileManager,
providerManager: providerManager,
preferencesManager: preferencesManager,
registry: dependencies.registry,
tunnel: tunnel,
tunnelReceiptURL: BundleConfiguration.urlForBetaReceipt
)
}()
}
// MARK: - Dependencies
private extension Dependencies {
var customUserLevel: AppUserLevel? {
guard let userLevelString = BundleConfiguration.mainIntegerIfPresent(for: .userLevel),
let userLevel = AppUserLevel(rawValue: userLevelString) else {
return nil
}
return userLevel
}
func simulatedAppProductHelper() -> any AppProductHelper {
if AppCommandLine.contains(.fakeIAP) {
return FakeAppProductHelper()
}
return appProductHelper()
}
func simulatedAppReceiptReader() -> AppReceiptReader {
if AppCommandLine.contains(.fakeIAP) {
guard let mockHelper = simulatedAppProductHelper() as? FakeAppProductHelper else {
fatalError("When .isFakeIAP, simulatedInAppHelper is expected to be MockAppProductHelper")
}
return mockHelper.receiptReader
}
return FallbackReceiptReader(
main: StoreKitReceiptReader(),
beta: betaReceiptURL.map {
KvittoReceiptReader(url: $0)
}
)
}
var betaReceiptURL: URL? {
Bundle.main.appStoreProductionReceiptURL
}
}
// MARK: Simulator
#if targetEnvironment(simulator)
private extension Dependencies {
func tunnelStrategy(environment: TunnelEnvironment) -> TunnelObservableStrategy {
FakeTunnelStrategy(environment: environment, dataCountInterval: 1000)
}
func mainProfileRepository(model: NSManagedObjectModel, environment: TunnelEnvironment) -> ProfileRepository {
coreDataProfileRepository(model: model, observingResults: true)
}
func backupProfileRepository(model: NSManagedObjectModel) -> ProfileRepository? {
nil
}
}
#else
// MARK: Device
private extension Dependencies {
func tunnelStrategy(environment: TunnelEnvironment) -> TunnelObservableStrategy {
neStrategy(environment: environment)
}
func mainProfileRepository(model: NSManagedObjectModel, environment: TunnelEnvironment) -> ProfileRepository {
neProfileRepository(environment: environment)
}
func backupProfileRepository(model: NSManagedObjectModel) -> ProfileRepository? {
coreDataProfileRepository(model: model, observingResults: false)
}
}
#endif
// MARK: Common
private extension Dependencies {
var mirrorsRemoteRepository: Bool {
#if os(tvOS)
true
#else
false
#endif
}
func neProfileRepository(environment: TunnelEnvironment) -> ProfileRepository {
NEProfileRepository(repository: neStrategy(environment: environment)) {
profileTitle($0)
}
}
func neStrategy(environment: TunnelEnvironment) -> NETunnelStrategy {
NETunnelStrategy(
bundleIdentifier: BundleConfiguration.mainString(for: .tunnelId),
coder: neProtocolCoder(),
environment: environment
)
}
func coreDataProfileRepository(model: NSManagedObjectModel, observingResults: Bool) -> ProfileRepository {
let store = CoreDataPersistentStore(
logger: coreDataLogger(),
containerName: Constants.shared.containers.backup,
model: model,
cloudKitIdentifier: nil,
author: nil
)
return AppData.cdProfileRepositoryV3(
registry: registry,
coder: CodableProfileCoder(),
context: store.context,
observingResults: observingResults,
onResultError: {
pp_log(.App.profiles, .error, "Unable to decode local profile: \($0)")
return .ignore
}
)
}
}