fix: make sure new ios project has properly configured iOS options (#521)

* fix: make sure new ios project has properly configured iOS options

* calculate project name and fingerprint after pod install

* changeset

* remove todo; update vscode extensions

---------

Co-authored-by: Michał Pierzchała <[email protected]>

Author: szymonrybczak

.changeset/happy-parrots-return.md

@@ -0,0 +1,6 @@
+---
+'@rock-js/platform-apple-helpers': patch
+'@rock-js/tools': patch
+---
+
+fix: make sure new ios project has properly configured iOS options

.vscode/extensions.json

@@ -1,3 +1,3 @@
 {
-  "recommendations": ["nrwl.angular-console", "esbenp.prettier-vscode"]
+  "recommendations": ["esbenp.prettier-vscode"]
 }

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

@@ -52,12 +52,19 @@ export const createBuild = async ({
       ? 'simulator'
       : 'device'
     : 'simulator';
-  const artifactName = await formatArtifactName({
-    platform: 'ios',
-    traits: [deviceOrSimulator, args.configuration ?? 'Debug'],
-    root: projectRoot,
-    fingerprintOptions,
-  });
+
+  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 binaryPath = await getBinaryPath({
     artifactName,
     localFlag: args.local,
@@ -82,7 +89,7 @@ export const createBuild = async ({
   }
 
   try {
-    const { appPath, ...buildAppResult } = await buildApp({
+    const { appPath, didInstallPods, ...buildAppResult } = await buildApp({
       projectRoot,
       projectConfig,
       platformName,
@@ -95,6 +102,12 @@ export const createBuild = async ({
     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'}`;

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

@@ -52,12 +52,19 @@ export const createRun = async ({
       ? 'simulator'
       : 'device'
     : 'simulator';
-  const artifactName = await formatArtifactName({
-    platform: 'ios',
-    traits: [deviceOrSimulator, args.configuration ?? 'Debug'],
-    root: projectRoot,
-    fingerprintOptions,
-  });
+
+  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 binaryPath = await getBinaryPath({
     artifactName,
     binaryPathFlag: args.binaryPath,
@@ -132,7 +139,7 @@ ${devices
     }
     cacheRecentDevice(device, platformName);
     if (device.type === 'simulator') {
-      const [, { appPath, infoPlistPath }] = await Promise.all([
+      const [, { appPath, infoPlistPath, didInstallPods }] = await Promise.all([
         launchSimulator(device),
         buildApp({
           args,
@@ -144,6 +151,11 @@ ${devices
           binaryPath,
         }),
       ]);
+      // 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') {
@@ -194,7 +206,7 @@ ${devices
       }
     }
     for (const bootedDevice of bootedDevices) {
-      const [, { appPath, infoPlistPath, bundleIdentifier }] =
+      const [, { appPath, infoPlistPath, bundleIdentifier, didInstallPods }] =
         await Promise.all([
           launchSimulator(bootedDevice),
           buildApp({
@@ -207,6 +219,11 @@ ${devices
             binaryPath,
           }),
         ]);
+      // 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);

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

@@ -49,9 +49,11 @@ export async function buildApp({
       scheme: args.scheme,
       xcodeProject: projectConfig.xcodeProject,
       sourceDir: projectConfig.sourceDir,
+      didInstallPods: false,
     };
   }
 
+  let didInstallPods = false;
   let { xcodeProject, sourceDir } = projectConfig;
 
   if (args.installPods) {
@@ -75,6 +77,7 @@ export async function buildApp({
       xcodeProject = newProjectConfig.xcodeProject;
       sourceDir = newProjectConfig.sourceDir;
     }
+    didInstallPods = true;
   }
 
   const info = await getInfo(xcodeProject, sourceDir);
@@ -123,6 +126,7 @@ export async function buildApp({
     xcodeProject,
     sourceDir,
     bundleIdentifier: buildSettings.bundleIdentifier,
+    didInstallPods,
   };
 }
 

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

@@ -4,6 +4,7 @@ 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';
 
@@ -104,12 +105,14 @@ export async function formatArtifactName({
   root,
   fingerprintOptions,
   raw,
+  silent,
 }: {
   platform?: 'ios' | 'android';
   traits?: string[];
   root: string;
   fingerprintOptions: FingerprintSources;
   raw?: boolean;
+  silent?: boolean;
 }): Promise<string> {
   if (!platform || !traits) {
     return '';
@@ -123,7 +126,7 @@ export async function formatArtifactName({
     return `rock-${platform}-${traits.join('-')}-${hash}`;
   }
 
-  const loader = spinner();
+  const loader = spinner({ silent });
   loader.start('Calculating project fingerprint');
   const { hash } = await nativeFingerprint(root, {
     ...fingerprintOptions,
@@ -132,6 +135,9 @@ export async function formatArtifactName({
   loader.stop(
     `Calculated project fingerprint: ${color.bold(color.magenta(hash))}`,
   );
+  if (silent) {
+    logger.debug(`Calculated project fingerprint: ${hash}`);
+  }
   return `rock-${platform}-${traits.join('-')}-${hash}`;
 }
 

packages/tools/src/lib/fingerprint/index.ts

@@ -22,6 +22,7 @@ export const DEFAULT_IGNORE_PATHS = [
   'ios/DerivedData',
   'ios/Pods',
   'ios/tmp.xcconfig', // added by react-native-config
+  'ios/**/*.xcworkspace',
   'node_modules',
   'android/local.properties',
   'android/.idea',
@@ -48,15 +49,15 @@ export type FingerprintResult = {
  * Calculates the fingerprint of the native parts project of the project.
  */
 export async function nativeFingerprint(
-  path: string,
+  projectRoot: string,
   options: FingerprintOptions,
 ): Promise<FingerprintResult> {
   const platform = options.platform;
   // Use stdout to avoid deprecation warnings
   const { stdout: autolinkingConfigString } = await spawn(
     'rock',
     ['config', '-p', options.platform],
-    { cwd: path, stdio: 'pipe', preferLocal: true },
+    { cwd: projectRoot, stdio: 'pipe', preferLocal: true },
   );
 
   const autolinkingSources = parseAutolinkingSources({
@@ -65,14 +66,17 @@ export async function nativeFingerprint(
     contentsId: 'rncoreAutolinkingConfig',
   });
 
-  const fingerprint = await createFingerprintAsync(path, {
+  const fingerprint = await createFingerprintAsync(projectRoot, {
     platforms: [platform],
-    dirExcludes: DEFAULT_IGNORE_PATHS,
     extraSources: [
       ...autolinkingSources,
-      ...processExtraSources(options.extraSources, path, options.ignorePaths),
+      ...processExtraSources(
+        options.extraSources,
+        projectRoot,
+        options.ignorePaths,
+      ),
     ],
-    ignorePaths: options.ignorePaths,
+    ignorePaths: [...DEFAULT_IGNORE_PATHS, ...(options.ignorePaths ?? [])],
   });
 
   // Filter out un-relevant sources as these caused hash mismatch between local and remote builds