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.

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

Migrate to first pre-release of FFI 0.9.0 #1446

Merged
merged 9 commits into from
Aug 14, 2024

Conversation

str4d
Copy link
Collaborator

@str4d str4d commented Jun 6, 2024

Includes:

  • Initialization changes to enable log filter customization. We now connect the Rust log level to the Swift log level, and always run other Rust initialization steps.
  • ZIP 320 support (TEX addresses).
  • Fetching the ZEC-USD exchange rate over Tor.

Depends on Electric-Coin-Company/zcash-light-client-ffi#142.

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.

@@ -56,6 +56,7 @@ actor CompactBlockProcessor {
let saplingParamsSourceURL: SaplingParamsSourceURL
let fsBlockCacheRoot: URL
let dataDb: URL
let torDir: URL
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I feel like there are now too many of these; I originally was passing this through to ZcashRustBackend, but now have a separate TorClient that only the SDKSynchronizer needs to know about. But I didn't have time to figure out which of these could be reverted.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Agreed but not high-prio to deal with it right now I believe. We can file a followup ticket to maybe pass a URLConfiguration or something like that.

@@ -823,33 +847,33 @@ struct ZcashRustBackend: ZcashRustBackendWelding {
}

private extension ZcashRustBackend {
static func enableTracing() {
zcashlc_init_on_load(false)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The old code here was treating the enableTracing argument to ZcashRustBackend as enabling Rust logging, rather than enabling trace-level logging. The changes I've made so far in this PR have preserved that, but only because OSLogger.LogLevel has no trace level.

@str4d str4d force-pushed the rust-logging-and-exchange-rates branch from ea54bf1 to fca9729 Compare June 6, 2024 02:35
Copy link
Collaborator

@LukasKorba LukasKorba left a comment

Choose a reason for hiding this comment

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

Just a few non-blocking comments from me.

@str4d str4d force-pushed the rust-logging-and-exchange-rates branch from fca9729 to 929f198 Compare June 19, 2024 15:30
@str4d
Copy link
Collaborator Author

str4d commented Jun 19, 2024

Force-pushed to address comments, and replace Float64 with NSDecimalNumber.

str4d added 2 commits July 30, 2024 11:01
Includes:
- Initialization changes to enable log filter customization. We now
  connect the Rust log level to the Swift log level, and always run
  other Rust initialization steps.
- ZIP 320 support (TEX addresses).
@str4d str4d force-pushed the rust-logging-and-exchange-rates branch from 929f198 to bce8085 Compare July 30, 2024 10:07
@str4d
Copy link
Collaborator Author

str4d commented Jul 30, 2024

Rebased on latest integration branch state and pulled in latest -ffi preview state.

LukasKorba and others added 7 commits August 1, 2024 13:28
- API refactored to Combine's CurrentValueSubject

refresh-rate

- FiatCurrencyResult is now Equatable

refresh-rates

- cleanup

refresh-rates

- The API has been refactored to follow the same principles as for state and events.
- Review comments addressed

refresh-rates

- The API has been extended to send a result of the operation, success or failure

refresh-rates

- bugfix of the try vs try?

refresh-rates

- reverted the error state

Update CHANGELOG.md

- changelog updated
Co-authored-by: Jack Grigg <[email protected]>
- The API has been refactored to carry state and always broadcast a value, even in case of failed request

always-return-value

- ignore refresh request when one is already in flight

always-return-value

- ensure tor client is initialized

always-return-value

- don't pass nil value

always-return-value

- final touch, the tor initialization is sligthly more controlled and error potentially propagated.
- comments addressed
Copy link
Collaborator Author

@str4d str4d left a comment

Choose a reason for hiding this comment

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

PR state as of 343630e looks good to merge into the feature branch.

Comment on lines +20 to +21
// Compiled from 2516a94f8bdc540d951c38b66e9c07e2b8c29cb4
.package(url: "https://github.com/zcash-hackworks/zcash-light-client-ffi", revision: "4de1b42f99aebfc5e4f0340da8a66a4f719db9a6")
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've confirmed that the "compiled from" commit is present in Electric-Coin-Company/zcash-light-client-ffi#143, and the current target is the tip commit of https://github.com/Electric-Coin-Company/zcash-light-client-ffi/tree/ffi-preview-0.9.0 (which will be deleted once we're ready to release FFI 0.9.0, but will preserve the individual target commits within the feature branch for now).

@str4d str4d merged commit a3e15f0 into ffi-0.9.0-integration Aug 14, 2024
1 of 2 checks passed
@str4d str4d deleted the rust-logging-and-exchange-rates branch August 14, 2024 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants