codeceptjs 3.5.0 → 3.5.1-2.beta.7

package/lib/helper/scripts/focusElement.js

@@ -0,0 +1,17 @@
+module.exports.focusElement = (element, context) => {
+  const clientSideFn = el => {
+    el.focus();
+  };
+
+  try {
+    // Puppeteer
+    context.evaluate(clientSideFn, element);
+  } catch (e) {
+    // WebDriver
+    try {
+      context.execute(clientSideFn, element);
+    } catch (err) {
+      // ignore
+    }
+  }
+};

package/lib/helper/scripts/highlightElement.js

@@ -7,8 +7,8 @@ module.exports.highlightElement = (element, context) => {
   };
 
   try {
-    // Playwright, Puppeteer
-    context.evaluate(clientSideHighlightFn, element);
+    // Puppeteer
+    context.evaluate(clientSideHighlightFn, element).catch(err => console.error(err));
   } catch (e) {
     // WebDriver
     try {

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/bdd.js

@@ -30,7 +30,7 @@ const parameterTypeRegistry = new ParameterTypeRegistry();
 const matchStep = (step) => {
   for (const stepName in steps) {
     if (stepName.indexOf('/') === 0) {
-      const regExpArr = stepName.match(new RegExp('^/(.*?)/([gimy]*)$')) || [];
+      const regExpArr = stepName.match(/^\/(.*?)\/([gimy]*)$/) || [];
       const res = step.match(new RegExp(regExpArr[1], regExpArr[2]));
       if (res) {
         const fn = steps[stepName];

package/lib/interfaces/gherkin.js

@@ -1,6 +1,7 @@
 const Gherkin = require('@cucumber/gherkin');
 const Messages = require('@cucumber/messages');
 const { Context, Suite, Test } = require('mocha');
+const debug = require('debug')('codeceptjs:bdd');
 
 const { matchStep } = require('./bdd');
 const event = require('../event');
@@ -17,6 +18,11 @@ parser.stopAtFirstError = false;
 
 module.exports = (text, file) => {
   const ast = parser.parse(text);
+  let currentLanguage;
+
+  if (ast.feature) {
+    currentLanguage = getTranslation(ast.feature.language);
+  }
 
   if (!ast.feature) {
     throw new Error(`No 'Features' available in Gherkin '${file}' provided!`);
@@ -39,7 +45,9 @@ module.exports = (text, file) => {
     for (const step of steps) {
       const metaStep = new Step.MetaStep(null, step.text);
       metaStep.actor = step.keyword.trim();
+      let helperStep;
       const setMetaStep = (step) => {
+        helperStep = step;
         if (step.metaStep) {
           if (step.metaStep === metaStep) {
             return;
@@ -67,11 +75,15 @@ module.exports = (text, file) => {
       step.startTime = Date.now();
       step.match = fn.line;
       event.emit(event.bddStep.before, step);
+      event.emit(event.bddStep.started, metaStep);
       event.dispatcher.prependListener(event.step.before, setMetaStep);
       try {
+        debug(`Step '${step.text}' started...`);
         await fn(...fn.params);
+        debug('Step passed');
         step.status = 'passed';
       } catch (err) {
+        debug(`Step failed: ${err?.message}`);
         step.status = 'failed';
         step.err = err;
         throw err;
@@ -79,6 +91,7 @@ module.exports = (text, file) => {
         step.endTime = Date.now();
         event.dispatcher.removeListener(event.step.before, setMetaStep);
       }
+      event.emit(event.bddStep.finished, metaStep);
       event.emit(event.bddStep.after, step);
     }
   };
@@ -88,7 +101,7 @@ module.exports = (text, file) => {
       suite.beforeEach('Before', scenario.injected(async () => runSteps(child.background.steps), suite, 'before'));
       continue;
     }
-    if (child.scenario && child.scenario.keyword === 'Scenario Outline') {
+    if (child.scenario && (currentLanguage ? child.scenario.keyword === currentLanguage.contexts.ScenarioOutline : child.scenario.keyword === 'Scenario Outline')) {
       for (const examples of child.scenario.examples) {
         const fields = examples.tableHeader.cells.map(c => c.value);
         for (const example of examples.tableBody) {
@@ -106,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;
@@ -133,7 +153,7 @@ function transformTable(table) {
   let str = '';
   for (const id in table.rows) {
     const cells = table.rows[id].cells;
-    str += cells.map(c => c.value).map(c => c.slice(0, 15).padEnd(15)).join(' | ');
+    str += cells.map(c => c.value).map(c => c.padEnd(15)).join(' | ');
     str += '\n';
   }
   return str;
@@ -154,3 +174,17 @@ function addExampleInTable(exampleSteps, placeholders) {
   }
   return steps;
 }
+
+function getTranslation(language) {
+  const translations = Object.keys(require('../../translations'));
+
+  for (const availableTranslation of translations) {
+    if (!language) {
+      break;
+    }
+
+    if (availableTranslation.includes(language)) {
+      return require('../../translations')[availableTranslation];
+    }
+  }
+}

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('csstoxpath');
 const { sprintf } = require('sprintf-js');
 
 const { xpathLocator } = require('./utils');
@@ -158,11 +158,12 @@ class Locator {
   }
 
   /**
+   * @param {string} [pseudoSelector] CSS to XPath extension pseudo: https://www.npmjs.com/package/csstoxpath?activeTab=explore#extension-pseudos
    * @returns {string}
    */
-  toXPath() {
+  toXPath(pseudoSelector = '') {
     if (this.isXPath()) return this.value;
-    if (this.isCSS()) return cssToXPath(this.value);
+    if (this.isCSS()) return cssToXPath(`${this.value}${pseudoSelector}`);
 
     throw new Error('Can\'t be converted to XPath');
   }
@@ -243,12 +244,24 @@ class Locator {
   }
 
   /**
+   * Find an element containing a text
    * @param {string} text
    * @returns {Locator}
    */
   withText(text) {
     text = xpathLocator.literal(text);
-    const xpath = sprintf('%s[%s]', this.toXPath(), `contains(., ${text})`);
+    const xpath = this.toXPath(`:text-contains-case(${text})`);
+    return new Locator({ xpath });
+  }
+
+  /**
+   * Find an element with exact text
+   * @param {string} text
+   * @returns {Locator}
+   */
+  withTextEquals(text) {
+    text = xpathLocator.literal(text);
+    const xpath = this.toXPath(`:text-case(${text})`);
     return new Locator({ xpath });
   }
 

package/lib/mochaFactory.js

@@ -97,7 +97,8 @@ class MochaFactory {
     const attributes = Object.getOwnPropertyDescriptor(reporterOptions, 'codeceptjs-cli-reporter');
     if (reporterOptions['codeceptjs-cli-reporter'] && attributes) {
       Object.defineProperty(
-        reporterOptions, 'codeceptjs/lib/cli',
+        reporterOptions,
+        'codeceptjs/lib/cli',
         attributes,
       );
       delete reporterOptions['codeceptjs-cli-reporter'];

package/lib/output.js

@@ -106,7 +106,7 @@ module.exports = {
     if (!step) return;
     // Avoid to print non-gherkin steps, when gherkin is running for --steps mode
     if (outputLevel === 1) {
-      if (step.hasBDDAncestor()) {
+      if (typeof step === 'object' && step.hasBDDAncestor()) {
         return;
       }
     }

package/lib/pause.js

@@ -18,10 +18,10 @@ 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]
  */
 const pause = function (passedObject = {}) {
   if (store.dryRun) return;
@@ -44,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`));
@@ -67,6 +69,7 @@ function pauseSession(passedObject = {}) {
   });
   return new Promise(((resolve) => {
     finish = resolve;
+    // eslint-disable-next-line
     return askForStep();
   }));
 }
@@ -76,7 +79,6 @@ async function parseInput(cmd) {
   rl.pause();
   next = false;
   recorder.session.start('pause');
-  store.debugMode = false;
   if (cmd === '') next = true;
   if (!cmd || cmd === 'resume' || cmd === 'exit') {
     finish();
@@ -96,13 +98,14 @@ async function parseInput(cmd) {
     return cmd;
   };
 
-  store.debugMode = true;
   let isCustomCommand = false;
   let lastError = null;
   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;
@@ -114,13 +117,13 @@ async function parseInput(cmd) {
       isAiCommand = true;
       executeCommand = executeCommand.then(async () => {
         try {
-          const html = await res; 
-          aiAssistant.setHtmlContext(html);
+          const html = await res;
+          await aiAssistant.setHtmlContext(html);
         } catch (err) {
           output.print(output.styles.error(' ERROR '), 'Can\'t get HTML context', err.stack);
           return;
         } finally {
-          output.level(currentOutputLevel);          
+          output.level(currentOutputLevel);
         }
         // aiAssistant.mockResponse("```js\nI.click('Sign in');\n```");
         const spinner = ora("Processing OpenAI request...").start();
@@ -148,12 +151,12 @@ async function parseInput(cmd) {
     })
 
     const val = await executeCommand;
-    
+
     if (isCustomCommand) {
       if (val !== undefined) console.log('Result', '$res=', val); // eslint-disable-line
       $res = val;
     }
-    
+
     if (cmd?.startsWith('I.see') || cmd?.startsWith('I.dontSee')) {
       output.print(output.styles.success('  OK  '), cmd);
     }

package/lib/plugin/autoLogin.js

@@ -9,6 +9,7 @@ const isAsyncFunction = require('../utils').isAsyncFunction;
 
 const defaultUser = {
   fetch: I => I.grabCookie(),
+  check: () => {},
   restore: (I, cookies) => {
     I.amOnPage('/'); // open a page
     I.setCookie(cookies);
@@ -37,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');
  * });
@@ -61,7 +64,7 @@ const defaultConfig = {
  * #### How It Works
  *
  * 1. `restore` method is executed. It should open a page and set credentials.
- * 2. `check` method is executed. It should reload a page (so cookies are applied) and check that this page belongs to logged in user.
+ * 2. `check` method is executed. It should reload a page (so cookies are applied) and check that this page belongs to logged-in user. When you pass the second args `session`, you could perform the validation using passed session.
  * 3. If `restore` and `check` were not successful, `login` is executed
  * 4. `login` should fill in login form
  * 5. After successful login, `fetch` is executed to save cookies into memory or file.
@@ -212,6 +215,38 @@ const defaultConfig = {
  * })
  * ```
  *
+ * #### Tips: Using session to validate user
+ *
+ * Instead of asserting on page elements for the current user in `check`, you can use the `session` you saved in `fetch`
+ *
+ * ```js
+ * autoLogin: {
+ *   enabled: true,
+ *   saveToFile: true,
+ *   inject: 'login',
+ *   users: {
+ *     admin: {
+ *       login: async (I) => {  // If you use async function in the autoLogin plugin
+ *          const phrase = await I.grabTextFrom('#phrase')
+ *          I.fillField('username', 'admin'),
+ *          I.fillField('password', 'password')
+ *          I.fillField('phrase', phrase)
+ *       },
+ *       check: (I, session) => {
+ *          // Throwing an error in `check` will make CodeceptJS perform the login step for the user
+ *          if (session.profile.email !== the.email.you.expect@some-mail.com) {
+ *               throw new Error ('Wrong user signed in');
+ *         }
+ *       },
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ```js
+ * Scenario('login', async ( {I, login} ) => {
+ *   await login('admin') // you should use `await`
+ * })
  *
  *
 */
@@ -251,27 +286,28 @@ module.exports = function (config) {
       } else {
         userSession.login(I);
       }
-      store.debugMode = true;
+
       const cookies = await userSession.fetch(I);
+      if (!cookies) {
+        debug('Cannot save user session with empty cookies from auto login\'s fetch method');
+        return;
+      }
       if (config.saveToFile) {
         debug(`Saved user session into file for ${name}`);
         fs.writeFileSync(path.join(global.output_dir, `${name}_session.json`), JSON.stringify(cookies));
       }
       store[`${name}_session`] = cookies;
-      store.debugMode = false;
     };
 
     if (!cookies) return loginAndSave();
 
-    store.debugMode = true;
-
     recorder.session.start('check login');
     if (shouldAwait) {
       await userSession.restore(I, cookies);
-      await userSession.check(I);
+      await userSession.check(I, cookies);
     } else {
       userSession.restore(I, cookies);
-      userSession.check(I);
+      userSession.check(I, cookies);
     }
     recorder.session.catch((err) => {
       debug(`Failed auto login for ${name} due to ${err}`);
@@ -287,7 +323,6 @@ module.exports = function (config) {
       });
     });
     recorder.add(() => {
-      store.debugMode = false;
       recorder.session.restore('check login');
     });
 

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',
@@ -26,7 +27,7 @@ const defaultConfig = {
  *
  * This plugin is experimental and requires OpenAI API key.
  *
- * To use it you need to set OPENAI_API_KEY env variable and enable plugin inside condig.
+ * To use it you need to set OPENAI_API_KEY env variable and enable plugin inside the config.
  *
  * ```js
  * plugins: {
@@ -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,22 +71,37 @@ 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} steps in a test`));
+        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');
         output.print('or increase healing limit in heal plugin config');
 
@@ -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;
     });
   });
 
@@ -126,7 +153,7 @@ module.exports = function (config = {}) {
     print('===================');
     print(colors.bold.green('Self-Healing Report:'));
 
-    print(`${colors.bold(healSuggestions.length)} steps were healed by AI`);
+    print(`${colors.bold(healSuggestions.length)} step(s) were healed by AI`);
 
     let i = 1;
     print('');
@@ -145,19 +172,19 @@ module.exports = function (config = {}) {
   });
 
   async function tryToHeal(failedStep, err) {
-    output.debug(`Running OpenAPI to heal ${failedStep.toCode()} step`);
+    output.debug(`Running OpenAI to heal ${failedStep.toCode()} step`);
 
-    const I = Container.support('I');
+    const codeSnippets = await aiAssistant.healFailedStep(failedStep, err, currentTest);
 
-    const codeSnippets = await aiAssistant.healFailedStep(
-      failedStep, err, currentTest,
-    );
-
-    output.debug(`Received ${codeSnippets.length} proposals from OpenAI`);
+    output.debug(`Received ${codeSnippets.length} suggestions from OpenAI`);
+    const I = Container.support('I'); // eslint-disable-line
 
     for (const codeSnippet of codeSnippets) {
       try {
         debug('Executing', codeSnippet);
+        recorder.catch((e) => {
+          console.log(e);
+        });
         await eval(codeSnippet); // eslint-disable-line
 
         healSuggestions.push({
@@ -166,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,7 @@
 const event = require('../event');
 const recorder = require('../recorder');
+const container = require('../container');
+const { log } = require('../output');
 
 const defaultConfig = {
   retries: 3,
@@ -42,7 +44,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 +100,11 @@ module.exports = (config) => {
   config.when = when;
 
   event.dispatcher.on(event.step.started, (step) => {
+    if (process.env.TRY_TO === 'true') {
+      log('Info: RetryFailedStep plugin is disabled inside tryTo block');
+      return;
+    }
+
     // if a step is ignored - return
     for (const ignored of config.ignoredSteps) {
       if (step.name === ignored) return;
@@ -114,6 +121,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/retryTo.js

@@ -83,16 +83,15 @@ module.exports = function (config) {
   return retryTo;
 
   function retryTo(callback, maxTries, pollInterval = undefined) {
-    const mode = store.debugMode;
     let tries = 1;
     if (!pollInterval) pollInterval = config.pollInterval;
 
     let err = null;
 
     return new Promise((done) => {
-      const tryBlock = () => {
+      const tryBlock = async () => {
         recorder.session.start(`retryTo ${tries}`);
-        callback(tries);
+        await callback(tries);
         recorder.add(() => {
           recorder.session.restore(`retryTo ${tries}`);
           done(null);
@@ -113,7 +112,6 @@ module.exports = function (config) {
       };
 
       recorder.add('retryTo', async () => {
-        store.debugMode = true;
         tryBlock();
       });
     }).then(() => {

package/lib/plugin/selenoid.js

@@ -58,7 +58,12 @@ let seleniumUrl = 'http://localhost:$port$';
 const supportedHelpers = ['WebDriver'];
 const SELENOID_START_TIMEOUT = 2000;
 const SELENOID_STOP_TIMEOUT = 10000;
-const wait = time => new Promise((res) => setTimeout(() => res(), time));
+const wait = time => new Promise((res) => {
+  setTimeout(() => {
+    // @ts-ignore
+    res();
+  }, time);
+});
 
 /**
  * [Selenoid](https://aerokube.com/selenoid/) plugin automatically starts browsers and video recording.

package/lib/plugin/standardActingHelpers.js

@@ -4,8 +4,6 @@ const standardActingHelpers = [
   'Puppeteer',
   'Appium',
   'TestCafe',
-  'Protractor',
-  'Nightmare',
 ];
 
 module.exports = standardActingHelpers;