feat: use isIos18OrNewer to check version instead of ios-device util (#2716)

* use `isIos18OrNewer` to check version instead of ios-device util

* make `driverOpts` non-optional param

Author: navin772

lib/device/real-device-management.ts

@@ -7,8 +7,9 @@ import {buildSafariPreferences, SAFARI_BUNDLE_ID} from '../app-utils';
 import {log as defaultLogger} from '../logger';
 import { Devicectl } from 'node-devicectl';
 import type { AppiumLogger } from '@appium/types';
-import type { XCUITestDriver } from '../driver';
+import type { XCUITestDriver, XCUITestDriverOpts } from '../driver';
 import {AfcClient} from './afc-client';
+import {isIos18OrNewer} from '../utils';
 
 const DEFAULT_APP_INSTALLATION_TIMEOUT_MS = 8 * 60 * 1000;
 export const IO_TIMEOUT_MS = 4 * 60 * 1000;
@@ -264,10 +265,11 @@ export class RealDevice {
   readonly udid: string;
   private readonly _log: AppiumLogger;
   readonly devicectl: Devicectl;
-  private platformVersion: string | undefined;
+  readonly driverOpts: XCUITestDriverOpts;
 
-  constructor(udid: string, logger?: AppiumLogger) {
+  constructor(udid: string, driverOpts: XCUITestDriverOpts, logger?: AppiumLogger) {
     this.udid = udid;
+    this.driverOpts = driverOpts;
     this._log = logger ?? defaultLogger;
     this.devicectl = new Devicectl(this.udid);
   }
@@ -294,8 +296,7 @@ export class RealDevice {
       timeoutMs = IO_TIMEOUT_MS,
     } = opts;
     const timer = new timing.Timer().start();
-    const platformVersion = await this.getPlatformVersion();
-    const useRemoteXPC = !!platformVersion && util.compareVersions(platformVersion, '>=', '18.0');
+    const useRemoteXPC = isIos18OrNewer(this.driverOpts);
     const afcClient = await AfcClient.createForDevice(this.udid, useRemoteXPC);
     try {
       let bundlePathOnPhone: string;
@@ -516,10 +517,7 @@ export class RealDevice {
   }
 
   async getPlatformVersion(): Promise<string> {
-    if (!this.platformVersion) {
-      this.platformVersion = await utilities.getOSVersion(this.udid) as string;
-    }
-    return this.platformVersion;
+    return await utilities.getOSVersion(this.udid);
   }
 
   async reset(opts: {bundleId?: string; fullReset?: boolean}): Promise<void> {

lib/driver.ts

@@ -1362,7 +1362,7 @@ export class XCUITestDriver
       }
 
       this.log.debug(`Creating iDevice object with udid '${this.opts.udid}'`);
-      const device = new RealDevice(this.opts.udid as string, this.log);
+      const device = new RealDevice(this.opts.udid as string, this.opts, this.log);
       return {device, realDevice: true, udid: this.opts.udid as string};
     }
 

test/unit/commands/location-specs.ts

@@ -1,5 +1,5 @@
 import sinon from 'sinon';
-import {XCUITestDriver} from '../../../lib/driver';
+import {XCUITestDriver, XCUITestDriverOpts} from '../../../lib/driver';
 import {services} from 'appium-ios-device';
 import {RealDevice} from '../../../lib/device/real-device-management';
 import {expect} from 'chai';
@@ -77,7 +77,7 @@ describe('location commands', function () {
     describe('on real device', function () {
       beforeEach(function () {
         driver.opts.udid = udid;
-        driver._device = new RealDevice('123');
+        driver._device = new RealDevice('123', {} as XCUITestDriverOpts);
       });
 
       it('should use location service to set a location when no platform version', async function () {

test/unit/driver-specs.ts

@@ -2,7 +2,7 @@ import xcode from 'appium-xcode';
 import {JWProxy} from 'appium/driver';
 import _ from 'lodash';
 import {createSandbox} from 'sinon';
-import {XCUITestDriver} from '../../lib/driver';
+import {XCUITestDriver, XCUITestDriverOpts} from '../../lib/driver';
 import * as utils from '../../lib/utils';
 import {MOCHA_LONG_TIMEOUT} from './helpers';
 import {RealDevice} from '../../lib/device/real-device-management';
@@ -39,7 +39,7 @@ describe('XCUITestDriver', function () {
 
     beforeEach(function () {
       driver = new XCUITestDriver({} as any);
-      realDevice = new RealDevice('1234');
+      realDevice = new RealDevice('1234', {} as XCUITestDriverOpts);
       // Mock _wda to avoid getter throwing error
       // For simulators, url.port should be undefined to allow wdaLocalPort to be used
       driver._wda = {

test/unit/real-device-management-specs.ts

@@ -1,6 +1,6 @@
 import {createSandbox} from 'sinon';
 import { installToRealDevice, RealDevice } from '../../lib/device/real-device-management';
-import {XCUITestDriver} from '../../lib/driver';
+import {XCUITestDriver, XCUITestDriverOpts} from '../../lib/driver';
 import chai, {expect} from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 import type {SinonStub} from 'sinon';
@@ -25,7 +25,7 @@ describe('installToRealDevice', function () {
   });
 
   it('nothing happen without app', async function () {
-    const realDevice = new RealDevice(udid);
+    const realDevice = new RealDevice(udid, {} as XCUITestDriverOpts);
     const removeStub = sandbox.stub(realDevice, 'remove').resolves() as SinonStub;
     const installStub = sandbox.stub(realDevice, 'install').resolves() as SinonStub;
     driver.opts = {udid};
@@ -37,7 +37,7 @@ describe('installToRealDevice', function () {
   });
 
   it('nothing happen without bundle id', async function () {
-    const realDevice = new RealDevice(udid);
+    const realDevice = new RealDevice(udid, {} as XCUITestDriverOpts);
     const removeStub = sandbox.stub(realDevice, 'remove').resolves() as SinonStub;
     const installStub = sandbox.stub(realDevice, 'install').resolves() as SinonStub;
     driver._device = realDevice;
@@ -52,7 +52,7 @@ describe('installToRealDevice', function () {
     const opts = {
       skipUninstall: true
     };
-    const realDevice = new RealDevice(udid);
+    const realDevice = new RealDevice(udid, {} as XCUITestDriverOpts);
     const removeStub = sandbox.stub(realDevice, 'remove').resolves() as SinonStub;
     const installStub = sandbox.stub(realDevice, 'install').resolves() as SinonStub;
     driver._device = realDevice;
@@ -68,7 +68,7 @@ describe('installToRealDevice', function () {
     const opts = {
       skipUninstall: false
     };
-    const realDevice = new RealDevice(udid);
+    const realDevice = new RealDevice(udid, {} as XCUITestDriverOpts);
     const removeStub = sandbox.stub(realDevice, 'remove').resolves() as SinonStub;
     const installStub = sandbox.stub(realDevice, 'install').resolves() as SinonStub;
     driver._device = realDevice;
@@ -85,7 +85,7 @@ describe('installToRealDevice', function () {
       skipUninstall: false
     };
     const err_msg = `{"Error":"ApplicationVerificationFailed","ErrorDetail":-402620395,"ErrorDescription":"Failed to verify code signature of /path/to.app : 0xe8008015 (A valid provisioning profile for this executable was not found.)"}`;
-    const realDevice = new RealDevice(udid);
+    const realDevice = new RealDevice(udid, {} as XCUITestDriverOpts);
     const removeStub = sandbox.stub(realDevice, 'remove').resolves() as SinonStub;
     const installStub = sandbox.stub(realDevice, 'install').throws(err_msg) as SinonStub;
     driver._device = realDevice;
@@ -102,7 +102,7 @@ describe('installToRealDevice', function () {
     const opts = {
       skipUninstall: true
     };
-    const realDevice = new RealDevice(udid);
+    const realDevice = new RealDevice(udid, {} as XCUITestDriverOpts);
     const removeStub = sandbox.stub(realDevice, 'remove').resolves() as SinonStub;
     const installStub = sandbox.stub(realDevice, 'install')
       .onCall(0).throws(`{"Error":"MismatchedApplicationIdentifierEntitlement","ErrorDescription":"Upgrade's application-identifier entitlement string (TEAM_ID.com.kazucocoa.example) does not match installed application's application-identifier string (ANOTHER_TEAM_ID.com.kazucocoa.example); rejecting upgrade."}`)
@@ -121,7 +121,7 @@ describe('installToRealDevice', function () {
       skipUninstall: true
     };
     const err_msg = `{"Error":"ApplicationVerificationFailed","ErrorDetail":-402620395,"ErrorDescription":"Failed to verify code signature of /path/to.app : 0xe8008015 (A valid provisioning profile for this executable was not found.)"}`;
-    const realDevice = new RealDevice(udid);
+    const realDevice = new RealDevice(udid, {} as XCUITestDriverOpts);
     const removeStub = sandbox.stub(realDevice, 'remove').resolves() as SinonStub;
     const installStub = sandbox.stub(realDevice, 'install').throws(err_msg) as SinonStub;
     sandbox.stub(realDevice, 'isAppInstalled').resolves(true);