From d292f1392ffdc6c61834390b953c5375af17d6cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateo=20Guzm=C3=A1n?= Date: Wed, 11 Jun 2025 14:05:04 -0700 Subject: [PATCH] Migrate `ReactInstanceManagerBuilder` to Kotlin (#51884) Summary: Migrate com.facebook.react.ReactInstanceManagerBuilder to Kotlin. ## Changelog: [INTERNAL] - Migrate com.facebook.react.ReactInstanceManagerBuilder to Kotlin Pull Request resolved: https://github.com/facebook/react-native/pull/51884 Test Plan: ```bash yarn test-android yarn android ``` Reviewed By: javache, mdvacca Differential Revision: D76418525 Pulled By: cortinico fbshipit-source-id: 672095719ff20526de2a8eecf82f9aabe43ac129 --- .../ReactAndroid/api/ReactAndroid.api | 63 +-- .../react/ReactInstanceManagerBuilder.java | 401 ------------------ .../react/ReactInstanceManagerBuilder.kt | 396 +++++++++++++++++ .../facebook/react/jscexecutor/JSCExecutor.kt | 2 +- 4 files changed, 429 insertions(+), 433 deletions(-) delete mode 100644 packages/react-native/ReactAndroid/src/main/java/com/facebook/react/ReactInstanceManagerBuilder.java create mode 100644 packages/react-native/ReactAndroid/src/main/java/com/facebook/react/ReactInstanceManagerBuilder.kt diff --git a/packages/react-native/ReactAndroid/api/ReactAndroid.api b/packages/react-native/ReactAndroid/api/ReactAndroid.api index a64ef7e5e42..9a3cc0c49fc 100644 --- a/packages/react-native/ReactAndroid/api/ReactAndroid.api +++ b/packages/react-native/ReactAndroid/api/ReactAndroid.api @@ -290,37 +290,38 @@ public class com/facebook/react/ReactInstanceManager { public abstract interface class com/facebook/react/ReactInstanceManager$ReactInstanceEventListener : com/facebook/react/ReactInstanceEventListener { } -public class com/facebook/react/ReactInstanceManagerBuilder { - public fun addPackage (Lcom/facebook/react/ReactPackage;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun addPackages (Ljava/util/List;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun build ()Lcom/facebook/react/ReactInstanceManager; - public fun setApplication (Landroid/app/Application;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setBridgeIdleDebugListener (Lcom/facebook/react/bridge/NotThreadSafeBridgeIdleDebugListener;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setBundleAssetName (Ljava/lang/String;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setChoreographerProvider (Lcom/facebook/react/internal/ChoreographerProvider;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setCurrentActivity (Landroid/app/Activity;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setCustomPackagerCommandHandlers (Ljava/util/Map;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setDefaultHardwareBackBtnHandler (Lcom/facebook/react/modules/core/DefaultHardwareBackBtnHandler;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setDevBundleDownloadListener (Lcom/facebook/react/devsupport/interfaces/DevBundleDownloadListener;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setDevLoadingViewManager (Lcom/facebook/react/devsupport/interfaces/DevLoadingViewManager;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setDevSupportManagerFactory (Lcom/facebook/react/devsupport/DevSupportManagerFactory;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setInitialLifecycleState (Lcom/facebook/react/common/LifecycleState;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setJSBundleFile (Ljava/lang/String;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setJSBundleLoader (Lcom/facebook/react/bridge/JSBundleLoader;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setJSExceptionHandler (Lcom/facebook/react/bridge/JSExceptionHandler;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setJSMainModulePath (Ljava/lang/String;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setJavaScriptExecutorFactory (Lcom/facebook/react/bridge/JavaScriptExecutorFactory;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setKeepActivity (Z)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setLazyViewManagersEnabled (Z)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setMinNumShakes (I)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setMinTimeLeftInFrameForNonBatchedOperationMs (I)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setPausedInDebuggerOverlayManager (Lcom/facebook/react/devsupport/interfaces/PausedInDebuggerOverlayManager;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setReactPackageTurboModuleManagerDelegateBuilder (Lcom/facebook/react/ReactPackageTurboModuleManagerDelegate$Builder;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setRedBoxHandler (Lcom/facebook/react/devsupport/interfaces/RedBoxHandler;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setRequireActivity (Z)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setSurfaceDelegateFactory (Lcom/facebook/react/common/SurfaceDelegateFactory;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setUIManagerProvider (Lcom/facebook/react/bridge/UIManagerProvider;)Lcom/facebook/react/ReactInstanceManagerBuilder; - public fun setUseDeveloperSupport (Z)Lcom/facebook/react/ReactInstanceManagerBuilder; +public final class com/facebook/react/ReactInstanceManagerBuilder { + public fun ()V + public final fun addPackage (Lcom/facebook/react/ReactPackage;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun addPackages (Ljava/util/List;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun build ()Lcom/facebook/react/ReactInstanceManager; + public final fun setApplication (Landroid/app/Application;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setBridgeIdleDebugListener (Lcom/facebook/react/bridge/NotThreadSafeBridgeIdleDebugListener;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setBundleAssetName (Ljava/lang/String;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setChoreographerProvider (Lcom/facebook/react/internal/ChoreographerProvider;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setCurrentActivity (Landroid/app/Activity;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setCustomPackagerCommandHandlers (Ljava/util/Map;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setDefaultHardwareBackBtnHandler (Lcom/facebook/react/modules/core/DefaultHardwareBackBtnHandler;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setDevBundleDownloadListener (Lcom/facebook/react/devsupport/interfaces/DevBundleDownloadListener;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setDevLoadingViewManager (Lcom/facebook/react/devsupport/interfaces/DevLoadingViewManager;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setDevSupportManagerFactory (Lcom/facebook/react/devsupport/DevSupportManagerFactory;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setInitialLifecycleState (Lcom/facebook/react/common/LifecycleState;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setJSBundleFile (Ljava/lang/String;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setJSBundleLoader (Lcom/facebook/react/bridge/JSBundleLoader;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setJSExceptionHandler (Lcom/facebook/react/bridge/JSExceptionHandler;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setJSMainModulePath (Ljava/lang/String;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setJavaScriptExecutorFactory (Lcom/facebook/react/bridge/JavaScriptExecutorFactory;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setKeepActivity (Z)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setLazyViewManagersEnabled (Z)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setMinNumShakes (I)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setMinTimeLeftInFrameForNonBatchedOperationMs (I)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setPausedInDebuggerOverlayManager (Lcom/facebook/react/devsupport/interfaces/PausedInDebuggerOverlayManager;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setReactPackageTurboModuleManagerDelegateBuilder (Lcom/facebook/react/ReactPackageTurboModuleManagerDelegate$Builder;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setRedBoxHandler (Lcom/facebook/react/devsupport/interfaces/RedBoxHandler;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setRequireActivity (Z)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setSurfaceDelegateFactory (Lcom/facebook/react/common/SurfaceDelegateFactory;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setUIManagerProvider (Lcom/facebook/react/bridge/UIManagerProvider;)Lcom/facebook/react/ReactInstanceManagerBuilder; + public final fun setUseDeveloperSupport (Z)Lcom/facebook/react/ReactInstanceManagerBuilder; } public abstract class com/facebook/react/ReactNativeHost { diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/ReactInstanceManagerBuilder.java b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/ReactInstanceManagerBuilder.java deleted file mode 100644 index da8e9f93a6a..00000000000 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/ReactInstanceManagerBuilder.java +++ /dev/null @@ -1,401 +0,0 @@ -/* - * 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. - */ - -package com.facebook.react; - -import static com.facebook.react.ReactInstanceManager.initializeSoLoaderIfNecessary; - -import android.app.Activity; -import android.app.Application; -import android.content.Context; -import androidx.annotation.Nullable; -import com.facebook.common.logging.FLog; -import com.facebook.hermes.reactexecutor.HermesExecutor; -import com.facebook.hermes.reactexecutor.HermesExecutorFactory; -import com.facebook.infer.annotation.Assertions; -import com.facebook.react.bridge.JSBundleLoader; -import com.facebook.react.bridge.JSExceptionHandler; -import com.facebook.react.bridge.JavaScriptExecutorFactory; -import com.facebook.react.bridge.NotThreadSafeBridgeIdleDebugListener; -import com.facebook.react.bridge.UIManagerProvider; -import com.facebook.react.common.LifecycleState; -import com.facebook.react.common.SurfaceDelegateFactory; -import com.facebook.react.common.annotations.internal.LegacyArchitecture; -import com.facebook.react.common.annotations.internal.LegacyArchitectureLogLevel; -import com.facebook.react.common.annotations.internal.LegacyArchitectureLogger; -import com.facebook.react.devsupport.DefaultDevSupportManagerFactory; -import com.facebook.react.devsupport.DevSupportManagerFactory; -import com.facebook.react.devsupport.interfaces.DevBundleDownloadListener; -import com.facebook.react.devsupport.interfaces.DevLoadingViewManager; -import com.facebook.react.devsupport.interfaces.DevSupportManager; -import com.facebook.react.devsupport.interfaces.PausedInDebuggerOverlayManager; -import com.facebook.react.devsupport.interfaces.RedBoxHandler; -import com.facebook.react.internal.ChoreographerProvider; -import com.facebook.react.jscexecutor.JSCExecutor; -import com.facebook.react.jscexecutor.JSCExecutorFactory; -import com.facebook.react.modules.core.DefaultHardwareBackBtnHandler; -import com.facebook.react.modules.systeminfo.AndroidInfoHelpers; -import com.facebook.react.packagerconnection.RequestHandler; -import java.util.ArrayList; -import java.util.List; -import java.util.Map; - -/** Builder class for {@link ReactInstanceManager} */ -@LegacyArchitecture(logLevel = LegacyArchitectureLogLevel.ERROR) -public class ReactInstanceManagerBuilder { - - static { - LegacyArchitectureLogger.assertLegacyArchitecture( - "ReactInstanceManagerBuilder", LegacyArchitectureLogLevel.ERROR); - } - - private static final String TAG = ReactInstanceManagerBuilder.class.getSimpleName(); - - private final List mPackages = new ArrayList<>(); - - private @Nullable String mJSBundleAssetUrl; - private @Nullable JSBundleLoader mJSBundleLoader; - private @Nullable String mJSMainModulePath; - private @Nullable NotThreadSafeBridgeIdleDebugListener mBridgeIdleDebugListener; - private @Nullable Application mApplication; - private boolean mUseDeveloperSupport; - private @Nullable DevSupportManagerFactory mDevSupportManagerFactory; - private boolean mRequireActivity; - private boolean mKeepActivity; - private @Nullable LifecycleState mInitialLifecycleState; - private @Nullable JSExceptionHandler mJSExceptionHandler; - private @Nullable Activity mCurrentActivity; - private @Nullable DefaultHardwareBackBtnHandler mDefaultHardwareBackBtnHandler; - private @Nullable RedBoxHandler mRedBoxHandler; - private boolean mLazyViewManagersEnabled; - private @Nullable DevBundleDownloadListener mDevBundleDownloadListener; - private @Nullable JavaScriptExecutorFactory mJavaScriptExecutorFactory; - private int mMinNumShakes = 1; - private int mMinTimeLeftInFrameForNonBatchedOperationMs = -1; - private @Nullable UIManagerProvider mUIManagerProvider; - private @Nullable Map mCustomPackagerCommandHandlers; - private @Nullable ReactPackageTurboModuleManagerDelegate.Builder mTMMDelegateBuilder; - private @Nullable SurfaceDelegateFactory mSurfaceDelegateFactory; - private @Nullable DevLoadingViewManager mDevLoadingViewManager; - private @Nullable ChoreographerProvider mChoreographerProvider = null; - private @Nullable PausedInDebuggerOverlayManager mPausedInDebuggerOverlayManager = null; - - /* package protected */ ReactInstanceManagerBuilder() {} - - /** Factory for desired implementation of JavaScriptExecutor. */ - public ReactInstanceManagerBuilder setJavaScriptExecutorFactory( - @Nullable JavaScriptExecutorFactory javaScriptExecutorFactory) { - mJavaScriptExecutorFactory = javaScriptExecutorFactory; - return this; - } - - public ReactInstanceManagerBuilder setUIManagerProvider(UIManagerProvider uIManagerProvider) { - mUIManagerProvider = uIManagerProvider; - return this; - } - - /** - * Name of the JS bundle file to be loaded from application's raw assets. Example: {@code - * "index.android.js"} - */ - public ReactInstanceManagerBuilder setBundleAssetName(String bundleAssetName) { - mJSBundleAssetUrl = (bundleAssetName == null ? null : "assets://" + bundleAssetName); - mJSBundleLoader = null; - return this; - } - - /** - * Path to the JS bundle file to be loaded from the file system. - * - *

Example: {@code "assets://index.android.js" or "/sdcard/main.jsbundle"} - */ - public ReactInstanceManagerBuilder setJSBundleFile(String jsBundleFile) { - if (jsBundleFile.startsWith("assets://")) { - mJSBundleAssetUrl = jsBundleFile; - mJSBundleLoader = null; - return this; - } - return setJSBundleLoader(JSBundleLoader.createFileLoader(jsBundleFile)); - } - - /** - * Bundle loader to use when setting up JS environment. This supersedes prior invocations of - * {@link #setJSBundleFile} and {@link #setBundleAssetName}. - * - *

Example: {@code JSBundleLoader.createFileLoader(application, bundleFile)} - */ - public ReactInstanceManagerBuilder setJSBundleLoader(JSBundleLoader jsBundleLoader) { - mJSBundleLoader = jsBundleLoader; - mJSBundleAssetUrl = null; - return this; - } - - /** - * Path to your app's main module on Metro. This is used when reloading JS during development. All - * paths are relative to the root folder the packager is serving files from. Examples: {@code - * "index.android"} or {@code "subdirectory/index.android"} - */ - public ReactInstanceManagerBuilder setJSMainModulePath(String jsMainModulePath) { - mJSMainModulePath = jsMainModulePath; - return this; - } - - public ReactInstanceManagerBuilder addPackage(ReactPackage reactPackage) { - mPackages.add(reactPackage); - return this; - } - - public ReactInstanceManagerBuilder addPackages(List reactPackages) { - mPackages.addAll(reactPackages); - return this; - } - - public ReactInstanceManagerBuilder setBridgeIdleDebugListener( - NotThreadSafeBridgeIdleDebugListener bridgeIdleDebugListener) { - mBridgeIdleDebugListener = bridgeIdleDebugListener; - return this; - } - - /** Required. This must be your {@code Application} instance. */ - public ReactInstanceManagerBuilder setApplication(Application application) { - mApplication = application; - return this; - } - - public ReactInstanceManagerBuilder setCurrentActivity(Activity activity) { - mCurrentActivity = activity; - return this; - } - - public ReactInstanceManagerBuilder setDefaultHardwareBackBtnHandler( - DefaultHardwareBackBtnHandler defaultHardwareBackBtnHandler) { - mDefaultHardwareBackBtnHandler = defaultHardwareBackBtnHandler; - return this; - } - - /** - * When {@code true}, developer options such as JS reloading and debugging are enabled. Note you - * still have to call {@link #showDevOptionsDialog} to show the dev menu, e.g. when the device - * Menu button is pressed. - */ - public ReactInstanceManagerBuilder setUseDeveloperSupport(boolean useDeveloperSupport) { - mUseDeveloperSupport = useDeveloperSupport; - return this; - } - - /** - * Set the custom {@link DevSupportManagerFactory}. If not set, will use {@link - * DefaultDevSupportManagerFactory}. - */ - public ReactInstanceManagerBuilder setDevSupportManagerFactory( - final DevSupportManagerFactory devSupportManagerFactory) { - mDevSupportManagerFactory = devSupportManagerFactory; - return this; - } - - /** - * When {@code false}, indicates that correct usage of React Native will NOT involve an Activity. - * For the vast majority of Android apps in the ecosystem, this will not need to change. Unless - * you really know what you're doing, you should probably not change this! - */ - public ReactInstanceManagerBuilder setRequireActivity(boolean requireActivity) { - mRequireActivity = requireActivity; - return this; - } - - public ReactInstanceManagerBuilder setKeepActivity(boolean keepActivity) { - mKeepActivity = keepActivity; - return this; - } - - /** - * When the {@link SurfaceDelegateFactory} is provided, it will be used for native modules to get - * a {@link SurfaceDelegate} to interact with the platform specific surface that they that needs - * to be rendered in. For mobile platform this is default to be null so that these modules will - * need to provide a default surface delegate. One example of such native module is LogBoxModule, - * which is rendered in mobile platform with LogBoxDialog, while in VR platform with custom layer - * provided by runtime. - */ - public ReactInstanceManagerBuilder setSurfaceDelegateFactory( - @Nullable final SurfaceDelegateFactory surfaceDelegateFactory) { - mSurfaceDelegateFactory = surfaceDelegateFactory; - return this; - } - - /** Sets the Dev Loading View Manager. */ - public ReactInstanceManagerBuilder setDevLoadingViewManager( - @Nullable DevLoadingViewManager devLoadingViewManager) { - mDevLoadingViewManager = devLoadingViewManager; - return this; - } - - public ReactInstanceManagerBuilder setPausedInDebuggerOverlayManager( - @Nullable PausedInDebuggerOverlayManager pausedInDebuggerOverlayManager) { - mPausedInDebuggerOverlayManager = pausedInDebuggerOverlayManager; - return this; - } - - /** - * Sets the initial lifecycle state of the host. For example, if the host is already resumed at - * creation time, we wouldn't expect an onResume call until we get an onPause call. - */ - public ReactInstanceManagerBuilder setInitialLifecycleState( - LifecycleState initialLifecycleState) { - mInitialLifecycleState = initialLifecycleState; - return this; - } - - /** - * Set the exception handler for all native module calls. If not set, the default {@link - * DevSupportManager} will be used, which shows a redbox in dev mode and rethrows (crashes the - * app) in prod mode. - */ - public ReactInstanceManagerBuilder setJSExceptionHandler(@Nullable JSExceptionHandler handler) { - mJSExceptionHandler = handler; - return this; - } - - public ReactInstanceManagerBuilder setRedBoxHandler(@Nullable RedBoxHandler redBoxHandler) { - mRedBoxHandler = redBoxHandler; - return this; - } - - public ReactInstanceManagerBuilder setLazyViewManagersEnabled(boolean lazyViewManagersEnabled) { - mLazyViewManagersEnabled = lazyViewManagersEnabled; - return this; - } - - public ReactInstanceManagerBuilder setDevBundleDownloadListener( - @Nullable DevBundleDownloadListener listener) { - mDevBundleDownloadListener = listener; - return this; - } - - public ReactInstanceManagerBuilder setMinNumShakes(int minNumShakes) { - mMinNumShakes = minNumShakes; - return this; - } - - public ReactInstanceManagerBuilder setMinTimeLeftInFrameForNonBatchedOperationMs( - int minTimeLeftInFrameForNonBatchedOperationMs) { - mMinTimeLeftInFrameForNonBatchedOperationMs = minTimeLeftInFrameForNonBatchedOperationMs; - return this; - } - - public ReactInstanceManagerBuilder setCustomPackagerCommandHandlers( - Map customPackagerCommandHandlers) { - mCustomPackagerCommandHandlers = customPackagerCommandHandlers; - return this; - } - - public ReactInstanceManagerBuilder setReactPackageTurboModuleManagerDelegateBuilder( - @Nullable ReactPackageTurboModuleManagerDelegate.Builder builder) { - mTMMDelegateBuilder = builder; - return this; - } - - public ReactInstanceManagerBuilder setChoreographerProvider( - @Nullable ChoreographerProvider choreographerProvider) { - mChoreographerProvider = choreographerProvider; - return this; - } - - /** - * Instantiates a new {@link ReactInstanceManager}. Before calling {@code build}, the following - * must be called: - * - *

    - *
  • {@link #setApplication} - *
  • {@link #setCurrentActivity} if the activity has already resumed - *
  • {@link #setDefaultHardwareBackBtnHandler} if the activity has already resumed - *
  • {@link #setJSBundleFile} or {@link #setJSMainModulePath} - *
- */ - public ReactInstanceManager build() { - Assertions.assertNotNull( - mApplication, "Application property has not been set with this builder"); - - if (mInitialLifecycleState == LifecycleState.RESUMED) { - Assertions.assertNotNull( - mCurrentActivity, "Activity needs to be set if initial lifecycle state is resumed"); - } - - Assertions.assertCondition( - mUseDeveloperSupport || mJSBundleAssetUrl != null || mJSBundleLoader != null, - "JS Bundle File or Asset URL has to be provided when dev support is disabled"); - - Assertions.assertCondition( - mJSMainModulePath != null || mJSBundleAssetUrl != null || mJSBundleLoader != null, - "Either MainModulePath or JS Bundle File needs to be provided"); - - // We use the name of the device and the app for debugging & metrics - //noinspection ConstantConditions - String appName = mApplication.getPackageName(); - String deviceName = AndroidInfoHelpers.getFriendlyDeviceName(); - - return new ReactInstanceManager( - mApplication, - mCurrentActivity, - mDefaultHardwareBackBtnHandler, - mJavaScriptExecutorFactory == null - ? getDefaultJSExecutorFactory(appName, deviceName, mApplication.getApplicationContext()) - : mJavaScriptExecutorFactory, - (mJSBundleLoader == null && mJSBundleAssetUrl != null) - ? JSBundleLoader.createAssetLoader( - mApplication, mJSBundleAssetUrl, false /*Asynchronous*/) - : mJSBundleLoader, - mJSMainModulePath, - mPackages, - mUseDeveloperSupport, - mDevSupportManagerFactory == null - ? new DefaultDevSupportManagerFactory() - : mDevSupportManagerFactory, - mRequireActivity, - mKeepActivity, - mBridgeIdleDebugListener, - Assertions.assertNotNull(mInitialLifecycleState, "Initial lifecycle state was not set"), - mJSExceptionHandler, - mRedBoxHandler, - mLazyViewManagersEnabled, - mDevBundleDownloadListener, - mMinNumShakes, - mMinTimeLeftInFrameForNonBatchedOperationMs, - mUIManagerProvider, - mCustomPackagerCommandHandlers, - mTMMDelegateBuilder, - mSurfaceDelegateFactory, - mDevLoadingViewManager, - mChoreographerProvider, - mPausedInDebuggerOverlayManager); - } - - private JavaScriptExecutorFactory getDefaultJSExecutorFactory( - String appName, String deviceName, Context applicationContext) { - - initializeSoLoaderIfNecessary(applicationContext); - // Hermes has been enabled by default in OSS since React Native 0.70. - // Here we attempt to load Hermes first, and fallback to JSC if we can't resolve the library. - try { - HermesExecutor.loadLibrary(); - return new HermesExecutorFactory(); - } catch (UnsatisfiedLinkError ignoredHermesError) { - try { - JSCExecutor.loadLibrary(); - return new JSCExecutorFactory(appName, deviceName); - } catch (UnsatisfiedLinkError jscError) { - FLog.e( - TAG, - "Unable to load neither the Hermes nor the JSC native library. " - + "Your application is not built correctly and will fail to execute"); - if (jscError.getMessage().contains("__cxa_bad_typeid")) { - throw jscError; - } - return null; - } - } - } -} diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/ReactInstanceManagerBuilder.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/ReactInstanceManagerBuilder.kt new file mode 100644 index 00000000000..79f8cda2aa2 --- /dev/null +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/ReactInstanceManagerBuilder.kt @@ -0,0 +1,396 @@ +/* + * 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. + */ + +package com.facebook.react + +import android.app.Activity +import android.app.Application +import android.content.Context +import com.facebook.common.logging.FLog +import com.facebook.hermes.reactexecutor.HermesExecutor +import com.facebook.hermes.reactexecutor.HermesExecutorFactory +import com.facebook.react.ReactInstanceManager.initializeSoLoaderIfNecessary +import com.facebook.react.bridge.JSBundleLoader +import com.facebook.react.bridge.JSExceptionHandler +import com.facebook.react.bridge.JavaScriptExecutorFactory +import com.facebook.react.bridge.NotThreadSafeBridgeIdleDebugListener +import com.facebook.react.bridge.UIManagerProvider +import com.facebook.react.common.LifecycleState +import com.facebook.react.common.SurfaceDelegateFactory +import com.facebook.react.common.annotations.internal.LegacyArchitecture +import com.facebook.react.common.annotations.internal.LegacyArchitectureLogLevel +import com.facebook.react.common.annotations.internal.LegacyArchitectureLogger +import com.facebook.react.devsupport.DefaultDevSupportManagerFactory +import com.facebook.react.devsupport.DevSupportManagerFactory +import com.facebook.react.devsupport.interfaces.DevBundleDownloadListener +import com.facebook.react.devsupport.interfaces.DevLoadingViewManager +import com.facebook.react.devsupport.interfaces.DevSupportManager +import com.facebook.react.devsupport.interfaces.PausedInDebuggerOverlayManager +import com.facebook.react.devsupport.interfaces.RedBoxHandler +import com.facebook.react.internal.ChoreographerProvider +import com.facebook.react.modules.core.DefaultHardwareBackBtnHandler +import com.facebook.react.modules.systeminfo.AndroidInfoHelpers +import com.facebook.react.packagerconnection.RequestHandler + +/** Builder class for [ReactInstanceManager]. */ +@LegacyArchitecture(logLevel = LegacyArchitectureLogLevel.ERROR) +public class ReactInstanceManagerBuilder { + private val packages: MutableList = mutableListOf() + private var jsBundleAssetUrl: String? = null + private var jsBundleLoader: JSBundleLoader? = null + private var jsMainModulePath: String? = null + private var bridgeIdleDebugListener: NotThreadSafeBridgeIdleDebugListener? = null + private var application: Application? = null + private var useDeveloperSupport = false + private var devSupportManagerFactory: DevSupportManagerFactory? = null + private var requireActivity = false + private var keepActivity = false + private var initialLifecycleState: LifecycleState? = null + private var jsExceptionHandler: JSExceptionHandler? = null + private var currentActivity: Activity? = null + private var defaultHardwareBackBtnHandler: DefaultHardwareBackBtnHandler? = null + private var redBoxHandler: RedBoxHandler? = null + private var lazyViewManagersEnabled = false + private var devBundleDownloadListener: DevBundleDownloadListener? = null + private var javaScriptExecutorFactory: JavaScriptExecutorFactory? = null + private var minNumShakes = 1 + private var minTimeLeftInFrameForNonBatchedOperationMs = -1 + private var uiManagerProvider: UIManagerProvider? = null + private var customPackagerCommandHandlers: Map? = null + private var tmmDelegateBuilder: ReactPackageTurboModuleManagerDelegate.Builder? = null + private var surfaceDelegateFactory: SurfaceDelegateFactory? = null + private var devLoadingViewManager: DevLoadingViewManager? = null + private var choreographerProvider: ChoreographerProvider? = null + private var pausedInDebuggerOverlayManager: PausedInDebuggerOverlayManager? = null + + /** Factory for desired implementation of JavaScriptExecutor. */ + public fun setJavaScriptExecutorFactory( + javaScriptExecutorFactory: JavaScriptExecutorFactory? + ): ReactInstanceManagerBuilder { + this.javaScriptExecutorFactory = javaScriptExecutorFactory + return this + } + + public fun setUIManagerProvider( + uiManagerProvider: UIManagerProvider? + ): ReactInstanceManagerBuilder { + this.uiManagerProvider = uiManagerProvider + return this + } + + /** + * Name of the JS bundle file to be loaded from application's raw assets. + * + * Example: `"index.android.js"` + */ + public fun setBundleAssetName(bundleAssetName: String?): ReactInstanceManagerBuilder { + jsBundleAssetUrl = if (bundleAssetName == null) null else "assets://$bundleAssetName" + jsBundleLoader = null + return this + } + + /** + * Path to the JS bundle file to be loaded from the file system. + * + * Example: `"assets://index.android.js"` or `"/sdcard/main.jsbundle"` + */ + public fun setJSBundleFile(jsBundleFile: String): ReactInstanceManagerBuilder { + if (jsBundleFile.startsWith("assets://")) { + jsBundleAssetUrl = jsBundleFile + jsBundleLoader = null + return this + } + return setJSBundleLoader(JSBundleLoader.createFileLoader(jsBundleFile)) + } + + /** + * Bundle loader to use when setting up JS environment. This supersedes prior invocations of + * [setJSBundleFile] and [setBundleAssetName]. + * + * Example: `JSBundleLoader.createFileLoader(application, bundleFile)` + */ + public fun setJSBundleLoader(jsBundleLoader: JSBundleLoader): ReactInstanceManagerBuilder { + this.jsBundleLoader = jsBundleLoader + jsBundleAssetUrl = null + return this + } + + /** + * Path to your app's main module on Metro. This is used when reloading JS during development. All + * paths are relative to the root folder the packager is serving files from. Examples: + * `"index.android"` or `"subdirectory/index.android"` + */ + public fun setJSMainModulePath(jsMainModulePath: String): ReactInstanceManagerBuilder { + this.jsMainModulePath = jsMainModulePath + return this + } + + public fun addPackage(reactPackage: ReactPackage): ReactInstanceManagerBuilder { + packages.add(reactPackage) + return this + } + + public fun addPackages(reactPackages: List): ReactInstanceManagerBuilder { + packages.addAll(reactPackages) + return this + } + + public fun setBridgeIdleDebugListener( + bridgeIdleDebugListener: NotThreadSafeBridgeIdleDebugListener + ): ReactInstanceManagerBuilder { + this.bridgeIdleDebugListener = bridgeIdleDebugListener + return this + } + + /** Required. This must be your `Application` instance. */ + public fun setApplication(application: Application): ReactInstanceManagerBuilder { + this.application = application + return this + } + + public fun setCurrentActivity(activity: Activity): ReactInstanceManagerBuilder { + currentActivity = activity + return this + } + + public fun setDefaultHardwareBackBtnHandler( + defaultHardwareBackBtnHandler: DefaultHardwareBackBtnHandler + ): ReactInstanceManagerBuilder { + this.defaultHardwareBackBtnHandler = defaultHardwareBackBtnHandler + return this + } + + /** + * When `true`, developer options such as JS reloading and debugging are enabled. Note you still + * have to call [showDevOptionsDialog] to show the dev menu, e.g. when the device Menu button is + * pressed. + */ + public fun setUseDeveloperSupport(useDeveloperSupport: Boolean): ReactInstanceManagerBuilder { + this.useDeveloperSupport = useDeveloperSupport + return this + } + + /** + * Set the custom [DevSupportManagerFactory]. If not set, will use + * [DefaultDevSupportManagerFactory]. + */ + public fun setDevSupportManagerFactory( + devSupportManagerFactory: DevSupportManagerFactory? + ): ReactInstanceManagerBuilder { + this.devSupportManagerFactory = devSupportManagerFactory + return this + } + + /** + * When `false`, indicates that correct usage of React Native will NOT involve an Activity. For + * the vast majority of Android apps in the ecosystem, this will not need to change. Unless you + * really know what you're doing, you should probably not change this! + */ + public fun setRequireActivity(requireActivity: Boolean): ReactInstanceManagerBuilder { + this.requireActivity = requireActivity + return this + } + + public fun setKeepActivity(keepActivity: Boolean): ReactInstanceManagerBuilder { + this.keepActivity = keepActivity + return this + } + + /** + * When the [SurfaceDelegateFactory] is provided, it will be used for native modules to get a + * [SurfaceDelegate] to interact with the platform specific surface that they that needs to be + * rendered in. For mobile platform this is default to be null so that these modules will need to + * provide a default surface delegate. One example of such native module is [LogBoxModule], which + * is rendered in mobile platform with [LogBoxDialog], while in VR platform with custom layer + * provided by runtime. + */ + public fun setSurfaceDelegateFactory( + surfaceDelegateFactory: SurfaceDelegateFactory? + ): ReactInstanceManagerBuilder { + this.surfaceDelegateFactory = surfaceDelegateFactory + return this + } + + /** Sets the Dev Loading View Manager. */ + public fun setDevLoadingViewManager( + devLoadingViewManager: DevLoadingViewManager? + ): ReactInstanceManagerBuilder { + this.devLoadingViewManager = devLoadingViewManager + return this + } + + public fun setPausedInDebuggerOverlayManager( + pausedInDebuggerOverlayManager: PausedInDebuggerOverlayManager? + ): ReactInstanceManagerBuilder { + this.pausedInDebuggerOverlayManager = pausedInDebuggerOverlayManager + return this + } + + /** + * Sets the initial lifecycle state of the host. For example, if the host is already resumed at + * creation time, we wouldn't expect an onResume call until we get an onPause call. + */ + public fun setInitialLifecycleState( + initialLifecycleState: LifecycleState + ): ReactInstanceManagerBuilder { + this.initialLifecycleState = initialLifecycleState + return this + } + + /** + * Set the exception handler for all native module calls. If not set, the default + * [DevSupportManager] will be used, which shows a redbox in dev mode and rethrows (crashes the + * app) in prod mode. + */ + public fun setJSExceptionHandler(handler: JSExceptionHandler?): ReactInstanceManagerBuilder { + jsExceptionHandler = handler + return this + } + + public fun setRedBoxHandler(redBoxHandler: RedBoxHandler?): ReactInstanceManagerBuilder { + this.redBoxHandler = redBoxHandler + return this + } + + public fun setLazyViewManagersEnabled( + lazyViewManagersEnabled: Boolean + ): ReactInstanceManagerBuilder { + this.lazyViewManagersEnabled = lazyViewManagersEnabled + return this + } + + public fun setDevBundleDownloadListener( + listener: DevBundleDownloadListener? + ): ReactInstanceManagerBuilder { + devBundleDownloadListener = listener + return this + } + + public fun setMinNumShakes(minNumShakes: Int): ReactInstanceManagerBuilder { + this.minNumShakes = minNumShakes + return this + } + + public fun setMinTimeLeftInFrameForNonBatchedOperationMs( + minTimeLeftInFrameForNonBatchedOperationMs: Int + ): ReactInstanceManagerBuilder { + this.minTimeLeftInFrameForNonBatchedOperationMs = minTimeLeftInFrameForNonBatchedOperationMs + return this + } + + public fun setCustomPackagerCommandHandlers( + customPackagerCommandHandlers: Map + ): ReactInstanceManagerBuilder { + this.customPackagerCommandHandlers = customPackagerCommandHandlers + return this + } + + public fun setReactPackageTurboModuleManagerDelegateBuilder( + builder: ReactPackageTurboModuleManagerDelegate.Builder? + ): ReactInstanceManagerBuilder { + tmmDelegateBuilder = builder + return this + } + + public fun setChoreographerProvider( + choreographerProvider: ChoreographerProvider? + ): ReactInstanceManagerBuilder { + this.choreographerProvider = choreographerProvider + return this + } + + /** + * Instantiates a new [ReactInstanceManager]. Before calling [build], the following must be + * called: + * * [setApplication] + * * [setCurrentActivity] if the activity has already resumed + * * [setDefaultHardwareBackBtnHandler] if the activity has already resumed + * * [setJSBundleFile] or [setJSMainModulePath] + */ + public fun build(): ReactInstanceManager { + val application = + checkNotNull(this.application) { "Application property has not been set with this builder" } + + if (initialLifecycleState == LifecycleState.RESUMED) { + checkNotNull(currentActivity) { + "Activity needs to be set if initial lifecycle state is resumed" + } + } + + check(useDeveloperSupport || jsBundleAssetUrl != null || jsBundleLoader != null) { + "JS Bundle File or Asset URL has to be provided when dev support is disabled" + } + + check(jsMainModulePath != null || jsBundleAssetUrl != null || jsBundleLoader != null) { + "Either MainModulePath or JS Bundle File needs to be provided" + } + + // We use the name of the device and the app for debugging & metrics + val appName = application.packageName + val deviceName: String = AndroidInfoHelpers.getFriendlyDeviceName() + val safeJSBundleAssetUrl = jsBundleAssetUrl + + return ReactInstanceManager( + application, + currentActivity, + defaultHardwareBackBtnHandler, + javaScriptExecutorFactory + ?: getDefaultJSExecutorFactory(appName, deviceName, application.applicationContext), + if ((jsBundleLoader == null && safeJSBundleAssetUrl != null)) + JSBundleLoader.createAssetLoader( + application, safeJSBundleAssetUrl, loadSynchronously = false) + else jsBundleLoader, + jsMainModulePath, + packages, + useDeveloperSupport, + devSupportManagerFactory ?: DefaultDevSupportManagerFactory(), + requireActivity, + keepActivity, + bridgeIdleDebugListener, + checkNotNull(initialLifecycleState) { "Initial lifecycle state was not set" }, + jsExceptionHandler, + redBoxHandler, + lazyViewManagersEnabled, + devBundleDownloadListener, + minNumShakes, + minTimeLeftInFrameForNonBatchedOperationMs, + uiManagerProvider, + customPackagerCommandHandlers, + tmmDelegateBuilder, + surfaceDelegateFactory, + devLoadingViewManager, + choreographerProvider, + pausedInDebuggerOverlayManager) + } + + private fun getDefaultJSExecutorFactory( + appName: String, + deviceName: String, + applicationContext: Context + ): JavaScriptExecutorFactory? { + ReactInstanceManager.initializeSoLoaderIfNecessary(applicationContext) + // Hermes has been enabled by default in OSS since React Native 0.70. + try { + HermesExecutor.loadLibrary() + return HermesExecutorFactory() + } catch (error: UnsatisfiedLinkError) { + FLog.e( + TAG, + "Unable to load Hermes. Your application is not built correctly and will fail to execute") + return null + } + } + + private companion object { + init { + LegacyArchitectureLogger.assertLegacyArchitecture( + "ReactInstanceManagerBuilder", LegacyArchitectureLogLevel.ERROR) + } + + private val TAG: String = ReactInstanceManagerBuilder::class.java.simpleName + } +} diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/jscexecutor/JSCExecutor.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/jscexecutor/JSCExecutor.kt index 2ce29108d4c..d0b3a466b80 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/jscexecutor/JSCExecutor.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/jscexecutor/JSCExecutor.kt @@ -24,7 +24,7 @@ public class JSCExecutor internal constructor(jscConfig: ReadableNativeMap) : return "JSCExecutor" } - private companion object { + internal companion object { init { loadLibrary() LegacyArchitectureLogger.assertLegacyArchitecture("JSCExecutor")