feat: duplicate worklets code the smart way #6827
Merged
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
tjzel
force-pushed
the
@tjzel/worklets/restructure-worklets-source-sets
branch
from
b30c495 to
2634199
Compare
tjzel
force-pushed
the
@tjzel/worklets/duplicate-reanimated-code
branch
from
d723ecc to
62c9488
Compare
…lets-source-sets' into @tjzel/worklets/duplicate-reanimated-code
…@tjzel/worklets/duplicate-reanimated-code
…@tjzel/worklets/duplicate-reanimated-code
tjzel
commented
Jan 28, 2025
...reanimated/android/src/externalWorklets/with/com/swmansion/reanimated/ReanimatedPackage.java
Outdated
Show resolved
Hide resolved
Base automatically changed from
@tjzel/worklets/restructure-worklets-source-sets
to
main
January 28, 2025 11:34
bartlomiejbloniarz
approved these changes
Jan 28, 2025
...nimated/android/src/externalWorklets/without/com/swmansion/reanimated/ReanimatedPackage.java
Outdated
Show resolved
Hide resolved
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 31, 2025
## Summary In this PR I'm moving the `WorkletsModule` part of the JS code to `react-native-worklets`. Reanimated would still have those files duplicated via a mechanism introduced in #6827. Now in Reanimated all worklets code must be acquired via a special `WorkletsResolver` module. This is a temporary solution and will be dropped once we require `react-native-worklets` as a mandatory dependency for `react-native-reanimated`. - Added a workaround so that in our monorepo `react-native-worklets` wouldn't be used in the app even though it's not a dependency. - Added an ESLint rule that enforces imports from `WorkletsResolver`. - I duplicated `PlatformChecker.ts` explicitly in `react-native-worklets`. This file is small and stable so I don't consider this to be an issue. We can think of some better solution once the package is more polished. - Split some types from `commonTypes.ts` between packages. ## Test plan Fabric example should work with & without `react-native-worklets` installed. You can check using the debugger that always the correct instance of Worklets' JavaScript code is used.
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
In the transitional period of
react-native-workletscoming as a separate package, Reanimated should work with or withoutreact-native-workletsinstalled. This requires the code of Worklets to be present both inreact-native-reanimatedandreact-native-worklets.This PR moves Worklets' files that were in Reanimated to
react-native-workletspackage and adds a script that makes hard links to these files. The linking happens during theyarn buildstep ofreact-native-reanimated- this guarantees thatreact-native-reanimatedwould still work withoutreact-native-workletsand that its' npm package would still contain all the necessary files.For Android some files had to be duplicated. This is because of codegen conflicts and namespace generation. However, that code is relatively small and put into respective source sets
externalWorklets/withandexternalWorklets/without.Also:
ReanimatedVersion.cpp/hfiles back to Reanimated. We'll implement version checking for Worklets when we actually need it.yarn buildin Reanimated when necessary.react-native-workletsinreact-native-reanimated.react-native-workletsfor iOS.NativeWorkletsModuleSpec.tstoNativeReaWorkletsModuleSpec.tsto avoid codegen conflicts.DummyWorkletsModulefromreact-native-workletssince now it hasWorkletsModule.Test plan
Run an Example with these changes.
Then do
yarn add react-native-workletsincommon-app(it will use workspace version by default) in the example directory and run it again.