fix: launch iOS app on device (#525)

* fix: launch iOS app on device

* changeset

Author: thymikee

.changeset/thirty-planets-return.md

@@ -0,0 +1,9 @@
+---
+'@rock-js/platform-apple-helpers': patch
+'create-rock': patch
+'@rock-js/tools': patch
+'rock': patch
+'rock-docs': patch
+---
+
+fix: launch iOS app on device

packages/cli/src/lib/cli.ts

@@ -2,7 +2,12 @@ import { createRequire } from 'node:module';
 import { dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { type CommandType, getConfig } from '@rock-js/config';
-import { colorLink, logger, resolveFilenameUp, RockError } from '@rock-js/tools';
+import {
+  colorLink,
+  logger,
+  resolveFilenameUp,
+  RockError,
+} from '@rock-js/tools';
 import { Command } from 'commander';
 import { checkDeprecatedOptions } from './checkDeprecatedOptions.js';
 import { cleanPlugin } from './plugins/clean.js';

packages/cli/src/lib/plugins/remoteCache.ts

@@ -7,14 +7,14 @@ import {
   color,
   colorLink,
   formatArtifactName,
+  getInfoPlist,
   getLocalArtifactPath,
   getLocalBinaryPath,
   handleDownloadResponse,
   handleUploadResponse,
   logger,
   relativeToCwd,
   RockError,
-  spawn,
   spinner,
 } from '@rock-js/tools';
 import AdmZip from 'adm-zip';
@@ -195,7 +195,8 @@ ${output
 
         // Upload index.html and manifest.plist for ad-hoc distribution
         if (args.adHoc) {
-          const { version, bundleIdentifier } = await getInfoPlist(binaryPath);
+          const { version, bundleIdentifier } =
+            await getInfoPlistFromIpa(binaryPath);
           const { url: urlIndexHtml, getResponse: getResponseIndexHtml } =
             await remoteBuildCache.upload({
               artifactName,
@@ -279,7 +280,7 @@ ${deletedArtifacts
   return null;
 }
 
-async function getInfoPlist(binaryPath: string) {
+async function getInfoPlistFromIpa(binaryPath: string) {
   const ipaFileName = path.basename(binaryPath);
   const appName = path.basename(ipaFileName, '.ipa');
   const ipaPath = binaryPath;
@@ -295,33 +296,15 @@ async function getInfoPlist(binaryPath: string) {
   const infoPlistBuffer = infoPlistEntry.getData();
   const tempPlistPath = path.join(os.tmpdir(), 'rock-temp-info.plist');
   fs.writeFileSync(tempPlistPath, infoPlistBuffer);
-
-  let version = 'unknown';
-  let bundleIdentifier = 'unknown';
-  try {
-    await spawn('plutil', [
-      '-convert',
-      'json',
-      '-o',
-      tempPlistPath,
-      tempPlistPath,
-    ]);
-
-    const jsonContent = fs.readFileSync(tempPlistPath, 'utf8');
-    const infoPlistJson = JSON.parse(jsonContent) as Record<string, any>;
-
-    version =
-      infoPlistJson['CFBundleShortVersionString'] ||
-      infoPlistJson['CFBundleVersion'] ||
-      'unknown';
-    bundleIdentifier = infoPlistJson['CFBundleIdentifier'];
-  } finally {
-    if (fs.existsSync(tempPlistPath)) {
-      fs.unlinkSync(tempPlistPath);
-    }
-  }
-
-  return { version, bundleIdentifier };
+  const infoPlistJson = await getInfoPlist(tempPlistPath);
+  fs.unlinkSync(tempPlistPath);
+  return {
+    version:
+      infoPlistJson?.['CFBundleShortVersionString'] ||
+      infoPlistJson?.['CFBundleVersion'] ||
+      'unknown',
+    bundleIdentifier: infoPlistJson?.['CFBundleIdentifier'] || 'unknown',
+  };
 }
 
 async function getBinaryBuffer(

packages/create-app/src/lib/utils/initInExistingProject.ts

@@ -26,7 +26,9 @@ export async function initInExistingProject(projectRoot: string) {
     '@rock-js/platform-ios',
   ];
 
-  loader.start(`Adding ${color.bold('Rock')} dependencies with ${color.bold(pkgManager)}`);
+  loader.start(
+    `Adding ${color.bold('Rock')} dependencies with ${color.bold(pkgManager)}`,
+  );
   await addDevDependencies(projectRoot, pkgManager, rockPackages);
   loader.stop(`Added ${color.bold('Rock')} dependencies`);
 
@@ -169,8 +171,7 @@ function updateAndroidBuildGradle(projectRoot: string, sourceDir: string) {
   if (!fs.existsSync(filePath)) {
     return;
   }
-  const desired =
-    'cliFile = file("../../node_modules/rock/dist/src/bin.js")';
+  const desired = 'cliFile = file("../../node_modules/rock/dist/src/bin.js")';
   const content = fs.readFileSync(filePath, 'utf8');
   const replaced = content.replace(
     /\/\/\s+cliFile\s*=\s*file\([^)]*\)/g,

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

@@ -147,7 +147,7 @@ ${devices
       saveLocalBuildCache(artifactName, appPath);
       await runOnSimulator(device, appPath, infoPlistPath);
     } else if (device.type === 'device') {
-      const { appPath } = await buildApp({
+      const { appPath, bundleIdentifier } = await buildApp({
         args,
         projectConfig,
         platformName,
@@ -156,7 +156,12 @@ ${devices
         reactNativePath,
         binaryPath,
       });
-      await runOnDevice(device, appPath, projectConfig.sourceDir);
+      await runOnDevice(
+        device,
+        appPath,
+        projectConfig.sourceDir,
+        bundleIdentifier,
+      );
     }
     return;
   } else {
@@ -189,23 +194,29 @@ ${devices
       }
     }
     for (const bootedDevice of bootedDevices) {
-      const [, { appPath, infoPlistPath }] = await Promise.all([
-        launchSimulator(bootedDevice),
-        buildApp({
-          args,
-          projectConfig,
-          platformName,
-          udid: bootedDevice.udid,
-          projectRoot,
-          reactNativePath,
-          binaryPath,
-        }),
-      ]);
+      const [, { appPath, infoPlistPath, bundleIdentifier }] =
+        await Promise.all([
+          launchSimulator(bootedDevice),
+          buildApp({
+            args,
+            projectConfig,
+            platformName,
+            udid: bootedDevice.udid,
+            projectRoot,
+            reactNativePath,
+            binaryPath,
+          }),
+        ]);
       saveLocalBuildCache(artifactName, appPath);
       if (bootedDevice.type === 'simulator') {
         await runOnSimulator(bootedDevice, appPath, infoPlistPath);
       } else {
-        await runOnDevice(bootedDevice, appPath, projectConfig.sourceDir);
+        await runOnDevice(
+          bootedDevice,
+          appPath,
+          projectConfig.sourceDir,
+          bundleIdentifier,
+        );
       }
     }
   }

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

@@ -8,6 +8,7 @@ type BuildSettings = {
   EXECUTABLE_FOLDER_PATH: string;
   FULL_PRODUCT_NAME: string;
   WRAPPER_EXTENSION: string;
+  PRODUCT_BUNDLE_IDENTIFIER: string;
 };
 
 export async function getBuildSettings({
@@ -28,7 +29,11 @@ export async function getBuildSettings({
   scheme: string;
   target?: string;
   buildFolder?: string;
-}): Promise<{ appPath: string; infoPlistPath: string }> {
+}): Promise<{
+  appPath: string;
+  infoPlistPath: string;
+  bundleIdentifier: string;
+}> {
   const destination = destinations[0];
   const sdk = destination.match(/simulator/i)
     ? getSimulatorPlatformSDK(platformName)
@@ -102,6 +107,7 @@ export async function getBuildSettings({
     return {
       appPath,
       infoPlistPath: path.join(targetBuildDir, infoPlistPath),
+      bundleIdentifier: buildSettings.PRODUCT_BUNDLE_IDENTIFIER,
     };
   }
 

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

@@ -6,22 +6,39 @@ export async function runOnDevice(
   selectedDevice: Device,
   binaryPath: string,
   sourceDir: string,
+  bundleIdentifier: string,
 ) {
-  const deviceCtlArgs = [
-    'devicectl',
-    'device',
-    'install',
-    'app',
-    '--device',
-    selectedDevice.udid,
-    binaryPath,
-  ];
   const loader = spinner();
   loader.start(
     `Installing and launching your app on ${color.bold(selectedDevice.name)}`,
   );
   try {
-    await spawn('xcrun', deviceCtlArgs, { cwd: sourceDir });
+    await spawn(
+      'xcrun',
+      [
+        'devicectl',
+        'device',
+        'install',
+        'app',
+        '--device',
+        selectedDevice.udid,
+        binaryPath,
+      ],
+      { cwd: sourceDir },
+    );
+    await spawn(
+      'xcrun',
+      [
+        'devicectl',
+        'device',
+        'process',
+        'launch',
+        '--device',
+        selectedDevice.udid,
+        bundleIdentifier,
+      ],
+      { cwd: sourceDir },
+    );
   } catch (error) {
     loader.stop(
       `Failed: Installing and launching your app on ${color.bold(

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

@@ -1,6 +1,6 @@
 import path from 'node:path';
 import type { IOSProjectConfig } from '@react-native-community/cli-types';
-import { RockError } from '@rock-js/tools';
+import { getInfoPlist, RockError } 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';
@@ -37,10 +37,15 @@ export async function buildApp({
   brownfield?: boolean;
 }) {
   if (binaryPath) {
+    // @todo Info.plist is hardcoded when reading from binaryPath
+    const infoPlistPath = path.join(binaryPath, 'Info.plist');
+    const infoPlistJson = await getInfoPlist(infoPlistPath);
+    const bundleIdentifier = infoPlistJson?.['CFBundleIdentifier'] ?? 'unknown';
+
     return {
       appPath: binaryPath,
-      // @todo Info.plist is hardcoded when reading from binaryPath
-      infoPlistPath: path.join(binaryPath, 'Info.plist'),
+      bundleIdentifier,
+      infoPlistPath,
       scheme: args.scheme,
       xcodeProject: projectConfig.xcodeProject,
       sourceDir: projectConfig.sourceDir,
@@ -117,6 +122,7 @@ export async function buildApp({
     scheme: scheme,
     xcodeProject,
     sourceDir,
+    bundleIdentifier: buildSettings.bundleIdentifier,
   };
 }
 

packages/tools/src/index.ts

@@ -21,3 +21,4 @@ export {
   handleDownloadResponse,
   handleUploadResponse,
 } from './lib/build-cache/fetchCachedBuild.js';
+export { getInfoPlist } from './lib/getInfoPlist.js';

packages/tools/src/lib/getInfoPlist.ts

@@ -0,0 +1,17 @@
+import { logger, spawn } from '../index.js';
+
+export async function getInfoPlist(
+  infoPlistPath: string,
+): Promise<Record<string, any> | null> {
+  try {
+    const { stdout } = await spawn(
+      'plutil',
+      ['-convert', 'json', '-o', '-', infoPlistPath],
+      { stdio: 'pipe' },
+    );
+    return JSON.parse(stdout);
+  } catch (error) {
+    logger.debug(`Failed to get Info.plist: ${error}`);
+  }
+  return null;
+}