Merge branch '3.x' of github.com:codeceptjs/CodeceptJS into 3.x

Author: DavertMik

docs/locators.md

@@ -17,7 +17,7 @@ CodeceptJS provides flexible strategies for locating elements:
 
 Most methods in CodeceptJS use locators which can be either a string or an object.
 
-If the locator is an object, it should have a single element, with the key signifying the locator type (`id`, `name`, `css`, `xpath`, `link`, `react`, or `class`) and the value being the locator itself. This is called a "strict" locator.
+If the locator is an object, it should have a single element, with the key signifying the locator type (`id`, `name`, `css`, `xpath`, `link`, `react`, `class` or `shadow`) and the value being the locator itself. This is called a "strict" locator.
 
 Examples:
 

docs/plugins.md

@@ -788,18 +788,22 @@ Adds global `tryTo` function inside of which all failed steps won't fail a test
 
 Enable this plugin in `codecept.conf.js` (enabled by default for new setups):
 
-````js
+```js
 plugins: {
   tryTo: {
     enabled: true
   }
 }
+```
+
+Use it in your tests:
+
 ```js
 const result = await tryTo(() => I.see('Welcome'));
 
 // if text "Welcome" is on page, result => true
 // if text "Welcome" is not on page, result => false
-````
+```
 
 Disables retryFailedStep plugin for steps inside a block;
 

lib/actor.js

@@ -35,8 +35,6 @@ class Actor {
   retry(opts) {
     if (opts === undefined) opts = 1;
     recorder.retry(opts);
-    // adding an empty promise to clear retries
-    recorder.add(() => null);
     // remove retry once the step passed
     recorder.add(() => event.dispatcher.once(event.step.finished, () => recorder.retries.pop()));
     return this;

lib/helper/Playwright.js

@@ -2152,7 +2152,7 @@ async function findElements(matcher, locator) {
 }
 
 async function proceedClick(locator, context = null, options = {}) {
-  let matcher = await this.context;
+  let matcher = await this._getContext();
   if (context) {
     const els = await this._locate(context);
     assertElementExists(els, context);

lib/helper/WebDriver.js

@@ -2188,7 +2188,9 @@ class WebDriver extends Helper {
       }, aSec * 1000, `element (${new Locator(locator)}) still not visible after ${aSec} sec`);
     }
     return this.browser.waitUntil(async () => {
-      const res = await this.$$(withStrictLocator(locator));
+      const res = (this._isShadowLocator(locator))
+        ? await this._locate(withStrictLocator(locator))
+        : await this.$$(withStrictLocator(locator));
       if (!res || res.length === 0) return false;
       const selected = await forEachAsync(res, async el => el.isDisplayed());
       if (Array.isArray(selected)) {

lib/listener/helpers.js

@@ -23,7 +23,7 @@ module.exports = function () {
     if (store.dryRun) return;
     Object.keys(helpers).forEach((key) => {
       if (!helpers[key][hook]) return;
-      recorder.add(`hook ${key}.${hook}()`, () => helpers[key][hook](param), force);
+      recorder.add(`hook ${key}.${hook}()`, () => helpers[key][hook](param), force, false);
     });
   };
 

lib/locator.js

@@ -3,7 +3,7 @@ const { sprintf } = require('sprintf-js');
 
 const { xpathLocator } = require('./utils');
 
-const locatorTypes = ['css', 'by', 'xpath', 'id', 'name', 'fuzzy', 'frame'];
+const locatorTypes = ['css', 'by', 'xpath', 'id', 'name', 'fuzzy', 'frame', 'shadow'];
 /** @class */
 class Locator {
   /**
@@ -43,6 +43,9 @@ class Locator {
     if (isXPath(locator)) {
       this.type = 'xpath';
     }
+    if (isShadow(locator)) {
+      this.type = 'shadow';
+    }
 
     Locator.filters.forEach(f => f(locator, this));
   }
@@ -61,6 +64,8 @@ class Locator {
         return `[name="${this.value}"]`;
       case 'fuzzy':
         return this.value;
+      case 'shadow':
+        return { shadow: this.value };
     }
     return this.value;
   }
@@ -81,6 +86,10 @@ class Locator {
     return this.type === 'fuzzy';
   }
 
+  isShadow() {
+    return this.type === 'shadow';
+  }
+
   isFrame() {
     return this.type === 'frame';
   }
@@ -165,6 +174,7 @@ class Locator {
   at(position) {
     if (position < 0) {
       position++; // -1 points to the last element
+      // @ts-ignore
       position = `last()-${Math.abs(position)}`;
     }
     if (position === 0) {
@@ -338,6 +348,11 @@ function isXPath(locator) {
   return trimmed === '//' || trimmed === './';
 }
 
+function isShadow(locator) {
+  const hasShadowProperty = (locator.shadow !== undefined) && (Object.keys(locator).length === 1);
+  return hasShadowProperty;
+}
+
 function isXPathStartingWithRoundBrackets(locator) {
   return isXPath(locator) && locator[0] === '(';
 }

lib/plugin/tryTo.js

@@ -12,12 +12,16 @@ const defaultConfig = {
  * Adds global `tryTo` function inside of which all failed steps won't fail a test but will return true/false.
  *
  * Enable this plugin in `codecept.conf.js` (enabled by default for new setups):
+ *
  * ```js
  * plugins: {
  *   tryTo: {
  *     enabled: true
  *   }
  * }
+ * ```
+ * Use it in your tests:
+ *
  * ```js
  * const result = await tryTo(() => I.see('Welcome'));
  *

lib/recorder.js

@@ -154,17 +154,20 @@ module.exports = {
    * @param {string|function} taskName
    * @param {function} [fn]
    * @param {boolean} [force=false]
-   * @param {boolean} [retry=true] -
+   * @param {boolean} [retry]
+   *     undefined: `add(fn)` -> `false` and `add('step',fn)` -> `true`
    *     true: it will retries if `retryOpts` set.
    *     false: ignore `retryOpts` and won't retry.
    * @return {Promise<*> | undefined}
    * @inner
    */
-  add(taskName, fn = undefined, force = false, retry = true) {
+  add(taskName, fn = undefined, force = false, retry = undefined) {
     if (typeof taskName === 'function') {
       fn = taskName;
       taskName = fn.toString();
+      if (retry === undefined) retry = false;
     }
+    if (retry === undefined) retry = true;
     if (!running && !force) {
       return;
     }
@@ -178,11 +181,9 @@ module.exports = {
         return Promise.resolve(res).then(fn);
       }
 
+      const retryRules = this.retries.slice().reverse();
       return promiseRetry(Object.assign(defaultRetryOptions, retryOpts), (retry, number) => {
         if (number > 1) log(`${currentQueue()}Retrying... Attempt #${number}`);
-
-        const retryRules = this.retries.reverse();
-
         return Promise.resolve(res).then(fn).catch((err) => {
           for (const retryObj of retryRules) {
             if (!retryObj.when) return retry(err);

package.json

@@ -39,17 +39,17 @@
     "build": "tsc -p ./",
     "json-server": "./node_modules/json-server/bin/index.js test/data/rest/db.json -p 8010 --watch -m test/data/rest/headers.js",
     "json-server:graphql": "node test/data/graphql/index.js",
-    "lint": "eslint bin/ examples/ lib/ test/ translations/ runio.js",
-    "lint-fix": "eslint bin/ examples/ lib/ test/ translations/ runio.js --fix",
-    "docs": "./runio.js docs",
+    "lint": "eslint bin/ examples/ lib/ test/ translations/ runok.js",
+    "lint-fix": "eslint bin/ examples/ lib/ test/ translations/ runok.js --fix",
+    "docs": "./runok.js docs",
     "test:unit": "mocha test/unit --recursive",
     "test:runner": "mocha test/runner --recursive",
     "test": "npm run test:unit && npm run test:runner",
     "test:appium-quick": "mocha test/helper/Appium_test.js --grep 'quick'",
     "test:appium-other": "mocha test/helper/Appium_test.js --grep 'second'",
-    "def": "./runio.js def",
+    "def": "./runok.js def",
     "dev:graphql": "nodemon test/data/graphql/index.js",
-    "publish:site": "./runio.js publish:site",
+    "publish:site": "./runok.js publish:site",
     "update-contributor-faces": "contributor-faces .",
     "dtslint": "dtslint typings --localTs './node_modules/typescript/lib'"
   },
@@ -124,7 +124,7 @@
     "puppeteer": "^4.0.0",
     "qrcode-terminal": "^0.12.0",
     "rosie": "^1.6.0",
-    "runio.js": "^1.0.20",
+    "runok": "^0.9.2",
     "sinon": "^9.0.2",
     "sinon-chai": "^3.5.0",
     "testcafe": "^1.8.6",