WIP: feat(devicectl): Use devicectl for deploying to devices

Author: dpogue

lib/listDevices.js

@@ -1,42 +1,61 @@
-/*
-       Licensed to the Apache Software Foundation (ASF) under one
-       or more contributor license agreements.  See the NOTICE file
-       distributed with this work for additional information
-       regarding copyright ownership.  The ASF licenses this file
-       to you under the Apache License, Version 2.0 (the
-       "License"); you may not use this file except in compliance
-       with the License.  You may obtain a copy of the License at
-
-         http://www.apache.org/licenses/LICENSE-2.0
-
-       Unless required by applicable law or agreed to in writing,
-       software distributed under the License is distributed on an
-       "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-       KIND, either express or implied.  See the License for the
-       specific language governing permissions and limitations
-       under the License.
-*/
+/**
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
 
-const execa = require('execa');
+        http://www.apache.org/licenses/LICENSE-2.0
 
-const DEVICE_REGEX = /-o (iPhone|iPad|iPod)@.*?"USB Serial Number" = "([^"]*)"/gs;
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+*/
+
+const childProcess = require('node:child_process');
+const devicectl = require('devicectl');
 
 /**
- * Gets list of connected iOS devices
- * @return {Promise} Promise fulfilled with list of available iOS devices
+ * Gets list of available iOS devices for deployment.
+ * @return {Promise} Promise fulfilled with list of available iOS devices.
  */
 function listDevices () {
-    return execa('ioreg', ['-p', 'IOUSB', '-l'])
-        .then(({ stdout }) => {
-            return [...matchAll(stdout, DEVICE_REGEX)]
-                .map(m => m.slice(1).reverse().join(' '));
-        });
+    const availableDevices = listFromDeviceCtl();
+    const connectedDevices = listFromUSB();
+
+    // We prefer devicectl for newer devices, so filter out any duplicate
+    // devices from the ioreg list.
+    // Sadly the UDID format is very slightly different between the two...
+    const targets = availableDevices.map(d => d.target.replace('-', ''));
+    const devices = [].concat(availableDevices, connectedDevices.filter(d => !targets.includes(d.target)));
+
+    return Promise.resolve(devices.map(d => `${d.target} ${d.name}`));
+}
+
+function listFromDeviceCtl () {
+    const result = devicectl.list().json.result.devices;
+
+    return result
+        .filter((d) => d.connectionProperties.transportType === 'wired')
+        .map((d) => ({
+            target: d.hardwareProperties.udid,
+            name: `${d.deviceProperties.name} (${d.hardwareProperties.marketingName}, ${d.deviceProperties.osVersionNumber})`
+        }));
 }
 
-// TODO: Should be replaced with String#matchAll once available
-function * matchAll (s, r) {
-    let match;
-    while ((match = r.exec(s))) yield match;
+const DEVICE_REGEX = /-o (iPhone|iPad|iPod)@.*?"USB Serial Number" = "([^"]*)"/gs;
+function listFromUSB () {
+    const result = childProcess.spawnSync('ioreg', ['-p', 'IOUSB', '-l'], { encoding: 'utf8' });
+
+    return [...result.stdout.matchAll(DEVICE_REGEX)].map((m) => ({
+        target: m.pop(),
+        name: m.slice(1).reverse().join(' ')
+    }));
 }
 
 exports.run = listDevices;

lib/run.js

@@ -22,6 +22,7 @@ const path = require('node:path');
 const bplist = require('bplist-parser');
 const plist = require('plist');
 const execa = require('execa');
+const devicectl = require('devicectl');
 const { CordovaError, events } = require('cordova-common');
 const build = require('./build');
 const check_reqs = require('./check_reqs');
@@ -64,7 +65,11 @@ module.exports.run = function (runOptions) {
                         // we also explicitly set device flag in options as we pass
                         // those parameters to other api (build as an example)
                         runOptions.device = true;
-                        return check_reqs.check_ios_deploy();
+                        runOptions.target = devices[0].split(' ')[0];
+
+                        if (!runOptions.target.includes('-')) {
+                            return check_reqs.check_ios_deploy();
+                        }
                     }
                 });
             }
@@ -90,7 +95,7 @@ module.exports.run = function (runOptions) {
                 const buildOutputDir = path.join(projectPath, 'build', `${configuration}-iphoneos`);
                 const appPath = path.join(buildOutputDir, `${productName}.app`);
 
-                return module.exports.checkDeviceConnected()
+                return module.exports.checkDeviceConnected(runOptions.target)
                     .then(() => {
                         // Unpack IPA
                         const ipafile = path.join(buildOutputDir, `${productName}.ipa`);
@@ -172,8 +177,13 @@ function filterSupportedArgs (args) {
  * Checks if any iOS device is connected
  * @return {Promise} Fullfilled when any device is connected, rejected otherwise
  */
-function checkDeviceConnected () {
-    return execa('ios-deploy', ['-c', '-t', '1'], { stdio: 'inherit' });
+function checkDeviceConnected (target = '') {
+    if (target.includes('-')) {
+        const details = devicectl.info(devicectl.InfoTypes.Details, target).json?.result;
+        return details?.connectionProperties?.transportType === 'wired';
+    } else {
+        return execa('ios-deploy', ['-c', '-t', '1'], { stdio: 'inherit' });
+    }
 }
 
 /**
@@ -184,13 +194,19 @@ function checkDeviceConnected () {
  */
 function deployToDevice (appPath, target, extraArgs) {
     events.emit('log', 'Deploying to device');
-    const args = ['--justlaunch', '-d', '-b', appPath];
-    if (target) {
-        args.push('-i', target);
+    if (target.includes('-')) {
+        return devicectl.install(target, appPath)
+            .then(() => getBundleIdentifierFromApp(appPath))
+            .then(appIdentifier => devicectl.launch(target, appIdentifier, extraArgs));
     } else {
-        args.push('--no-wifi');
+        const args = ['--justlaunch', '-d', '-b', appPath];
+        if (target) {
+            args.push('-i', target);
+        } else {
+            args.push('--no-wifi');
+        }
+        return execa('ios-deploy', args.concat(extraArgs), { stdio: 'inherit' });
     }
-    return execa('ios-deploy', args.concat(extraArgs), { stdio: 'inherit' });
 }
 
 /**
@@ -223,48 +239,52 @@ async function deployToSim (appPath, target) {
     return module.exports.startSim(appPath, target);
 }
 
-async function startSim (appPath, target) {
-    const projectPath = path.join(path.dirname(appPath), '../..');
-    const logPath = path.join(projectPath, 'cordova/console.log');
-    const deviceTypeId = `com.apple.CoreSimulator.SimDeviceType.${target}`;
-
-    try {
-        const infoPlistPath = path.join(appPath, 'Info.plist');
-        if (!fs.existsSync(infoPlistPath)) {
-            throw new Error(`${infoPlistPath} file not found.`);
-        }
-
-        bplist.parseFile(infoPlistPath, function (err, obj) {
-            let appIdentifier;
+function getBundleIdentifierFromApp (appPath) {
+    const infoPlistPath = path.join(appPath, 'Info.plist');
+    if (!fs.existsSync(infoPlistPath)) {
+        return Promise.reject(new Error(`${infoPlistPath} file not found.`));
+    }
 
+    return new Promise((resolve, reject) => {
+        bplist.parseFile(infoPlistPath, (err, obj) => {
             if (err) {
                 obj = plist.parse(fs.readFileSync(infoPlistPath, 'utf8'));
                 if (obj) {
-                    appIdentifier = obj.CFBundleIdentifier;
+                    return resolve(obj.CFBundleIdentifier);
                 } else {
-                    throw err;
+                    return reject(err);
                 }
             } else {
-                appIdentifier = obj[0].CFBundleIdentifier;
+                return resolve(obj[0].CFBundleIdentifier);
             }
+        });
+    });
+}
 
-            // get the deviceid from --devicetypeid
-            // --devicetypeid is a string in the form "devicetype, runtime_version" (optional: runtime_version)
-            const device = getDeviceFromDeviceTypeId(deviceTypeId);
+async function startSim (appPath, target) {
+    const projectPath = path.join(path.dirname(appPath), '../..');
+    const logPath = path.join(projectPath, 'cordova/console.log');
+    const deviceTypeId = `com.apple.CoreSimulator.SimDeviceType.${target}`;
 
-            // so now we have the deviceid, we can proceed
-            try {
-                startSimulator(device, { appPath, appIdentifier, logPath, waitForDebugger: false });
-            } catch (e) {
-                events.emit('warn', `Failed to start simulator with error: "${e.message}"`);
-            }
+    try {
+        const appIdentifier = await getBundleIdentifierFromApp(appPath);
 
-            if (logPath) {
-                events.emit('log', `Log Path: ${path.resolve(logPath)}`);
-            }
+        // get the deviceid from --devicetypeid
+        // --devicetypeid is a string in the form "devicetype, runtime_version" (optional: runtime_version)
+        const device = getDeviceFromDeviceTypeId(deviceTypeId);
 
-            process.exit(0);
-        });
+        // so now we have the deviceid, we can proceed
+        try {
+            startSimulator(device, { appPath, appIdentifier, logPath, waitForDebugger: false });
+        } catch (e) {
+            events.emit('warn', `Failed to start simulator with error: "${e.message}"`);
+        }
+
+        if (logPath) {
+            events.emit('log', `Log Path: ${path.resolve(logPath)}`);
+        }
+
+        process.exit(0);
     } catch (e) {
         events.emit('warn', `Failed to launch simulator with error: ${e.message}`);
         process.exit(1);

package-lock.json

@@ -35,9 +35,15 @@
   "engines": {
     "node": "^20.17.0 || >=22.9.0"
   },
+  "exports": {
+    ".": "./lib/Api.js",
+    "./package.json": "./package.json",
+    "./lib/*": "./lib/*.js"
+  },
   "dependencies": {
     "bplist-parser": "^0.3.2",
     "cordova-common": "^6.0.0",
+    "devicectl": "^0.0.1",
     "elementtree": "^0.1.7",
     "execa": "^5.1.1",
     "nopt": "^9.0.0",

package.json

@@ -24,6 +24,72 @@
   |   "IOKitDiagnostics" = {"Foobar"="Foobar"}
   | }
   |
+  +-o AppleT6000USBXHCI@02000000  <class AppleT6000USBXHCI, id 0x100000473, registered, matched, active, busy 0 (598 ms), retain 98>
+  | | {
+  | |   "IOClass" = "AppleT6000USBXHCI"
+  | |   "kUSBSleepPortCurrentLimit" = 3000
+  | |   "UsbHostControllerSoftRetryPolicy" = 0
+  | |   "IOPersonalityPublisher" = "com.apple.driver.usb.AppleSynopsysUSB40XHCI"
+  | |   "IOMatchedAtBoot" = Yes
+  | |   "IOPowerManagement" = {"ChildrenPowerState"=3,"DevicePowerState"=0,"CurrentPowerState"=3,"CapabilityFlags"=32768,"MaxPowerState"=3,"DriverPowerState"=0}
+  | |   "IOProviderClass" = "AppleARMIODevice"
+  | |   "IOProbeScore" = 10002
+  | |   "locationID" = 33554432
+  | |   "kUSBWakePortCurrentLimit" = 3000
+  | |   "IONameMatch" = "usb-drd,t6000"
+  | |   "CFBundleIdentifierKernel" = "com.apple.driver.usb.AppleSynopsysUSB40XHCI"
+  | |   "UsbHostControllerDeferRegisterService" = Yes
+  | |   "IOMatchCategory" = "usb-host"
+  | |   "CFBundleIdentifier" = "com.apple.driver.usb.AppleSynopsysUSB40XHCI"
+  | |   "Revision" = <0103>
+  | |   "IONameMatched" = "usb-drd,t6000"
+  | |   "UsbHostControllerUSB4LPMPolicy" = 1
+  | |   "UsbHostControllerTierLimit" = 6
+  | |   "controller-statistics" = {"kControllerStatIOCount"=46575,"kControllerStatPowerStateTime"={"kPowerStateInitialize"="0ms (0%)","kPowerStateOff"="327655037ms (97%)","kPowerStateSle$
+  | |   "kUSBSleepSupported" = Yes
+  | | }
+  | |
+  | +-o iPad@02100000  <class IOUSBHostDevice, id 0x1003271c8, registered, matched, active, busy 0 (276 ms), retain 62>
+  |     {
+  |       "kUSBSerialNumberString" = "IPADMINI_UDID"
+  |       "bDeviceClass" = 0
+  |       "UsbAppleDeviceECID" = 6259374711472158
+  |       "bDeviceSubClass" = 0
+  |       "iSerialNumber" = 3
+  |       "UsbPowerSinkCapability" = 2400
+  |       "IOServiceDEXTEntitlements" = (("com.apple.developer.driverkit.transport.usb"))
+  |       "iProduct" = 2
+  |       "USB Serial Number" = "IPADMINI_UDID"
+  |       "USB Vendor Name" = "Apple Inc."
+  |       "USBSpeed" = 3
+  |       "IOPowerManagement" = {"PowerOverrideOn"=Yes,"DevicePowerState"=2,"CurrentPowerState"=2,"CapabilityFlags"=32768,"MaxPowerState"=2,"DriverPowerState"=0}
+  |       "bNumConfigurations" = 5
+  |       "kUSBProductString" = "iPad"
+  |       "kCDCDoNotMatchThisDevice" = Yes
+  |       "kCallInterfaceOpenWithGate" = Yes
+  |       "kUSBVendorString" = "Apple Inc."
+  |       "USB Product Name" = "iPad"
+  |       "iManufacturer" = 1
+  |       "idVendor" = 1452
+  |       "Device Speed" = 2
+  |       "kUSBCurrentConfiguration" = 5
+  |       "idProduct" = 4779
+  |       "bcdDevice" = 5121
+  |       "UsbDeviceSignature" = <ac05ab120114303030303831313030303136334344453345333138303145000000060101010100010200030000fffe02fffd01020d000a0001>
+  |       "sessionID" = 7864622857660
+  |       "USB Address" = 1
+  |       "kUSBPreferredConfiguration" = 3
+  |       "IOCFPlugInTypes" = {"9dc7b780-9ec0-11d4-a54f-000a27052861"="IOUSBHostFamily.kext/Contents/PlugIns/IOUSBLib.bundle"}
+  |       "SupportsIPhoneOS" = Yes
+  |       "USBPortType" = 0
+  |       "bDeviceProtocol" = 0
+  |       "locationID" = 34603008
+  |       "kUSBAddress" = 1
+  |       "bcdUSB" = 528
+  |       "IOGeneralInterest" = "IOCommand is not serializable"
+  |       "bMaxPacketSize0" = 64
+  |     }
+  |
   +-o AppleUSBXHCI Root Hub Simulation@14000000  <class AppleUSBRootHubDevice, id 0x100020cab, registered, matched, active, busy 0 (2 ms), retain 9>
     | {
     |   "iManufacturer" = 0