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

Remove @CriticalNative usage #1592

Merged
merged 3 commits into from
Sep 16, 2024
Merged

Remove @CriticalNative usage #1592

merged 3 commits into from
Sep 16, 2024

Conversation

str4d
Copy link
Contributor

@str4d str4d commented Sep 16, 2024

This was added to the TorClient.dispose() JNI pathway because that native coded did not require access to JNIEnv or JClass. However, it turns out that this annotation was only added in Android 8 for system usage 0, and was not CTS-tested public API until Android 14. For whatever reason, in API 27 (Android 8.1) the native method symbol can't be found, but in API 28 and above it can be.

The performance cost of regular JNI is no longer necessary to worry about given that we now keep a TorClient around long-term as part of SdkSynchronizer, so instead of doing anything complex to preserve it on API 28+ we just remove the @CriticalNative annotation and adjust the native method's signature to take (and ignore) the extra arguments.

Closes #1587.

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.

str4d and others added 2 commits September 16, 2024 14:47
This was added to the `TorClient.dispose()` JNI pathway because that
native coded did not require access to `JNIEnv` or `JClass`. However,
it turns out that this annotation was only added in Android 8 for
system usage [0], and was not CTS-tested public API until Android 14.
For whatever reason, in API 27 (Android 8.1) the native method symbol
can't be found, but in API 28 and above it can be.

The performance cost of regular JNI is no longer necessary to worry
about given that we now keep a `TorClient` around long-term as part of
`SdkSynchronizer`, so instead of doing anything complex to preserve it
on API 28+ we just remove the `@CriticalNative` annotation and adjust
the native method's signature to take (and ignore) the extra arguments.

Closes #1587.

[0]: https://developer.android.com/reference/dalvik/annotation/optimization/CriticalNative
@HonzaR HonzaR merged commit a6ed7e1 into main Sep 16, 2024
11 of 12 checks passed
@HonzaR HonzaR deleted the 1587-fix-tor-crash branch September 16, 2024 15:01
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.

Crash: Tor together with testing server responses
2 participants