appium-chromedriver 8.2.28 → 8.2.29

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [8.2.29](https://github.com/appium/appium-chromedriver/compare/v8.2.28...v8.2.29) (2026-04-24)
+
+### Miscellaneous Chores
+
+* ChromeDriver Bump to v148.0.7778.56 ([#568](https://github.com/appium/appium-chromedriver/issues/568)) ([84b1bb0](https://github.com/appium/appium-chromedriver/commit/84b1bb012ad16c99d40c8d3c2a971298b0fec9e8))
+
+### Code Refactoring
+
+* Decompose Chromedriver internals ([#565](https://github.com/appium/appium-chromedriver/issues/565)) ([209efa8](https://github.com/appium/appium-chromedriver/commit/209efa82b03d697fd1e81cc4e80238dde7f1de00))
+
 ## [8.2.28](https://github.com/appium/appium-chromedriver/compare/v8.2.27...v8.2.28) (2026-04-23)
 
 ### Miscellaneous Chores

package/build/lib/chromedriver.d.ts

@@ -1,114 +1,117 @@
 import events from 'node:events';
-import { JWProxy } from '@appium/base-driver';
+import { JWProxy, PROTOCOLS } from '@appium/base-driver';
+import { SubProcess, exec } from 'teen_process';
+import { ChromedriverStorageClient } from './storage-client/storage-client';
+import { CHROMEDRIVER_EVENTS, CHROMEDRIVER_STATES } from './constants';
+import type { ADB } from 'appium-adb';
 import type { HTTPMethod, HTTPBody } from '@appium/types';
 import type { Request, Response } from 'express';
 import type { ChromedriverOpts } from './types';
 type SessionCapabilities = Record<string, any>;
-export declare class Chromedriver extends events.EventEmitter {
-    static readonly EVENT_ERROR = "chromedriver_error";
-    static readonly EVENT_CHANGED = "stateChanged";
-    static readonly STATE_STOPPED = "stopped";
-    static readonly STATE_STARTING = "starting";
-    static readonly STATE_ONLINE = "online";
-    static readonly STATE_STOPPING = "stopping";
-    static readonly STATE_RESTARTING = "restarting";
+type ChromedriverState = (typeof CHROMEDRIVER_STATES)[keyof typeof CHROMEDRIVER_STATES];
+type ChromedriverEventMap = {
+    [CHROMEDRIVER_EVENTS.ERROR]: [Error];
+    [CHROMEDRIVER_EVENTS.CHANGED]: [{
+        state: ChromedriverState;
+    }];
+};
+export declare class Chromedriver extends events.EventEmitter<ChromedriverEventMap> {
+    static readonly EVENT_ERROR: "chromedriver_error";
+    static readonly EVENT_CHANGED: "stateChanged";
+    static readonly STATE_STOPPED: "stopped";
+    static readonly STATE_STARTING: "starting";
+    static readonly STATE_ONLINE: "online";
+    static readonly STATE_STOPPING: "stopping";
+    static readonly STATE_RESTARTING: "restarting";
     private readonly _log;
     private readonly proxyHost;
-    private readonly proxyPort;
-    private readonly adb?;
-    private readonly cmdArgs?;
-    private proc;
-    private readonly useSystemExecutable;
-    private chromedriver?;
-    private readonly executableDir;
-    private readonly mappingPath?;
-    private bundleId?;
-    private executableVerified;
+    readonly proxyPort: number;
+    readonly adb?: ADB;
+    readonly cmdArgs?: string[];
+    proc: SubProcess | null;
+    readonly useSystemExecutable: boolean;
+    chromedriver?: string;
+    readonly executableDir: string;
+    readonly mappingPath?: string;
+    bundleId?: string;
+    executableVerified: boolean;
     state: string;
-    private readonly _execFunc;
+    _execFunc: typeof exec;
     jwproxy: JWProxy;
-    private readonly isCustomExecutableDir;
-    private readonly verbose?;
-    private readonly logPath?;
-    private readonly disableBuildCheck;
-    private readonly storageClient;
-    private readonly details?;
-    private capabilities;
-    private _desiredProtocol;
-    private _driverVersion;
-    private _onlineStatus;
+    readonly isCustomExecutableDir: boolean;
+    readonly verbose?: boolean;
+    readonly logPath?: string;
+    readonly disableBuildCheck: boolean;
+    readonly storageClient: ChromedriverStorageClient | null;
+    readonly details?: ChromedriverOpts['details'];
+    capabilities: SessionCapabilities;
+    _desiredProtocol: keyof typeof PROTOCOLS | null;
+    _driverVersion: string | null;
+    _onlineStatus: Record<string, any> | null;
     constructor(args?: ChromedriverOpts);
-    /**
-     * Gets the logger instance for this Chromedriver instance.
-     * @returns The logger instance.
-     */
     get log(): any;
-    /**
-     * Gets the version of the currently running Chromedriver.
-     * @returns The driver version string, or null if not yet determined.
-     */
     get driverVersion(): string | null;
     /**
      * Starts a new Chromedriver session with the given capabilities.
-     * @param caps - The session capabilities to use.
-     * @param emitStartingState - Whether to emit the starting state event (default: true).
-     * @returns A promise that resolves to the session capabilities returned by Chromedriver.
-     * @throws {Error} If Chromedriver fails to start or crashes during startup.
+     *
+     * @param caps - Capabilities passed to Chromedriver session creation.
+     * @param emitStartingState - Whether to emit the `starting` state transition.
+     * @returns Session capabilities returned by Chromedriver.
      */
     start(caps: SessionCapabilities, emitStartingState?: boolean): Promise<SessionCapabilities>;
     /**
-     * Gets the current session ID if the driver is online.
-     * @returns The session ID string, or null if the driver is not online.
+     * Gets active Chromedriver session id if the driver is online.
+     *
+     * @returns The session id or `null` when driver is not online.
      */
     sessionId(): string | null;
     /**
-     * Restarts the Chromedriver session.
-     * The session will be stopped and then started again with the same capabilities.
-     * @returns A promise that resolves to the session capabilities returned by Chromedriver.
-     * @throws {Error} If the driver is not online or if restart fails.
+     * Restarts current Chromedriver session with previously stored capabilities.
+     *
+     * @returns Session capabilities returned by the restarted session.
      */
     restart(): Promise<SessionCapabilities>;
     /**
-     * Stops the Chromedriver session and terminates the process.
-     * @param emitStates - Whether to emit state change events during shutdown (default: true).
-     * @returns A promise that resolves when the session has been stopped.
+     * Stops the current Chromedriver session and underlying subprocess.
+     *
+     * @param emitStates - Whether to emit stopping/stopped state transitions.
      */
     stop(emitStates?: boolean): Promise<void>;
     /**
-     * Sends a command to the Chromedriver server.
-     * @param url - The endpoint URL (e.g., '/url', '/session').
-     * @param method - The HTTP method to use ('POST', 'GET', or 'DELETE').
-     * @param body - Optional request body for POST requests.
-     * @returns A promise that resolves to the response from Chromedriver.
+     * Sends a direct command to Chromedriver through the JSONWP/W3C proxy.
+     *
+     * @param url - Chromedriver endpoint path.
+     * @param method - HTTP method used for the command.
+     * @param body - Optional request payload.
+     * @returns Command response payload.
      */
     sendCommand(url: string, method: HTTPMethod, body?: HTTPBody): Promise<HTTPBody>;
     /**
-     * Proxies an HTTP request/response to the Chromedriver server.
-     * @param req - The incoming HTTP request object.
-     * @param res - The outgoing HTTP response object.
-     * @returns A promise that resolves when the proxying is complete.
+     * Proxies an incoming Express request/response pair to Chromedriver.
+     *
+     * @param req - Incoming request object.
+     * @param res - Outgoing response object.
      */
     proxyReq(req: Request, res: Response): Promise<void>;
     /**
-     * Checks if Chromedriver is currently able to automate webviews.
-     * Sometimes Chromedriver stops automating webviews; this method runs a simple
-     * command to determine the current state.
-     * @returns A promise that resolves to true if webviews are working, false otherwise.
+     * Checks whether the active webview connection is currently responsive.
+     *
+     * @returns `true` if `/url` command succeeds, otherwise `false`.
      */
     hasWorkingWebview(): Promise<boolean>;
     private buildChromedriverArgs;
     private getDriversMapping;
     private getChromedrivers;
-    private getChromeVersion;
     private updateDriversMapping;
     private getCompatibleChromedriver;
     private initChromedriverPath;
+    private getChromeVersion;
     private syncProtocol;
     private waitForOnline;
     private getStatus;
-    private startSession;
-    private changeState;
     private killAll;
+    private changeState;
+    private startSession;
 }
 export {};
 //# sourceMappingURL=chromedriver.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"chromedriver.d.ts","sourceRoot":"","sources":["../../lib/chromedriver.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAC,OAAO,EAAY,MAAM,qBAAqB,CAAC;AAoBvD,OAAO,KAAK,EAAe,UAAU,EAAE,QAAQ,EAAC,MAAM,eAAe,CAAC;AACtE,OAAO,KAAK,EAAC,OAAO,EAAE,QAAQ,EAAC,MAAM,SAAS,CAAC;AAC/C,OAAO,KAAK,EAAC,gBAAgB,EAA6B,MAAM,SAAS,CAAC;AAwB1E,KAAK,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE/C,qBAAa,YAAa,SAAQ,MAAM,CAAC,YAAY;IACnD,MAAM,CAAC,QAAQ,CAAC,WAAW,wBAAwB;IACnD,MAAM,CAAC,QAAQ,CAAC,aAAa,kBAAkB;IAC/C,MAAM,CAAC,QAAQ,CAAC,aAAa,aAAa;IAC1C,MAAM,CAAC,QAAQ,CAAC,cAAc,cAAc;IAC5C,MAAM,CAAC,QAAQ,CAAC,YAAY,YAAY;IACxC,MAAM,CAAC,QAAQ,CAAC,cAAc,cAAc;IAC5C,MAAM,CAAC,QAAQ,CAAC,gBAAgB,gBAAgB;IAEhD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAM;IAC3B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAM;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAW;IACpC,OAAO,CAAC,IAAI,CAAoB;IAChC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAU;IAC9C,OAAO,CAAC,YAAY,CAAC,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,kBAAkB,CAAU;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAc;IACxC,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAU;IAChD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAU;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAU;IAC5C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAmC;IACjE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAA8B;IACvD,OAAO,CAAC,YAAY,CAAsB;IAC1C,OAAO,CAAC,gBAAgB,CAAgC;IACxD,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,aAAa,CAA6B;gBAEtC,IAAI,GAAE,gBAAqB;IAsEvC;;;OAGG;IACH,IAAI,GAAG,QAEN;IAED;;;OAGG;IACH,IAAI,aAAa,IAAI,MAAM,GAAG,IAAI,CAEjC;IAED;;;;;;OAMG;IACG,KAAK,CAAC,IAAI,EAAE,mBAAmB,EAAE,iBAAiB,UAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAgH9F;;;OAGG;IACH,SAAS,IAAI,MAAM,GAAG,IAAI;IAI1B;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAU7C;;;;OAIG;IACG,IAAI,CAAC,UAAU,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAyB5C;;;;;;OAMG;IACG,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,GAAE,QAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI5F;;;;;OAKG;IACG,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1D;;;;;OAKG;IACG,iBAAiB,IAAI,OAAO,CAAC,OAAO,CAAC;IAW3C,OAAO,CAAC,qBAAqB;YAkBf,iBAAiB;YAgCjB,gBAAgB;YAmGhB,gBAAgB;YAqEhB,oBAAoB;YAuBpB,yBAAyB;YA+IzB,oBAAoB;IA0BlC,OAAO,CAAC,YAAY;YAoCN,aAAa;YA2Bb,SAAS;YAIT,YAAY;IAqB1B,OAAO,CAAC,WAAW;YAML,OAAO;CAwCtB"}
+{"version":3,"file":"chromedriver.d.ts","sourceRoot":"","sources":["../../lib/chromedriver.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAC,OAAO,EAAE,SAAS,EAAC,MAAM,qBAAqB,CAAC;AAEvD,OAAO,EAAC,UAAU,EAAE,IAAI,EAAC,MAAM,cAAc,CAAC;AAG9C,OAAO,EAAC,yBAAyB,EAAC,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAC,mBAAmB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAWrE,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,EAAe,UAAU,EAAE,QAAQ,EAAC,MAAM,eAAe,CAAC;AACtE,OAAO,KAAK,EAAC,OAAO,EAAE,QAAQ,EAAC,MAAM,SAAS,CAAC;AAC/C,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,SAAS,CAAC;AAI9C,KAAK,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC/C,KAAK,iBAAiB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AACxF,KAAK,oBAAoB,GAAG;IAC1B,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;QAAC,KAAK,EAAE,iBAAiB,CAAA;KAAC,CAAC,CAAC;CAC7D,CAAC;AAEF,qBAAa,YAAa,SAAQ,MAAM,CAAC,YAAY,CAAC,oBAAoB,CAAC;IACzE,MAAM,CAAC,QAAQ,CAAC,WAAW,uBAA6B;IACxD,MAAM,CAAC,QAAQ,CAAC,aAAa,iBAA+B;IAC5D,MAAM,CAAC,QAAQ,CAAC,aAAa,YAA+B;IAC5D,MAAM,CAAC,QAAQ,CAAC,cAAc,aAAgC;IAC9D,MAAM,CAAC,QAAQ,CAAC,YAAY,WAA8B;IAC1D,MAAM,CAAC,QAAQ,CAAC,cAAc,aAAgC;IAC9D,MAAM,CAAC,QAAQ,CAAC,gBAAgB,eAAkC;IAElE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAM;IAC3B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC;IACnB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,IAAI,EAAE,UAAU,GAAG,IAAI,CAAC;IACxB,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,OAAO,IAAI,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,qBAAqB,EAAE,OAAO,CAAC;IACxC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACpC,QAAQ,CAAC,aAAa,EAAE,yBAAyB,GAAG,IAAI,CAAC;IACzD,QAAQ,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC/C,YAAY,EAAE,mBAAmB,CAAC;IAClC,gBAAgB,EAAE,MAAM,OAAO,SAAS,GAAG,IAAI,CAAC;IAChD,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;gBAE9B,IAAI,GAAE,gBAAqB;IA0DvC,IAAI,GAAG,QAEN;IAED,IAAI,aAAa,IAAI,MAAM,GAAG,IAAI,CAEjC;IAED;;;;;;OAMG;IACG,KAAK,CAAC,IAAI,EAAE,mBAAmB,EAAE,iBAAiB,UAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA8F9F;;;;OAIG;IACH,SAAS,IAAI,MAAM,GAAG,IAAI;IAI1B;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAU7C;;;;OAIG;IACG,IAAI,CAAC,UAAU,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAyB5C;;;;;;;OAOG;IACG,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,GAAE,QAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI5F;;;;;OAKG;IACG,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1D;;;;OAIG;IACG,iBAAiB,IAAI,OAAO,CAAC,OAAO,CAAC;IAS3C,OAAO,CAAC,qBAAqB,CAAyB;IACtD,OAAO,CAAC,iBAAiB,CAAqB;IAC9C,OAAO,CAAC,gBAAgB,CAAoB;IAC5C,OAAO,CAAC,oBAAoB,CAAwB;IACpD,OAAO,CAAC,yBAAyB,CAA6B;IAC9D,OAAO,CAAC,oBAAoB,CAAwB;IACpD,OAAO,CAAC,gBAAgB,CAAoC;IAC5D,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,aAAa,CAAiB;IACtC,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,OAAO,CAAW;IAC1B,OAAO,CAAC,WAAW,CAAe;YAEpB,YAAY;CAG3B"}