Add additonal error handling to DBP database and related classes

DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -138,7 +138,7 @@
     {
       "identity" : "swift-syntax",
       "kind" : "remoteSourceControl",
-      "location" : "https://github.com/apple/swift-syntax.git",
+      "location" : "https://github.com/apple/swift-syntax",
       "state" : {
         "revision" : "64889f0c732f210a935a0ad7cda38f77f876262d",
         "version" : "509.1.1"

DuckDuckGo/DBP/DBPHomeViewController.swift

@@ -33,6 +33,7 @@ public extension Notification.Name {
 final class DBPHomeViewController: NSViewController {
     private var presentedWindowController: NSWindowController?
     private let dataBrokerProtectionManager: DataBrokerProtectionManager
+    private let pixelHandler: EventMapping<DataBrokerProtectionPixels> = DataBrokerProtectionPixelsHandler()
 
     lazy var dataBrokerProtectionViewController: DataBrokerProtectionViewController = {
         let privacyConfigurationManager = PrivacyFeatures.contentBlocking.privacyConfigurationManager
@@ -83,9 +84,14 @@ final class DBPHomeViewController: NSViewController {
             attachDataBrokerContainerView()
         }
 
-        if dataBrokerProtectionManager.dataManager.fetchProfile() != nil {
-            let dbpDateStore = DefaultWaitlistActivationDateStore(source: .dbp)
-            dbpDateStore.updateLastActiveDate()
+        do {
+            if try dataBrokerProtectionManager.dataManager.fetchProfile() != nil {
+                let dbpDateStore = DefaultWaitlistActivationDateStore(source: .dbp)
+                dbpDateStore.updateLastActiveDate()
+            }
+        } catch {
+            os_log("DBPHomeViewController error: viewDidLoad, error: %{public}@", log: .error, error.localizedDescription)
+            pixelHandler.fire(.generalError(error: error, functionOccurredIn: "DBPHomeViewController.viewDidLoad"))
         }
     }
 
@@ -146,6 +152,11 @@ public class DataBrokerProtectionPixelsHandler: EventMapping<DataBrokerProtectio
             switch event {
             case .error(let error, _):
                 Pixel.fire(.debug(event: .pixelKitEvent(event), error: error))
+            case .generalError(let error, _),
+                    .secureVaultInitError(let error),
+                    .secureVaultError(let error):
+                // We can't use .debug directly because it modifies the pixel name and clobbers the params
+                Pixel.fire(.pixelKitEvent(DebugEvent(event, error: error)))
             case .ipcServerOptOutAllBrokersCompletion(error: let error),
                     .ipcServerScanAllBrokersCompletion(error: let error),
                     .ipcServerRunQueuedOperationsCompletion(error: let error):

DuckDuckGo/DBP/DataBrokerProtectionAppEvents.swift

@@ -49,8 +49,8 @@ struct DataBrokerProtectionAppEvents {
 
             // If we don't have profileQueries it means there's no user profile saved in our DB
             // In this case, let's disable the agent and delete any left-over data because there's nothing for it to do
-            let profileQueries = await DataBrokerProtectionManager.shared.dataManager.fetchBrokerProfileQueryData(ignoresCache: true)
-            if profileQueries.count > 0 {
+            if let profileQueries = try? DataBrokerProtectionManager.shared.dataManager.fetchBrokerProfileQueryData(ignoresCache: true),
+               profileQueries.count > 0 {
                 restartBackgroundAgent(loginItemsManager: loginItemsManager)
             } else {
                 featureVisibility.disableAndDeleteForWaitlistUsers()

DuckDuckGo/DBP/DataBrokerProtectionDebugMenu.swift

@@ -204,9 +204,15 @@ final class DataBrokerProtectionDebugMenu: NSMenu {
         os_log("Running queued operations...", log: .dataBrokerProtection)
         let showWebView = sender.representedObject as? Bool ?? false
 
-        DataBrokerProtectionManager.shared.scheduler.runQueuedOperations(showWebView: showWebView) { error in
-            if let error = error {
-                os_log("Queued operations finished,  error: %{public}@", log: .dataBrokerProtection, error.localizedDescription)
+        DataBrokerProtectionManager.shared.scheduler.runQueuedOperations(showWebView: showWebView) { errors in
+            if let errors = errors {
+                if let oneTimeError = errors.oneTimeError {
+                    os_log("Queued operations finished,  error: %{public}@", log: .dataBrokerProtection, oneTimeError.localizedDescription)
+                }
+                if let operationErrors = errors.operationErrors,
+                          operationErrors.count != 0 {
+                    os_log("Queued operations finished, operation errors count: %{public}@", log: .dataBrokerProtection, operationErrors.count)
+                }
             } else {
                 os_log("Queued operations finished", log: .dataBrokerProtection)
             }
@@ -217,9 +223,15 @@ final class DataBrokerProtectionDebugMenu: NSMenu {
         os_log("Running scan operations...", log: .dataBrokerProtection)
         let showWebView = sender.representedObject as? Bool ?? false
 
-        DataBrokerProtectionManager.shared.scheduler.scanAllBrokers(showWebView: showWebView) { error in
-            if let error = error {
-                os_log("Scan operations finished,  error: %{public}@", log: .dataBrokerProtection, error.localizedDescription)
+        DataBrokerProtectionManager.shared.scheduler.scanAllBrokers(showWebView: showWebView) { errors in
+            if let errors = errors {
+                if let oneTimeError = errors.oneTimeError {
+                    os_log("scan operations finished,  error: %{public}@", log: .dataBrokerProtection, oneTimeError.localizedDescription)
+                }
+                if let operationErrors = errors.operationErrors,
+                          operationErrors.count != 0 {
+                    os_log("scan operations finished, operation errors count: %{public}@", log: .dataBrokerProtection, operationErrors.count)
+                }
             } else {
                 os_log("Scan operations finished", log: .dataBrokerProtection)
             }
@@ -230,9 +242,15 @@ final class DataBrokerProtectionDebugMenu: NSMenu {
         os_log("Running Optout operations...", log: .dataBrokerProtection)
         let showWebView = sender.representedObject as? Bool ?? false
 
-        DataBrokerProtectionManager.shared.scheduler.optOutAllBrokers(showWebView: showWebView) { error in
-            if let error = error {
-                os_log("Optout operations finished,  error: %{public}@", log: .dataBrokerProtection, error.localizedDescription)
+        DataBrokerProtectionManager.shared.scheduler.optOutAllBrokers(showWebView: showWebView) { errors in
+            if let errors = errors {
+                if let oneTimeError = errors.oneTimeError {
+                    os_log("Optout operations finished,  error: %{public}@", log: .dataBrokerProtection, oneTimeError.localizedDescription)
+                }
+                if let operationErrors = errors.operationErrors,
+                          operationErrors.count != 0 {
+                    os_log("Optout operations finished, operation errors count: %{public}@", log: .dataBrokerProtection, operationErrors.count)
+                }
             } else {
                 os_log("Optout operations finished", log: .dataBrokerProtection)
             }

DuckDuckGo/DBP/DataBrokerProtectionFeatureDisabler.swift

@@ -46,7 +46,11 @@ struct DataBrokerProtectionFeatureDisabler: DataBrokerProtectionFeatureDisabling
 
             scheduler.disableLoginItem()
 
-            dataManager.removeAllData()
+            do {
+                try dataManager.removeAllData()
+            } catch {
+                os_log("DataBrokerProtectionFeatureDisabler error: disableAndDelete, error: %{public}@", log: .error, error.localizedDescription)
+            }
 
             DataBrokerProtectionLoginItemPixels.fire(pixel: .dataBrokerDisableAndDeleteDaily, frequency: .dailyOnly)
             NotificationCenter.default.post(name: .dbpWasDisabled, object: nil)

DuckDuckGo/DBP/DataBrokerProtectionLoginItemScheduler.swift

@@ -55,7 +55,8 @@ extension DataBrokerProtectionLoginItemScheduler: DataBrokerProtectionScheduler
         ipcScheduler.statusPublisher
     }
 
-    func scanAllBrokers(showWebView: Bool, completion: ((Error?) -> Void)?) {
+    func scanAllBrokers(showWebView: Bool,
+                        completion: ((DataBrokerProtectionSchedulerErrorCollection?) -> Void)?) {
         enableLoginItem()
         ipcScheduler.scanAllBrokers(showWebView: showWebView, completion: completion)
     }
@@ -69,15 +70,17 @@ extension DataBrokerProtectionLoginItemScheduler: DataBrokerProtectionScheduler
         ipcScheduler.stopScheduler()
     }
 
-    func optOutAllBrokers(showWebView: Bool, completion: ((Error?) -> Void)?) {
+    func optOutAllBrokers(showWebView: Bool,
+                          completion: ((DataBrokerProtectionSchedulerErrorCollection?) -> Void)?) {
         ipcScheduler.optOutAllBrokers(showWebView: showWebView, completion: completion)
     }
 
     func runAllOperations(showWebView: Bool) {
         ipcScheduler.runAllOperations(showWebView: showWebView)
     }
 
-    func runQueuedOperations(showWebView: Bool, completion: ((Error?) -> Void)?) {
+    func runQueuedOperations(showWebView: Bool,
+                             completion: ((DataBrokerProtectionSchedulerErrorCollection?) -> Void)?) {
         ipcScheduler.runQueuedOperations(showWebView: showWebView, completion: completion)
     }
 }

DuckDuckGo/DBP/DataBrokerProtectionManager.swift

@@ -36,7 +36,7 @@ public final class DataBrokerProtectionManager {
     private let dataBrokerProtectionWaitlistDataSource: WaitlistActivationDateStore = DefaultWaitlistActivationDateStore(source: .dbp)
 
     lazy var dataManager: DataBrokerProtectionDataManager = {
-        let dataManager = DataBrokerProtectionDataManager(fakeBrokerFlag: fakeBrokerFlag)
+        let dataManager = DataBrokerProtectionDataManager(pixelHandler: pixelHandler, fakeBrokerFlag: fakeBrokerFlag)
         dataManager.delegate = self
         return dataManager
     }()

DuckDuckGoDBPBackgroundAgent/DataBrokerProtectionBackgroundManager.swift

@@ -36,7 +36,7 @@ public final class DataBrokerProtectionBackgroundManager {
     private lazy var ipcServiceManager = IPCServiceManager(scheduler: scheduler, pixelHandler: pixelHandler)
 
     lazy var dataManager: DataBrokerProtectionDataManager = {
-        DataBrokerProtectionDataManager(fakeBrokerFlag: fakeBrokerFlag)
+        DataBrokerProtectionDataManager(pixelHandler: pixelHandler, fakeBrokerFlag: fakeBrokerFlag)
     }()
 
     lazy var scheduler: DataBrokerProtectionScheduler = {
@@ -78,19 +78,36 @@ public final class DataBrokerProtectionBackgroundManager {
     public func runOperationsAndStartSchedulerIfPossible() {
         pixelHandler.fire(.backgroundAgentRunOperationsAndStartSchedulerIfPossible)
 
-        // If there's no saved profile we don't need to start the scheduler
-        if dataManager.fetchProfile() != nil {
-            scheduler.runQueuedOperations(showWebView: false) { [weak self] error in
-                guard error == nil else {
-                    // Ideally we'd fire a pixel here, however at the moment the scheduler never ever returns an error
-                    return
-                }
+        do {
+            // If there's no saved profile we don't need to start the scheduler
+            guard (try dataManager.fetchProfile()) != nil else {
+                pixelHandler.fire(.backgroundAgentRunOperationsAndStartSchedulerIfPossibleNoSavedProfile)
+                return
+            }
+        } catch {
+            pixelHandler.fire(.generalError(error: error,
+                                            functionOccurredIn: "DataBrokerProtectionBackgroundManager.runOperationsAndStartSchedulerIfPossible"))
+            return
+        }
 
-                self?.pixelHandler.fire(.backgroundAgentRunOperationsAndStartSchedulerIfPossibleRunQueuedOperationsCallbackStartScheduler)
-                self?.scheduler.startScheduler()
+        scheduler.runQueuedOperations(showWebView: false) { [weak self] errors in
+            if let errors = errors {
+                if let oneTimeError = errors.oneTimeError {
+                    os_log("Error during BackgroundManager runOperationsAndStartSchedulerIfPossible in scheduler.runQueuedOperations(), error: %{public}@",
+                           log: .dataBrokerProtection,
+                           oneTimeError.localizedDescription)
+                    self?.pixelHandler.fire(.generalError(error: oneTimeError,
+                                                          functionOccurredIn: "DataBrokerProtectionBackgroundManager.runOperationsAndStartSchedulerIfPossible"))
+                }
+                if let operationErrors = errors.operationErrors,
+                          operationErrors.count != 0 {
+                    os_log("Operation error(s) during  BackgroundManager runOperationsAndStartSchedulerIfPossible in scheduler.runQueuedOperations(), count: %{public}d", log: .dataBrokerProtection, operationErrors.count)
+                }
+                return
             }
-        } else {
-            pixelHandler.fire(.backgroundAgentRunOperationsAndStartSchedulerIfPossibleNoSavedProfile)
+
+            self?.pixelHandler.fire(.backgroundAgentRunOperationsAndStartSchedulerIfPossibleRunQueuedOperationsCallbackStartScheduler)
+            self?.scheduler.startScheduler()
         }
     }
 }

DuckDuckGoDBPBackgroundAgent/IPCServiceManager.swift

@@ -77,27 +77,30 @@ extension IPCServiceManager: IPCServerInterface {
         scheduler.stopScheduler()
     }
 
-    func optOutAllBrokers(showWebView: Bool, completion: @escaping ((Error?) -> Void)) {
+    func optOutAllBrokers(showWebView: Bool,
+                          completion: @escaping ((DataBrokerProtectionSchedulerErrorCollection?) -> Void)) {
         pixelHandler.fire(.ipcServerOptOutAllBrokers)
-        scheduler.optOutAllBrokers(showWebView: showWebView) { error in
-            self.pixelHandler.fire(.ipcServerOptOutAllBrokersCompletion(error: error))
-            completion(error)
+        scheduler.optOutAllBrokers(showWebView: showWebView) { errors in
+            self.pixelHandler.fire(.ipcServerOptOutAllBrokersCompletion(error: errors?.oneTimeError))
+            completion(errors)
         }
     }
 
-    func scanAllBrokers(showWebView: Bool, completion: @escaping ((Error?) -> Void)) {
+    func scanAllBrokers(showWebView: Bool,
+                        completion: @escaping ((DataBrokerProtectionSchedulerErrorCollection?) -> Void)) {
         pixelHandler.fire(.ipcServerScanAllBrokers)
-        scheduler.scanAllBrokers(showWebView: showWebView) { error in
-            self.pixelHandler.fire(.ipcServerScanAllBrokersCompletion(error: error))
-            completion(error)
+        scheduler.scanAllBrokers(showWebView: showWebView) { errors in
+            self.pixelHandler.fire(.ipcServerScanAllBrokersCompletion(error: errors?.oneTimeError))
+            completion(errors)
         }
     }
 
-    func runQueuedOperations(showWebView: Bool, completion: @escaping ((Error?) -> Void)) {
+    func runQueuedOperations(showWebView: Bool,
+                             completion: @escaping ((DataBrokerProtectionSchedulerErrorCollection?) -> Void)) {
         pixelHandler.fire(.ipcServerRunQueuedOperations)
-        scheduler.runQueuedOperations(showWebView: showWebView) { error in
-            self.pixelHandler.fire(.ipcServerRunQueuedOperationsCompletion(error: error))
-            completion(error)
+        scheduler.runQueuedOperations(showWebView: showWebView) { errors in
+            self.pixelHandler.fire(.ipcServerRunQueuedOperationsCompletion(error: errors?.oneTimeError))
+            completion(errors)
         }
     }
 

LocalPackages/DataBrokerProtection/Sources/DataBrokerProtection/CCF/DataBrokerProtectionErrors.swift

@@ -38,6 +38,7 @@ public enum DataBrokerProtectionError: Error, Equatable, Codable {
     case solvingCaptchaWithCallbackError
     case cantCalculatePreferredRunDate
     case httpError(code: Int)
+    case dataNotInDatabase
 
     static func parse(params: Any) -> DataBrokerProtectionError {
         let errorDataResult = try? JSONSerialization.data(withJSONObject: params)
@@ -88,6 +89,8 @@ extension DataBrokerProtectionError {
             return "cantCalculatePreferredRunDate"
         case .httpError:
             return "httpError"
+        case .dataNotInDatabase:
+            return "dataNotInDatabase"
         }
     }
 }