selenium-webdriver 4.1.1 → 4.1.2

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/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.
    *

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/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/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) => {
@@ -363,7 +364,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
 }
 
 /**
@@ -609,5 +610,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',
 }
 
 /**
@@ -347,8 +349,14 @@ class Pointer extends Device {
    * @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 +385,16 @@ 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 +408,34 @@ Pointer.Type = {
   TOUCH: 'touch',
 }
 
+class Wheel extends Device {
+  /**
+   * @param {string} id the device ID.
+   * @param {Pointer.Type} type the pointer type.
+   */
+  constructor(id, type) {
+    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 {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 +553,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 +574,11 @@ class Actions {
     return this.mouse_
   }
 
+  /** @return {!Wheel} the wheel device handle. */
+  wheel() {
+    return this.wheel_
+  }
+
   /**
    * @param {!Device} device
    * @return {!Array<!Action>}
@@ -735,6 +788,19 @@ 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 {!Action} 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

package/lib/webdriver.js

@@ -1197,14 +1197,25 @@ class WebDriver {
    * @return {!Promise<resolved>} A new CDP instance.
    */
   async createCDPConnection(target) {
+    let debuggerUrl = null
+
     const caps = await this.getCapabilities()
-    const seCdp = caps['map_'].get('se:cdp')
-    const vendorInfo =
-      caps['map_'].get(this.VENDOR_COMMAND_PREFIX + ':chromeOptions') ||
-      caps['map_'].get(this.VENDOR_CAPABILITY_PREFIX + ':edgeOptions') ||
-      caps['map_'].get('moz:debuggerAddress') ||
-      new Map()
-    const debuggerUrl = seCdp || vendorInfo['debuggerAddress'] || vendorInfo
+
+    if (process.env.SELENIUM_REMOTE_URL) {
+      const host = new URL(process.env.SELENIUM_REMOTE_URL).host
+      const sessionId = await this.getSession().then((session) =>
+        session.getId()
+      )
+      debuggerUrl = `ws://${host}/session/${sessionId}/se/cdp`
+    } else {
+      const seCdp = caps['map_'].get('se:cdp')
+      const vendorInfo =
+        caps['map_'].get(this.VENDOR_COMMAND_PREFIX + ':chromeOptions') ||
+        caps['map_'].get(this.VENDOR_CAPABILITY_PREFIX + ':edgeOptions') ||
+        caps['map_'].get('moz:debuggerAddress') ||
+        new Map()
+      debuggerUrl = seCdp || vendorInfo['debuggerAddress'] || vendorInfo
+    }
     this._wsUrl = await this.getWsUrl(debuggerUrl, target, caps)
     return new Promise((resolve, reject) => {
       try {
@@ -1945,14 +1956,10 @@ class Window {
    * @return {!Promise<{x: number, y: number, width: number, height: number}>}
    *     A promise that will resolve to the window rect of the current window.
    */
-  async getRect() {
-    try {
-      return await this.driver_.execute(
-        new command.Command(command.Name.GET_WINDOW_RECT)
-      )
-    } catch (ex) {
-      throw ex
-    }
+  getRect() {
+    return this.driver_.execute(
+      new command.Command(command.Name.GET_WINDOW_RECT)
+    )
   }
 
   /**
@@ -1969,19 +1976,15 @@ class Window {
    *     A promise that will resolve to the current window's updated window
    *     rect.
    */
-  async setRect({ x, y, width, height }) {
-    try {
-      return await this.driver_.execute(
-        new command.Command(command.Name.SET_WINDOW_RECT).setParameters({
-          x,
-          y,
-          width,
-          height,
-        })
-      )
-    } catch (ex) {
-      throw ex
-    }
+  setRect({ x, y, width, height }) {
+    return this.driver_.execute(
+      new command.Command(command.Name.SET_WINDOW_RECT).setParameters({
+        x,
+        y,
+        width,
+        height,
+      })
+    )
   }
 
   /**
@@ -2522,12 +2525,12 @@ class WebElement {
       if (type === 'number') {
         key = String(key)
       } else if (type !== 'string') {
-        throw TypeError('each key must be a number of string; got ' + type)
+        throw TypeError('each key must be a number or string; got ' + type)
       }
 
       // The W3C protocol requires keys to be specified as an array where
       // each element is a single key.
-      keys.push(...key.split(''))
+      keys.push(...key)
     })
 
     if (!this.driver_.fileDetector_) {
@@ -2544,7 +2547,10 @@ class WebElement {
         keys.join('')
       )
     } catch (ex) {
-      console.log('Error trying parse string as a file with file detector; sending keys instead' + ex)
+      console.log(
+        'Error trying parse string as a file with file detector; sending keys instead' +
+          ex
+      )
     }
 
     return this.execute_(
@@ -2715,14 +2721,8 @@ class WebElement {
    * @return {!Promise<{width: number, height: number, x: number, y: number}>}
    *     A promise that will resolve with the element's rect.
    */
-  async getRect() {
-    try {
-      return await this.execute_(
-        new command.Command(command.Name.GET_ELEMENT_RECT)
-      )
-    } catch (err) {
-        throw err;
-    }
+  getRect() {
+    return this.execute_(new command.Command(command.Name.GET_ELEMENT_RECT))
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "4.1.1",
+  "version": "4.1.2",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [
@@ -35,7 +35,7 @@
     "eslint-plugin-prettier": "^3.4.0",
     "express": "^4.17.1",
     "jasmine": "^3.8.0",
-    "mocha": "^8.1.0",
+    "mocha": "^9.2.2",
     "multer": "^1.4.2",
     "prettier": "^2.3.0",
     "serve-index": "^1.9.1",