[#1179] Handle false positive getSubtreeRoots when connectivity is down

- when getSubtreeRoots call fails on timeout, the connectivity is not present and the action must be terminated (throw) an error, this way when the connectivity is back, the State Machine starts over and getSubtreeRoots get a chance to properly decide if SBS is supported [#1179] Handle false positive getSubtreeRoots when connectivity is down - unit test for the timeout getSubtreeRoot added [#1179] Handle false positive getSubtreeRoots when connectivity is down (#1222) - warning fixed
Electric-Coin-Company · Aug 31, 2023 · f1c61f8 · f1c61f8
1 parent c49400d
commit f1c61f8
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/Sources/ZcashLightClientKit/Block/Actions/UpdateSubtreeRootsAction.swift b/Sources/ZcashLightClientKit/Block/Actions/UpdateSubtreeRootsAction.swift
@@ -39,6 +39,8 @@ extension UpdateSubtreeRootsAction: Action {
             for try await subtreeRoot in stream {
                 roots.append(subtreeRoot)
             }
+        } catch ZcashError.serviceSubtreeRootsStreamFailed(LightWalletServiceError.timeOut) {
+            throw ZcashError.serviceSubtreeRootsStreamFailed(LightWalletServiceError.timeOut)
         } catch {
             logger.debug("getSubtreeRoots failed with error \(error.localizedDescription)")
             err = error

diff --git a/Tests/OfflineTests/CompactBlockProcessorActions/UpdateSubtreeRootsActionTests.swift b/Tests/OfflineTests/CompactBlockProcessorActions/UpdateSubtreeRootsActionTests.swift
@@ -68,6 +68,36 @@ final class UpdateSubtreeRootsActionTests: ZcashTestCase {
         }
     }
 
+    func testUpdateSubtreeRootsAction_getSubtreeRootsTimeout() async throws {
+        let loggerMock = LoggerMock()
+
+        loggerMock.infoFileFunctionLineClosure = { _, _, _, _ in  }
+
+        let tupple = setupAction(loggerMock)
+        let updateSubtreeRootsActionAction = tupple.action
+        tupple.serviceMock.getSubtreeRootsClosure = { _ in
+            AsyncThrowingStream { continuation in continuation.finish(throwing: ZcashError.serviceSubtreeRootsStreamFailed(LightWalletServiceError.timeOut)) }
+        }
+
+        do {
+            let context = ActionContextMock.default()
+            context.updateSupportedSyncAlgorithmClosure = { _ in }
+
+            _ = try await updateSubtreeRootsActionAction.run(with: context) { _ in }
+            XCTFail("The test is expected to fail but continued.")
+        } catch ZcashError.serviceSubtreeRootsStreamFailed(LightWalletServiceError.timeOut) {
+            // this is expected, the action must be terminated as there is no connectivity
+        } catch {
+            XCTFail(
+                """
+                testUpdateSubtreeRootsAction_getSubtreeRootsTimeout is expected to fail with
+                ZcashError.serviceSubtreeRootsStreamFailed(LightWalletServiceError.timeOut)
+                but received \(error)".
+                """
+            )
+        }
+    }
+
     func testUpdateSubtreeRootsAction_getSubtreeRootsEmpty() async throws {
         let loggerMock = LoggerMock()