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

[#1334] WIP / Proposal Allow SDKSynchronizer to user arbitrary checkp… #1335

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

pacu
Copy link
Contributor

@pacu pacu commented Jan 5, 2024

…oints instead of bundled ones

This is a draft PR intended to show the implementation I'd like to propose. It does not compile for many reasons, like visibility of checkpoint

would eventually close #1334

Note
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 your own code in GitHub's web interface1
  • Add automated tests as appropriate
  • Update the manual tests2 as appropriate
  • Check the code coverage3 report for the automated tests
  • Update documentation as appropriate (e.g README.md, Architecture.md, etc.)
  • Run the demo app and try the changes
  • Pull in the latest changes from the main branch and squash your commits before assigning a reviewer4

Reviewer

  • Check the code with the Code Review Guidelines checklist
  • Perform an ad hoc review5
  • Review the automated tests
  • Review the manual tests
  • Review the documentation, README.md, Architecture.md, etc. as appropriate
  • Run the demo app and try the changes6

Footnotes

  1. Code often looks different when reviewing the diff in a browser, making it easier to spot potential bugs.

  2. While we aim for automated testing of the SDK, some aspects require manual testing. If you had to manually test
    something during development of this pull request, write those steps down.

  3. While we are not looking for perfect coverage, the tool can point out potential cases that have been missed. Code coverage can be generated with: ./gradlew check for Kotlin modules and ./gradlew connectedCheck -PIS_ANDROID_INSTRUMENTATION_TEST_COVERAGE_ENABLED=true for Android modules.

  4. 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.

  5. 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.

  6. While the CI server runs the demo app to look for build failures or crashes, humans running the demo app are
    more likely to notice unexpected log messages, UI inconsistencies, or bad output data. Perform this step last, after verifying the code changes are safe to run locally.

…user arbitrary checkpoints instead of bundled ones

This is a draft PR intended to show the implementation I'd like to
propose. It does not compile for many reasons, like visibility of
checkpoint

would eventually close Electric-Coin-Company#1334
@pacu pacu marked this pull request as draft January 5, 2024 00:36
@pacu
Copy link
Contributor Author

pacu commented Jan 5, 2024

I'm having a weird message on Android Studio.

Settings file '...../zcash-android-wallet-sdk/build-conventions/settings.gradle.kts' line: 11

An exception occurred applying plugin request [id: 'org.gradle.toolchains.foojay-resolver-convention', version: '0.5.0']
> Failed to apply plugin class 'org.gradle.toolchains.foojay.FoojayToolchainsPlugin'.
   > FoojayToolchainsPlugin needs Gradle version 7.6 or higher

@HonzaR
Copy link
Collaborator

HonzaR commented Jan 8, 2024

I'm having a weird message on Android Studio.

Hi Pacu, Thank you for the proposed changes. I'll proceed to review it soon.

Until then, what is blocking you while building the SDK in the Android Studio does not happen to me, although it seems like a problem with the dependency locking mechanism. Let's try to turn it off. From our documentation:

Note that some versions of Android Studio on Intel machines have trouble with dependency locks. If you experience this issue, the workaround is to add the following line to `~/.gradle/gradle.properties` `ZCASH_IS_DEPENDENCY_LOCKING_ENABLED=false`

Another thing I'd try is to switch to an alternative version of the Android Studio. I use the Preview Beta one. But building the SDK also works for me from the stable one.

@pacu
Copy link
Contributor Author

pacu commented Jan 9, 2024

Thanks @HonzaR I'll try that out and report back!

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.

Allow SDKSynchronizer to user arbitrary checkpoints instead of bundled ones
2 participants