chore: improve error messages around installing pods; run codegen (#289)

* chore: improve error messages around installing pods

* remove unnecessary retry since we already know whether bundler is in use

* add codegen step

* changeset

Author: thymikee

.changeset/tough-yaks-cry.md

@@ -0,0 +1,7 @@
+---
+'@rnef/platform-apple-helpers': patch
+'@rnef/plugin-brownfield-ios': patch
+'@rnef/platform-ios': patch
+---
+
+chore: improve error messages around installing pods; run codegen

packages/platform-apple-helpers/src/lib/commands/build/createBuild.ts

@@ -21,12 +21,19 @@ import {
 import type { BuildFlags } from './buildOptions.js';
 import { exportArchive } from './exportArchive.js';
 
-export const createBuild = async (
-  platformName: BuilderCommand['platformName'],
-  projectConfig: ProjectConfig,
-  args: BuildFlags,
-  projectRoot: string
-) => {
+export const createBuild = async ({
+  platformName,
+  projectConfig,
+  args,
+  projectRoot,
+  reactNativePath,
+}: {
+  platformName: BuilderCommand['platformName'];
+  projectConfig: ProjectConfig;
+  args: BuildFlags;
+  projectRoot: string;
+  reactNativePath: string;
+}) => {
   await validateArgs(args);
   let xcodeProject: XcodeProjectInfo;
   let sourceDir: string;
@@ -40,6 +47,7 @@ export const createBuild = async (
           ? getSimulatorPlatformSDK(platformName)
           : getDevicePlatformSDK(platformName),
       args,
+      reactNativePath,
     });
     const loader = spinner();
     loader.start('');

packages/platform-apple-helpers/src/lib/commands/run/createRun.ts

@@ -31,14 +31,23 @@ import { runOnMacCatalyst } from './runOnMacCatalyst.js';
 import { launchSimulator, runOnSimulator } from './runOnSimulator.js';
 import type { RunFlags } from './runOptions.js';
 
-export const createRun = async (
-  platformName: ApplePlatform,
-  projectConfig: ProjectConfig,
-  args: RunFlags,
-  projectRoot: string,
-  remoteCacheProvider: SupportedRemoteCacheProviders | undefined,
-  fingerprintOptions: { extraSources: string[]; ignorePaths: string[] }
-) => {
+export const createRun = async ({
+  platformName,
+  projectConfig,
+  args,
+  projectRoot,
+  remoteCacheProvider,
+  fingerprintOptions,
+  reactNativePath,
+}: {
+  platformName: ApplePlatform;
+  projectConfig: ProjectConfig;
+  args: RunFlags;
+  projectRoot: string;
+  remoteCacheProvider: SupportedRemoteCacheProviders | undefined;
+  fingerprintOptions: { extraSources: string[]; ignorePaths: string[] };
+  reactNativePath: string;
+}) => {
   if (!args.binaryPath && args.remoteCache) {
     const artifactName = await formatArtifactName({
       platform: 'ios',
@@ -76,6 +85,7 @@ export const createRun = async (
       projectRoot,
       udid,
       deviceName,
+      reactNativePath,
     });
     await runOnMac(appPath);
     return;
@@ -88,6 +98,7 @@ export const createRun = async (
       projectRoot,
       udid,
       deviceName,
+      reactNativePath,
     });
     if (scheme) {
       await runOnMacCatalyst(appPath, scheme);
@@ -121,6 +132,7 @@ export const createRun = async (
           platformSDK: getSimulatorPlatformSDK(platformName),
           udid: device.udid,
           projectRoot,
+          reactNativePath,
         }),
       ]);
 
@@ -133,6 +145,7 @@ export const createRun = async (
         platformSDK: getDevicePlatformSDK(platformName),
         udid: device.udid,
         projectRoot,
+        reactNativePath,
       });
       await runOnDevice(device, appPath, projectConfig.sourceDir);
     }
@@ -173,6 +186,7 @@ export const createRun = async (
           platformSDK: getSimulatorPlatformSDK(platformName),
           udid: simulator.udid,
           projectRoot,
+          reactNativePath,
         }),
       ]);
       await runOnSimulator(simulator, appPath, infoPlistPath);

packages/platform-apple-helpers/src/lib/utils/buildApp.ts

@@ -22,6 +22,7 @@ export async function buildApp({
   udid,
   projectRoot,
   deviceName,
+  reactNativePath,
 }: {
   args: RunFlags | BuildFlags;
   projectConfig: ProjectConfig;
@@ -31,6 +32,7 @@ export async function buildApp({
   udid?: string;
   deviceName?: string;
   projectRoot: string;
+  reactNativePath: string;
 }) {
   if ('binaryPath' in args && args.binaryPath) {
     return {
@@ -50,7 +52,8 @@ export async function buildApp({
       projectRoot,
       platformName,
       sourceDir,
-      args.newArch
+      args.newArch,
+      reactNativePath
     );
     // When the project is not a workspace, we need to get the project config again,
     // because running pods install might have generated .xcworkspace project.

packages/platform-apple-helpers/src/lib/utils/codegen.ts

@@ -0,0 +1,41 @@
+import type { SubprocessError } from '@rnef/tools';
+import { spawn } from '@rnef/tools';
+import { RnefError } from '@rnef/tools';
+import fs from 'fs';
+import path from 'path';
+import type { ApplePlatform } from '../types/index.js';
+
+interface CodegenOptions {
+  projectRoot: string;
+  platformName: ApplePlatform;
+  reactNativePath: string;
+}
+
+async function runCodegen(options: CodegenOptions) {
+  if (fs.existsSync('build')) {
+    fs.rmSync('build', { recursive: true });
+  }
+
+  const codegenScript = path.join(
+    options.reactNativePath,
+    'scripts/generate-codegen-artifacts.js'
+  );
+
+  try {
+    await spawn('node', [
+      codegenScript,
+      '-p',
+      options.projectRoot,
+      '-o',
+      process.cwd(),
+      '-t',
+      options.platformName,
+    ]);
+  } catch (error) {
+    throw new RnefError('Failed to run React Native codegen script', {
+      cause: (error as SubprocessError).stdout,
+    });
+  }
+}
+
+export default runCodegen;

packages/platform-apple-helpers/src/lib/utils/pods.ts

@@ -12,6 +12,7 @@ import {
   spinner,
 } from '@rnef/tools';
 import type { ApplePlatform } from '../types/index.js';
+import runCodegen from './codegen.js';
 
 const podErrorHelpMessage = `Please make sure your environment is correctly set up. 
 Learn more at: ${color.dim('https://cocoapods.org/')}
@@ -21,7 +22,8 @@ export async function installPodsIfNeeded(
   projectRoot: string,
   platformName: ApplePlatform,
   sourceDir: string,
-  newArch: boolean
+  newArch: boolean,
+  reactNativePath: string
 ) {
   const podsPath = path.join(sourceDir, 'Pods');
   const podfilePath = path.join(sourceDir, 'Podfile');
@@ -40,6 +42,7 @@ export async function installPodsIfNeeded(
     : true;
 
   if (!podsDirExists || hashChanged) {
+    await runCodegen({ projectRoot, platformName, reactNativePath });
     await installPods({ projectRoot, sourceDir, podfilePath, newArch });
     cacheManager.set(
       cacheKey,
@@ -64,7 +67,8 @@ const calculateCurrentHash = ({
     podfile = fs.readFileSync(podfilePath, 'utf-8');
   } catch {
     throw new RnefError(
-      `No Podfile found at: ${podfilePath}. ${podErrorHelpMessage}`
+      `No Podfile found at: ${podfilePath}.
+${podErrorHelpMessage}`
     );
   }
 
@@ -104,7 +108,6 @@ async function runPodInstall(options: {
 
   const command = options.useBundler ? 'bundle' : 'pod';
   const args = options.useBundler ? ['exec', 'pod', 'install'] : ['install'];
-
   try {
     await spawn(command, args, {
       env: {
@@ -117,8 +120,9 @@ async function runPodInstall(options: {
       cwd: options.sourceDir,
     });
   } catch (error) {
-    const stderr = (error as SubprocessError).stderr;
-
+    loader.stop('Failed: Installing CocoaPods dependencies', 1);
+    const stderr =
+      (error as SubprocessError).stderr || (error as SubprocessError).output;
     /**
      * If CocoaPods failed due to repo being out of date, it will
      * include the update command in the error message.
@@ -135,26 +139,15 @@ async function runPodInstall(options: {
         useBundler: options.useBundler,
       });
     } else {
-      if (options.useBundler) {
-        // If for any reason the installing with bundler failed, try with pure `pod install`
-        await runPodInstall({
-          shouldHandleRepoUpdate: false,
-          sourceDir: options.sourceDir,
-          newArch: options.newArch,
-          useBundler: false,
-        });
-      } else {
-        loader.stop('CocoaPods installation failed. ', 1);
-
-        throw new RnefError(
-          `CocoaPods installation failed. ${podErrorHelpMessage}`,
-          { cause: stderr }
-        );
-      }
+      throw new RnefError(
+        `CocoaPods installation failed. 
+${podErrorHelpMessage}`,
+        { cause: stderr }
+      );
     }
   }
 
-  loader.stop('CocoaPods installed successfully.');
+  loader.stop('Installed CocoaPods dependencies successfully');
 }
 
 async function runPodUpdate(cwd: string, useBundler: boolean) {
@@ -169,10 +162,11 @@ async function runPodUpdate(cwd: string, useBundler: boolean) {
   } catch (error) {
     const stderr =
       (error as SubprocessError).stderr || (error as SubprocessError).stdout;
-    loader.stop();
+    loader.stop('Failed: Updating CocoaPods repositories', 1);
 
     throw new RnefError(
-      `Failed to update CocoaPods repositories for iOS project. ${podErrorHelpMessage}`,
+      `Failed to update CocoaPods repositories for iOS project.
+${podErrorHelpMessage}`,
       { cause: stderr }
     );
   }
@@ -194,6 +188,9 @@ async function installPods(options: {
     options.sourceDir,
     options.projectRoot
   );
+  if (!useBundler) {
+    logger.info('Unable to use Ruby bundler, falling back to "pod install"');
+  }
   await runPodInstall({
     sourceDir: options.sourceDir,
     newArch: options.newArch,
@@ -210,10 +207,18 @@ async function validatePodCommand(sourceDir: string) {
   try {
     await spawn('pod', ['--version'], { cwd: sourceDir });
   } catch (error) {
+    const cause = (error as SubprocessError).cause;
+    if (cause instanceof Error && cause.message.includes('ENOENT')) {
+      throw new RnefError(
+        `The "pod" command is not available.
+${podErrorHelpMessage}`
+      );
+    }
     const stderr =
       (error as SubprocessError).stderr || (error as SubprocessError).stdout;
     throw new RnefError(
-      `CocoaPods "pod" command failed. ${podErrorHelpMessage}`,
+      `CocoaPods "pod" command failed.
+${podErrorHelpMessage}`,
       { cause: stderr }
     );
   }
@@ -260,14 +265,15 @@ skipping Ruby Gems installation.`
   } catch (error) {
     const stderr =
       (error as SubprocessError).stderr || (error as SubprocessError).stdout;
-    loader.stop('Ruby Gems installation failed.', 1);
+    loader.stop('Failed: Installing Ruby Gems', 1);
     throw new RnefError(
-      `Failed to install Ruby Gems with "bundle install". ${podErrorHelpMessage}`,
+      `Failed to install Ruby Gems with "bundle install".
+${podErrorHelpMessage}`,
       { cause: stderr }
     );
   }
 
-  loader.stop('Installed Ruby Gems.');
+  loader.stop('Installed Ruby Gems');
   return true;
 }
 

packages/platform-ios/src/lib/platformIOS.ts

@@ -24,7 +24,13 @@ export const platformIOS =
       description: 'Build iOS app.',
       action: async (args) => {
         intro('Building iOS app');
-        await createBuild('ios', iosConfig, args as BuildFlags, projectRoot);
+        await createBuild({
+          platformName: 'ios',
+          projectConfig: iosConfig,
+          args: args as BuildFlags,
+          projectRoot,
+          reactNativePath: api.getReactNativePath(),
+        });
         outro('Success 🎉.');
       },
       options: buildOptions,
@@ -35,14 +41,15 @@ export const platformIOS =
       description: 'Run iOS app.',
       action: async (args) => {
         intro('Running iOS app');
-        await createRun(
-          'ios',
-          iosConfig,
-          args as RunFlags,
+        await createRun({
+          platformName: 'ios',
+          projectConfig: iosConfig,
+          args: args as RunFlags,
           projectRoot,
-          api.getRemoteCacheProvider(),
-          api.getFingerprintOptions()
-        );
+          remoteCacheProvider: api.getRemoteCacheProvider(),
+          fingerprintOptions: api.getFingerprintOptions(),
+          reactNativePath: api.getReactNativePath(),
+        });
         outro('Success 🎉.');
       },
       // @ts-expect-error: fix `simulator` is not defined in `RunFlags`

packages/plugin-brownfield-ios/src/lib/pluginBrownfieldIos.ts

@@ -32,12 +32,13 @@ export const pluginBrownfieldIos =
         const buildFolder = args.buildFolder ?? derivedDataDir;
         const configuration = args.configuration ?? 'Debug';
 
-        await createBuild(
-          'ios',
-          iosConfig,
-          { ...args, destinations, buildFolder },
-          projectRoot
-        );
+        await createBuild({
+          platformName: 'ios',
+          projectConfig: iosConfig,
+          args: { ...args, destinations, buildFolder },
+          projectRoot,
+          reactNativePath: api.getReactNativePath(),
+        });
 
         if (!args.scheme) {
           throw new RnefError(