feat: read main activity from AndroidManifest.xml automatically (#1967

)

* feat: read main activity from `AndroidManifest.xml` automatically

* test: update e2e snaphosts

* test: add test scenario for main activity as class name

* chore: types cleanup

* chore: code cleaning

* fix: tests

__e2e__/__snapshots__/config.test.ts.snap

@@ -65,7 +65,8 @@ exports[`shows up current config without unnecessary output 1`] = `
     "android": {
       "sourceDir": "<<REPLACED_ROOT>>/TestProject/android",
       "appName": "app",
-      "packageName": "com.testproject"
+      "packageName": "com.testproject",
+      "mainActivity": ".MainActivity"
     }
   }
 }

docs/platforms.md

@@ -84,6 +84,7 @@ type AndroidProjectConfig = {
   sourceDir: string;
   appName: string;
   packageName: string;
+  mainActivity: string;
   dependencyConfiguration?: string;
   watchModeCommandParams: string;
 };

packages/cli-config/src/__tests__/index-test.ts

@@ -406,12 +406,28 @@ test('should convert project sourceDir relative path to absolute', () => {
       <manifest xmlns:android="http://schemas.android.com/apk/res/android"
         xmlns:tools="http://schemas.android.com/tools"
         package="com.coinbase.android">
+        <application android:name=".MainApplication">
+          <activity android:name=".MainActivity">
+            <intent-filter>
+              <action android:name="android.intent.action.MAIN" />
+              <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+          </activity>
+        </application>
       </manifest>
     `,
     'android2/AndroidManifest.xml': `
       <manifest xmlns:android="http://schemas.android.com/apk/res/android"
         xmlns:tools="http://schemas.android.com/tools"
         package="com.coinbase.android">
+        <application android:name=".MainApplication">
+          <activity android:name=".MainActivity">
+            <intent-filter>
+              <action android:name="android.intent.action.MAIN" />
+              <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+          </activity>
+        </application>
       </manifest>
     `,
   });

packages/cli-platform-android/package.json

@@ -10,6 +10,7 @@
     "@react-native-community/cli-tools": "12.0.0-alpha.10",
     "chalk": "^4.1.2",
     "execa": "^5.0.0",
+    "fast-xml-parser": "^4.2.4",
     "glob": "^7.1.3",
     "logkitty": "^0.7.1"
   },

packages/cli-platform-android/src/commands/runAndroid/__tests__/runOnAllDevices.test.ts

@@ -67,6 +67,7 @@ describe('--appFolder', () => {
     appName: 'app',
     packageName: 'com.test',
     sourceDir: '/android',
+    mainActivity: '.MainActivity',
   };
   beforeEach(() => {
     jest.clearAllMocks();

packages/cli-platform-android/src/commands/runAndroid/index.ts

@@ -105,7 +105,11 @@ async function runAndroid(_argv: Array<string>, config: Config, args: Flags) {
     }
   }
 
-  const androidProject = getAndroidProject(config);
+  let androidProject = getAndroidProject(config);
+
+  if (args.mainActivity) {
+    androidProject.mainActivity = args.mainActivity;
+  }
 
   return buildAndRun(args, androidProject);
 }
@@ -294,12 +298,8 @@ function installAndLaunchOnDevice(
     androidProject,
     selectedTask,
   );
-  tryLaunchAppOnDevice(
-    selectedDevice,
-    androidProject.packageName,
-    adbPath,
-    args,
-  );
+
+  tryLaunchAppOnDevice(selectedDevice, androidProject, adbPath, args);
 }
 
 export default {
@@ -338,7 +338,6 @@ export default {
     {
       name: '--main-activity <string>',
       description: 'Name of the activity to start',
-      default: 'MainActivity',
     },
     {
       name: '--deviceId <string>',

packages/cli-platform-android/src/commands/runAndroid/runOnAllDevices.ts

@@ -110,7 +110,7 @@ async function runOnAllDevices(
       if (args.binaryPath && device) {
         tryInstallAppOnDevice(args, adbPath, device, androidProject);
       }
-      tryLaunchAppOnDevice(device, androidProject.packageName, adbPath, args);
+      tryLaunchAppOnDevice(device, androidProject, adbPath, args);
     },
   );
 }

packages/cli-platform-android/src/commands/runAndroid/tryLaunchAppOnDevice.ts

@@ -7,23 +7,25 @@
  */
 
 import execa from 'execa';
-import {Flags} from '.';
+import {AndroidProject, Flags} from '.';
 import {logger, CLIError} from '@react-native-community/cli-tools';
 
 function tryLaunchAppOnDevice(
   device: string | void,
-  packageName: string,
+  androidProject: AndroidProject,
   adbPath: string,
   args: Flags,
 ) {
   const {appId, appIdSuffix} = args;
+  const {packageName, mainActivity} = androidProject;
+
   const packageNameWithSuffix = [appId || packageName, appIdSuffix]
     .filter(Boolean)
     .join('.');
 
-  const activityToLaunch = args.mainActivity.includes('.')
-    ? args.mainActivity
-    : [packageName, args.mainActivity].filter(Boolean).join('.');
+  const activityToLaunch = mainActivity.includes('.')
+    ? mainActivity
+    : [packageName, mainActivity].filter(Boolean).join('.');
 
   try {
     // Here we're using the same flags as Android Studio to launch the app

packages/cli-platform-android/src/config/__fixtures__/android.ts

@@ -22,6 +22,14 @@ const appBuildGradle = fs.readFileSync(
   path.join(__dirname, './files/appbuild.gradle'),
 );
 
+const fewActivitiesManifest = fs.readFileSync(
+  path.join(__dirname, './files/AndroidManifest-few-activities.xml'),
+);
+
+const classNameManifest = fs.readFileSync(
+  path.join(__dirname, './files/AndroidManifest-className.xml'),
+);
+
 function generateValidFileStructureForLib(classFileName: string) {
   return {
     'build.gradle': buildGradle,
@@ -278,3 +286,15 @@ export const findPackagesClassNameJavaNotValid = [
   }
   `,
 ];
+
+export const fewActivities = {
+  src: {
+    'AndroidManifest.xml': fewActivitiesManifest,
+  },
+};
+
+export const className = {
+  src: {
+    'AndroidManifest.xml': classNameManifest,
+  },
+};

packages/cli-platform-android/src/config/__fixtures__/files/AndroidManifest-className.xml

@@ -0,0 +1,12 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.some.example">
+	<uses-permission android:name="android.permission.INTERNET" />
+
+	<application android:name=".MainApplication">
+		<activity android:name="com.example.ExampleAppActivity">
+			<intent-filter>
+				<action android:name="android.intent.action.MAIN" />
+				<category android:name="android.intent.category.LAUNCHER" />
+			</intent-filter>
+		</activity>
+	</application>
+</manifest>

packages/cli-platform-android/src/config/__fixtures__/files/AndroidManifest-few-activities.xml

@@ -0,0 +1,20 @@
+<manifest
+  xmlns:android="http://schemas.android.com/apk/res/android">
+  <application android:name=".ExampleApplication">
+    <activity android:name=".ExampleAppActivity">
+      <intent-filter>
+        <action android:name="android.intent.action.MAIN" />
+        <category android:name="android.intent.category.LAUNCHER" />
+        <category android:name="android.intent.category.LEANBACK_LAUNCHER" />
+      </intent-filter>
+      <intent-filter>
+        <action android:name="android.intent.action.VIEW" />
+        <category android:name="android.intent.category.DEFAULT" />
+        <category android:name="android.intent.category.BROWSABLE" />
+        <data android:scheme="rntester" android:host="example" />
+      </intent-filter>
+    </activity>
+    <activity android:name="com.facebook.react.devsupport.DevSettingsActivity" android:exported="false"/>
+  </application>
+  </queries>
+</manifest>

packages/cli-platform-android/src/config/__fixtures__/files/AndroidManifest.xml

@@ -1,4 +1,12 @@
-<manifest
-  xmlns:android="http://schemas.android.com/apk/res/android"
-  package="com.some.example">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.some.example">
+	<uses-permission android:name="android.permission.INTERNET" />
+
+	<application android:name=".MainApplication">
+		<activity android:name=".MainActivity">
+			<intent-filter>
+				<action android:name="android.intent.action.MAIN" />
+				<category android:name="android.intent.category.LAUNCHER" />
+			</intent-filter>
+		</activity>
+	</application>
 </manifest>

packages/cli-platform-android/src/config/__tests__/__snapshots__/getProjectConfig.test.ts.snap

@@ -4,6 +4,7 @@ exports[`android::getProjectConfig returns an object with android project config
 Object {
   "appName": "",
   "dependencyConfiguration": undefined,
+  "mainActivity": ".MainActivity",
   "packageName": "com.some.example",
   "sourceDir": "/flat/android",
   "unstable_reactLegacyComponentNames": undefined,
@@ -15,6 +16,7 @@ exports[`android::getProjectConfig returns an object with android project config
 Object {
   "appName": "",
   "dependencyConfiguration": undefined,
+  "mainActivity": ".MainActivity",
   "packageName": "com.some.example",
   "sourceDir": "/multiple/android",
   "unstable_reactLegacyComponentNames": undefined,
@@ -26,6 +28,7 @@ exports[`android::getProjectConfig returns an object with android project config
 Object {
   "appName": "app",
   "dependencyConfiguration": undefined,
+  "mainActivity": ".MainActivity",
   "packageName": "com.some.example",
   "sourceDir": "/nested/android",
   "unstable_reactLegacyComponentNames": undefined,

packages/cli-platform-android/src/config/__tests__/getMainActivity.test.ts

@@ -0,0 +1,60 @@
+import findManifest from '../findManifest';
+import getMainActivity from '../getMainActivity';
+import * as mocks from '../__fixtures__/android';
+
+jest.mock('path');
+jest.mock('fs');
+
+const fs = require('fs');
+
+describe('android::getMainActivity', () => {
+  beforeAll(() => {
+    fs.__setMockFilesystem({
+      empty: {},
+      valid: {
+        android: {
+          app: mocks.valid,
+        },
+      },
+      className: {
+        android: {
+          app: mocks.className,
+        },
+      },
+      few: {
+        android: {
+          app: mocks.fewActivities,
+        },
+      },
+    });
+  });
+
+  it('returns main activity if file exists in the folder', () => {
+    const manifestPath = findManifest('/valid');
+    const manifest = getMainActivity(manifestPath || '');
+    expect(manifest).not.toBeNull();
+    expect(typeof manifest).toBe('string');
+    expect(manifest).toBe('.MainActivity');
+  });
+
+  it('returns main activity if there is few activities', () => {
+    const manifestPath = findManifest('/few');
+    const mainActivity = getMainActivity(manifestPath || '');
+    expect(mainActivity).not.toBeNull();
+    expect(typeof mainActivity).toBe('string');
+    expect(mainActivity).toBe('.ExampleAppActivity');
+  });
+
+  it('returns main activity if it is class name', () => {
+    const manifestPath = findManifest('/className');
+    const mainActivity = getMainActivity(manifestPath || '');
+    expect(mainActivity).not.toBeNull();
+    expect(typeof mainActivity).toBe('string');
+    expect(mainActivity).toBe('com.example.ExampleAppActivity');
+  });
+
+  it('returns null if file do not exist', () => {
+    const fakeManifestPath = findManifest('/empty');
+    expect(getMainActivity(fakeManifestPath || '')).toBeNull();
+  });
+});