Skip to content

feat(tm-ios): Reject Promise if Turbo Module method throws an Error#40764

Closed
krystofwoldrich wants to merge 67 commits intofacebook:mainfrom
krystofwoldrich:kw-mixed-stack-traces-promise-ios
Closed

feat(tm-ios): Reject Promise if Turbo Module method throws an Error#40764
krystofwoldrich wants to merge 67 commits intofacebook:mainfrom
krystofwoldrich:kw-mixed-stack-traces-promise-ios

Conversation

@krystofwoldrich
Copy link
Copy Markdown
Contributor

@krystofwoldrich krystofwoldrich commented Oct 10, 2023

Summary:

Android change here

This PR builds upon the previous work done in #36925, which introduced native stack traces to the JSError for synchronous functions.

The current modifications concentrate on functions that return Promises. Prior to this PR, errors within Promise-returning functions would be thrown at the platform layer crashing the app without a link to the JS stack.

After the implementation of this PR, errors thrown within Promise-returning functions are now captured and transformed into rejected Promises. These rejected Promises contain a JS Error object that contains both the JS stack trace and the cause, along with the platform stack trace.

Additionally, this PR ensures that rejections from native functions are now linked to the JS stack trace, providing a more comprehensive view of the rejection flow.

Changelog:

[GENERAL][ADDED] - Turbo Modules Promise-returning functions reject with JS and platform stack traces information

Test Plan:

iOS
function_promise_ios

Example of intentionally rejected promise on iOS:

{
  "name": "Error",
  "message": "Exception in HostFunction: intentional promise rejection",
  "stack": "@[native code]\nrejectPromise@http://localhost:8081/js/examples/TurboModule/SampleTurboModuleExample.bundle:42:70\nonPress@http://localhost:8081/js/examples/TurboModule/SampleTurboModuleExample.bundle:242:71\n_performTransitionSideEffects@http://localhost:8081/js/RNTesterApp.ios.bundle:52614:22\n_receiveSignal@http://localhost:8081/js/RNTesterApp.ios.bundle:52570:45\nonResponderRelease@http://localhost:8081/js/RNTesterApp.ios.bundle:52433:34\ninvokeGuardedCallbackProd@http://localhost:8081/js/RNTesterApp.ios.bundle:3068:21\ninvokeGuardedCallback@http://localhost:8081/js/RNTesterApp.ios.bundle:3154:42\ninvokeGuardedCallbackAndCatchFirstError@http://localhost:8081/js/RNTesterApp.ios.bundle:3157:36\nexecuteDispatch@http://localhost:8081/js/RNTesterApp.ios.bundle:3221:48\nexecuteDispatchesInOrder@http://localhost:8081/js/RNTesterApp.ios.bundle:3238:26\nexecuteDispatchesAndRelease@http://localhost:8081/js/RNTesterApp.ios.bundle:4962:35\nforEach@[native code]\nforEachAccumulated@http://localhost:8081/js/RNTesterApp.ios.bundle:3680:22\nrunEventsInBatch@http://localhost:8081/js/RNTesterApp.ios.bundle:4980:27\nrunExtractedPluginEventsInBatch@http://localhost:8081/js/RNTesterApp.ios.bundle:5002:25\n@http://localhost:8081/js/RNTesterApp.ios.bundle:5020:42\nbatchedUpdates$1@http://localhost:8081/js/RNTesterApp.ios.bundle:14856:20\nbatchedUpdates@http://localhost:8081/js/RNTesterApp.ios.bundle:4951:36\ndispatchEvent@http://localhost:8081/js/RNTesterApp.ios.bundle:5013:23",
  "cause": {
    "code": "code_1",
    "stackSymbols": [
      "0   RNTester                            0x00000001031f9958 RCTJSErrorFromCodeMessageAndNSError + 112",
      "1   RNTester                            0x00000001034cecc8 ___ZZN8facebook5react15ObjCTurboModule13createPromiseERNS_3jsi7RuntimeENSt3__112basic_stringIcNS5_11char_traitsIcEENS5_9allocatorIcEEEEU13block_pointerFvU13block_pointerFvP11objc_objectEU13block_pointerFvP8NSStringSH_P7NSErrorEU13block_pointerFvP11NSExceptionEEENK3$_0clES4_RKNS2_5ValueEPSU_m_block_invoke.66 + 96",
      "2   RNTester                            0x000000010374e774 -[RCTSampleTurboModule getValueWithPromise:resolve:reject:] + 232",
      "3   CoreFoundation                      0x000000018043d6c0 __invoking___ + 144",
      "4   CoreFoundation                      0x000000018043aa44 -[NSInvocation invoke] + 276",
      "5   CoreFoundation                      0x000000018043acdc -[NSInvocation invokeWithTarget:] + 60",
      "6   RNTester                            0x00000001034c4de4 ___ZN8facebook5react15ObjCTurboModule23performMethodInvocationERNS_3jsi7RuntimeEbPKcP12NSInvocationP14NSMutableArrayU13block_pointerFvP11NSExceptionE_block_invoke + 240",
      "7   RNTester                            0x00000001034d5120 _ZZN8facebook5react15ObjCTurboModule23performMethodInvocationERNS_3jsi7RuntimeEbPKcP12NSInvocationP14NSMutableArrayU13block_pointerFvP11NSExceptionEENK3$_1clEv + 32",
      "8   RNTester                            0x00000001034d50f4 _ZNSt3__18__invokeB6v15006IRZN8facebook5react15ObjCTurboModule23performMethodInvocationERNS1_3jsi7RuntimeEbPKcP12NSInvocationP14NSMutableArrayU13block_pointerFvP11NSExceptionEE3$_1JEEEDTclclsr3stdE7declvalIT_EEspclsr3stdE7declvalIT0_EEEEOSJ_DpOSK_ + 24",
      "9   RNTester                            0x00000001034d50ac _ZNSt3__128__invoke_void_return_wrapperIvLb1EE6__callIJRZN8facebook5react15ObjCTurboModule23performMethodInvocationERNS3_3jsi7RuntimeEbPKcP12NSInvocationP14NSMutableArrayU13block_pointerFvP11NSExceptionEE3$_1EEEvDpOT_ + 24",
      "10  RNTester                            0x00000001034d5088 _ZNSt3__110__function12__alloc_funcIZN8facebook5react15ObjCTurboModule23performMethodInvocationERNS2_3jsi7RuntimeEbPKcP12NSInvocationP14NSMutableArrayU13block_pointerFvP11NSExceptionEE3$_1NS_9allocatorISI_EEFvvEEclB6v15006Ev + 28",
      "11  RNTester                            0x00000001034d3ce0 _ZNSt3__110__function6__funcIZN8facebook5react15ObjCTurboModule23performMethodInvocationERNS2_3jsi7RuntimeEbPKcP12NSInvocationP14NSMutableArrayU13block_pointerFvP11NSExceptionEE3$_1NS_9allocatorISI_EEFvvEEclEv + 28",
      "12  RNTester                            0x000000010308d65c _ZNKSt3__110__function12__value_funcIFvvEEclB6v15006Ev + 68",
      "13  RNTester                            0x000000010308d60c _ZNKSt3__18functionIFvvEEclEv + 24",
      "14  RNTester                            0x00000001034dbd24 ___ZN12_GLOBAL__N_128MethodQueueNativeCallInvoker11invokeAsyncEONSt3__18functionIFvvEEE_block_invoke + 44",
      "15  libdispatch.dylib                   0x0000000106820528 _dispatch_call_block_and_release + 24",
      "16  libdispatch.dylib                   0x0000000106821d50 _dispatch_client_callout + 16",
      "17  libdispatch.dylib                   0x0000000106832808 _dispatch_main_queue_drain + 1316",
      "18  libdispatch.dylib                   0x00000001068322d4 _dispatch_main_queue_callback_4CF + 40",
      "19  CoreFoundation                      0x000000018039a784 __CFRUNLOOP_IS_SERVICING_THE_MAIN_DISPATCH_QUEUE__ + 12",
      "20  CoreFoundation                      0x0000000180394de4 __CFRunLoopRun + 1912",
      "21  CoreFoundation                      0x0000000180394254 CFRunLoopRunSpecific + 584",
      "22  GraphicsServices                    0x0000000188eb7c9c GSEventRunModal + 160",
      "23  UIKitCore                           0x0000000112b32ff0 -[UIApplication _run] + 868",
      "24  UIKitCore                           0x0000000112b36f3c UIApplicationMain + 124",
      "25  RNTester                            0x0000000102e7029c main + 96",
      "26  dyld                                0x0000000106721514 start_sim + 20",
      "27  ???                                 0x00000001068fde50 0x0 + 4405059152",
      "28  ???                                 0x7539800000000000 0x0 + 8446923313598431232"
    ],
    "message": "intentional promise rejection",
    "domain": "RCTSampleTurboModule",
    "userInfo": {}
  }
}

How I logged out the Errors:

console.log('Error in JS:', JSON.stringify({
  name: e.name,
  message: e.message,
  stack: e.stack,
  ...e,
}, null, 2));

krystofwoldrich and others added 30 commits April 27, 2023 18:10
@krystofwoldrich
Add iOS reject promise if turbo module method throws exception
097525d
Merge remote-tracking branch 'origin/main' into kw-mixed-stack-traces…
4fc71fd 
…-promise
@krystofwoldrich
Merge remote-tracking branch 'origin/main' into kw-mixed-stack-traces…
108e205 
…-promise
Merge branch 'main' into kw-mixed-stack-traces-promise
0ca58bb
Add Android reject async func on error
5892e50
add(ios): js stack to rejection caused by native exception or native …
97606c9 
…rejection
Fix android promise reject and add JS stack trace
2eb0a46
Refactor java callback
a836691
Fix typos
be2ea63
iOS jsStack do not copy
ccf5460
Update lint
85f48d7
More lint
7205f1d
Merge remote-tracking branch 'upstream/main' into kw-mixed-stack-trac…
d92339c 
…es-promise
Add RCT_TRACE_PROMISE_REJECTION_ENABLED flag for iOS
99cb0b9
Rename the iOS flag
732dba9
Add android flag and fix internal reject invocation on Hermes
239667d
move RCTInternalPromiseRejectBlock to rct turbo module
882c81b
Add js func returning void rethrow explanation
9529dd9
Rename RCTInternalPromiseRejectBlock to RCTNSExceptionHandler
40163ff
Add CallbackWrapperExecutor type
49b861d
Handle all throws from Obj-Cpp
4d40ceb
Merge remote-tracking branch 'upstream/main' into kw-mixed-stack-trac…
86bf079 
…es-promise
Merge branch 'main' into kw-mixed-stack-traces-promise
b21990c
Enable trace turbo module rejection in debug iOS builds
25b32b7
Make jsInvocationStack optional
be8e027
Add jsInvocationStack comment
377c328
use ref to js stack in createRejectJSErrorValue
6e4b652
Use only one rejectJSIFn in java
abf7e8a
Rename feature flag
e1634a6
fix flag func overload
65982e2
facebook-github-bot pushed a commit that referenced this pull request Oct 27, 2023
@facebook-github-bot
feat(tm-android): Reject Promise if Turbo Module method throws an Err…
7612e66 
…or (#37484)

Summary:
### [iOS change here](#40764)

This PR builds upon the previous work done in #36925, which introduced native stack traces to the JSError for synchronous functions.

The current modifications concentrate on functions that return Promises. Prior to this PR, errors within Promise-returning functions would be thrown at the platform layer crashing the app without a link to the JS stack.

After the implementation of this PR, errors thrown within Promise-returning functions are now captured and transformed into rejected Promises. These rejected Promises contain a JS Error object that contains both the JS stack trace and the cause, along with the platform stack trace.

Additionally, this PR ensures that rejections from native functions are now linked to the JS stack trace, providing a more comprehensive view of the rejection flow.

## Changelog:

<!-- Help reviewers and the release process by writing your own changelog entry.

Pick one each for the category and type tags:

[ANDROID|GENERAL|IOS|INTERNAL] [BREAKING|ADDED|CHANGED|DEPRECATED|REMOVED|FIXED|SECURITY] - Message

For more details, see:
https://reactnative.dev/contributing/changelogs-in-pull-requests
-->

[GENERAL][ADDED] - Turbo Modules Promise-returning functions reject with JS and platform stack traces information

Pull Request resolved: #37484

Test Plan:
| Android |
|--------|
| ![function_promise_android](https://github.com/krystofwoldrich/react-native/assets/31292499/1d1a3adf-986a-47b4-b98b-9e766176b7ae) |

Example of intentionally rejected promise on Android:

```
{
  "name": "Error",
  "message": "Exception in HostFunction: intentional promise rejection",
  "stack": "[native code]\ntryCallTwo@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:25844:9\ndoResolve@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:25975:25\nPromise@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:25863:14\n[native code]\nrejectPromise@http://10.0.2.2:8081/js/examples/TurboModule/SampleTurboModuleExample.bundle?platform=android&lazy=true&app=com.facebook.react.uiapp&modulesOnly=true&dev=true&minify=false&runModule=true&shallow=true:42:70\nonPress@http://10.0.2.2:8081/js/examples/TurboModule/SampleTurboModuleExample.bundle?platform=android&lazy=true&app=com.facebook.react.uiapp&modulesOnly=true&dev=true&minify=false&runModule=true&shallow=true:242:71\n_performTransitionSideEffects@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:51896:22\n_receiveSignal@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:51852:45\nonResponderRelease@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:51715:34\ninvokeGuardedCallbackProd@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:2962:21\ninvokeGuardedCallback@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:3048:42\ninvokeGuardedCallbackAndCatchFirstError@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:3051:36\nexecuteDispatch@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:3115:48\nexecuteDispatchesInOrder@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:3132:26\nexecuteDispatchesAndRelease@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:4856:35\nforEach@[native code]\nforEachAccumulated@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:3574:22\nrunEventsInBatch@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:4874:27\nrunExtractedPluginEventsInBatch@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:4896:25\nhttp://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:4914:42\nbatchedUpdates$1@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:14750:20\nbatchedUpdates@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:4845:36\ndispatchEvent@http://10.0.2.2:8081/js/RNTesterApp.android.bundle?platform=android&dev=true&lazy=true&minify=false&app=com.facebook.react.uiapp&modulesOnly=false&runModule=true:4907:23",
  "cause": {
    "nativeStackAndroid": [
      {
        "lineNumber": 173,
        "file": "SampleTurboModule.java",
        "methodName": "getValueWithPromise",
        "class": "com.facebook.fbreact.specs.SampleTurboModule"
      },
      {
        "lineNumber": -2,
        "file": "NativeRunnable.java",
        "methodName": "run",
        "class": "com.facebook.jni.NativeRunnable"
      },
      {
        "lineNumber": 942,
        "file": "Handler.java",
        "methodName": "handleCallback",
        "class": "android.os.Handler"
      },
      {
        "lineNumber": 99,
        "file": "Handler.java",
        "methodName": "dispatchMessage",
        "class": "android.os.Handler"
      },
      {
        "lineNumber": 27,
        "file": "MessageQueueThreadHandler.java",
        "methodName": "dispatchMessage",
        "class": "com.facebook.react.bridge.queue.MessageQueueThreadHandler"
      },
      {
        "lineNumber": 201,
        "file": "Looper.java",
        "methodName": "loopOnce",
        "class": "android.os.Looper"
      },
      {
        "lineNumber": 288,
        "file": "Looper.java",
        "methodName": "loop",
        "class": "android.os.Looper"
      },
      {
        "lineNumber": 228,
        "file": "MessageQueueThreadImpl.java",
        "methodName": "run",
        "class": "com.facebook.react.bridge.queue.MessageQueueThreadImpl$4"
      },
      {
        "lineNumber": 1012,
        "file": "Thread.java",
        "methodName": "run",
        "class": "java.lang.Thread"
      }
    ],
    "userInfo": null,
    "message": "intentional promise rejection",
    "code": "code 1"
  }
}
```

How I logged out the Errors:

```js
console.log('Error in JS:', JSON.stringify({
  name: e.name,
  message: e.message,
  stack: e.stack,
  ...e,
}, null, 2));
```

Reviewed By: RSNara

Differential Revision: D50613349

Pulled By: javache

fbshipit-source-id: b49c469118c8d8d27c43164f110dfe57ddd592d9
@javache javache self-assigned this Nov 10, 2023
@krystofwoldrich
Copy link
Copy Markdown
Contributor Author

krystofwoldrich commented Nov 30, 2023

@javache Hi, is there anything blocking this PR?

javache
javache reviewed Nov 30, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@javache javache left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me (and sorry for the delay). Just some nits, but should be good to import.

@krystofwoldrich
Copy link
Copy Markdown
Contributor Author

krystofwoldrich commented Dec 14, 2023

@javache Thank you 🙏, no worries, will update the PR.

@krystofwoldrich krystofwoldrich requested a review from javache March 10, 2024 17:54
@krystofwoldrich
Copy link
Copy Markdown
Contributor Author

krystofwoldrich commented Mar 23, 2024

Hi @javache,
can you check this PR?

javache
javache reviewed Jul 3, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@javache javache left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few remaining nits and and some conflicts with main to resolve, and I'll try to get this landed internally :)

.../react-native/ReactCommon/react/nativemodule/core/platform/ios/ReactCommon/RCTTurboModule.mm
error.asObject(runtime).setProperty(runtime, "cause", std::move(cause));
return {runtime, std::move(error)};
return jsi::JSError(runtime, std::move(error));
}
Copy link
Copy Markdown
Member

@javache javache Jul 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this method now unused? Can it be removed?

Copy link
Copy Markdown
Contributor Author

@krystofwoldrich krystofwoldrich Jul 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's used here https://github.com/krystofwoldrich/react-native/blob/41fac96681d837c80f4db8ee0ee4351d90d40b65/packages/react-native/ReactCommon/react/nativemodule/core/platform/ios/ReactCommon/RCTTurboModule.mm#L500

@krystofwoldrich krystofwoldrich requested a review from javache July 15, 2024 04:09
@krystofwoldrich
Copy link
Copy Markdown
Contributor Author

krystofwoldrich commented Jul 15, 2024 •
edited
Loading

@javache Thank you very much, I've applied the suggestions.

@react-native-bot
Copy link
Copy Markdown
Collaborator

react-native-bot commented Aug 13, 2025

This PR is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@react-native-bot react-native-bot added the Stale There has been a lack of activity on this issue and it may be closed soon. label Aug 13, 2025
@react-native-bot
Copy link
Copy Markdown
Collaborator

react-native-bot commented Aug 20, 2025

This PR was closed because it has been stalled for 7 days with no activity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@javache javache Awaiting requested review from javache

Assignees

@javache javache

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. p: Sentry Partner: Sentry Partner Shared with Meta Applied via automation to indicate that an Issue or Pull Request has been shared with the team. Stale There has been a lack of activity on this issue and it may be closed soon.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@krystofwoldrich @analysis-bot @react-native-bot @javache @facebook-github-bot