selenium-webdriver 4.20.0 → 4.21.0

package/CHANGES.md

@@ -1,3 +1,9 @@
+## 4.21.0
+
+- Add CDP for Chrome 125 and remove 122
+- Ensure 'selectVisibleByText' method is same as other languages (#13899)
+- Ensure parity in the locators used by methods (#13902)
+
 ## 4.20.0
 
 - Add CDP for Chrome 124 and remove 121

package/README.md

@@ -218,7 +218,7 @@ 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/
-[chrome]: http://chromedriver.storage.googleapis.com/index.html
+[chrome]: https://googlechromelabs.github.io/chrome-for-testing/#stable
 [gh]: https://github.com/SeleniumHQ/selenium/
 [issues]: https://github.com/SeleniumHQ/selenium/issues
 [edge]: http://go.microsoft.com/fwlink/?LinkId=619687

package/bidi/browsingContext.js

@@ -500,21 +500,18 @@ class BrowsingContext {
    *
    * @param {Locator} locator - The locator object used to locate the nodes.
    * @param {number} [maxNodeCount] - The maximum number of nodes to locate (optional).
-   * @param {string} [ownership] - The ownership type of the nodes (optional).
    * @param {string} [sandbox] - The sandbox name for locating nodes (optional).
    * @param {SerializationOptions} [serializationOptions] - The serialization options for locating nodes (optional).
    * @param {ReferenceValue[]} [startNodes] - The array of start nodes for locating nodes (optional).
    * @returns {Promise<RemoteValue[]>} - A promise that resolves to the arrays of located nodes.
    * @throws {Error} - If the locator is not an instance of Locator.
    * @throws {Error} - If the serializationOptions is provided but not an instance of SerializationOptions.
-   * @throws {Error} - If the ownership is provided but not 'root' or 'none'.
    * @throws {Error} - If the startNodes is provided but not an array of ReferenceValue objects.
    * @throws {Error} - If any of the startNodes is not an instance of ReferenceValue.
    */
   async locateNodes(
     locator,
     maxNodeCount = undefined,
-    ownership = undefined,
     sandbox = undefined,
     serializationOptions = undefined,
     startNodes = undefined,
@@ -527,10 +524,6 @@ class BrowsingContext {
       throw Error(`Pass in SerializationOptions object. Received: ${serializationOptions} `)
     }
 
-    if (ownership !== undefined && !['root', 'none'].includes(ownership)) {
-      throw Error(`Valid types are 'root' and 'none. Received: ${ownership}`)
-    }
-
     if (startNodes !== undefined && !Array.isArray(startNodes)) {
       throw Error(`Pass in an array of ReferenceValue objects. Received: ${startNodes}`)
     }
@@ -549,7 +542,6 @@ class BrowsingContext {
         context: this._id,
         locator: Object.fromEntries(locator.toMap()),
         maxNodeCount: maxNodeCount,
-        ownership: ownership,
         sandbox: sandbox,
         serializationOptions: serializationOptions,
         startNodes: startNodes,
@@ -574,20 +566,13 @@ class BrowsingContext {
    * Locates a single node in the browsing context.
    *
    * @param {Locator} locator - The locator used to find the node.
-   * @param {string} [ownership] - The ownership of the node (optional).
    * @param {string} [sandbox] - The sandbox of the node (optional).
    * @param {SerializationOptions} [serializationOptions] - The serialization options for the node (optional).
    * @param {Array} [startNodes] - The starting nodes for the search (optional).
    * @returns {Promise<RemoteValue>} - A promise that resolves to the located node.
    */
-  async locateNode(
-    locator,
-    ownership = undefined,
-    sandbox = undefined,
-    serializationOptions = undefined,
-    startNodes = undefined,
-  ) {
-    const elements = await this.locateNodes(locator, 1, ownership, sandbox, serializationOptions, startNodes)
+  async locateNode(locator, sandbox = undefined, serializationOptions = undefined, startNodes = undefined) {
+    const elements = await this.locateNodes(locator, 1, sandbox, serializationOptions, startNodes)
     return elements[0]
   }
 

package/lib/select.js

@@ -36,7 +36,7 @@
 
 'use strict'
 
-const { By, escapeCss } = require('./by')
+const { By } = require('./by')
 const error = require('./error')
 
 /**
@@ -146,6 +146,10 @@ class Select {
    * @param {WebElement} element Select WebElement.
    */
   constructor(element) {
+    if (element === null) {
+      throw new Error(`Element must not be null. Please provide a valid <select> element.`)
+    }
+
     this.element = element
 
     this.element.getAttribute('tagName').then(function (tagName) {
@@ -153,6 +157,10 @@ class Select {
         throw new Error(`Select only works on <select> elements`)
       }
     })
+
+    this.element.getAttribute('multiple').then((multiple) => {
+      this.multiple = multiple !== null && multiple !== 'false'
+    })
   }
 
   /**
@@ -216,9 +224,7 @@ class Select {
     let matched = false
     let isMulti = await this.isMultiple()
 
-    let options = await this.element.findElements({
-      css: 'option[value =' + escapeCss(value) + ']',
-    })
+    let options = await this.element.findElements(By.xpath('.//option[@value = ' + escapeQuotes(value) + ']'))
 
     for (let option of options) {
       await this.setSelected(option)
@@ -254,30 +260,46 @@ class Select {
   async selectByVisibleText(text) {
     text = typeof text === 'number' ? text.toString() : text
 
-    const normalized = text
-      .trim() // strip leading and trailing white-space characters
-      .replace(/\s+/, ' ') // replace sequences of whitespace characters by a single space
+    const xpath = './/option[normalize-space(.) = ' + escapeQuotes(text) + ']'
 
-    /**
-     * find option element using xpath
-     */
-    const formatted = /"/.test(normalized)
-      ? 'concat("' + normalized.split('"').join('", \'"\', "') + '")'
-      : `"${normalized}"`
-    const dotFormat = `[. = ${formatted}]`
-    const spaceFormat = `[normalize-space(text()) = ${formatted}]`
-
-    const selections = [
-      `./option${dotFormat}`,
-      `./option${spaceFormat}`,
-      `./optgroup/option${dotFormat}`,
-      `./optgroup/option${spaceFormat}`,
-    ]
-
-    const optionElement = await this.element.findElement({
-      xpath: selections.join('|'),
-    })
-    await this.setSelected(optionElement)
+    const options = await this.element.findElements(By.xpath(xpath))
+
+    for (let option of options) {
+      await this.setSelected(option)
+      if (!(await this.isMultiple())) {
+        return
+      }
+    }
+
+    let matched = Array.isArray(options) && options.length > 0
+
+    if (!matched && text.includes(' ')) {
+      const subStringWithoutSpace = getLongestSubstringWithoutSpace(text)
+      let candidates
+      if ('' === subStringWithoutSpace) {
+        candidates = await this.element.findElements(By.tagName('option'))
+      } else {
+        const xpath = './/option[contains(., ' + escapeQuotes(subStringWithoutSpace) + ')]'
+        candidates = await this.element.findElements(By.xpath(xpath))
+      }
+
+      const trimmed = text.trim()
+
+      for (let option of candidates) {
+        const optionText = await option.getText()
+        if (trimmed === optionText.trim()) {
+          await this.setSelected(option)
+          if (!(await this.isMultiple())) {
+            return
+          }
+          matched = true
+        }
+      }
+    }
+
+    if (!matched) {
+      throw new Error(`Cannot locate option with text: ${text}`)
+    }
   }
 
   /**
@@ -293,7 +315,7 @@ class Select {
    * @returns {Promise<boolean>}
    */
   async isMultiple() {
-    return (await this.element.getAttribute('multiple')) !== null
+    return this.multiple
   }
 
   /**
@@ -353,29 +375,9 @@ class Select {
      */
     text = typeof text === 'number' ? text.toString() : text
 
-    const normalized = text
-      .trim() // strip leading and trailing white-space characters
-      .replace(/\s+/, ' ') // replace sequences of whitespace characters by a single space
-
-    /**
-     * find option element using xpath
-     */
-    const formatted = /"/.test(normalized)
-      ? 'concat("' + normalized.split('"').join('", \'"\', "') + '")'
-      : `"${normalized}"`
-    const dotFormat = `[. = ${formatted}]`
-    const spaceFormat = `[normalize-space(text()) = ${formatted}]`
-
-    const selections = [
-      `./option${dotFormat}`,
-      `./option${spaceFormat}`,
-      `./optgroup/option${dotFormat}`,
-      `./optgroup/option${spaceFormat}`,
-    ]
-
-    const optionElement = await this.element.findElement({
-      xpath: selections.join('|'),
-    })
+    const optionElement = await this.element.findElement(
+      By.xpath('.//option[normalize-space(.) = ' + escapeQuotes(text) + ']'),
+    )
     if (await optionElement.isSelected()) {
       await optionElement.click()
     }
@@ -431,9 +433,11 @@ class Select {
 
     let matched = false
 
-    let options = await this.element.findElements({
-      css: 'option[value =' + escapeCss(value) + ']',
-    })
+    let options = await this.element.findElements(By.xpath('.//option[@value = ' + escapeQuotes(value) + ']'))
+
+    if (options.length === 0) {
+      throw new Error(`Cannot locate option with value: ${value}`)
+    }
 
     for (let option of options) {
       if (await option.isSelected()) {
@@ -457,4 +461,42 @@ class Select {
   }
 }
 
-module.exports = { Select }
+function escapeQuotes(toEscape) {
+  if (toEscape.includes(`"`) && toEscape.includes(`'`)) {
+    const quoteIsLast = toEscape.lastIndexOf(`"`) === toEscape.length - 1
+    const substrings = toEscape.split(`"`)
+
+    // Remove the last element if it's an empty string
+    if (substrings[substrings.length - 1] === '') {
+      substrings.pop()
+    }
+
+    let result = 'concat('
+
+    for (let i = 0; i < substrings.length; i++) {
+      result += `"${substrings[i]}"`
+      result += i === substrings.length - 1 ? (quoteIsLast ? `, '"')` : `)`) : `, '"', `
+    }
+    return result
+  }
+
+  if (toEscape.includes('"')) {
+    return `'${toEscape}'`
+  }
+
+  // Otherwise return the quoted string
+  return `"${toEscape}"`
+}
+
+function getLongestSubstringWithoutSpace(text) {
+  let words = text.split(' ')
+  let longestString = ''
+  for (let word of words) {
+    if (word.length > longestString.length) {
+      longestString = word
+    }
+  }
+  return longestString
+}
+
+module.exports = { Select, escapeQuotes }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "4.20.0",
+  "version": "4.21.0",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [
@@ -20,7 +20,7 @@
     "url": "https://github.com/SeleniumHQ/selenium.git"
   },
   "engines": {
-    "node": ">= 14.20.0"
+    "node": ">= 14.21.0"
   },
   "dependencies": {
     "jszip": "^3.10.1",