Worklets without captured variables are rejected as "Regular javascript function" when transpiled by react-native-worklets' Babel plugin
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 55/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- cpp, javascript, react-native
調査の方向性
Start with cpp/WKTJsiWorklet.h, especially isDecoratedAsWorklet() and createWorklet(), then trace how JsiObjectWrapper::setFunctionValue() handles a function without __closure. Reproduce with the supplied Babel output: a numeric __workletHash, string __initData.code, and no closure. Done when that no-capture worklet is recognized and invoked successfully while existing captured worklets still work.
索引モデルが issue の本文から書いたものです。
説明
Description
When a project uses the Babel plugin from react-native-worklets (the Reanimated 4 worklets package) together with react-native-worklets-core, any 'worklet' function that does not capture any outer variables is not recognized as a worklet by worklets-core.
Calling such a function from inside another worklet that runs on a worklets-core context throws:
Regular javascript function 't' cannot be shared. Try decorating the function with the 'worklet' keyword to allow the javascript function to be used as a worklet.
('t' is just the minified function name in a release bundle.)
We hit this through react-native-filament: EntitySelector's MaterialModifier worklet calls the module-level applyMaterialParameters worklet, which captures nothing, so every model with materialParameters fails on the worklet thread.
Environment
- react-native: 0.88.0 (New Architecture, Hermes)
- react-native-worklets-core: 1.6.3
- react-native-worklets: 0.13.0 (its Babel plugin is active)
- react-native-filament: 1.9.0 (where we first saw it; 1.11.0 has the same code)
- Babel plugins:
plugins: [ ['react-native-worklets-core/plugin', { processNestedWorklets: true }], 'react-native-worklets/plugin', ]
Minimal reproduction
import { Worklets } from 'react-native-worklets-core'
// Captures nothing from the outer scope
const double = (x: number) => {
'worklet'
return x * 2
}
const context = Worklets.createContext('repro')
// The worklet passed to runAsync captures `double`
context
.runAsync(() => {
'worklet'
return double(21) // <- throws "Regular javascript function '...' cannot be shared"
})
.then(console.log)
If double captures any outer variable (so it gets a __closure), the call works.
What the transpiled code looks like
With the react-native-worklets plugin (0.13.0, and the same in the 0.14 nightlies), a worklet that captures nothing is emitted without __closure, and the hash is a number literal:
var double = function double_Factory([_worklet_123_init_data]) {
const double = function (x) { return x * 2 }
double.__workletHash = 123 // number, not string
double.__initData = _worklet_123_init_data // { code: "(function ...)" }
return double // no __closure assignment
}([_worklet_123_init_data])
The plugin only emits __closure when closureVariables.length > 0 (see plugin/index.js), so leaving it out is intended behavior there, not a bug.
Root cause
In cpp/WKTJsiWorklet.h:
isDecoratedAsWorklet()returnstrueright away only when__workletHashis a string. Otherwise it requires__closureto be present, so a numeric hash with no__closureis treated as a regular function.createWorklet()returns early when__closureisundefined/null, so even if detection passed, the worklet would not be created.
JsiObjectWrapper::setFunctionValue() then wraps the function in a host function that throws the "cannot be shared" error when called.
Suggested fix
Treat a function as a worklet when __workletHash is a number and __initData.code is a string, and use an empty closure when __closure is missing. Code generated for a worklet with no captures never reads this.__closure, so an empty array is safe.
I have a small patch for this and can open a PR.
Possibly related
#258 reports release builds failing with "is not a Worklet" when the Reanimated plugin and the worklets-core plugin are used together. It might be the same root cause, but I haven't verified that.
- 主要言語
- C++
- スター
- 791
- フォーク
- 66
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
margelo/react-native-worklets-core のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
margelo/react-native-worklets-core#271 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
margelo/react-native-worklets-core#269 · リアクション 2 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
margelo/react-native-worklets-core#268 · コメント 2 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
margelo/react-native-worklets-core#267 · コメント 1 件 · リアクション 1 件 ·
margelo/react-native-worklets-core の issue をすべて見る
似ている issue
-
(S1 - Need confirmation)
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
CleverRaven/Cataclysm-DDA#89194 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
moonshine-ai/moonshine#231 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
メンテナーはふだん 1 日以内に返信
-
documentation good first issue M7: multi-node no hardware needed
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
GageLawton/noise-cancellation#299 ·
メンテナーはふだん 1 日以内に返信