Add enum example to Android/iOS rn-tester TurboModule (#35133)

Summary: Pull Request resolved: #35133 Add enum example to Android/iOS rn-tester TurboModule Changelog: [General][Added] - Add enum example to Android/iOS rn-tester TurboModule Differential Revision: D40711269 fbshipit-source-id: 03017b3aec9685c32b0bd532a1b4d43261e98378
facebook · Oct 31, 2022 · e8e4ab0 · e8e4ab0
1 parent ad5e3f6
commit e8e4ab0
Show file tree

Hide file tree

Showing 20 changed files with 95 additions and 0 deletions.
diff --git a/.flowconfig b/.flowconfig
@@ -30,6 +30,7 @@ flow/
 
 [options]
 emoji=true
+enums=true
 
 exact_by_default=true
 exact_empty_objects=true

diff --git a/.flowconfig.android b/.flowconfig.android
@@ -30,6 +30,7 @@ flow/
 
 [options]
 emoji=true
+enums=true
 
 exact_by_default=true
 exact_empty_objects=true

diff --git a/BUCK b/BUCK
@@ -744,6 +744,7 @@ rn_library(
         "//xplat/js:node_modules__base64_19js",
         "//xplat/js:node_modules__deprecated_19react_19native_19prop_19types",
         "//xplat/js:node_modules__event_19target_19shim",
+        "//xplat/js:node_modules__flow_19enums_19runtime",
         "//xplat/js:node_modules__invariant",
         "//xplat/js:node_modules__memoize_19one",
         "//xplat/js:node_modules__nullthrows",

diff --git a/Libraries/TurboModule/samples/NativeSampleTurboModule.js b/Libraries/TurboModule/samples/NativeSampleTurboModule.js
@@ -13,6 +13,11 @@ import type {RootTag, TurboModule} from '../RCTExport';
 
 import * as TurboModuleRegistry from '../TurboModuleRegistry';
 
+export enum EnumInt {
+  A = 23,
+  B = 42,
+}
+
 export interface Spec extends TurboModule {
   // Exported methods.
   +getConstants: () => {|
@@ -22,6 +27,7 @@ export interface Spec extends TurboModule {
   |};
   +voidFunc: () => void;
   +getBool: (arg: boolean) => boolean;
+  +getEnum?: (arg: EnumInt) => EnumInt;
   +getNumber: (arg: number) => number;
   +getString: (arg: string) => string;
   +getArray: (arg: Array<any>) => Array<any>;

diff --git a/ReactCommon/react/nativemodule/samples/ReactCommon/NativeSampleTurboCxxModuleSpecJSI.cpp b/ReactCommon/react/nativemodule/samples/ReactCommon/NativeSampleTurboCxxModuleSpecJSI.cpp
@@ -31,6 +31,16 @@ static jsi::Value __hostFunction_NativeSampleTurboCxxModuleSpecJSI_getBool(
           ->getBool(rt, args[0].getBool()));
 }
 
+static jsi::Value __hostFunction_NativeSampleTurboCxxModuleSpecJSI_getEnum(
+    jsi::Runtime &rt,
+    TurboModule &turboModule,
+    const jsi::Value *args,
+    size_t count) {
+  return jsi::Value(
+      static_cast<NativeSampleTurboCxxModuleSpecJSI *>(&turboModule)
+          ->getEnum(rt, args[0].getNumber()));
+}
+
 static jsi::Value __hostFunction_NativeSampleTurboCxxModuleSpecJSI_getNumber(
     jsi::Runtime &rt,
     TurboModule &turboModule,
@@ -119,6 +129,8 @@ NativeSampleTurboCxxModuleSpecJSI::NativeSampleTurboCxxModuleSpecJSI(
       0, __hostFunction_NativeSampleTurboCxxModuleSpecJSI_voidFunc};
   methodMap_["getBool"] = MethodMetadata{
       1, __hostFunction_NativeSampleTurboCxxModuleSpecJSI_getBool};
+  methodMap_["getEnum"] = MethodMetadata{
+      1, __hostFunction_NativeSampleTurboCxxModuleSpecJSI_getEnum};
   methodMap_["getNumber"] = MethodMetadata{
       1, __hostFunction_NativeSampleTurboCxxModuleSpecJSI_getNumber};
   methodMap_["getString"] = MethodMetadata{

diff --git a/ReactCommon/react/nativemodule/samples/ReactCommon/NativeSampleTurboCxxModuleSpecJSI.h b/ReactCommon/react/nativemodule/samples/ReactCommon/NativeSampleTurboCxxModuleSpecJSI.h
@@ -23,6 +23,7 @@ class JSI_EXPORT NativeSampleTurboCxxModuleSpecJSI : public TurboModule {
  public:
   virtual void voidFunc(jsi::Runtime &rt) = 0;
   virtual bool getBool(jsi::Runtime &rt, bool arg) = 0;
+  virtual double getEnum(jsi::Runtime &rt, double arg) = 0;
   virtual double getNumber(jsi::Runtime &rt, double arg) = 0;
   virtual jsi::String getString(jsi::Runtime &rt, const jsi::String &arg) = 0;
   virtual jsi::Array getArray(jsi::Runtime &rt, const jsi::Array &arg) = 0;

diff --git a/ReactCommon/react/nativemodule/samples/ReactCommon/SampleTurboCxxModule.cpp b/ReactCommon/react/nativemodule/samples/ReactCommon/SampleTurboCxxModule.cpp
@@ -26,6 +26,10 @@ bool SampleTurboCxxModule::getBool(jsi::Runtime &rt, bool arg) {
   return arg;
 }
 
+double SampleTurboCxxModule::getEnum(jsi::Runtime &rt, double arg) {
+  return arg;
+}
+
 double SampleTurboCxxModule::getNumber(jsi::Runtime &rt, double arg) {
   return arg;
 }

diff --git a/ReactCommon/react/nativemodule/samples/ReactCommon/SampleTurboCxxModule.h b/ReactCommon/react/nativemodule/samples/ReactCommon/SampleTurboCxxModule.h
@@ -25,6 +25,7 @@ class SampleTurboCxxModule : public NativeSampleTurboCxxModuleSpecJSI {
 
   void voidFunc(jsi::Runtime &rt) override;
   bool getBool(jsi::Runtime &rt, bool arg) override;
+  double getEnum(jsi::Runtime &rt, double arg) override;
   double getNumber(jsi::Runtime &rt, double arg) override;
   jsi::String getString(jsi::Runtime &rt, const jsi::String &arg) override;
   jsi::Array getArray(jsi::Runtime &rt, const jsi::Array &arg) override;

diff --git a/ReactCommon/react/nativemodule/samples/platform/android/NativeSampleTurboModuleSpec.java b/ReactCommon/react/nativemodule/samples/platform/android/NativeSampleTurboModuleSpec.java
@@ -66,6 +66,9 @@ public NativeSampleTurboModuleSpec(ReactApplicationContext reactContext) {
   @ReactMethod(isBlockingSynchronousMethod = true)
   public abstract boolean getBool(boolean arg);
 
+  @ReactMethod(isBlockingSynchronousMethod = true)
+  public abstract double getEnum(double arg);
+
   protected abstract Map<String, Object> getTypedExportedConstants();
 
   @Override

diff --git a/...tCommon/react/nativemodule/samples/platform/android/ReactCommon/SampleTurboModuleSpec.cpp b/...tCommon/react/nativemodule/samples/platform/android/ReactCommon/SampleTurboModuleSpec.cpp
@@ -36,6 +36,18 @@ __hostFunction_NativeSampleTurboModuleSpecJSI_getBool(
           rt, BooleanKind, "getBool", "(Z)Z", args, count, cachedMethodId);
 }
 
+static facebook::jsi::Value
+__hostFunction_NativeSampleTurboModuleSpecJSI_getEnum(
+    facebook::jsi::Runtime &rt,
+    TurboModule &turboModule,
+    const facebook::jsi::Value *args,
+    size_t count) {
+  static jmethodID cachedMethodId = nullptr;
+  return static_cast<JavaTurboModule &>(turboModule)
+      .invokeJavaMethod(
+          rt, NumberKind, "getEnum", "(D)D", args, count, cachedMethodId);
+}
+
 static facebook::jsi::Value
 __hostFunction_NativeSampleTurboModuleSpecJSI_getNumber(
     facebook::jsi::Runtime &rt,
@@ -195,6 +207,9 @@ NativeSampleTurboModuleSpecJSI::NativeSampleTurboModuleSpecJSI(
   methodMap_["getBool"] =
       MethodMetadata{1, __hostFunction_NativeSampleTurboModuleSpecJSI_getBool};
 
+  methodMap_["getEnum"] =
+      MethodMetadata{1, __hostFunction_NativeSampleTurboModuleSpecJSI_getEnum};
+
   methodMap_["getNumber"] = MethodMetadata{
       1, __hostFunction_NativeSampleTurboModuleSpecJSI_getNumber};
 

diff --git a/ReactCommon/react/nativemodule/samples/platform/android/SampleTurboModule.java b/ReactCommon/react/nativemodule/samples/platform/android/SampleTurboModule.java
@@ -48,6 +48,14 @@ public boolean getBool(boolean arg) {
     return arg;
   }
 
+  @DoNotStrip
+  @SuppressWarnings("unused")
+  @Override
+  public double getEnum(double arg) {
+    log("getEnum", arg, arg);
+    return arg;
+  }
+
   @Override
   protected Map<String, Object> getTypedExportedConstants() {
     Map<String, Object> result = new HashMap<>();

diff --git a/ReactCommon/react/nativemodule/samples/platform/ios/RCTNativeSampleTurboModuleSpec.h b/ReactCommon/react/nativemodule/samples/platform/ios/RCTNativeSampleTurboModuleSpec.h
@@ -22,6 +22,7 @@
 
 - (void)voidFunc;
 - (NSNumber *)getBool:(BOOL)arg;
+- (NSNumber *)getEnum:(double)arg;
 - (NSNumber *)getNumber:(double)arg;
 - (NSString *)getString:(NSString *)arg;
 - (NSArray<id<NSObject>> *)getArray:(NSArray *)arg;

diff --git a/ReactCommon/react/nativemodule/samples/platform/ios/RCTNativeSampleTurboModuleSpec.mm b/ReactCommon/react/nativemodule/samples/platform/ios/RCTNativeSampleTurboModuleSpec.mm
@@ -30,6 +30,16 @@
       .invokeObjCMethod(rt, BooleanKind, "getBool", @selector(getBool:), args, count);
 }
 
+static facebook::jsi::Value __hostFunction_NativeSampleTurboModuleSpecJSI_getEnum(
+    facebook::jsi::Runtime &rt,
+    TurboModule &turboModule,
+    const facebook::jsi::Value *args,
+    size_t count)
+{
+  return static_cast<ObjCTurboModule &>(turboModule)
+      .invokeObjCMethod(rt, NumberKind, "getEnum", @selector(getEnum:), args, count);
+}
+
 static facebook::jsi::Value __hostFunction_NativeSampleTurboModuleSpecJSI_getNumber(
     facebook::jsi::Runtime &rt,
     TurboModule &turboModule,
@@ -136,6 +146,7 @@
 {
   methodMap_["voidFunc"] = MethodMetadata{0, __hostFunction_NativeSampleTurboModuleSpecJSI_voidFunc};
   methodMap_["getBool"] = MethodMetadata{1, __hostFunction_NativeSampleTurboModuleSpecJSI_getBool};
+  methodMap_["getEnum"] = MethodMetadata{1, __hostFunction_NativeSampleTurboModuleSpecJSI_getEnum};
   methodMap_["getNumber"] = MethodMetadata{1, __hostFunction_NativeSampleTurboModuleSpecJSI_getNumber};
   methodMap_["getString"] = MethodMetadata{1, __hostFunction_NativeSampleTurboModuleSpecJSI_getString};
   methodMap_["getArray"] = MethodMetadata{1, __hostFunction_NativeSampleTurboModuleSpecJSI_getArray};

diff --git a/ReactCommon/react/nativemodule/samples/platform/ios/RCTSampleTurboModule.mm b/ReactCommon/react/nativemodule/samples/platform/ios/RCTSampleTurboModule.mm
@@ -74,6 +74,11 @@ - (NSDictionary *)constantsToExport
   return @(arg);
 }
 
+RCT_EXPORT_SYNCHRONOUS_TYPED_METHOD(NSNumber *, getEnum : (double)arg)
+{
+  return @(arg);
+}
+
 RCT_EXPORT_SYNCHRONOUS_TYPED_METHOD(NSNumber *, getNumber : (double)arg)
 {
   return @(arg);

diff --git a/ReactCommon/react/nativemodule/samples/platform/ios/SampleTurboCxxModuleLegacyImpl.cpp b/ReactCommon/react/nativemodule/samples/platform/ios/SampleTurboCxxModuleLegacyImpl.cpp
@@ -39,6 +39,12 @@ std::vector<CxxModule::Method> SampleTurboCxxModuleLegacyImpl::getMethods() {
             return getBool(xplat::jsArgAsBool(args, 0));
           },
           CxxModule::SyncTag),
+      CxxModule::Method(
+          "getEnum",
+          [this](folly::dynamic args) {
+            return getEnum(xplat::jsArgAsDouble(args, 0));
+          },
+          CxxModule::SyncTag),
       CxxModule::Method(
           "getNumber",
           [this](folly::dynamic args) {
@@ -114,6 +120,10 @@ bool SampleTurboCxxModuleLegacyImpl::getBool(bool arg) {
   return arg;
 }
 
+double SampleTurboCxxModuleLegacyImpl::getEnum(double arg) {
+  return arg;
+}
+
 double SampleTurboCxxModuleLegacyImpl::getNumber(double arg) {
   return arg;
 }

diff --git a/ReactCommon/react/nativemodule/samples/platform/ios/SampleTurboCxxModuleLegacyImpl.h b/ReactCommon/react/nativemodule/samples/platform/ios/SampleTurboCxxModuleLegacyImpl.h
@@ -27,6 +27,7 @@ class SampleTurboCxxModuleLegacyImpl
   // API
   void voidFunc();
   bool getBool(bool arg);
+  double getEnum(double arg);
   double getNumber(double arg);
   std::string getString(const std::string &arg);
   folly::dynamic getArray(const folly::dynamic &arg);

diff --git a/package.json b/package.json
@@ -120,6 +120,7 @@
     "base64-js": "^1.1.2",
     "deprecated-react-native-prop-types": "^2.3.0",
     "event-target-shim": "^5.0.1",
+    "flow-enums-runtime": "^0.0.5",
     "invariant": "^2.2.4",
     "jest-environment-node": "^29.2.1",
     "jsc-android": "^250230.2.1",

diff --git a/packages/rn-tester/js/examples/TurboModule/SampleTurboModuleExample.js b/packages/rn-tester/js/examples/TurboModule/SampleTurboModuleExample.js
@@ -9,6 +9,7 @@
  */
 
 import NativeSampleTurboModule from 'react-native/Libraries/TurboModule/samples/NativeSampleTurboModule';
+import {EnumInt} from 'react-native/Libraries/TurboModule/samples/NativeSampleTurboModule';
 import type {RootTag} from 'react-native/Libraries/ReactNative/RootTag';
 import {
   StyleSheet,
@@ -57,6 +58,10 @@ class SampleTurboModuleExample extends React.Component<{||}, State> {
     getConstants: () => NativeSampleTurboModule.getConstants(),
     voidFunc: () => NativeSampleTurboModule.voidFunc(),
     getBool: () => NativeSampleTurboModule.getBool(true),
+    getEnum: () =>
+      NativeSampleTurboModule.getEnum
+        ? NativeSampleTurboModule.getEnum(EnumInt.A)
+        : null,
     getNumber: () => NativeSampleTurboModule.getNumber(99.95),
     getString: () => NativeSampleTurboModule.getString('Hello'),
     getArray: () =>
@@ -80,6 +85,7 @@ class SampleTurboModuleExample extends React.Component<{||}, State> {
       | 'callback'
       | 'getArray'
       | 'getBool'
+      | 'getEnum'
       | 'getConstants'
       | 'getNumber'
       | 'getObject'
@@ -120,6 +126,7 @@ class SampleTurboModuleExample extends React.Component<{||}, State> {
       | 'callback'
       | 'getArray'
       | 'getBool'
+      | 'getEnum'
       | 'getConstants'
       | 'getNumber'
       | 'getObject'

diff --git a/template/_flowconfig b/template/_flowconfig
@@ -21,6 +21,7 @@ node_modules/react-native/flow/
 
 [options]
 emoji=true
+enums=true
 
 exact_by_default=true
 

diff --git a/yarn.lock b/yarn.lock
@@ -4528,6 +4528,11 @@ flow-bin@^0.191.0:
   resolved "https://registry.yarnpkg.com/flow-bin/-/flow-bin-0.191.0.tgz#9324c9498584b60575fd8d77a2897ee4f384443b"
   integrity sha512-IhaDGoOtRDdGUJLjm7KQlHK8BAzOVJmpx+CIR6bCju4pF7zon2v7WNrds5706WZqDE3rD2c8cM4GdhDnIFYXtg==
 
+flow-enums-runtime@^0.0.5:
+  version "0.0.5"
+  resolved "https://registry.yarnpkg.com/flow-enums-runtime/-/flow-enums-runtime-0.0.5.tgz#95884bfcc82edaf27eef7e1dd09732331cfbafbc"
+  integrity sha512-PSZF9ZuaZD03sT9YaIs0FrGJ7lSUw7rHZIex+73UYVXg46eL/wxN5PaVcPJFudE2cJu5f0fezitV5aBkLHPUOQ==
+
 flow-parser@0.*, flow-parser@^0.185.0:
   version "0.185.0"
   resolved "https://registry.yarnpkg.com/flow-parser/-/flow-parser-0.185.0.tgz#56bde60805bad19b2934ebfc50c9485e5c5424f9"