selenium-webdriver 4.1.1 → 4.3.0

package/README.md

@@ -33,10 +33,10 @@ The sample below and others are included in the `example` directory. You may
 also find the tests for selenium-webdriver informative.
 
 ```javascript
-const {Builder, By, Key, until} = require('selenium-webdriver');
+const {Builder, Browser, By, Key, until} = require('selenium-webdriver');
 
 (async function example() {
-  let driver = await new Builder().forBrowser('firefox').build();
+  let driver = await new Builder().forBrowser(Browser.FIREFOX).build();
   try {
     await driver.get('http://www.google.com/ncr');
     await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN);
@@ -60,7 +60,7 @@ const chrome = require('selenium-webdriver/chrome');
 const firefox = require('selenium-webdriver/firefox');
 
 let driver = new webdriver.Builder()
-    .forBrowser('firefox')
+    .forBrowser(webdriver.Browser.FIREFOX)
     .setChromeOptions(/* ... */)
     .setFirefoxOptions(/* ... */)
     .build();
@@ -99,7 +99,7 @@ API:
 
 ```javascript
 let driver = new webdriver.Builder()
-    .forBrowser('firefox')
+    .forBrowser(webdriver.Browser.FIREFOX)
     .usingServer('http://localhost:4444/wd/hub')
     .build();
 ```

package/chrome.js

@@ -290,9 +290,8 @@ Driver.prototype.VENDOR_COMMAND_PREFIX = 'goog'
 module.exports = {
   Driver: Driver,
   Options,
-  ServiceBuilder ,
+  ServiceBuilder,
   getDefaultService,
   setDefaultService,
-  locateSynchronously
+  locateSynchronously,
 }
-

package/chromium.js

@@ -92,6 +92,7 @@ const Command = {
   LAUNCH_APP: 'launchApp',
   GET_NETWORK_CONDITIONS: 'getNetworkConditions',
   SET_NETWORK_CONDITIONS: 'setNetworkConditions',
+  DELETE_NETWORK_CONDITIONS: 'deleteNetworkConditions',
   SEND_DEVTOOLS_COMMAND: 'sendDevToolsCommand',
   SEND_AND_GET_DEVTOOLS_COMMAND: 'sendAndGetDevToolsCommand',
   SET_PERMISSION: 'setPermission',
@@ -137,6 +138,11 @@ function configureExecutor(executor, vendorPrefix) {
     'POST',
     '/session/:sessionId/chromium/network_conditions'
   )
+  executor.defineCommand(
+    Command.DELETE_NETWORK_CONDITIONS,
+    'DELETE',
+    '/session/:sessionId/chromium/network_conditions'
+  )
   executor.defineCommand(
     Command.SEND_DEVTOOLS_COMMAND,
     'POST',
@@ -655,14 +661,12 @@ class Driver extends webdriver.WebDriver {
    */
   static createSession(caps, opt_serviceExecutor) {
     let executor
-    let onQuit
     if (opt_serviceExecutor instanceof http.Executor) {
       executor = opt_serviceExecutor
       configureExecutor(executor, this.VENDOR_COMMAND_PREFIX)
     } else {
       let service = opt_serviceExecutor || this.getDefaultService()
       executor = createExecutor(service.start(), this.VENDOR_COMMAND_PREFIX)
-      onQuit = () => service.kill()
     }
 
     // W3C spec requires noProxy value to be an array of strings, but Chromium
@@ -675,7 +679,7 @@ class Driver extends webdriver.WebDriver {
       }
     }
 
-    return /** @type {!Driver} */ (super.createSession(executor, caps, onQuit))
+    return /** @type {!Driver} */ (super.createSession(executor, caps))
   }
 
   /**
@@ -706,6 +710,15 @@ class Driver extends webdriver.WebDriver {
     return this.execute(new command.Command(Command.GET_NETWORK_CONDITIONS))
   }
 
+  /**
+   * Schedules a command to delete Chromium network emulation settings.
+   * @return {!Promise} A promise that will be resolved when network
+   *     emulation settings have been deleted.
+   */
+  deleteNetworkConditions() {
+    return this.execute(new command.Command(Command.DELETE_NETWORK_CONDITIONS))
+  }
+
   /**
    * Schedules a command to set Chromium network emulation settings.
    *
@@ -847,7 +860,7 @@ class Driver extends webdriver.WebDriver {
    * @return {!promise.Thenable<void>} A promise that will be resolved
    *     when the mirror command has been issued to the device.
    */
-   startDesktopMirroring(deviceName) {
+  startDesktopMirroring(deviceName) {
     return this.schedule(
       new command.Command(Command.START_CAST_DESKTOP_MIRRORING).setParameter(
         'sinkName',

package/devtools/CDPConnection.js

@@ -19,7 +19,7 @@ class CDPConnection {
   constructor(wsConnection) {
     this._wsConnection = wsConnection
     this.cmd_id = 0
-    this.targetID = null;
+    this.targetID = null
     this.sessionId = null
   }
 

package/edge.js

@@ -94,7 +94,7 @@ let defaultService = null
 
 /**
  * Creates {@link selenium-webdriver/remote.DriverService} instances that manage
- * a [ChromeDriver](https://chromedriver.chromium.org/)
+ * a [MSEdgeDriver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/)
  * server in a child process.
  */
 class ServiceBuilder extends chromium.ServiceBuilder {
@@ -130,7 +130,7 @@ class Options extends chromium.Options {
    * The binary path be absolute or relative to the msedgedriver server
    * executable, but it must exist on the machine that will launch edge chromium.
    *
-   * @param {string} path The path to the edgedriver binary to use.
+   * @param {string} path The path to the msedgedriver binary to use.
    * @return {!Options} A self reference.
    */
   setEdgeChromiumBinaryPath(path) {

package/firefox.js

@@ -672,7 +672,7 @@ class Driver extends webdriver.WebDriver {
    */
   async installAddon(path, temporary = false) {
     let stats = fs.statSync(path)
-    let buf;
+    let buf
     if (stats.isDirectory()) {
       let zip = new Zip()
       await zip.addDir(path)

package/ie.js

@@ -402,9 +402,9 @@ function createServiceFromCapabilities(capabilities) {
   if (!exe || !fs.existsSync(exe)) {
     throw Error(
       `${IEDRIVER_EXE} could not be found on the current PATH. Please ` +
-      `download the latest version of ${IEDRIVER_EXE} from ` +
-      'https://www.selenium.dev/downloads/ and ' +
-      'ensure it can be found on your system PATH.'
+        `download the latest version of ${IEDRIVER_EXE} from ` +
+        'https://www.selenium.dev/downloads/ and ' +
+        'ensure it can be found on your system PATH.'
     )
   }
 

package/index.js

@@ -38,7 +38,6 @@ const safari = require('./safari')
 const session = require('./lib/session')
 const until = require('./lib/until')
 const webdriver = require('./lib/webdriver')
-const opera = require('./opera')
 
 const Browser = capabilities.Browser
 const Capabilities = capabilities.Capabilities
@@ -78,7 +77,7 @@ function startSeleniumServer(jar) {
 function ensureFileDetectorsAreEnabled(ctor) {
   return class extends ctor {
     /** @param {input.FileDetector} detector */
-    setFileDetector (detector) {
+    setFileDetector(detector) {
       webdriver.WebDriver.prototype.setFileDetector.call(this, detector)
     }
   }
@@ -232,12 +231,6 @@ class Builder {
 
     /** @private {http.Agent} */
     this.agent_ = null
-
-    /** @private {opera.Options} */
-    this.operaOptions_ = null
-
-    /** @private {remote.DriverService.Builder} */
-    this.operaService_ = null
   }
 
   /**
@@ -432,20 +425,6 @@ class Builder {
     return this
   }
 
-  /**
-   * Sets Opera specific {@linkplain opera.Options options} for drivers
-   * created by this builder. Any logging or proxy settings defined on the given
-   * options will take precedence over those set through
-   * {@link #setLoggingPrefs} and {@link #setProxy}, respectively.
-   *
-   * @param {!opera.Options} options The OperaDriver options to use.
-   * @return {!Builder} A self reference.
-   */
-  setOperaOptions(options) {
-    this.operaOptions_ = options
-    return this
-  }
-
   /**
    * @return {chrome.Options} the Chrome specific options currently configured
    *     for this builder.
@@ -560,21 +539,6 @@ class Builder {
     return this
   }
 
-  /**
-   * Sets the {@link opera.ServiceBuilder} to use to manage the
-   * operaDriver child process when creating sessions locally.
-   *
-   * @param {opera.ServiceBuilder} service the service to use.
-   * @return {!Builder} a self reference.
-   */
-  setOperaService(service) {
-    if (service && !(service instanceof opera.ServiceBuilder)) {
-      throw TypeError('not a opera.ServiceBuilder object')
-    }
-    this.operaService_ = service
-    return this
-  }
-
   /**
    * Sets Safari specific {@linkplain safari.Options options} for drivers
    * created by this builder. Any logging settings defined on the given options
@@ -648,8 +612,6 @@ class Builder {
       capabilities.merge(this.safariOptions_)
     } else if (browser === Browser.EDGE && this.edgeOptions_) {
       capabilities.merge(this.edgeOptions_)
-    } else if (browser === Browser.OPERA && this.operaOptions_) {
-      capabilities.merge(this.operaOptions_)
     }
 
     checkOptions(
@@ -736,14 +698,6 @@ class Builder {
         return createDriver(edge.Driver, capabilities, service)
       }
 
-      case Browser.OPERA: {
-        let service = null
-        if (this.operaService_) {
-          service = this.operaService_.build()
-        }
-        return createDriver(opera.Driver, capabilities, service)
-      }
-
       case Browser.SAFARI:
         return createDriver(safari.Driver, capabilities)
 

package/lib/by.js

@@ -225,7 +225,7 @@ class By {
    * @return {!By} The new locator.
    */
   static tagName(name) {
-    return By.css(name)
+    return new By('tag name', name)
   }
 
   /**

package/lib/capabilities.js

@@ -34,7 +34,6 @@ const Browser = {
   FIREFOX: 'firefox',
   INTERNET_EXPLORER: 'internet explorer',
   SAFARI: 'safari',
-  OPERA: 'opera',
 }
 
 /**
@@ -282,13 +281,6 @@ class Capabilities {
     return new Capabilities().setBrowserName(Browser.SAFARI)
   }
 
-  /**
-   * @return {!Capabilities} A basic set of capabilities for Opera
-   */
-  static opera() {
-    return new Capabilities().setBrowserName(Browser.OPERA)
-  }
-
   /**
    * @return {!Object<string, ?>} The JSON representation of this instance.
    *     Note, the returned object may contain nested promised values.

package/lib/command.js

@@ -164,6 +164,15 @@ const Name = {
   FIND_ELEMENT_FROM_SHADOWROOT: 'findElementFromShadowRoot',
   FIND_ELEMENTS_FROM_SHADOWROOT: 'findElementsFromShadowRoot',
 
+  // Virtual Authenticator Commands
+  ADD_VIRTUAL_AUTHENTICATOR: 'addVirtualAuthenticator',
+  REMOVE_VIRTUAL_AUTHENTICATOR: 'removeVirtualAuthenticator',
+  ADD_CREDENTIAL: 'addCredential',
+  GET_CREDENTIALS: 'getCredentials',
+  REMOVE_CREDENTIAL: 'removeCredential',
+  REMOVE_ALL_CREDENTIALS: 'removeAllCredentials',
+  SET_USER_VERIFIED: 'setUserVerified',
+
   GET_AVAILABLE_LOG_TYPES: 'getAvailableLogTypes',
   GET_LOG: 'getLog',
 

package/lib/http.js

@@ -63,8 +63,8 @@ function requireAtom(module, bazelTarget) {
       console.log(ex2)
       throw Error(
         `Failed to import atoms module ${module}. If running in dev mode, you` +
-        ` need to run \`bazel build ${bazelTarget}\` from the project` +
-        `root: ${ex}`
+          ` need to run \`bazel build ${bazelTarget}\` from the project` +
+          `root: ${ex}`
       )
     }
   }
@@ -197,7 +197,6 @@ function toExecuteAtomCommand(command, atom, ...params) {
 
 /** @const {!Map<string, (CommandSpec|CommandTransformer)>} */
 const W3C_COMMAND_MAP = new Map([
-
   // Session management.
   [cmd.Name.NEW_SESSION, post('/session')],
   [cmd.Name.QUIT, del('/session/:sessionId')],
@@ -245,7 +244,6 @@ const W3C_COMMAND_MAP = new Map([
   [cmd.Name.CLEAR_ACTIONS, del('/session/:sessionId/actions')],
   [cmd.Name.PRINT_PAGE, post('/session/:sessionId/print')],
 
-
   // Locating elements.
   [cmd.Name.GET_ACTIVE_ELEMENT, get('/session/:sessionId/element/active')],
   [cmd.Name.FIND_ELEMENT, post('/session/:sessionId/element')],
@@ -266,7 +264,10 @@ const W3C_COMMAND_MAP = new Map([
   ],
   // Element interaction.
   [cmd.Name.GET_ELEMENT_TAG_NAME, get('/session/:sessionId/element/:id/name')],
-  [cmd.Name.GET_DOM_ATTRIBUTE, get('/session/:sessionId/element/:id/attribute/:name')],
+  [
+    cmd.Name.GET_DOM_ATTRIBUTE,
+    get('/session/:sessionId/element/:id/attribute/:name'),
+  ],
   [
     cmd.Name.GET_ELEMENT_ATTRIBUTE,
     (cmd) => {
@@ -346,6 +347,44 @@ const W3C_COMMAND_MAP = new Map([
 
   // Server Extensions
   [cmd.Name.UPLOAD_FILE, post('/session/:sessionId/se/file')],
+
+  // Virtual Authenticator
+  [
+    cmd.Name.ADD_VIRTUAL_AUTHENTICATOR,
+    post('/session/:sessionId/webauthn/authenticator'),
+  ],
+  [
+    cmd.Name.REMOVE_VIRTUAL_AUTHENTICATOR,
+    del('/session/:sessionId/webauthn/authenticator/:authenticatorId'),
+  ],
+  [
+    cmd.Name.ADD_CREDENTIAL,
+    post(
+      '/session/:sessionId/webauthn/authenticator/:authenticatorId/credential'
+    ),
+  ],
+  [
+    cmd.Name.GET_CREDENTIALS,
+    get(
+      '/session/:sessionId/webauthn/authenticator/:authenticatorId/credentials'
+    ),
+  ],
+  [
+    cmd.Name.REMOVE_CREDENTIAL,
+    del(
+      '/session/:sessionId/webauthn/authenticator/:authenticatorId/credentials/:credentialId'
+    ),
+  ],
+  [
+    cmd.Name.REMOVE_ALL_CREDENTIALS,
+    del(
+      '/session/:sessionId/webauthn/authenticator/:authenticatorId/credentials'
+    ),
+  ],
+  [
+    cmd.Name.SET_USER_VERIFIED,
+    post('/session/:sessionId/webauthn/authenticator/:authenticatorId/uv'),
+  ],
 ])
 
 /**
@@ -363,7 +402,7 @@ class Client {
    * @return {!Promise<Response>} A promise that will be fulfilled with the
    *     server's response.
    */
-  send(httpRequest) { } // eslint-disable-line
+  send(httpRequest) {} // eslint-disable-line
 }
 
 /**
@@ -471,6 +510,7 @@ class Executor {
     this.log_.finer(() => `>>>\n${request}\n<<<\n${response}`)
 
     let httpResponse = /** @type {!Response} */ (response)
+
     let { isW3C, value } = parseHttpResponse(command, httpResponse)
 
     if (command.getName() === cmd.Name.NEW_SESSION) {
@@ -529,6 +569,7 @@ function parseHttpResponse(command, httpResponse) {
   }
 
   let parsed = tryParse(httpResponse.body)
+
   if (parsed && typeof parsed === 'object') {
     let value = parsed.value
     let isW3C =
@@ -609,5 +650,5 @@ module.exports = {
   Request: Request,
   Response: Response,
   // Exported for testing.
-  buildPath: buildPath
+  buildPath: buildPath,
 }

package/lib/input.js

@@ -200,6 +200,7 @@ Action.Type = {
   POINTER_UP: 'pointerUp',
   POINTER_MOVE: 'pointerMove',
   POINTER_CANCEL: 'pointerCancel',
+  SCROLL: 'scroll',
 }
 
 /**
@@ -233,6 +234,7 @@ Device.Type = {
   KEY: 'key',
   NONE: 'none',
   POINTER: 'pointer',
+  WHEEL: 'wheel',
 }
 
 /**
@@ -344,11 +346,43 @@ class Pointer extends Device {
 
   /**
    * @param {!Button=} button The button to press.
+   * @param width
+   * @param height
+   * @param pressure
+   * @param tangentialPressure
+   * @param tiltX
+   * @param tiltY
+   * @param twist
+   * @param altitudeAngle
+   * @param azimuthAngle
    * @return {!Action} An action to press the specified button with this device.
    * @package
    */
-  press(button = Button.LEFT) {
-    return { type: Action.Type.POINTER_DOWN, button }
+  press(
+    button = Button.LEFT,
+    width = 0,
+    height = 0,
+    pressure = 0,
+    tangentialPressure = 0,
+    tiltX = 0,
+    tiltY = 0,
+    twist = 0,
+    altitudeAngle = 0,
+    azimuthAngle = 0
+  ) {
+    return {
+      type: Action.Type.POINTER_DOWN,
+      button,
+      width,
+      height,
+      pressure,
+      tangentialPressure,
+      tiltX,
+      tiltY,
+      twist,
+      altitudeAngle,
+      azimuthAngle,
+    }
   }
 
   /**
@@ -377,8 +411,37 @@ class Pointer extends Device {
    * @return {!Action} The new action.
    * @package
    */
-  move({ x = 0, y = 0, duration = 100, origin = Origin.VIEWPORT }) {
-    return { type: Action.Type.POINTER_MOVE, origin, duration, x, y }
+  move({
+    x = 0,
+    y = 0,
+    duration = 100,
+    origin = Origin.VIEWPORT,
+    width = 0,
+    height = 0,
+    pressure = 0,
+    tangentialPressure = 0,
+    tiltX = 0,
+    tiltY = 0,
+    twist = 0,
+    altitudeAngle = 0,
+    azimuthAngle = 0,
+  }) {
+    return {
+      type: Action.Type.POINTER_MOVE,
+      origin,
+      duration,
+      x,
+      y,
+      width,
+      height,
+      pressure,
+      tangentialPressure,
+      tiltX,
+      tiltY,
+      twist,
+      altitudeAngle,
+      azimuthAngle,
+    }
   }
 }
 
@@ -392,6 +455,37 @@ Pointer.Type = {
   TOUCH: 'touch',
 }
 
+class Wheel extends Device {
+  /**
+   * @param {string} id the device ID..
+   */
+  constructor(id) {
+    super(Device.Type.WHEEL, id)
+  }
+
+  /**
+   * Scrolls a page via the coordinates given
+   * @param {number} x starting x coordinate
+   * @param {number} y starting y coordinate
+   * @param {number} deltaX Delta X to scroll to target
+   * @param {number} deltaY Delta Y to scroll to target
+   * @param {WebElement} origin element origin
+   * @param {number} duration duration ratio be the ratio of time delta and duration
+   * @returns {!Action} An action to scroll with this device.
+   */
+  scroll(x, y, deltaX, deltaY, origin, duration) {
+    return {
+      type: Action.Type.SCROLL,
+      duration: duration,
+      x: x,
+      y: y,
+      deltaX: deltaX,
+      deltaY: deltaY,
+      origin: origin,
+    }
+  }
+}
+
 /**
  * User facing API for generating complex user gestures. This class should not
  * be instantiated directly. Instead, users should create new instances by
@@ -509,10 +603,14 @@ class Actions {
     /** @private @const */
     this.mouse_ = new Pointer('default mouse', Pointer.Type.MOUSE)
 
+    /** @private @const */
+    this.wheel_ = new Wheel('default wheel')
+
     /** @private @const {!Map<!Device, !Array<!Action>>} */
     this.sequences_ = new Map([
       [this.keyboard_, []],
       [this.mouse_, []],
+      [this.wheel_, []],
     ])
   }
 
@@ -526,6 +624,11 @@ class Actions {
     return this.mouse_
   }
 
+  /** @return {!Wheel} the wheel device handle. */
+  wheel() {
+    return this.wheel_
+  }
+
   /**
    * @param {!Device} device
    * @return {!Array<!Action>}
@@ -735,6 +838,22 @@ class Actions {
     return this.insert(this.mouse_, this.mouse_.release(button))
   }
 
+  /**
+   * scrolls a page via the coordinates given
+   * @param {number} x starting x coordinate
+   * @param {number} y starting y coordinate
+   * @param {number} deltax delta x to scroll to target
+   * @param {number} deltay delta y to scroll to target
+   * @param {number} duration duration ratio be the ratio of time delta and duration
+   * @returns {!Actions} An action to scroll with this device.
+   */
+  scroll(x, y, targetDeltaX, targetDeltaY, origin, duration) {
+    return this.insert(
+      this.wheel_,
+      this.wheel_.scroll(x, y, targetDeltaX, targetDeltaY, origin, duration)
+    )
+  }
+
   /**
    * Inserts an action for moving the mouse `x` and `y` pixels relative to the
    * specified `origin`. The `origin` may be defined as the mouse's