webdriverio 5.11.11 → 5.11.12

package/build/scripts/isDisplayedInViewport.js

@@ -5,11 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = isDisplayedInViewport;
 
-/**
- * check if element is visible and within the viewport
- * @param  {HTMLElement} elem  element to check
- * @return {Boolean}           true if element is within viewport
- */
 function isDisplayedInViewport(elem) {
   const dde = document.documentElement;
   let isWithinViewport = true;

package/build/scripts/isElementDisplayed.js

@@ -5,36 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = isElementDisplayed;
 
-/*
- * Copyright (C) 2017 Apple Inc. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
- * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
- * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
- * THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-/**
- * check if element is visible
- * @param  {HTMLElement} elem  element to check
- * @return {Boolean}           true if element is within viewport
- */
 function isElementDisplayed(element) {
   function nodeIsElement(node) {
     if (!node) {
@@ -79,10 +49,7 @@ function isElementDisplayed(element) {
   function cascadedStylePropertyForElement(element, property) {
     if (!element || !property) {
       return null;
-    } // if document-fragment, skip it and use element.host instead. This happens
-    // when the element is inside a shadow root.
-    // window.getComputedStyle errors on document-fragment.
-
+    }
 
     if (element instanceof DocumentFragment) {
       element = element.host;
@@ -93,15 +60,7 @@ function isElementDisplayed(element) {
 
     if (computedStyleProperty && computedStyleProperty !== 'inherit') {
       return computedStyleProperty;
-    } // Ideally getPropertyValue would return the 'used' or 'actual' value, but
-    // it doesn't for legacy reasons. So we need to do our own poor man's cascade.
-    // Fall back to the first non-'inherit' value found in an ancestor.
-    // In any case, getPropertyValue will not return 'initial'.
-    // FIXME: will this incorrectly inherit non-inheritable CSS properties?
-    // I think all important non-inheritable properties (width, height, etc.)
-    // for our purposes here are specially resolved, so this may not be an issue.
-    // Specification is here: https://drafts.csswg.org/cssom/#resolved-values
-
+    }
 
     let parentElement = parentElementForElement(element);
     return cascadedStylePropertyForElement(parentElement, property);
@@ -112,8 +71,7 @@ function isElementDisplayed(element) {
 
     if (boundingBox.width > 0 && boundingBox.height > 0) {
       return true;
-    } // Paths can have a zero width or height. Treat them as shown if the stroke width is positive.
-
+    }
 
     if (element.tagName.toUpperCase() === 'PATH' && boundingBox.width + boundingBox.height > 0) {
       let strokeWidth = cascadedStylePropertyForElement(element, 'stroke-width');
@@ -124,9 +82,7 @@ function isElementDisplayed(element) {
 
     if (cascadedOverflow === 'hidden') {
       return false;
-    } // If the container's overflow is not hidden and it has zero size, consider the
-    // container to have non-zero dimensions if a child node has non-zero dimensions.
-
+    }
 
     return Array.from(element.childNodes).some(childNode => {
       if (childNode.nodeType === Node.TEXT_NODE) {
@@ -146,10 +102,7 @@ function isElementDisplayed(element) {
 
     if (cascadedOverflow !== 'hidden') {
       return false;
-    } // FIXME: this needs to take into account the scroll position of the element,
-    // the display modes of it and its ancestors, and the container it overflows.
-    // See Selenium's bot.dom.getOverflowState atom for an exhaustive list of edge cases.
-
+    }
 
     return true;
   }
@@ -165,13 +118,9 @@ function isElementDisplayed(element) {
 
     if (!element.childNodes.length) {
       return false;
-    } // This element's subtree is hidden by overflow if all child subtrees are as well.
-
+    }
 
     return Array.from(element.childNodes).every(childNode => {
-      // Returns true if the child node is overflowed or otherwise hidden.
-      // Base case: not an element, has zero size, scrolled out, or doesn't overflow container.
-      // Visibility of text nodes is controlled by parent
       if (childNode.nodeType === Node.TEXT_NODE) {
         return false;
       }
@@ -182,13 +131,11 @@ function isElementDisplayed(element) {
 
       if (!elementSubtreeHasNonZeroDimensions(childNode)) {
         return true;
-      } // Recurse.
-
+      }
 
       return isElementSubtreeHiddenByOverflow(childNode);
     });
-  } // walk up the tree testing for a shadow root
-
+  }
 
   function isElementInsideShadowRoot(element) {
     if (!element) {
@@ -200,15 +147,11 @@ function isElementDisplayed(element) {
     }
 
     return isElementInsideShadowRoot(element.parentNode);
-  } // This is a partial reimplementation of Selenium's "element is displayed" algorithm.
-  // When the W3C specification's algorithm stabilizes, we should implement that.
-  // If this command is misdirected to the wrong document (and is NOT inside a shadow root), treat it as not shown.
-
+  }
 
   if (!isElementInsideShadowRoot(element) && !document.contains(element)) {
     return false;
-  } // Special cases for specific tag names.
-
+  }
 
   switch (element.tagName.toUpperCase()) {
     case 'BODY':
@@ -221,20 +164,16 @@ function isElementDisplayed(element) {
     case 'OPTGROUP':
     case 'OPTION':
       {
-        // Option/optgroup are considered shown if the containing <select> is shown.
         let enclosingSelectElement = enclosingNodeOrSelfMatchingPredicate(element, e => e.tagName.toUpperCase() === 'SELECT');
         return isElementDisplayed(enclosingSelectElement);
       }
 
     case 'INPUT':
-      // <input type="hidden"> is considered not shown.
       if (element.type === 'hidden') {
         return false;
       }
 
       break;
-    // case 'MAP':
-    // FIXME: Selenium has special handling for <map> elements. We don't do anything now.
 
     default:
       break;

package/build/scripts/isFocused.js

@@ -5,11 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = _default;
 
-/**
- * checks if given element is focused
- * @param  {HTMLElement} elem  element to check
- * @return {Boolean}           true if element is focused
- */
 function _default(elem) {
   return elem === document.activeElement;
 }

package/build/scripts/newWindow.js

@@ -5,14 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = newWindow;
 
-/**
- * opens new window via window.open
- * @param  {String} url            The URL to be loaded in the newly opened window.
- * @param  {String} windowName     A string name for the new window.
- * @param  {String} windowFeatures An optional parameter listing the features (size, position, scrollbars, etc.) of the new window as a string.
- *
- * @see  https://developer.mozilla.org/en-US/docs/Web/API/Window.open
- */
 function newWindow(url, windowName = 'new window', windowFeatures = '') {
   window.open(url, windowName, windowFeatures);
 }

package/build/scripts/resq.js

@@ -26,9 +26,7 @@ const react$ = function react$(selector, props = {}, state = {}, reactElement) {
     return {
       message: `React element with selector "${selector}" wasn't found`
     };
-  } // resq returns an array of HTMLElements if the React component is a fragment
-  // if the element is a fragment, we return the first child to be passed into the driver
-
+  }
 
   return element.isFragment ? element.node[0] : element.node;
 };
@@ -48,10 +46,7 @@ const react$$ = function react$$(selector, props, state, reactElement) {
 
   if (!elements.length) {
     return [];
-  } // resq returns an array of HTMLElements if the React component is a fragment
-  // this avoids having nested arrays of nodes which the driver does not understand
-  // [[div, div], [div, div]] => [div, div, div, div]
-
+  }
 
   let nodes = [];
   elements.forEach(element => {

package/build/scripts/shadowFnFactory.js

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.shadowFnFactory = void 0;
 
-// generate a function that can be used to query shadowRoots
 const shadowFnFactory = function (elementSelector, qsAll) {
   const strFn = `
     (function() {

package/build/utils/Timer.js

@@ -8,15 +8,6 @@ exports.default = void 0;
 var _config = require("@wdio/config");
 
 const TIMEOUT_ERROR = 'timeout';
-/**
- * Promise-based Timer. Execute fn every tick.
- * When fn is resolved — timer will stop
- * @param {Number} delay - delay between ticks
- * @param {Number} timeout - after that time timer will stop
- * @param {Function} fn - function that returns promise. will execute every tick
- * @param {Boolean} leading - should be function invoked on start
- * @return {promise} Promise-based Timer.
- */
 
 class Timer {
   constructor(delay, timeout, fn, leading) {
@@ -25,11 +16,6 @@ class Timer {
     this._fn = fn;
     this._leading = leading;
     this._conditionExecutedCnt = 0;
-    /**
-     * only wrap waitUntil condition if:
-     *  - wdio-sync is installed
-     *  - function name is not async
-     */
 
     if (_config.hasWdioSyncSupport && !fn.name.includes('async')) {
       this._fn = () => (0, _config.runFnInFiberContext)(fn)();
@@ -54,9 +40,6 @@ class Timer {
     }
 
     this._mainTimeoutId = setTimeout(() => {
-      /**
-       * make sure that condition was executed at least once
-       */
       if (!this.wasConditionExecuted()) {
         return;
       }
@@ -97,7 +80,7 @@ class Timer {
 
   checkCondition(err, res) {
     ++this._conditionExecutedCnt;
-    this.lastError = err; // resolve timer only on truthy values
+    this.lastError = err;
 
     if (res) {
       this._resolve(res);
@@ -105,14 +88,12 @@ class Timer {
       this.stop();
       this.stopMain();
       return;
-    } // autocorrect timer
-
+    }
 
     let diff = Date.now() - this._start - this._ticks++ * this._delay;
 
-    let delay = Math.max(0, this._delay - diff); // clear old timeoutID
-
-    this.stop(); // check if we have time to one more tick
+    let delay = Math.max(0, this._delay - diff);
+    this.stop();
 
     if (this.hasTime(delay)) {
       this._timeoutId = setTimeout(this.tick.bind(this), delay);

package/build/utils/findStrategy.js

@@ -15,87 +15,60 @@ const DEFAULT_STRATEGY = 'css selector';
 const DIRECT_SELECTOR_REGEXP = /^(id|css selector|xpath|link text|partial link text|name|tag name|class name|-android uiautomator|-android datamatcher|-ios uiautomation|-ios predicate string|-ios class chain|accessibility id):(.+)/;
 const XPATH_SELECTORS_START = ['/', '(', '../', './', '*/'];
 const NAME_MOBILE_SELECTORS_START = ['uia', 'xcuielementtype', 'android.widget', 'cyi'];
-const XPATH_SELECTOR_REGEXP = [// HTML tag
-/^([a-z0-9|-]*)/, // optional . or # + class or id
-/(?:(\.|#)(-?[_a-zA-Z]+[_a-zA-Z0-9-]*))?/, // optional [attribute-name="attribute-selector"]
-/(?:\[(-?[_a-zA-Z]+[_a-zA-Z0-9-]*)(?:=(?:"|')([a-zA-z0-9\-_. ]+)(?:"|'))?\])?/, // *=query or =query
-/(\*)?=(.+)$/];
+const XPATH_SELECTOR_REGEXP = [/^([a-z0-9|-]*)/, /(?:(\.|#)(-?[_a-zA-Z]+[_a-zA-Z0-9-]*))?/, /(?:\[(-?[_a-zA-Z]+[_a-zA-Z0-9-]*)(?:=(?:"|')([a-zA-z0-9\-_. ]+)(?:"|'))?\])?/, /(\*)?=(.+)$/];
 
 const defineStrategy = function (selector) {
-  // Condition with checking isPlainObject(selector) should be first because
-  // in case of "selector" argument is a plain object then .match() will cause
-  // an error like "selector.match is not a function"
-  // Use '-android datamatcher' strategy if selector is a plain object (Android only)
   if ((0, _lodash.default)(selector)) {
     return '-android datamatcher';
-  } // Check if user has specified locator strategy directly
-
+  }
 
   if (selector.match(DIRECT_SELECTOR_REGEXP)) {
     return 'directly';
-  } // Use xPath strategy if selector starts with //
-
+  }
 
   if (XPATH_SELECTORS_START.some(option => selector.startsWith(option))) {
     return 'xpath';
-  } // Use link text strategy if selector starts with =
-
+  }
 
   if (selector.startsWith('=')) {
     return 'link text';
-  } // Use partial link text strategy if selector starts with *=
-
+  }
 
   if (selector.startsWith('*=')) {
     return 'partial link text';
-  } // Use id strategy if the selector starts with id=
-
+  }
 
   if (selector.startsWith('id=')) {
     return 'id';
-  } // Recursive element search using the UiAutomator library (Android only)
-
+  }
 
   if (selector.startsWith('android=')) {
     return '-android uiautomator';
-  } // Recursive element search using the UIAutomation library (iOS-only)
-
+  }
 
   if (selector.startsWith('ios=')) {
     return '-ios uiautomation';
-  } // Recursive element search using accessibility id
-
+  }
 
   if (selector.startsWith('~')) {
     return 'accessibility id';
-  } // Class name mobile selector
-  // for iOS = UIA...
-  // for Android = android.widget
-
+  }
 
   if (NAME_MOBILE_SELECTORS_START.some(option => selector.toLowerCase().startsWith(option))) {
     return 'class name';
-  } // Use tag name strategy if selector contains a tag
-  // e.g. "<div>" or "<div />"
-
+  }
 
   if (selector.search(/<[a-zA-Z-]+( \/)*>/g) >= 0) {
     return 'tag name';
-  } // Use name strategy if selector queries elements with name attributes for JSONWP
-  // or if isMobile is used even when w3c is used
-  // e.g. "[name='myName']" or '[name="myName"]'
-
+  }
 
   if (selector.search(/^\[name=("|')([a-zA-z0-9\-_.@=[\] ']+)("|')]$/) >= 0) {
     return 'name';
-  } // Allow to move up to the parent or select current element
-
+  }
 
   if (selector === '..' || selector === '.') {
     return 'xpath';
-  } // Any element with given class, id, or attribute and content
-  // e.g. h1.header=Welcome or [data-name=table-row]=Item or #content*=Intro
-
+  }
 
   if (selector.match(new RegExp(XPATH_SELECTOR_REGEXP.map(rx => rx.source).join('')))) {
     return 'xpath extended';
@@ -107,13 +80,12 @@ const findStrategy = function (selector, isW3C, isMobile) {
   let value = selector;
 
   switch (defineStrategy(selector)) {
-    // user has specified locator strategy directly
     case 'directly':
       {
         const match = selector.match(DIRECT_SELECTOR_REGEXP);
 
         if (!isMobile && isW3C && !_constants.W3C_SELECTOR_STRATEGIES.includes(match[1])) {
-          throw new Error('InvalidSelectorStrategy'); // ToDo: move error to wdio-error package
+          throw new Error('InvalidSelectorStrategy');
         }
 
         using = match[1];
@@ -223,13 +195,9 @@ const findStrategy = function (selector, isW3C, isMobile) {
         break;
       }
   }
-  /**
-   * ensure selector strategy is supported
-   */
-
 
   if (!isMobile && isW3C && !_constants.W3C_SELECTOR_STRATEGIES.includes(using)) {
-    throw new Error('InvalidSelectorStrategy'); // ToDo: move error to wdio-error package
+    throw new Error('InvalidSelectorStrategy');
   }
 
   return {

package/build/utils/getElementObject.js

@@ -25,12 +25,6 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-/**
- * transforms and findElement response into a WDIO element
- * @param  {String} selector  selector that was used to query the element
- * @param  {Object} res       findElement response
- * @return {Object}           WDIO element object
- */
 const getElement = function findElement(selector, res) {
   const browser = (0, _utils.getBrowserObject)(this);
 
@@ -42,13 +36,7 @@ const getElement = function findElement(selector, res) {
     const elementId = (0, _utils.getElementFromResponse)(res);
 
     if (elementId) {
-      /**
-       * set elementId for easy access
-       */
       client.elementId = elementId;
-      /**
-       * set element id with proper key so element can be passed into execute commands
-       */
 
       if (this.isW3C) {
         client[_constants.ELEMENT_KEY] = elementId;
@@ -76,13 +64,6 @@ const getElement = function findElement(selector, res) {
 
   return elementInstance;
 };
-/**
- * transforms and findElement response into a WDIO element
- * @param  {String} selector  selector that was used to query the element
- * @param  {Object} res       findElement response
- * @return {Object}           WDIO element object
- */
-
 
 exports.getElement = getElement;
 
@@ -93,13 +74,7 @@ const getElements = function getElements(selector, res) {
       const elementId = (0, _utils.getElementFromResponse)(res);
 
       if (elementId) {
-        /**
-         * set elementId for easy access
-         */
         client.elementId = elementId;
-        /**
-         * set element id with proper key so element can be passed into execute commands
-         */
 
         if (this.isW3C) {
           client[_constants.ELEMENT_KEY] = elementId;

package/build/utils/implicitWait.js

@@ -10,14 +10,6 @@ var _logger = _interopRequireDefault(require("@wdio/logger"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const log = (0, _logger.default)('webdriverio');
-/**
- * wait on element if:
- *  - elementId couldn't be fetched in the first place
- *  - command is not explicit wait command for existance or displayedness
- * @param  {Object}  currentElement  element to wait on if necessary
- * @param  {string}  commandName  name of the command that called this
- * @return {Promise} resolves with element after any necessary waiting
- */
 
 async function implicitWait(currentElement, commandName) {
   if (!currentElement.elementId && !commandName.match(/(waitUntil|waitFor|isExisting|is?\w+Displayed)/)) {
@@ -25,10 +17,6 @@ async function implicitWait(currentElement, commandName) {
 
     try {
       await currentElement.waitForExist();
-      /**
-       * if waitForExist was successful requery element and assign elementId to the scope
-       */
-
       return await currentElement.parent.$(currentElement.selector);
     } catch (_unused) {
       throw new Error(`Can't call ${commandName} on element with selector "${currentElement.selector}" because element wasn't found`);

package/build/utils/refetchElement.js

@@ -9,15 +9,8 @@ var _implicitWait = _interopRequireDefault(require("./implicitWait"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- * helper utility to refetch an element and all its parent elements when running
- * into stale element exception errors
- * @param  {Object}  currentElement  element to refetch
- * @param  {string}  commandName  name of the command that called this
- * @return {Promise} resolves with element after all its parent were refetched
- */
 async function refetchElement(currentElement, commandName) {
-  let selectors = []; //Crawl back to the browser object, and cache all selectors
+  let selectors = [];
 
   while (currentElement.elementId && currentElement.parent) {
     selectors.push({
@@ -28,8 +21,7 @@ async function refetchElement(currentElement, commandName) {
   }
 
   selectors.reverse();
-  const length = selectors.length; // Beginning with the browser object, rechain
-
+  const length = selectors.length;
   return selectors.reduce(async (elementPromise, {
     selector,
     index
@@ -37,11 +29,6 @@ async function refetchElement(currentElement, commandName) {
     const resolvedElement = await elementPromise;
     let nextElement = index > 0 ? (await resolvedElement.$$(selector))[index] : null;
     nextElement = nextElement || (await resolvedElement.$(selector));
-    /**
-     *  For error purposes, changing command name to '$' if we aren't
-     *  on the last element of the array
-     */
-
     return await (0, _implicitWait.default)(nextElement, currentIndex + 1 < length ? '$' : commandName);
   }, Promise.resolve(currentElement));
 }