appium-chromedriver 5.0.2 → 5.0.5

package/lib/chromedriver.js

@@ -9,7 +9,7 @@ import { SubProcess, exec } from 'teen_process';
 import B from 'bluebird';
 import {
   getChromeVersion, getChromedriverDir, CHROMEDRIVER_CHROME_MAPPING,
-  getChromedriverBinaryPath, CD_CDN,
+  getChromedriverBinaryPath, CD_CDN, generateLogPrefix
 } from './utils';
 import semver from 'semver';
 import _ from 'lodash';
@@ -18,9 +18,6 @@ import compareVersions from 'compare-versions';
 import ChromedriverStorageClient from './storage-client';
 import { toW3cCapNames, getCapValue } from './protocol-helpers';
 
-
-const log = logger.getLogger('Chromedriver');
-
 const NEW_CD_VERSION_FORMAT_MAJOR_VERSION = 73;
 const DEFAULT_HOST = '127.0.0.1';
 const MIN_CD_VERSION_WITH_W3C_SUPPORT = 75;
@@ -56,6 +53,7 @@ class Chromedriver extends events.EventEmitter {
       details,
       isAutodownloadEnabled = false,
     } = args;
+    this._log = logger.getLogger(generateLogPrefix(this));
 
     this.proxyHost = host;
     this.proxyPort = port;
@@ -71,7 +69,8 @@ class Chromedriver extends events.EventEmitter {
     this.state = Chromedriver.STATE_STOPPED;
     this.jwproxy = new JWProxy({
       server: this.proxyHost,
-      port: this.proxyPort
+      port: this.proxyPort,
+      log: this._log,
     });
     this.verbose = verbose;
     this.logPath = logPath;
@@ -84,23 +83,27 @@ class Chromedriver extends events.EventEmitter {
     this.desiredProtocol = PROTOCOLS.MJSONWP;
   }
 
+  get log () {
+    return this._log;
+  }
+
   async getDriversMapping () {
     let mapping = _.cloneDeep(CHROMEDRIVER_CHROME_MAPPING);
     if (this.mappingPath) {
-      log.debug(`Attempting to use Chromedriver->Chrome mapping from '${this.mappingPath}'`);
+      this.log.debug(`Attempting to use Chromedriver->Chrome mapping from '${this.mappingPath}'`);
       if (!await fs.exists(this.mappingPath)) {
-        log.warn(`No file found at '${this.mappingPath}'`);
-        log.info('Defaulting to the static Chromedriver->Chrome mapping');
+        this.log.warn(`No file found at '${this.mappingPath}'`);
+        this.log.info('Defaulting to the static Chromedriver->Chrome mapping');
       } else {
         try {
           mapping = JSON.parse(await fs.readFile(this.mappingPath, 'utf8'));
         } catch (err) {
-          log.warn(`Error parsing mapping from '${this.mappingPath}': ${err.message}`);
-          log.info('Defaulting to the static Chromedriver->Chrome mapping');
+          this.log.warn(`Error parsing mapping from '${this.mappingPath}': ${err.message}`);
+          this.log.info('Defaulting to the static Chromedriver->Chrome mapping');
         }
       }
     } else {
-      log.debug('Using the static Chromedriver->Chrome mapping');
+      this.log.debug('Using the static Chromedriver->Chrome mapping');
     }
 
     // make sure that the values for minimum chrome version are semver compliant
@@ -109,7 +112,7 @@ class Chromedriver extends events.EventEmitter {
       if (coercedVersion) {
         mapping[cdVersion] = coercedVersion.version;
       } else {
-        log.info(`'${chromeVersion}' is not a valid version number. Skipping it`);
+        this.log.info(`'${chromeVersion}' is not a valid version number. Skipping it`);
       }
     }
     return mapping;
@@ -117,10 +120,15 @@ class Chromedriver extends events.EventEmitter {
 
   async getChromedrivers (mapping) {
     // go through the versions available
-    const executables = await fs.glob(`${this.executableDir}/*`);
-    log.debug(`Found ${util.pluralize('executable', executables.length, true)} ` +
+    const executables = await fs.glob('*', {
+      cwd: this.executableDir,
+      strict: false,
+      nodir: true,
+      absolute: true,
+    });
+    this.log.debug(`Found ${util.pluralize('executable', executables.length, true)} ` +
       `in '${this.executableDir}'`);
-    const cds = (await asyncmap(executables, async function mapChromedriver (executable) {
+    const cds = (await asyncmap(executables, async (executable) => {
       const logError = ({message, stdout = null, stderr = null}) => {
         let errMsg = `Cannot retrieve version number from '${path.basename(executable)}' Chromedriver binary. ` +
           `Make sure it returns a valid version string in response to '--version' command line argument. ${message}`;
@@ -130,7 +138,7 @@ class Chromedriver extends events.EventEmitter {
         if (stderr) {
           errMsg += `\nStderr: ${stderr}`;
         }
-        log.warn(errMsg);
+        this.log.warn(errMsg);
         return null;
       };
 
@@ -177,12 +185,12 @@ class Chromedriver extends events.EventEmitter {
       .filter((cd) => !!cd)
       .sort((a, b) => compareVersions(b.version, a.version));
     if (_.isEmpty(cds)) {
-      log.info(`No Chromedrivers were found in '${this.executableDir}'`);
+      this.log.info(`No Chromedrivers were found in '${this.executableDir}'`);
       return cds;
     }
-    log.debug(`The following Chromedriver executables were found:`);
+    this.log.debug(`The following Chromedriver executables were found:`);
     for (const cd of cds) {
-      log.debug(`    '${cd.executable}' (version '${cd.version}', minimum Chrome version '${cd.minChromeVersion ? cd.minChromeVersion : 'Unknown'}')`);
+      this.log.debug(`    '${cd.executable}' (version '${cd.version}', minimum Chrome version '${cd.minChromeVersion ? cd.minChromeVersion : 'Unknown'}')`);
     }
     return cds;
   }
@@ -192,7 +200,7 @@ class Chromedriver extends events.EventEmitter {
     // The `info` item must contain the output of /json/version CDP command
     // where `Browser` field looks like `Chrome/72.0.3601.0``
     if (this.details?.info) {
-      log.debug(`Browser version in the supplied details: ${this.details?.info?.Browser}`);
+      this.log.debug(`Browser version in the supplied details: ${this.details?.info?.Browser}`);
     }
     const versionMatch = VERSION_PATTERN.exec(this.details?.info?.Browser);
     if (versionMatch) {
@@ -256,7 +264,7 @@ class Chromedriver extends events.EventEmitter {
         await fs.writeFile(this.mappingPath, JSON.stringify(newMapping, null, 2), 'utf8');
         shouldUpdateStaticMapping = false;
       } catch (e) {
-        log.warn(`Cannot store the updated chromedrivers mapping into '${this.mappingPath}'. ` +
+        this.log.warn(`Cannot store the updated chromedrivers mapping into '${this.mappingPath}'. ` +
           `This may reduce the performance of further executions. Original error: ${e.message}`);
       }
     }
@@ -272,14 +280,14 @@ class Chromedriver extends events.EventEmitter {
 
     const mapping = await this.getDriversMapping();
     if (!_.isEmpty(mapping)) {
-      log.debug(`The most recent known Chrome version: ${_.values(mapping)[0]}`);
+      this.log.debug(`The most recent known Chrome version: ${_.values(mapping)[0]}`);
     }
 
     let didStorageSync = false;
     const syncChromedrivers = async (chromeVersion) => {
       didStorageSync = true;
       const retrievedMapping = await this.storageClient.retrieveMapping();
-      log.debug('Got chromedrivers mapping from the storage: ' +
+      this.log.debug('Got chromedrivers mapping from the storage: ' +
         JSON.stringify(retrievedMapping, null, 2));
       const driverKeys = await this.storageClient.syncDrivers({
         minBrowserVersion: chromeVersion.major,
@@ -313,7 +321,7 @@ class Chromedriver extends events.EventEmitter {
         missingVersions[version] = minChromeVersion;
       }
       if (!_.isEmpty(missingVersions)) {
-        log.info(`Found ${util.pluralize('Chromedriver', _.size(missingVersions), true)}, ` +
+        this.log.info(`Found ${util.pluralize('Chromedriver', _.size(missingVersions), true)}, ` +
           `which ${_.size(missingVersions) === 1 ? 'is' : 'are'} missing in the list of known versions: ` +
           JSON.stringify(missingVersions));
         await this.updateDriversMapping(Object.assign(mapping, missingVersions));
@@ -321,12 +329,12 @@ class Chromedriver extends events.EventEmitter {
 
       if (this.disableBuildCheck) {
         if (_.isEmpty(cds)) {
-          log.errorAndThrow(`There must be at least one Chromedriver executable available for use if ` +
+          this.log.errorAndThrow(`There must be at least one Chromedriver executable available for use if ` +
             `'chromedriverDisableBuildCheck' capability is set to 'true'`);
         }
         const {version, executable} = cds[0];
-        log.warn(`Chrome build check disabled. Using most recent Chromedriver version (${version}, at '${executable}')`);
-        log.warn(`If this is wrong, set 'chromedriverDisableBuildCheck' capability to 'false'`);
+        this.log.warn(`Chrome build check disabled. Using most recent Chromedriver version (${version}, at '${executable}')`);
+        this.log.warn(`If this is wrong, set 'chromedriverDisableBuildCheck' capability to 'false'`);
         return executable;
       }
 
@@ -334,14 +342,14 @@ class Chromedriver extends events.EventEmitter {
       if (!chromeVersion) {
         // unable to get the chrome version
         if (_.isEmpty(cds)) {
-          log.errorAndThrow(`There must be at least one Chromedriver executable available for use if ` +
+          this.log.errorAndThrow(`There must be at least one Chromedriver executable available for use if ` +
             `the current Chrome version cannot be determined`);
         }
         const {version, executable} = cds[0];
-        log.warn(`Unable to discover Chrome version. Using Chromedriver ${version} at '${executable}'`);
+        this.log.warn(`Unable to discover Chrome version. Using Chromedriver ${version} at '${executable}'`);
         return executable;
       }
-      log.debug(`Found Chrome bundle '${this.bundleId}' version '${chromeVersion}'`);
+      this.log.debug(`Found Chrome bundle '${this.bundleId}' version '${chromeVersion}'`);
 
       const matchingDrivers = cds.filter(({minChromeVersion}) => {
         const minChromeVersionS = minChromeVersion && semver.coerce(minChromeVersion);
@@ -360,9 +368,9 @@ class Chromedriver extends events.EventEmitter {
               continue;
             }
           } catch (e) {
-            log.warn(`Cannot synchronize local chromedrivers with the remote storage at ${CD_CDN}: ` +
+            this.log.warn(`Cannot synchronize local chromedrivers with the remote storage at ${CD_CDN}: ` +
               e.message);
-            log.debug(e.stack);
+            this.log.debug(e.stack);
           }
         }
         const autodownloadSuggestion =
@@ -373,9 +381,9 @@ class Chromedriver extends events.EventEmitter {
       }
 
       const binPath = matchingDrivers[0].executable;
-      log.debug(`Found ${util.pluralize('executable', matchingDrivers.length, true)} ` +
+      this.log.debug(`Found ${util.pluralize('executable', matchingDrivers.length, true)} ` +
         `capable of automating Chrome '${chromeVersion}'.\nChoosing the most recent, '${binPath}'.`);
-      log.debug('If a specific version is required, specify it with the `chromedriverExecutable`' +
+      this.log.debug('If a specific version is required, specify it with the `chromedriverExecutable`' +
         'desired capability.');
       return binPath;
     // eslint-disable-next-line no-constant-condition
@@ -399,19 +407,19 @@ class Chromedriver extends events.EventEmitter {
                       `${this.chromedriver}, but it doesn't exist!`);
     }
     this.executableVerified = true;
-    log.info(`Set chromedriver binary as: ${this.chromedriver}`);
+    this.log.info(`Set chromedriver binary as: ${this.chromedriver}`);
   }
 
   syncProtocol (cdVersion = null) {
     const coercedVersion = semver.coerce(cdVersion);
     if (!coercedVersion || coercedVersion.major < MIN_CD_VERSION_WITH_W3C_SUPPORT) {
-      log.debug(`Chromedriver v. ${cdVersion} does not fully support ${PROTOCOLS.W3C} protocol. ` +
+      this.log.debug(`Chromedriver v. ${cdVersion} does not fully support ${PROTOCOLS.W3C} protocol. ` +
         `Defaulting to ${PROTOCOLS.MJSONWP}`);
       return;
     }
     const chromeOptions = getCapValue(this.capabilities, 'chromeOptions', {});
     if (chromeOptions.w3c === false) {
-      log.info(`Chromedriver v. ${cdVersion} supports ${PROTOCOLS.W3C} protocol, ` +
+      this.log.info(`Chromedriver v. ${cdVersion} supports ${PROTOCOLS.W3C} protocol, ` +
         `but ${PROTOCOLS.MJSONWP} one has been explicitly requested`);
       return;
     }
@@ -478,7 +486,7 @@ class Chromedriver extends events.EventEmitter {
         let match = /"Browser": "(.*)"/.exec(out);
         if (match) {
           webviewVersion = match[1];
-          log.debug(`Webview version: '${webviewVersion}'`);
+          this.log.debug(`Webview version: '${webviewVersion}'`);
         }
 
         // also print chromedriver version to logs
@@ -486,7 +494,7 @@ class Chromedriver extends events.EventEmitter {
         //  Starting ChromeDriver 2.33.506106 (8a06c39c4582fbfbab6966dbb1c38a9173bfb1a2) on port 9515
         match = /Starting ChromeDriver ([.\d]+)/.exec(out);
         if (match) {
-          log.debug(`Chromedriver version: '${match[1]}'`);
+          this.log.debug(`Chromedriver version: '${match[1]}'`);
           this.syncProtocol(match[1]);
         }
 
@@ -494,11 +502,11 @@ class Chromedriver extends events.EventEmitter {
         if (this.verbose) {
           for (let line of (stdout || '').trim().split('\n')) {
             if (!line.trim().length) continue; // eslint-disable-line curly
-            log.debug(`[STDOUT] ${line}`);
+            this.log.debug(`[STDOUT] ${line}`);
           }
           for (let line of (stderr || '').trim().split('\n')) {
             if (!line.trim().length) continue; // eslint-disable-line curly
-            log.error(`[STDERR] ${line}`);
+            this.log.error(`[STDERR] ${line}`);
           }
         }
       });
@@ -509,20 +517,18 @@ class Chromedriver extends events.EventEmitter {
         if (this.state !== Chromedriver.STATE_STOPPED &&
             this.state !== Chromedriver.STATE_STOPPING &&
             this.state !== Chromedriver.STATE_RESTARTING) {
-          let msg = `Chromedriver exited unexpectedly with code ${code}, ` +
-                    `signal ${signal}`;
-          log.error(msg);
+          const msg = `Chromedriver exited unexpectedly with code ${code}, signal ${signal}`;
+          this.log.error(msg);
           this.changeState(Chromedriver.STATE_STOPPED);
         }
       });
-      log.info(`Spawning chromedriver with: ${this.chromedriver} ` +
-               `${args.join(' ')}`);
+      this.log.info(`Spawning chromedriver with: ${this.chromedriver} ${args.join(' ')}`);
       // start subproc and wait for startDetector
       await this.proc.start(startDetector);
       await this.waitForOnline();
       await this.startSession();
     } catch (e) {
-      log.debug(e);
+      this.log.debug(e);
       this.emit(Chromedriver.EVENT_ERROR, e);
       // just because we had an error doesn't mean the chromedriver process
       // finished; we should clean up if necessary
@@ -545,20 +551,16 @@ class Chromedriver extends events.EventEmitter {
       }
 
       message += e.message;
-      log.errorAndThrow(message);
+      this.log.errorAndThrow(message);
     }
   }
 
   sessionId () {
-    if (this.state !== Chromedriver.STATE_ONLINE) {
-      return null;
-    }
-
-    return this.jwproxy.sessionId;
+    return this.state === Chromedriver.STATE_ONLINE ? this.jwproxy.sessionId : null;
   }
 
   async restart () {
-    log.info('Restarting chromedriver');
+    this.log.info('Restarting chromedriver');
     if (this.state !== Chromedriver.STATE_ONLINE) {
       throw new Error("Can't restart when we're not online");
     }
@@ -591,9 +593,10 @@ class Chromedriver extends events.EventEmitter {
     const sessionCaps = this.desiredProtocol === PROTOCOLS.W3C
       ? {capabilities: {alwaysMatch: this.capabilities}}
       : {desiredCapabilities: this.capabilities};
-    log.info(`Starting ${this.desiredProtocol} Chromedriver session with capabilities: ` +
+    this.log.info(`Starting ${this.desiredProtocol} Chromedriver session with capabilities: ` +
       JSON.stringify(sessionCaps, null, 2));
     await this.jwproxy.command('/session', 'POST', sessionCaps);
+    this.log.prefix = generateLogPrefix(this, this.jwproxy.sessionId);
     this.changeState(Chromedriver.STATE_ONLINE);
   }
 
@@ -605,12 +608,13 @@ class Chromedriver extends events.EventEmitter {
       try {
         return await f();
       } catch (e) {
-        log.warn(e.message);
-        log.debug(e.stack);
+        this.log.warn(e.message);
+        this.log.debug(e.stack);
       }
     };
     await runSafeStep(() => this.jwproxy.command('', 'DELETE'));
     await runSafeStep(() => this.proc.stop('SIGTERM', 20000));
+    this.log.prefix = generateLogPrefix(this);
     if (emitStates) {
       this.changeState(Chromedriver.STATE_STOPPED);
     }
@@ -618,7 +622,7 @@ class Chromedriver extends events.EventEmitter {
 
   changeState (state) {
     this.state = state;
-    log.debug(`Changed state to '${state}'`);
+    this.log.debug(`Changed state to '${state}'`);
     this.emit(Chromedriver.EVENT_CHANGED, {state});
   }
 
@@ -634,12 +638,12 @@ class Chromedriver extends events.EventEmitter {
     let cmd = system.isWindows()
       ? `wmic process where "commandline like '%chromedriver.exe%--port=${this.proxyPort}%'" delete`
       : `pkill -15 -f "${this.chromedriver}.*--port=${this.proxyPort}"`;
-    log.debug(`Killing any old chromedrivers, running: ${cmd}`);
+    this.log.debug(`Killing any old chromedrivers, running: ${cmd}`);
     try {
       await (B.promisify(cp.exec))(cmd);
-      log.debug('Successfully cleaned up old chromedrivers');
+      this.log.debug('Successfully cleaned up old chromedrivers');
     } catch (err) {
-      log.warn('No old chromedrivers seem to exist');
+      this.log.warn('No old chromedrivers seem to exist');
     }
 
     if (this.adb) {
@@ -647,9 +651,9 @@ class Chromedriver extends events.EventEmitter {
       const udid = udidIndex > -1 ? this.adb.executable.defaultArgs[udidIndex + 1] : null;
 
       if (udid) {
-        log.debug(`Cleaning this device's adb forwarded port socket connections: ${udid}`);
+        this.log.debug(`Cleaning this device's adb forwarded port socket connections: ${udid}`);
       } else {
-        log.debug(`Cleaning any old adb forwarded port socket connections`);
+        this.log.debug(`Cleaning any old adb forwarded port socket connections`);
       }
 
       try {
@@ -665,7 +669,7 @@ class Chromedriver extends events.EventEmitter {
           }
         }
       } catch (err) {
-        log.warn(`Unable to clean forwarded ports. Error: '${err.message}'. Continuing.`);
+        this.log.warn(`Unable to clean forwarded ports. Error: '${err.message}'. Continuing.`);
       }
     }
   }

package/lib/utils.js

@@ -1,5 +1,6 @@
 import _ from 'lodash';
 import { system, fs } from '@appium/support';
+import { BaseDriver } from '@appium/base-driver';
 import path from 'path';
 import compareVersions from 'compare-versions';
 import axios from 'axios';
@@ -92,9 +93,22 @@ const getOsInfo = _.memoize(async function getOsInfo () {
   };
 });
 
+const getBaseDriverInstance = _.memoize(() => new BaseDriver({}, false));
+
+/**
+ * Generates log prefix string
+ *
+ * @param {object} obj log owner instance
+ * @param {string?} sessionId Optional session identifier
+ * @returns {string}
+ */
+function generateLogPrefix (obj, sessionId = null) {
+  return getBaseDriverInstance().helpers.generateDriverLogPrefix(obj, sessionId);
+}
+
 
 export {
   getChromeVersion, getChromedriverDir, getChromedriverBinaryPath, getOsName,
   CD_BASE_DIR, CD_CDN, CD_VER, CHROMEDRIVER_CHROME_MAPPING, getMostRecentChromedriver,
-  retrieveData, getOsInfo, OS, X64, X86, M1_ARCH_SUFFIX,
+  retrieveData, getOsInfo, OS, X64, X86, M1_ARCH_SUFFIX, generateLogPrefix,
 };

package/package.json

@@ -6,7 +6,7 @@
     "chrome",
     "android"
   ],
-  "version": "5.0.2",
+  "version": "5.0.5",
   "author": "appium",
   "license": "Apache-2.0",
   "repository": {
@@ -35,14 +35,14 @@
     "config/mapping.json"
   ],
   "dependencies": {
-    "@appium/base-driver": "^8.0.0",
+    "@appium/base-driver": "^8.4.0",
     "@appium/support": "^2.55.3",
     "@babel/runtime": "^7.0.0",
     "@xmldom/xmldom": "^0.x",
     "asyncbox": "^2.0.2",
     "axios": "^0.x",
     "bluebird": "^3.5.1",
-    "compare-versions": "^3.4.0",
+    "compare-versions": "^4.1.3",
     "fancy-log": "^2.0.0",
     "lodash": "^4.17.4",
     "semver": "^7.0.0",
@@ -76,11 +76,13 @@
     "@appium/test-support": "^1.0.0",
     "@babel/core": "^7.16.0",
     "@babel/eslint-parser": "^7.16.3",
+    "@semantic-release/git": "^10.0.1",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
     "gulp": "^4.0.0",
-    "mocha": "^9.0.0",
+    "mocha": "^10.0.0",
     "pre-commit": "^1.1.3",
+    "semantic-release": "^19.0.2",
     "sinon": "^13.0.0"
   }
 }