codeceptjs 3.5.9 → 3.5.11

package/lib/helper/WebDriver.js

@@ -869,6 +869,14 @@ class WebDriver extends Helper {
     return findFields.call(this, locator).then(res => res);
   }
 
+  /**
+   * {{> grabWebElements }}
+   *
+   */
+  async grabWebElements(locator) {
+    return this._locate(locator);
+  }
+
   /**
    * Set [WebDriver timeouts](https://webdriver.io/docs/timeouts.html) in realtime.
    *
@@ -1096,8 +1104,9 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> attachFile }}
    * Appium: not tested
+   *
+   * {{> attachFile }}
    */
   async attachFile(locator, pathToFile) {
     let file = path.join(global.codecept_dir, pathToFile);
@@ -1124,8 +1133,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> checkOption }}
    * Appium: not tested
+   * {{> checkOption }}
    */
   async checkOption(field, context = null) {
     const clickMethod = this.browser.isMobile && !this.browser.isW3C ? 'touchClick' : 'elementClick';
@@ -1144,8 +1153,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> uncheckOption }}
    * Appium: not tested
+   * {{> uncheckOption }}
    */
   async uncheckOption(field, context = null) {
     const clickMethod = this.browser.isMobile && !this.browser.isW3C ? 'touchClick' : 'elementClick';
@@ -1362,16 +1371,16 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> seeCheckboxIsChecked }}
    * Appium: not tested
+   * {{> seeCheckboxIsChecked }}
    */
   async seeCheckboxIsChecked(field) {
     return proceedSeeCheckbox.call(this, 'assert', field);
   }
 
   /**
-   * {{> dontSeeCheckboxIsChecked }}
    * Appium: not tested
+   * {{> dontSeeCheckboxIsChecked }}
    */
   async dontSeeCheckboxIsChecked(field) {
     return proceedSeeCheckbox.call(this, 'negate', field);
@@ -1508,7 +1517,9 @@ class WebDriver extends Helper {
     let chunked = chunkArray(props, values.length);
     chunked = chunked.filter((val) => {
       for (let i = 0; i < val.length; ++i) {
-        if (val[i] !== values[i]) return false;
+        const _acutal = Number.isNaN(val[i]) || (typeof values[i]) === 'string' ? val[i] : Number.parseInt(val[i], 10);
+        const _expected = Number.isNaN(values[i]) || (typeof values[i]) === 'string' ? values[i] : Number.parseInt(values[i], 10);
+        if (_acutal !== _expected) return false;
       }
       return true;
     });
@@ -1535,7 +1546,9 @@ class WebDriver extends Helper {
     let chunked = chunkArray(attrs, values.length);
     chunked = chunked.filter((val) => {
       for (let i = 0; i < val.length; ++i) {
-        if (val[i] !== values[i]) return false;
+        const _acutal = Number.isNaN(val[i]) || (typeof values[i]) === 'string' ? val[i] : Number.parseInt(val[i], 10);
+        const _expected = Number.isNaN(values[i]) || (typeof values[i]) === 'string' ? values[i] : Number.parseInt(values[i], 10);
+        if (_acutal !== _expected) return false;
       }
       return true;
     });
@@ -1594,10 +1607,9 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> executeScript }}
-   *
-   *
    * Wraps [execute](http://webdriver.io/api/protocol/execute.html) command.
+   *
+   * {{> executeScript }}
    */
   executeScript(...args) {
     return this.browser.execute.apply(this.browser, args);
@@ -1719,11 +1731,8 @@ class WebDriver extends Helper {
   }
 
   /**
+   * Uses Selenium's JSON [cookie format](https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object).
    * {{> setCookie }}
-   *
-   *
-   * Uses Selenium's JSON [cookie
-   * format](https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object).
    */
   async setCookie(cookie) {
     return this.browser.setCookies(cookie);
@@ -1776,7 +1785,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.
+   * Dismisses the active JavaScript popup, as created by `window.alert|window.confirm|window.prompt`.
    *
    */
   async cancelPopup() {
@@ -1850,9 +1859,9 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> pressKeyWithKeyNormalization }}
-   *
    * _Note:_ In case a text field or textarea is focused be aware that some browsers do not respect active modifier when combining modifier keys with other keys.
+   *
+   * {{> pressKeyWithKeyNormalization }}
    */
   async pressKey(key) {
     const modifiers = [];
@@ -1911,8 +1920,9 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> resizeWindow }}
    * Appium: not tested in web, in apps doesn't work
+   *
+   * {{> resizeWindow }}
    */
   async resizeWindow(width, height) {
     return this._resizeBrowserWindow(this.browser, width, height);
@@ -1964,8 +1974,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> dragAndDrop }}
    * Appium: not tested
+   * {{> dragAndDrop }}
    */
   async dragAndDrop(srcElement, destElement) {
     let sourceEl = await this._locate(srcElement);

package/lib/helper/extras/PlaywrightReactVueLocator.js

@@ -0,0 +1,38 @@
+async function findReact(matcher, locator) {
+  let _locator = `_react=${locator.react}`;
+  let props = '';
+
+  if (locator.props) {
+    props += propBuilder(locator.props);
+    _locator += props;
+  }
+  return matcher.locator(_locator).all();
+}
+
+async function findVue(matcher, locator) {
+  let _locator = `_vue=${locator.vue}`;
+  let props = '';
+
+  if (locator.props) {
+    props += propBuilder(locator.props);
+    _locator += props;
+  }
+  return matcher.locator(_locator).all();
+}
+
+function propBuilder(props) {
+  let _props = '';
+
+  for (const [key, value] of Object.entries(props)) {
+    if (typeof value === 'object') {
+      for (const [k, v] of Object.entries(value)) {
+        _props += `[${key}.${k} = "${v}"]`;
+      }
+    } else {
+      _props += `[${key} = "${value}"]`;
+    }
+  }
+  return _props;
+}
+
+module.exports = { findReact, findVue };

package/lib/html.js

@@ -1,7 +1,7 @@
 const { parse, serialize } = require('parse5');
-const { minify } = require('html-minifier');
+const { minify } = require('html-minifier-terser');
 
-function minifyHtml(html) {
+async function minifyHtml(html) {
   return minify(html, {
     collapseWhitespace: true,
     removeComments: true,
@@ -11,7 +11,7 @@ function minifyHtml(html) {
     removeStyleLinkTypeAttributes: true,
     collapseBooleanAttributes: true,
     useShortDoctype: true,
-  }).toString();
+  });
 }
 
 const defaultHtmlOpts = {

package/lib/interfaces/gherkin.js

@@ -119,7 +119,14 @@ module.exports = (text, file) => {
             });
           }
           const tags = child.scenario.tags.map(t => t.name).concat(examples.tags.map(t => t.name));
-          const title = `${child.scenario.name} ${JSON.stringify(current)} ${tags.join(' ')}`.trim();
+          let title = `${child.scenario.name} ${JSON.stringify(current)} ${tags.join(' ')}`.trim();
+
+          for (const [key, value] of Object.entries(current)) {
+            if (title.includes(`<${key}>`)) {
+              title = title.replace(JSON.stringify(current), '').replace(`<${key}>`, value);
+            }
+          }
+
           const test = new Test(title, async () => runSteps(addExampleInTable(exampleSteps, current)));
           test.tags = suite.tags.concat(tags);
           test.file = file;

package/lib/interfaces/scenarioConfig.js

@@ -35,6 +35,7 @@ class ScenarioConfig {
    * @returns {this}
    */
   retry(retries) {
+    if (process.env.SCENARIO_ONLY) retries = -retries;
     this.test.retries(retries);
     return this;
   }

package/lib/locator.js

@@ -1,4 +1,4 @@
-const cssToXPath = require('css-to-xpath');
+const cssToXPath = require('convert-cssxpath');
 const { sprintf } = require('sprintf-js');
 
 const { xpathLocator } = require('./utils');
@@ -162,7 +162,7 @@ class Locator {
    */
   toXPath() {
     if (this.isXPath()) return this.value;
-    if (this.isCSS()) return cssToXPath(this.value);
+    if (this.isCSS()) return cssToXPath.convert(this.value);
 
     throw new Error('Can\'t be converted to XPath');
   }

package/lib/pause.js

@@ -18,8 +18,7 @@ let nextStep;
 let finish;
 let next;
 let registeredVariables = {};
-const aiAssistant = new AiAssistant();
-
+let aiAssistant;
 /**
  * Pauses test execution and starts interactive shell
  * @param {Object<string, *>} [passedObject]
@@ -45,6 +44,8 @@ function pauseSession(passedObject = {}) {
     let vars = Object.keys(registeredVariables).join(', ');
     if (vars) vars = `(vars: ${vars})`;
 
+    aiAssistant = AiAssistant.getInstance();
+
     output.print(colors.yellow(' Interactive shell started'));
     output.print(colors.yellow(' Use JavaScript syntax to try steps in action'));
     output.print(colors.yellow(` - Press ${colors.bold('ENTER')} to run the next step`));
@@ -102,7 +103,9 @@ async function parseInput(cmd) {
   let isAiCommand = false;
   let $res;
   try {
+    // eslint-disable-next-line
     const locate = global.locate; // enable locate in this context
+    // eslint-disable-next-line
     const I = container.support('I');
     if (cmd.trim().startsWith('=>')) {
       isCustomCommand = true;
@@ -115,7 +118,7 @@ async function parseInput(cmd) {
       executeCommand = executeCommand.then(async () => {
         try {
           const html = await res;
-          aiAssistant.setHtmlContext(html);
+          await aiAssistant.setHtmlContext(html);
         } catch (err) {
           output.print(output.styles.error(' ERROR '), 'Can\'t get HTML context', err.stack);
           return;

package/lib/plugin/autoLogin.js

@@ -38,12 +38,14 @@ const defaultConfig = {
  * ```js
  * // inside a test file
  * // use login to inject auto-login function
+ * Feature('Login');
+ *
  * Before(({ login }) => {
  *    login('user'); // login using user session
  * });
  *
- * // Alternatively log in for one scenario
- * Scenario('log me in', ( {I, login} ) => {
+ * // Alternatively log in for one scenario.
+ * Scenario('log me in', ( { I, login } ) => {
  *    login('admin');
  *    I.see('I am logged in');
  * });

package/lib/plugin/heal.js

@@ -8,6 +8,7 @@ const output = require('../output');
 const supportedHelpers = require('./standardActingHelpers');
 
 const defaultConfig = {
+  healTries: 1,
   healLimit: 2,
   healSteps: [
     'click',
@@ -54,11 +55,14 @@ const defaultConfig = {
  *
  */
 module.exports = function (config = {}) {
-  const aiAssistant = new AiAssistant();
+  const aiAssistant = AiAssistant.getInstance();
 
   let currentTest = null;
   let currentStep = null;
   let healedSteps = 0;
+  let caughtError;
+  let healTries = 0;
+  let isHealing = false;
 
   const healSuggestions = [];
 
@@ -67,20 +71,35 @@ module.exports = function (config = {}) {
   event.dispatcher.on(event.test.before, (test) => {
     currentTest = test;
     healedSteps = 0;
+    caughtError = null;
   });
 
   event.dispatcher.on(event.step.started, step => currentStep = step);
 
-  event.dispatcher.on(event.step.before, () => {
+  event.dispatcher.on(event.step.after, (step) => {
+    if (isHealing) return;
     const store = require('../store');
     if (store.debugMode) return;
-
     recorder.catchWithoutStop(async (err) => {
-      if (!aiAssistant.isEnabled) throw err;
+      isHealing = true;
+      if (caughtError === err) throw err; // avoid double handling
+      caughtError = err;
+      if (!aiAssistant.isEnabled) {
+        output.print(colors.yellow('Heal plugin can\'t operate, AI assistant is disabled. Please set OPENAI_API_KEY env variable to enable it.'));
+        throw err;
+      }
       if (!currentStep) throw err;
       if (!config.healSteps.includes(currentStep.name)) throw err;
       const test = currentTest;
 
+      if (healTries >= config.healTries) {
+        output.print(colors.bold.red(`Healing failed for ${config.healTries} time(s)`));
+        output.print('AI couldn\'t identify the correct solution');
+        output.print('Probably the entire flow has changed and the test should be updated');
+
+        throw err;
+      }
+
       if (healedSteps >= config.healLimit) {
         output.print(colors.bold.red(`Can't heal more than ${config.healLimit} step(s) in a test`));
         output.print('Entire flow can be broken, please check it manually');
@@ -111,9 +130,17 @@ module.exports = function (config = {}) {
 
       if (!html) throw err;
 
-      aiAssistant.setHtmlContext(html);
+      healTries++;
+      await aiAssistant.setHtmlContext(html);
       await tryToHeal(step, err);
-      recorder.session.restore();
+
+      recorder.add('close healing session', () => {
+        recorder.session.restore('heal');
+        recorder.ignoreErr(err);
+      });
+      await recorder.promise();
+
+      isHealing = false;
     });
   });
 
@@ -155,6 +182,9 @@ module.exports = function (config = {}) {
     for (const codeSnippet of codeSnippets) {
       try {
         debug('Executing', codeSnippet);
+        recorder.catch((e) => {
+          console.log(e);
+        });
         await eval(codeSnippet); // eslint-disable-line
 
         healSuggestions.push({
@@ -163,14 +193,17 @@ module.exports = function (config = {}) {
           snippet: codeSnippet,
         });
 
-        output.print(colors.bold.green('  Code healed successfully'));
+        recorder.add('healed', () => output.print(colors.bold.green('  Code healed successfully')));
         healedSteps++;
         return;
       } catch (err) {
         debug('Failed to execute code', err);
+        recorder.ignoreErr(err); // healing ded not help
+        // recorder.catch(() => output.print(colors.bold.red('  Failed healing code')));
       }
     }
 
     output.debug(`Couldn't heal the code for ${failedStep.toCode()}`);
   }
+  return recorder.promise();
 };

package/lib/plugin/retryFailedStep.js

@@ -1,5 +1,6 @@
 const event = require('../event');
 const recorder = require('../recorder');
+const container = require('../container');
 
 const defaultConfig = {
   retries: 3,
@@ -42,7 +43,7 @@ const defaultConfig = {
  * * `factor` - The exponential factor to use. Default is 1.5.
  * * `minTimeout` - The number of milliseconds before starting the first retry. Default is 1000.
  * * `maxTimeout` - The maximum number of milliseconds between two retries. Default is Infinity.
- * * `randomize` - Randomizes the timeouts by multiplying with a factor between 1 to 2. Default is false.
+ * * `randomize` - Randomizes the timeouts by multiplying with a factor from 1 to 2. Default is false.
  * * `defaultIgnoredSteps` - an array of steps to be ignored for retry. Includes:
  *     * `amOnPage`
  *     * `wait*`
@@ -98,6 +99,8 @@ module.exports = (config) => {
   config.when = when;
 
   event.dispatcher.on(event.step.started, (step) => {
+    if (process.env.TRY_TO) return;
+
     // if a step is ignored - return
     for (const ignored of config.ignoredSteps) {
       if (step.name === ignored) return;
@@ -114,6 +117,8 @@ module.exports = (config) => {
 
   event.dispatcher.on(event.test.before, (test) => {
     if (test && test.disableRetryFailedStep) return; // disable retry when a test is not active
+    // this env var is used to set the retries inside _before() block of helpers
+    process.env.FAILED_STEP_RETRIES = config.retries;
     recorder.retry(config);
   });
 };

package/lib/plugin/stepByStepReport.js

@@ -89,8 +89,8 @@ module.exports = function (config) {
   const reportDir = config.output ? path.resolve(global.codecept_dir, config.output) : defaultConfig.output;
 
   event.dispatcher.on(event.test.before, (test) => {
-    const md5hash = crypto.createHash('md5').update(test.file + test.title).digest('hex');
-    dir = path.join(reportDir, `record_${md5hash}`);
+    const sha256hash = crypto.createHash('sha256').update(test.file + test.title).digest('hex');
+    dir = path.join(reportDir, `record_${sha256hash}`);
     mkdirp.sync(dir);
     stepNum = 0;
     error = null;

package/lib/plugin/tryTo.js

@@ -1,5 +1,4 @@
 const recorder = require('../recorder');
-const store = require('../store');
 const { debug } = require('../output');
 
 const defaultConfig = {
@@ -9,7 +8,7 @@ const defaultConfig = {
 /**
  *
  *
- * Adds global `tryTo` function inside of which all failed steps won't fail a test but will return true/false.
+ * Adds global `tryTo` function in 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):
  *
@@ -47,7 +46,7 @@ const defaultConfig = {
  * ```js
  * const assert = require('assert');
  * ```
- * Then use the assert:
+ * Then use the assertion:
  * const result1 = await tryTo(() => I.see('Hello, user'));
  * const result2 = await tryTo(() => I.seeElement('.welcome'));
  * assert.ok(result1 && result2, 'Assertions were not succesful');
@@ -70,7 +69,7 @@ const defaultConfig = {
  * const tryTo = codeceptjs.container.plugins('tryTo');
  * ```
  *
-*/
+ */
 module.exports = function (config) {
   config = Object.assign(defaultConfig, config);
 
@@ -84,6 +83,7 @@ function tryTo(callback) {
   let result = false;
   return recorder.add('tryTo', () => {
     recorder.session.start('tryTo');
+    process.env.TRY_TO = 'true';
     callback();
     recorder.add(() => {
       result = true;
@@ -98,6 +98,7 @@ function tryTo(callback) {
       return result;
     });
     return recorder.add('result', () => {
+      process.env.TRY_TO = undefined;
       return result;
     }, true, false);
   }, false, false);

package/lib/recorder.js

@@ -11,6 +11,7 @@ let errFn;
 let queueId = 0;
 let sessionId = null;
 let asyncErr = null;
+let ignoredErrs = [];
 
 let tasks = [];
 let oldPromises = [];
@@ -93,6 +94,7 @@ module.exports = {
     promise = Promise.resolve();
     oldPromises = [];
     tasks = [];
+    ignoredErrs = [];
     this.session.running = false;
     // reset this retries makes the retryFailedStep plugin won't work if there is Before/BeforeSuit block due to retries is undefined on Scenario
     // this.retries = [];
@@ -226,9 +228,10 @@ module.exports = {
    * @inner
    */
   catch(customErrFn) {
-    debug(`${currentQueue()}Queued | catch with error handler`);
+    const fnDescription = customErrFn?.toString()?.replace(/\s{2,}/g, ' ').replace(/\n/g, ' ')?.slice(0, 50);
+    debug(`${currentQueue()}Queued | catch with error handler ${fnDescription || ''}`);
     return promise = promise.catch((err) => {
-      log(`${currentQueue()}Error | ${err}`);
+      log(`${currentQueue()}Error | ${err} ${fnDescription}...`);
       if (!(err instanceof Error)) { // strange things may happen
         err = new Error(`[Wrapped Error] ${printObjectProperties(err)}`); // we should be prepared for them
       }
@@ -247,15 +250,15 @@ module.exports = {
    * @inner
    */
   catchWithoutStop(customErrFn) {
+    const fnDescription = customErrFn?.toString()?.replace(/\s{2,}/g, ' ').replace(/\n/g, ' ')?.slice(0, 50);
     return promise = promise.catch((err) => {
-      log(`${currentQueue()}Error | ${err}`);
+      if (ignoredErrs.includes(err)) return; // already caught
+      log(`${currentQueue()}Error (Non-Terminated) | ${err} | ${fnDescription || ''}...`);
       if (!(err instanceof Error)) { // strange things may happen
         err = new Error(`[Wrapped Error] ${JSON.stringify(err)}`); // we should be prepared for them
       }
       if (customErrFn) {
         return customErrFn(err);
-      } if (errFn) {
-        return errFn(err);
       }
     });
   },
@@ -274,6 +277,10 @@ module.exports = {
     });
   },
 
+  ignoreErr(err) {
+    ignoredErrs.push(err);
+  },
+
   /**
    * @param {*} err
    * @inner

package/lib/ui.js

@@ -168,6 +168,7 @@ module.exports = function (suite) {
     context.Scenario.only = function (title, opts, fn) {
       const reString = `^${escapeRe(`${suites[0].title}: ${title}`.replace(/( \| {.+})?$/g, ''))}`;
       mocha.grep(new RegExp(reString));
+      process.env.SCENARIO_ONLY = true;
       return addScenario(title, opts, fn);
     };
 

package/lib/workers.js

@@ -359,6 +359,7 @@ class Workers extends EventEmitter {
     this.stats.start = new Date();
     recorder.startUnlessRunning();
     event.dispatcher.emit(event.workers.before);
+    process.env.RUNS_WITH_WORKERS = 'true';
     recorder.add('starting workers', () => {
       for (const worker of this.workers) {
         const workerThread = createWorker(worker);
@@ -492,6 +493,7 @@ class Workers extends EventEmitter {
     }
 
     output.result(this.stats.passes, this.stats.failures, this.stats.pending, ms(this.stats.duration));
+    process.env.RUNS_WITH_WORKERS = 'false';
   }
 }