swiftui-multiplatform/Shared/LocalStorageManager.swift
Angelo Stavrow dbcb18b1df
Fix bad merges (#215)
* Alert on error: shared code

commit 00e6fabe1dad243eb49d5ffdd9695bda287b8b53
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Thu Jul 28 07:16:22 2022 -0400

    Replace CollectionListModel with FetchRequest in CollectionListView

    commit d54b9471ba9da5d22c904bbb38a555529d3c15a5
    Author: Angelo Stavrow <contact@angelostavrow.com>
    Date:   Thu Jul 28 07:13:13 2022 -0400

        Add error handling to iOS post editor

        commit b48fde47147572fe78379c2bd76430f474ac4822
        Author: Angelo Stavrow <contact@angelostavrow.com>
        Date:   Wed Jul 27 12:13:06 2022 -0400

            Add error handling to macOS

            commit 695da810854414620035005b83d9c366669f96ff
            Author: Angelo Stavrow <contact@angelostavrow.com>
            Date:   Wed Jul 27 12:00:34 2022 -0400

                Log fatal errors and present alert on next launch

                commit 2017a5b437
                Author: Angelo Stavrow <contact@angelostavrow.com>
                Date:   Sun Jul 24 06:22:29 2022 -0400

                    Clean up todo comment

                commit 669e07ecd9
                Merge: efe173c b93e0c3
                Author: Angelo Stavrow <contact@angelostavrow.com>
                Date:   Sat Jun 25 12:08:17 2022 -0400

                    Merge branch 'show-downloadable-logs' into log-localstore-errors

                commit b93e0c3547
                Author: Angelo Stavrow <contact@angelostavrow.com>
                Date:   Sat Jun 25 12:07:38 2022 -0400

                    Refactor class to use protocol

                commit 9b2572ba41
                Author: Angelo Stavrow <contact@angelostavrow.com>
                Date:   Sat Jun 25 11:17:44 2022 -0400

                    Refactor logging into reuseable methods

                commit efe173cfca
                Author: Angelo Stavrow <contact@angelostavrow.com>
                Date:   Fri Jun 24 08:40:10 2022 -0400

                    Update crash alert copy and navigate to help forum

                commit 5a1b400333
                Author: Angelo Stavrow <contact@angelostavrow.com>
                Date:   Sat Jun 18 08:53:25 2022 -0400

                    Log fatal crashes and present alert on next launch

            commit f1b0a20643
            Author: Angelo Stavrow <contact@angelostavrow.com>
            Date:   Wed Jul 27 11:42:05 2022 -0400

                Revert "Log fatal errors and present alert on next launch (#212)"

                This reverts commit 7475b57772.

            commit 7475b57772
            Author: Angelo Stavrow <contact@angelostavrow.com>
            Date:   Wed Jul 27 09:47:06 2022 -0400

                Log fatal errors and present alert on next launch (#212)

                * Log fatal crashes and present alert on next launch

                * Update crash alert copy and navigate to help forum

                * Refactor logging into reuseable methods

                * Refactor class to use protocol

                * Clean up todo comment

            commit a43bd801a8
            Author: Angelo Stavrow <contact@angelostavrow.com>
            Date:   Tue May 31 07:35:40 2022 -0400

                Add error handling to Mac app

        commit a315b09553
        Author: Angelo Stavrow <contact@angelostavrow.com>
        Date:   Tue May 31 06:51:40 2022 -0400

            Cleanup

        commit 7863c2ba08
        Author: Angelo Stavrow <contact@angelostavrow.com>
        Date:   Sat May 28 09:23:16 2022 -0400

            Add error handling to post editor

    commit 2eba4c5c04
    Author: Angelo Stavrow <contact@angelostavrow.com>
    Date:   Sat May 28 07:22:27 2022 -0400

        Remove commented-out code

    commit 230f7a1076
    Author: Angelo Stavrow <contact@angelostavrow.com>
    Date:   Sat May 28 07:17:33 2022 -0400

        Delete CollectionListModel in favour of FetchRequest in CollectionListView

commit fd37a163b9
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Tue May 31 07:36:43 2022 -0400

    Revert "Add error handling to Mac app"

    This reverts commit b1a8b8b29c.

commit b1a8b8b29c
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Tue May 31 07:23:41 2022 -0400

    Add error handling to Mac app

commit 15f84b04c0
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Thu May 26 08:08:12 2022 -0400

    Handle errors in (most) shared code

    Two outliers to come back to are:

    - the LocalStoreManager, where we can’t set a current error in the WriteFreelyModel in methods that can’t throw
    - the CollectionListModel, where the initializer can’t throw because we use it as a property initializer in CollectionListView

commit c5b611b39e
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Thu May 26 07:31:11 2022 -0400

    Add FIXME to track silent failure on fetching collections

    As collections are fetched and added to the `list` property in the CollectionListModel’s initializer, it’s tricky to throw an error here: we call it as a property initializer in CollectionListView, which cannot throw.

    Consider refactoring this logic such that we’re using, for example, a @FetchRequest in CollectionListView instead.

commit b017e21e06
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Mon May 23 15:52:20 2022 -0400

    Handle purging post errors

commit 11d2e41ab5
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Mon May 23 15:12:33 2022 -0400

    Add default values for some error strings

commit dfb3a08608
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Fri May 13 08:44:13 2022 -0400

    Move User Defaults errors to ErrorConstants file

commit 223ebf5b7c
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Fri May 13 08:33:32 2022 -0400

    Set current error on API call handlers

commit faa557c2b4
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Fri May 13 08:01:11 2022 -0400

    Set current error on API call failures

commit a3b805a319
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Fri May 13 07:20:47 2022 -0400

    Add error handling to top-level content view

commit 3a53bec184
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Mon May 9 08:55:43 2022 -0400

    Clean up WriteFreelyModel’s published vars

commit aefcd0d799
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Sun May 8 10:18:21 2022 -0400

    Fix for temporary debugging

commit bf35738957
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Sun May 8 09:17:05 2022 -0400

    Handle errors on logout

commit 01ba57ae75
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Sun May 8 09:16:46 2022 -0400

    Move Account-related error handling up the hierarchy

commit 11200a01a0
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Sun May 1 12:06:36 2022 -0400

    Initial work on presenting alert on error

* Bump writefreely-swift package minimum version

commit 91e2852243
Author: Angelo Stavrow <contact@angelostavrow.com>
Date:   Sat May 28 06:50:34 2022 -0400

    Bump writefreely-swift package minimum version
2022-07-28 07:47:39 -04:00

139 lines
5.4 KiB
Swift
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import CoreData
#if os(iOS)
import UIKit
#elseif os(macOS)
import AppKit
#endif
final class LocalStorageManager {
private let logger = Logging(for: String(describing: LocalStorageManager.self))
public static var standard = LocalStorageManager()
public let container: NSPersistentContainer
private let containerName = "LocalStorageModel"
private init() {
container = NSPersistentContainer(name: containerName)
setupStore(in: container)
registerObservers()
}
func saveContext() {
if container.viewContext.hasChanges {
do {
logger.log("Saving context to local store started...")
try container.viewContext.save()
logger.log("Context saved to local store.")
} catch {
logger.logCrashAndSetFlag(error: LocalStoreError.couldNotSaveContext)
}
}
}
func purgeUserCollections() throws {
let fetchRequest: NSFetchRequest<NSFetchRequestResult> = NSFetchRequest(entityName: "WFACollection")
let deleteRequest = NSBatchDeleteRequest(fetchRequest: fetchRequest)
do {
logger.log("Purging user collections from local store...")
try container.viewContext.executeAndMergeChanges(using: deleteRequest)
logger.log("User collections purged from local store.")
} catch {
logger.log("\(LocalStoreError.couldNotPurgeCollections.localizedDescription)", level: .error)
throw LocalStoreError.couldNotPurgeCollections
}
}
}
private extension LocalStorageManager {
var oldStoreURL: URL {
let appSupport = FileManager.default.urls(for: .applicationSupportDirectory, in: .userDomainMask).first!
return appSupport.appendingPathComponent("LocalStorageModel.sqlite")
}
var sharedStoreURL: URL {
let id = "group.com.abunchtell.writefreely"
let groupContainer = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: id)!
return groupContainer.appendingPathComponent("LocalStorageModel.sqlite")
}
func setupStore(in container: NSPersistentContainer) {
if !FileManager.default.fileExists(atPath: oldStoreURL.path) {
container.persistentStoreDescriptions.first!.url = sharedStoreURL
}
container.loadPersistentStores { _, error in
self.logger.log("Loading local store...")
if let error = error {
self.logger.logCrashAndSetFlag(error: LocalStoreError.couldNotLoadStore(error.localizedDescription))
}
self.logger.log("Loaded local store.")
}
migrateStore(for: container)
container.viewContext.automaticallyMergesChangesFromParent = true
container.viewContext.mergePolicy = NSMergeByPropertyObjectTrumpMergePolicy
}
func migrateStore(for container: NSPersistentContainer) {
// Check if the shared store exists before attempting a migration  for example, in case we've already attempted
// and successfully completed a migration, but the deletion of the old store failed for some reason.
guard !FileManager.default.fileExists(atPath: sharedStoreURL.path) else { return }
let coordinator = container.persistentStoreCoordinator
// Get a reference to the old store.
guard let oldStore = coordinator.persistentStore(for: oldStoreURL) else {
return
}
// Attempt to migrate the old store over to the shared store URL.
do {
self.logger.log("Migrating local store to shared store...")
try coordinator.migratePersistentStore(oldStore,
to: sharedStoreURL,
options: nil,
withType: NSSQLiteStoreType)
self.logger.log("Migrated local store to shared store.")
} catch {
logger.logCrashAndSetFlag(error: LocalStoreError.couldNotMigrateStore(error.localizedDescription))
}
// Attempt to delete the old store.
do {
logger.log("Deleting migrated local store...")
try FileManager.default.removeItem(at: oldStoreURL)
logger.log("Deleted migrated local store.")
} catch {
logger.logCrashAndSetFlag(
error: LocalStoreError.couldNotDeleteStoreAfterMigration(error.localizedDescription)
)
}
}
func registerObservers() {
let center = NotificationCenter.default
#if os(iOS)
let notification = UIApplication.willResignActiveNotification
#elseif os(macOS)
let notification = NSApplication.willResignActiveNotification
#endif
// We don't need to worry about removing this observer because we're targeting iOS 9+ / macOS 10.11+; the
// system will clean this up the next time it would be posted to.
// See: https://developer.apple.com/documentation/foundation/notificationcenter/1413994-removeobserver
// And: https://developer.apple.com/documentation/foundation/notificationcenter/1407263-removeobserver
// swiftlint:disable:next discarded_notification_center_observer
center.addObserver(forName: notification, object: nil, queue: nil, using: self.saveContextOnResignActive)
}
func saveContextOnResignActive(_ notification: Notification) {
saveContext()
}
}