refactor: unify spawn verbose output (#259)

* refactor: unify spawn verbose output

* changeset

* fix tests; improve error handling

Author: thymikee

.changeset/cuddly-olives-travel.md

@@ -0,0 +1,8 @@
+---
+'@rnef/platform-apple-helpers': patch
+'@rnef/plugin-brownfield-ios': patch
+'@rnef/platform-android': patch
+'@rnef/tools': patch
+---
+
+refactor: unify spawn verbose output

packages/platform-android/src/lib/commands/buildAndroid/__tests__/buildAndroid.test.ts

@@ -67,7 +67,6 @@ test('buildAndroid runs gradle build with correct configuration for debug and ou
   await buildAndroid(androidProject, { ...args, aab: true });
 
   expect(spawn).toBeCalledWith('./gradlew', ['app:bundleDebug', '-x', 'lint'], {
-    stdio: !tools.isInteractive() ? 'inherit' : 'pipe',
     cwd: '/android',
   });
   expect(spinnerMock.stop).toBeCalledWith(
@@ -89,9 +88,6 @@ test('buildAndroid fails gracefully when gradle errors', async () => {
   expect(spawn).toBeCalledWith(
     './gradlew',
     ['app:assembleDebug', '-x', 'lint'],
-    {
-      stdio: !tools.isInteractive() ? 'inherit' : 'pipe',
-      cwd: '/android',
-    }
+    { cwd: '/android' }
   );
 });

packages/platform-android/src/lib/commands/generateKeystore.ts

@@ -96,7 +96,7 @@ async function runKeytool(androidProject: AndroidProjectConfig, args: Flags) {
       `Failed to generate keystore. Please try manually by following instructions at: ${color.cyan(
         'https://reactnative.dev/docs/signed-apk-android'
       )}`,
-      { cause: (error as SubprocessError).cause }
+      { cause: (error as SubprocessError).stderr }
     );
   }
 }

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

@@ -307,7 +307,8 @@ test.each([['release'], ['debug'], ['staging']])(
       { ...androidProject },
       { ...args, variant },
       '/',
-      undefined
+      undefined,
+      { extraSources: [], ignorePaths: [] }
     );
 
     expect(tools.outro).toBeCalledWith('Success 🎉.');
@@ -327,7 +328,7 @@ test.each([['release'], ['debug'], ['staging']])(
         '-PreactNativeDevServerPort=8081',
         '-PreactNativeArchitectures=arm64-v8a,armeabi-v7a',
       ],
-      { stdio: !tools.isInteractive() ? 'inherit' : 'pipe', cwd: '/android' }
+      { cwd: '/android' }
     );
 
     // launches com.test app with MainActivity on emulator-5552
@@ -336,8 +337,7 @@ test.each([['release'], ['debug'], ['staging']])(
       expect.arrayContaining([
         'emulator-5554',
         'com.test/com.test.MainActivity',
-      ]),
-      { stdio: ['ignore', 'ignore', 'pipe'] }
+      ])
     );
   }
 );
@@ -356,7 +356,8 @@ test('runAndroid runs gradle build with custom --appId, --appIdSuffix and --main
       mainActivity: 'OtherActivity',
     },
     '/',
-    undefined
+    undefined,
+    { extraSources: [], ignorePaths: [] }
   );
 
   expect(tools.outro).toBeCalledWith('Success 🎉.');
@@ -368,8 +369,7 @@ test('runAndroid runs gradle build with custom --appId, --appIdSuffix and --main
     expect.arrayContaining([
       'emulator-5552',
       'com.custom.suffix/com.test.OtherActivity',
-    ]),
-    { stdio: ['ignore', 'ignore', 'pipe'] }
+    ])
   );
 });
 
@@ -383,7 +383,8 @@ test('runAndroid fails to launch an app on not-connected device when specified w
     { ...androidProject },
     { ...args, device: 'emulator-5554' },
     '/',
-    undefined
+    undefined,
+    { extraSources: [], ignorePaths: [] }
   );
   expect(logWarnSpy).toBeCalledWith(
     'No devices or emulators found matching "emulator-5554". Using available one instead.'
@@ -451,7 +452,8 @@ test.each([['release'], ['debug']])(
       { ...androidProject },
       { ...args, device: 'emulator-5554', variant },
       '/',
-      undefined
+      undefined,
+      { extraSources: [], ignorePaths: [] }
     );
 
     // we don't want to run installDebug when a device is selected, because gradle will install the app on all connected devices
@@ -472,7 +474,7 @@ test.each([['release'], ['debug']])(
         '-PreactNativeDevServerPort=8081',
         '-PreactNativeArchitectures=arm64-v8a,armeabi-v7a',
       ],
-      { stdio: !tools.isInteractive() ? 'inherit' : 'pipe', cwd: '/android' }
+      { cwd: '/android' }
     );
 
     // launches com.test app with MainActivity on emulator-5554
@@ -481,8 +483,7 @@ test.each([['release'], ['debug']])(
       expect.arrayContaining([
         'emulator-5554',
         'com.test/com.test.MainActivity',
-      ]),
-      { stdio: ['ignore', 'ignore', 'pipe'] }
+      ])
     );
   }
 );
@@ -509,7 +510,10 @@ test('runAndroid launches an app on all connected devices', async () => {
     });
   });
 
-  await runAndroid({ ...androidProject }, { ...args }, '/', undefined);
+  await runAndroid({ ...androidProject }, { ...args }, '/', undefined, {
+    extraSources: [],
+    ignorePaths: [],
+  });
 
   // Runs assemble debug task with active architectures arm64-v8a, armeabi-v7a
   expect(spawn).toBeCalledWith(
@@ -521,21 +525,19 @@ test('runAndroid launches an app on all connected devices', async () => {
       '-PreactNativeDevServerPort=8081',
       '-PreactNativeArchitectures=arm64-v8a,armeabi-v7a',
     ],
-    { stdio: !tools.isInteractive() ? 'inherit' : 'pipe', cwd: '/android' }
+    { cwd: '/android' }
   );
 
   // launches com.test app with MainActivity on emulator-5552
   expect(spawn).toBeCalledWith(
     '/mock/android/home/platform-tools/adb',
-    expect.arrayContaining(['emulator-5552', 'com.test/com.test.MainActivity']),
-    { stdio: ['ignore', 'ignore', 'pipe'] }
+    expect.arrayContaining(['emulator-5552', 'com.test/com.test.MainActivity'])
   );
 
   // launches com.test app with MainActivity on emulator-5554
   expect(spawn).toBeCalledWith(
     '/mock/android/home/platform-tools/adb',
-    expect.arrayContaining(['emulator-5554', 'com.test/com.test.MainActivity']),
-    { stdio: ['ignore', 'ignore', 'pipe'] }
+    expect.arrayContaining(['emulator-5554', 'com.test/com.test.MainActivity'])
   );
 });
 
@@ -576,7 +578,8 @@ test('runAndroid skips building when --binary-path is passed', async () => {
       binaryPath: 'android/app/build/outputs/apk/debug/app-debug.apk',
     },
     '/root',
-    undefined
+    undefined,
+    { extraSources: [], ignorePaths: [] }
   );
 
   // Skips gradle
@@ -585,14 +588,12 @@ test('runAndroid skips building when --binary-path is passed', async () => {
   // launches com.test app with MainActivity on emulator-5554
   expect(spawn).toBeCalledWith(
     '/mock/android/home/platform-tools/adb',
-    expect.arrayContaining(['emulator-5552', 'com.test/com.test.MainActivity']),
-    { stdio: ['ignore', 'ignore', 'pipe'] }
+    expect.arrayContaining(['emulator-5552', 'com.test/com.test.MainActivity'])
   );
 
   // launches com.test app with MainActivity on emulator-5554
   expect(spawn).toBeCalledWith(
     '/mock/android/home/platform-tools/adb',
-    expect.arrayContaining(['emulator-5554', 'com.test/com.test.MainActivity']),
-    { stdio: ['ignore', 'ignore', 'pipe'] }
+    expect.arrayContaining(['emulator-5554', 'com.test/com.test.MainActivity'])
   );
 });

packages/platform-android/src/lib/commands/runAndroid/__tests__/tryLaunchAppOnDevice.test.ts

@@ -62,16 +62,12 @@ const actionCategoryFlags = [
 test('launches adb shell with intent to launch com.myapp.MainActivity with different appId than packageName on a simulator', async () => {
   await tryLaunchAppOnDevice(device, androidProject, args);
 
-  expect(spawn).toHaveBeenCalledWith(
-    '/mock/android/home/platform-tools/adb',
-    [
-      ...shellStartCommand,
-      '-n',
-      'com.myapp.custom/com.myapp.MainActivity',
-      ...actionCategoryFlags,
-    ],
-    { stdio: ['ignore', 'ignore', 'pipe'] }
-  );
+  expect(spawn).toHaveBeenCalledWith('/mock/android/home/platform-tools/adb', [
+    ...shellStartCommand,
+    '-n',
+    'com.myapp.custom/com.myapp.MainActivity',
+    ...actionCategoryFlags,
+  ]);
 });
 
 test('launches adb shell with intent to launch com.myapp.MainActivity with different appId than packageName on a simulator when mainActivity is fully qualified name', async () => {
@@ -81,16 +77,12 @@ test('launches adb shell with intent to launch com.myapp.MainActivity with diffe
     args
   );
 
-  expect(spawn).toHaveBeenCalledWith(
-    '/mock/android/home/platform-tools/adb',
-    [
-      ...shellStartCommand,
-      '-n',
-      'com.myapp.custom/com.myapp.MainActivity',
-      ...actionCategoryFlags,
-    ],
-    { stdio: ['ignore', 'ignore', 'pipe'] }
-  );
+  expect(spawn).toHaveBeenCalledWith('/mock/android/home/platform-tools/adb', [
+    ...shellStartCommand,
+    '-n',
+    'com.myapp.custom/com.myapp.MainActivity',
+    ...actionCategoryFlags,
+  ]);
 });
 
 test('launches adb shell with intent to launch com.myapp.MainActivity with same appId as packageName on a simulator', async () => {
@@ -107,8 +99,7 @@ test('launches adb shell with intent to launch com.myapp.MainActivity with same
       '-n',
       'com.myapp/com.myapp.MainActivity',
       ...actionCategoryFlags,
-    ],
-    { stdio: ['ignore', 'ignore', 'pipe'] }
+    ]
   );
 });
 
@@ -122,8 +113,7 @@ test('launches adb shell with intent to launch com.myapp.MainActivity with diffe
       '-n',
       'com.myapp.custom/com.myapp.MainActivity',
       ...actionCategoryFlags,
-    ],
-    { stdio: ['ignore', 'ignore', 'pipe'] }
+    ]
   );
 });
 
@@ -147,8 +137,7 @@ test('launches adb shell with intent to launch fully specified activity with dif
       '-n',
       'com.myapp.custom.dev/com.zoontek.rnbootsplash.RNBootSplashActivity',
       ...actionCategoryFlags,
-    ],
-    { stdio: ['ignore', 'ignore', 'pipe'] }
+    ]
   );
 });
 
@@ -165,8 +154,7 @@ test('--appId flag overwrites applicationId setting in androidProject', async ()
       '-n',
       'my.app.id/com.myapp.MainActivity',
       ...actionCategoryFlags,
-    ],
-    { stdio: ['ignore', 'ignore', 'pipe'] }
+    ]
   );
 });
 
@@ -183,7 +171,6 @@ test('appIdSuffix Staging is appended to applicationId', async () => {
       '-n',
       'com.myapp.custom.Staging/com.myapp.MainActivity',
       ...actionCategoryFlags,
-    ],
-    { stdio: ['ignore', 'ignore', 'pipe'] }
+    ]
   );
 });

packages/platform-android/src/lib/commands/runAndroid/adb.ts

@@ -34,7 +34,7 @@ function parseDevicesResult(result: string): Array<string> {
 export async function getDevices() {
   const adbPath = getAdbPath();
   try {
-    const { output } = await spawn(adbPath, ['devices']);
+    const { output } = await spawn(adbPath, ['devices'], { stdio: 'pipe' });
     return parseDevicesResult(output);
   } catch {
     return [];

packages/platform-android/src/lib/commands/runAndroid/findOutputFile.ts

@@ -87,7 +87,7 @@ async function getAvailableCPUs(device?: string) {
       adbArgs.unshift('-s', device);
     }
 
-    const { output } = await spawn(adbPath, adbArgs);
+    const { output } = await spawn(adbPath, adbArgs, { stdio: 'pipe' });
 
     return output.trim().split(',');
   } catch {

packages/platform-android/src/lib/commands/runAndroid/listAndroidDevices.ts

@@ -17,13 +17,11 @@ export type DeviceData = {
  */
 async function getEmulatorName(deviceId: string) {
   const adbPath = getAdbPath();
-  const { output } = await spawn(adbPath, [
-    '-s',
-    deviceId,
-    'emu',
-    'avd',
-    'name',
-  ]);
+  const { output } = await spawn(
+    adbPath,
+    ['-s', deviceId, 'emu', 'avd', 'name'],
+    { stdio: 'pipe' }
+  );
 
   // 1st line should get us emu name
   return output
@@ -39,13 +37,11 @@ async function getEmulatorName(deviceId: string) {
  */
 async function getPhoneName(deviceId: string) {
   const adbPath = getAdbPath();
-  const { output } = await spawn(adbPath, [
-    '-s',
-    deviceId,
-    'shell',
-    'getprop',
-    'ro.product.model',
-  ]);
+  const { output } = await spawn(
+    adbPath,
+    ['-s', deviceId, 'shell', 'getprop', 'ro.product.model'],
+    { stdio: 'pipe' }
+  );
   return output.replace(/\[ro\.product\.model\]:\s*\[(.*)\]/, '$1').trim();
 }
 

packages/platform-android/src/lib/commands/runAndroid/listAndroidUsers.ts

@@ -17,7 +17,7 @@ export async function checkUsers(device: string): Promise<User[]> {
   loader.start(`Checking users on "${device}"`);
 
   try {
-    const { stdout, stderr } = await spawn(adbPath, adbArgs);
+    const { stdout, stderr } = await spawn(adbPath, adbArgs, { stdio: 'pipe' });
 
     if (stderr) {
       loader.stop(`Failed to check users of "${device}". ${stderr}`, 1);

packages/platform-android/src/lib/commands/runAndroid/tryInstallAppOnDevice.ts

@@ -59,7 +59,7 @@ export async function tryInstallAppOnDevice(
     `Installing the app on ${device.readableName} (id: ${deviceId})`
   );
   try {
-    await spawn(adbPath, adbArgs, { stdio: ['ignore', 'ignore', 'pipe'] });
+    await spawn(adbPath, adbArgs);
     loader.stop(
       `Installed the app on ${device.readableName} (id: ${deviceId}).`
     );