appium-webdriveragent 14.2.0 → 15.0.0

package/build/lib/utils/xctestrun.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xctestrun.js","sourceRoot":"","sources":["../../../lib/utils/xctestrun.ts"],"names":[],"mappings":";;;;;AAiCA,4CAqBC;AAUD,0DAmBC;AAQD,oDAuCC;AAQD,oDAKC;AA/ID,6CAAgD;AAChD,0DAA6B;AAC7B,qCAA6B;AAC7B,sCAA8B;AAE9B,yCAAkC;AAclC;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,gBAAgB,CAAC,IAAuB;IAC5D,MAAM,EACJ,UAAU,EACV,UAAU,EACV,aAAa,EACb,aAAa,EACb,YAAY,EACZ,sBAAsB,GACvB,GAAG,IAAI,CAAC;IACT,MAAM,iBAAiB,GAAG,MAAM,oBAAoB,CAAC,UAAU,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;IAC5F,MAAM,gBAAgB,GAAG,MAAM,eAAK,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;IACvE,MAAM,aAAa,GAAG,uBAAuB,CAC3C,UAAU,CAAC,YAAY,EACvB,aAAa,EACb,YAAY,EACZ,sBAAsB,CACvB,CAAC;IACF,MAAM,mBAAmB,GAAG,YAAY,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;IAC1E,MAAM,eAAK,CAAC,eAAe,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;IAE1E,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,uBAAuB,CACrC,YAAoB,EACpB,aAA8B,EAC9B,YAAqB,EACrB,sBAAwC;IAExC,MAAM,MAAM,GAAG,uBAAuB,IAAA,iBAAM,EAAC,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAC5E,OAAO;QACL,CAAC,MAAM,CAAC,EAAE;YACR,oBAAoB,EAAE;gBACpB,4BAA4B;gBAC5B,QAAQ,EAAE,GAAG,aAAa,EAAE;gBAC5B,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAC,MAAM,EAAE,YAAY,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC/C,GAAG,CAAC,sBAAsB;oBACxB,CAAC,CAAC,EAAC,0BAA0B,EAAE,GAAG,sBAAsB,EAAE,EAAC;oBAC3D,CAAC,CAAC,EAAE,CAAC;aACR;SACF;KACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,oBAAoB,CACxC,UAAsB,EACtB,UAAkB,EAClB,aAAqB;IAErB,kDAAkD;IAClD,MAAM,QAAQ,GAAqB;QACjC,mBAAI,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,UAAU,CAAC,IAAI,IAAI,UAAU,YAAY,CAAC;QACzE,UAAU;KACX,CAAC;IACF,qDAAqD;IACrD,MAAM,aAAa,GAAqB;QACtC,mBAAI,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,UAAU,CAAC,IAAI,IAAI,UAAU,CAAC,eAAe,YAAY,CAAC;QACzF,UAAU,CAAC,eAAe;KAC3B,CAAC;IAEF,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,EAAE,CAAC;QAC5D,IAAI,MAAM,YAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9B,YAAG,CAAC,IAAI,CAAC,UAAU,QAAQ,qBAAqB,CAAC,CAAC;YAClD,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,MAAM,qBAAqB,GAAG,mBAAI,CAAC,OAAO,CACxC,aAAa,EACb,oBAAoB,CAAC,UAAU,EAAE,OAAO,CAAC,CAC1C,CAAC;QACF,IAAI,MAAM,YAAE,CAAC,MAAM,CAAC,qBAAqB,CAAC,EAAE,CAAC;YAC3C,6FAA6F;YAC7F,wGAAwG;YACxG,MAAM,YAAE,CAAC,QAAQ,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC;YACnD,YAAG,CAAC,IAAI,CAAC,UAAU,QAAQ,kCAAkC,qBAAqB,GAAG,CAAC,CAAC;YACvF,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IAED,MAAM,IAAI,KAAK,CACb,0DAA0D;QACxD,2CAA2C;QAC3C,IAAI,mBAAI,CAAC,OAAO,CAAC,aAAa,EAAE,oBAAoB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,IAAI,CACpF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,UAAsB,EAAE,OAAe;IAC1E,MAAM,UAAU,GAAG,UAAU,CAAC,YAAY;QACxC,CAAC,CAAC,KAAK,OAAO,QAAQ;QACtB,CAAC,CAAC,YAAY,OAAO,IAAI,IAAA,cAAI,GAAE,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IACrE,OAAO,wBAAwB,IAAA,iBAAM,EAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,GAAG,UAAU,YAAY,CAAC;AACtH,CAAC;AAED,SAAS,YAAY,CACnB,MAAS,EACT,MAAS;IAET,MAAM,MAAM,GAAwB,EAAC,GAAG,MAAM,EAAC,CAAC;IAChD,KAAK,MAAM,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACxD,MAAM,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,cAAI,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,cAAI,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,CAAC;YACvE,MAAM,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACrD,SAAS;QACX,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC;IAC5B,CAAC;IACD,OAAO,MAAe,CAAC;AACzB,CAAC"}

package/build/lib/wda-strategies.d.ts

@@ -0,0 +1,69 @@
+import type { AppiumLogger, StringRecord } from '@appium/types';
+import type { NoSessionProxy } from './no-session-proxy';
+import type { XcodeBuild } from './xcodebuild';
+import type { AppleDevice, RealDevicePreinstalledHostOps, RealDeviceXcodebuildHostOps, SimulatorHostOps, WdaHostOps, WdaStartupStrategyName } from './types';
+export interface WdaStartupStrategy {
+    readonly name: WdaStartupStrategyName;
+    launch(sessionId: string): Promise<StringRecord | null>;
+    quit(): Promise<void>;
+}
+export interface WdaStartupStrategyContext {
+    readonly argsWebDriverAgentUrl?: string;
+    readonly webDriverAgentUrl?: string;
+    readonly usePreinstalledWDA?: boolean;
+    readonly useXctestrunFile?: boolean;
+    readonly usePrebuiltWDA?: boolean;
+    readonly prebuildWDA?: boolean;
+    readonly isRealDevice: boolean;
+    readonly device: AppleDevice;
+    readonly agentPath: string;
+    readonly bootstrapPath: string;
+    readonly bundleIdForXctest: string;
+    readonly wdaLocalPort?: number;
+    readonly wdaRemotePort: number;
+    readonly wdaBindingIP?: string;
+    readonly wdaLaunchTimeout: number;
+    readonly mjpegServerPort?: number;
+    readonly maxHttpRequestBodySize?: number;
+    readonly platformName?: string;
+    readonly platformVersion?: string;
+    readonly log: AppiumLogger;
+    readonly hostOps: Required<WdaHostOps>;
+    setWebDriverAgentUrl(value?: string): void;
+    setUrl(value: string): void;
+    setupProxies(sessionId: string): void;
+    getStatus(timeoutMs?: number): Promise<StringRecord | null>;
+    cleanupProjectIfFresh(): Promise<void>;
+    xcodebuild(): XcodeBuild;
+    noSessionProxy(): NoSessionProxy;
+    setStarted(started: boolean): void;
+}
+/**
+ * Selects the WDA startup strategy for the provided launch arguments.
+ */
+export declare function selectWdaStartupStrategyName(args: {
+    realDevice?: boolean;
+    webDriverAgentUrl?: string;
+    usePreinstalledWDA?: boolean;
+}): WdaStartupStrategyName;
+/**
+ * Creates a WDA startup strategy for the current facade state.
+ */
+export declare function createWdaStartupStrategy(ctx: WdaStartupStrategyContext): WdaStartupStrategy;
+/**
+ * Creates default host operations for flows the package can own directly.
+ */
+export declare function createDefaultWdaHostOps(): Required<WdaHostOps>;
+/**
+ * Creates default simulator host operations.
+ */
+export declare function createDefaultSimulatorWdaHostOps(): SimulatorHostOps;
+/**
+ * Creates default real-device preinstalled host operations.
+ */
+export declare function createDefaultRealDevicePreinstalledHostOps(): RealDevicePreinstalledHostOps;
+/**
+ * Creates default real-device xcodebuild host operations.
+ */
+export declare function createDefaultRealDeviceXcodebuildHostOps(): RealDeviceXcodebuildHostOps;
+//# sourceMappingURL=wda-strategies.d.ts.map

package/build/lib/wda-strategies.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wda-strategies.d.ts","sourceRoot":"","sources":["../../lib/wda-strategies.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,YAAY,EAAE,YAAY,EAAC,MAAM,eAAe,CAAC;AAE9D,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,cAAc,CAAC;AAC7C,OAAO,KAAK,EACV,WAAW,EACX,6BAA6B,EAC7B,2BAA2B,EAC3B,gBAAgB,EAChB,UAAU,EAEV,sBAAsB,EACvB,MAAM,SAAS,CAAC;AAMjB,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,IAAI,EAAE,sBAAsB,CAAC;IACtC,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IACxD,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IACxC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IACtC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IACpC,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IACvC,oBAAoB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IAC5D,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,UAAU,IAAI,UAAU,CAAC;IACzB,cAAc,IAAI,cAAc,CAAC;IACjC,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;CACpC;AAsED;;GAEG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,EAAE;IACjD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,GAAG,sBAAsB,CAWzB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,yBAAyB,GAAG,kBAAkB,CAkB3F;AAED;;GAEG;AACH,wBAAgB,uBAAuB,IAAI,QAAQ,CAAC,UAAU,CAAC,CAM9D;AAED;;GAEG;AACH,wBAAgB,gCAAgC,IAAI,gBAAgB,CAYnE;AAED;;GAEG;AACH,wBAAgB,0CAA0C,IAAI,6BAA6B,CAS1F;AAED;;GAEG;AACH,wBAAgB,wCAAwC,IAAI,2BAA2B,CAkBtF"}

package/build/lib/wda-strategies.js

@@ -0,0 +1,253 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.selectWdaStartupStrategyName = selectWdaStartupStrategyName;
+exports.createWdaStartupStrategy = createWdaStartupStrategy;
+exports.createDefaultWdaHostOps = createDefaultWdaHostOps;
+exports.createDefaultSimulatorWdaHostOps = createDefaultSimulatorWdaHostOps;
+exports.createDefaultRealDevicePreinstalledHostOps = createDefaultRealDevicePreinstalledHostOps;
+exports.createDefaultRealDeviceXcodebuildHostOps = createDefaultRealDeviceXcodebuildHostOps;
+const teen_process_1 = require("teen_process");
+const support_1 = require("@appium/support");
+const utils_1 = require("./utils");
+const WDA_AGENT_PORT = 8100;
+const HOST_OPS_REQUIRED_MESSAGE = 'Host operations must be provided to launch or terminate preinstalled WebDriverAgent';
+class ExistingWdaUrlStrategy {
+    ctx;
+    name = 'existing-url';
+    constructor(ctx) {
+        this.ctx = ctx;
+    }
+    async launch(sessionId) {
+        this.ctx.log.info(`Using provided WebdriverAgent at '${this.ctx.webDriverAgentUrl}'`);
+        this.ctx.setUrl(this.ctx.webDriverAgentUrl);
+        this.ctx.setupProxies(sessionId);
+        return await this.ctx.getStatus();
+    }
+    async quit() {
+        this.ctx.log.debug('Stopping neither xcodebuild nor XCTest session since WDA lifecycle is not managed by this driver');
+    }
+}
+class SimulatorWdaStrategy {
+    ctx;
+    name = 'simulator';
+    constructor(ctx) {
+        this.ctx = ctx;
+    }
+    async launch(sessionId) {
+        if (this.ctx.usePreinstalledWDA) {
+            return await launchPreinstalled(this.ctx, this.ctx.hostOps.simulator, sessionId);
+        }
+        return await launchWithXcodebuild(this.ctx, sessionId);
+    }
+    async quit() {
+        if (this.ctx.usePreinstalledWDA) {
+            await terminatePreinstalled(this.ctx, this.ctx.hostOps.simulator);
+            return;
+        }
+        await quitXcodebuild(this.ctx);
+    }
+}
+class RealDeviceXcodebuildStrategy {
+    ctx;
+    name = 'real-device-xcodebuild';
+    constructor(ctx) {
+        this.ctx = ctx;
+    }
+    async launch(sessionId) {
+        return await launchWithXcodebuild(this.ctx, sessionId);
+    }
+    async quit() {
+        await quitXcodebuild(this.ctx);
+    }
+}
+class RealDevicePreinstalledStrategy {
+    ctx;
+    name = 'real-device-preinstalled';
+    constructor(ctx) {
+        this.ctx = ctx;
+    }
+    async launch(sessionId) {
+        return await launchPreinstalled(this.ctx, this.ctx.hostOps.realDevicePreinstalled, sessionId);
+    }
+    async quit() {
+        await terminatePreinstalled(this.ctx, this.ctx.hostOps.realDevicePreinstalled);
+    }
+}
+/**
+ * Selects the WDA startup strategy for the provided launch arguments.
+ */
+function selectWdaStartupStrategyName(args) {
+    if (args.webDriverAgentUrl) {
+        return 'existing-url';
+    }
+    if (!args.realDevice) {
+        return 'simulator';
+    }
+    if (args.usePreinstalledWDA) {
+        return 'real-device-preinstalled';
+    }
+    return 'real-device-xcodebuild';
+}
+/**
+ * Creates a WDA startup strategy for the current facade state.
+ */
+function createWdaStartupStrategy(ctx) {
+    const startupStrategy = selectWdaStartupStrategyName({
+        realDevice: ctx.isRealDevice,
+        webDriverAgentUrl: ctx.webDriverAgentUrl,
+        usePreinstalledWDA: ctx.usePreinstalledWDA,
+    });
+    switch (startupStrategy) {
+        case 'existing-url':
+            return new ExistingWdaUrlStrategy(ctx);
+        case 'simulator':
+            return new SimulatorWdaStrategy(ctx);
+        case 'real-device-preinstalled':
+            return new RealDevicePreinstalledStrategy(ctx);
+        case 'real-device-xcodebuild':
+            return new RealDeviceXcodebuildStrategy(ctx);
+        default:
+            throw new Error(`Unknown WDA startup strategy: ${startupStrategy}`);
+    }
+}
+/**
+ * Creates default host operations for flows the package can own directly.
+ */
+function createDefaultWdaHostOps() {
+    return {
+        simulator: createDefaultSimulatorWdaHostOps(),
+        realDevicePreinstalled: createDefaultRealDevicePreinstalledHostOps(),
+        realDeviceXcodebuild: createDefaultRealDeviceXcodebuildHostOps(),
+    };
+}
+/**
+ * Creates default simulator host operations.
+ */
+function createDefaultSimulatorWdaHostOps() {
+    return {
+        async launchPreinstalled() {
+            throw new Error(HOST_OPS_REQUIRED_MESSAGE);
+        },
+        async terminate() {
+            throw new Error(HOST_OPS_REQUIRED_MESSAGE);
+        },
+        async resetTestProcesses({ udid, isSimulator }) {
+            await (0, utils_1.resetTestProcesses)(udid, isSimulator);
+        },
+    };
+}
+/**
+ * Creates default real-device preinstalled host operations.
+ */
+function createDefaultRealDevicePreinstalledHostOps() {
+    return {
+        async launchPreinstalled() {
+            throw new Error(HOST_OPS_REQUIRED_MESSAGE);
+        },
+        async terminate() {
+            throw new Error(HOST_OPS_REQUIRED_MESSAGE);
+        },
+    };
+}
+/**
+ * Creates default real-device xcodebuild host operations.
+ */
+function createDefaultRealDeviceXcodebuildHostOps() {
+    return {
+        async resetTestProcesses({ udid, isSimulator }) {
+            await (0, utils_1.resetTestProcesses)(udid, isSimulator);
+        },
+        async cleanupObsoleteProcesses({ udid, port, commandLineIncludes }) {
+            const obsoletePids = await (0, utils_1.getPIDsListeningOnPort)(port, (cmdLine) => cmdLine.includes(commandLineIncludes) &&
+                !cmdLine.toLowerCase().includes(udid.toLowerCase()));
+            if (obsoletePids.length > 0) {
+                await (0, teen_process_1.exec)('kill', obsoletePids);
+            }
+        },
+    };
+}
+async function launchWithXcodebuild(ctx, sessionId) {
+    ctx.log.info('Launching WebDriverAgent on the device');
+    ctx.setupProxies(sessionId);
+    if (!ctx.useXctestrunFile && !(await support_1.fs.exists(ctx.agentPath))) {
+        throw new Error(`Trying to use WebDriverAgent project at '${ctx.agentPath}' but the ` + 'file does not exist');
+    }
+    if (ctx.useXctestrunFile || ctx.usePrebuiltWDA) {
+        ctx.log.info('Skipped WDA project cleanup according to the provided capabilities');
+    }
+    else {
+        await ctx.cleanupProjectIfFresh();
+    }
+    const resetTestProcesses = ctx.isRealDevice
+        ? ctx.hostOps.realDeviceXcodebuild.resetTestProcesses
+        : ctx.hostOps.simulator.resetTestProcesses;
+    await resetTestProcesses?.({
+        udid: ctx.device.udid,
+        isSimulator: !ctx.isRealDevice,
+    });
+    const xcodebuild = ctx.xcodebuild();
+    await xcodebuild.init(ctx.noSessionProxy());
+    if (ctx.prebuildWDA) {
+        await xcodebuild.prebuild();
+    }
+    return (await xcodebuild.start());
+}
+async function launchPreinstalled(ctx, hostOps, sessionId) {
+    const xctestEnv = createPreinstalledWdaEnvironment(ctx);
+    ctx.log.info('Launching WebDriverAgent on the device without xcodebuild');
+    await hostOps.launchPreinstalled({
+        udid: ctx.device.udid,
+        bundleId: ctx.bundleIdForXctest,
+        env: xctestEnv,
+        wdaLocalPort: ctx.wdaLocalPort,
+        wdaRemotePort: ctx.wdaRemotePort,
+        platformName: ctx.platformName,
+        platformVersion: ctx.platformVersion,
+        timeoutMs: ctx.wdaLaunchTimeout,
+    });
+    ctx.setupProxies(sessionId);
+    let status;
+    try {
+        status = await ctx.getStatus(ctx.wdaLaunchTimeout);
+    }
+    catch {
+        throw new Error(`Failed to start the preinstalled WebDriverAgent in ${ctx.wdaLaunchTimeout} ms. ` +
+            `The WebDriverAgent might not be properly built or the device might be locked. ` +
+            `The 'appium:wdaLaunchTimeout' capability modifies the timeout.`);
+    }
+    ctx.setStarted(true);
+    return status;
+}
+async function terminatePreinstalled(ctx, hostOps) {
+    ctx.log.info('Stopping the XCTest session');
+    try {
+        await hostOps.terminate({
+            udid: ctx.device.udid,
+            bundleId: ctx.bundleIdForXctest,
+        });
+    }
+    catch (e) {
+        ctx.log.warn(e.message);
+    }
+}
+async function quitXcodebuild(ctx) {
+    ctx.log.info('Shutting down sub-processes');
+    await ctx.xcodebuild().quit();
+}
+function createPreinstalledWdaEnvironment(ctx) {
+    const xctestEnv = {
+        USE_PORT: ctx.wdaLocalPort || WDA_AGENT_PORT,
+        WDA_PRODUCT_BUNDLE_IDENTIFIER: ctx.bundleIdForXctest,
+    };
+    if (ctx.mjpegServerPort) {
+        xctestEnv.MJPEG_SERVER_PORT = ctx.mjpegServerPort;
+    }
+    if (ctx.wdaBindingIP) {
+        xctestEnv.USE_IP = ctx.wdaBindingIP;
+    }
+    if (ctx.maxHttpRequestBodySize) {
+        xctestEnv.MAX_HTTP_REQUEST_BODY_SIZE = ctx.maxHttpRequestBodySize;
+    }
+    return xctestEnv;
+}
+//# sourceMappingURL=wda-strategies.js.map

package/build/lib/wda-strategies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wda-strategies.js","sourceRoot":"","sources":["../../lib/wda-strategies.ts"],"names":[],"mappings":";;AAiIA,oEAeC;AAKD,4DAkBC;AAKD,0DAMC;AAKD,4EAYC;AAKD,gGASC;AAKD,4FAkBC;AAxOD,+CAAkC;AAClC,6CAAmC;AAEnC,mCAAmE;AAanE,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,MAAM,yBAAyB,GAC7B,qFAAqF,CAAC;AAwCxF,MAAM,sBAAsB;IAGG;IAFpB,IAAI,GAAG,cAAuB,CAAC;IAExC,YAA6B,GAA8B;QAA9B,QAAG,GAAH,GAAG,CAA2B;IAAG,CAAC;IAE/D,KAAK,CAAC,MAAM,CAAC,SAAiB;QAC5B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,qCAAqC,IAAI,CAAC,GAAG,CAAC,iBAAiB,GAAG,CAAC,CAAC;QACtF,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,iBAA2B,CAAC,CAAC;QACtD,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAChB,kGAAkG,CACnG,CAAC;IACJ,CAAC;CACF;AAED,MAAM,oBAAoB;IAGK;IAFpB,IAAI,GAAG,WAAoB,CAAC;IAErC,YAA6B,GAA8B;QAA9B,QAAG,GAAH,GAAG,CAA2B;IAAG,CAAC;IAE/D,KAAK,CAAC,MAAM,CAAC,SAAiB;QAC5B,IAAI,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC;YAChC,OAAO,MAAM,kBAAkB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnF,CAAC;QACD,OAAO,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC;YAChC,MAAM,qBAAqB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAClE,OAAO;QACT,CAAC;QACD,MAAM,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;CACF;AAED,MAAM,4BAA4B;IAGH;IAFpB,IAAI,GAAG,wBAAiC,CAAC;IAElD,YAA6B,GAA8B;QAA9B,QAAG,GAAH,GAAG,CAA2B;IAAG,CAAC;IAE/D,KAAK,CAAC,MAAM,CAAC,SAAiB;QAC5B,OAAO,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,IAAI;QACR,MAAM,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;CACF;AAED,MAAM,8BAA8B;IAGL;IAFpB,IAAI,GAAG,0BAAmC,CAAC;IAEpD,YAA6B,GAA8B;QAA9B,QAAG,GAAH,GAAG,CAA2B;IAAG,CAAC;IAE/D,KAAK,CAAC,MAAM,CAAC,SAAiB;QAC5B,OAAO,MAAM,kBAAkB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,sBAAsB,EAAE,SAAS,CAAC,CAAC;IAChG,CAAC;IAED,KAAK,CAAC,IAAI;QACR,MAAM,qBAAqB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACjF,CAAC;CACF;AAED;;GAEG;AACH,SAAgB,4BAA4B,CAAC,IAI5C;IACC,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,OAAO,cAAc,CAAC;IACxB,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;QACrB,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC5B,OAAO,0BAA0B,CAAC;IACpC,CAAC;IACD,OAAO,wBAAwB,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,SAAgB,wBAAwB,CAAC,GAA8B;IACrE,MAAM,eAAe,GAAG,4BAA4B,CAAC;QACnD,UAAU,EAAE,GAAG,CAAC,YAAY;QAC5B,iBAAiB,EAAE,GAAG,CAAC,iBAAiB;QACxC,kBAAkB,EAAE,GAAG,CAAC,kBAAkB;KAC3C,CAAC,CAAC;IACH,QAAQ,eAAe,EAAE,CAAC;QACxB,KAAK,cAAc;YACjB,OAAO,IAAI,sBAAsB,CAAC,GAAG,CAAC,CAAC;QACzC,KAAK,WAAW;YACd,OAAO,IAAI,oBAAoB,CAAC,GAAG,CAAC,CAAC;QACvC,KAAK,0BAA0B;YAC7B,OAAO,IAAI,8BAA8B,CAAC,GAAG,CAAC,CAAC;QACjD,KAAK,wBAAwB;YAC3B,OAAO,IAAI,4BAA4B,CAAC,GAAG,CAAC,CAAC;QAC/C;YACE,MAAM,IAAI,KAAK,CAAC,iCAAiC,eAAe,EAAE,CAAC,CAAC;IACxE,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,uBAAuB;IACrC,OAAO;QACL,SAAS,EAAE,gCAAgC,EAAE;QAC7C,sBAAsB,EAAE,0CAA0C,EAAE;QACpE,oBAAoB,EAAE,wCAAwC,EAAE;KACjE,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,gCAAgC;IAC9C,OAAO;QACL,KAAK,CAAC,kBAAkB;YACtB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QACD,KAAK,CAAC,SAAS;YACb,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QACD,KAAK,CAAC,kBAAkB,CAAC,EAAC,IAAI,EAAE,WAAW,EAAC;YAC1C,MAAM,IAAA,0BAAkB,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,0CAA0C;IACxD,OAAO;QACL,KAAK,CAAC,kBAAkB;YACtB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QACD,KAAK,CAAC,SAAS;YACb,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,wCAAwC;IACtD,OAAO;QACL,KAAK,CAAC,kBAAkB,CAAC,EAAC,IAAI,EAAE,WAAW,EAAC;YAC1C,MAAM,IAAA,0BAAkB,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,CAAC;QACD,KAAK,CAAC,wBAAwB,CAAC,EAAC,IAAI,EAAE,IAAI,EAAE,mBAAmB,EAAC;YAC9D,MAAM,YAAY,GAAG,MAAM,IAAA,8BAAsB,EAC/C,IAAI,EACJ,CAAC,OAAO,EAAE,EAAE,CACV,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC;gBACrC,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CACtD,CAAC;YAEF,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAA,mBAAI,EAAC,MAAM,EAAE,YAAY,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,oBAAoB,CACjC,GAA8B,EAC9B,SAAiB;IAEjB,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;IAEvD,GAAG,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAE5B,IAAI,CAAC,GAAG,CAAC,gBAAgB,IAAI,CAAC,CAAC,MAAM,YAAE,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;QAC/D,MAAM,IAAI,KAAK,CACb,4CAA4C,GAAG,CAAC,SAAS,YAAY,GAAG,qBAAqB,CAC9F,CAAC;IACJ,CAAC;IAED,IAAI,GAAG,CAAC,gBAAgB,IAAI,GAAG,CAAC,cAAc,EAAE,CAAC;QAC/C,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,oEAAoE,CAAC,CAAC;IACrF,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,CAAC,qBAAqB,EAAE,CAAC;IACpC,CAAC;IAED,MAAM,kBAAkB,GAAG,GAAG,CAAC,YAAY;QACzC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,CAAC,kBAAkB;QACrD,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,kBAAkB,CAAC;IAC7C,MAAM,kBAAkB,EAAE,CAAC;QACzB,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI;QACrB,WAAW,EAAE,CAAC,GAAG,CAAC,YAAY;KAC/B,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,EAAE,CAAC;IACpC,MAAM,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC;IAE5C,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;QACpB,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IACD,OAAO,CAAC,MAAM,UAAU,CAAC,KAAK,EAAE,CAAwB,CAAC;AAC3D,CAAC;AAED,KAAK,UAAU,kBAAkB,CAC/B,GAA8B,EAC9B,OAAyD,EACzD,SAAiB;IAEjB,MAAM,SAAS,GAAG,gCAAgC,CAAC,GAAG,CAAC,CAAC;IACxD,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;IAC1E,MAAM,OAAO,CAAC,kBAAkB,CAAC;QAC/B,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI;QACrB,QAAQ,EAAE,GAAG,CAAC,iBAAiB;QAC/B,GAAG,EAAE,SAAS;QACd,YAAY,EAAE,GAAG,CAAC,YAAY;QAC9B,aAAa,EAAE,GAAG,CAAC,aAAa;QAChC,YAAY,EAAE,GAAG,CAAC,YAAY;QAC9B,eAAe,EAAE,GAAG,CAAC,eAAe;QACpC,SAAS,EAAE,GAAG,CAAC,gBAAgB;KAChC,CAAC,CAAC;IAEH,GAAG,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAC5B,IAAI,MAA2B,CAAC;IAChC,IAAI,CAAC;QACH,MAAM,GAAG,MAAM,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IACrD,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CACb,sDAAsD,GAAG,CAAC,gBAAgB,OAAO;YAC/E,gFAAgF;YAChF,gEAAgE,CACnE,CAAC;IACJ,CAAC;IACD,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACrB,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,qBAAqB,CAClC,GAA8B,EAC9B,OAAyD;IAEzD,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC5C,IAAI,CAAC;QACH,MAAM,OAAO,CAAC,SAAS,CAAC;YACtB,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI;YACrB,QAAQ,EAAE,GAAG,CAAC,iBAAiB;SAChC,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;AACH,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,GAA8B;IAC1D,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC5C,MAAM,GAAG,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,CAAC;AAChC,CAAC;AAED,SAAS,gCAAgC,CAAC,GAA8B;IACtE,MAAM,SAAS,GAAyB;QACtC,QAAQ,EAAE,GAAG,CAAC,YAAY,IAAI,cAAc;QAC5C,6BAA6B,EAAE,GAAG,CAAC,iBAAiB;KACrD,CAAC;IACF,IAAI,GAAG,CAAC,eAAe,EAAE,CAAC;QACxB,SAAS,CAAC,iBAAiB,GAAG,GAAG,CAAC,eAAe,CAAC;IACpD,CAAC;IACD,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;QACrB,SAAS,CAAC,MAAM,GAAG,GAAG,CAAC,YAAY,CAAC;IACtC,CAAC;IACD,IAAI,GAAG,CAAC,sBAAsB,EAAE,CAAC;QAC/B,SAAS,CAAC,0BAA0B,GAAG,GAAG,CAAC,sBAAsB,CAAC;IACpE,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/build/lib/webdriveragent.d.ts

@@ -33,6 +33,8 @@ export declare class WebDriverAgent {
     private readonly wdaLaunchTimeout;
     private readonly usePreinstalledWDA?;
     private readonly updatedWDABundleIdSuffix;
+    private readonly hostOps;
+    private activeStartupStrategy?;
     private _xcodebuild?;
     private _url?;
     /**
@@ -147,6 +149,7 @@ export declare class WebDriverAgent {
      * @returns The WDA URL used for caching on success, or `undefined` if caching was skipped.
      */
     setupCaching(): Promise<string | undefined>;
+    private createStartupStrategy;
     private setupProxies;
     private toUrl;
     private setWDAPaths;
@@ -173,19 +176,5 @@ export declare class WebDriverAgent {
      */
     private getStatus;
     private _cleanupProjectIfFresh;
-    /**
-     * Launch WDA with preinstalled package with 'xcrun devicectl device process launch'.
-     * The WDA package must be prepared properly like published via
-     * https://github.com/appium/WebDriverAgent/releases
-     * with proper sign for this case.
-     *
-     * @param opts launching WDA with devicectl command options.
-     */
-    private _launchViaDevicectl;
-    /**
-     * Launch WDA with preinstalled package without xcodebuild.
-     * @param sessionId Launch WDA and establish the session with this sessionId
-     */
-    private launchWithPreinstalledWDA;
 }
 //# sourceMappingURL=webdriveragent.d.ts.map

package/build/lib/webdriveragent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webdriveragent.d.ts","sourceRoot":"","sources":["../../lib/webdriveragent.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,OAAO,EAAC,MAAM,qBAAqB,CAAC;AAE5C,OAAO,KAAK,EAAC,YAAY,EAAE,YAAY,EAAC,MAAM,eAAe,CAAC;AAE9D,OAAO,EAAC,cAAc,EAAC,MAAM,oBAAoB,CAAC;AAOlD,OAAO,EAAC,UAAU,EAAC,MAAM,cAAc,CAAC;AAUxC,OAAO,KAAK,EACV,kBAAkB,EAClB,WAAW,EACX,kBAAkB,EAClB,4BAA4B,EAC7B,MAAM,SAAS,CAAC;AAUjB,qBAAa,cAAc;IACzB,aAAa,EAAG,MAAM,CAAC;IACvB,SAAS,EAAG,MAAM,CAAC;IACnB,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAe;IACnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAU;IACvC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAS;IAC/C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAU;IAC5C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAU;IAC1C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAS;IACjD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAU;IAC9C,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAS;IAClD,OAAO,CAAC,WAAW,CAAC,CAAoB;IACxC,OAAO,CAAC,IAAI,CAAC,CAAM;IAEnB;;;;OAIG;gBACS,IAAI,EAAE,kBAAkB,EAAE,GAAG,GAAE,YAAY,GAAG,IAAW;IA2ErE;;;OAGG;IACH,IAAI,iBAAiB,IAAI,OAAO,CAI/B;IAED;;;;OAIG;IACH,IAAI,UAAU,IAAI,UAAU,CAK3B;IAED;;;;;;;OAOG;IACH,IAAI,iBAAiB,IAAI,MAAM,CAE9B;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,MAAM,CAKrB;IAED;;;;;OAKG;IACH,IAAI,GAAG,IAAI,GAAG,CAab;IAED;;;OAGG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED;;;OAGG;IACH,IAAI,YAAY,CAAC,OAAO,EAAE,OAAO,EAEhC;IAED;;;OAGG;IACH,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,EAEnB;IAED;;;OAGG;IACG,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;IA8B/C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAkD7D;;;;OAIG;IACG,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC;IAOvC;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAoC3B;;;;OAIG;IACG,qBAAqB,CACzB,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC;IAO1C;;;OAGG;IACG,uBAAuB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAO5D;;;;;OAKG;IACG,YAAY,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAyDjD,OAAO,CAAC,YAAY;IAsBpB,OAAO,CAAC,KAAK;IAYb,OAAO,CAAC,WAAW;IAWnB;;;;;;;;;;;;;;;;;;;;OAoBG;YACW,SAAS;YAoDT,sBAAsB;IAmEpC;;;;;;;OAOG;YACW,mBAAmB;IAWjC;;;OAGG;YACW,yBAAyB;CAsCxC"}
+{"version":3,"file":"webdriveragent.d.ts","sourceRoot":"","sources":["../../lib/webdriveragent.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,OAAO,EAAC,MAAM,qBAAqB,CAAC;AAE5C,OAAO,KAAK,EAAC,YAAY,EAAE,YAAY,EAAC,MAAM,eAAe,CAAC;AAE9D,OAAO,EAAC,cAAc,EAAC,MAAM,oBAAoB,CAAC;AAElD,OAAO,EAAC,UAAU,EAAC,MAAM,cAAc,CAAC;AASxC,OAAO,KAAK,EACV,kBAAkB,EAClB,WAAW,EACX,kBAAkB,EAClB,4BAA4B,EAE7B,MAAM,SAAS,CAAC;AAcjB,qBAAa,cAAc;IACzB,aAAa,EAAG,MAAM,CAAC;IACvB,SAAS,EAAG,MAAM,CAAC;IACnB,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAe;IACnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAU;IACvC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAS;IAC/C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAU;IAC5C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAU;IAC1C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAS;IACjD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAU;IAC9C,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAS;IAClD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAuB;IAC/C,OAAO,CAAC,qBAAqB,CAAC,CAAqB;IACnD,OAAO,CAAC,WAAW,CAAC,CAAoB;IACxC,OAAO,CAAC,IAAI,CAAC,CAAM;IAEnB;;;;OAIG;gBACS,IAAI,EAAE,kBAAkB,EAAE,GAAG,GAAE,YAAY,GAAG,IAAW;IA0FrE;;;OAGG;IACH,IAAI,iBAAiB,IAAI,OAAO,CAI/B;IAED;;;;OAIG;IACH,IAAI,UAAU,IAAI,UAAU,CAK3B;IAED;;;;;;;OAOG;IACH,IAAI,iBAAiB,IAAI,MAAM,CAE9B;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,MAAM,CAKrB;IAED;;;;;OAKG;IACH,IAAI,GAAG,IAAI,GAAG,CAab;IAED;;;OAGG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED;;;OAGG;IACH,IAAI,YAAY,CAAC,OAAO,EAAE,OAAO,EAEhC;IAED;;;OAGG;IACH,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,EAEnB;IAED;;;OAGG;IACG,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;IAY/C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAO7D;;;;OAIG;IACG,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC;IAOvC;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAiB3B;;;;OAIG;IACG,qBAAqB,CACzB,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC;IAO1C;;;OAGG;IACG,uBAAuB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAO5D;;;;;OAKG;IACG,YAAY,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAyDjD,OAAO,CAAC,qBAAqB;IAoD7B,OAAO,CAAC,YAAY;IAsBpB,OAAO,CAAC,KAAK;IAYb,OAAO,CAAC,WAAW;IAWnB;;;;;;;;;;;;;;;;;;;;OAoBG;YACW,SAAS;YAoDT,sBAAsB;CAkErC"}

package/build/lib/webdriveragent.js

@@ -13,9 +13,9 @@ const no_session_proxy_1 = require("./no-session-proxy");
 const utils_1 = require("./utils");
 const xcodebuild_1 = require("./xcodebuild");
 const async_lock_1 = __importDefault(require("async-lock"));
-const teen_process_1 = require("teen_process");
 const constants_1 = require("./constants");
 const strongbox_1 = require("@appium/strongbox");
+const wda_strategies_1 = require("./wda-strategies");
 const WDA_LAUNCH_TIMEOUT = 60 * 1000;
 const WDA_AGENT_PORT = 8100;
 const SHARED_RESOURCES_GUARD = new async_lock_1.default();
@@ -51,6 +51,8 @@ class WebDriverAgent {
     wdaLaunchTimeout;
     usePreinstalledWDA;
     updatedWDABundleIdSuffix;
+    hostOps;
+    activeStartupStrategy;
     _xcodebuild;
     _url;
     /**
@@ -88,6 +90,21 @@ class WebDriverAgent {
         this.wdaLaunchTimeout = args.wdaLaunchTimeout || WDA_LAUNCH_TIMEOUT;
         this.usePreinstalledWDA = args.usePreinstalledWDA;
         this.updatedWDABundleIdSuffix = args.updatedWDABundleIdSuffix ?? constants_1.DEFAULT_TEST_BUNDLE_SUFFIX;
+        const defaultHostOps = (0, wda_strategies_1.createDefaultWdaHostOps)();
+        this.hostOps = {
+            simulator: {
+                ...defaultHostOps.simulator,
+                ...args.hostOps?.simulator,
+            },
+            realDevicePreinstalled: {
+                ...defaultHostOps.realDevicePreinstalled,
+                ...args.hostOps?.realDevicePreinstalled,
+            },
+            realDeviceXcodebuild: {
+                ...defaultHostOps.realDeviceXcodebuild,
+                ...args.hostOps?.realDeviceXcodebuild,
+            },
+        };
         this._xcodebuild = this.canSkipXcodebuild
             ? null
             : new xcodebuild_1.XcodeBuild(this.device, {
@@ -204,21 +221,15 @@ class WebDriverAgent {
      * that are listening on the same port but belong to different devices.
      */
     async cleanupObsoleteProcesses() {
-        const obsoletePids = await (0, utils_1.getPIDsListeningOnPort)(this.url.port, (cmdLine) => cmdLine.includes('/WebDriverAgentRunner') &&
-            !cmdLine.toLowerCase().includes(this.device.udid.toLowerCase()));
-        if (obsoletePids.length === 0) {
-            this.log.debug(`No obsolete cached processes from previous WDA sessions ` +
-                `listening on port ${this.url.port} have been found`);
-            return;
-        }
-        this.log.info(`Detected ${obsoletePids.length} obsolete cached process${obsoletePids.length === 1 ? '' : 'es'} ` +
-            `from previous WDA sessions. Cleaning them up`);
         try {
-            await (0, teen_process_1.exec)('kill', obsoletePids);
+            await this.hostOps.realDeviceXcodebuild.cleanupObsoleteProcesses?.({
+                udid: this.device.udid,
+                port: this.url.port,
+                commandLineIncludes: '/WebDriverAgentRunner',
+            });
         }
         catch (e) {
-            this.log.warn(`Failed to kill obsolete cached process${obsoletePids.length === 1 ? '' : 'es'} '${obsoletePids}'. ` +
-                `Original error: ${e.message}`);
+            this.log.warn(`Failed to clean obsolete cached processes. Original error: ${e.message}`);
         }
     }
     /**
@@ -246,41 +257,10 @@ class WebDriverAgent {
      * @param sessionId Launch WDA and establish the session with this sessionId
      */
     async launch(sessionId) {
-        if (this.webDriverAgentUrl) {
-            this.log.info(`Using provided WebdriverAgent at '${this.webDriverAgentUrl}'`);
-            this.url = this.webDriverAgentUrl;
-            this.setupProxies(sessionId);
-            return await this.getStatus();
-        }
-        if (this.usePreinstalledWDA) {
-            return await this.launchWithPreinstalledWDA(sessionId);
-        }
-        this.log.info('Launching WebDriverAgent on the device');
-        this.setupProxies(sessionId);
-        if (!this.useXctestrunFile && !(await support_1.fs.exists(this.agentPath))) {
-            throw new Error(`Trying to use WebDriverAgent project at '${this.agentPath}' but the ` +
-                'file does not exist');
-        }
-        // useXctestrunFile and usePrebuiltWDA use existing dependencies
-        // It depends on user side
-        if (this.useXctestrunFile || this.usePrebuiltWDA) {
-            this.log.info('Skipped WDA project cleanup according to the provided capabilities');
-        }
-        else {
-            const synchronizationKey = node_path_1.default.normalize(this.bootstrapPath);
-            await SHARED_RESOURCES_GUARD.acquire(synchronizationKey, async () => await this._cleanupProjectIfFresh());
-        }
-        // We need to provide WDA local port, because it might be occupied
-        await (0, utils_1.resetTestProcesses)(this.device.udid, !this.isRealDevice);
-        if (!this.noSessionProxy) {
-            throw new Error('noSessionProxy is not available');
-        }
-        await this.xcodebuild.init(this.noSessionProxy);
-        // Start the xcodebuild process
-        if (this.prebuildWDA) {
-            await this.xcodebuild.prebuild();
-        }
-        return (await this.xcodebuild.start());
+        const startupStrategy = this.createStartupStrategy();
+        this.log.info(`Selected '${startupStrategy.name}' WebDriverAgent startup strategy`);
+        this.activeStartupStrategy = startupStrategy;
+        return await startupStrategy.launch(sessionId);
     }
     /**
      * Checks if the WebDriverAgent source is fresh by verifying
@@ -296,29 +276,7 @@ class WebDriverAgent {
      * Handles both preinstalled WDA and xcodebuild-based sessions.
      */
     async quit() {
-        if (this.usePreinstalledWDA) {
-            this.log.info('Stopping the XCTest session');
-            try {
-                if (this.device.simctl) {
-                    await this.device.simctl.terminateApp(this.bundleIdForXctest);
-                }
-                else if (this.device.devicectl) {
-                    await this.device.devicectl.terminateApp(this.bundleIdForXctest);
-                }
-            }
-            catch (e) {
-                this.log.warn(e.message);
-            }
-        }
-        else if (!this.args.webDriverAgentUrl) {
-            this.log.info('Shutting down sub-processes');
-            if (this._xcodebuild) {
-                await this.xcodebuild.quit();
-            }
-        }
-        else {
-            this.log.debug('Stopping neither xcodebuild nor XCTest session since WDA lifecycle is not managed by this driver');
-        }
+        await (this.activeStartupStrategy ?? this.createStartupStrategy()).quit();
         if (this.jwproxy) {
             this.jwproxy.sessionId = null;
         }
@@ -328,6 +286,7 @@ class WebDriverAgent {
             // then clean that up. If the url was supplied, we want to keep it
             this.webDriverAgentUrl = undefined;
         }
+        this.activeStartupStrategy = undefined;
     }
     /**
      * Retrieves Xcode build settings.
@@ -395,6 +354,54 @@ class WebDriverAgent {
         this.webDriverAgentUrl = cachedUrl;
         return cachedUrl;
     }
+    createStartupStrategy() {
+        const context = {
+            argsWebDriverAgentUrl: this.args.webDriverAgentUrl,
+            webDriverAgentUrl: this.webDriverAgentUrl,
+            usePreinstalledWDA: this.usePreinstalledWDA,
+            useXctestrunFile: this.useXctestrunFile,
+            usePrebuiltWDA: this.usePrebuiltWDA,
+            prebuildWDA: this.prebuildWDA,
+            isRealDevice: this.isRealDevice,
+            device: this.device,
+            agentPath: this.agentPath,
+            bootstrapPath: this.bootstrapPath,
+            bundleIdForXctest: this.bundleIdForXctest,
+            wdaLocalPort: this.wdaLocalPort,
+            wdaRemotePort: this.wdaRemotePort,
+            wdaBindingIP: this.wdaBindingIP,
+            wdaLaunchTimeout: this.wdaLaunchTimeout,
+            mjpegServerPort: this.mjpegServerPort,
+            maxHttpRequestBodySize: this.maxHttpRequestBodySize,
+            platformName: this.platformName,
+            platformVersion: this.platformVersion,
+            log: this.log,
+            hostOps: this.hostOps,
+            setWebDriverAgentUrl: (value) => {
+                this.webDriverAgentUrl = value;
+            },
+            setUrl: (value) => {
+                this.url = value;
+            },
+            setupProxies: (sessionId) => this.setupProxies(sessionId),
+            getStatus: async (timeoutMs) => await this.getStatus(timeoutMs),
+            cleanupProjectIfFresh: async () => {
+                const synchronizationKey = node_path_1.default.normalize(this.bootstrapPath);
+                await SHARED_RESOURCES_GUARD.acquire(synchronizationKey, async () => await this._cleanupProjectIfFresh());
+            },
+            xcodebuild: () => this.xcodebuild,
+            noSessionProxy: () => {
+                if (!this.noSessionProxy) {
+                    throw new Error('noSessionProxy is not available');
+                }
+                return this.noSessionProxy;
+            },
+            setStarted: (started) => {
+                this.started = started;
+            },
+        };
+        return (0, wda_strategies_1.createWdaStartupStrategy)(context);
+    }
     setupProxies(sessionId) {
         const proxyOpts = {
             log: this.log,
@@ -556,62 +563,6 @@ class WebDriverAgent {
             this.log.warn(`Cannot perform WebDriverAgent project cleanup. Original error: ${e.message}`);
         }
     }
-    /**
-     * Launch WDA with preinstalled package with 'xcrun devicectl device process launch'.
-     * The WDA package must be prepared properly like published via
-     * https://github.com/appium/WebDriverAgent/releases
-     * with proper sign for this case.
-     *
-     * @param opts launching WDA with devicectl command options.
-     */
-    async _launchViaDevicectl(opts = {}) {
-        const { env } = opts;
-        await this.device.devicectl.launchApp(this.bundleIdForXctest, {
-            env,
-            terminateExisting: true,
-        });
-    }
-    /**
-     * Launch WDA with preinstalled package without xcodebuild.
-     * @param sessionId Launch WDA and establish the session with this sessionId
-     */
-    async launchWithPreinstalledWDA(sessionId) {
-        const xctestEnv = {
-            USE_PORT: this.wdaLocalPort || WDA_AGENT_PORT,
-            WDA_PRODUCT_BUNDLE_IDENTIFIER: this.bundleIdForXctest,
-        };
-        if (this.mjpegServerPort) {
-            xctestEnv.MJPEG_SERVER_PORT = this.mjpegServerPort;
-        }
-        if (this.wdaBindingIP) {
-            xctestEnv.USE_IP = this.wdaBindingIP;
-        }
-        if (this.maxHttpRequestBodySize) {
-            xctestEnv.MAX_HTTP_REQUEST_BODY_SIZE = this.maxHttpRequestBodySize;
-        }
-        this.log.info('Launching WebDriverAgent on the device without xcodebuild');
-        if (this.isRealDevice) {
-            await this._launchViaDevicectl({ env: xctestEnv });
-        }
-        else {
-            await this.device.simctl.exec('launch', {
-                args: ['--terminate-running-process', this.device.udid, this.bundleIdForXctest],
-                env: xctestEnv,
-            });
-        }
-        this.setupProxies(sessionId);
-        let status;
-        try {
-            status = await this.getStatus(this.wdaLaunchTimeout);
-        }
-        catch {
-            throw new Error(`Failed to start the preinstalled WebDriverAgent in ${this.wdaLaunchTimeout} ms. ` +
-                `The WebDriverAgent might not be properly built or the device might be locked. ` +
-                `The 'appium:wdaLaunchTimeout' capability modifies the timeout.`);
-        }
-        this.started = true;
-        return status;
-    }
 }
 exports.WebDriverAgent = WebDriverAgent;
 //# sourceMappingURL=webdriveragent.js.map