selenium-webdriver 4.0.0 → 4.1.0

package/io/index.js

@@ -19,7 +19,6 @@
 
 const fs = require('fs')
 const path = require('path')
-const rimraf = require('rimraf')
 const tmp = require('tmp')
 
 /**
@@ -52,24 +51,16 @@ function checkedCall(fn) {
  * @return {!Promise} A promise to be resolved when the operation has
  *     completed.
  */
-exports.rmDir = function (dirPath) {
+function rmDir(dirPath) {
   return new Promise(function (fulfill, reject) {
-    var numAttempts = 0
-    attemptRm()
-    function attemptRm() {
-      numAttempts += 1
-      rimraf(dirPath, function (err) {
-        if (err) {
-          if (err.code && err.code === 'ENOTEMPTY' && numAttempts < 2) {
-            attemptRm()
-            return
-          }
-          reject(err)
-        } else {
-          fulfill()
-        }
-      })
-    }
+    fs.rm(dirPath, { recursive: true, maxRetries: 2 }, function (err) {
+      if (err && err.code === 'ENOENT') {
+        fulfill()
+      } else if (err) {
+        reject(err)
+      }
+      fulfill()
+    })
   })
 }
 
@@ -79,12 +70,12 @@ exports.rmDir = function (dirPath) {
  * @param {string} dst The destination file.
  * @return {!Promise<string>} A promise for the copied file's path.
  */
-exports.copy = function (src, dst) {
+function copy(src, dst) {
   return new Promise(function (fulfill, reject) {
-    var rs = fs.createReadStream(src)
+    const rs = fs.createReadStream(src)
     rs.on('error', reject)
 
-    var ws = fs.createWriteStream(dst)
+    const ws = fs.createWriteStream(dst)
     ws.on('error', reject)
     ws.on('close', () => fulfill(dst))
 
@@ -102,20 +93,19 @@ exports.copy = function (src, dst) {
  * @return {!Promise<string>} A promise for the destination
  *     directory's path once all files have been copied.
  */
-exports.copyDir = function (src, dst, opt_exclude) {
-  var predicate = opt_exclude
+function copyDir(src, dst, opt_exclude) {
+  let predicate = opt_exclude
   if (opt_exclude && typeof opt_exclude !== 'function') {
     predicate = function (p) {
       return !opt_exclude.test(p)
     }
   }
 
-  // TODO(jleyba): Make this function completely async.
   if (!fs.existsSync(dst)) {
     fs.mkdirSync(dst)
   }
 
-  var files = fs.readdirSync(src)
+  let files = fs.readdirSync(src)
   files = files.map(function (file) {
     return path.join(src, file)
   })
@@ -153,8 +143,7 @@ exports.exists = function (aPath) {
     if (type !== 'string') {
       reject(TypeError(`expected string path, but got ${type}`))
     } else {
-      // eslint-disable-next-line node/no-deprecated-api
-      fs.exists(aPath, fulfill)
+      fulfill(fs.existsSync(aPath))
     }
   })
 }
@@ -174,18 +163,16 @@ exports.stat = function stat(aPath) {
  * @param {string} aPath The path to remove.
  * @return {!Promise} A promise for when the file has been removed.
  */
-exports.unlink = function (aPath) {
+function unlink(aPath) {
   return new Promise(function (fulfill, reject) {
-    // eslint-disable-next-line node/no-deprecated-api
-    fs.exists(aPath, function (exists) {
-      if (exists) {
-        fs.unlink(aPath, function (err) {
-          ;(err && reject(err)) || fulfill()
-        })
-      } else {
-        fulfill()
-      }
-    })
+    const exists = fs.existsSync(aPath)
+    if (exists) {
+      fs.unlink(aPath, function (err) {
+        ;(err && reject(err)) || fulfill()
+      })
+    } else {
+      fulfill()
+    }
   })
 }
 
@@ -193,7 +180,7 @@ exports.unlink = function (aPath) {
  * @return {!Promise<string>} A promise for the path to a temporary directory.
  * @see https://www.npmjs.org/package/tmp
  */
-exports.tmpDir = function () {
+function tmpDir() {
   return checkedCall((callback) => tmp.dir({ unsafeCleanup: true }, callback))
 }
 
@@ -202,7 +189,7 @@ exports.tmpDir = function () {
  * @return {!Promise<string>} A promise for the path to a temporary file.
  * @see https://www.npmjs.org/package/tmp
  */
-exports.tmpFile = function (opt_options) {
+function tmpFile(opt_options) {
   return checkedCall((callback) => {
     /**  check fixed in v > 0.2.1 if
      * (typeof options === 'function') {
@@ -222,7 +209,7 @@ exports.tmpFile = function (opt_options) {
  * @return {?string} Path to the located file, or {@code null} if it could
  *     not be found.
  */
-exports.findInPath = function (file, opt_checkCwd) {
+function findInPath(file, opt_checkCwd) {
   const dirs = []
   if (opt_checkCwd) {
     dirs.push(process.cwd())
@@ -249,7 +236,7 @@ exports.findInPath = function (file, opt_checkCwd) {
  * @return {!Promise<!Buffer>} A promise that will resolve with a buffer of the
  *     file contents.
  */
-exports.read = function (aPath) {
+function read(aPath) {
   return checkedCall((callback) => fs.readFile(aPath, callback))
 }
 
@@ -261,7 +248,7 @@ exports.read = function (aPath) {
  * @return {!Promise} A promise that will resolve when the operation has
  *     completed.
  */
-exports.write = function (aPath, data) {
+function write(aPath, data) {
   return checkedCall((callback) => fs.writeFile(aPath, data, callback))
 }
 
@@ -272,7 +259,7 @@ exports.write = function (aPath, data) {
  * @return {!Promise<string>} A promise that will resolve with the path of the
  *     created directory.
  */
-exports.mkdir = function (aPath) {
+function mkdir(aPath) {
   return checkedCall((callback) => {
     fs.mkdir(aPath, undefined, (err) => {
       if (err && err.code !== 'EEXIST') {
@@ -291,7 +278,7 @@ exports.mkdir = function (aPath) {
  * @return {!Promise<string>} A promise that will resolve with the path of the
  *     created directory.
  */
-exports.mkdirp = function mkdirp(dir) {
+function mkdirp(dir) {
   return checkedCall((callback) => {
     fs.mkdir(dir, undefined, (err) => {
       if (!err) {
@@ -327,7 +314,7 @@ exports.mkdirp = function mkdirp(dir) {
  *     resolve with a list of entries seen. For each entry, the recorded path
  *     will be relative to `rootPath`.
  */
-exports.walkDir = function (rootPath) {
+function walkDir(rootPath) {
   const seen = []
   return (function walk(dir) {
     return checkedCall((callback) => fs.readdir(dir, callback)).then((files) =>
@@ -346,3 +333,17 @@ exports.walkDir = function (rootPath) {
     )
   })(rootPath).then(() => seen)
 }
+
+// PUBLIC API
+module.exports.walkDir = walkDir
+module.exports.rmDir = rmDir
+module.exports.mkdirp = mkdirp
+module.exports.mkdir = mkdir
+module.exports.write = write
+module.exports.read = read
+module.exports.findInPath = findInPath
+module.exports.tmpFile = tmpFile
+module.exports.tmpDir = tmpDir
+module.exports.unlink = unlink
+module.exports.copy = copy
+module.exports.copyDir = copyDir

package/lib/atoms/find-elements.js

@@ -109,8 +109,8 @@ function gd(a){var b=a.shape.toLowerCase();a=a.coords.split(",");if("rect"==b&&4
 function hd(a){return a.replace(/^[^\S\xa0]+|[^\S\xa0]+$/g,"")}function id(a){var b=[];Yc?jd(a,b):kd(a,b);a=qa(b,hd);return hd(a.join("\n")).replace(/\xa0/g," ")}
 function ld(a,b,c){if(S(a,"BR"))b.push("");else{var d=S(a,"TD"),e=V(a,"display"),f=!d&&!(0<=oa(md,e)),g=void 0!==a.previousElementSibling?a.previousElementSibling:gb(a.previousSibling);g=g?V(g,"display"):"";var h=V(a,"float")||V(a,"cssFloat")||V(a,"styleFloat");!f||"run-in"==g&&"none"==h||/^[\s\xa0]*$/.test(b[b.length-1]||"")||b.push("");var n=ed(a),u=null,p=null;n&&(u=V(a,"white-space"),p=V(a,"text-transform"));l(a.childNodes,function(G){c(G,b,n,u,p)});a=b[b.length-1]||"";!d&&"table-cell"!=e||!a||
 za(a)||(b[b.length-1]+=" ");f&&"run-in"!=e&&!/^[\s\xa0]*$/.test(a)&&b.push("")}}function kd(a,b){ld(a,b,function(c,d,e,f,g){3==c.nodeType&&e?nd(c,d,f,g):S(c)&&kd(c,d)})}var md="inline inline-block inline-table none table-cell table-column table-column-group".split(" ");
-function nd(a,b,c,d){a=a.nodeValue.replace(/[\u200b\u200e\u200f]/g,"");a=a.replace(/(\r\n|\r|\n)/g,"\n");if("normal"==c||"nowrap"==c)a=a.replace(/\n/g," ");a="pre"==c||"pre-wrap"==c?a.replace(/[ \f\t\v\u2028\u2029]/g,"\u00a0"):a.replace(/[ \f\t\v\u2028\u2029]+/g," ");"capitalize"==d?a=a.replace(/(^|[^\d\p{L}\p{S}])([\p{Ll}|\p{S}])/gu,function(e,f,g){return f+g.toUpperCase()}):"uppercase"==d?a=a.toUpperCase():"lowercase"==d&&(a=a.toLowerCase());c=b.pop()||"";za(c)&&0==a.lastIndexOf(" ",0)&&(a=a.substr(1));
-b.push(c+a)}function dd(a){if(Mc){if("relative"==V(a,"position"))return 1;a=V(a,"filter");return(a=a.match(/^alpha\(opacity=(\d*)\)/)||a.match(/^progid:DXImageTransform.Microsoft.Alpha\(Opacity=(\d*)\)/))?Number(a[1])/100:1}return od(a)}function od(a){var b=1,c=V(a,"opacity");c&&(b=Number(c));(a=Zc(a))&&(b*=od(a));return b}
+function nd(a,b,c,d){a=a.nodeValue.replace(/[\u200b\u200e\u200f]/g,"");a=a.replace(/(\r\n|\r|\n)/g,"\n");if("normal"==c||"nowrap"==c)a=a.replace(/\n/g," ");a="pre"==c||"pre-wrap"==c?a.replace(/[ \f\t\v\u2028\u2029]/g,"\u00a0"):a.replace(/[ \f\t\v\u2028\u2029]+/g," ");"capitalize"==d?a=a.replace(t?/(^|\s|\b)(\S)/g:/(^|[^\d\p{L}\p{S}])([\p{Ll}|\p{S}])/gu,function(e,f,g){return f+g.toUpperCase()}):"uppercase"==d?a=a.toUpperCase():"lowercase"==d&&(a=a.toLowerCase());c=b.pop()||"";za(c)&&0==a.lastIndexOf(" ",
+0)&&(a=a.substr(1));b.push(c+a)}function dd(a){if(Mc){if("relative"==V(a,"position"))return 1;a=V(a,"filter");return(a=a.match(/^alpha\(opacity=(\d*)\)/)||a.match(/^progid:DXImageTransform.Microsoft.Alpha\(Opacity=(\d*)\)/))?Number(a[1])/100:1}return od(a)}function od(a){var b=1,c=V(a,"opacity");c&&(b=Number(c));(a=Zc(a))&&(b*=od(a));return b}
 function pd(a,b,c,d,e){if(3==a.nodeType&&c)nd(a,b,d,e);else if(S(a))if(S(a,"CONTENT")||S(a,"SLOT")){for(var f=a;f.parentNode;)f=f.parentNode;f instanceof ShadowRoot?(a=S(a,"CONTENT")?a.getDistributedNodes():a.assignedNodes(),l(a,function(g){pd(g,b,c,d,e)})):jd(a,b)}else if(S(a,"SHADOW")){for(f=a;f.parentNode;)f=f.parentNode;if(f instanceof ShadowRoot&&(a=f))for(a=a.olderShadowRoot;a;)l(a.childNodes,function(g){pd(g,b,c,d,e)}),a=a.olderShadowRoot}else jd(a,b)}
 function jd(a,b){a.shadowRoot&&l(a.shadowRoot.childNodes,function(c){pd(c,b,!0,null,null)});ld(a,b,function(c,d,e,f,g){var h=null;1==c.nodeType?h=c:3==c.nodeType&&(h=c);null!=h&&(null!=h.assignedSlot||h.getDestinationInsertionPoints&&0<h.getDestinationInsertionPoints().length)||pd(c,d,e,f,g)})};var qd={C:function(a,b){return!(!a.querySelectorAll||!a.querySelector)&&!/^\d.*/.test(b)},o:function(a,b){var c=eb(b),d="string"===typeof a?c.a.getElementById(a):a;return d?Uc(d,"id")==a&&b!=d&&hb(b,d)?d:ua(mb(c,"*"),function(e){return Uc(e,"id")==a&&b!=e&&hb(b,e)}):null},j:function(a,b){if(!a)return[];if(qd.C(b,a))try{return b.querySelectorAll("#"+qd.T(a))}catch(c){return[]}b=mb(eb(b),"*",null,b);return pa(b,function(c){return Uc(c,"id")==a})},T:function(a){return a.replace(/([\s'"\\#.:;,!?+<>=~*^$|%&@`{}\-\/\[\]\(\)])/g,
 "\\$1")}};var Y={},rd={};Y.N=function(a,b,c){try{var d=Nc.j("a",b)}catch(e){d=mb(eb(b),"A",null,b)}return ua(d,function(e){e=id(e);e=e.replace(/^[\s]+|[\s]+$/g,"");return c&&-1!=e.indexOf(a)||e==a})};Y.K=function(a,b,c){try{var d=Nc.j("a",b)}catch(e){d=mb(eb(b),"A",null,b)}return pa(d,function(e){e=id(e);e=e.replace(/^[\s]+|[\s]+$/g,"");return c&&-1!=e.indexOf(a)||e==a})};Y.o=function(a,b){return Y.N(a,b,!1)};Y.j=function(a,b){return Y.K(a,b,!1)};rd.o=function(a,b){return Y.N(a,b,!0)};

package/lib/by.js

@@ -190,11 +190,9 @@ class By {
    * @return {function(!./webdriver.WebDriver): !Promise}
    *     A new JavaScript-based locator function.
    */
-  static js(script, var_args) { // eslint-disable-line
-    // eslint-disable-line
-    let args = Array.prototype.slice.call(arguments, 0)
+  static js(script, ...var_args) {
     return function (driver) {
-      return driver.executeScript.apply(driver, args)
+      return driver.executeScript.call(driver, script, ...var_args)
     }
   }
 
@@ -277,7 +275,7 @@ function withTagName(tagName) {
  * @returns {RelativeBy}
  */
 function locateWith(by) {
-  return new RelativeBy(getLocator(by));
+  return new RelativeBy(getLocator(by))
 }
 
 function getLocator(locatorOrElement) {
@@ -431,4 +429,5 @@ module.exports = {
   withTagName: withTagName,
   locateWith: locateWith,
   checkedLocator: check,
+  escapeCss: escapeCss
 }

package/lib/capabilities.js

@@ -83,7 +83,7 @@ const Platform = {
  *
  * @record
  */
-function Timeouts() { }
+function Timeouts() {}
 
 /**
  * Defines when, in milliseconds, to interrupt a script that is being

package/lib/command.js

@@ -168,6 +168,11 @@ const Name = {
   GET_ALERT_TEXT: 'getAlertText',
   SET_ALERT_TEXT: 'setAlertValue',
 
+  // Shadow DOM Commands
+  GET_SHADOW_ROOT: 'getShadowRoot',
+  FIND_ELEMENT_FROM_SHADOWROOT: 'findElementFromShadowRoot',
+  FIND_ELEMENTS_FROM_SHADOWROOT: 'findElementsFromShadowRoot',
+
   GET_AVAILABLE_LOG_TYPES: 'getAvailableLogTypes',
   GET_LOG: 'getLog',
   GET_SESSION_LOGS: 'getSessionLogs',

package/lib/error.js

@@ -39,6 +39,16 @@ class WebDriverError extends Error {
   }
 }
 
+/**
+ * Indicates the shadow root is no longer attached to the DOM
+ */
+class DetachedShadowRootError extends WebDriverError {
+  /** @param {string=} opt_error the error message, if any. */
+  constructor(opt_error) {
+    super(opt_error)
+  }
+}
+
 /**
  * Indicates a {@linkplain ./webdriver.WebElement#click click command} could not
  * completed because the click target is obscured by other elements on the
@@ -201,6 +211,16 @@ class NoSuchElementError extends WebDriverError {
   }
 }
 
+/**
+ * A ShadowRoot could not be located on the element
+ */
+class NoSuchShadowRootError extends WebDriverError {
+  /** @param {string=} opt_error the error message, if any. */
+  constructor(opt_error) {
+    super(opt_error);
+  }
+}
+
 /**
  * A request to switch to a frame could not be satisfied because the frame
  * could not be found.
@@ -420,6 +440,7 @@ const LEGACY_ERROR_CODE_TO_TYPE = new Map([
 
 const ERROR_CODE_TO_TYPE = new Map([
   ['unknown error', WebDriverError],
+  ['detached shadow root', DetachedShadowRootError],
   ['element click intercepted', ElementClickInterceptedError],
   ['element not interactable', ElementNotInteractableError],
   ['element not selectable', ElementNotSelectableError],
@@ -436,6 +457,7 @@ const ERROR_CODE_TO_TYPE = new Map([
   ['no such cookie', NoSuchCookieError],
   ['no such element', NoSuchElementError],
   ['no such frame', NoSuchFrameError],
+  ['no such shadow root', NoSuchShadowRootError],
   ['no such window', NoSuchWindowError],
   ['script timeout', ScriptTimeoutError],
   ['session not created', SessionNotCreatedError],
@@ -569,6 +591,7 @@ module.exports = {
   ErrorCode,
 
   WebDriverError,
+  DetachedShadowRootError,
   ElementClickInterceptedError,
   ElementNotInteractableError,
   ElementNotSelectableError,
@@ -584,6 +607,7 @@ module.exports = {
   NoSuchCookieError,
   NoSuchElementError,
   NoSuchFrameError,
+  NoSuchShadowRootError,
   NoSuchSessionError,
   NoSuchWindowError,
   ScriptTimeoutError,

package/lib/http.js

@@ -31,7 +31,7 @@ const error = require('./error')
 const logging = require('./logging')
 const promise = require('./promise')
 const { Session } = require('./session')
-const { WebElement } = require('./webdriver')
+const { WebElement, ShadowRoot } = require('./webdriver')
 
 const getAttribute = requireAtom(
   'get-attribute.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}`
       )
     }
   }
@@ -173,7 +173,7 @@ var CommandSpec // eslint-disable-line
 /** @typedef {function(!cmd.Command): !cmd.Command} */
 var CommandTransformer // eslint-disable-line
 
-class InternalTypeError extends TypeError {}
+class InternalTypeError extends TypeError { }
 
 /**
  * @param {!cmd.Command} command The initial command.
@@ -421,6 +421,10 @@ const W3C_COMMAND_MAP = new Map([
   ],
   // print page.
   [cmd.Name.PRINT_PAGE, post('/session/:sessionId/print')],
+  // Shadow Root
+  [cmd.Name.GET_SHADOW_ROOT, get('/session/:sessionId/element/:id/shadow')],
+  [cmd.Name.FIND_ELEMENT_FROM_SHADOWROOT, post('/session/:sessionId/shadow/:id/element')],
+  [cmd.Name.FIND_ELEMENTS_FROM_SHADOWROOT, post('/session/:sessionId/shadow/:id/elements')],
   // Log extensions.
   [cmd.Name.GET_LOG, post('/session/:sessionId/se/log')],
   [cmd.Name.GET_AVAILABLE_LOG_TYPES, get('/session/:sessionId/se/log/types')],
@@ -441,7 +445,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
 }
 
 /**
@@ -584,7 +588,7 @@ class Executor {
       // No implementations use the `capabilities` key yet...
       let capabilities = value.capabilities || value.value
       return new Session(
-        /** @type {{sessionId: string}} */ (value).sessionId,
+        /** @type {{sessionId: string}} */(value).sessionId,
         capabilities
       )
     }

package/lib/until.js

@@ -137,13 +137,14 @@ exports.alertIsPresent = function alertIsPresent() {
  * @return {!Condition<boolean>} The new condition.
  */
 exports.titleIs = function titleIs(title) {
-  return new Condition('for title to be ' + JSON.stringify(title), function (
-    driver
-  ) {
-    return driver.getTitle().then(function (t) {
-      return t === title
-    })
-  })
+  return new Condition(
+    'for title to be ' + JSON.stringify(title),
+    function (driver) {
+      return driver.getTitle().then(function (t) {
+        return t === title
+      })
+    }
+  )
 }
 
 /**
@@ -188,13 +189,14 @@ exports.titleMatches = function titleMatches(regex) {
  * @return {!Condition<boolean>} The new condition.
  */
 exports.urlIs = function urlIs(url) {
-  return new Condition('for URL to be ' + JSON.stringify(url), function (
-    driver
-  ) {
-    return driver.getCurrentUrl().then(function (u) {
-      return u === url
-    })
-  })
+  return new Condition(
+    'for URL to be ' + JSON.stringify(url),
+    function (driver) {
+      return driver.getCurrentUrl().then(function (u) {
+        return u === url
+      })
+    }
+  )
 }
 
 /**