passepartout-apple/Library/Sources/CommonUtils/Business/CoreDataPersistentStore.swift
Davide ed45e5d2e4
Fix a Core Data crash on Apple TV ()
Could not create the Preferences Core Data container in the App Group
because sub-directories did not exist. Create them upfront when using
App Group URLs.

This was not an issue with other Core Data containers because they are
stored in the app directories, where "Library/Documents" already exists.
2024-12-12 12:48:58 +01:00

150 lines
5.1 KiB
Swift

//
// CoreDataPersistentStore.swift
// Passepartout
//
// Created by Davide De Rosa on 3/14/22.
// 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 CloudKit
import Combine
import CoreData
import Foundation
public protocol CoreDataPersistentStoreLogger: Sendable {
func debug(_ msg: String)
func warning(_ msg: String)
}
public final class CoreDataPersistentStore: Sendable {
private let logger: CoreDataPersistentStoreLogger?
private let container: NSPersistentContainer
public convenience init(
logger: CoreDataPersistentStoreLogger? = nil,
containerName: String,
baseURL: URL? = nil,
model: NSManagedObjectModel,
cloudKitIdentifier: String?,
author: String?
) {
let container: NSPersistentContainer
if let cloudKitIdentifier {
container = NSPersistentCloudKitContainer(name: containerName, managedObjectModel: model)
logger?.debug("Set up CloudKit container (\(cloudKitIdentifier)): \(containerName)")
} else {
container = NSPersistentContainer(name: containerName, managedObjectModel: model)
logger?.debug("Set up local container: \(containerName)")
}
if let baseURL {
let url = baseURL.appending(component: "\(containerName).sqlite")
container.persistentStoreDescriptions = [.init(url: url)]
}
self.init(
logger: logger,
container: container,
cloudKitIdentifier: cloudKitIdentifier,
author: author
)
}
private init(
logger: CoreDataPersistentStoreLogger?,
container: NSPersistentContainer,
cloudKitIdentifier: String?,
author: String?
) {
self.logger = logger
self.container = container
guard let desc = container.persistentStoreDescriptions.first else {
fatalError("Unable to read persistent store description")
}
logger?.debug("Container description: \(desc)")
// optional container identifier for CloudKit, first in entitlements otherwise
if let cloudKitIdentifier {
desc.cloudKitContainerOptions = .init(containerIdentifier: cloudKitIdentifier)
}
// set this even for local container, to avoid readonly mode in case
// container was formerly created with CloudKit option
desc.setOption(true as NSNumber, forKey: NSPersistentHistoryTrackingKey)
// report remote notifications (do this BEFORE loadPersistentStores)
//
// https://stackoverflow.com/a/69507329/784615
// desc.setOption(true as NSNumber, forKey: NSPersistentStoreRemoteChangeNotificationPostOptionKey)
container.loadPersistentStores {
if let error = $1 {
fatalError("Unable to load persistent store: \(error)")
}
}
container.viewContext.mergePolicy = NSMergePolicy.mergeByPropertyObjectTrump
container.viewContext.automaticallyMergesChangesFromParent = true
if let author {
logger?.debug("Setting transaction author: \(author)")
container.viewContext.transactionAuthor = author
}
}
}
extension CoreDataPersistentStore {
public var context: NSManagedObjectContext {
container.viewContext
}
public func backgroundContext() -> NSManagedObjectContext {
container.newBackgroundContext()
}
}
// MARK: Development
extension CoreDataPersistentStore {
public var containerURLs: [URL]? {
guard let url = container.persistentStoreDescriptions.first?.url else {
return nil
}
return [
url,
url.deletingPathExtension().appendingPathExtension("sqlite-shm"),
url.deletingPathExtension().appendingPathExtension("sqlite-wal")
]
}
public func truncate() {
let coordinator = container.persistentStoreCoordinator
container.persistentStoreDescriptions.forEach {
do {
try $0.url.map {
try coordinator.destroyPersistentStore(at: $0, ofType: NSSQLiteStoreType)
try coordinator.addPersistentStore(ofType: NSSQLiteStoreType, configurationName: nil, at: $0, options: nil)
}
} catch {
logger?.warning("Unable to truncate persistent store: \(error)")
}
}
}
}