minor error handling improvements

lukepistrol · lukepistrol · commit da0c0babd5f8 · 2024-10-18T08:57:49.000+02:00
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -63,3 +63,8 @@ custom_rules:
     message: "Use `SFSafeSymbols` via `systemSymbol` parameters for type safety."
     regex: "(Image\\(systemName:)|(NSImage\\(symbolName:)|(Label[^,]+?,\\s*systemImage:)|(UIApplicationShortcutIcon\\(systemImageName:)"
     severity: warning
+  no_print_statements:
+    name: "No print statements"
+    message: "Use the `Logging` package instead."
+    regex: "(print\\(.*\\))|(debugPrint\\(.*\\))"
+    severity: warning
diff --git a/TimeMachineStatus.xcodeproj/project.pbxproj b/TimeMachineStatus.xcodeproj/project.pbxproj
@@ -190,6 +190,7 @@
 				28FAD5A62AFE3DBF00F642E7 /* CardViewModifier.swift */,
 				28FAD5AC2AFF0D7200F642E7 /* ExpandableSection.swift */,
 				28FAD5AE2AFF0D9600F642E7 /* UserfacingErrorView.swift */,
+				281C819D2CBC887D00CDFED6 /* HiddenViewModifier+.swift */,
 			);
 			path = Components;
 			sourceTree = "<group>";
@@ -281,7 +282,6 @@
 				281822662AFD86AC0067E564 /* Color+RawRepresentable.swift */,
 				2888D17B2C99B3E80081FBBB /* KeyedDecodingContainer+.swift */,
 				28710D2E2CAF16AF00033855 /* Timer+Sendable.swift */,
-				281C819D2CBC887D00CDFED6 /* HiddenViewModifier+.swift */,
 			);
 			path = Extensions;
 			sourceTree = "<group>";
diff --git a/TimeMachineStatus/Components/CustomLabeledContentStyle.swift b/TimeMachineStatus/Components/CustomLabeledContentStyle.swift
@@ -28,3 +28,9 @@ struct CustomLabeledContentStyle: LabeledContentStyle {
         }
     }
 }
+
+extension LabeledContentStyle where Self == CustomLabeledContentStyle {
+    static var custom: CustomLabeledContentStyle {
+        CustomLabeledContentStyle()
+    }
+}
diff --git a/TimeMachineStatus/Components/ExpandableSection.swift b/TimeMachineStatus/Components/ExpandableSection.swift
@@ -51,3 +51,15 @@ struct ExpandableSection<C: View, H: View>: View {
         }
     }
 }
+
+#Preview {
+    List {
+        ExpandableSection {
+            Text("Item 1")
+            Text("Item 2")
+            Text("Item 3")
+        } header: {
+            Text("Header")
+        }
+    }
+}
diff --git a/TimeMachineStatus/Components/HiddenViewModifier+.swift b/TimeMachineStatus/Components/HiddenViewModifier+.swift
diff --git a/TimeMachineStatus/Localizable.xcstrings b/TimeMachineStatus/Localizable.xcstrings
@@ -426,13 +426,20 @@
       }
     },
     "D" : {
+      "extractionState" : "manual",
       "localizations" : {
         "de" : {
           "stringUnit" : {
             "state" : "translated",
             "value" : "D"
           }
         },
+        "en" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "D"
+          }
+        },
         "it" : {
           "stringUnit" : {
             "state" : "translated",
@@ -464,6 +471,28 @@
         }
       }
     },
+    "dest_info_error" : {
+      "localizations" : {
+        "de" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Fehler Code"
+          }
+        },
+        "en" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Error Code"
+          }
+        },
+        "it" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Codice errore"
+          }
+        }
+      }
+    },
     "dest_info_filesystem" : {
       "extractionState" : "manual",
       "localizations" : {
@@ -579,6 +608,28 @@
         }
       }
     },
+    "dest_info_number_of_backups" : {
+      "localizations" : {
+        "de" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Anzahl an Sicherungen"
+          }
+        },
+        "en" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Number of backups"
+          }
+        },
+        "it" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Numero di backup"
+          }
+        }
+      }
+    },
     "dest_info_quota" : {
       "extractionState" : "manual",
       "localizations" : {
@@ -671,25 +722,25 @@
         }
       }
     },
-    "dest_label_last_backup_failed" : {
+    "dest_label_last_backup_failed_%lld" : {
       "extractionState" : "manual",
       "localizations" : {
         "de" : {
           "stringUnit" : {
             "state" : "translated",
-            "value" : "Letztes Backup fehlgeschlagen. TimeMachine Einstellungen öffnen um mehr zu erfahren."
+            "value" : "Letztes Backup fehlgeschlagen (%lld). TimeMachine Einstellungen öffnen um mehr zu erfahren."
           }
         },
         "en" : {
           "stringUnit" : {
             "state" : "translated",
-            "value" : "Last Backup Failed. Open TimeMachine Settings for more information."
+            "value" : "Last Backup Failed (%lld). Open TimeMachine Settings for more information."
           }
         },
         "it" : {
           "stringUnit" : {
             "state" : "translated",
-            "value" : "Ultimo backup non riuscito. Apri le Impostazioni di TimeMachine per ulteriori informazioni."
+            "value" : "Ultimo backup non riuscito (%lld). Apri le Impostazioni di TimeMachine per ulteriori informazioni."
           }
         }
       }
diff --git a/TimeMachineStatus/Model/BackupState/BackupState.swift b/TimeMachineStatus/Model/BackupState/BackupState.swift
@@ -28,12 +28,12 @@ enum BackupState {
         if let state = try? _decodePlist(data, raw: result) {
             return state
         }
+
         #if DEBUG
         log.error("Unknown state: \(result)")
-        fatalError("Unknown state: \(result)")
-        #else
-        throw BackupStateError.invalidState(raw: result)
         #endif
+
+        throw BackupStateError.invalidState(raw: result)
     }
 }
 
@@ -72,11 +72,8 @@ extension BackupState {
         case ._thinning:
             return try decoder.decode(BackupState.Thinning.self, from: data)
         case ._unknown(let state):
-            #if DEBUG
-            throw BackupStateError.invalidState(raw: raw)
-            #else
+            log.warning("Unknown state: \(state), raw: \(raw)")
             return BackupState.Unknown(title: state, raw: raw)
-            #endif
         }
     }
 }
diff --git a/TimeMachineStatus/Model/Preferences/Preferences.swift b/TimeMachineStatus/Model/Preferences/Preferences.swift
@@ -105,6 +105,7 @@ struct Destination: Decodable {
         case referenceLocalSnapshotDate = "ReferenceLocalSnapshotDate"
         case snapshotDates = "SnapshotDates"
         case attemptDates = "AttemptDates"
+        case result = "RESULT"
     }
 
     let lastKnownVolumeName: String?
@@ -119,6 +120,7 @@ struct Destination: Decodable {
     let referenceLocalSnapshotDate: Date?
     let snapshotDates: [Date]?
     let attemptDates: [Date]?
+    let result: Int?
 
     var lastBackupFailed: Bool {
         guard let snapshotDates,
@@ -129,6 +131,10 @@ struct Destination: Decodable {
 
         return lastAttempt > last
     }
+
+    var numberOfBackups: Int {
+        snapshotDates?.count ?? 0
+    }
 }
 
 extension Preferences {
@@ -160,7 +166,8 @@ extension Destination {
             consistencyScanDate: .distantPast,
             referenceLocalSnapshotDate: .now,
             snapshotDates: [.distantPast, .now.addingTimeInterval(.random(in: -100_000...0))],
-            attemptDates: [.distantPast, .now.addingTimeInterval(.random(in: -100_000...0))]
+            attemptDates: [.distantPast, .now.addingTimeInterval(.random(in: -100_000...0))],
+            result: 0
         )
     }
 }
diff --git a/TimeMachineStatus/Views/DestinationCell.swift b/TimeMachineStatus/Views/DestinationCell.swift
@@ -61,6 +61,9 @@ struct DestinationCell: View {
         .contentShape(.rect)
         .contextMenu { contextMenuActions }
         .card(.background.secondary)
+        .onTapGesture {
+            showInfo.toggle()
+        }
         .onHover { hovering in
             withAnimation(.snappy) {
                 self.hovering = hovering
@@ -141,7 +144,7 @@ struct DestinationCell: View {
             }
             .buttonStyle(.plain)
             .focusable(false)
-            .help("dest_label_last_backup_failed")
+            .help("dest_label_last_backup_failed_\(dest.result ?? -1)")
         }
     }
 
diff --git a/TimeMachineStatus/Views/DestinationInfoView.swift b/TimeMachineStatus/Views/DestinationInfoView.swift
@@ -22,7 +22,7 @@ struct DestinationInfoView: View {
                 if let lastKnownEncryptionState = dest.lastKnownEncryptionState {
                     LabeledContent("dest_info_encrypted", value: lastKnownEncryptionState)
                 }
-                if let networkURL = dest.networkURL {
+                if let networkURL = dest.networkURL?.removingPercentEncoding {
                     LabeledContent("dest_info_url", value: networkURL)
                 }
             }
@@ -41,16 +41,22 @@ struct DestinationInfoView: View {
                 }
             }
             Section {
+                LabeledContent("dest_info_number_of_backups", value: "\(dest.numberOfBackups)")
                 if let last = dest.snapshotDates?.max() {
                     LabeledContent("dest_info_lastbackup", value: last.formatted(.relativeDate))
                 }
                 if let last = dest.attemptDates?.max() {
                     LabeledContent("dest_info_lastattempt", value: last.formatted(.relativeDate))
                 }
             }
+            Section {
+                if let errorCode = dest.result, errorCode != 0 {
+                    LabeledContent("dest_info_error", value: "\(errorCode)")
+                }
+            }
         }
         .formStyle(.grouped)
-        .labeledContentStyle(CustomLabeledContentStyle())
+        .labeledContentStyle(.custom)
         .frame(width: 500)
     }
 }
diff --git a/TimeMachineStatus/Views/MenuView.swift b/TimeMachineStatus/Views/MenuView.swift
@@ -118,7 +118,7 @@ struct MenuView: View {
             } header: {
                 Text("section_general_info")
             }
-            .labeledContentStyle(CustomLabeledContentStyle())
+            .labeledContentStyle(.custom)
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -28,3 +28,9 @@ struct CustomLabeledContentStyle: LabeledContentStyle {`
`28`	`28`	`}`
`29`	`29`	`}`
`30`	`30`	`}`
	`31`	`+`
	`32`	`+extension LabeledContentStyle where Self == CustomLabeledContentStyle {`
	`33`	`+ static var custom: CustomLabeledContentStyle {`
	`34`	`+ CustomLabeledContentStyle()`
	`35`	`+ }`
	`36`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -51,3 +51,15 @@ struct ExpandableSection<C: View, H: View>: View {`
`51`	`51`	`}`
`52`	`52`	`}`
`53`	`53`	`}`
	`54`	`+`
	`55`	`+#Preview {`
	`56`	`+ List {`
	`57`	`+ ExpandableSection {`
	`58`	`+ Text("Item 1")`
	`59`	`+ Text("Item 2")`
	`60`	`+ Text("Item 3")`
	`61`	`+ } header: {`
	`62`	`+ Text("Header")`
	`63`	`+ }`
	`64`	`+ }`
	`65`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -28,12 +28,12 @@ enum BackupState {`
`28`	`28`	`if let state = try? _decodePlist(data, raw: result) {`
`29`	`29`	`return state`
`30`	`30`	`}`
	`31`	`+`
`31`	`32`	`#if DEBUG`
`32`	`33`	`log.error("Unknown state: \(result)")`
`33`		`- fatalError("Unknown state: \(result)")`
`34`		`- #else`
`35`		`- throw BackupStateError.invalidState(raw: result)`
`36`	`34`	`#endif`
	`35`	`+`
	`36`	`+ throw BackupStateError.invalidState(raw: result)`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`
`@@ -72,11 +72,8 @@ extension BackupState {`
`72`	`72`	`case ._thinning:`
`73`	`73`	`return try decoder.decode(BackupState.Thinning.self, from: data)`
`74`	`74`	`case ._unknown(let state):`
`75`		`- #if DEBUG`
`76`		`- throw BackupStateError.invalidState(raw: raw)`
`77`		`- #else`
	`75`	`+ log.warning("Unknown state: \(state), raw: \(raw)")`
`78`	`76`	`return BackupState.Unknown(title: state, raw: raw)`
`79`		`- #endif`
`80`	`77`	`}`
`81`	`78`	`}`
`82`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -105,6 +105,7 @@ struct Destination: Decodable {`
`105`	`105`	`case referenceLocalSnapshotDate = "ReferenceLocalSnapshotDate"`
`106`	`106`	`case snapshotDates = "SnapshotDates"`
`107`	`107`	`case attemptDates = "AttemptDates"`
	`108`	`+ case result = "RESULT"`
`108`	`109`	`}`
`109`	`110`
`110`	`111`	`let lastKnownVolumeName: String?`
`@@ -119,6 +120,7 @@ struct Destination: Decodable {`
`119`	`120`	`let referenceLocalSnapshotDate: Date?`
`120`	`121`	`let snapshotDates: [Date]?`
`121`	`122`	`let attemptDates: [Date]?`
	`123`	`+ let result: Int?`
`122`	`124`
`123`	`125`	`var lastBackupFailed: Bool {`
`124`	`126`	`guard let snapshotDates,`
`@@ -129,6 +131,10 @@ struct Destination: Decodable {`
`129`	`131`
`130`	`132`	`return lastAttempt > last`
`131`	`133`	`}`
	`134`	`+`
	`135`	`+ var numberOfBackups: Int {`
	`136`	`+ snapshotDates?.count ?? 0`
	`137`	`+ }`
`132`	`138`	`}`
`133`	`139`
`134`	`140`	`extension Preferences {`
`@@ -160,7 +166,8 @@ extension Destination {`
`160`	`166`	`consistencyScanDate: .distantPast,`
`161`	`167`	`referenceLocalSnapshotDate: .now,`
`162`	`168`	`snapshotDates: [.distantPast, .now.addingTimeInterval(.random(in: -100_000...0))],`
`163`		`- attemptDates: [.distantPast, .now.addingTimeInterval(.random(in: -100_000...0))]`
	`169`	`+ attemptDates: [.distantPast, .now.addingTimeInterval(.random(in: -100_000...0))],`
	`170`	`+ result: 0`
`164`	`171`	`)`
`165`	`172`	`}`
`166`	`173`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,9 @@ struct DestinationCell: View {`
`61`	`61`	`.contentShape(.rect)`
`62`	`62`	`.contextMenu { contextMenuActions }`
`63`	`63`	`.card(.background.secondary)`
	`64`	`+ .onTapGesture {`
	`65`	`+ showInfo.toggle()`
	`66`	`+ }`
`64`	`67`	`.onHover { hovering in`
`65`	`68`	`withAnimation(.snappy) {`
`66`	`69`	`self.hovering = hovering`
`@@ -141,7 +144,7 @@ struct DestinationCell: View {`
`141`	`144`	`}`
`142`	`145`	`.buttonStyle(.plain)`
`143`	`146`	`.focusable(false)`
`144`		`- .help("dest_label_last_backup_failed")`
	`147`	`+ .help("dest_label_last_backup_failed_\(dest.result ?? -1)")`
`145`	`148`	`}`
`146`	`149`	`}`
`147`	`150`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ struct DestinationInfoView: View {`
`22`	`22`	`if let lastKnownEncryptionState = dest.lastKnownEncryptionState {`
`23`	`23`	`LabeledContent("dest_info_encrypted", value: lastKnownEncryptionState)`
`24`	`24`	`}`
`25`		`- if let networkURL = dest.networkURL {`
	`25`	`+ if let networkURL = dest.networkURL?.removingPercentEncoding {`
`26`	`26`	`LabeledContent("dest_info_url", value: networkURL)`
`27`	`27`	`}`
`28`	`28`	`}`
`@@ -41,16 +41,22 @@ struct DestinationInfoView: View {`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`	`Section {`
	`44`	`+ LabeledContent("dest_info_number_of_backups", value: "\(dest.numberOfBackups)")`
`44`	`45`	`if let last = dest.snapshotDates?.max() {`
`45`	`46`	`LabeledContent("dest_info_lastbackup", value: last.formatted(.relativeDate))`
`46`	`47`	`}`
`47`	`48`	`if let last = dest.attemptDates?.max() {`
`48`	`49`	`LabeledContent("dest_info_lastattempt", value: last.formatted(.relativeDate))`
`49`	`50`	`}`
`50`	`51`	`}`
	`52`	`+ Section {`
	`53`	`+ if let errorCode = dest.result, errorCode != 0 {`
	`54`	`+ LabeledContent("dest_info_error", value: "\(errorCode)")`
	`55`	`+ }`
	`56`	`+ }`
`51`	`57`	`}`
`52`	`58`	`.formStyle(.grouped)`
`53`		`- .labeledContentStyle(CustomLabeledContentStyle())`
	`59`	`+ .labeledContentStyle(.custom)`
`54`	`60`	`.frame(width: 500)`
`55`	`61`	`}`
`56`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ struct MenuView: View {`
`118`	`118`	`} header: {`
`119`	`119`	`Text("section_general_info")`
`120`	`120`	`}`
`121`		`- .labeledContentStyle(CustomLabeledContentStyle())`
	`121`	`+ .labeledContentStyle(.custom)`
`122`	`122`	`}`
`123`	`123`	`}`
`124`	`124`