appium-chromedriver 5.5.3 → 5.6.0

package/build/lib/storage-client/googleapis.js

@@ -0,0 +1,188 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseGoogleapiStorageXml = exports.parseNotes = exports.findChildNode = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const xpath_1 = __importDefault(require("xpath"));
+const support_1 = require("@appium/support");
+const utils_1 = require("../utils");
+const bluebird_1 = __importDefault(require("bluebird"));
+const constants_1 = require("../constants");
+const xmldom_1 = require("@xmldom/xmldom");
+const path_1 = __importDefault(require("path"));
+const log = support_1.logger.getLogger('ChromedriverGoogleapisStorageClient');
+const MAX_PARALLEL_DOWNLOADS = 5;
+/**
+ *
+ * @param {Node|Attr} parent
+ * @param {string?} childName
+ * @param {string?} text
+ * @returns
+ */
+function findChildNode(parent, childName = null, text = null) {
+    if (!childName && !text) {
+        return null;
+    }
+    if (!parent.hasChildNodes()) {
+        return null;
+    }
+    for (let childNodeIdx = 0; childNodeIdx < parent.childNodes.length; childNodeIdx++) {
+        const childNode = /** @type {Element|Attr} */ (parent.childNodes[childNodeIdx]);
+        if (childName && !text && childName === childNode.localName) {
+            return childNode;
+        }
+        if (text) {
+            const childText = extractNodeText(childNode);
+            if (!childText) {
+                continue;
+            }
+            if (childName && childName === childNode.localName && text === childText) {
+                return childNode;
+            }
+            if (!childName && text === childText) {
+                return childNode;
+            }
+        }
+    }
+    return null;
+}
+exports.findChildNode = findChildNode;
+/**
+ *
+ * @param {Node?} node
+ * @returns
+ */
+function extractNodeText(node) {
+    return !node || !node.firstChild || !support_1.util.hasValue(node.firstChild.nodeValue)
+        ? null
+        : node.firstChild.nodeValue;
+}
+/**
+ * Gets additional chromedriver details from chromedriver
+ * release notes
+ *
+ * @param {string} content - Release notes of the corresponding chromedriver
+ * @returns {import('../types').AdditionalDriverDetails}
+ */
+function parseNotes(content) {
+    const result = {};
+    const versionMatch = /^\s*[-]+ChromeDriver[\D]+([\d.]+)/im.exec(content);
+    if (versionMatch) {
+        result.version = versionMatch[1];
+    }
+    const minBrowserVersionMatch = /^\s*Supports Chrome[\D]+(\d+)/im.exec(content);
+    if (minBrowserVersionMatch) {
+        result.minBrowserVersion = minBrowserVersionMatch[1];
+    }
+    return result;
+}
+exports.parseNotes = parseNotes;
+/**
+ * Parses chromedriver storage XML and returns
+ * the parsed results
+ *
+ * @param {string} xml - The chromedriver storage XML
+ * @param {boolean} shouldParseNotes [true] - If set to `true`
+ * then additional drivers information is going to be parsed
+ * and assigned to `this.mapping`
+ * @returns {Promise<ChromedriverDetailsMapping>}
+ */
+async function parseGoogleapiStorageXml(xml, shouldParseNotes = true) {
+    const doc = new xmldom_1.DOMParser().parseFromString(xml);
+    const driverNodes = /** @type {Array<Node|Attr>} */ (xpath_1.default.select(`//*[local-name(.)='Contents']`, doc));
+    log.debug(`Parsed ${driverNodes.length} entries from storage XML`);
+    if (lodash_1.default.isEmpty(driverNodes)) {
+        throw new Error('Cannot retrieve any valid Chromedriver entries from the storage config');
+    }
+    const promises = [];
+    const chunk = [];
+    /** @type {ChromedriverDetailsMapping} */
+    const mapping = {};
+    for (const driverNode of driverNodes) {
+        const k = extractNodeText(findChildNode(driverNode, 'Key'));
+        if (!lodash_1.default.includes(k, '/chromedriver_')) {
+            continue;
+        }
+        const key = String(k);
+        const etag = extractNodeText(findChildNode(driverNode, 'ETag'));
+        if (!etag) {
+            log.debug(`The entry '${key}' does not contain the checksum. Skipping it`);
+            continue;
+        }
+        const filename = path_1.default.basename(key);
+        const osNameMatch = /_([a-z]+)/i.exec(filename);
+        if (!osNameMatch) {
+            log.debug(`The entry '${key}' does not contain valid OS name. Skipping it`);
+            continue;
+        }
+        /** @type {ChromedriverDetails} */
+        const cdInfo = {
+            url: `${constants_1.GOOGLEAPIS_CDN}/${key}`,
+            etag: lodash_1.default.trim(etag, '"'),
+            version: /** @type {string} */ (lodash_1.default.first(key.split('/'))),
+            minBrowserVersion: null,
+            os: {
+                name: osNameMatch[1],
+                arch: filename.includes(constants_1.ARCH.X64) ? constants_1.ARCH.X64 : constants_1.ARCH.X86,
+                cpu: constants_1.APPLE_ARM_SUFFIXES.some((suffix) => filename.includes(suffix)) ? constants_1.CPU.ARM : constants_1.CPU.INTEL,
+            }
+        };
+        mapping[key] = cdInfo;
+        const notesPath = `${cdInfo.version}/notes.txt`;
+        const isNotesPresent = !!driverNodes.reduce((acc, node) => Boolean(acc || findChildNode(node, 'Key', notesPath)), false);
+        if (!isNotesPresent) {
+            cdInfo.minBrowserVersion = null;
+            if (shouldParseNotes) {
+                log.info(`The entry '${key}' does not contain any notes. Skipping it`);
+            }
+            continue;
+        }
+        else if (!shouldParseNotes) {
+            continue;
+        }
+        const promise = bluebird_1.default.resolve(retrieveAdditionalDriverInfo(key, `${constants_1.GOOGLEAPIS_CDN}/${notesPath}`, cdInfo));
+        promises.push(promise);
+        chunk.push(promise);
+        if (chunk.length >= MAX_PARALLEL_DOWNLOADS) {
+            await bluebird_1.default.any(chunk);
+        }
+        lodash_1.default.remove(chunk, (p) => p.isFulfilled());
+    }
+    await bluebird_1.default.all(promises);
+    log.info(`The total count of entries in the mapping: ${lodash_1.default.size(mapping)}`);
+    return mapping;
+}
+exports.parseGoogleapiStorageXml = parseGoogleapiStorageXml;
+/**
+ * Downloads chromedriver release notes and puts them
+ * into the dictionary argument
+ *
+ * The method call mutates by merging `AdditionalDriverDetails`
+ * @param {string} driverKey - Driver version plus archive name
+ * @param {string} notesUrl - The URL of chromedriver notes
+ * @param {ChromedriverDetails} infoDict - The dictionary containing driver info.
+ * @param {number} timeout
+ * @throws {Error} if the release notes cannot be downloaded
+ */
+async function retrieveAdditionalDriverInfo(driverKey, notesUrl, infoDict, timeout = constants_1.STORAGE_REQ_TIMEOUT_MS) {
+    const notes = await (0, utils_1.retrieveData)(notesUrl, {
+        'user-agent': 'appium',
+        accept: '*/*',
+    }, { timeout });
+    const { minBrowserVersion } = parseNotes(notes);
+    if (!minBrowserVersion) {
+        log.debug(`The driver '${driverKey}' does not contain valid release notes at ${notesUrl}. ` +
+            `Skipping it`);
+        return;
+    }
+    infoDict.minBrowserVersion = minBrowserVersion;
+}
+/**
+ * @typedef {import('../types').SyncOptions} SyncOptions
+ * @typedef {import('../types').OSInfo} OSInfo
+ * @typedef {import('../types').ChromedriverDetails} ChromedriverDetails
+ * @typedef {import('../types').ChromedriverDetailsMapping} ChromedriverDetailsMapping
+ */
+//# sourceMappingURL=googleapis.js.map

package/build/lib/storage-client/googleapis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"googleapis.js","sourceRoot":"","sources":["../../../lib/storage-client/googleapis.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,kDAA0B;AAC1B,6CAA6C;AAC7C,oCAAsC;AACtC,wDAAyB;AACzB,4CAMsB;AACtB,2CAAyC;AACzC,gDAAwB;AAGxB,MAAM,GAAG,GAAG,gBAAM,CAAC,SAAS,CAAC,qCAAqC,CAAC,CAAC;AACpE,MAAM,sBAAsB,GAAG,CAAC,CAAC;AAEjC;;;;;;GAMG;AACH,SAAgB,aAAa,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,IAAI,GAAG,IAAI;IACjE,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,EAAE;QACvB,OAAO,IAAI,CAAC;KACb;IACD,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,EAAE;QAC3B,OAAO,IAAI,CAAC;KACb;IAED,KAAK,IAAI,YAAY,GAAG,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE;QAClF,MAAM,SAAS,GAAG,2BAA2B,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;QAChF,IAAI,SAAS,IAAI,CAAC,IAAI,IAAI,SAAS,KAAK,SAAS,CAAC,SAAS,EAAE;YAC3D,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,IAAI,EAAE;YACR,MAAM,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;YAC7C,IAAI,CAAC,SAAS,EAAE;gBACd,SAAS;aACV;YACD,IAAI,SAAS,IAAI,SAAS,KAAK,SAAS,CAAC,SAAS,IAAI,IAAI,KAAK,SAAS,EAAE;gBACxE,OAAO,SAAS,CAAC;aAClB;YACD,IAAI,CAAC,SAAS,IAAI,IAAI,KAAK,SAAS,EAAE;gBACpC,OAAO,SAAS,CAAC;aAClB;SACF;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AA3BD,sCA2BC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,IAAI;IAC3B,OAAO,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QAC3E,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;AAChC,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,OAAO;IAChC,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,MAAM,YAAY,GAAG,qCAAqC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACzE,IAAI,YAAY,EAAE;QAChB,MAAM,CAAC,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;KAClC;IACD,MAAM,sBAAsB,GAAG,iCAAiC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/E,IAAI,sBAAsB,EAAE;QAC1B,MAAM,CAAC,iBAAiB,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;KACtD;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAXD,gCAWC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,wBAAwB,CAAC,GAAG,EAAE,gBAAgB,GAAG,IAAI;IACzE,MAAM,GAAG,GAAG,IAAI,kBAAS,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IACjD,MAAM,WAAW,GAAG,+BAA+B,CAAC,CAClD,eAAK,CAAC,MAAM,CAAC,+BAA+B,EAAE,GAAG,CAAC,CACnD,CAAC;IACF,GAAG,CAAC,KAAK,CAAC,UAAU,WAAW,CAAC,MAAM,2BAA2B,CAAC,CAAC;IACnE,IAAI,gBAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QAC1B,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;KAC3F;IAED,MAAM,QAAQ,GAAG,EAAE,CAAC;IACpB,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,yCAAyC;IACzC,MAAM,OAAO,GAAG,EAAE,CAAC;IACnB,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QACpC,MAAM,CAAC,GAAG,eAAe,CAAC,aAAa,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,gBAAgB,CAAC,EAAE;YACpC,SAAS;SACV;QACD,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAEtB,MAAM,IAAI,GAAG,eAAe,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;QAChE,IAAI,CAAC,IAAI,EAAE;YACT,GAAG,CAAC,KAAK,CAAC,cAAc,GAAG,8CAA8C,CAAC,CAAC;YAC3E,SAAS;SACV;QAED,MAAM,QAAQ,GAAG,cAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,WAAW,GAAG,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,WAAW,EAAE;YAChB,GAAG,CAAC,KAAK,CAAC,cAAc,GAAG,+CAA+C,CAAC,CAAC;YAC5E,SAAS;SACV;QAED,kCAAkC;QAClC,MAAM,MAAM,GAAG;YACb,GAAG,EAAE,GAAG,0BAAc,IAAI,GAAG,EAAE;YAC/B,IAAI,EAAE,gBAAC,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC;YACvB,OAAO,EAAE,qBAAqB,CAAC,CAAC,gBAAC,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;YACxD,iBAAiB,EAAE,IAAI;YACvB,EAAE,EAAE;gBACF,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;gBACpB,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,gBAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,gBAAI,CAAC,GAAG,CAAC,CAAC,CAAC,gBAAI,CAAC,GAAG;gBACvD,GAAG,EAAE,8BAAkB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,eAAG,CAAC,GAAG,CAAC,CAAC,CAAC,eAAG,CAAC,KAAK;aAC1F;SACF,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;QAEtB,MAAM,SAAS,GAAG,GAAG,MAAM,CAAC,OAAO,YAAY,CAAC;QAChD,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC,MAAM,CACzC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,EACpE,KAAK,CACN,CAAC;QACF,IAAI,CAAC,cAAc,EAAE;YACnB,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAC;YAChC,IAAI,gBAAgB,EAAE;gBACpB,GAAG,CAAC,IAAI,CAAC,cAAc,GAAG,2CAA2C,CAAC,CAAC;aACxE;YACD,SAAS;SACV;aAAM,IAAI,CAAC,gBAAgB,EAAE;YAC5B,SAAS;SACV;QAED,MAAM,OAAO,GAAG,kBAAC,CAAC,OAAO,CAAC,4BAA4B,CAAC,GAAG,EAAE,GAAG,0BAAc,IAAI,SAAS,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;QACvG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpB,IAAI,KAAK,CAAC,MAAM,IAAI,sBAAsB,EAAE;YAC1C,MAAM,kBAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;SACpB;QACD,gBAAC,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;KACzC;IACD,MAAM,kBAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACtB,GAAG,CAAC,IAAI,CAAC,8CAA8C,gBAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC1E,OAAO,OAAO,CAAC;AACjB,CAAC;AA1ED,4DA0EC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,4BAA4B,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,GAAG,kCAAsB;IACzG,MAAM,KAAK,GAAG,MAAM,IAAA,oBAAY,EAC9B,QAAQ,EACR;QACE,YAAY,EAAE,QAAQ;QACtB,MAAM,EAAE,KAAK;KACd,EACD,EAAC,OAAO,EAAC,CACV,CAAC;IACF,MAAM,EAAC,iBAAiB,EAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IAC9C,IAAI,CAAC,iBAAiB,EAAE;QACtB,GAAG,CAAC,KAAK,CACP,eAAe,SAAS,6CAA6C,QAAQ,IAAI;YAC/E,aAAa,CAChB,CAAC;QACF,OAAO;KACR;IACD,QAAQ,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AACjD,CAAC;AAED;;;;;GAKG"}

package/build/lib/{storage-client.d.ts → storage-client/storage-client.d.ts}

@@ -1,43 +1,13 @@
 export class ChromedriverStorageClient {
     /**
      *
-     * @param {import('./types').ChromedriverStorageClientOpts} args
+     * @param {import('../types').ChromedriverStorageClientOpts} args
      */
-    constructor(args?: import('./types').ChromedriverStorageClientOpts);
+    constructor(args?: import('../types').ChromedriverStorageClientOpts);
     chromedriverDir: string;
     timeout: number;
     /** @type {ChromedriverDetailsMapping} */
     mapping: ChromedriverDetailsMapping;
-    /**
-     * Gets additional chromedriver details from chromedriver
-     * release notes
-     *
-     * @param {string} content - Release notes of the corresponding chromedriver
-     * @returns {import('./types').AdditionalDriverDetails}
-     */
-    parseNotes(content: string): import('./types').AdditionalDriverDetails;
-    /**
-     * Downloads chromedriver release notes and puts them
-     * into the dictionary argument
-     *
-     * The method call mutates by merging `AdditionalDriverDetails`
-     * @param {string} driverKey - Driver version plus archive name
-     * @param {string} notesUrl - The URL of chromedriver notes
-     * @param {ChromedriverDetails} infoDict - The dictionary containing driver info.
-     * @throws {Error} if the release notes cannot be downloaded
-     */
-    retrieveAdditionalDriverInfo(driverKey: string, notesUrl: string, infoDict: ChromedriverDetails): Promise<void>;
-    /**
-     * Parses chromedriver storage XML and stores
-     * the parsed results into `this.mapping`
-     *
-     * @param {Document} doc - The DOM representation
-     * of the chromedriver storage XML
-     * @param {boolean} shouldParseNotes [true] - If set to `true`
-     * then additional drivers information is going to be parsed
-     * and assigned to `this.mapping`
-     */
-    parseStorageXml(doc: Document, shouldParseNotes?: boolean): Promise<void>;
     /**
      * Retrieves chromedriver mapping from the storage
      *
@@ -66,6 +36,14 @@ export class ChromedriverStorageClient {
      * entry names (version/archive name)
      */
     selectMatchingDrivers(osInfo: OSInfo, opts?: SyncOptions): Array<string>;
+    /**
+     * Checks whether the given chromedriver matches the operating system to run on
+     *
+     * @param {string} cdName
+     * @param {OSInfo} osInfo
+     * @returns {boolean}
+     */
+    doesMatchForOsInfo(cdName: string, { name, arch, cpu }: OSInfo): boolean;
     /**
      * Retrieves the given chromedriver from the storage
      * and unpacks it into `this.chromedriverDir` folder
@@ -94,8 +72,8 @@ export class ChromedriverStorageClient {
     syncDrivers(opts?: SyncOptions): Promise<string[]>;
 }
 export default ChromedriverStorageClient;
-export type SyncOptions = import('./types').SyncOptions;
-export type OSInfo = import('./types').OSInfo;
-export type ChromedriverDetails = import('./types').ChromedriverDetails;
-export type ChromedriverDetailsMapping = import('./types').ChromedriverDetailsMapping;
+export type SyncOptions = import('../types').SyncOptions;
+export type OSInfo = import('../types').OSInfo;
+export type ChromedriverDetails = import('../types').ChromedriverDetails;
+export type ChromedriverDetailsMapping = import('../types').ChromedriverDetailsMapping;
 //# sourceMappingURL=storage-client.d.ts.map

package/build/lib/storage-client/storage-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-client.d.ts","sourceRoot":"","sources":["../../../lib/storage-client/storage-client.js"],"names":[],"mappings":"AAwCA;IACE;;;OAGG;IACH,mBAFW,OAAO,UAAU,EAAE,6BAA6B,EAQ1D;IAJC,wBAAsC;IACtC,gBAAsB;IACtB,yCAAyC;IACzC,SADW,0BAA0B,CACpB;IAGnB;;;;;;;OAOG;IACH,mCALW,OAAO,GAGL,QAAQ,0BAA0B,CAAC,CAiB/C;IAED;;;;;;OAMG;IACH,iBAHW,MAAM,OACN,MAAM,iBAwBhB;IAED;;;;;;;;;OASG;IACH,8BALW,MAAM,SACN,WAAW,GACT,aAAa,CAyHzB;IAED;;;;;;OAMG;IACH,2BAJW,MAAM,uBACN,MAAM,GACJ,OAAO,CAgBnB;IAED;;;;;;;;;;;;;;OAcG;IACH,sBAXW,MAAM,aACN,MAAM,gBACN,MAAM,aAEN,OAAO,GAIL,QAAQ,OAAO,CAAC,CA4C5B;IAED;;;;;;;;OAQG;IACH,mBALW,WAAW,GAGT,QAAQ,MAAM,EAAE,CAAC,CAwD7B;CACF;;0BAKY,OAAO,UAAU,EAAE,WAAW;qBAC9B,OAAO,UAAU,EAAE,MAAM;kCACzB,OAAO,UAAU,EAAE,mBAAmB;yCACtC,OAAO,UAAU,EAAE,0BAA0B"}

package/build/lib/{storage-client.js → storage-client/storage-client.js}

@@ -4,15 +4,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChromedriverStorageClient = void 0;
-const utils_1 = require("./utils");
+const utils_1 = require("../utils");
 const lodash_1 = __importDefault(require("lodash"));
-const xpath_1 = __importDefault(require("xpath"));
-const xmldom_1 = require("@xmldom/xmldom");
 const bluebird_1 = __importDefault(require("bluebird"));
 const path_1 = __importDefault(require("path"));
-const os_1 = __importDefault(require("os"));
 const support_1 = require("@appium/support");
-const TIMEOUT_MS = 15000;
+const constants_1 = require("../constants");
+const googleapis_1 = require("./googleapis");
+const chromelabs_1 = require("./chromelabs");
+const compare_versions_1 = require("compare-versions");
+const semver_1 = __importDefault(require("semver"));
 const MAX_PARALLEL_DOWNLOADS = 5;
 const log = support_1.logger.getLogger('ChromedriverStorageClient');
 /**
@@ -25,160 +26,18 @@ async function isCrcOk(src, checksum) {
     const md5 = await support_1.fs.hash(src, 'md5');
     return lodash_1.default.toLower(md5) === lodash_1.default.toLower(checksum);
 }
-/**
- *
- * @param {Node|Attr} parent
- * @param {string?} childName
- * @param {string?} text
- * @returns
- */
-function findChildNode(parent, childName = null, text = null) {
-    if (!childName && !text) {
-        return null;
-    }
-    if (!parent.hasChildNodes()) {
-        return null;
-    }
-    for (let childNodeIdx = 0; childNodeIdx < parent.childNodes.length; childNodeIdx++) {
-        const childNode = /** @type {Element|Attr} */ (parent.childNodes[childNodeIdx]);
-        if (childName && !text && childName === childNode.localName) {
-            return childNode;
-        }
-        if (text) {
-            const childText = extractNodeText(childNode);
-            if (!childText) {
-                continue;
-            }
-            if (childName && childName === childNode.localName && text === childText) {
-                return childNode;
-            }
-            if (!childName && text === childText) {
-                return childNode;
-            }
-        }
-    }
-    return null;
-}
-/**
- *
- * @param {Node?} node
- * @returns
- */
-function extractNodeText(node) {
-    return !node || !node.firstChild || !support_1.util.hasValue(node.firstChild.nodeValue)
-        ? null
-        : node.firstChild.nodeValue;
-}
 class ChromedriverStorageClient {
     /**
      *
-     * @param {import('./types').ChromedriverStorageClientOpts} args
+     * @param {import('../types').ChromedriverStorageClientOpts} args
      */
     constructor(args = {}) {
-        const { chromedriverDir = (0, utils_1.getChromedriverDir)(), timeout = TIMEOUT_MS } = args;
+        const { chromedriverDir = (0, utils_1.getChromedriverDir)(), timeout = constants_1.STORAGE_REQ_TIMEOUT_MS } = args;
         this.chromedriverDir = chromedriverDir;
         this.timeout = timeout;
         /** @type {ChromedriverDetailsMapping} */
         this.mapping = {};
     }
-    /**
-     * Gets additional chromedriver details from chromedriver
-     * release notes
-     *
-     * @param {string} content - Release notes of the corresponding chromedriver
-     * @returns {import('./types').AdditionalDriverDetails}
-     */
-    parseNotes(content) {
-        const result = {};
-        const versionMatch = /^\s*[-]+ChromeDriver[\D]+([\d.]+)/im.exec(content);
-        if (versionMatch) {
-            result.version = versionMatch[1];
-        }
-        const minBrowserVersionMatch = /^\s*Supports Chrome[\D]+(\d+)/im.exec(content);
-        if (minBrowserVersionMatch) {
-            result.minBrowserVersion = minBrowserVersionMatch[1];
-        }
-        return result;
-    }
-    /**
-     * Downloads chromedriver release notes and puts them
-     * into the dictionary argument
-     *
-     * The method call mutates by merging `AdditionalDriverDetails`
-     * @param {string} driverKey - Driver version plus archive name
-     * @param {string} notesUrl - The URL of chromedriver notes
-     * @param {ChromedriverDetails} infoDict - The dictionary containing driver info.
-     * @throws {Error} if the release notes cannot be downloaded
-     */
-    async retrieveAdditionalDriverInfo(driverKey, notesUrl, infoDict) {
-        const notes = await (0, utils_1.retrieveData)(notesUrl, {
-            'user-agent': 'appium',
-            accept: '*/*',
-        }, { timeout: this.timeout });
-        const { minBrowserVersion } = this.parseNotes(notes);
-        if (!minBrowserVersion) {
-            log.debug(`The driver '${driverKey}' does not contain valid release notes at ${notesUrl}. ` +
-                `Skipping it`);
-            return;
-        }
-        infoDict.minBrowserVersion = minBrowserVersion;
-    }
-    /**
-     * Parses chromedriver storage XML and stores
-     * the parsed results into `this.mapping`
-     *
-     * @param {Document} doc - The DOM representation
-     * of the chromedriver storage XML
-     * @param {boolean} shouldParseNotes [true] - If set to `true`
-     * then additional drivers information is going to be parsed
-     * and assigned to `this.mapping`
-     */
-    async parseStorageXml(doc, shouldParseNotes = true) {
-        const driverNodes = /** @type {Array<Node|Attr>} */ (xpath_1.default.select(`//*[local-name(.)='Contents']`, doc));
-        log.debug(`Parsed ${driverNodes.length} entries from storage XML`);
-        if (lodash_1.default.isEmpty(driverNodes)) {
-            return;
-        }
-        const promises = [];
-        for (const driverNode of driverNodes) {
-            const k = extractNodeText(findChildNode(driverNode, 'Key'));
-            if (!lodash_1.default.includes(k, '/chromedriver_')) {
-                continue;
-            }
-            const key = String(k);
-            const etag = extractNodeText(findChildNode(driverNode, 'ETag'));
-            if (!etag) {
-                log.debug(`The entry '${key}' does not contain the checksum. Skipping it`);
-                continue;
-            }
-            /** @type {ChromedriverDetails} */
-            const cdInfo = {
-                url: `${utils_1.CD_CDN}/${key}`,
-                etag: lodash_1.default.trim(etag, '"'),
-                version: /** @type {string} */ (lodash_1.default.first(key.split('/'))),
-                minBrowserVersion: null,
-            };
-            this.mapping[key] = cdInfo;
-            const notesPath = `${cdInfo.version}/notes.txt`;
-            const isNotesPresent = !!driverNodes.reduce((acc, node) => Boolean(acc || findChildNode(node, 'Key', notesPath)), false);
-            if (!isNotesPresent) {
-                cdInfo.minBrowserVersion = null;
-                if (shouldParseNotes) {
-                    log.info(`The entry '${key}' does not contain any notes. Skipping it`);
-                }
-                continue;
-            }
-            else if (!shouldParseNotes) {
-                continue;
-            }
-            promises.push(this.retrieveAdditionalDriverInfo(key, `${utils_1.CD_CDN}/${notesPath}`, cdInfo));
-            if (promises.length % MAX_PARALLEL_DOWNLOADS === 0) {
-                await bluebird_1.default.all(promises);
-            }
-        }
-        await bluebird_1.default.all(promises);
-        log.info(`The total count of entries in the mapping: ${lodash_1.default.size(this.mapping)}`);
-    }
     /**
      * Retrieves chromedriver mapping from the storage
      *
@@ -188,13 +47,19 @@ class ChromedriverStorageClient {
      * @returns {Promise<ChromedriverDetailsMapping>}
      */
     async retrieveMapping(shouldParseNotes = true) {
-        const xml = await (0, utils_1.retrieveData)(utils_1.CD_CDN, {
-            'user-agent': 'appium',
-            accept: 'application/xml, */*',
-        }, { timeout: this.timeout });
-        const doc = new xmldom_1.DOMParser().parseFromString(xml);
-        await this.parseStorageXml(doc, shouldParseNotes);
-        return lodash_1.default.cloneDeep(this.mapping);
+        const [xmlStr, jsonStr] = await bluebird_1.default.all([
+            [constants_1.GOOGLEAPIS_CDN, 'application/xml'],
+            [`${constants_1.CHROMELABS_URL}/chrome-for-testing/known-good-versions-with-downloads.json`, 'application/json'],
+        ]
+            .map(([url, contentType]) => url
+            ? (0, utils_1.retrieveData)(url, {
+                'user-agent': constants_1.USER_AGENT,
+                accept: `${contentType}, */*`,
+            }, { timeout: this.timeout })
+            : bluebird_1.default.resolve()));
+        this.mapping = xmlStr ? await (0, googleapis_1.parseGoogleapiStorageXml)(xmlStr, shouldParseNotes) : {};
+        Object.assign(this.mapping, (0, chromelabs_1.parseKnownGoodVersionsWithDownloadsJson)(jsonStr));
+        return this.mapping;
     }
     /**
      * Extracts downloaded chromedriver archive
@@ -267,28 +132,83 @@ class ChromedriverStorageClient {
         }
         if (!lodash_1.default.isEmpty(osInfo)) {
             // Filter out drivers for unsupported system architectures
-            let { name, arch } = osInfo;
-            if (arch === utils_1.X64 && !driversToSync.some((cdName) => cdName.includes(`_${name}${utils_1.X64}`))) {
-                // Fall back to x86 build if x64 one is not available for the given OS
-                arch = utils_1.X86;
+            const { name, arch, cpu = (0, utils_1.getCpuType)() } = osInfo;
+            log.debug(`Selecting chromedrivers whose platform matches to ${name}:${cpu}${arch}`);
+            let result = driversToSync.filter((cdName) => this.doesMatchForOsInfo(cdName, osInfo));
+            if (lodash_1.default.isEmpty(result) && arch === constants_1.ARCH.X64 && cpu === constants_1.CPU.INTEL) {
+                // Fallback to X86 if X64 architecture is not available for this driver
+                result = driversToSync.filter((cdName) => this.doesMatchForOsInfo(cdName, {
+                    name, arch: constants_1.ARCH.X86, cpu
+                }));
             }
-            // https://stackoverflow.com/questions/65146751/detecting-apple-silicon-mac-in-javascript
-            if (name === utils_1.OS.mac && lodash_1.default.includes(lodash_1.default.toLower(os_1.default.cpus()[0].model), 'apple')) {
-                for (const armSuffix of utils_1.APPLE_ARM_SUFFIXES) {
-                    if (driversToSync.some((cdName) => cdName.includes(armSuffix))) {
-                        // prefer executable for ARM arch if present
-                        arch = armSuffix;
-                        break;
-                    }
-                }
+            if (lodash_1.default.isEmpty(result) && name === constants_1.OS.MAC && cpu === constants_1.CPU.ARM) {
+                // Fallback to Intel/Rosetta if ARM architecture is not available for this driver
+                result = driversToSync.filter((cdName) => this.doesMatchForOsInfo(cdName, {
+                    name, arch, cpu: constants_1.CPU.INTEL
+                }));
             }
-            log.debug(`Selecting chromedrivers whose platform matches to ${name}${arch}`);
-            const platformRe = new RegExp(`(\\b|_)${name}${arch}\\b`);
-            driversToSync = driversToSync.filter((cdName) => platformRe.test(cdName));
+            driversToSync = result;
             log.debug(`Got ${support_1.util.pluralize('item', driversToSync.length, true)}`);
         }
+        if (!lodash_1.default.isEmpty(driversToSync)) {
+            log.debug('Excluding older patches if present');
+            /** @type {{[key: string]: string[]}} */
+            const patchesMap = {};
+            // Older chromedrivers must not be excluded as they follow a different
+            // versioning pattern
+            const versionWithPatchPattern = /\d+\.\d+\.\d+\.\d+/;
+            const selectedVersions = new Set();
+            for (const cdName of driversToSync) {
+                const cdVersion = this.mapping[cdName].version;
+                if (!versionWithPatchPattern.test(cdVersion)) {
+                    selectedVersions.add(cdVersion);
+                    continue;
+                }
+                const verObj = semver_1.default.parse(cdVersion, { loose: true });
+                if (!verObj) {
+                    continue;
+                }
+                if (!lodash_1.default.isArray(patchesMap[verObj.major])) {
+                    patchesMap[verObj.major] = [];
+                }
+                patchesMap[verObj.major].push(cdVersion);
+            }
+            for (const majorVersion of lodash_1.default.keys(patchesMap)) {
+                if (patchesMap[majorVersion].length <= 1) {
+                    continue;
+                }
+                patchesMap[majorVersion].sort((/** @type {string} */ a, /** @type {string}} */ b) => (0, compare_versions_1.compareVersions)(b, a));
+            }
+            if (!lodash_1.default.isEmpty(patchesMap)) {
+                log.debug('Versions mapping: ' + JSON.stringify(patchesMap, null, 2));
+                for (const sortedVersions of lodash_1.default.values(patchesMap)) {
+                    selectedVersions.add(sortedVersions[0]);
+                }
+                driversToSync = driversToSync.filter((cdName) => selectedVersions.has(this.mapping[cdName].version));
+            }
+        }
         return driversToSync;
     }
+    /**
+     * Checks whether the given chromedriver matches the operating system to run on
+     *
+     * @param {string} cdName
+     * @param {OSInfo} osInfo
+     * @returns {boolean}
+     */
+    doesMatchForOsInfo(cdName, { name, arch, cpu }) {
+        const cdInfo = this.mapping[cdName];
+        if (!cdInfo) {
+            return false;
+        }
+        if (cdInfo.os.name !== name || cdInfo.os.arch !== arch) {
+            return false;
+        }
+        if (cpu && cdInfo.os.cpu && this.mapping[cdName].os.cpu !== cpu) {
+            return false;
+        }
+        return true;
+    }
     /**
      * Retrieves the given chromedriver from the storage
      * and unpacks it into `this.chromedriverDir` folder
@@ -311,7 +231,7 @@ class ChromedriverStorageClient {
         try {
             await support_1.net.downloadFile(url, archivePath, {
                 isMetered: false,
-                timeout: TIMEOUT_MS,
+                timeout: constants_1.STORAGE_REQ_TIMEOUT_MS,
             });
         }
         catch (e) {
@@ -323,7 +243,7 @@ class ChromedriverStorageClient {
             log.error(msg);
             return false;
         }
-        if (!(await isCrcOk(archivePath, etag))) {
+        if (etag && !(await isCrcOk(archivePath, etag))) {
             const msg = `The checksum for the downloaded chromedriver '${driverKey}' did not match`;
             if (isStrict) {
                 throw new Error(msg);
@@ -376,17 +296,21 @@ class ChromedriverStorageClient {
          */
         const synchronizedDrivers = [];
         const promises = [];
+        const chunk = [];
         const archivesRoot = await support_1.tempDir.openDir();
         try {
             for (const [idx, driverKey] of driversToSync.entries()) {
-                promises.push((async () => {
+                const promise = bluebird_1.default.resolve((async () => {
                     if (await this.retrieveDriver(idx, driverKey, archivesRoot, !lodash_1.default.isEmpty(opts))) {
                         synchronizedDrivers.push(driverKey);
                     }
                 })());
-                if (promises.length % MAX_PARALLEL_DOWNLOADS === 0) {
-                    await bluebird_1.default.all(promises);
+                promises.push(promise);
+                chunk.push(promise);
+                if (chunk.length >= MAX_PARALLEL_DOWNLOADS) {
+                    await bluebird_1.default.any(chunk);
                 }
+                lodash_1.default.remove(chunk, (p) => p.isFulfilled());
             }
             await bluebird_1.default.all(promises);
         }
@@ -406,9 +330,9 @@ class ChromedriverStorageClient {
 exports.ChromedriverStorageClient = ChromedriverStorageClient;
 exports.default = ChromedriverStorageClient;
 /**
- * @typedef {import('./types').SyncOptions} SyncOptions
- * @typedef {import('./types').OSInfo} OSInfo
- * @typedef {import('./types').ChromedriverDetails} ChromedriverDetails
- * @typedef {import('./types').ChromedriverDetailsMapping} ChromedriverDetailsMapping
+ * @typedef {import('../types').SyncOptions} SyncOptions
+ * @typedef {import('../types').OSInfo} OSInfo
+ * @typedef {import('../types').ChromedriverDetails} ChromedriverDetails
+ * @typedef {import('../types').ChromedriverDetailsMapping} ChromedriverDetailsMapping
  */
 //# sourceMappingURL=storage-client.js.map