refactor: move saving cache to buildApp; show that fingerprint was updated (#559)

* refactor: move saving cache to buildApp; show that fingerprint was updated

* update only if pods did install

* changeset

Author: thymikee

.changeset/short-bags-hang.md

@@ -0,0 +1,6 @@
+---
+'@rock-js/platform-apple-helpers': patch
+'@rock-js/tools': patch
+---
+
+refactor: move saving cache to buildApp; show that fingerprint was updated

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

@@ -53,17 +53,12 @@ export const createBuild = async ({
       : 'device'
     : 'simulator';
 
-  async function getArtifactName({ silent }: { silent?: boolean } = {}) {
-    return await formatArtifactName({
-      platform: 'ios',
-      traits: [deviceOrSimulator, args.configuration ?? 'Debug'],
-      root: projectRoot,
-      fingerprintOptions,
-      silent,
-    });
-  }
-
-  let artifactName = await getArtifactName();
+  const artifactName = await formatArtifactName({
+    platform: 'ios',
+    traits: [deviceOrSimulator, args.configuration ?? 'Debug'],
+    root: projectRoot,
+    fingerprintOptions,
+  });
 
   const binaryPath = await getBinaryPath({
     platformName,
@@ -90,26 +85,22 @@ export const createBuild = async ({
   }
 
   try {
-    const { appPath, didInstallPods, ...buildAppResult } = await buildApp({
+    const { appPath, ...buildAppResult } = await buildApp({
       projectRoot,
       projectConfig,
       platformName,
       args,
       reactNativePath,
       brownfield,
+      artifactName,
+      deviceOrSimulator,
+      fingerprintOptions,
     });
     logger.log(`Build available at: ${colorLink(relativeToCwd(appPath))}`);
 
     xcodeProject = buildAppResult.xcodeProject;
     sourceDir = buildAppResult.sourceDir;
     scheme = buildAppResult.scheme;
-
-    // After installing pods the fingerprint likely changes.
-    // We update the artifact name to reflect the new fingerprint and store proper entry in the local cache.
-    if (didInstallPods) {
-      artifactName = await getArtifactName({ silent: true });
-    }
-    saveLocalBuildCache(artifactName, appPath);
   } catch (error) {
     const message = `Failed to create ${args.archive ? 'archive' : 'build'}`;
     throw new RockError(message, { cause: error });

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

@@ -9,7 +9,6 @@ import {
   logger,
   promptSelect,
   RockError,
-  saveLocalBuildCache,
 } from '@rock-js/tools';
 import type {
   ApplePlatform,
@@ -53,17 +52,12 @@ export const createRun = async ({
       : 'device'
     : 'simulator';
 
-  async function getArtifactName({ silent }: { silent?: boolean } = {}) {
-    return await formatArtifactName({
-      platform: 'ios',
-      traits: [deviceOrSimulator, args.configuration ?? 'Debug'],
-      root: projectRoot,
-      fingerprintOptions,
-      silent,
-    });
-  }
-
-  let artifactName = await getArtifactName();
+  const artifactName = await formatArtifactName({
+    platform: 'ios',
+    traits: [deviceOrSimulator, args.configuration ?? 'Debug'],
+    root: projectRoot,
+    fingerprintOptions,
+  });
 
   const binaryPath = await getBinaryPath({
     platformName: 'ios',
@@ -94,6 +88,9 @@ export const createRun = async ({
       deviceName,
       reactNativePath,
       binaryPath,
+      artifactName,
+      deviceOrSimulator,
+      fingerprintOptions,
     });
     await runOnMac(appPath);
     return;
@@ -107,6 +104,9 @@ export const createRun = async ({
       deviceName,
       reactNativePath,
       binaryPath,
+      artifactName,
+      deviceOrSimulator,
+      fingerprintOptions,
     });
     if (scheme) {
       await runOnMacCatalyst(appPath, scheme);
@@ -140,7 +140,7 @@ ${devices
     }
     cacheRecentDevice(device, platformName);
     if (device.type === 'simulator') {
-      const [, { appPath, infoPlistPath, didInstallPods }] = await Promise.all([
+      const [, { appPath, infoPlistPath }] = await Promise.all([
         launchSimulator(device),
         buildApp({
           args,
@@ -150,14 +150,11 @@ ${devices
           projectRoot,
           reactNativePath,
           binaryPath,
+          artifactName,
+          deviceOrSimulator,
+          fingerprintOptions,
         }),
       ]);
-      // After installing pods the fingerprint likely changes.
-      // We update the artifact name to reflect the new fingerprint and store proper entry in the local cache.
-      if (didInstallPods) {
-        artifactName = await getArtifactName({ silent: true });
-      }
-      saveLocalBuildCache(artifactName, appPath);
       await runOnSimulator(device, appPath, infoPlistPath);
     } else if (device.type === 'device') {
       const { appPath, bundleIdentifier } = await buildApp({
@@ -168,6 +165,9 @@ ${devices
         projectRoot,
         reactNativePath,
         binaryPath,
+        artifactName,
+        deviceOrSimulator,
+        fingerprintOptions,
       });
       await runOnDevice(
         device,
@@ -207,7 +207,7 @@ ${devices
       }
     }
     for (const bootedDevice of bootedDevices) {
-      const [, { appPath, infoPlistPath, bundleIdentifier, didInstallPods }] =
+      const [, { appPath, infoPlistPath, bundleIdentifier }] =
         await Promise.all([
           launchSimulator(bootedDevice),
           buildApp({
@@ -218,14 +218,11 @@ ${devices
             projectRoot,
             reactNativePath,
             binaryPath,
+            artifactName,
+            deviceOrSimulator,
+            fingerprintOptions,
           }),
         ]);
-      // After installing pods the fingerprint likely changes.
-      // We update the artifact name to reflect the new fingerprint and store proper entry in the local cache.
-      if (didInstallPods) {
-        artifactName = await getArtifactName({ silent: true });
-      }
-      saveLocalBuildCache(artifactName, appPath);
       if (bootedDevice.type === 'simulator') {
         await runOnSimulator(bootedDevice, appPath, infoPlistPath);
       } else {

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

@@ -1,6 +1,12 @@
 import path from 'node:path';
 import type { IOSProjectConfig } from '@react-native-community/cli-types';
-import { getInfoPlist, RockError } from '@rock-js/tools';
+import {
+  type FingerprintSources,
+  formatArtifactName,
+  getInfoPlist,
+  RockError,
+  saveLocalBuildCache,
+} from '@rock-js/tools';
 import type { BuildFlags } from '../commands/build/buildOptions.js';
 import { buildProject } from '../commands/build/buildProject.js';
 import { getBuildSettings } from '../commands/run/getBuildSettings.js';
@@ -24,6 +30,9 @@ export async function buildApp({
   reactNativePath,
   binaryPath,
   brownfield,
+  artifactName,
+  fingerprintOptions,
+  deviceOrSimulator,
 }: {
   args: RunFlags | BuildFlags;
   projectConfig: ProjectConfig;
@@ -35,6 +44,9 @@ export async function buildApp({
   reactNativePath: string;
   binaryPath?: string;
   brownfield?: boolean;
+  artifactName: string;
+  fingerprintOptions: FingerprintSources;
+  deviceOrSimulator: string;
 }) {
   if (binaryPath) {
     // @todo Info.plist is hardcoded when reading from binaryPath
@@ -49,15 +61,13 @@ export async function buildApp({
       scheme: args.scheme,
       xcodeProject: projectConfig.xcodeProject,
       sourceDir: projectConfig.sourceDir,
-      didInstallPods: false,
     };
   }
-
-  let didInstallPods = false;
+  let artifactNameToSave = artifactName;
   let { xcodeProject, sourceDir } = projectConfig;
 
   if (args.installPods) {
-    await installPodsIfNeeded(
+    const didInstallPods = await installPodsIfNeeded(
       projectRoot,
       platformName,
       sourceDir,
@@ -77,7 +87,18 @@ export async function buildApp({
       xcodeProject = newProjectConfig.xcodeProject;
       sourceDir = newProjectConfig.sourceDir;
     }
-    didInstallPods = true;
+
+    if (didInstallPods) {
+      // After installing pods the fingerprint likely changes.
+      // We update the artifact name to reflect the new fingerprint and store proper entry in the local cache.
+      artifactNameToSave = await formatArtifactName({
+        platform: 'ios',
+        traits: [deviceOrSimulator, args.configuration ?? 'Debug'],
+        root: projectRoot,
+        fingerprintOptions,
+        type: 'update',
+      });
+    }
   }
 
   const info = await getInfo(xcodeProject, sourceDir);
@@ -119,14 +140,15 @@ export async function buildApp({
     buildFolder: args.buildFolder,
   });
 
+  saveLocalBuildCache(artifactNameToSave, buildSettings.appPath);
+
   return {
     appPath: buildSettings.appPath,
     infoPlistPath: buildSettings.infoPlistPath,
     scheme: scheme,
     xcodeProject,
     sourceDir,
     bundleIdentifier: buildSettings.bundleIdentifier,
-    didInstallPods,
   };
 }
 

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

@@ -56,7 +56,9 @@ export async function installPodsIfNeeded(
       cacheKey,
       calculateCurrentHash({ podfilePath, podsPath, nativeDependencies }),
     );
+    return true;
   }
+  return false;
 }
 
 const calculateCurrentHash = ({

packages/tools/src/lib/build-cache/common.ts

@@ -4,7 +4,6 @@ import { color } from '../color.js';
 import type { FingerprintSources } from '../fingerprint/index.js';
 import { nativeFingerprint } from '../fingerprint/index.js';
 import { isInteractive } from '../isInteractive.js';
-import logger from '../logger.js';
 import { getCacheRootPath } from '../project.js';
 import { spinner } from '../prompts.js';
 
@@ -105,14 +104,14 @@ export async function formatArtifactName({
   root,
   fingerprintOptions,
   raw,
-  silent,
+  type,
 }: {
   platform?: 'ios' | 'android';
   traits?: string[];
   root: string;
   fingerprintOptions: FingerprintSources;
   raw?: boolean;
-  silent?: boolean;
+  type?: 'create' | 'update';
 }): Promise<string> {
   if (!platform || !traits) {
     return '';
@@ -126,18 +125,18 @@ export async function formatArtifactName({
     return `rock-${platform}-${traits.join('-')}-${hash}`;
   }
 
-  const loader = spinner({ silent });
-  loader.start('Calculating project fingerprint');
+  const startMessage = type === 'update' ? 'Updating' : 'Calculating';
+  const stopMessage = type === 'update' ? 'Updated' : 'Calculated';
+
+  const loader = spinner();
+  loader.start(`${startMessage} project fingerprint`);
   const { hash } = await nativeFingerprint(root, {
     ...fingerprintOptions,
     platform,
   });
   loader.stop(
-    `Calculated project fingerprint: ${color.bold(color.magenta(hash))}`,
+    `${stopMessage} project fingerprint: ${color.bold(color.magenta(hash))}`,
   );
-  if (silent) {
-    logger.debug(`Calculated project fingerprint: ${hash}`);
-  }
   return `rock-${platform}-${traits.join('-')}-${hash}`;
 }