fix(cli-platform-apple): properly receive simulators (#2251)

* fix: properly receive simulators

* fix: physical devices are always booted

* chore: add missing description to function

* chore: move from `child_process` to `execa`

* test: add test for merged output

* chore: apply code review suggestions

Author: szymonrybczak

packages/cli-platform-apple/src/commands/logCommand/createLog.ts

@@ -3,8 +3,7 @@ import {Config, IOSProjectConfig} from '@react-native-community/cli-types';
 import {spawnSync} from 'child_process';
 import os from 'os';
 import path from 'path';
-import getSimulators from '../../tools/getSimulators';
-import listDevices, {stripPlatform} from '../../tools/listDevices';
+import listDevices from '../../tools/listDevices';
 import {getPlatformInfo} from '../runCommand/getPlatformInfo';
 import {BuilderCommand, Device} from '../../types';
 import {supportedPlatforms} from '../../config/supportedPlatforms';
@@ -31,48 +30,31 @@ const createLog =
       throw new CLIError(`Unable to find ${platformName} platform config`);
     }
 
-    // Here we're using two command because first command `xcrun simctl list --json devices` outputs `state` but doesn't return `available`. But second command `xcrun xcdevice list` outputs `available` but doesn't output `state`. So we need to connect outputs of both commands.
-    const simulators = getSimulators();
-    const bootedSimulators = Object.keys(simulators.devices)
-      .map((key) => simulators.devices[key])
-      .reduce((acc, val) => acc.concat(val), [])
-      .filter(({state}) => state === 'Booted');
-
     const {sdkNames} = getPlatformInfo(platformName);
-    const devices = await listDevices(sdkNames);
-
-    const availableSimulators = devices.filter(
-      ({type, isAvailable}) => type === 'simulator' && isAvailable,
-    );
+    const allDevices = await listDevices(sdkNames);
+    const simulators = allDevices.filter(({type}) => type === 'simulator');
 
-    if (availableSimulators.length === 0) {
+    if (simulators.length === 0) {
       logger.error('No simulators detected. Install simulators via Xcode.');
       return;
     }
 
-    const bootedAndAvailableSimulators = bootedSimulators
-      .map((booted) => {
-        const available = availableSimulators.find(
-          ({udid}) => udid === booted.udid,
-        );
-        return {...available, ...booted};
-      })
-      .filter(({sdk}) => sdk && sdkNames.includes(stripPlatform(sdk)));
+    const booted = simulators.filter(({state}) => state === 'Booted');
 
-    if (bootedAndAvailableSimulators.length === 0) {
+    if (booted.length === 0) {
       logger.error(
         `No booted and available ${platformReadableName} simulators found.`,
       );
       return;
     }
 
-    if (args.interactive && bootedAndAvailableSimulators.length > 1) {
+    if (args.interactive && booted.length > 1) {
       const udid = await promptForDeviceToTailLogs(
         platformReadableName,
-        bootedAndAvailableSimulators,
+        booted,
       );
 
-      const simulator = bootedAndAvailableSimulators.find(
+      const simulator = booted.find(
         ({udid: deviceUDID}) => deviceUDID === udid,
       );
 
@@ -84,7 +66,7 @@ const createLog =
 
       tailDeviceLogs(simulator);
     } else {
-      tailDeviceLogs(bootedAndAvailableSimulators[0]);
+      tailDeviceLogs(booted[0]);
     }
   };
 

packages/cli-platform-apple/src/commands/runCommand/createRun.ts

@@ -151,18 +151,14 @@ const createRun =
 
     const devices = await listDevices(sdkNames);
 
-    const availableDevices = devices.filter(
-      ({isAvailable}) => isAvailable === true,
-    );
-
-    if (availableDevices.length === 0) {
+    if (devices.length === 0) {
       return logger.error(
         `${platformReadableName} devices or simulators not detected. Install simulators via Xcode or connect a physical ${platformReadableName} device`,
       );
     }
 
     const fallbackSimulator =
-      platformName === 'ios' ? getFallbackSimulator(args) : availableDevices[0];
+      platformName === 'ios' ? getFallbackSimulator(args) : devices[0];
 
     if (args.listDevices || args.interactive) {
       if (args.device || args.udid) {
@@ -180,7 +176,7 @@ const createRun =
       );
 
       const selectedDevice = await promptForDeviceSelection(
-        availableDevices,
+        devices,
         preferredDevice,
       );
 
@@ -222,12 +218,12 @@ const createRun =
     }
 
     if (!args.device && !args.udid && !args.simulator) {
-      const bootedDevices = availableDevices.filter(
-        ({type}) => type === 'device',
+      const bootedSimulators = devices.filter(
+        ({state, type}) => state === 'Booted' && type === 'simulator',
       );
-      const bootedSimulators = devices.filter(({type}) => type === 'simulator');
+      const bootedDevices = devices.filter(({type}) => type === 'device'); // Physical devices here are always booted
+      const booted = [...bootedSimulators, ...bootedDevices];
 
-      const booted = [...bootedDevices, ...bootedSimulators];
       if (booted.length === 0) {
         logger.info(
           'No booted devices or simulators found. Launching first available simulator...',
@@ -276,12 +272,12 @@ const createRun =
     }
 
     if (args.udid) {
-      const device = availableDevices.find((d) => d.udid === args.udid);
+      const device = devices.find((d) => d.udid === args.udid);
       if (!device) {
         return logger.error(
           `Could not find a device with udid: "${chalk.bold(
             args.udid,
-          )}". ${printFoundDevices(availableDevices)}`,
+          )}". ${printFoundDevices(devices)}`,
         );
       }
       if (device.type === 'simulator') {
@@ -304,9 +300,7 @@ const createRun =
         );
       }
     } else if (args.device) {
-      const physicalDevices = availableDevices.filter(
-        ({type}) => type !== 'simulator',
-      );
+      const physicalDevices = devices.filter(({type}) => type !== 'simulator');
       const device = matchingDevice(physicalDevices, args.device);
       if (device) {
         return runOnDevice(

packages/cli-platform-apple/src/tools/__tests__/listDevices.test.ts

@@ -13,7 +13,13 @@ jest.mock('execa', () => {
   return {sync: jest.fn()};
 });
 
-const xcrunOut = `
+beforeEach(() => {
+  (execa.sync as jest.Mock)
+    .mockReturnValueOnce({stdout: xcrunXcdeviceOut})
+    .mockReturnValueOnce({stdout: xcrunSimctlOut});
+});
+
+const xcrunXcdeviceOut = `
 [
   {
     "simulator" : true,
@@ -63,6 +69,19 @@ const xcrunOut = `
     "modelName" : "iPhone SE (3rd generation)",
     "name" : "iPhone SE (3rd generation)"
   },
+  {
+    "simulator" : true,
+    "operatingSystemVersion" : "17.0 (21A328)",
+    "available" : true,
+    "platform" : "com.apple.platform.iphonesimulator",
+    "modelCode" : "iPhone16,2",
+    "identifier" : "B3D623E3-9907-4E0A-B76B-13B13A47FE92",
+    "architecture" : "arm64",
+    "modelUTI" : "com.apple.iphone-15-pro-max-1",
+    "modelName" : "iPhone 15 Pro Max",
+    "name" : "iPhone 15 Pro Max",
+    "ignored" : false
+  },
   {
     "simulator" : false,
     "operatingSystemVersion" : "13.0.1 (22A400)",
@@ -161,9 +180,40 @@ const xcrunOut = `
 ]
 `;
 
+const xcrunSimctlOut = `
+{
+  "devices" : {
+    "com.apple.CoreSimulator.SimRuntime.iOS-16-2" : [
+      {
+        "lastBootedAt" : "2023-05-09T11:08:32Z",
+        "dataPath" : "<REPLACED_ROOT>/Library/Developer/CoreSimulator/Devices/54B1D3DE-A943-4867-BA6A-B82BFE3A7904/data",
+        "dataPathSize" : 4630163456,
+        "logPath" : "<REPLACED_ROOT>/Library/Logs/CoreSimulator/54B1D3DE-A943-4867-BA6A-B82BFE3A7904",
+        "udid" : "54B1D3DE-A943-4867-BA6A-B82BFE3A7904",
+        "isAvailable" : false,
+        "availabilityError" : "runtime profile not found using System match policy",
+        "deviceTypeIdentifier" : "com.apple.CoreSimulator.SimDeviceType.iPhone-14",
+        "state" : "Shutdown",
+        "name" : "iPhone 14"
+      },
+      {
+        "lastBootedAt" : "2024-01-07T15:33:06Z",
+        "dataPath" : "<REPLACED_ROOT>/Library/Developer/CoreSimulator/Devices/B3D623E3-9907-4E0A-B76B-13B13A47FE92/data",
+        "dataPathSize" : 4181225472,
+        "logPath" : "<REPLACED_ROOT>/Library/Logs/CoreSimulator/B3D623E3-9907-4E0A-B76B-13B13A47FE92",
+        "udid" : "B3D623E3-9907-4E0A-B76B-13B13A47FE92",
+        "isAvailable" : true,
+        "logPathSize" : 745472,
+        "deviceTypeIdentifier" : "com.apple.CoreSimulator.SimDeviceType.iPhone-15-Pro-Max",
+        "state" : "Shutdown",
+        "name" : "iPhone 15 Pro Max"
+      }
+    ]
+  }
+}`;
+
 describe('listDevices', () => {
-  it('parses output from xcdevice list for iOS', async () => {
-    (execa.sync as jest.Mock).mockReturnValueOnce({stdout: xcrunOut});
+  it('parses output list for iOS', async () => {
     const devices = await listDevices(['iphoneos', 'iphonesimulator']);
 
     // Find all available simulators
@@ -186,17 +236,6 @@ describe('listDevices', () => {
       type: 'simulator',
     });
 
-    // Find all available iPhone's event when not available
-    expect(devices).toContainEqual({
-      name: 'Adam’s iPhone',
-      isAvailable: false,
-      udid: '1234567890-0987654321',
-      version: '16.2 (20C65)',
-      sdk: 'com.apple.platform.iphoneos',
-      availabilityError:
-        'To use Adam’s iPhone for development, enable Developer Mode in Settings → Privacy & Security.',
-      type: 'device',
-    });
     // Filter out AppleTV
     expect(devices).not.toContainEqual({
       isAvailable: false,
@@ -227,8 +266,7 @@ describe('listDevices', () => {
     });
   });
 
-  it('parses output from xcdevice list for tvOS', async () => {
-    (execa.sync as jest.Mock).mockReturnValueOnce({stdout: xcrunOut});
+  it('parses output for tvOS', async () => {
     const devices = await listDevices(['appletvos', 'appletvsimulator']);
 
     // Filter out all available simulators
@@ -242,28 +280,7 @@ describe('listDevices', () => {
       type: 'simulator',
     });
 
-    // Filter out all available iPhone's event when not available
-    expect(devices).not.toContainEqual({
-      name: 'Adam’s iPhone',
-      isAvailable: false,
-      udid: '1234567890-0987654321',
-      version: '16.2 (20C65)',
-      sdk: 'com.apple.platform.iphoneos',
-      availabilityError:
-        'To use Adam’s iPhone for development, enable Developer Mode in Settings → Privacy & Security.',
-      type: 'device',
-    });
-
     // Find AppleTV
-    expect(devices).toContainEqual({
-      isAvailable: false,
-      name: 'Living Room',
-      udid: '7656fbf922891c8a2c7682c9d845eaa6954c24d8',
-      sdk: 'com.apple.platform.appletvos',
-      version: '16.1 (20K71)',
-      availabilityError: 'Living Room is not connected',
-      type: 'device',
-    });
     expect(devices).toContainEqual({
       isAvailable: true,
       name: 'Apple TV 4K (2nd generation)',
@@ -284,4 +301,28 @@ describe('listDevices', () => {
       type: 'device',
     });
   });
+
+  it('parses and merges output from two commands', async () => {
+    const devices = await listDevices(['iphoneos', 'iphonesimulator']);
+
+    expect(devices).toContainEqual({
+      availabilityError: undefined,
+      dataPath:
+        '<REPLACED_ROOT>/Library/Developer/CoreSimulator/Devices/B3D623E3-9907-4E0A-B76B-13B13A47FE92/data',
+      dataPathSize: 4181225472,
+      deviceTypeIdentifier:
+        'com.apple.CoreSimulator.SimDeviceType.iPhone-15-Pro-Max',
+      isAvailable: true,
+      lastBootedAt: '2024-01-07T15:33:06Z',
+      logPath:
+        '<REPLACED_ROOT>/Library/Logs/CoreSimulator/B3D623E3-9907-4E0A-B76B-13B13A47FE92',
+      logPathSize: 745472,
+      name: 'iPhone 15 Pro Max',
+      sdk: 'com.apple.platform.iphonesimulator',
+      state: 'Shutdown',
+      type: 'simulator',
+      udid: 'B3D623E3-9907-4E0A-B76B-13B13A47FE92',
+      version: '17.0 (21A328)',
+    });
+  });
 });

packages/cli-platform-apple/src/tools/getSimulators.ts

@@ -49,9 +49,45 @@ const parseXcdeviceList = (text: string, sdkNames: string[] = []): Device[] => {
   return devices;
 };
 
+/**
+ * Executes `xcrun xcdevice list` and `xcrun simctl list --json devices`, and connects parsed output of these two commands. We are running these two commands as they are necessary to display both physical devices and simulators. However, it's important to note that neither command provides a combined output of both.
+ * @param sdkNames
+ * @returns List of available devices and simulators.
+ */
 async function listDevices(sdkNames: string[]): Promise<Device[]> {
-  const out = execa.sync('xcrun', ['xcdevice', 'list']).stdout;
-  return parseXcdeviceList(out, sdkNames);
+  const xcdeviceOutput = execa.sync('xcrun', ['xcdevice', 'list']).stdout;
+  const parsedXcdeviceOutput = parseXcdeviceList(xcdeviceOutput, sdkNames);
+
+  const simctlOutput = JSON.parse(
+    execa.sync('xcrun', ['simctl', 'list', '--json', 'devices']).stdout,
+  );
+
+  const parsedSimctlOutput: Device[] = Object.keys(simctlOutput.devices)
+    .map((key) => simctlOutput.devices[key])
+    .reduce((acc, val) => acc.concat(val), []);
+
+  const merged: Device[] = [];
+  const matchedUdids = new Set();
+
+  parsedXcdeviceOutput.forEach((first) => {
+    const match = parsedSimctlOutput.find(
+      (second) => first.udid === second.udid,
+    );
+    if (match) {
+      matchedUdids.add(first.udid);
+      merged.push({...first, ...match});
+    } else {
+      merged.push({...first});
+    }
+  });
+
+  parsedSimctlOutput.forEach((item) => {
+    if (!matchedUdids.has(item.udid)) {
+      merged.push({...item});
+    }
+  });
+
+  return merged.filter(({isAvailable}) => isAvailable === true);
 }
 
 export function stripPlatform(platform: string): string {