Generalize Error Handling (#28)

haIIux · 0xLeif · web-flow · commit 9e36fbfb764a · 2023-02-25T14:49:07.000-07:00
* added new errorhandling file, removed vertical space to clean swiftlint

* created more global error handling method to be reused

* added little documentation

* adds more generalized error enum

* Add Scribe to project dependecies

* Add a basic shared Scribe object

* Make Errors private and specific

* Use t.error for mock errors

* Use new ErrorHandler singleton

* Add ErrorHandler and ToastErrorPlugin

* Removed singleton ErrorHandler

* Add ScribeLogging protocol

* Move logging files to a folder

---------

Co-authored-by: Leif &lt;zmeriksen@icloud.com&gt;
diff --git a/base/App/Profile/ProfileScreen.swift b/base/App/Profile/ProfileScreen.swift
@@ -35,7 +35,7 @@ struct ProfileScreen: View {
                 RegisterScreen(
                     registerViewModel: RegisterViewModel(
                         // TODO: (base-Template) Update to Production
-                        registerNetworking: SuccessMockRegisterService()
+                        registerNetworking: NoDataFailureMockRegisterService()
                     )
                 )
             }
diff --git a/base/App/Profile/Register/RegisterNetworking.swift b/base/App/Profile/Register/RegisterNetworking.swift
@@ -14,7 +14,7 @@
 //  RegisterNetworking.swift
 //
 
-import Foundation
+import t
 
 protocol RegisterNetworking {
    mutating func register(
@@ -65,7 +65,7 @@ struct NoDataFailureMockRegisterService: RegisterNetworking {
         password: String,
         passwordConfirmation: String
     ) async throws -> User {
-      throw AuthError.noData
+        throw t.error(description: "No Data")
     }
 }
 
@@ -77,6 +77,6 @@ struct ValidationFailureMockRegisterService: RegisterNetworking {
         password: String,
         passwordConfirmation: String
     ) async throws -> User {
-        throw AuthError.validation(reason: "Mock Failure")
+        throw t.error(description: "Validation")
     }
 }
diff --git a/base/App/Profile/Register/RegisterViewModel.swift b/base/App/Profile/Register/RegisterViewModel.swift
@@ -20,17 +20,27 @@ import Foundation
  The `RegisterViewModel` conforms to type `ObservableObject`,
  and acts as mediator between the view and the networking layer.
  */
-class RegisterViewModel: ObservableObject {
+class RegisterViewModel: ObservableObject, ErrorHandling {
     private var registerNetworking: RegisterNetworking
     private var registerTask: Task<Void, Never>?
 
+    var errorHandler: ErrorHandler
+
     @Published var username = ""
     @Published var email = ""
     @Published var password = ""
     @Published var confirmationPassword = ""
 
-    init(registerNetworking: RegisterNetworking) {
+    init(
+        registerNetworking: RegisterNetworking,
+        errorHandler: ErrorHandler = ErrorHandler(
+            plugins: [
+                ToastErrorPlugin()
+            ]
+        )
+    ) {
         self.registerNetworking = registerNetworking
+        self.errorHandler = errorHandler
     }
 
     var areFieldsValidated: Bool {
@@ -63,29 +73,12 @@ class RegisterViewModel: ObservableObject {
                     )
                 }
             } catch {
-                handle(error: error)
+                errorHandler.handle(error: error)
             }
         }
 
         registerTask = task
 
         return task
     }
-
-    private func handle(error: Error) {
-        #if DEBUG
-        Navigation.path.toast(
-            title: "Error",
-            message: error.localizedDescription,
-            style: .error
-        )
-        #else
-        print("⚠️ Error! - \(error)")
-        Navigation.path.toast(
-            title: "Error",
-            message: "There was an error registering your account, please try again.",
-            style: .error
-        )
-        #endif
-    }
 }
diff --git a/base/Networking/Implementation/AuthNetworking+Default.swift b/base/Networking/Implementation/AuthNetworking+Default.swift
@@ -16,6 +16,18 @@
 
 import Foundation
 
+private enum AuthNetworkingError: LocalizedError {
+    case noData
+    case validation(reason: String)
+
+    var errorDescription: String? {
+        switch self {
+        case .noData:                   return "\(#fileID): No Data"
+        case let .validation(reason):   return "\(#fileID): Validation: \(reason)"
+        }
+    }
+}
+
 extension AuthNetworking {
     var tokenFileName: String { "base.token" }
 
@@ -75,13 +87,13 @@ extension AuthNetworking {
         let httpResponse = dataResponse.response as? HTTPURLResponse
 
         guard httpResponse?.statusCode == 200 else {
-            throw AuthError.validation(
+            throw AuthNetworkingError.validation(
                 reason: "Status code was not 200, but was: '\(httpResponse?.statusCode ?? -1)'"
             )
         }
 
         guard let data = dataResponse.data else {
-            throw AuthError.noData
+            throw AuthNetworkingError.noData
         }
 
         let decoder = JSONDecoder()
diff --git a/base/Networking/Interface/AuthNetworking+Models.swift b/base/Networking/Interface/AuthNetworking+Models.swift
@@ -17,13 +17,11 @@
 import Foundation
 import t
 
-enum AuthError: LocalizedError {
-    case noData
+private enum RegisterPayloadError: LocalizedError {
     case validation(reason: String)
 
     var errorDescription: String? {
         switch self {
-        case .noData:                   return "\(#fileID): No Data"
         case let .validation(reason):   return "\(#fileID): Validation: \(reason)"
         }
     }
@@ -59,7 +57,7 @@ struct RegisterPayload: Codable {
                 try t.assert(email.matches(of: regex).isEmpty == false)
             }
         } catch {
-            throw AuthError.validation(reason: "Invalid Email Address")
+            throw RegisterPayloadError.validation(reason: "Invalid Email Address")
         }
     }
 
@@ -69,7 +67,7 @@ struct RegisterPayload: Codable {
                 try t.assert(name.count < 256)
             }
         } catch {
-            throw AuthError.validation(reason: "Username is too long")
+            throw RegisterPayloadError.validation(reason: "Username is too long")
         }
     }
 
@@ -83,7 +81,7 @@ struct RegisterPayload: Codable {
                 try t.assert(password.matches(of: regex).isEmpty == false)
             }
         } catch {
-            throw AuthError.validation(
+            throw RegisterPayloadError.validation(
                 reason: """
                         Passwords must contain:
                             - At least 10 characters
diff --git a/base/Utilities/Errors/ErrorHandler.swift b/base/Utilities/Errors/ErrorHandler.swift
@@ -0,0 +1,31 @@
+//
+//  base template generated by OpenBytes on 12/17/22.
+//  Copyright (c) 2023 OpenBytes
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the conditions found at the following link:
+//  https://github.com/0xOpenBytes/ios-BASE/blob/main/LICENSE
+//
+// Created by Rob Maltese.
+//  ErrorHandler.swift
+//
+
+import Plugin
+
+class ErrorHandler: Pluginable {
+    var plugins: [any Plugin]
+
+    init(plugins: [any Plugin]) {
+        self.plugins = plugins
+    }
+
+    func handle(error: Error) {
+        Task {
+            try? await handle(value: error)
+        }
+    }
+}
diff --git a/base/Utilities/Errors/ErrorHandling.swift b/base/Utilities/Errors/ErrorHandling.swift
@@ -0,0 +1,19 @@
+//
+//  base template generated by OpenBytes on 2/16/23.
+//  Copyright (c) 2023 OpenBytes
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the conditions found at the following link:
+//  https://github.com/0xOpenBytes/ios-BASE/blob/main/LICENSE
+//
+// Created by Leif.
+//  ErrorHandling.swift
+//
+
+protocol ErrorHandling {
+    var errorHandler: ErrorHandler { get set }
+}
diff --git a/base/Utilities/Errors/Plugins/ToastErrorPlugin.swift b/base/Utilities/Errors/Plugins/ToastErrorPlugin.swift
@@ -0,0 +1,40 @@
+//
+//  base template generated by OpenBytes on 2/16/23.
+//  Copyright (c) 2023 OpenBytes
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the conditions found at the following link:
+//  https://github.com/0xOpenBytes/ios-BASE/blob/main/LICENSE
+//
+// Created by Leif.
+//  ToastErrorPlugin.swift
+//
+
+import Plugin
+import Scribe
+
+struct ToastErrorPlugin: ImmutablePlugin {
+    func handle(value: Error) async throws {
+        baseScribe.shared.error(
+            Scribe.Message(stringLiteral: value.localizedDescription)
+        )
+
+        #if DEBUG
+        Navigation.path.toast(
+            title: "Error",
+            message: value.localizedDescription,
+            style: .error
+        )
+        #else
+        Navigation.path.toast(
+            title: "Error",
+            message: "Encountered an error, please try again.",
+            style: .error
+        )
+        #endif
+    }
+}
diff --git a/base/Utilities/Logging/ScribeLogging.swift b/base/Utilities/Logging/ScribeLogging.swift
@@ -0,0 +1,21 @@
+//
+//  base template generated by OpenBytes on 2/17/23.
+//  Copyright (c) 2023 OpenBytes
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the conditions found at the following link:
+//  https://github.com/0xOpenBytes/ios-BASE/blob/main/LICENSE
+//
+// Created by Leif.
+//  ScribeLogging.swift
+//
+
+import Scribe
+
+protocol ScribeLogging {
+    var scribe: Scribe { get set }
+}
diff --git a/base/Utilities/Logging/baseScribe.swift b/base/Utilities/Logging/baseScribe.swift
@@ -0,0 +1,26 @@
+//
+//  base template generated by OpenBytes on 2/16/23.
+//  Copyright (c) 2023 OpenBytes
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the conditions found at the following link:
+//  https://github.com/0xOpenBytes/ios-BASE/blob/main/LICENSE
+//
+// Created by Leif.
+//  baseScribe.swift
+//
+
+import Scribe
+
+class baseScribe: Scribe {
+    static var shared: baseScribe = baseScribe(
+        label: "base.scribe",
+        plugins: [
+
+        ]
+    )
+}
diff --git a/project.yml b/project.yml
@@ -5,6 +5,9 @@ packages:
   Fork:
     url: https://github.com/0xLeif/Fork
     from: 1.0.0
+  Scribe:
+    url: https://github.com/0xLeif/Scribe
+    from: 1.2.0
   o:
     url: https://github.com/0xOpenBytes/o
     from: 2.0.0
@@ -48,6 +51,7 @@ targets:
             - "Swish"
     dependencies:
       - package: Fork
+      - package: Scribe
       - package: o
       - package: c
     postCompileScripts:

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ struct ProfileScreen: View {`
`35`	`35`	`RegisterScreen(`
`36`	`36`	`registerViewModel: RegisterViewModel(`
`37`	`37`	`// TODO: (base-Template) Update to Production`
`38`		`- registerNetworking: SuccessMockRegisterService()`
	`38`	`+ registerNetworking: NoDataFailureMockRegisterService()`
`39`	`39`	`)`
`40`	`40`	`)`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`// RegisterNetworking.swift`
`15`	`15`	`//`
`16`	`16`
`17`		`-import Foundation`
	`17`	`+import t`
`18`	`18`
`19`	`19`	`protocol RegisterNetworking {`
`20`	`20`	`mutating func register(`
`@@ -65,7 +65,7 @@ struct NoDataFailureMockRegisterService: RegisterNetworking {`
`65`	`65`	`password: String,`
`66`	`66`	`passwordConfirmation: String`
`67`	`67`	`) async throws -> User {`
`68`		`- throw AuthError.noData`
	`68`	`+ throw t.error(description: "No Data")`
`69`	`69`	`}`
`70`	`70`	`}`
`71`	`71`
`@@ -77,6 +77,6 @@ struct ValidationFailureMockRegisterService: RegisterNetworking {`
`77`	`77`	`password: String,`
`78`	`78`	`passwordConfirmation: String`
`79`	`79`	`) async throws -> User {`
`80`		`- throw AuthError.validation(reason: "Mock Failure")`
	`80`	`+ throw t.error(description: "Validation")`
`81`	`81`	`}`
`82`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,13 +17,11 @@`
`17`	`17`	`import Foundation`
`18`	`18`	`import t`
`19`	`19`
`20`		`-enum AuthError: LocalizedError {`
`21`		`- case noData`
	`20`	`+private enum RegisterPayloadError: LocalizedError {`
`22`	`21`	`case validation(reason: String)`
`23`	`22`
`24`	`23`	`var errorDescription: String? {`
`25`	`24`	`switch self {`
`26`		`- case .noData: return "\(#fileID): No Data"`
`27`	`25`	`case let .validation(reason): return "\(#fileID): Validation: \(reason)"`
`28`	`26`	`}`
`29`	`27`	`}`
`@@ -59,7 +57,7 @@ struct RegisterPayload: Codable {`
`59`	`57`	`try t.assert(email.matches(of: regex).isEmpty == false)`
`60`	`58`	`}`
`61`	`59`	`} catch {`
`62`		`- throw AuthError.validation(reason: "Invalid Email Address")`
	`60`	`+ throw RegisterPayloadError.validation(reason: "Invalid Email Address")`
`63`	`61`	`}`
`64`	`62`	`}`
`65`	`63`
`@@ -69,7 +67,7 @@ struct RegisterPayload: Codable {`
`69`	`67`	`try t.assert(name.count < 256)`
`70`	`68`	`}`
`71`	`69`	`} catch {`
`72`		`- throw AuthError.validation(reason: "Username is too long")`
	`70`	`+ throw RegisterPayloadError.validation(reason: "Username is too long")`
`73`	`71`	`}`
`74`	`72`	`}`
`75`	`73`
`@@ -83,7 +81,7 @@ struct RegisterPayload: Codable {`
`83`	`81`	`try t.assert(password.matches(of: regex).isEmpty == false)`
`84`	`82`	`}`
`85`	`83`	`} catch {`
`86`		`- throw AuthError.validation(`
	`84`	`+ throw RegisterPayloadError.validation(`
`87`	`85`	`reason: """`
`88`	`86`	`Passwords must contain:`
`89`	`87`	`- At least 10 characters`