writefreely/swiftui-multiplatform
2
0
Fork 0
mirror of https://github.com/writeas/writefreely-swiftui-multiplatform.git synced 2024-11-15 01:11:02 +00:00
Code Issues Releases Wiki Activity

Fix bad merges (#215)

Browse Source 
* 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
This commit is contained in:
Angelo Stavrow 2022-07-28 07:47:39 -04:00 committed by GitHub
parent 93c016268a
commit dbcb18b1df
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 121 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Shared/Extensions/UserDefaults+Extensions.swift
View File

@ -13,6 +13,8 @@ enum WFDefaults {
static let automaticallyChecksForUpdates = "automaticallyChecksForUpdates" static let automaticallyChecksForUpdates = "automaticallyChecksForUpdates"
static let subscribeToBetaUpdates = "subscribeToBetaUpdates" static let subscribeToBetaUpdates = "subscribeToBetaUpdates"
#endif #endif
static let didHaveFatalError = "didHaveFatalError"
static let fatalErrorDescription = "fatalErrorDescription"
} }
extension UserDefaults { extension UserDefaults {

23
Shared/LocalStorageManager.swift
View File

@ -8,6 +8,8 @@ import AppKit
final class LocalStorageManager { final class LocalStorageManager {
private let logger = Logging(for: String(describing: LocalStorageManager.self))
public static var standard = LocalStorageManager() public static var standard = LocalStorageManager()
public let container: NSPersistentContainer public let container: NSPersistentContainer
private let containerName = "LocalStorageModel" private let containerName = "LocalStorageModel"
@ -21,9 +23,11 @@ final class LocalStorageManager {
func saveContext() { func saveContext() {
if container.viewContext.hasChanges { if container.viewContext.hasChanges {
do { do {
logger.log("Saving context to local store started...")
try container.viewContext.save() try container.viewContext.save()
logger.log("Context saved to local store.")
} catch { } catch {
fatalError(LocalStoreError.couldNotSaveContext.localizedDescription) logger.logCrashAndSetFlag(error: LocalStoreError.couldNotSaveContext)
} }
} }
} }
@ -33,8 +37,11 @@ final class LocalStorageManager {
let deleteRequest = NSBatchDeleteRequest(fetchRequest: fetchRequest) let deleteRequest = NSBatchDeleteRequest(fetchRequest: fetchRequest)
do { do {
logger.log("Purging user collections from local store...")
try container.viewContext.executeAndMergeChanges(using: deleteRequest) try container.viewContext.executeAndMergeChanges(using: deleteRequest)
logger.log("User collections purged from local store.")
} catch { } catch {
logger.log("\(LocalStoreError.couldNotPurgeCollections.localizedDescription)", level: .error)
throw LocalStoreError.couldNotPurgeCollections throw LocalStoreError.couldNotPurgeCollections
} }
} }
@ -60,9 +67,11 @@ private extension LocalStorageManager {
} }
container.loadPersistentStores { _, error in container.loadPersistentStores { _, error in
self.logger.log("Loading local store...")
if let error = error { if let error = error {
fatalError(LocalStoreError.couldNotLoadStore(error.localizedDescription).localizedDescription) self.logger.logCrashAndSetFlag(error: LocalStoreError.couldNotLoadStore(error.localizedDescription))
} }
self.logger.log("Loaded local store.")
} }
migrateStore(for: container) migrateStore(for: container)
container.viewContext.automaticallyMergesChangesFromParent = true container.viewContext.automaticallyMergesChangesFromParent = true
@ -83,20 +92,24 @@ private extension LocalStorageManager {
// Attempt to migrate the old store over to the shared store URL. // Attempt to migrate the old store over to the shared store URL.
do { do {
self.logger.log("Migrating local store to shared store...")
try coordinator.migratePersistentStore(oldStore, try coordinator.migratePersistentStore(oldStore,
to: sharedStoreURL, to: sharedStoreURL,
options: nil, options: nil,
withType: NSSQLiteStoreType) withType: NSSQLiteStoreType)
self.logger.log("Migrated local store to shared store.")
} catch { } catch {
fatalError(LocalStoreError.couldNotMigrateStore(error.localizedDescription).localizedDescription) logger.logCrashAndSetFlag(error: LocalStoreError.couldNotMigrateStore(error.localizedDescription))
} }
// Attempt to delete the old store. // Attempt to delete the old store.
do { do {
logger.log("Deleting migrated local store...")
try FileManager.default.removeItem(at: oldStoreURL) try FileManager.default.removeItem(at: oldStoreURL)
logger.log("Deleted migrated local store.")
} catch { } catch {
fatalError( logger.logCrashAndSetFlag(
LocalStoreError.couldNotDeleteStoreAfterMigration(error.localizedDescription).localizedDescription error: LocalStoreError.couldNotDeleteStoreAfterMigration(error.localizedDescription)
) )
} }
} }

50
Shared/Logging/Logging.swift Normal file
View File

@ -0,0 +1,50 @@
//
// Logging.swift
// WriteFreely-MultiPlatform
//
// Created by Angelo Stavrow on 2022-06-25.
//
import Foundation
import os
import OSLog
protocol LogWriter {
func log(_ message: String, withSensitiveInfo privateInfo: String?, level: OSLogType)
func logCrashAndSetFlag(error: Error)
}
final class Logging {
private let logger: Logger
private let subsystem = Bundle.main.bundleIdentifier!
init(for category: String = "") {
self.logger = Logger(subsystem: subsystem, category: category)
}
}
extension Logging: LogWriter {
func log(
_ message: String,
withSensitiveInfo privateInfo: String? = nil,
level: OSLogType = .default
) {
if let privateInfo = privateInfo {
logger.log(level: level, "\(message): \(privateInfo, privacy: .sensitive)")
} else {
logger.log(level: level, "\(message)")
}
}
func logCrashAndSetFlag(error: Error) {
let errorDescription = error.localizedDescription
UserDefaults.shared.set(true, forKey: WFDefaults.didHaveFatalError)
UserDefaults.shared.set(errorDescription, forKey: WFDefaults.fatalErrorDescription)
logger.log(level: .error, "\(errorDescription)")
fatalError(errorDescription)
}
}

35
Shared/WriteFreely_MultiPlatformApp.swift
View File

@ -30,6 +30,8 @@ struct WriteFreely_MultiPlatformApp: App {
@State private var selectedTab = 0 @State private var selectedTab = 0
#endif #endif
@State private var didCrash = UserDefaults.shared.bool(forKey: WFDefaults.didHaveFatalError)
var body: some Scene { var body: some Scene {
WindowGroup { WindowGroup {
ContentView() ContentView()
@ -48,6 +50,24 @@ struct WriteFreely_MultiPlatformApp: App {
} }
} }
}) })
.alert(isPresented: $didCrash) {
var helpMsg = "Alert the humans by sharing what happened on the help forum."
if let errorMsg = UserDefaults.shared.object(forKey: WFDefaults.fatalErrorDescription) as? String {
helpMsg.append("\n\n\(errorMsg)")
}
return Alert(
title: Text("Crash Detected"),
message: Text(helpMsg),
primaryButton: .default(
Text("Let us know"), action: didPressCrashAlertButton
),
secondaryButton: .cancel(
Text("Dismiss"),
action: resetCrashFlags
)
)
}
.withErrorHandling() .withErrorHandling()
.environmentObject(model) .environmentObject(model)
.environment(\.managedObjectContext, LocalStorageManager.standard.container.viewContext) .environment(\.managedObjectContext, LocalStorageManager.standard.container.viewContext)
@ -145,4 +165,19 @@ struct WriteFreely_MultiPlatformApp: App {
} }
} }
} }
private func resetCrashFlags() {
UserDefaults.shared.set(false, forKey: WFDefaults.didHaveFatalError)
UserDefaults.shared.removeObject(forKey: WFDefaults.fatalErrorDescription)
}
private func didPressCrashAlertButton() {
resetCrashFlags()
#if os(macOS)
NSWorkspace().open(model.helpURL)
#else
UIApplication.shared.open(model.helpURL)
#endif
}
} }

16
WriteFreely-MultiPlatform.xcodeproj/project.pbxproj
View File

@ -7,6 +7,9 @@
objects = { objects = {
/* Begin PBXBuildFile section */ /* Begin PBXBuildFile section */
17027E25286741B90062EB29 /* Logging.swift in Sources */ = {isa = PBXBuildFile; fileRef = 17027E24286741B80062EB29 /* Logging.swift */; };
17027E26286741B90062EB29 /* Logging.swift in Sources */ = {isa = PBXBuildFile; fileRef = 17027E24286741B80062EB29 /* Logging.swift */; };
17027E27286757650062EB29 /* Logging.swift in Sources */ = {isa = PBXBuildFile; fileRef = 17027E24286741B80062EB29 /* Logging.swift */; };
170DFA34251BBC44001D82A0 /* PostEditorModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 170DFA33251BBC44001D82A0 /* PostEditorModel.swift */; }; 170DFA34251BBC44001D82A0 /* PostEditorModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 170DFA33251BBC44001D82A0 /* PostEditorModel.swift */; };
170DFA35251BBC44001D82A0 /* PostEditorModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 170DFA33251BBC44001D82A0 /* PostEditorModel.swift */; }; 170DFA35251BBC44001D82A0 /* PostEditorModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 170DFA33251BBC44001D82A0 /* PostEditorModel.swift */; };
17120DA124E19839002B9F6C /* AccountView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 17A5388D24DDEC7400DEFF9A /* AccountView.swift */; }; 17120DA124E19839002B9F6C /* AccountView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 17A5388D24DDEC7400DEFF9A /* AccountView.swift */; };
@ -176,6 +179,7 @@
/* End PBXCopyFilesBuildPhase section */ /* End PBXCopyFilesBuildPhase section */
/* Begin PBXFileReference section */ /* Begin PBXFileReference section */
17027E24286741B80062EB29 /* Logging.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Logging.swift; sourceTree = "<group>"; };
1709ADDF251B9A110053AF79 /* EditorLaunchingPolicy.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = EditorLaunchingPolicy.md; sourceTree = "<group>"; }; 1709ADDF251B9A110053AF79 /* EditorLaunchingPolicy.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = EditorLaunchingPolicy.md; sourceTree = "<group>"; };
170DFA33251BBC44001D82A0 /* PostEditorModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PostEditorModel.swift; sourceTree = "<group>"; }; 170DFA33251BBC44001D82A0 /* PostEditorModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PostEditorModel.swift; sourceTree = "<group>"; };
17120DA424E19CBF002B9F6C /* SettingsView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SettingsView.swift; sourceTree = "<group>"; }; 17120DA424E19CBF002B9F6C /* SettingsView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SettingsView.swift; sourceTree = "<group>"; };
@ -312,6 +316,14 @@
/* End PBXFrameworksBuildPhase section */ /* End PBXFrameworksBuildPhase section */
/* Begin PBXGroup section */ /* Begin PBXGroup section */
17027E23286741910062EB29 /* Logging */ = {
isa = PBXGroup;
children = (
17027E24286741B80062EB29 /* Logging.swift */,
);
path = Logging;
sourceTree = "<group>";
};
1709ADDE251B99D40053AF79 /* Technotes */ = { 1709ADDE251B99D40053AF79 /* Technotes */ = {
isa = PBXGroup; isa = PBXGroup;
children = ( children = (
@ -491,6 +503,7 @@
17DF32D024C8B75C00BCE2E3 /* Account */, 17DF32D024C8B75C00BCE2E3 /* Account */,
1756AE7F24CB841200FD7257 /* Extensions */, 1756AE7F24CB841200FD7257 /* Extensions */,
17275264280997BF003D0A6A /* ErrorHandling */, 17275264280997BF003D0A6A /* ErrorHandling */,
17027E23286741910062EB29 /* Logging */,
1762DCB124EB07680019C4EB /* Models */, 1762DCB124EB07680019C4EB /* Models */,
17DF32CC24C8B72300BCE2E3 /* Navigation */, 17DF32CC24C8B72300BCE2E3 /* Navigation */,
1739B8D324EAFAB700DA7421 /* PostEditor */, 1739B8D324EAFAB700DA7421 /* PostEditor */,
@ -879,6 +892,7 @@
172E10202735C64600061372 /* WFACollection+CoreDataClass.swift in Sources */, 172E10202735C64600061372 /* WFACollection+CoreDataClass.swift in Sources */,
172E10222735C64600061372 /* WFAPost+CoreDataProperties.swift in Sources */, 172E10222735C64600061372 /* WFAPost+CoreDataProperties.swift in Sources */,
172E101D2735C5AB00061372 /* LocalStorageModel.xcdatamodeld in Sources */, 172E101D2735C5AB00061372 /* LocalStorageModel.xcdatamodeld in Sources */,
17027E27286757650062EB29 /* Logging.swift in Sources */,
17836C14273EFB870047AF61 /* UserDefaults+Extensions.swift in Sources */, 17836C14273EFB870047AF61 /* UserDefaults+Extensions.swift in Sources */,
172E10242735C72500061372 /* PreferencesModel.swift in Sources */, 172E10242735C72500061372 /* PreferencesModel.swift in Sources */,
172E10172735C2DF00061372 /* EnvironmentValues+Extensions.swift in Sources */, 172E10172735C2DF00061372 /* EnvironmentValues+Extensions.swift in Sources */,
@ -928,6 +942,7 @@
1756DC0124FEE18400207AB8 /* WFACollection+CoreDataClass.swift in Sources */, 1756DC0124FEE18400207AB8 /* WFACollection+CoreDataClass.swift in Sources */,
17DF32AA24C87D3500BCE2E3 /* WriteFreely_MultiPlatformApp.swift in Sources */, 17DF32AA24C87D3500BCE2E3 /* WriteFreely_MultiPlatformApp.swift in Sources */,
17120DA724E19D11002B9F6C /* SettingsView.swift in Sources */, 17120DA724E19D11002B9F6C /* SettingsView.swift in Sources */,
17027E25286741B90062EB29 /* Logging.swift in Sources */,
1727526628099802003D0A6A /* ErrorConstants.swift in Sources */, 1727526628099802003D0A6A /* ErrorConstants.swift in Sources */,
1756DC0324FEE18400207AB8 /* WFACollection+CoreDataProperties.swift in Sources */, 1756DC0324FEE18400207AB8 /* WFACollection+CoreDataProperties.swift in Sources */,
17120DA224E1985C002B9F6C /* AccountModel.swift in Sources */, 17120DA224E1985C002B9F6C /* AccountModel.swift in Sources */,
@ -961,6 +976,7 @@
17120DAD24E1B99F002B9F6C /* AccountLoginView.swift in Sources */, 17120DAD24E1B99F002B9F6C /* AccountLoginView.swift in Sources */,
17D4926727947D780035BD7E /* MacUpdatesViewModel.swift in Sources */, 17D4926727947D780035BD7E /* MacUpdatesViewModel.swift in Sources */,
17466626256C0D0600629997 /* MacEditorTextView.swift in Sources */, 17466626256C0D0600629997 /* MacEditorTextView.swift in Sources */,
17027E26286741B90062EB29 /* Logging.swift in Sources */,
1727526B2809991A003D0A6A /* ErrorHandling.swift in Sources */, 1727526B2809991A003D0A6A /* ErrorHandling.swift in Sources */,
17E5DF8A2543610700DCDC9B /* PostTextEditingView.swift in Sources */, 17E5DF8A2543610700DCDC9B /* PostTextEditingView.swift in Sources */,
17C42E71250AAFD500072984 /* NSManagedObjectContext+ExecuteAndMergeChanges.swift in Sources */, 17C42E71250AAFD500072984 /* NSManagedObjectContext+ExecuteAndMergeChanges.swift in Sources */,