Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Aug 31, 2023
Merged

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

merged 1 commit into from
Aug 31, 2023

Conversation

LukasKorba
Copy link
Collaborator

@LukasKorba LukasKorba commented Aug 31, 2023 •
edited by HonzaR
Loading

Closes #1179

  • 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
  • unit test for the timeout getSubtreeRoot added

This code review checklist is intended to serve as a starting point for the author and reviewer, although it may not be appropriate for all types of changes (e.g. fixing a spelling typo in documentation). For more in-depth discussion of how we think about code review, please see Code Review Guidelines.

Author

  • Self-review: Did you review your own code in GitHub's web interface? Code often looks different when reviewing the diff in a browser, making it easier to spot potential bugs.
  • Automated tests: Did you add appropriate automated tests for any code changes?
  • Code coverage: Did you check the code coverage report for the automated tests? While we are not looking for perfect coverage, the tool can point out potential cases that have been missed.
  • Documentation: Did you update Docs as appropiate? (E.g README.md, etc.)
  • Run the app: Did you run the app and try the changes?
  • Did you provide Screenshots of what the App looks like before and after your changes as part of the description of this PR? (only applicable to UI Changes)
  • Rebase and squash: Did you pull in the latest changes from the main branch and squash your commits before assigning a reviewer? Having your code up to date and squashed will make it easier for others to review. Use best judgement when squashing commits, as some changes (such as refactoring) might be easier to review as a separate commit.

Reviewer

  • Checklist review: Did you go through the code with the Code Review Guidelines checklist?
  • Ad hoc review: Did you perform an ad hoc review? In addition to a first pass using the code review guidelines, do a second pass using your best judgement and experience which may identify additional questions or comments. Research shows that code review is most effective when done in multiple passes, where reviewers look for different things through each pass.
  • Automated tests: Did you review the automated tests?
  • Manual tests: Did you review the manual tests?You will find manual testing guidelines under our manual testing section
  • How is Code Coverage affected by this PR? We encourage you to compare coverage befor and after your changes and when possible, leave it in a better place. Learn More...
  • Documentation: Did you review Docs, README.md, LICENSE.md, and Architecture.md as appropriate?
  • Run the app: Did you run the app and try the changes? While the CI server runs the app to look for build failures or crashes, humans running the app are more likely to notice unexpected log messages, UI inconsistencies, or bad output data.

@LukasKorba LukasKorba requested a review from HonzaR August 31, 2023 06:46
HonzaR
HonzaR approved these changes Aug 31, 2023
View reviewed changes
Copy link
Collaborator

@HonzaR HonzaR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with a question inline.

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) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the connectivity issue in the iOS world always result in the timeout error?

@LukasKorba
[Electric-Coin-Company#1179] Handle false positive getSubtreeRoots wh…
f1c61f8 
…en 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

[Electric-Coin-Company#1179] Handle false positive getSubtreeRoots when connectivity is down

- unit test for the timeout getSubtreeRoot added

[Electric-Coin-Company#1179] Handle false positive getSubtreeRoots when connectivity is down (Electric-Coin-Company#1222)

- warning fixed
@LukasKorba LukasKorba force-pushed the 1179-Handle-false-positive-getSubtreeRoots-when-connectivity-is-down branch from 5097029 to f1c61f8 Compare August 31, 2023 10:49
@LukasKorba LukasKorba merged commit d880d25 into Electric-Coin-Company:feature/DAG-sync Aug 31, 2023
1 check passed
LukasKorba added a commit to LukasKorba/ZcashLightClientKit that referenced this pull request Sep 7, 2023
@LukasKorba
[Electric-Coin-Company#1179] Handle false positive getSubtreeRoots wh…
aecb07f 
…en 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

[Electric-Coin-Company#1179] Handle false positive getSubtreeRoots when connectivity is down

- unit test for the timeout getSubtreeRoot added

[Electric-Coin-Company#1179] Handle false positive getSubtreeRoots when connectivity is down (Electric-Coin-Company#1222)

- warning fixed
LukasKorba added a commit that referenced this pull request Sep 7, 2023
@LukasKorba
[#1179] Handle false positive getSubtreeRoots when connectivity is down
569741e 
- 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
@LukasKorba LukasKorba deleted the 1179-Handle-false-positive-getSubtreeRoots-when-connectivity-is-down branch October 4, 2023 06:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@HonzaR HonzaR HonzaR approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@LukasKorba @HonzaR