Merge pull request #1813 from belemaire/android-dynamic-feature-module

Add support for Android dynamic feature modules

Author: belemaire

docs/platform-parts/container/container-integration.md

@@ -150,6 +150,38 @@ You can configure `androidConfig` in the cauldron as show below.
 }
 ```
 
+##### Android Dynamic Feature Module Support
+
+If the Android client mobile application consuming the container is keeping the container dependency in an Android [dynamic feature module](https://developer.android.com/codelabs/on-demand-dynamic-delivery), there will be issues with resources loading _(your MiniApps images won't be visible for example)_. This is because of React Native Android implementation, that is loading some resources via reflection, using the base package name of the application, instead of the package name of the dynamic module _[see Android documentation for more details](https://developer.android.com/guide/playcore/feature-delivery#resource-uri)_. For this reason we had no way but to fork React Native to update the implementation to properly handle this use case.\
+Our fork of React Native is kept in [electrode-io/react-native](https://github.com/electrode-io/react-native) repository.\
+We are only using it to publish special React Native AARs for Android, not for any iOS changes nor JS ones _(i.e we're not publishing anything to npm)_.\
+Starting with 0.63 line, we will publish custom releases of the AAR, in addition to the official versions, to include support for dynamic feature modules. These versions will have a patch number starting at 100 _(0.63.100, 0.64.100 ...)_.
+
+If you are facing this fringe scenario with dynamic feature modules, here is what can be done:
+
+1. Generate the container with a custom AAR version of React Native that includes support for Dynamic Feature Modules.\
+This can be done by supplying such a configuration to the container generator _(via --extra option or through Cauldron config)_
+
+```json
+{
+  "containerGenerator": {
+    "androidConfig": {
+      "reactNativeAarVersion": "0.64.100"
+    }
+  }
+}
+```
+
+Always use the latest custom AAR version matching the React Native version line that your miniapps(s) are using _(for example if your miniapp is using 0.63.4, you should use 0.63.100 here)_.
+
+2. Update the client application to pass the dynamic feature module package name to the container.\
+For example if the client application base package name is `com.foo` and the dynamic feature module containing the container dependency is named `bar`, the package name used for resources resolution in the dynamic feature module would be `com.foo.bar`.\
+In that case, the client application would need to call the following, prior to initializing the container.
+
+```java
+ElectrodeReactContainer.setPackageName("com.foo.bar");
+```
+
 ##### JavaScript Engine (RN 0.60 and above)
 
 Starting with React Native 0.60, the JavaScript engine is distributed separately from the React Native AAR.

ern-container-gen-android/src/AndroidGenerator.ts

@@ -38,6 +38,7 @@ import semver from 'semver';
 
 const PATH_TO_TEMPLATES_DIR = path.join(__dirname, 'templates');
 const PATH_TO_HULL_DIR = path.join(__dirname, 'hull');
+const ERN_CUSTOM_REACT_NATIVE_AAR_PATCH_VERSION = 100;
 
 export interface AndroidDependencies {
   files: string[];
@@ -333,7 +334,7 @@ You should replace "${annotationProcessorPrefix}:${dependency}" with "annotation
     mustacheView.customPermissions = _.uniq(mustacheView.customPermissions);
 
     androidDependencies.regular.push(
-      `com.walmartlabs.ern:react-native:${reactNativePlugin.version}`,
+      `com.walmartlabs.ern:react-native:${versions.reactNativeAarVersion}`,
     );
     androidDependencies.regular.push(
       `com.android.support:appcompat-v7:${versions.supportLibraryVersion}`,
@@ -354,6 +355,13 @@ You should replace "${annotationProcessorPrefix}:${dependency}" with "annotation
       )}`,
     );
 
+    if (
+      semver.patch(versions.reactNativeAarVersion) >=
+      ERN_CUSTOM_REACT_NATIVE_AAR_PATCH_VERSION
+    ) {
+      mustacheView.isCustomReactNativeAar = true;
+    }
+
     injectPluginsKaxTask.succeed(injectPluginsTaskMsg);
 
     const partialProxy = (name: string) => {

ern-container-gen-android/src/hull/lib/src/main/java/com/walmartlabs/ern/container/ElectrodeReactContainer.java

@@ -26,6 +26,7 @@
 import com.facebook.react.ReactInstanceManager;
 import com.facebook.react.ReactNativeHost;
 import com.facebook.react.ReactPackage;
+import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactContext;
 import com.facebook.react.bridge.SafeActivityStarter;
 import com.facebook.react.devsupport.interfaces.DevOptionHandler;
@@ -67,6 +68,12 @@ public class ElectrodeReactContainer {
     private ElectrodeReactContainer() {
     }
 
+{{#isCustomReactNativeAar}}
+    public static void setPackageName(String packageName) {
+        ReactApplicationContext.PACKAGE_NAME = packageName;
+    }
+{{/isCustomReactNativeAar}}
+
     public static synchronized ReactInstanceManager getReactInstanceManager() {
         throwIfNotInitialized();
         return sElectrodeReactNativeHost.getReactInstanceManager();

ern-core/src/android.ts

@@ -39,6 +39,7 @@ export interface AndroidResolvedVersions {
   gradleDistributionVersion: string;
   kotlinVersion: string;
   minSdkVersion: string;
+  reactNativeAarVersion: string;
   sourceCompatibility: string;
   supportLibraryVersion: string;
   targetCompatibility: string;
@@ -54,6 +55,7 @@ export function resolveAndroidVersions({
   gradleDistributionVersion = DEFAULT_GRADLE_DISTRIBUTION_VERSION,
   kotlinVersion = DEFAULT_KOTLIN_VERSION,
   minSdkVersion,
+  reactNativeAarVersion,
   sourceCompatibility = DEFAULT_SOURCE_COMPATIBILITY,
   supportLibraryVersion = DEFAULT_SUPPORT_LIBRARY_VERSION,
   targetCompatibility = DEFAULT_TARGET_COMPATIBILITY,
@@ -68,6 +70,7 @@ export function resolveAndroidVersions({
   gradleDistributionVersion?: string;
   kotlinVersion?: string;
   minSdkVersion?: string;
+  reactNativeAarVersion?: string;
   sourceCompatibility?: string;
   supportLibraryVersion?: string;
   targetCompatibility?: string;
@@ -80,6 +83,8 @@ export function resolveAndroidVersions({
     ? DEFAULT_MIN_SDK_VERSION_POST_RN64
     : DEFAULT_MIN_SDK_VERSION_PRE_RN64;
 
+  reactNativeAarVersion = reactNativeAarVersion ?? reactNativeVersion!;
+
   return {
     androidGradlePlugin,
     androidxAppcompactVersion,
@@ -89,6 +94,7 @@ export function resolveAndroidVersions({
     gradleDistributionVersion,
     kotlinVersion,
     minSdkVersion: resolvedMinSdkVersion,
+    reactNativeAarVersion,
     sourceCompatibility,
     supportLibraryVersion,
     targetCompatibility,

ern-core/test/android-test.ts

@@ -223,6 +223,7 @@ describe('android.js', () => {
         gradleDistributionVersion: android.DEFAULT_GRADLE_DISTRIBUTION_VERSION,
         kotlinVersion: android.DEFAULT_KOTLIN_VERSION,
         minSdkVersion: android.DEFAULT_MIN_SDK_VERSION_POST_RN64,
+        reactNativeAarVersion: '0.64.0',
         sourceCompatibility: android.DEFAULT_SOURCE_COMPATIBILITY,
         supportLibraryVersion: android.DEFAULT_SUPPORT_LIBRARY_VERSION,
         targetCompatibility: android.DEFAULT_TARGET_COMPATIBILITY,
@@ -244,6 +245,7 @@ describe('android.js', () => {
         gradleDistributionVersion: android.DEFAULT_GRADLE_DISTRIBUTION_VERSION,
         kotlinVersion: android.DEFAULT_KOTLIN_VERSION,
         minSdkVersion: android.DEFAULT_MIN_SDK_VERSION_PRE_RN64,
+        reactNativeAarVersion: '0.63.0',
         sourceCompatibility: android.DEFAULT_SOURCE_COMPATIBILITY,
         supportLibraryVersion: android.DEFAULT_SUPPORT_LIBRARY_VERSION,
         targetCompatibility: android.DEFAULT_TARGET_COMPATIBILITY,
@@ -269,6 +271,7 @@ describe('android.js', () => {
         gradleDistributionVersion: android.DEFAULT_GRADLE_DISTRIBUTION_VERSION,
         kotlinVersion: '1.4.0',
         minSdkVersion: '15',
+        reactNativeAarVersion: undefined,
         sourceCompatibility: 'VERSION_1_9',
         supportLibraryVersion: android.DEFAULT_SUPPORT_LIBRARY_VERSION,
         targetCompatibility: 'VERSION_1_9',
@@ -300,6 +303,7 @@ describe('android.js', () => {
         gradleDistributionVersion: '4.5',
         kotlinVersion: '1.4.0',
         minSdkVersion: '15',
+        reactNativeAarVersion: undefined,
         sourceCompatibility: 'VERSION_1_9',
         supportLibraryVersion: '27.0.0',
         targetCompatibility: 'VERSION_1_9',