feat: support local cache for build:* commands (#446)

* feat: support local cache for build:* commands

* fixup tests

* save cache after build

* feat: warn about ignored files affecting fingerprint (#450)

* feat: warn about ignored files affecting fingerprint

* changeset

* Update packages/platform-android/src/lib/commands/buildAndroid/buildAndroid.ts

Co-authored-by: Szymon Rybczak <[email protected]>

* fix: add ios/tmp.xcconfig from react-native-config to fingerprint ignores (#449)

* fix: add ios/tmp.xcconfig from react-native-config to fingerprint ignores

* changeset

* changeset

---------

Co-authored-by: Szymon Rybczak <[email protected]>

Author: thymikee

.changeset/honest-brooms-type.md

@@ -0,0 +1,9 @@
+---
+'@rnef/platform-apple-helpers': patch
+'@rnef/plugin-brownfield-ios': patch
+'@rnef/platform-android': patch
+'@rnef/platform-ios': patch
+'@rnef/tools': patch
+---
+
+feat: support local cache for build:\* commands

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

@@ -14,6 +14,7 @@ const args: BuildFlags = {
   variant: 'debug',
   activeArchOnly: false,
   extraParams: undefined,
+  local: true,
 };
 const androidProject: AndroidProjectConfig = {
   appName: 'app',
@@ -73,6 +74,7 @@ test('buildAndroid runs gradle build with correct configuration for debug and ou
     androidProject,
     { ...args, aab: true },
     '/root',
+    null,
     fingerprintOptions
   );
 
@@ -86,7 +88,7 @@ test('buildAndroid fails gracefully when gradle errors', async () => {
   vi.mocked(spawn).mockRejectedValueOnce({ stderr: 'gradle error' });
 
   await expect(
-    buildAndroid(androidProject, args, '/root', fingerprintOptions)
+    buildAndroid(androidProject, args, '/root', null, fingerprintOptions)
   ).rejects.toThrowErrorMatchingInlineSnapshot(
     `[RnefError: Failed to build the app. See the error above for details from Gradle.]`
   );

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

@@ -1,8 +1,10 @@
 import type { AndroidProjectConfig } from '@react-native-community/cli-types';
+import type { RemoteBuildCache } from '@rnef/tools';
 import {
   colorLink,
   type FingerprintSources,
   formatArtifactName,
+  getBinaryPath,
   logger,
   outro,
   parseArgs,
@@ -18,12 +20,14 @@ export interface BuildFlags {
   activeArchOnly?: boolean;
   tasks?: Array<string>;
   extraParams?: Array<string>;
+  local?: boolean;
 }
 
 export async function buildAndroid(
   androidProject: AndroidProjectConfig,
   args: BuildFlags,
   projectRoot: string,
+  remoteCacheProvider: null | (() => RemoteBuildCache) | undefined,
   fingerprintOptions: FingerprintSources
 ) {
   normalizeArgs(args);
@@ -36,9 +40,19 @@ export async function buildAndroid(
     root: projectRoot,
     fingerprintOptions,
   });
-  await runGradle({ tasks, androidProject, args, artifactName });
+  const binaryPath = await getBinaryPath({
+    artifactName,
+    localFlag: args.local,
+    remoteCacheProvider,
+    fingerprintOptions,
+    sourceDir: androidProject.sourceDir,
+  });
+  if (!binaryPath) {
+    await runGradle({ tasks, androidProject, args, artifactName });
+  }
 
-  const outputFilePath = await findOutputFile(androidProject, tasks);
+  const outputFilePath =
+    binaryPath ?? (await findOutputFile(androidProject, tasks));
 
   if (outputFilePath) {
     logger.log(
@@ -85,4 +99,8 @@ export const options = [
     description: 'Custom params passed to gradle build command',
     parse: parseArgs,
   },
+  {
+    name: '--local',
+    description: 'Force local build with Gradle wrapper.',
+  },
 ];

packages/platform-android/src/lib/commands/buildAndroid/command.ts

@@ -20,6 +20,7 @@ export function registerBuildCommand(
         androidConfig,
         args as BuildFlags,
         api.getProjectRoot(),
+        await api.getRemoteCacheProvider(),
         api.getFingerprintOptions()
       );
     },

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

@@ -7,9 +7,7 @@ import type {
 import type { FingerprintSources, RemoteBuildCache } from '@rnef/tools';
 import {
   color,
-  fetchCachedBuild,
   formatArtifactName,
-  getLocalBuildCacheBinaryPath,
   intro,
   isInteractive,
   logger,
@@ -18,6 +16,7 @@ import {
   RnefError,
   spinner,
 } from '@rnef/tools';
+import { getBinaryPath } from '@rnef/tools';
 import type { BuildFlags } from '../buildAndroid/buildAndroid.js';
 import { options } from '../buildAndroid/buildAndroid.js';
 import { runGradle } from '../runGradle.js';
@@ -68,35 +67,14 @@ export async function runAndroid(
     root: projectRoot,
     fingerprintOptions,
   });
-  // 1. First check if the binary path is provided
-  let binaryPath = args.binaryPath;
-
-  // 2. If not, check if the local build is requested
-  if (!binaryPath && !args.local) {
-    binaryPath = getLocalBuildCacheBinaryPath(artifactName);
-  }
-
-  // 3. If not, check if the remote cache is requested
-  if (!binaryPath && !args.local) {
-    try {
-      const cachedBuild = await fetchCachedBuild({
-        artifactName,
-        remoteCacheProvider,
-      });
-      if (cachedBuild) {
-        binaryPath = cachedBuild.binaryPath;
-      }
-    } catch (error) {
-      const message = (error as RnefError).message;
-      const cause = (error as RnefError).cause;
-      logger.warn(
-        `Failed to fetch cached build for ${artifactName}: \n${message}`,
-        cause ? `\nCause: ${cause.toString()}` : ''
-      );
-      logger.debug('Remote cache failure error:', error);
-      logger.info('Continuing with local build');
-    }
-  }
+  const binaryPath = await getBinaryPath({
+    artifactName,
+    binaryPathFlag: args.binaryPath,
+    localFlag: args.local,
+    remoteCacheProvider,
+    fingerprintOptions,
+    sourceDir: androidProject.sourceDir,
+  });
 
   if (device) {
     if (!(await getDevices()).find((d) => d === device.deviceId)) {
@@ -298,8 +276,4 @@ export const runOptions = [
     name: '--user <number>',
     description: 'Id of the User Profile you want to install the app on.',
   },
-  {
-    name: '--local',
-    description: 'Force local build with Gradle wrapper.',
-  },
 ];

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

@@ -15,6 +15,7 @@ export type BuildFlags = {
   archive?: boolean;
   installPods: boolean;
   newArch: boolean;
+  local?: boolean;
 };
 
 export const getBuildOptions = ({ platformName }: BuilderCommand) => {
@@ -79,5 +80,9 @@ export const getBuildOptions = ({ platformName }: BuilderCommand) => {
       name: '--no-new-arch',
       description: 'Run React Native in legacy async architecture.',
     },
+    {
+      name: '--local',
+      description: 'Force local build with xcodebuild.',
+    },
   ];
 };

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

@@ -1,8 +1,10 @@
+import fs from 'node:fs';
 import path from 'node:path';
-import type { FingerprintSources } from '@rnef/tools';
+import type { FingerprintSources, RemoteBuildCache } from '@rnef/tools';
 import {
   colorLink,
   formatArtifactName,
+  getBinaryPath,
   isInteractive,
   logger,
   promptSelect,
@@ -28,6 +30,7 @@ export const createBuild = async ({
   reactNativePath,
   fingerprintOptions,
   brownfield,
+  remoteCacheProvider,
 }: {
   platformName: BuilderCommand['platformName'];
   projectConfig: ProjectConfig;
@@ -36,12 +39,13 @@ export const createBuild = async ({
   reactNativePath: string;
   fingerprintOptions: FingerprintSources;
   brownfield?: boolean;
+  remoteCacheProvider: null | (() => RemoteBuildCache) | undefined;
 }) => {
   await validateArgs(args);
 
   let xcodeProject: XcodeProjectInfo;
   let sourceDir: string;
-  let scheme: string;
+  let scheme: string | undefined;
   const deviceOrSimulator = args.destination
     ? // there can be multiple destinations, so we'll pick the first one
       args.destination[0].match(/simulator/i)
@@ -54,6 +58,29 @@ export const createBuild = async ({
     root: projectRoot,
     fingerprintOptions,
   });
+  const binaryPath = await getBinaryPath({
+    artifactName,
+    localFlag: args.local,
+    remoteCacheProvider,
+    fingerprintOptions,
+    sourceDir: projectConfig.sourceDir,
+  });
+
+  if (binaryPath) {
+    logger.log(`Build available at: ${colorLink(relativeToCwd(binaryPath))}`);
+
+    if (args.archive) {
+      const { exportDir } = getBuildPaths(platformName);
+      if (fs.statSync(exportDir).isDirectory()) {
+        logger.log(
+          `Archives available at: ${colorLink(relativeToCwd(exportDir))}`
+        );
+      }
+    }
+
+    return { scheme };
+  }
+
   try {
     const { appPath, ...buildAppResult } = await buildApp({
       projectRoot,
@@ -67,9 +94,8 @@ export const createBuild = async ({
 
     xcodeProject = buildAppResult.xcodeProject;
     sourceDir = buildAppResult.sourceDir;
-    // @ts-expect-error - scheme is not set when binaryPath is provided,
-    // which is not supported for build command (but is used by run command)
     scheme = buildAppResult.scheme;
+    saveLocalBuildCache(artifactName, appPath);
   } catch (error) {
     const message = `Failed to create ${args.archive ? 'archive' : 'build'}`;
     throw new RnefError(message, { cause: error });

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

@@ -3,9 +3,8 @@ import path from 'node:path';
 import type { FingerprintSources, RemoteBuildCache } from '@rnef/tools';
 import {
   color,
-  fetchCachedBuild,
   formatArtifactName,
-  getLocalBuildCacheBinaryPath,
+  getBinaryPath,
   isInteractive,
   logger,
   promptSelect,
@@ -59,35 +58,14 @@ export const createRun = async ({
     root: projectRoot,
     fingerprintOptions,
   });
-  // 1. First check if the binary path is provided
-  let binaryPath = args.binaryPath;
-
-  // 2. If not, check if the local build is requested
-  if (!binaryPath && !args.local) {
-    binaryPath = getLocalBuildCacheBinaryPath(artifactName);
-  }
-
-  // 3. If not, check if the remote cache is requested
-  if (!binaryPath && !args.local) {
-    try {
-      const cachedBuild = await fetchCachedBuild({
-        artifactName,
-        remoteCacheProvider,
-      });
-      if (cachedBuild) {
-        binaryPath = cachedBuild.binaryPath;
-      }
-    } catch (error) {
-      const message = (error as RnefError).message;
-      const cause = (error as RnefError).cause;
-      logger.warn(
-        `Failed to fetch cached build for ${artifactName}: \n${message}`,
-        cause ? `\nCause: ${cause.toString()}` : ''
-      );
-      logger.debug('Remote cache failure error:', error);
-      logger.info('Continuing with local build');
-    }
-  }
+  const binaryPath = await getBinaryPath({
+    artifactName,
+    binaryPathFlag: args.binaryPath,
+    localFlag: args.local,
+    remoteCacheProvider,
+    fingerprintOptions,
+    sourceDir: projectConfig.sourceDir,
+  });
 
   // Check if the device argument looks like a UDID
   // (assuming UDIDs are alphanumeric and have specific length)

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

@@ -21,10 +21,6 @@ export const getRunOptions = ({ platformName }: BuilderCommand) => {
       description:
         'Path relative to project root where pre-built .app binary lives.',
     },
-    {
-      name: '--local',
-      description: 'Force local build with xcodebuild.',
-    },
     {
       name: '--device <string>',
       description:

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

@@ -35,6 +35,7 @@ export const platformIOS =
           projectRoot,
           reactNativePath: api.getReactNativePath(),
           fingerprintOptions: api.getFingerprintOptions(),
+          remoteCacheProvider: await api.getRemoteCacheProvider(),
         });
         outro('Success 🎉.');
       },