Better error message when trying to call non-worklet from UI thread #3821

kmagiera · 2022-11-30T12:14:12Z

Summary

After #3722 the error message presented after attempting to synchronously call React runtime function from the UI runtime has changed and became less descriptive than before. This PR adds a way for us to throw a more descriptive error in such scenario.

Test plan

Use the following code:

function rnMethod() {
  console.log('from RN');
}

function uiMethod() {
  'worklet';
  rnMethod(); // this should throw
}

runOnUI(uiMethod)();

Before this change you'd get a generic "Object is not a function" thrown at the line where we call rnMethod, now the error message says "Tried to synchronously call a non-worklet function" and presents possible solution (see the diff for the whole error message)

src/reanimated2/core.ts

Common/cpp/SharedItems/Shareables.h

src/reanimated2/core.ts

src/reanimated2/threads.ts

src/reanimated2/core.ts

Co-authored-by: Tomek Zawadzki <tomasz.zawadzki@swmansion.com>

…oftware-mansion#3821) ## Summary After software-mansion#3722 the error message presented after attempting to synchronously call React runtime function from the UI runtime has changed and became less descriptive than before. This PR adds a way for us to throw a more descriptive error in such scenario. ## Test plan Use the following code: ``` function rnMethod() { console.log('from RN'); } function uiMethod() { 'worklet'; rnMethod(); // this should throw } runOnUI(uiMethod)(); ``` Before this change you'd get a generic "Object is not a function" thrown at the line where we call `rnMethod`, now the error message says "Tried to synchronously call a non-worklet function" and presents possible solution (see the diff for the whole error message) Co-authored-by: Tomek Zawadzki <tomasz.zawadzki@swmansion.com>

Better error message when trying to call non-worklet from UI thread

7f962c6

kmagiera requested review from tomekzaw and piaskowyk November 30, 2022 12:58