Skip to content

fix: Use devicectl while listing available device udids #2648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 3, 2025
+9 −4
Merged

fix: Use devicectl while listing available device udids #2648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f27d91
fix: Use devicectl while listing available device udids
mykola-mokhnach Nov 2, 2025
cba2a7b
format
mykola-mokhnach Nov 2, 2025
4115e66
use env flag instead
mykola-mokhnach Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions lib/real-device-management.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import _ from 'lodash';
import {buildSafariPreferences} from './app-utils';
import {utilities} from 'appium-ios-device';
import { getConnectedDevices } from './real-device';

const DEFAULT_APP_INSTALLATION_TIMEOUT_MS = 8 * 60 * 1000;

Expand Down Expand Up @@ -114,11 +114,11 @@ export function applySafariStartupArgs() {
*/
export async function detectUdid() {
this.log.debug('Auto-detecting real device udid...');
const udids = await utilities.getConnectedDevices();
const udids = await getConnectedDevices();
if (_.isEmpty(udids)) {
throw new Error('No real devices are connected to the host');
}
const udid = _.last(udids);
const udid = udids[udids.length - 1];
if (udids.length > 1) {
this.log.info(`Multiple devices found: ${udids.join(', ')}`);
this.log.info(`Choosing '${udid}'. Consider settings the 'udid' capability if another device must be selected`);
Expand Down
5 changes: 5 additions & 0 deletions lib/real-device.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ const INSTALLATION_STAGING_DIR = 'PublicStaging';
* @returns {Promise<string[]>}
*/
export async function getConnectedDevices() {
if (['yes', 'true', '1'].includes(_.toLower(process.env.APPIUM_XCUITEST_PREFER_DEVICECTL))) {
return (await new Devicectl('').listDevices())
.map(({hardwareProperties}) => hardwareProperties?.udid)
.filter(Boolean);
}
return await utilities.getConnectedDevices();
Copy link
Member

@KazuCocoa KazuCocoa Nov 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The devicectl command could have a situation that doesn't work or conflict if the same env has core device service injected (e.g. 3rd party tools) So, this could be a breaking change for such a condition.

Currently, this may help only for tvOS (and env which doesn't expose usbmuxd for wifi-connected devices), thus maybe it makes sense to add a new capability to use devicectl prior to appium-ios-device

Copy link
Contributor Author

@mykola-mokhnach mykola-mokhnach Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the logic to use an env flag instead. I do't want to introduce a new capability as I expect this solution to be temporary until we fully ditch appium-ios-device and switch to appium-ios-remotexpc usage

}

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
"lru-cache": "^11.1.0",
"moment": "^2.29.4",
"moment-timezone": "^0.x",
"node-devicectl": "^1.0.1",
"node-devicectl": "^1.1.0",
"node-simctl": "^8.0.0",
"portscanner": "^2.2.0",
"semver": "^7.5.4",
Expand Down
Loading