appium-xcuitest-driver 10.8.4 → 10.9.0

package/build/lib/driver.js

@@ -101,7 +101,7 @@ const desired_caps_1 = require("./desired-caps");
 const device_connections_factory_1 = require("./device/device-connections-factory");
 const execute_method_map_1 = require("./execute-method-map");
 const method_map_1 = require("./method-map");
-const py_ios_device_client_1 = require("./real-device-clients/py-ios-device-client");
+const py_ios_device_client_1 = require("./device/clients/py-ios-device-client");
 const real_device_management_1 = require("./device/real-device-management");
 const simulator_management_1 = require("./device/simulator-management");
 const utils_1 = require("./utils");
@@ -146,7 +146,6 @@ const WEB_ELEMENTS_CACHE_SIZE = 500;
 const SUPPORTED_ORIENATIONS = ['LANDSCAPE', 'PORTRAIT'];
 const DEFAULT_MJPEG_SERVER_PORT = 9100;
 /* eslint-disable no-useless-escape */
-/** @type {import('@appium/types').RouteMatcher[]} */
 const NO_PROXY_NATIVE_LIST = [
     ['DELETE', /window/],
     ['GET', /^\/session\/[^\/]+$/],
@@ -193,7 +192,7 @@ const NO_PROXY_NATIVE_LIST = [
     ['GET', /cookie/],
     ['POST', /cookie/],
 ];
-const NO_PROXY_WEB_LIST = /** @type {import('@appium/types').RouteMatcher[]} */ ([
+const NO_PROXY_WEB_LIST = [
     ['GET', /attribute/],
     ['GET', /element/],
     ['GET', /text/],
@@ -205,89 +204,55 @@ const NO_PROXY_WEB_LIST = /** @type {import('@appium/types').RouteMatcher[]} */
     ['POST', /frame/],
     ['POST', /keys/],
     ['POST', /refresh/],
-]).concat(NO_PROXY_NATIVE_LIST);
+    ...NO_PROXY_NATIVE_LIST,
+];
 /* eslint-enable no-useless-escape */
 const MEMOIZED_FUNCTIONS = ['getStatusBarHeight', 'getDevicePixelRatio', 'getScreenInfo'];
 // Capabilities that do not have xcodebuild process
 const CAP_NAMES_NO_XCODEBUILD_REQUIRED = ['webDriverAgentUrl', 'usePreinstalledWDA'];
 const BUNDLE_VERSION_PATTERN = /CFBundleVersion\s+=\s+"?([^(;|")]+)/;
-/**
- * @implements {ExternalDriver<XCUITestDriverConstraints, FullContext|string>}
- * @extends {BaseDriver<XCUITestDriverConstraints>}
- * @privateRemarks **This class should be considered "final"**. It cannot be extended
- * due to use of public class field assignments.  If extending this class becomes a hard requirement, refer to the implementation of `BaseDriver` on how to do so.
- */
 class XCUITestDriver extends driver_1.BaseDriver {
     static newMethodMap = method_map_1.newMethodMap;
     static executeMethodMap = execute_method_map_1.executeMethodMap;
-    /** @type {string|null|undefined} */
     curWindowHandle;
-    /**
-     * @type {boolean|undefined}
-     */
     selectingNewPage;
-    /** @type {string[]} */
     contexts;
-    /** @type {string|null} */
     curContext;
-    /** @type {string[]} */
     curWebFrames;
-    /** @type {import('./types').CalibrationData|null} */
     webviewCalibrationResult;
-    /** @type {import('./types').AsyncPromise|undefined} */
     asyncPromise;
-    /** @type {number|undefined} */
     asyncWaitMs;
-    /** @type {((logRecord: {message: string}) => void)|null} */
     _syslogWebsocketListener;
-    /** @type {import('./commands/performance').PerfRecorder[]} */
     _perfRecorders;
-    /** @type {LRUCache} */
     webElementsCache;
-    /**
-     * @type {any|null}
-     * @privateRemarks needs types
-     **/
-    _conditionInducerService;
-    /**
-     * @type {import('./commands/condition.js').DVTServiceWithConnection|null}
-     * @privateRemarks RemoteXPC DVT connection for iOS>=18 condition inducer
-     **/
-    _remoteXPCConditionInducerConnection;
-    /** @type {boolean|undefined} */
+    _conditionInducerService; // needs types
+    _remoteXPCConditionInducerConnection; // RemoteXPC DVT connection for iOS>=18 condition inducer
     _isSafariIphone;
-    /** @type {boolean|undefined} */
     _isSafariNotched;
-    /** @type {import('./commands/types').WaitingAtoms} */
     _waitingAtoms;
-    /** @type {import('./types').LifecycleData} */
     lifecycleData;
-    /** @type {import('./commands/record-audio').AudioRecorder|null} */
     _audioRecorder;
-    /** @type {XcodeVersion|undefined} */
     xcodeVersion;
-    /** @type {import('./commands/pcap').TrafficCapture|null} */
     _trafficCapture;
-    /** @type {import('./commands/recordscreen').ScreenRecorder|null} */
     _recentScreenRecorder;
-    /** @type {Simulator|RealDevice} */
     _device;
-    /** @type {string|null} */
     _iosSdkVersion;
-    /** @type {WebDriverAgent} */
-    wda;
-    /** @type {import('appium-remote-debugger').RemoteDebugger|null} */
+    _wda;
     remote;
-    /** @type {DriverLogs} */
     logs;
-    /** @type {import('./commands/types').LogListener|undefined} */
     _bidiServerLogListener;
-    /**
-     *
-     * @param {XCUITestDriverOpts} opts
-     * @param {boolean} shouldValidateCaps
-     */
-    constructor(opts = /** @type {XCUITestDriverOpts} */ ({}), shouldValidateCaps = true) {
+    // Additional properties that were missing
+    appInfosCache;
+    doesSupportBidi;
+    jwpProxyActive;
+    proxyReqRes;
+    safari;
+    cachedWdaStatus;
+    _currentUrl;
+    pageLoadMs;
+    landscapeWebCoordsOffset;
+    mjpegStream;
+    constructor(opts, shouldValidateCaps = true) {
         super(opts, shouldValidateCaps);
         this.locatorStrategies = [
             'xpath',
@@ -331,7 +296,295 @@ class XCUITestDriver extends driver_1.BaseDriver {
         this.appInfosCache = new app_infos_cache_1.AppInfosCache(this.log);
         this.remote = null;
         this.doesSupportBidi = true;
+        this._wda = null;
+    }
+    // Override methods from BaseDriver
+    async createSession(w3cCaps1, w3cCaps2, w3cCaps3, driverData) {
+        try {
+            const [sessionId, initialCaps] = await super.createSession(w3cCaps1, w3cCaps2, w3cCaps3, driverData);
+            let caps = initialCaps;
+            // merge cli args to opts, and if we did merge any, revalidate opts to ensure the final set
+            // is also consistent
+            if (this.mergeCliArgsToOpts()) {
+                this.validateDesiredCaps({ ...caps, ...this.cliArgs });
+            }
+            await this.start();
+            // merge server capabilities + desired capabilities
+            caps = { ...defaultServerCaps, ...caps };
+            // update the udid with what is actually used
+            caps.udid = this.opts.udid;
+            // ensure we track nativeWebTap capability as a setting as well
+            if (lodash_1.default.has(this.opts, 'nativeWebTap')) {
+                await this.updateSettings({ nativeWebTap: this.opts.nativeWebTap });
+            }
+            // ensure we track nativeWebTapStrict capability as a setting as well
+            if (lodash_1.default.has(this.opts, 'nativeWebTapStrict')) {
+                await this.updateSettings({ nativeWebTapStrict: this.opts.nativeWebTapStrict });
+            }
+            // ensure we track useJSONSource capability as a setting as well
+            if (lodash_1.default.has(this.opts, 'useJSONSource')) {
+                await this.updateSettings({ useJSONSource: this.opts.useJSONSource });
+            }
+            const wdaSettings = {
+                elementResponseAttributes: DEFAULT_SETTINGS.elementResponseAttributes,
+                shouldUseCompactResponses: DEFAULT_SETTINGS.shouldUseCompactResponses,
+            };
+            if ('elementResponseAttributes' in this.opts && lodash_1.default.isString(this.opts.elementResponseAttributes)) {
+                wdaSettings.elementResponseAttributes = this.opts.elementResponseAttributes;
+            }
+            if ('shouldUseCompactResponses' in this.opts && lodash_1.default.isBoolean(this.opts.shouldUseCompactResponses)) {
+                wdaSettings.shouldUseCompactResponses = this.opts.shouldUseCompactResponses;
+            }
+            if ('mjpegServerScreenshotQuality' in this.opts && lodash_1.default.isNumber(this.opts.mjpegServerScreenshotQuality)) {
+                wdaSettings.mjpegServerScreenshotQuality = this.opts.mjpegServerScreenshotQuality;
+            }
+            if ('mjpegServerFramerate' in this.opts && lodash_1.default.isNumber(this.opts.mjpegServerFramerate)) {
+                wdaSettings.mjpegServerFramerate = this.opts.mjpegServerFramerate;
+            }
+            if (lodash_1.default.has(this.opts, 'screenshotQuality')) {
+                this.log.info(`Setting the quality of phone screenshot: '${this.opts.screenshotQuality}'`);
+                wdaSettings.screenshotQuality = this.opts.screenshotQuality;
+            }
+            // ensure WDA gets our defaults instead of whatever its own might be
+            await this.updateSettings(wdaSettings);
+            await this.handleMjpegOptions();
+            return [
+                sessionId,
+                caps,
+            ];
+        }
+        catch (e) {
+            this.log.error(JSON.stringify(e));
+            await this.deleteSession();
+            throw e;
+        }
+    }
+    async deleteSession(sessionId) {
+        await utils_1.removeAllSessionWebSocketHandlers.bind(this)();
+        for (const recorder of lodash_1.default.compact([
+            this._recentScreenRecorder,
+            this._audioRecorder,
+            this._trafficCapture,
+        ])) {
+            await recorder.interrupt(true);
+            await recorder.cleanup();
+        }
+        if (!lodash_1.default.isEmpty(this._perfRecorders)) {
+            await bluebird_1.default.all(this._perfRecorders.map((x) => x.stop(true)));
+            this._perfRecorders = [];
+        }
+        if (this._conditionInducerService || this._remoteXPCConditionInducerConnection) {
+            try {
+                await this.disableConditionInducer();
+            }
+            catch (err) {
+                this.log.warn(`Cannot disable condition inducer: ${err.message}`);
+            }
+        }
+        await this.stop();
+        if (this._wda && this.isXcodebuildNeeded()) {
+            if (this.opts.clearSystemFiles) {
+                let synchronizationKey = XCUITestDriver.name;
+                const derivedDataPath = await this.wda.retrieveDerivedDataPath();
+                if (derivedDataPath) {
+                    synchronizationKey = node_path_1.default.normalize(derivedDataPath);
+                }
+                await SHARED_RESOURCES_GUARD.acquire(synchronizationKey, async () => {
+                    await (0, utils_1.clearSystemFiles)(this.wda);
+                });
+            }
+            else {
+                this.log.debug('Not clearing log files. Use `clearSystemFiles` capability to turn on.');
+            }
+        }
+        if (this.remote) {
+            this.log.debug('Found a remote debugger session. Removing...');
+            await this.stopRemote();
+        }
+        if (this.opts.resetOnSessionStartOnly === false) {
+            await this.runReset(true);
+        }
+        const simulatorDevice = this.isSimulator() ? this.device : null;
+        if (simulatorDevice && this.lifecycleData.createSim) {
+            this.log.debug(`Deleting simulator created for this run (udid: '${simulatorDevice.udid}')`);
+            await simulator_management_1.shutdownSimulator.bind(this)();
+            await simulatorDevice.delete();
+        }
+        const shouldResetLocationService = this.isRealDevice() && !!this.opts.resetLocationService;
+        if (shouldResetLocationService) {
+            try {
+                await this.mobileResetLocationService();
+            }
+            catch {
+                /* Ignore this error since mobileResetLocationService already logged the error */
+            }
+        }
+        await this.logs.syslog?.stopCapture();
+        lodash_1.default.values(this.logs).forEach((x) => x?.removeAllListeners?.());
+        if (this._bidiServerLogListener) {
+            this.log.unwrap().off('log', this._bidiServerLogListener);
+        }
+        this.logs = {};
+        if (this.mjpegStream) {
+            this.log.info('Closing MJPEG stream');
+            this.mjpegStream.stop();
+        }
+        this.resetIos();
+        await super.deleteSession(sessionId);
+    }
+    async executeCommand(cmd, ...args) {
+        this.log.debug(`Executing command '${cmd}'`);
+        if (cmd === 'receiveAsyncResponse') {
+            return await this.receiveAsyncResponse(...args);
+        }
+        // TODO: once this fix gets into base driver remove from here
+        if (cmd === 'getStatus') {
+            return await this.getStatus();
+        }
+        return await super.executeCommand(cmd, ...args);
+    }
+    proxyActive() {
+        return Boolean(this.jwpProxyActive);
+    }
+    getProxyAvoidList() {
+        if (this.isWebview()) {
+            return NO_PROXY_WEB_LIST;
+        }
+        return NO_PROXY_NATIVE_LIST;
+    }
+    canProxy() {
+        return true;
+    }
+    validateLocatorStrategy(strategy) {
+        super.validateLocatorStrategy(strategy, this.isWebContext());
     }
+    validateDesiredCaps(caps) {
+        if (!super.validateDesiredCaps(caps)) {
+            return false;
+        }
+        // make sure that the capabilities have one of `app` or `bundleId`
+        if (lodash_1.default.toLower(caps.browserName) !== 'safari' && !caps.app && !caps.bundleId) {
+            this.log.info('The desired capabilities include neither an app nor a bundleId. ' +
+                'WebDriverAgent will be started without the default app');
+        }
+        if (!support_1.util.coerceVersion(String(caps.platformVersion), false)) {
+            this.log.warn(`'platformVersion' capability ('${caps.platformVersion}') is not a valid version number. ` +
+                `Consider fixing it or be ready to experience an inconsistent driver behavior.`);
+        }
+        const verifyProcessArgument = (processArguments) => {
+            const { args, env } = processArguments;
+            if (!lodash_1.default.isNil(args) && !lodash_1.default.isArray(args)) {
+                throw this.log.errorWithException('processArguments.args must be an array of strings');
+            }
+            if (!lodash_1.default.isNil(env) && !lodash_1.default.isPlainObject(env)) {
+                throw this.log.errorWithException('processArguments.env must be an object <key,value> pair {a:b, c:d}');
+            }
+        };
+        // `processArguments` should be JSON string or an object with arguments and/ environment details
+        if (caps.processArguments) {
+            if (lodash_1.default.isString(caps.processArguments)) {
+                try {
+                    // try to parse the string as JSON
+                    caps.processArguments = JSON.parse(caps.processArguments);
+                    verifyProcessArgument(caps.processArguments);
+                }
+                catch (err) {
+                    throw this.log.errorWithException(`processArguments must be a JSON format or an object with format {args : [], env : {a:b, c:d}}. ` +
+                        `Both environment and argument can be null. Error: ${err}`);
+                }
+            }
+            else if (lodash_1.default.isPlainObject(caps.processArguments)) {
+                verifyProcessArgument(caps.processArguments);
+            }
+            else {
+                throw this.log.errorWithException(`'processArguments must be an object, or a string JSON object with format {args : [], env : {a:b, c:d}}. ` +
+                    `Both environment and argument can be null.`);
+            }
+        }
+        // there is no point in having `keychainPath` without `keychainPassword`
+        if ((caps.keychainPath && !caps.keychainPassword) ||
+            (!caps.keychainPath && caps.keychainPassword)) {
+            throw this.log.errorWithException(`If 'keychainPath' is set, 'keychainPassword' must also be set (and vice versa).`);
+        }
+        // `resetOnSessionStartOnly` should be set to true by default
+        this.opts.resetOnSessionStartOnly =
+            !support_1.util.hasValue(this.opts.resetOnSessionStartOnly) || this.opts.resetOnSessionStartOnly;
+        this.opts.useNewWDA = support_1.util.hasValue(this.opts.useNewWDA) ? this.opts.useNewWDA : false;
+        if (caps.commandTimeouts) {
+            caps.commandTimeouts = (0, utils_1.normalizeCommandTimeouts)(caps.commandTimeouts);
+        }
+        if (lodash_1.default.isString(caps.webDriverAgentUrl)) {
+            const { protocol, host } = node_url_1.default.parse(caps.webDriverAgentUrl);
+            if (lodash_1.default.isEmpty(protocol) || lodash_1.default.isEmpty(host)) {
+                throw this.log.errorWithException(`'webDriverAgentUrl' capability is expected to contain a valid WebDriverAgent server URL. ` +
+                    `'${caps.webDriverAgentUrl}' is given instead`);
+            }
+        }
+        if (caps.browserName) {
+            if (caps.bundleId) {
+                throw this.log.errorWithException(`'browserName' cannot be set together with 'bundleId' capability`);
+            }
+            // warn if the capabilities have both `app` and `browser, although this
+            // is common with selenium grid
+            if (caps.app) {
+                this.log.warn(`The capabilities should generally not include both an 'app' and a 'browserName'`);
+            }
+        }
+        if (caps.permissions) {
+            try {
+                for (const [bundleId, perms] of lodash_1.default.toPairs(JSON.parse(caps.permissions))) {
+                    if (!lodash_1.default.isString(bundleId)) {
+                        throw new Error(`'${JSON.stringify(bundleId)}' must be a string`);
+                    }
+                    if (!lodash_1.default.isPlainObject(perms)) {
+                        throw new Error(`'${JSON.stringify(perms)}' must be a JSON object`);
+                    }
+                }
+            }
+            catch (e) {
+                throw this.log.errorWithException(`'${caps.permissions}' is expected to be a valid object with format ` +
+                    `{"<bundleId1>": {"<serviceName1>": "<serviceStatus1>", ...}, ...}. Original error: ${e.message}`);
+            }
+        }
+        if (caps.platformVersion && !support_1.util.coerceVersion(caps.platformVersion, false)) {
+            throw this.log.errorWithException(`'platformVersion' must be a valid version number. ` +
+                `'${caps.platformVersion}' is given instead.`);
+        }
+        // additionalWebviewBundleIds is an array, JSON array, or string
+        if (caps.additionalWebviewBundleIds) {
+            caps.additionalWebviewBundleIds = this.helpers.parseCapsArray(caps.additionalWebviewBundleIds);
+        }
+        // finally, return true since the superclass check passed, as did this
+        return true;
+    }
+    // Getter methods
+    get wda() {
+        if (!this._wda) {
+            throw new Error('WebDriverAgent is not initialized');
+        }
+        return this._wda;
+    }
+    get driverData() {
+        // TODO fill out resource info here
+        return {};
+    }
+    get device() {
+        return this._device;
+    }
+    // Utility methods
+    isSafari() {
+        return !!this.safari;
+    }
+    isRealDevice() {
+        return 'devicectl' in (this.device ?? {});
+    }
+    isSimulator() {
+        return 'simctl' in (this.device ?? {});
+    }
+    isXcodebuildNeeded() {
+        return !(CAP_NAMES_NO_XCODEBUILD_REQUIRED.some((x) => Boolean(this.opts[x])));
+    }
+    // Core driver methods
     async onSettingsUpdate(key, value) {
         // skip sending the update request to the WDA nor saving it in opts
         // to not spend unnecessary time.
@@ -343,39 +596,7 @@ class XCUITestDriver extends driver_1.BaseDriver {
                 settings: { [key]: value },
             });
         }
-        this.opts[key] = !!value;
-    }
-    resetIos() {
-        this.opts = this.opts || {};
-        // @ts-ignore this is ok
-        this.wda = null;
-        this.jwpProxyActive = false;
-        this.proxyReqRes = null;
-        this.safari = false;
-        this.cachedWdaStatus = null;
-        this.curWebFrames = [];
-        this._currentUrl = null;
-        this.curContext = null;
-        this.xcodeVersion = undefined;
-        this.contexts = [];
-        this.implicitWaitMs = 0;
-        this.pageLoadMs = 6000;
-        this.landscapeWebCoordsOffset = 0;
-        this.remote = null;
-        this._conditionInducerService = null;
-        this._remoteXPCConditionInducerConnection = null;
-        this.webElementsCache = new lru_cache_1.LRUCache({
-            max: WEB_ELEMENTS_CACHE_SIZE,
-        });
-        this._waitingAtoms = {
-            count: 0,
-            alertNotifier: new node_events_1.default(),
-            alertMonitor: bluebird_1.default.resolve(),
-        };
-    }
-    get driverData() {
-        // TODO fill out resource info here
-        return {};
+        this.opts[key] = !!value;
     }
     async getStatus() {
         const status = {
@@ -400,79 +621,6 @@ class XCUITestDriver extends driver_1.BaseDriver {
         }
         return didMerge;
     }
-    /**
-     * @returns {Simulator|RealDevice}
-     */
-    get device() {
-        return this._device;
-    }
-    isXcodebuildNeeded() {
-        return !(CAP_NAMES_NO_XCODEBUILD_REQUIRED.some((x) => Boolean(this.opts[x])));
-    }
-    async createSession(w3cCaps1, w3cCaps2, w3cCaps3, driverData) {
-        try {
-            let [sessionId, caps] = await super.createSession(w3cCaps1, w3cCaps2, w3cCaps3, driverData);
-            // merge cli args to opts, and if we did merge any, revalidate opts to ensure the final set
-            // is also consistent
-            if (this.mergeCliArgsToOpts()) {
-                this.validateDesiredCaps({ ...caps, ...this.cliArgs });
-            }
-            await this.start();
-            // merge server capabilities + desired capabilities
-            caps = { ...defaultServerCaps, ...caps };
-            // update the udid with what is actually used
-            caps.udid = this.opts.udid;
-            // ensure we track nativeWebTap capability as a setting as well
-            if (lodash_1.default.has(this.opts, 'nativeWebTap')) {
-                await this.updateSettings({ nativeWebTap: this.opts.nativeWebTap });
-            }
-            // ensure we track nativeWebTapStrict capability as a setting as well
-            if (lodash_1.default.has(this.opts, 'nativeWebTapStrict')) {
-                await this.updateSettings({ nativeWebTapStrict: this.opts.nativeWebTapStrict });
-            }
-            // ensure we track useJSONSource capability as a setting as well
-            if (lodash_1.default.has(this.opts, 'useJSONSource')) {
-                await this.updateSettings({ useJSONSource: this.opts.useJSONSource });
-            }
-            /** @type {import('appium-webdriveragent').WDASettings} */
-            let wdaSettings = {
-                elementResponseAttributes: DEFAULT_SETTINGS.elementResponseAttributes,
-                shouldUseCompactResponses: DEFAULT_SETTINGS.shouldUseCompactResponses,
-            };
-            if ('elementResponseAttributes' in this.opts && lodash_1.default.isString(this.opts.elementResponseAttributes)) {
-                wdaSettings.elementResponseAttributes = this.opts.elementResponseAttributes;
-            }
-            if ('shouldUseCompactResponses' in this.opts && lodash_1.default.isBoolean(this.opts.shouldUseCompactResponses)) {
-                wdaSettings.shouldUseCompactResponses = this.opts.shouldUseCompactResponses;
-            }
-            if ('mjpegServerScreenshotQuality' in this.opts && lodash_1.default.isNumber(this.opts.mjpegServerScreenshotQuality)) {
-                wdaSettings.mjpegServerScreenshotQuality = this.opts.mjpegServerScreenshotQuality;
-            }
-            if ('mjpegServerFramerate' in this.opts && lodash_1.default.isNumber(this.opts.mjpegServerFramerate)) {
-                wdaSettings.mjpegServerFramerate = this.opts.mjpegServerFramerate;
-            }
-            if (lodash_1.default.has(this.opts, 'screenshotQuality')) {
-                this.log.info(`Setting the quality of phone screenshot: '${this.opts.screenshotQuality}'`);
-                wdaSettings.screenshotQuality = this.opts.screenshotQuality;
-            }
-            // ensure WDA gets our defaults instead of whatever its own might be
-            await this.updateSettings(wdaSettings);
-            await this.handleMjpegOptions();
-            return /** @type {[string, import('@appium/types').DriverCaps<XCUITestDriverConstraints>]} */ ([
-                sessionId,
-                caps,
-            ]);
-        }
-        catch (e) {
-            this.log.error(JSON.stringify(e));
-            await this.deleteSession();
-            throw e;
-        }
-    }
-    /**
-     * Handles MJPEG server-related capabilities
-     * @returns {Promise<void>}
-     */
     async handleMjpegOptions() {
         await this.allocateMjpegServerPort();
         // turn on mjpeg stream reading if requested
@@ -482,11 +630,6 @@ class XCUITestDriver extends driver_1.BaseDriver {
             await this.mjpegStream.start();
         }
     }
-    /**
-     * Allocates and configures port forwarding for the MJPEG server
-     * @returns {Promise<void>}
-     * @throws {Error} If port forwarding fails and mjpegServerPort capability value is provided explicitly
-     */
     async allocateMjpegServerPort() {
         const mjpegServerPort = this.opts.mjpegServerPort || DEFAULT_MJPEG_SERVER_PORT;
         this.log.debug(`Forwarding MJPEG server port ${mjpegServerPort} to local port ${mjpegServerPort}`);
@@ -510,10 +653,6 @@ class XCUITestDriver extends driver_1.BaseDriver {
             }
         }
     }
-    /**
-     * Returns the default URL for Safari browser
-     * @returns {string} The default URL
-     */
     getDefaultUrl() {
         // Setting this to some external URL slows down the session init
         return `${this.getWdaLocalhostRoot()}/health`;
@@ -533,7 +672,7 @@ class XCUITestDriver extends driver_1.BaseDriver {
             }
             else {
                 this.log.info(`Setting simulator devices set path to '${this.opts.simulatorDevicesSetPath}'`);
-                ( /** @type {Simulator} */(this.device)).devicesSetPath = this.opts.simulatorDevicesSetPath;
+                this.device.devicesSetPath = this.opts.simulatorDevicesSetPath;
             }
         }
         // at this point if there is no platformVersion, get it from the device
@@ -574,21 +713,26 @@ class XCUITestDriver extends driver_1.BaseDriver {
             }
         }
         await this.runReset();
-        this.wda = new appium_webdriveragent_1.WebDriverAgent(
-        /** @type {import('appium-xcode').XcodeVersion} */ (this.xcodeVersion), {
+        this._wda = new appium_webdriveragent_1.WebDriverAgent(
+        // @ts-ignore This property is not used by WDA, and will be removed in the future
+        this.xcodeVersion, {
             ...this.opts,
             device: this.device,
             realDevice: this.isRealDevice(),
             iosSdkVersion: this._iosSdkVersion ?? undefined,
             reqBasePath: this.basePath,
-        }, 
-        // @ts-ignore this is ok
-        this.log);
+        }, this.log);
         // Derived data path retrieval is an expensive operation
         // We could start that now in background and get the cached result
         // whenever it is needed
-        // eslint-disable-next-line promise/prefer-await-to-then
-        this.wda.retrieveDerivedDataPath().catch((e) => this.log.debug(e));
+        (async () => {
+            try {
+                await this.wda.retrieveDerivedDataPath();
+            }
+            catch (e) {
+                this.log.debug(e);
+            }
+        })();
         const memoizedLogInfo = lodash_1.default.memoize(() => {
             this.log.info("'skipLogCapture' is set. Skipping starting logs such as crash, system, safari console and safari network.");
         });
@@ -631,7 +775,7 @@ class XCUITestDriver extends driver_1.BaseDriver {
             if (this.opts.permissions) {
                 this.log.debug('Setting the requested permissions before WDA is started');
                 for (const [bundleId, permissionsMapping] of lodash_1.default.toPairs(JSON.parse(this.opts.permissions))) {
-                    await /** @type {Simulator} */ (this.device).setPermissions(bundleId, permissionsMapping);
+                    await this.device.setPermissions(bundleId, permissionsMapping);
                 }
             }
             // TODO: Deprecate and remove this block together with calendarAccessAuthorized capability
@@ -670,11 +814,40 @@ class XCUITestDriver extends driver_1.BaseDriver {
             }
         }
     }
-    /**
-     * Start the simulator and initialize based on capabilities
-     */
+    async runReset(enforceSimulatorShutdown = false) {
+        this.logEvent('resetStarted');
+        if (this.isRealDevice()) {
+            await real_device_management_1.runRealDeviceReset.bind(this)();
+        }
+        else {
+            await simulator_management_1.runSimulatorReset.bind(this)(enforceSimulatorShutdown);
+        }
+        this.logEvent('resetComplete');
+    }
+    async stop() {
+        this.jwpProxyActive = false;
+        this.proxyReqRes = null;
+        if (this._wda?.fullyStarted) {
+            if (this.wda.jwproxy) {
+                try {
+                    await this.proxyCommand(`/session/${this.sessionId}`, 'DELETE');
+                }
+                catch (err) {
+                    // an error here should not short-circuit the rest of clean up
+                    this.log.debug(`Unable to DELETE session on WDA: '${err.message}'. Continuing shutdown.`);
+                }
+            }
+            // The former could cache the xcodebuild, so should not quit the process.
+            // If the session skipped the xcodebuild (this.wda.canSkipXcodebuild), the this.wda instance
+            // should quit properly.
+            if ((!this.wda.webDriverAgentUrl && this.opts.useNewWDA) || this.wda.canSkipXcodebuild) {
+                await this.wda.quit();
+            }
+        }
+        device_connections_factory_1.DEVICE_CONNECTIONS_FACTORY.releaseConnection(this.opts.udid);
+    }
     async initSimulator() {
-        const device = /** @type {Simulator} */ (this.device);
+        const device = this.device;
         if (this.opts.shutdownOtherSimulators) {
             this.assertFeatureEnabled(SHUTDOWN_OTHER_FEAT_NAME);
             await simulator_management_1.shutdownOtherSimulators.bind(this)();
@@ -691,7 +864,6 @@ class XCUITestDriver extends driver_1.BaseDriver {
         if (await simulator_management_1.setLocalizationPrefs.bind(this)()) {
             this.log.debug('Localization preferences have been updated');
         }
-        /** @type {Promise[]} */
         const promises = ['reduceMotion', 'reduceTransparency', 'autoFillPasswords']
             .filter((optName) => lodash_1.default.isBoolean(this.opts[optName]))
             .map((optName) => {
@@ -713,9 +885,6 @@ class XCUITestDriver extends driver_1.BaseDriver {
         }
         this.logEvent('simStarted');
     }
-    /**
-     * Start WebDriverAgentRunner
-     */
     async startWda() {
         // Don't cleanup the processes if webDriverAgentUrl is set
         if (!support_1.util.hasValue(this.wda.webDriverAgentUrl)) {
@@ -786,7 +955,6 @@ class XCUITestDriver extends driver_1.BaseDriver {
                 this.log.debug(`Trying to start WebDriverAgent once since at least one of ${CAP_NAMES_NO_XCODEBUILD_REQUIRED} capabilities is provided`);
                 startupRetries = 1;
             }
-            /** @type {Error|null} */
             let shortCircuitError = null;
             let retryCount = 0;
             await (0, asyncbox_1.retryInterval)(startupRetries, startupRetryInterval, async () => {
@@ -798,207 +966,84 @@ class XCUITestDriver extends driver_1.BaseDriver {
                     if (this.opts.usePreinstalledWDA) {
                         await this.preparePreinstalledWda();
                     }
-                    this.cachedWdaStatus = await this.wda.launch(/** @type {string} */ (this.sessionId));
-                }
-                catch (err) {
-                    this.logEvent('wdaStartFailed');
-                    this.log.debug(err.stack);
-                    retryCount++;
-                    let errorMsg = `Unable to launch WebDriverAgent. Original error: ${err.message}`;
-                    if (this.isRealDevice()) {
-                        errorMsg += `. Make sure you follow the tutorial at ${WDA_REAL_DEV_TUTORIAL_URL}`;
-                    }
-                    if (this.opts.usePreinstalledWDA) {
-                        try {
-                            // In case the bundle id process start got failed because of
-                            // auth popup in the device. Then, the bundle id process itself started. It is safe to stop it here.
-                            await this.mobileKillApp(this.wda.bundleIdForXctest);
-                        }
-                        catch { }
-                        ;
-                        // Mostly it failed to start the WDA process as no the bundle id
-                        // e.g. '<bundle id of WDA> not found on device <udid>'
-                        errorMsg = `Unable to launch WebDriverAgent. Original error: ${err.message}. ` +
-                            `Make sure the application ${this.wda.bundleIdForXctest} exists and it is launchable.`;
-                        if (this.isRealDevice()) {
-                            errorMsg += ` ${WDA_REAL_DEV_TUTORIAL_URL} may help to complete the preparation.`;
-                        }
-                        ;
-                        throw new Error(errorMsg);
-                    }
-                    else {
-                        await quitAndUninstall(errorMsg);
-                    }
-                }
-                this.proxyReqRes = this.wda.proxyReqRes.bind(this.wda);
-                this.jwpProxyActive = true;
-                try {
-                    this.logEvent('wdaSessionAttempted');
-                    this.log.debug('Sending createSession command to WDA');
-                    this.cachedWdaStatus = this.cachedWdaStatus || (await this.proxyCommand('/status', 'GET'));
-                    await this.startWdaSession(this.opts.bundleId, this.opts.processArguments);
-                    this.logEvent('wdaSessionStarted');
-                }
-                catch (err) {
-                    this.logEvent('wdaSessionFailed');
-                    this.log.debug(err.stack);
-                    if (err instanceof driver_1.errors.TimeoutError) {
-                        // Session startup timed out. There is no point to retry
-                        shortCircuitError = err;
-                        return;
-                    }
-                    let errorMsg = `Unable to start WebDriverAgent session. Original error: ${err.message}`;
-                    if (this.isRealDevice() && lodash_1.default.includes(err.message, 'xcodebuild')) {
-                        errorMsg += ` Make sure you follow the tutorial at ${WDA_REAL_DEV_TUTORIAL_URL}.`;
-                    }
-                    throw new Error(errorMsg);
-                }
-                if (this.opts.clearSystemFiles && this.isXcodebuildNeeded()) {
-                    await (0, utils_1.markSystemFilesForCleanup)(this.wda);
-                }
-                // We don't restrict the version, but show what version of WDA is running on the device for debugging purposes.
-                if (this.cachedWdaStatus?.build) {
-                    this.log.info(`WebDriverAgent version: '${this.cachedWdaStatus.build.version}'`);
-                }
-                else {
-                    this.log.warn(`WebDriverAgent does not provide any version information. ` +
-                        `This might indicate either a custom or an outdated build.`);
-                }
-                // we expect certain socket errors until this point, but now
-                // mark things as fully working
-                this.wda.fullyStarted = true;
-                this.logEvent('wdaStarted');
-            });
-            if (shortCircuitError) {
-                throw shortCircuitError;
-            }
-        });
-    }
-    /**
-     *
-     * @param {boolean} [enforceSimulatorShutdown=false]
-     */
-    async runReset(enforceSimulatorShutdown = false) {
-        this.logEvent('resetStarted');
-        if (this.isRealDevice()) {
-            await real_device_management_1.runRealDeviceReset.bind(this)();
-        }
-        else {
-            await simulator_management_1.runSimulatorReset.bind(this)(enforceSimulatorShutdown);
-        }
-        this.logEvent('resetComplete');
-    }
-    async deleteSession(sessionId) {
-        await utils_1.removeAllSessionWebSocketHandlers.bind(this)();
-        for (const recorder of lodash_1.default.compact([
-            this._recentScreenRecorder,
-            this._audioRecorder,
-            this._trafficCapture,
-        ])) {
-            await recorder.interrupt(true);
-            await recorder.cleanup();
-        }
-        if (!lodash_1.default.isEmpty(this._perfRecorders)) {
-            await bluebird_1.default.all(this._perfRecorders.map((x) => x.stop(true)));
-            this._perfRecorders = [];
-        }
-        if (this._conditionInducerService || this._remoteXPCConditionInducerConnection) {
-            try {
-                await this.disableConditionInducer();
-            }
-            catch (err) {
-                this.log.warn(`Cannot disable condition inducer: ${err.message}`);
-            }
-        }
-        await this.stop();
-        if (this.wda && this.isXcodebuildNeeded()) {
-            if (this.opts.clearSystemFiles) {
-                let synchronizationKey = XCUITestDriver.name;
-                const derivedDataPath = await this.wda.retrieveDerivedDataPath();
-                if (derivedDataPath) {
-                    synchronizationKey = node_path_1.default.normalize(derivedDataPath);
-                }
-                await SHARED_RESOURCES_GUARD.acquire(synchronizationKey, async () => {
-                    await (0, utils_1.clearSystemFiles)(this.wda);
-                });
-            }
-            else {
-                this.log.debug('Not clearing log files. Use `clearSystemFiles` capability to turn on.');
-            }
-        }
-        if (this.remote) {
-            this.log.debug('Found a remote debugger session. Removing...');
-            await this.stopRemote();
-        }
-        if (this.opts.resetOnSessionStartOnly === false) {
-            await this.runReset(true);
-        }
-        const simulatorDevice = this.isSimulator() ? /** @type {Simulator} */ (this.device) : null;
-        if (simulatorDevice && this.lifecycleData.createSim) {
-            this.log.debug(`Deleting simulator created for this run (udid: '${simulatorDevice.udid}')`);
-            await simulator_management_1.shutdownSimulator.bind(this)();
-            await simulatorDevice.delete();
-        }
-        const shouldResetLocationService = this.isRealDevice() && !!this.opts.resetLocationService;
-        if (shouldResetLocationService) {
-            try {
-                await this.mobileResetLocationService();
-            }
-            catch {
-                /* Ignore this error since mobileResetLocationService already logged the error */
-            }
-        }
-        await this.logs.syslog?.stopCapture();
-        lodash_1.default.values(this.logs).forEach((x) => x.removeAllListeners());
-        if (this._bidiServerLogListener) {
-            this.log.unwrap().off('log', this._bidiServerLogListener);
-        }
-        this.logs = {};
-        if (this.mjpegStream) {
-            this.log.info('Closing MJPEG stream');
-            this.mjpegStream.stop();
-        }
-        this.resetIos();
-        await super.deleteSession(sessionId);
-    }
-    async stop() {
-        this.jwpProxyActive = false;
-        this.proxyReqRes = null;
-        if (this.wda?.fullyStarted) {
-            if (this.wda.jwproxy) {
+                    if (!this.sessionId) {
+                        throw new Error('Session ID is required but was not set');
+                    }
+                    this.cachedWdaStatus = await this.wda.launch(this.sessionId);
+                }
+                catch (err) {
+                    this.logEvent('wdaStartFailed');
+                    this.log.debug(err.stack);
+                    retryCount++;
+                    let errorMsg = `Unable to launch WebDriverAgent. Original error: ${err.message}`;
+                    if (this.isRealDevice()) {
+                        errorMsg += `. Make sure you follow the tutorial at ${WDA_REAL_DEV_TUTORIAL_URL}`;
+                    }
+                    if (this.opts.usePreinstalledWDA) {
+                        try {
+                            // In case the bundle id process start got failed because of
+                            // auth popup in the device. Then, the bundle id process itself started. It is safe to stop it here.
+                            await this.mobileKillApp(this.wda.bundleIdForXctest);
+                        }
+                        catch { }
+                        ;
+                        // Mostly it failed to start the WDA process as no the bundle id
+                        // e.g. '<bundle id of WDA> not found on device <udid>'
+                        errorMsg = `Unable to launch WebDriverAgent. Original error: ${err.message}. ` +
+                            `Make sure the application ${this.wda.bundleIdForXctest} exists and it is launchable.`;
+                        if (this.isRealDevice()) {
+                            errorMsg += ` ${WDA_REAL_DEV_TUTORIAL_URL} may help to complete the preparation.`;
+                        }
+                        ;
+                        throw new Error(errorMsg);
+                    }
+                    else {
+                        await quitAndUninstall(errorMsg);
+                    }
+                }
+                this.proxyReqRes = this.wda.proxyReqRes.bind(this.wda);
+                this.jwpProxyActive = true;
                 try {
-                    await this.proxyCommand(`/session/${this.sessionId}`, 'DELETE');
+                    this.logEvent('wdaSessionAttempted');
+                    this.log.debug('Sending createSession command to WDA');
+                    this.cachedWdaStatus = this.cachedWdaStatus || (await this.proxyCommand('/status', 'GET'));
+                    await this.startWdaSession(this.opts.bundleId, this.opts.processArguments);
+                    this.logEvent('wdaSessionStarted');
                 }
                 catch (err) {
-                    // an error here should not short-circuit the rest of clean up
-                    this.log.debug(`Unable to DELETE session on WDA: '${err.message}'. Continuing shutdown.`);
+                    this.logEvent('wdaSessionFailed');
+                    this.log.debug(err.stack);
+                    if (err instanceof driver_1.errors.TimeoutError) {
+                        // Session startup timed out. There is no point to retry
+                        shortCircuitError = err;
+                        return;
+                    }
+                    let errorMsg = `Unable to start WebDriverAgent session. Original error: ${err.message}`;
+                    if (this.isRealDevice() && lodash_1.default.includes(err.message, 'xcodebuild')) {
+                        errorMsg += ` Make sure you follow the tutorial at ${WDA_REAL_DEV_TUTORIAL_URL}.`;
+                    }
+                    throw new Error(errorMsg);
                 }
+                if (this.opts.clearSystemFiles && this.isXcodebuildNeeded()) {
+                    await (0, utils_1.markSystemFilesForCleanup)(this.wda);
+                }
+                // We don't restrict the version, but show what version of WDA is running on the device for debugging purposes.
+                if (this.cachedWdaStatus?.build) {
+                    this.log.info(`WebDriverAgent version: '${this.cachedWdaStatus.build.version}'`);
+                }
+                else {
+                    this.log.warn(`WebDriverAgent does not provide any version information. ` +
+                        `This might indicate either a custom or an outdated build.`);
+                }
+                // we expect certain socket errors until this point, but now
+                // mark things as fully working
+                this.wda.fullyStarted = true;
+                this.logEvent('wdaStarted');
+            });
+            if (shortCircuitError) {
+                throw shortCircuitError;
             }
-            // The former could cache the xcodebuild, so should not quit the process.
-            // If the session skipped the xcodebuild (this.wda.canSkipXcodebuild), the this.wda instance
-            // should quit properly.
-            if ((!this.wda.webDriverAgentUrl && this.opts.useNewWDA) || this.wda.canSkipXcodebuild) {
-                await this.wda.quit();
-            }
-        }
-        device_connections_factory_1.DEVICE_CONNECTIONS_FACTORY.releaseConnection(this.opts.udid);
-    }
-    /**
-     *
-     * @param {string} cmd
-     * @param {...any} args
-     * @returns {Promise<any>}
-     */
-    async executeCommand(cmd, ...args) {
-        this.log.debug(`Executing command '${cmd}'`);
-        if (cmd === 'receiveAsyncResponse') {
-            return await this.receiveAsyncResponse(...args);
-        }
-        // TODO: once this fix gets into base driver remove from here
-        if (cmd === 'getStatus') {
-            return await this.getStatus();
-        }
-        return await super.executeCommand(cmd, ...args);
+        });
     }
     async configureApp() {
         function appIsPackageOrBundle(app) {
@@ -1020,11 +1065,11 @@ class XCUITestDriver extends driver_1.BaseDriver {
         switch (lodash_1.default.toLower(this.opts.app)) {
             case 'settings':
                 this.opts.bundleId = 'com.apple.Preferences';
-                this.opts.app = null;
+                this.opts.app = undefined;
                 return;
             case 'calendar':
                 this.opts.bundleId = 'com.apple.mobilecal';
-                this.opts.app = null;
+                this.opts.app = undefined;
                 return;
         }
         this.opts.app = await this.helpers.configureApp(this.opts.app, {
@@ -1114,9 +1159,7 @@ class XCUITestDriver extends driver_1.BaseDriver {
         return { device, realDevice: false, udid: device.udid };
     }
     async startSim() {
-        /** @type {import('appium-ios-simulator').DevicePreferences} */
         const devicePreferences = {};
-        /** @type {import('appium-ios-simulator').RunOptions} */
         const runOpts = {
             scaleFactor: this.opts.scaleFactor,
             connectHardwareKeyboard: !!this.opts.connectHardwareKeyboard,
@@ -1145,7 +1188,7 @@ class XCUITestDriver extends driver_1.BaseDriver {
                 devicePreferences.SimulatorWindowRotationAngle = 0;
                 break;
         }
-        await /** @type {Simulator} */ (this.device).run(runOpts);
+        await this.device.run(runOpts);
     }
     async createSim() {
         this.lifecycleData.createSim = true;
@@ -1184,7 +1227,6 @@ class XCUITestDriver extends driver_1.BaseDriver {
             // https://developer.apple.com/forums/thread/86951?answerId=263395022#263395022
             env.TZ = this.opts.appTimeZone;
         }
-        /** @type {import('appium-webdriveragent').WDACapabilities} */
         const wdaCaps = {
             bundleId: this.opts.autoLaunch === false ? undefined : bundleId,
             arguments: args,
@@ -1226,155 +1268,9 @@ class XCUITestDriver extends driver_1.BaseDriver {
         });
         this.log.info(`WDA session startup took ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`);
     }
-    // Override Proxy methods from BaseDriver
-    proxyActive() {
-        return Boolean(this.jwpProxyActive);
-    }
-    getProxyAvoidList() {
-        if (this.isWebview()) {
-            return NO_PROXY_WEB_LIST;
-        }
-        return NO_PROXY_NATIVE_LIST;
-    }
-    canProxy() {
-        return true;
-    }
-    /**
-     * @returns {boolean}
-     */
-    isSafari() {
-        return !!this.safari;
-    }
-    /**
-     * @returns {boolean}
-     */
-    isRealDevice() {
-        return 'devicectl' in (this.device ?? {});
-    }
-    /**
-     * @returns {boolean}
-     */
-    isSimulator() {
-        return 'simctl' in (this.device ?? {});
-    }
-    /**
-     * @param {string} strategy
-     */
-    validateLocatorStrategy(strategy) {
-        super.validateLocatorStrategy(strategy, this.isWebContext());
-    }
-    /**
-     * @param {any} caps
-     * @returns {caps is import('@appium/types').DriverCaps<XCUITestDriverConstraints>}
-     */
-    validateDesiredCaps(caps) {
-        if (!super.validateDesiredCaps(caps)) {
-            return false;
-        }
-        // make sure that the capabilities have one of `app` or `bundleId`
-        if (lodash_1.default.toLower(caps.browserName) !== 'safari' && !caps.app && !caps.bundleId) {
-            this.log.info('The desired capabilities include neither an app nor a bundleId. ' +
-                'WebDriverAgent will be started without the default app');
-        }
-        if (!support_1.util.coerceVersion(String(caps.platformVersion), false)) {
-            this.log.warn(`'platformVersion' capability ('${caps.platformVersion}') is not a valid version number. ` +
-                `Consider fixing it or be ready to experience an inconsistent driver behavior.`);
-        }
-        let verifyProcessArgument = (processArguments) => {
-            const { args, env } = processArguments;
-            if (!lodash_1.default.isNil(args) && !lodash_1.default.isArray(args)) {
-                throw this.log.errorWithException('processArguments.args must be an array of strings');
-            }
-            if (!lodash_1.default.isNil(env) && !lodash_1.default.isPlainObject(env)) {
-                throw this.log.errorWithException('processArguments.env must be an object <key,value> pair {a:b, c:d}');
-            }
-        };
-        // `processArguments` should be JSON string or an object with arguments and/ environment details
-        if (caps.processArguments) {
-            if (lodash_1.default.isString(caps.processArguments)) {
-                try {
-                    // try to parse the string as JSON
-                    caps.processArguments = JSON.parse(caps.processArguments);
-                    verifyProcessArgument(caps.processArguments);
-                }
-                catch (err) {
-                    throw this.log.errorWithException(`processArguments must be a JSON format or an object with format {args : [], env : {a:b, c:d}}. ` +
-                        `Both environment and argument can be null. Error: ${err}`);
-                }
-            }
-            else if (lodash_1.default.isPlainObject(caps.processArguments)) {
-                verifyProcessArgument(caps.processArguments);
-            }
-            else {
-                throw this.log.errorWithException(`'processArguments must be an object, or a string JSON object with format {args : [], env : {a:b, c:d}}. ` +
-                    `Both environment and argument can be null.`);
-            }
-        }
-        // there is no point in having `keychainPath` without `keychainPassword`
-        if ((caps.keychainPath && !caps.keychainPassword) ||
-            (!caps.keychainPath && caps.keychainPassword)) {
-            throw this.log.errorWithException(`If 'keychainPath' is set, 'keychainPassword' must also be set (and vice versa).`);
-        }
-        // `resetOnSessionStartOnly` should be set to true by default
-        this.opts.resetOnSessionStartOnly =
-            !support_1.util.hasValue(this.opts.resetOnSessionStartOnly) || this.opts.resetOnSessionStartOnly;
-        this.opts.useNewWDA = support_1.util.hasValue(this.opts.useNewWDA) ? this.opts.useNewWDA : false;
-        if (caps.commandTimeouts) {
-            caps.commandTimeouts = (0, utils_1.normalizeCommandTimeouts)(caps.commandTimeouts);
-        }
-        if (lodash_1.default.isString(caps.webDriverAgentUrl)) {
-            const { protocol, host } = node_url_1.default.parse(caps.webDriverAgentUrl);
-            if (lodash_1.default.isEmpty(protocol) || lodash_1.default.isEmpty(host)) {
-                throw this.log.errorWithException(`'webDriverAgentUrl' capability is expected to contain a valid WebDriverAgent server URL. ` +
-                    `'${caps.webDriverAgentUrl}' is given instead`);
-            }
-        }
-        if (caps.browserName) {
-            if (caps.bundleId) {
-                throw this.log.errorWithException(`'browserName' cannot be set together with 'bundleId' capability`);
-            }
-            // warn if the capabilities have both `app` and `browser, although this
-            // is common with selenium grid
-            if (caps.app) {
-                this.log.warn(`The capabilities should generally not include both an 'app' and a 'browserName'`);
-            }
-        }
-        if (caps.permissions) {
-            try {
-                for (const [bundleId, perms] of lodash_1.default.toPairs(JSON.parse(caps.permissions))) {
-                    if (!lodash_1.default.isString(bundleId)) {
-                        throw new Error(`'${JSON.stringify(bundleId)}' must be a string`);
-                    }
-                    if (!lodash_1.default.isPlainObject(perms)) {
-                        throw new Error(`'${JSON.stringify(perms)}' must be a JSON object`);
-                    }
-                }
-            }
-            catch (e) {
-                throw this.log.errorWithException(`'${caps.permissions}' is expected to be a valid object with format ` +
-                    `{"<bundleId1>": {"<serviceName1>": "<serviceStatus1>", ...}, ...}. Original error: ${e.message}`);
-            }
-        }
-        if (caps.platformVersion && !support_1.util.coerceVersion(caps.platformVersion, false)) {
-            throw this.log.errorWithException(`'platformVersion' must be a valid version number. ` +
-                `'${caps.platformVersion}' is given instead.`);
-        }
-        // additionalWebviewBundleIds is an array, JSON array, or string
-        if (caps.additionalWebviewBundleIds) {
-            caps.additionalWebviewBundleIds = this.helpers.parseCapsArray(caps.additionalWebviewBundleIds);
-        }
-        // finally, return true since the superclass check passed, as did this
-        return true;
-    }
-    /**
-     * Check if the given app can be installed, or should uninstall before installing it.
-     *
-     * @param {AutInstallationStateOptions} [opts]
-     * @returns {Promise<AutInstallationState>}
-     */
     async checkAutInstallationState(opts) {
         const { enforceAppInstall, fullReset, noReset, bundleId, app } = opts ?? this.opts;
-        const wasAppInstalled = await this.device.isAppInstalled(bundleId);
+        const wasAppInstalled = !!bundleId && await this.device.isAppInstalled(bundleId);
         if (wasAppInstalled) {
             this.log.info(`App '${bundleId}' is already installed`);
             if (noReset) {
@@ -1395,7 +1291,7 @@ class XCUITestDriver extends driver_1.BaseDriver {
                 skipUninstall: !wasAppInstalled,
             };
         }
-        const candidateBundleVersion = await this.appInfosCache.extractBundleVersion(app);
+        const candidateBundleVersion = app ? await this.appInfosCache.extractBundleVersion(app) : undefined;
         this.log.debug(`CFBundleVersion from Info.plist: ${candidateBundleVersion}`);
         if (!candidateBundleVersion) {
             return {
@@ -1404,8 +1300,8 @@ class XCUITestDriver extends driver_1.BaseDriver {
             };
         }
         const appBundleVersion = this.isRealDevice()
-            ? (await /** @type {RealDevice} */ (this.device).fetchAppInfo(bundleId))?.CFBundleVersion
-            : BUNDLE_VERSION_PATTERN.exec(await /** @type {Simulator} */ (this.device).simctl.appInfo(bundleId))?.[1];
+            ? (await this.device.fetchAppInfo(bundleId))?.CFBundleVersion
+            : BUNDLE_VERSION_PATTERN.exec(await this.device.simctl.appInfo(bundleId))?.[1];
         this.log.debug(`CFBundleVersion from installed app info: ${appBundleVersion}`);
         if (!appBundleVersion) {
             return {
@@ -1462,19 +1358,14 @@ class XCUITestDriver extends driver_1.BaseDriver {
             }
             if (support_1.util.hasValue(this.opts.iosInstallPause)) {
                 // https://github.com/appium/appium/issues/6889
-                const pauseMs = parseInt(this.opts.iosInstallPause, 10);
+                const pauseMs = this.opts.iosInstallPause;
                 this.log.debug(`iosInstallPause set. Pausing ${pauseMs} ms before continuing`);
                 await bluebird_1.default.delay(pauseMs);
             }
             this.logEvent('appInstalled');
         }
     }
-    /**
-     * @param {string|string[]} otherApps
-     * @returns {Promise<void>}
-     */
     async installOtherApps(otherApps) {
-        /** @type {string[]|undefined} */
         let appsList;
         try {
             appsList = this.helpers.parseCapsArray(otherApps);
@@ -1486,13 +1377,11 @@ class XCUITestDriver extends driver_1.BaseDriver {
             this.log.info(`Got zero apps from 'otherApps' capability value. Doing nothing`);
             return;
         }
-        /** @type {string[]} */
         const appPaths = await bluebird_1.default.all(appsList.map((app) => this.helpers.configureApp(app, {
             onPostProcess: app_utils_1.onPostConfigureApp.bind(this),
             onDownload: app_utils_1.onDownloadApp.bind(this),
             supportedExtensions: app_utils_1.SUPPORTED_EXTENSIONS,
         })));
-        /** @type {string[]} */
         const appIds = await bluebird_1.default.all(appPaths.map((appPath) => this.appInfosCache.extractBundleId(appPath)));
         for (const [appId, appPath] of lodash_1.default.zip(appIds, appPaths)) {
             if (this.isRealDevice()) {
@@ -1508,10 +1397,6 @@ class XCUITestDriver extends driver_1.BaseDriver {
             }
         }
     }
-    /**
-     * @param {string} orientation
-     * @returns {Promise<void>}
-     */
     async setInitialOrientation(orientation) {
         const dstOrientation = lodash_1.default.toUpper(orientation);
         if (!SUPPORTED_ORIENATIONS.includes(dstOrientation)) {
@@ -1527,21 +1412,6 @@ class XCUITestDriver extends driver_1.BaseDriver {
             this.log.warn(`Setting initial orientation failed with: ${err.message}`);
         }
     }
-    /**
-     * @param {string} [cmdName]
-     * @returns {number|undefined}
-     */
-    _getCommandTimeout(cmdName) {
-        if (this.opts.commandTimeouts) {
-            if (cmdName && lodash_1.default.has(this.opts.commandTimeouts, cmdName)) {
-                return this.opts.commandTimeouts[cmdName];
-            }
-            return this.opts.commandTimeouts[utils_1.DEFAULT_TIMEOUT_KEY];
-        }
-    }
-    /**
-     * Reset the current session (run the delete session and create session subroutines)
-     */
     async reset() {
         throw new Error(`The reset API has been deprecated and is not supported anymore. ` +
             `Consider using corresponding 'mobile:' extensions to manage the state of the app under test.`);
@@ -1570,6 +1440,41 @@ class XCUITestDriver extends driver_1.BaseDriver {
             await simulator_management_1.installToSimulator.bind(this)(this.opts.prebuiltWDAPath, candidateBundleId);
         }
     }
+    resetIos() {
+        this.opts = this.opts || {};
+        this._wda = null;
+        this.jwpProxyActive = false;
+        this.proxyReqRes = null;
+        this.safari = false;
+        this.cachedWdaStatus = null;
+        this.curWebFrames = [];
+        this._currentUrl = null;
+        this.curContext = null;
+        this.xcodeVersion = undefined;
+        this.contexts = [];
+        this.implicitWaitMs = 0;
+        this.pageLoadMs = 6000;
+        this.landscapeWebCoordsOffset = 0;
+        this.remote = null;
+        this._conditionInducerService = null;
+        this._remoteXPCConditionInducerConnection = null;
+        this.webElementsCache = new lru_cache_1.LRUCache({
+            max: WEB_ELEMENTS_CACHE_SIZE,
+        });
+        this._waitingAtoms = {
+            count: 0,
+            alertNotifier: new node_events_1.default(),
+            alertMonitor: bluebird_1.default.resolve(),
+        };
+    }
+    _getCommandTimeout(cmdName) {
+        if (this.opts.commandTimeouts) {
+            if (cmdName && lodash_1.default.has(this.opts.commandTimeouts, cmdName)) {
+                return this.opts.commandTimeouts[cmdName];
+            }
+            return this.opts.commandTimeouts[utils_1.DEFAULT_TIMEOUT_KEY];
+        }
+    }
     /*---------------+
      | ACTIVEAPPINFO |
      +---------------+*/
@@ -1945,32 +1850,4 @@ class XCUITestDriver extends driver_1.BaseDriver {
 }
 exports.XCUITestDriver = XCUITestDriver;
 exports.default = XCUITestDriver;
-/**
- * @template {import('@appium/types').Constraints} C
- * @template [Ctx=string]
- * @typedef {import('@appium/types').ExternalDriver<C, Ctx>} ExternalDriver
- */
-/**
- * @typedef {Pick<XCUITestDriverOpts, 'enforceAppInstall' | 'fullReset' | 'noReset' | 'bundleId' | 'app'>} AutInstallationStateOptions
- */
-/**
- * @typedef {Object} AutInstallationState
- * @property {boolean} install - If the given app should install, or not need to install.
- * @property {boolean} skipUninstall - If the installed app should be uninstalled, or not.
- */
-/**
- * @typedef {typeof desiredCapConstraints} XCUITestDriverConstraints
- * @typedef {import('@appium/types').DriverOpts<XCUITestDriverConstraints>} XCUITestDriverOpts
- * @typedef {import('./commands/types').FullContext} FullContext
- * @typedef {import('appium-xcode').XcodeVersion} XcodeVersion
- * @typedef {import('appium-ios-simulator').Simulator} Simulator
- */
-/**
- * @typedef {Object} DriverLogs
- * @property {import('./device-log/ios-device-log').IOSDeviceLog|import('./device-log/ios-simulator-log').IOSSimulatorLog} [syslog]
- * @property {import('./device-log/ios-crash-log').IOSCrashLog} [crashlog]
- * @property {import('./device-log/safari-console-log').SafariConsoleLog} [safariConsole]
- * @property {import('./device-log/safari-network-log').SafariNetworkLog} [safariNetwork]
- * @property {import('./device-log/ios-performance-log').IOSPerformanceLog} [performance]
- */
 //# sourceMappingURL=driver.js.map