selenium-webdriver 4.0.0-alpha.3 → 4.0.0-alpha.7

package/CHANGES.md

@@ -1,4 +1,11 @@
-## v4.0.0-alpha.2
+## v4.0.0-alpha.4
+
+### Changes
+
+* Removed BUILD.bazel files from the build artifact
+
+
+## v4.0.0-alpha.3
 
 ### Notice
 
@@ -718,7 +725,7 @@ continue to be supported, but will require setting the `--harmony` flag.
     due to a previously uncaught error within the frame.
 * FIXED: 8496: Extended the `chrome.Options` API to cover all configuration
     options (e.g. mobile emulation and performance logging) documented on the
-    ChromeDriver [project site](https://sites.google.com/a/chromium.org/chromedriver/capabilities).
+    ChromeDriver [project site](https://chromedriver.chromium.org/capabilities).
 
 ## v2.45.0
 

package/README.md

@@ -117,13 +117,12 @@ Additional resources include
 
 - the #selenium channel on freenode IRC
 - the [selenium-users@googlegroups.com][users] list
-- [SeleniumHQ](http://www.seleniumhq.org/docs/) documentation
+- [SeleniumHQ](https://selenium.dev/documentation/) documentation
 
 ## Contributing
 
 Contributions are accepted either through [GitHub][gh] pull requests or patches
-via the [Selenium issue tracker][issues]. You must sign our
-[Contributor License Agreement][cla] before your changes will be accepted.
+via the [Selenium issue tracker][issues].
 
 ## Node Support Policy
 
@@ -217,7 +216,6 @@ under the License.
 [LTS]: https://github.com/nodejs/LTS
 [PATH]: http://en.wikipedia.org/wiki/PATH_%28variable%29
 [api]: http://seleniumhq.github.io/selenium/docs/api/javascript/module/selenium-webdriver/
-[cla]: http://goo.gl/qC50R
 [chrome]: http://chromedriver.storage.googleapis.com/index.html
 [gh]: https://github.com/SeleniumHQ/selenium/
 [issues]: https://github.com/SeleniumHQ/selenium/issues

package/chrome.js

@@ -118,29 +118,20 @@
  * [Refer to the ChromeDriver site] for more information on using the
  * [ChromeDriver with Android][android].
  *
- * [ChromeDriver]: https://sites.google.com/a/chromium.org/chromedriver/
+ * [ChromeDriver]: https://chromedriver.chromium.org/
  * [ChromeDriver release]: http://chromedriver.storage.googleapis.com/index.html
  * [PATH]: http://en.wikipedia.org/wiki/PATH_%28variable%29
- * [android]: https://sites.google.com/a/chromium.org/chromedriver/getting-started/getting-started---android
+ * [android]: https://chromedriver.chromium.org/getting-started/getting-started---android
  * [webview]: https://developer.chrome.com/multidevice/webview/overview
  */
 
 'use strict';
 
-const fs = require('fs');
-const util = require('util');
-
 const http = require('./http');
 const io = require('./io');
-const {Browser, Capabilities, Capability} = require('./lib/capabilities');
-const command = require('./lib/command');
-const error = require('./lib/error');
-const logging = require('./lib/logging');
-const promise = require('./lib/promise');
-const Symbols = require('./lib/symbols');
-const webdriver = require('./lib/webdriver');
-const portprober = require('./net/portprober');
+const {Browser, Capabilities} = require('./lib/capabilities');
 const remote = require('./remote');
+const chromium = require('./chromium');
 
 
 /**
@@ -152,56 +143,6 @@ const CHROMEDRIVER_EXE =
     process.platform === 'win32' ? 'chromedriver.exe' : 'chromedriver';
 
 
-/**
- * Custom command names supported by ChromeDriver.
- * @enum {string}
- */
-const Command = {
-  LAUNCH_APP: 'launchApp',
-  GET_NETWORK_CONDITIONS: 'getNetworkConditions',
-  SET_NETWORK_CONDITIONS: 'setNetworkConditions',
-  SEND_DEVTOOLS_COMMAND: 'sendDevToolsCommand',
-};
-
-
-/**
- * Creates a command executor with support for ChromeDriver's custom commands.
- * @param {!Promise<string>} url The server's URL.
- * @return {!command.Executor} The new command executor.
- */
-function createExecutor(url) {
-  let agent = new http.Agent({ keepAlive: true });
-  let client = url.then(url => new http.HttpClient(url, agent));
-  let executor = new http.Executor(client);
-  configureExecutor(executor);
-  return executor;
-}
-
-
-/**
- * Configures the given executor with Chrome-specific commands.
- * @param {!http.Executor} executor the executor to configure.
- */
-function configureExecutor(executor) {
-  executor.defineCommand(
-      Command.LAUNCH_APP,
-      'POST',
-      '/session/:sessionId/chromium/launch_app');
-  executor.defineCommand(
-      Command.GET_NETWORK_CONDITIONS,
-      'GET',
-      '/session/:sessionId/chromium/network_conditions');
-  executor.defineCommand(
-      Command.SET_NETWORK_CONDITIONS,
-      'POST',
-      '/session/:sessionId/chromium/network_conditions');
-  executor.defineCommand(
-      Command.SEND_DEVTOOLS_COMMAND,
-      'POST',
-      '/session/:sessionId/chromium/send_command');
-}
-
-
 /**
  * _Synchronously_ attempts to locate the chromedriver executable on the current
  * system.
@@ -215,10 +156,10 @@ function locateSynchronously() {
 
 /**
  * Creates {@link selenium-webdriver/remote.DriverService} instances that manage
- * a [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/)
+ * a [ChromeDriver](https://chromedriver.chromium.org/)
  * server in a child process.
  */
-class ServiceBuilder extends remote.DriverService.Builder {
+class ServiceBuilder extends chromium.ServiceBuilder {
   /**
    * @param {string=} opt_exe Path to the server executable to use. If omitted,
    *     the builder will attempt to locate the chromedriver on the current
@@ -237,60 +178,10 @@ class ServiceBuilder extends remote.DriverService.Builder {
     }
 
     super(exe);
-    this.setLoopback(true);  // Required
-  }
-
-  /**
-   * Sets which port adb is listening to. _The ChromeDriver will connect to adb
-   * if an {@linkplain Options#androidPackage Android session} is requested, but
-   * adb **must** be started beforehand._
-   *
-   * @param {number} port Which port adb is running on.
-   * @return {!ServiceBuilder} A self reference.
-   */
-  setAdbPort(port) {
-    return this.addArguments('--adb-port=' + port);
-  }
-
-  /**
-   * Sets the path of the log file the driver should log to. If a log file is
-   * not specified, the driver will log to stderr.
-   * @param {string} path Path of the log file to use.
-   * @return {!ServiceBuilder} A self reference.
-   */
-  loggingTo(path) {
-    return this.addArguments('--log-path=' + path);
-  }
-
-  /**
-   * Enables verbose logging.
-   * @return {!ServiceBuilder} A self reference.
-   */
-  enableVerboseLogging() {
-    return this.addArguments('--verbose');
-  }
-
-  /**
-   * Sets the number of threads the driver should use to manage HTTP requests.
-   * By default, the driver will use 4 threads.
-   * @param {number} n The number of threads to use.
-   * @return {!ServiceBuilder} A self reference.
-   */
-  setNumHttpThreads(n) {
-    return this.addArguments('--http-threads=' + n);
-  }
-
-  /**
-   * @override
-   */
-  setPath(path) {
-    super.setPath(path);
-    return this.addArguments('--url-base=' + path);
   }
 }
 
 
-
 /** @type {remote.DriverService} */
 let defaultService = null;
 
@@ -324,111 +215,10 @@ function getDefaultService() {
 }
 
 
-const OPTIONS_CAPABILITY_KEY = 'goog:chromeOptions';
-
-
 /**
  * Class for managing ChromeDriver specific options.
  */
-class Options extends Capabilities {
-  /**
-   * @param {(Capabilities|Map<string, ?>|Object)=} other Another set of
-   *     capabilities to initialize this instance from.
-   */
-  constructor(other = undefined) {
-    super(other);
-
-    /** @private {!Object} */
-    this.options_ = this.get(OPTIONS_CAPABILITY_KEY) || {};
-
-    this.setBrowserName(Browser.CHROME);
-    this.set(OPTIONS_CAPABILITY_KEY, this.options_);
-  }
-
-  /**
-   * Add additional command line arguments to use when launching the Chrome
-   * browser.  Each argument may be specified with or without the "--" prefix
-   * (e.g. "--foo" and "foo"). Arguments with an associated value should be
-   * delimited by an "=": "foo=bar".
-   *
-   * @param {...(string|!Array<string>)} args The arguments to add.
-   * @return {!Options} A self reference.
-   */
-  addArguments(...args) {
-    let newArgs = (this.options_.args || []).concat(...args);
-    if (newArgs.length) {
-      this.options_.args = newArgs;
-    }
-    return this;
-  }
-
-  /**
-   * Configures the chromedriver to start Chrome in headless mode.
-   *
-   * > __NOTE:__ Resizing the browser window in headless mode is only supported
-   * > in Chrome 60. Users are encouraged to set an initial window size with
-   * > the {@link #windowSize windowSize({width, height})} option.
-   *
-   * > __NOTE__: For security, Chrome disables downloads by default when
-   * > in headless mode (to prevent sites from silently downloading files to
-   * > your machine). After creating a session, you may call
-   * > {@link ./chrome.Driver#setDownloadPath setDownloadPath} to re-enable
-   * > downloads, saving files in the specified directory.
-   *
-   * @return {!Options} A self reference.
-   */
-  headless() {
-    return this.addArguments('headless');
-  }
-
-  /**
-   * Sets the initial window size.
-   *
-   * @param {{width: number, height: number}} size The desired window size.
-   * @return {!Options} A self reference.
-   * @throws {TypeError} if width or height is unspecified, not a number, or
-   *     less than or equal to 0.
-   */
-  windowSize({width, height}) {
-    function checkArg(arg) {
-      if (typeof arg !== 'number' || arg <= 0) {
-        throw TypeError('Arguments must be {width, height} with numbers > 0');
-      }
-    }
-    checkArg(width);
-    checkArg(height);
-    return this.addArguments(`window-size=${width},${height}`);
-  }
-
-  /**
-   * List of Chrome command line switches to exclude that ChromeDriver by default
-   * passes when starting Chrome.  Do not prefix switches with "--".
-   *
-   * @param {...(string|!Array<string>)} args The switches to exclude.
-   * @return {!Options} A self reference.
-   */
-  excludeSwitches(...args) {
-    let switches = (this.options_.excludeSwitches || []).concat(...args);
-    if (switches.length) {
-      this.options_.excludeSwitches = switches;
-    }
-    return this;
-  }
-
-  /**
-   * Add additional extensions to install when launching Chrome. Each extension
-   * should be specified as the path to the packed CRX file, or a Buffer for an
-   * extension.
-   * @param {...(string|!Buffer|!Array<(string|!Buffer)>)} args The
-   *     extensions to add.
-   * @return {!Options} A self reference.
-   */
-  addExtensions(...args) {
-    let current = this.options_.extensions || [];
-    this.options_.extensions = current.concat(...args);
-    return this;
-  }
-
+class Options extends chromium.Options {
   /**
    * Sets the path to the Chrome binary to use. On Mac OS X, this path should
    * reference the actual Chrome executable, not just the application binary
@@ -441,98 +231,7 @@ class Options extends Capabilities {
    * @return {!Options} A self reference.
    */
   setChromeBinaryPath(path) {
-    this.options_.binary = path;
-    return this;
-  }
-
-  /**
-   * Sets whether to leave the started Chrome browser running if the controlling
-   * ChromeDriver service is killed before {@link webdriver.WebDriver#quit()} is
-   * called.
-   * @param {boolean} detach Whether to leave the browser running if the
-   *     chromedriver service is killed before the session.
-   * @return {!Options} A self reference.
-   */
-  detachDriver(detach) {
-    this.options_.detach = detach;
-    return this;
-  }
-
-  /**
-   * Sets the user preferences for Chrome's user profile. See the "Preferences"
-   * file in Chrome's user data directory for examples.
-   * @param {!Object} prefs Dictionary of user preferences to use.
-   * @return {!Options} A self reference.
-   */
-  setUserPreferences(prefs) {
-    this.options_.prefs = prefs;
-    return this;
-  }
-
-  /**
-   * Sets the performance logging preferences. Options include:
-   *
-   * - `enableNetwork`: Whether or not to collect events from Network domain.
-   * - `enablePage`: Whether or not to collect events from Page domain.
-   * - `enableTimeline`: Whether or not to collect events from Timeline domain.
-   *     Note: when tracing is enabled, Timeline domain is implicitly disabled,
-   *     unless `enableTimeline` is explicitly set to true.
-   * - `tracingCategories`: A comma-separated string of Chrome tracing
-   *     categories for which trace events should be collected. An unspecified
-   *     or empty string disables tracing.
-   * - `bufferUsageReportingInterval`: The requested number of milliseconds
-   *     between DevTools trace buffer usage events. For example, if 1000, then
-   *     once per second, DevTools will report how full the trace buffer is. If
-   *     a report indicates the buffer usage is 100%, a warning will be issued.
-   *
-   * @param {{enableNetwork: boolean,
-   *          enablePage: boolean,
-   *          enableTimeline: boolean,
-   *          tracingCategories: string,
-   *          bufferUsageReportingInterval: number}} prefs The performance
-   *     logging preferences.
-   * @return {!Options} A self reference.
-   */
-  setPerfLoggingPrefs(prefs) {
-    this.options_.perfLoggingPrefs = prefs;
-    return this;
-  }
-
-  /**
-   * Sets preferences for the "Local State" file in Chrome's user data
-   * directory.
-   * @param {!Object} state Dictionary of local state preferences.
-   * @return {!Options} A self reference.
-   */
-  setLocalState(state) {
-    this.options_.localState = state;
-    return this;
-  }
-
-  /**
-   * Sets the name of the activity hosting a Chrome-based Android WebView. This
-   * option must be set to connect to an [Android WebView](
-   * https://sites.google.com/a/chromium.org/chromedriver/getting-started/getting-started---android)
-   *
-   * @param {string} name The activity name.
-   * @return {!Options} A self reference.
-   */
-  androidActivity(name) {
-    this.options_.androidActivity = name;
-    return this;
-  }
-
-  /**
-   * Sets the device serial number to connect to via ADB. If not specified, the
-   * ChromeDriver will select an unused device at random. An error will be
-   * returned if all devices already have active sessions.
-   *
-   * @param {string} serial The device serial number to connect to.
-   * @return {!Options} A self reference.
-   */
-  androidDeviceSerial(serial) {
-    this.options_.androidDeviceSerial = serial;
-    return this;
+    return this.setBinaryPath(path);
   }
 
   /**
@@ -545,44 +244,6 @@ class Options extends Capabilities {
     return this.androidPackage('com.android.chrome');
   }
 
-  /**
-   * Sets the package name of the Chrome or WebView app.
-   *
-   * @param {?string} pkg The package to connect to, or `null` to disable Android
-   *     and switch back to using desktop Chrome.
-   * @return {!Options} A self reference.
-   */
-  androidPackage(pkg) {
-    this.options_.androidPackage = pkg;
-    return this;
-  }
-
-  /**
-   * Sets the process name of the Activity hosting the WebView (as given by
-   * `ps`). If not specified, the process name is assumed to be the same as
-   * {@link #androidPackage}.
-   *
-   * @param {string} processName The main activity name.
-   * @return {!Options} A self reference.
-   */
-  androidProcess(processName) {
-    this.options_.androidProcess = processName;
-    return this;
-  }
-
-  /**
-   * Sets whether to connect to an already-running instead of the specified
-   * {@linkplain #androidProcess app} instead of launching the app with a clean
-   * data directory.
-   *
-   * @param {boolean} useRunning Whether to connect to a running instance.
-   * @return {!Options} A self reference.
-   */
-  androidUseRunningApp(useRunning) {
-    this.options_.androidUseRunningApp = useRunning;
-    return this;
-  }
-
   /**
    * Sets the path to Chrome's log file. This path should exist on the machine
    * that will launch Chrome.
@@ -590,8 +251,7 @@ class Options extends Capabilities {
    * @return {!Options} A self reference.
    */
   setChromeLogFile(path) {
-    this.options_.logPath = path;
-    return this;
+    return this.setBrowserLogFile(path);
   }
 
   /**
@@ -601,79 +261,18 @@ class Options extends Capabilities {
    * @return {!Options} A self reference.
    */
   setChromeMinidumpPath(path) {
-    this.options_.minidumpPath = path;
-    return this;
-  }
-
-  /**
-   * Configures Chrome to emulate a mobile device. For more information, refer
-   * to the ChromeDriver project page on [mobile emulation][em]. Configuration
-   * options include:
-   *
-   * - `deviceName`: The name of a pre-configured [emulated device][devem]
-   * - `width`: screen width, in pixels
-   * - `height`: screen height, in pixels
-   * - `pixelRatio`: screen pixel ratio
-   *
-   * __Example 1: Using a Pre-configured Device__
-   *
-   *     let options = new chrome.Options().setMobileEmulation(
-   *         {deviceName: 'Google Nexus 5'});
-   *
-   *     let driver = chrome.Driver.createSession(options);
-   *
-   * __Example 2: Using Custom Screen Configuration__
-   *
-   *     let options = new chrome.Options().setMobileEmulation({
-   *         width: 360,
-   *         height: 640,
-   *         pixelRatio: 3.0
-   *     });
-   *
-   *     let driver = chrome.Driver.createSession(options);
-   *
-   *
-   * [em]: https://sites.google.com/a/chromium.org/chromedriver/mobile-emulation
-   * [devem]: https://developer.chrome.com/devtools/docs/device-mode
-   *
-   * @param {?({deviceName: string}|
-   *           {width: number, height: number, pixelRatio: number})} config The
-   *     mobile emulation configuration, or `null` to disable emulation.
-   * @return {!Options} A self reference.
-   */
-  setMobileEmulation(config) {
-    this.options_.mobileEmulation = config;
-    return this;
-  }
-
-  /**
-   * Converts this instance to its JSON wire protocol representation. Note this
-   * function is an implementation not intended for general use.
-   *
-   * @return {!Object} The JSON wire protocol representation of this instance.
-   * @suppress {checkTypes} Suppress [] access on a struct.
-   */
-  [Symbols.serialize]() {
-    if (this.options_.extensions &&  this.options_.extensions.length) {
-      this.options_.extensions =
-          this.options_.extensions.map(function(extension) {
-            if (Buffer.isBuffer(extension)) {
-              return extension.toString('base64');
-            }
-            return io.read(/** @type {string} */(extension))
-                .then(buffer => buffer.toString('base64'));
-          });
-    }
-    return super[Symbols.serialize]();
+    return this.setBrowserMinidumpPath(path);
   }
 }
 
+Options.prototype.CAPABILITY_KEY = 'goog:chromeOptions';
+Options.prototype.BROWSER_NAME_VALUE = Browser.CHROME;
+
 
 /**
  * Creates a new WebDriver client for Chrome.
  */
-class Driver extends webdriver.WebDriver {
-
+class Driver extends chromium.Driver {
   /**
    * Creates a new session with the ChromeDriver.
    *
@@ -686,121 +285,14 @@ class Driver extends webdriver.WebDriver {
    * @return {!Driver} A new driver instance.
    */
   static createSession(opt_config, opt_serviceExecutor) {
-    let executor;
-    if (opt_serviceExecutor instanceof http.Executor) {
-      executor = opt_serviceExecutor;
-      configureExecutor(executor);
-    } else {
-      let service = opt_serviceExecutor || getDefaultService();
-      executor = createExecutor(service.start());
-    }
-
-    let caps = opt_config || Capabilities.chrome();
-
-    // W3C spec requires noProxy value to be an array of strings, but Chrome
-    // expects a single host as a string.
-    let proxy = caps.get(Capability.PROXY);
-    if (proxy && Array.isArray(proxy.noProxy)) {
-      proxy.noProxy = proxy.noProxy[0];
-      if (!proxy.noProxy) {
-        proxy.noProxy = undefined;
-      }
-    }
-
-    return /** @type {!Driver} */(super.createSession(executor, caps));
-  }
-
-  /**
-   * This function is a no-op as file detectors are not supported by this
-   * implementation.
-   * @override
-   */
-  setFileDetector() {}
-
-  /**
-   * Schedules a command to launch Chrome App with given ID.
-   * @param {string} id ID of the App to launch.
-   * @return {!Promise<void>} A promise that will be resolved
-   *     when app is launched.
-   */
-  launchApp(id) {
-    return this.execute(
-        new command.Command(Command.LAUNCH_APP).setParameter('id', id));
-  }
-
-  /**
-   * Schedules a command to get Chrome network emulation settings.
-   * @return {!Promise} A promise that will be resolved when network
-   *     emulation settings are retrievied.
-   */
-  getNetworkConditions() {
-    return this.execute(new command.Command(Command.GET_NETWORK_CONDITIONS));
-  }
-
-  /**
-   * Schedules a command to set Chrome network emulation settings.
-   *
-   * __Sample Usage:__
-   *
-   *  driver.setNetworkConditions({
-   *    offline: false,
-   *    latency: 5, // Additional latency (ms).
-   *    download_throughput: 500 * 1024, // Maximal aggregated download throughput.
-   *    upload_throughput: 500 * 1024 // Maximal aggregated upload throughput.
-   * });
-   *
-   * @param {Object} spec Defines the network conditions to set
-   * @return {!Promise<void>} A promise that will be resolved when network
-   *     emulation settings are set.
-   */
-  setNetworkConditions(spec) {
-    if (!spec || typeof spec !== 'object') {
-      throw TypeError('setNetworkConditions called with non-network-conditions parameter');
-    }
-    return this.execute(
-        new command.Command(Command.SET_NETWORK_CONDITIONS)
-            .setParameter('network_conditions', spec));
-  }
-
-  /**
-   * Sends an arbitrary devtools command to the browser.
-   *
-   * @param {string} cmd The name of the command to send.
-   * @param {Object=} params The command parameters.
-   * @return {!Promise<void>} A promise that will be resolved when the command
-   *     has finished.
-   * @see <https://chromedevtools.github.io/devtools-protocol/>
-   */
-  sendDevToolsCommand(cmd, params = {}) {
-    return this.execute(
-        new command.Command(Command.SEND_DEVTOOLS_COMMAND)
-            .setParameter('cmd', cmd)
-            .setParameter('params', params));
-  }
-
-  /**
-   * Sends a DevTools command to change Chrome's download directory.
-   *
-   * @param {string} path The desired download directory.
-   * @return {!Promise<void>} A promise that will be resolved when the command
-   *     has finished.
-   * @see #sendDevToolsCommand
-   */
-  async setDownloadPath(path) {
-    if (!path || typeof path !== 'string') {
-      throw new error.InvalidArgumentError('invalid download path');
-    }
-    const stat = await io.stat(path);
-    if (!stat.isDirectory()) {
-      throw new error.InvalidArgumentError('not a directory: ' + path);
-    }
-    return this.sendDevToolsCommand('Page.setDownloadBehavior', {
-      'behavior': 'allow',
-      'downloadPath': path
-    });
+    let caps = opt_config || new Options();
+    return /** @type {!Driver} */(super.createSession(caps, opt_serviceExecutor));
   }
 }
 
+Driver.getDefaultService = getDefaultService;
+Driver.prototype.VENDOR_COMMAND_PREFIX = "goog";
+
 
 // PUBLIC API