[js/rn] Supoort New Architecture

js/.eslintrc.js

@@ -176,7 +176,22 @@ module.exports = {
     }
   }, {
     files: ['react_native/lib/**/*.ts'], rules: {
-      '@typescript-eslint/naming-convention': 'off'
+      '@typescript-eslint/naming-convention': 'off',
+    }
+  }, {
+    files: ['react_native/lib/NativeOnnxruntime.ts'], rules: {
+      'unicorn/filename-case': 'off',
+      '@typescript-eslint/ban-types': [
+        'error',
+        {
+          types: {
+            // NOTE: We got issue like https://github.com/facebook/react-native/issues/36431
+            // So we have to use `{}` type here.
+            '{}': false,
+          },
+          extendDefaults: true,
+        }
+      ]
     }
   }, {
     files: ['react_native/scripts/**/*.ts'], rules: {

js/README.md

@@ -382,12 +382,6 @@ From ORT v1.13 onwards the 'full' ONNX Runtime package is used. It supports both
 
 4. Test Android and iOS apps. In Windows, open Android Emulator first.
 
-   `debug.keystore` must be generated ahead for Android example.
-
-   ```sh
-   keytool -genkey -v -keystore <ORT_ROOT>/js/react_native/e2e/android/debug.keystore -alias androiddebugkey -storepass android -keypass android -keyalg RSA -keysize 2048 -validity 999999 -dname "CN=Android Debug,O=Android,C=US"
-   ```
-
    From `<ORT_ROOT>/js/react_native,
 
    ```sh

js/react_native/.gitignore

@@ -25,13 +25,15 @@ DerivedData
 *.ipa
 *.xcuserstate
 project.xcworkspace
+xcshareddata
 
 # Android/IJ
 #
 .idea
 .gradle
 local.properties
 android.iml
+.cxx
 
 # Cocoapods
 #

js/react_native/android/build.gradle

@@ -7,13 +7,21 @@ buildscript {
   }
 
   dependencies {
-    classpath 'com.android.tools.build:gradle:4.1.2'
+    classpath 'com.android.tools.build:gradle:7.3.1'
     // noinspection DifferentKotlinGradleVersion
   }
 }
 
 apply plugin: 'com.android.library'
 
+def isNewArchitectureEnabled() {
+  return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
+}
+
+if (isNewArchitectureEnabled()) {
+  apply plugin: "com.facebook.react"
+}
+
 def getExtOrDefault(name) {
   return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['OnnxruntimeModule_' + name]
 }
@@ -90,6 +98,7 @@ android {
         abiFilters (*reactNativeArchitectures())
       }
     }
+    buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
   }
 
   if (rootProject.hasProperty("ndkPath")) {
@@ -115,6 +124,7 @@ android {
       "META-INF",
       "META-INF/**",
       "**/libjsi.so",
+      "**/libc++_shared.so",
     ]
   }
 
@@ -139,6 +149,12 @@ android {
       } else {
         java.exclude '**/OnnxruntimeExtensionsEnabled.java'
       }
+
+      if (isNewArchitectureEnabled()) {
+        java.srcDirs += ['src/newarch']
+      } else {
+        java.srcDirs += ['src/oldarch']
+      }
     }
   }
 }
@@ -219,7 +235,13 @@ repositories {
 }
 
 dependencies {
-  api "com.facebook.react:react-native:" + REACT_NATIVE_VERSION
+  if (REACT_NATIVE_MINOR_VERSION >= 71) {
+    // REACT_NATIVE_VERSION >= 0.71.x use react-android (https://mvnrepository.com/artifact/com.facebook.react/react-android)
+    // See also https://github.com/facebook/react-native/blob/0.71-stable/android/README.md
+    api "com.facebook.react:react-android:" + REACT_NATIVE_VERSION
+  } else {
+    api "com.facebook.react:react-native:" + REACT_NATIVE_VERSION
+  }
   api "org.mockito:mockito-core:2.28.2"
 
   androidTestImplementation "androidx.test:runner:1.1.0"
@@ -238,3 +260,11 @@ dependencies {
     implementation "com.microsoft.onnxruntime:onnxruntime-extensions-android:latest.integration@aar"
   }
 }
+
+if (isNewArchitectureEnabled()) {
+  react {
+    jsRootDir = file("../lib/")
+    libraryName = "OnnxruntimeSpec"
+    codegenJavaPackageName = "ai.onnxruntime.reactnative"
+  }
+}

js/react_native/android/gradle.properties

@@ -17,3 +17,8 @@ OnnxruntimeModule_buildToolsVersion=29.0.2
 OnnxruntimeModule_compileSdkVersion=31
 OnnxruntimeModule_minSdkVersion=21
 OnnxruntimeModule_targetSdkVersion=31
+
+# Specifies the JVM arguments used for the daemon process.
+# The setting is particularly useful for tweaking memory settings.
+# Default value: -Xmx512m -XX:MaxMetaspaceSize=256m
+org.gradle.jvmargs=-Xmx2048m -XX:MaxMetaspaceSize=512m

js/react_native/android/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionSha256Sum=7faa7198769f872826c8ef4f1450f839ec27f0b4d5d1e51bade63667cbccd205
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip
+distributionSha256Sum=f6b8596b10cce501591e92f229816aa4046424f3b24d771751b06779d58c8ec4
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

js/react_native/android/src/androidTest/java/ai/onnxruntime/reactnative/OnnxruntimeModuleTest.java

@@ -58,7 +58,7 @@ public void setUp() {
   @Test
   public void getName() throws Exception {
     OnnxruntimeModule ortModule = new OnnxruntimeModule(reactContext);
-    ortModule.blobModule = blobModule;
+    ortModule.getOnnxruntime().setBlobModule(blobModule);
     String name = "Onnxruntime";
     Assert.assertEquals(ortModule.getName(), name);
   }
@@ -71,7 +71,8 @@ public void onnxruntime_module() throws Exception {
       when(Arguments.createArray()).thenAnswer(i -> new JavaOnlyArray());
 
       OnnxruntimeModule ortModule = new OnnxruntimeModule(reactContext);
-      ortModule.blobModule = blobModule;
+      ortModule.getOnnxruntime().setBlobModule(blobModule);
+      ortModule.getOnnxruntime().checkBlobModule();
       String sessionKey = "";
 
       // test loadModel()
@@ -82,7 +83,7 @@ public void onnxruntime_module() throws Exception {
 
           JavaOnlyMap options = new JavaOnlyMap();
           try {
-            ReadableMap resultMap = ortModule.loadModel(modelBuffer, options);
+            ReadableMap resultMap = ortModule.getOnnxruntime().loadModel(modelBuffer, options);
             sessionKey = resultMap.getString("key");
             ReadableArray inputNames = resultMap.getArray("inputNames");
             ReadableArray outputNames = resultMap.getArray("outputNames");
@@ -132,7 +133,7 @@ public void onnxruntime_module() throws Exception {
         options.putBoolean("encodeTensorData", true);
 
         try {
-          ReadableMap resultMap = ortModule.run(sessionKey, inputDataMap, outputNames, options);
+          ReadableMap resultMap = ortModule.getOnnxruntime().run(sessionKey, inputDataMap, outputNames, options);
 
           ReadableMap outputMap = resultMap.getMap("output");
           for (int i = 0; i < 2; ++i) {
@@ -151,7 +152,7 @@ public void onnxruntime_module() throws Exception {
       }
 
       // test dispose
-      ortModule.dispose(sessionKey);
+      ortModule.getOnnxruntime().dispose(sessionKey);
     } finally {
       mockSession.finishMocking();
     }
@@ -165,7 +166,8 @@ public void onnxruntime_module_append_nnapi() throws Exception {
       when(Arguments.createArray()).thenAnswer(i -> new JavaOnlyArray());
 
       OnnxruntimeModule ortModule = new OnnxruntimeModule(reactContext);
-      ortModule.blobModule = blobModule;
+      ortModule.getOnnxruntime().setBlobModule(blobModule);
+      ortModule.getOnnxruntime().checkBlobModule();
       String sessionKey = "";
 
       // test loadModel() with nnapi ep options
@@ -182,7 +184,7 @@ public void onnxruntime_module_append_nnapi() throws Exception {
         options.putArray("executionProviders", epArray);
 
         try {
-          ReadableMap resultMap = ortModule.loadModel(modelBuffer, options);
+          ReadableMap resultMap = ortModule.getOnnxruntime().loadModel(modelBuffer, options);
           sessionKey = resultMap.getString("key");
           ReadableArray inputNames = resultMap.getArray("inputNames");
           ReadableArray outputNames = resultMap.getArray("outputNames");
@@ -195,7 +197,7 @@ public void onnxruntime_module_append_nnapi() throws Exception {
           Assert.fail(e.getMessage());
         }
       }
-      ortModule.dispose(sessionKey);
+      ortModule.getOnnxruntime().dispose(sessionKey);
     } finally {
       mockSession.finishMocking();
     }

js/react_native/android/src/main/java/ai/onnxruntime/reactnative/OnnxruntimeModule.java → js/react_native/android/src/main/java/ai/onnxruntime/reactnative/Onnxruntime.java

@@ -15,22 +15,18 @@
 import android.net.Uri;
 import android.os.Build;
 import android.util.Log;
-import androidx.annotation.NonNull;
 import androidx.annotation.RequiresApi;
 import com.facebook.react.bridge.Arguments;
 import com.facebook.react.bridge.LifecycleEventListener;
 import com.facebook.react.bridge.Promise;
 import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.bridge.ReactContextBaseJavaModule;
-import com.facebook.react.bridge.ReactMethod;
 import com.facebook.react.bridge.ReadableArray;
 import com.facebook.react.bridge.ReadableMap;
 import com.facebook.react.bridge.ReadableType;
 import com.facebook.react.bridge.WritableArray;
 import com.facebook.react.bridge.WritableMap;
 import com.facebook.react.modules.blob.BlobModule;
 import java.io.BufferedReader;
-import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.Reader;
@@ -46,7 +42,7 @@
 import java.util.stream.Stream;
 
 @RequiresApi(api = Build.VERSION_CODES.N)
-public class OnnxruntimeModule extends ReactContextBaseJavaModule implements LifecycleEventListener {
+public class Onnxruntime implements LifecycleEventListener {
   private static ReactApplicationContext reactContext;
 
   private static OrtEnvironment ortEnvironment = OrtEnvironment.getEnvironment();
@@ -58,27 +54,20 @@ private static String getNextSessionKey() {
     nextSessionId = nextSessionId.add(BigInteger.valueOf(1));
     return key;
   }
+  private BlobModule blobModule;
 
-  protected BlobModule blobModule;
+  public Onnxruntime(ReactApplicationContext context) { reactContext = context; }
 
-  public OnnxruntimeModule(ReactApplicationContext context) {
-    super(context);
-    reactContext = context;
-  }
-
-  @NonNull
-  @Override
-  public String getName() {
-    return "Onnxruntime";
-  }
+  protected void setBlobModule(BlobModule blobModule) { this.blobModule = blobModule; }
 
   public void checkBlobModule() {
     if (blobModule == null) {
-      blobModule = getReactApplicationContext().getNativeModule(BlobModule.class);
+      blobModule = reactContext.getNativeModule(BlobModule.class);
       if (blobModule == null) {
         throw new RuntimeException("BlobModule is not initialized");
       }
     }
+    setBlobModule(blobModule);
   }
 
   /**
@@ -90,7 +79,6 @@ public void checkBlobModule() {
    * @note the value provided to `promise` includes a key representing the session.
    *       when run() is called, the key must be passed into the first parameter.
    */
-  @ReactMethod
   public void loadModel(String uri, ReadableMap options, Promise promise) {
     try {
       WritableMap resultMap = loadModel(uri, options);
@@ -109,7 +97,6 @@ public void loadModel(String uri, ReadableMap options, Promise promise) {
    * @note the value provided to `promise` includes a key representing the session.
    *       when run() is called, the key must be passed into the first parameter.
    */
-  @ReactMethod
   public void loadModelFromBlob(ReadableMap data, ReadableMap options, Promise promise) {
     try {
       checkBlobModule();
@@ -129,7 +116,6 @@ public void loadModelFromBlob(ReadableMap data, ReadableMap options, Promise pro
    * @param key session key representing a session given at loadModel()
    * @param promise output returning back to react native js
    */
-  @ReactMethod
   public void dispose(String key, Promise promise) {
     try {
       dispose(key);
@@ -148,9 +134,9 @@ public void dispose(String key, Promise promise) {
    * @param options onnxruntime run options
    * @param promise output returning back to react native js
    */
-  @ReactMethod
   public void run(String key, ReadableMap input, ReadableArray output, ReadableMap options, Promise promise) {
     try {
+      checkBlobModule();
       WritableMap resultMap = run(key, input, output, options);
       promise.resolve(resultMap);
     } catch (Exception e) {
@@ -259,8 +245,6 @@ public WritableMap run(String key, ReadableMap input, ReadableArray output, Read
 
     RunOptions runOptions = parseRunOptions(options);
 
-    checkBlobModule();
-
     long startTime = System.currentTimeMillis();
     Map<String, OnnxTensor> feed = new HashMap<>();
     Iterator<String> iterator = ortSession.getInputNames().iterator();