zec
/
ZcashLightClientKit
mirror of https://github.com/zcash/ZcashLightClientKit.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[#1227] Check continuation of UpdateChainTip repeated call 

- My assumption was right, the way State Machine is done requires .celarCache to be called with every "restart"
- I was able to reproduce errors when clearCache wasn't called so the updateChainTipAction needed to be updated to prepare clean conditions for the scan suggest ranges
- tests updated
This commit is contained in:
Lukas Korba 2023-09-04 10:38:10 +02:00
parent eca88735b4
commit 66c7c84f6f
2 changed files with 30 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Sources/ZcashLightClientKit/Block/Actions/UpdateChainTipAction.swift
View File

@ -9,11 +9,13 @@ import Foundation
final class UpdateChainTipAction {
let rustBackend: ZcashRustBackendWelding
let downloader: BlockDownloader
let service: LightWalletService
let logger: Logger
init(container: DIContainer) {
service = container.resolve(LightWalletService.self)
downloader = container.resolve(BlockDownloader.self)
rustBackend = container.resolve(ZcashRustBackendWelding.self)
logger = container.resolve(Logger.self)
}
@ -36,8 +38,9 @@ extension UpdateChainTipAction: Action {
// Update chain tip can be called from different contexts
if await context.prevState == .updateSubtreeRoots || now - lastChainTipUpdateTime > 600 {
await downloader.stopDownload()
try await updateChainTip(context, time: now)
await context.update(state: .processSuggestedScanRanges)
await context.update(state: .clearCache)
} else if await context.prevState == .enhance {
await context.update(state: .download)
}

38
Tests/OfflineTests/CompactBlockProcessorActions/UpdateChainTipActionTests.swift
View File

@ -26,10 +26,12 @@ final class UpdateChainTipActionTests: ZcashTestCase {
func testUpdateChainTipAction_UpdateChainTipTimeTriggered() async throws {
let loggerMock = LoggerMock()
loggerMock.infoFileFunctionLineClosure = { _, _, _, _ in }
let blockDownloaderMock = BlockDownloaderMock()
let updateChainTipAction = await setupAction(loggerMock)
loggerMock.infoFileFunctionLineClosure = { _, _, _, _ in }
blockDownloaderMock.stopDownloadClosure = { }
let updateChainTipAction = await setupAction(loggerMock, blockDownloaderMock)
do {
let context = ActionContextMock.default()
@ -39,7 +41,9 @@ final class UpdateChainTipActionTests: ZcashTestCase {
let nextContext = try await updateChainTipAction.run(with: context) { _ in }
let acResult = nextContext.checkStateIs(.processSuggestedScanRanges)
XCTAssertTrue(blockDownloaderMock.stopDownloadCallsCount == 1, "downloader.stopDownload() is expected to be called exactly once.")
let acResult = nextContext.checkStateIs(.clearCache)
XCTAssertTrue(acResult == .true, "Check of state failed with '\(acResult)'")
} catch {
XCTFail("testUpdateChainTipAction_UpdateChainTipTimeTriggered is not expected to fail. \(error)")
@ -48,10 +52,12 @@ final class UpdateChainTipActionTests: ZcashTestCase {
func testUpdateChainTipAction_UpdateChainTipPrevActionTriggered() async throws {
let loggerMock = LoggerMock()
loggerMock.infoFileFunctionLineClosure = { _, _, _, _ in }
let blockDownloaderMock = BlockDownloaderMock()
let updateChainTipAction = await setupAction(loggerMock)
loggerMock.infoFileFunctionLineClosure = { _, _, _, _ in }
blockDownloaderMock.stopDownloadClosure = { }
let updateChainTipAction = await setupAction(loggerMock, blockDownloaderMock)
do {
let context = ActionContextMock.default()
@ -61,7 +67,9 @@ final class UpdateChainTipActionTests: ZcashTestCase {
let nextContext = try await updateChainTipAction.run(with: context) { _ in }
let acResult = nextContext.checkStateIs(.processSuggestedScanRanges)
XCTAssertTrue(blockDownloaderMock.stopDownloadCallsCount == 1, "downloader.stopDownload() is expected to be called exactly once.")
let acResult = nextContext.checkStateIs(.clearCache)
XCTAssertTrue(acResult == .true, "Check of state failed with '\(acResult)'")
} catch {
XCTFail("testUpdateChainTipAction_UpdateChainTipPrevActionTriggered is not expected to fail. \(error)")
@ -70,10 +78,12 @@ final class UpdateChainTipActionTests: ZcashTestCase {
func testUpdateChainTipAction_UpdateChainTipSkipped() async throws {
let loggerMock = LoggerMock()
loggerMock.infoFileFunctionLineClosure = { _, _, _, _ in }
let blockDownloaderMock = BlockDownloaderMock()
let updateChainTipAction = await setupAction(loggerMock)
loggerMock.infoFileFunctionLineClosure = { _, _, _, _ in }
blockDownloaderMock.stopDownloadClosure = { }
let updateChainTipAction = await setupAction(loggerMock, blockDownloaderMock)
do {
let context = ActionContextMock.default()
@ -83,6 +93,8 @@ final class UpdateChainTipActionTests: ZcashTestCase {
let nextContext = try await updateChainTipAction.run(with: context) { _ in }
XCTAssertFalse(blockDownloaderMock.stopDownloadCalled, "downloader.stopDownload() is not expected to be called.")
let acResult = nextContext.checkStateIs(.download)
XCTAssertTrue(acResult == .true, "Check of state failed with '\(acResult)'")
} catch {
@ -91,7 +103,8 @@ final class UpdateChainTipActionTests: ZcashTestCase {
}
private func setupAction(
_ loggerMock: LoggerMock = LoggerMock()
_ loggerMock: LoggerMock = LoggerMock(),
_ blockDownloaderMock: BlockDownloaderMock = BlockDownloaderMock()
) async -> UpdateChainTipAction {
let config: CompactBlockProcessor.Configuration = .standard(
for: ZcashNetworkBuilder.network(for: underlyingNetworkType), walletBirthday: 0
@ -119,6 +132,7 @@ final class UpdateChainTipActionTests: ZcashTestCase {
mockContainer.mock(type: ZcashRustBackendWelding.self, isSingleton: true) { _ in rustBackendMock }
mockContainer.mock(type: LightWalletService.self, isSingleton: true) { _ in serviceMock }
mockContainer.mock(type: Logger.self, isSingleton: true) { _ in loggerMock }
mockContainer.mock(type: BlockDownloader.self, isSingleton: true) { _ in blockDownloaderMock }
return UpdateChainTipAction(container: mockContainer)
}