mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
12a102b926
Summary: This PR is adding examples of Turbo Modules functions throwing runtime exceptions and asserts. This should make it easier to collaborate and develop the error reporting for a new architecture that is being discussed in the React Native New Architecture Working Group -> https://github.com/reactwg/react-native-new-architecture/discussions/122. I'm not sure what return type should be used for the JS function returning `Promise<void>` in Cxx, I used [`AsyncPromise<jsi::Value>`](https://github.com/facebook/react-native/pull/36729/files#diff-9cebc75f48fd35fd6fef71138f98dfd0ba28a754b2aab0d6fe44fd685f74ce16R135), what would you use, I've not found `void` type to use? ### Added functions The table shows the current behavior. <table> <tr> <td> Function <td> Description <td> Turbo Module <td> Cxx Module <tr> <td> voidFuncThrows <td> function with return type void throws a runtime exception <td> platform error no JS stack trace <td> JS error no native stack trace <tr> <td> getObjectThrows <td> function with return type object throws a runtime exception <td> JS error no platform stack trace <td> JS error no native stack trace <tr> <td> promiseThrows <td> function with return type promise throws a runtime exception before settling the promise <td> platform error no JS stack trace <td> JS error no native stack trace <tr> <td> voidFuncAssert <td> function with return type void asserts <td> platform error no JS stack trace <td> native error no JS stack trace <tr> <td> getObjectAssert <td> function with return type object asserts <td> JS error no platform stack trace <td> native error no JS stack trace <tr> <td> promiseAssert <td> function with return type promise asserts before settling the promise <td> platform error no JS stack trace <td> native error no JS stack trace </table> ## 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 --> [INTERNAL] [ADDED] - Error reporting examples in rn-tester turbo modules Pull Request resolved: https://github.com/facebook/react-native/pull/36729 Test Plan: This PR doesn't change any RN behavior. Only shows the current state by adding an example to rn-tester. I'm happy to add these examples to the unit/integration test, just point me to where would be a good place. Reviewed By: rshest Differential Revision: D44623027 Pulled By: javache fbshipit-source-id: d9cc04852b05d810ed11d7a94f1b2d455ef554a5
87 lines
2.3 KiB
JavaScript
87 lines
2.3 KiB
JavaScript
/**
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @flow strict-local
|
|
* @format
|
|
*/
|
|
|
|
import type {TurboModule} from 'react-native/Libraries/TurboModule/RCTExport';
|
|
|
|
import {TurboModuleRegistry} from 'react-native';
|
|
|
|
export enum EnumInt {
|
|
IA = 23,
|
|
IB = 42,
|
|
}
|
|
|
|
export enum EnumFloat {
|
|
FA = 1.23,
|
|
FB = 4.56,
|
|
}
|
|
|
|
export enum EnumNone {
|
|
NA,
|
|
NB,
|
|
}
|
|
|
|
export enum EnumStr {
|
|
SA = 's---a',
|
|
SB = 's---b',
|
|
}
|
|
|
|
export type UnionFloat = 1.44 | 2.88 | 5.76;
|
|
export type UnionString = 'One' | 'Two' | 'Three';
|
|
export type UnionObject = {value: number} | {low: string};
|
|
|
|
export type ConstantsStruct = {|
|
|
const1: boolean,
|
|
const2: number,
|
|
const3: string,
|
|
|};
|
|
|
|
export type ObjectStruct = {|
|
|
a: number,
|
|
b: string,
|
|
c?: ?string,
|
|
|};
|
|
|
|
export type ValueStruct = {|
|
|
x: number,
|
|
y: string,
|
|
z: ObjectStruct,
|
|
|};
|
|
|
|
export interface Spec extends TurboModule {
|
|
+getArray: (arg: Array<ObjectStruct | null>) => Array<ObjectStruct | null>;
|
|
+getBool: (arg: boolean) => boolean;
|
|
+getConstants: () => ConstantsStruct;
|
|
+getCustomEnum: (arg: EnumInt) => EnumInt;
|
|
+getNumEnum: (arg: EnumInt) => EnumFloat;
|
|
+getStrEnum: (arg: EnumNone) => EnumStr;
|
|
+getMap: (arg: {[key: string]: ?number}) => {[key: string]: ?number};
|
|
+getNumber: (arg: number) => number;
|
|
+getObject: (arg: ObjectStruct) => ObjectStruct;
|
|
+getSet: (arg: Array<number>) => Array<number>;
|
|
+getString: (arg: string) => string;
|
|
+getUnion: (x: UnionFloat, y: UnionString, z: UnionObject) => string;
|
|
+getValue: (x: number, y: string, z: ObjectStruct) => ValueStruct;
|
|
+getValueWithCallback: (callback: (value: string) => void) => void;
|
|
+getValueWithPromise: (error: boolean) => Promise<string>;
|
|
+getWithWithOptionalArgs: (optionalArg?: boolean) => ?boolean;
|
|
+voidFunc: () => void;
|
|
+emitCustomDeviceEvent: (eventName: string) => void;
|
|
+voidFuncThrows: () => void;
|
|
+getObjectThrows: (arg: ObjectStruct) => ObjectStruct;
|
|
+promiseThrows: () => Promise<void>;
|
|
+voidFuncAssert: () => void;
|
|
+getObjectAssert: (arg: ObjectStruct) => ObjectStruct;
|
|
+promiseAssert: () => Promise<void>;
|
|
}
|
|
|
|
export default (TurboModuleRegistry.get<Spec>(
|
|
'NativeCxxModuleExampleCxx',
|
|
): ?Spec);
|