Merge pull request #1180 from novasamatech/develop

8.4.0 Governance Improvements
novasamatech · Aug 6, 2024 · 8debb84 · 8debb84
2 parents 6a990ff + b230a3b
commit 8debb84
Show file tree

Hide file tree

Showing 168 changed files with 4,289 additions and 1,092 deletions.
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -1,3 +1,5 @@
+disabled_rules:
+   - switch_case_alignment
 excluded:
   - Pods
   - PrivatePods

diff --git a/NovaPushNotificationServiceExtension/Handlers/Governance/NewReferendumHandler.swift b/NovaPushNotificationServiceExtension/Handlers/Governance/NewReferendumHandler.swift
@@ -22,7 +22,7 @@ final class NewReferendumHandler: CommonHandler, PushNotificationHandler {
 
     func handle(
         callbackQueue: DispatchQueue?,
-        completion: @escaping (NotificationContentResult?) -> Void
+        completion: @escaping (PushNotificationHandleResult) -> Void
     ) {
         let chainOperation = chainsRepository.fetchAllOperation(with: .init())
 
@@ -32,19 +32,19 @@ final class NewReferendumHandler: CommonHandler, PushNotificationHandler {
             backingCallIn: callStore,
             runningCallbackIn: callbackQueue
         ) { [weak self] result in
-            guard let self = self else {
+            guard let self else {
                 return
             }
+
             switch result {
             case let .success(chains):
                 guard
-                    let chain = self.search(
-                        chainId: self.chainId,
+                    let chain = search(
+                        chainId: chainId,
                         in: chains
-                    ),
-                    chain.syncMode.enabled()
+                    )
                 else {
-                    completion(nil)
+                    completion(.original(.chainNotFound(chainId: chainId)))
                     return
                 }
 
@@ -57,9 +57,14 @@ final class NewReferendumHandler: CommonHandler, PushNotificationHandler {
                     self.payload.referendumNumber,
                     preferredLanguages: self.locale.rLanguages
                 )
-                completion(.init(title: title, subtitle: subtitle))
-            case .failure:
-                completion(nil)
+
+                let notificationContentResult: NotificationContentResult = .init(
+                    title: title,
+                    subtitle: subtitle
+                )
+                completion(.modified(notificationContentResult))
+            case let .failure(error):
+                completion(.original(.internalError(error: error)))
             }
         }
     }

diff --git a/NovaPushNotificationServiceExtension/Handlers/Governance/ReferendumUpdatesHandler.swift b/NovaPushNotificationServiceExtension/Handlers/Governance/ReferendumUpdatesHandler.swift
@@ -21,7 +21,7 @@ final class ReferendumUpdatesHandler: CommonHandler, PushNotificationHandler {
 
     func handle(
         callbackQueue: DispatchQueue?,
-        completion: @escaping (NotificationContentResult?) -> Void
+        completion: @escaping (PushNotificationHandleResult) -> Void
     ) {
         let chainOperation = chainsRepository.fetchAllOperation(with: .init())
 
@@ -30,23 +30,20 @@ final class ReferendumUpdatesHandler: CommonHandler, PushNotificationHandler {
             inOperationQueue: operationQueue,
             runningCallbackIn: callbackQueue
         ) { [weak self] result in
-            guard let self = self else {
+            guard let self else {
                 return
             }
             switch result {
             case let .success(chains):
-                guard
-                    let chain = self.search(chainId: self.chainId, in: chains),
-                    chain.syncMode.enabled()
-                else {
-                    completion(nil)
+                guard let chain = search(chainId: chainId, in: chains) else {
+                    completion(.original(.chainNotFound(chainId: chainId)))
                     return
                 }
 
                 let content = self.content(from: chain)
-                completion(content)
-            case .failure:
-                completion(nil)
+                completion(.modified(content))
+            case let .failure(error):
+                completion(.original(.internalError(error: error)))
             }
         }
     }

diff --git a/NovaPushNotificationServiceExtension/Handlers/PushNotificationHandlersFactory.swift b/NovaPushNotificationServiceExtension/Handlers/PushNotificationHandlersFactory.swift
@@ -1,10 +1,15 @@
 import Foundation
 import SoraFoundation
 
+enum PushNotificationHandleResult {
+    case modified(NotificationContentResult)
+    case original(PushNotificationsHandlerErrors)
+}
+
 protocol PushNotificationHandler {
     func handle(
         callbackQueue: DispatchQueue?,
-        completion: @escaping (NotificationContentResult?) -> Void
+        completion: @escaping (PushNotificationHandleResult) -> Void
     )
 }
 
@@ -52,3 +57,49 @@ final class PushNotificationHandlersFactory: PushNotificationHandlersFactoryProt
         }
     }
 }
+
+// MARK: Errors
+
+enum PushNotificationsHandlerErrors: Error, Hashable {
+    static func == (
+        lhs: PushNotificationsHandlerErrors,
+        rhs: PushNotificationsHandlerErrors
+    ) -> Bool {
+        switch (lhs, rhs) {
+        case (.chainDisabled, .chainDisabled):
+            return true
+        case let (.chainNotFound(lhsChainId), .chainNotFound(rhsChainId)):
+            return lhsChainId == rhsChainId
+        case let (.assetNotFound(lhsAssetId), .assetNotFound(rhsAssetId)):
+            return lhsAssetId == rhsAssetId
+        case let (.internalError(lhsError), .internalError(rhsError)):
+            return lhsError.localizedDescription == rhsError.localizedDescription
+        default:
+            return false
+        }
+    }
+
+    func hash(into hasher: inout Hasher) {
+        switch self {
+        case .chainDisabled:
+            hasher.combine(0)
+        case let .chainNotFound(chainId):
+            hasher.combine(1)
+            hasher.combine(chainId)
+        case let .assetNotFound(assetId):
+            hasher.combine(2)
+            hasher.combine(assetId)
+        case let .internalError(error):
+            hasher.combine(3)
+            hasher.combine(error.localizedDescription)
+        case .undefined:
+            hasher.combine(4)
+        }
+    }
+
+    case chainDisabled
+    case chainNotFound(chainId: ChainModel.Id)
+    case assetNotFound(assetId: String?)
+    case internalError(error: Error)
+    case undefined
+}
diff --git a/NovaPushNotificationServiceExtension/Handlers/Staking/StakingRewardsHandler.swift b/NovaPushNotificationServiceExtension/Handlers/Staking/StakingRewardsHandler.swift
@@ -22,28 +22,35 @@ final class StakingRewardsHandler: CommonHandler, PushNotificationHandler {
 
     func handle(
         callbackQueue: DispatchQueue?,
-        completion: @escaping (NotificationContentResult?) -> Void
+        completion: @escaping (PushNotificationHandleResult) -> Void
     ) {
         let settingsOperation = settingsRepository.fetchAllOperation(with: .init())
         let chainOperation = chainsRepository.fetchAllOperation(with: .init())
 
-        let contentWrapper: CompoundOperationWrapper<NotificationContentResult?> =
-            OperationCombiningService.compoundWrapper(
-                operationManager: OperationManager(operationQueue: operationQueue)) {
+        let contentWrapper: CompoundOperationWrapper<NotificationContentResult> =
+            OperationCombiningService.compoundNonOptionalWrapper(
+                operationManager: OperationManager(operationQueue: operationQueue)
+            ) { [weak self] in
+                guard let self else {
+                    throw PushNotificationsHandlerErrors.undefined
+                }
+
                 let settings = try settingsOperation.extractNoCancellableResultData().first
                 let chains = try chainOperation.extractNoCancellableResultData()
-                guard
-                    let chain = self.search(chainId: self.chainId, in: chains),
-                    chain.syncMode.enabled(),
-                    let asset = chain.utilityAsset()
-                else {
-                    return nil
+
+                guard let chain = self.search(chainId: chainId, in: chains) else {
+                    throw PushNotificationsHandlerErrors.chainNotFound(chainId: chainId)
+                }
+
+                guard let asset = chain.utilityAsset() else {
+                    throw PushNotificationsHandlerErrors.assetNotFound(assetId: chainId)
                 }
 
                 let priceOperation: BaseOperation<[PriceData]>
-                if let priceId = asset.priceId,
-                   let currency = self.currencyManager(operationQueue: self.operationQueue)?.selectedCurrency {
-                    priceOperation = self.priceRepository(for: priceId, currencyId: currency.id).fetchAllOperation(with: .init())
+                if
+                    let priceId = asset.priceId,
+                    let currency = currencyManager(operationQueue: self.operationQueue)?.selectedCurrency {
+                    priceOperation = priceRepository(for: priceId, currencyId: currency.id).fetchAllOperation(with: .init())
                 } else {
                     priceOperation = .createWithResult([])
                 }
@@ -53,6 +60,7 @@ final class StakingRewardsHandler: CommonHandler, PushNotificationHandler {
                 let mapOperaion = ClosureOperation {
                     let price = try priceOperation.extractNoCancellableResultData().first
                     let metaAccounts = try fetchMetaAccountsOperation.extractNoCancellableResultData()
+
                     return self.updatingContent(
                         wallets: settings?.wallets ?? [],
                         metaAccounts: metaAccounts,
@@ -79,9 +87,11 @@ final class StakingRewardsHandler: CommonHandler, PushNotificationHandler {
         ) { result in
             switch result {
             case let .success(content):
-                completion(content)
-            case .failure:
-                completion(nil)
+                completion(.modified(content))
+            case let .failure(error as PushNotificationsHandlerErrors):
+                completion(.original(error))
+            case let .failure(error):
+                completion(.original(.internalError(error: error)))
             }
         }
     }

diff --git a/NovaPushNotificationServiceExtension/Handlers/Technical/NewReleaseHandler.swift b/NovaPushNotificationServiceExtension/Handlers/Technical/NewReleaseHandler.swift
@@ -21,7 +21,7 @@ final class NewReleaseHandler: PushNotificationHandler {
 
     func handle(
         callbackQueue: DispatchQueue?,
-        completion: @escaping (NotificationContentResult?) -> Void
+        completion: @escaping (PushNotificationHandleResult) -> Void
     ) {
         dispatchInQueueWhenPossible(callbackQueue) {
             let locale = self.localizationManager.selectedLocale
@@ -31,7 +31,12 @@ final class NewReleaseHandler: PushNotificationHandler {
                 preferredLanguages: locale.rLanguages
             )
 
-            completion(.init(title: title, subtitle: subtitle))
+            let notificationConentResult: NotificationContentResult = .init(
+                title: title,
+                subtitle: subtitle
+            )
+
+            completion(.modified(notificationConentResult))
         }
     }
 }
diff --git a/NovaPushNotificationServiceExtension/Handlers/Transfers/TransferHandler.swift b/NovaPushNotificationServiceExtension/Handlers/Transfers/TransferHandler.swift
@@ -25,34 +25,40 @@ final class TransferHandler: CommonHandler, PushNotificationHandler {
 
     func handle(
         callbackQueue: DispatchQueue?,
-        completion: @escaping (NotificationContentResult?) -> Void
+        completion: @escaping (PushNotificationHandleResult) -> Void
     ) {
         let settingsOperation = settingsRepository.fetchAllOperation(with: .init())
         let chainOperation = chainsRepository.fetchAllOperation(with: .init())
 
-        let contentWrapper: CompoundOperationWrapper<NotificationContentResult?> =
-            OperationCombiningService.compoundWrapper(
-                operationManager: OperationManager(operationQueue: operationQueue)) {
+        let contentWrapper: CompoundOperationWrapper<NotificationContentResult> =
+            OperationCombiningService.compoundNonOptionalWrapper(
+                operationManager: OperationManager(operationQueue: operationQueue)
+            ) { [weak self] in
+                guard let self else {
+                    return .createWithError(PushNotificationsHandlerErrors.undefined)
+                }
+
                 let settings = try settingsOperation.extractNoCancellableResultData().first
                 let chains = try chainOperation.extractNoCancellableResultData()
-                guard
-                    let chain = self.search(chainId: self.chainId, in: chains),
-                    chain.syncMode.enabled(),
-                    let asset = self.mapHistoryAssetId(self.payload.assetId, chain: chain)
-                else {
-                    return nil
+
+                guard let chain = search(chainId: chainId, in: chains) else {
+                    throw PushNotificationsHandlerErrors.chainNotFound(chainId: chainId)
+                }
+
+                guard let asset = mapHistoryAssetId(payload.assetId, chain: chain) else {
+                    throw PushNotificationsHandlerErrors.assetNotFound(assetId: chainId)
                 }
 
                 let priceOperation: BaseOperation<[PriceData]>
                 if let priceId = asset.priceId,
-                   let currency = self.currencyManager(operationQueue: self.operationQueue)?.selectedCurrency {
-                    priceOperation = self.priceRepository(for: priceId, currencyId: currency.id)
+                   let currency = currencyManager(operationQueue: operationQueue)?.selectedCurrency {
+                    priceOperation = priceRepository(for: priceId, currencyId: currency.id)
                         .fetchAllOperation(with: .init())
                 } else {
                     priceOperation = .createWithResult([])
                 }
                 priceOperation.addDependency(chainOperation)
-                let fetchMetaAccountsOperation = self.walletsRepository().fetchAllOperation(with: .init())
+                let fetchMetaAccountsOperation = walletsRepository().fetchAllOperation(with: .init())
 
                 let mapOperaion = ClosureOperation {
                     let price = try priceOperation.extractNoCancellableResultData().first
@@ -83,9 +89,11 @@ final class TransferHandler: CommonHandler, PushNotificationHandler {
         ) { result in
             switch result {
             case let .success(content):
-                completion(content)
-            case .failure:
-                completion(nil)
+                completion(.modified(content))
+            case let .failure(error as PushNotificationsHandlerErrors):
+                completion(.original(error))
+            case let .failure(error):
+                completion(.original(.internalError(error: error)))
             }
         }
     }

diff --git a/NovaPushNotificationServiceExtension/NotificationService.swift b/NovaPushNotificationServiceExtension/NotificationService.swift
@@ -8,6 +8,7 @@ final class NotificationService: UNNotificationServiceExtension {
     var contentHandler: ((UNNotificationContent) -> Void)?
     var bestAttemptContent: UNMutableNotificationContent?
     var handler: PushNotificationHandler?
+    var logger = Logger.shared
 
     override func didReceive(
         _ request: UNNotificationRequest,
@@ -33,10 +34,13 @@ final class NotificationService: UNNotificationServiceExtension {
         let factory = PushNotificationHandlersFactory()
         handler = factory.createHandler(message: message)
 
-        handler?.handle(callbackQueue: nil) { notification in
-            if let notification = notification {
+        handler?.handle(callbackQueue: nil) { [weak self] handlerResult in
+            switch handlerResult {
+            case let .modified(notification):
                 contentHandler(notification.toUserNotificationContent(with: bestAttemptContent))
-            } else {
+            case let .original(error):
+                self?.logError(error)
+
                 let unsupported = NotificationContentResult.createUnsupportedResult(
                     for: LocalizationManager.shared.selectedLocale
                 )
@@ -51,4 +55,19 @@ final class NotificationService: UNNotificationServiceExtension {
             contentHandler(bestAttemptContent)
         }
     }
+
+    private func logError(_ error: PushNotificationsHandlerErrors) {
+        switch error {
+        case let .assetNotFound(assetId):
+            logger.error("Notification handler failed to find asset with id: \(assetId ?? "")")
+        case let .chainNotFound(chainId):
+            logger.error("Notification handler failed to find asset with id: \(chainId)")
+        case let .internalError(error):
+            logger.error("Notification handler failed with error: \(error.localizedDescription)")
+        case .undefined:
+            logger.error("Notification handler failed with undefined reason")
+        default:
+            break
+        }
+    }
 }