Unify error messages and add Troubleshooting section to docs #4915
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tomekzaw
reviewed
Aug 21, 2023
android/src/main/java/com/swmansion/reanimated/layoutReanimation/AnimationsManager.java
Outdated
Show resolved
Hide resolved
src/reanimated2/layoutReanimation/animationBuilder/BaseAnimationBuilder.ts
Outdated
Show resolved
Hide resolved
tomekzaw
reviewed
Aug 21, 2023
tomekzaw
approved these changes
Aug 22, 2023
piaskowyk
pushed a commit
that referenced
this pull request
Sep 27, 2023
<!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please follow the template so that the reviewers can easily understand what the code changes affect. --> ## Summary This PR is a pinnacle of Reanimated's version detection grand scheme. Since there are numerous errors stemming from having parts of Reanimated used from different version we decided to enforce runtime checks for those parts - to make the troubleshooting process easier. Adding: - C++ checks JavaScript version - C++ checks Java version - Java checks C++ version Requires #4915 ## Test plan 1. C++ checks JavaScript version: Trigger failed resolution: ```diff // src/reanimated2/NativeReanimated/NativeReanimated.ts - global._REANIMATED_VERSION_JS = jsVersion; ``` Trigger wrong version: ```diff // src/reanimated2/NativeReanimated/NativeReanimated.ts - global._REANIMATED_VERSION_JS = jsVersion; + global._REANIMATED_VERSION_JS = 'wrong-version'; ``` 2. C++ checks Java version: Trigger failed resolution: ```diff // android/src/main/java/com/swmansion/reanimated/nativeProxy/NativeProxyCommon.java public String getReanimatedJavaVersion() { - return BuildConfig.REANIMATED_VERSION_JAVA; + throw new RuntimeException("forced fail"); } ``` Trigger wrong version: ```diff // android/src/main/java/com/swmansion/reanimated/nativeProxy/NativeProxyCommon.java public String getReanimatedJavaVersion() { - return BuildConfig.REANIMATED_VERSION_JAVA; + return new String("wrong-version"); } ``` 3. Java checks C++ version: Trigger failed resolution: ```diff // android/src/main/java/com/swmansion/reanimated/nativeProxy/NativeProxyCommon.java protected void setCppVersion(String version) { - cppVersion = version; + // NOOP } ``` Trigger wrong version: ```diff // android/src/main/java/com/swmansion/reanimated/nativeProxy/NativeProxyCommon.java protected void setCppVersion(String version) { - cppVersion = version; + cppVersion = new String("wrong-version"); } ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Since version checker PR #4914 will add more error messages to Reanimated and our Troubleshooting section in docs was almost non-existent I decided to add a new one.
To make it consistent I made all errors thrown by Reanimated start with
[Reanimated]and prettified them a bit.With this I made this tiny script
validate-urls.jsthat scans our source code to get valid (not so exotic) URLs and checks if they are available.Test plan
CI