codeceptjs 3.5.5 → 3.5.7-beta.1

package/lib/plugin/autoLogin.js

@@ -61,7 +61,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 +212,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 +283,23 @@ module.exports = function (config) {
       } else {
         userSession.login(I);
       }
-      store.debugMode = true;
       const cookies = await userSession.fetch(I);
       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 +315,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',
@@ -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/retryTo.js

@@ -83,7 +83,6 @@ module.exports = function (config) {
   return retryTo;
 
   function retryTo(callback, maxTries, pollInterval = undefined) {
-    const mode = store.debugMode;
     let tries = 1;
     if (!pollInterval) pollInterval = config.pollInterval;
 
@@ -113,7 +112,6 @@ module.exports = function (config) {
       };
 
       recorder.add('retryTo', async () => {
-        store.debugMode = true;
         tryBlock();
       });
     }).then(() => {

package/lib/plugin/tryTo.js

@@ -81,10 +81,8 @@ module.exports = function (config) {
 };
 
 function tryTo(callback) {
-  const mode = store.debugMode;
   let result = false;
   return recorder.add('tryTo', () => {
-    store.debugMode = true;
     recorder.session.start('tryTo');
     callback();
     recorder.add(() => {
@@ -100,7 +98,6 @@ function tryTo(callback) {
       return result;
     });
     return recorder.add('result', () => {
-      store.debugMode = mode;
       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/session.js

@@ -19,7 +19,7 @@ const savedSessions = {};
  * @param {CodeceptJS.LocatorOrString}  sessionName
  * @param {Function | Object<string, *>}  config
  * @param {Function}  [fn]
- * @return {Promise<*> | undefined}
+ * @return {any}
  */
 function session(sessionName, config, fn) {
   if (typeof config === 'function') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.5.5",
+  "version": "3.5.7-beta.1",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -40,8 +40,8 @@
     "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 --timeout 5000",
-    "test:runner": "mocha test/runner --recursive --timeout 5000",
+    "test:unit": "mocha test/unit --recursive --timeout 10000",
+    "test:runner": "mocha test/runner --recursive --timeout 10000",
     "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'",
@@ -51,6 +51,7 @@
     "test:unit:webbapi:puppeteer": "mocha test/helper/Puppeteer_test.js",
     "test:unit:webbapi:webDriver": "mocha test/helper/WebDriver_test.js",
     "test:unit:webbapi:testCafe": "mocha test/helper/TestCafe_test.js",
+    "test:unit:expect": "mocha test/helper/Expect_test.js",
     "def": "./runok.js def",
     "dev:graphql": "node test/data/graphql/index.js",
     "publish:site": "./runok.js publish:site",
@@ -68,8 +69,13 @@
     "acorn": "8.10.0",
     "arrify": "2.0.1",
     "axios": "1.3.3",
-    "chai": "4.3.6",
+    "chai": "4.3.8",
     "chai-deep-match": "1.2.1",
+    "chai-exclude": "^2.1.0",
+    "chai-json-schema": "^1.5.1",
+    "chai-json-schema-ajv": "^5.2.4",
+    "chai-match-pattern": "^1.3.0",
+    "chai-string": "^1.5.0",
     "chalk": "4.1.2",
     "commander": "11.0.0",
     "cross-spawn": "7.0.3",
@@ -80,10 +86,10 @@
     "fn-args": "4.0.0",
     "fs-extra": "8.1.0",
     "glob": "6.0.1",
-    "html-minifier": "4.0.0",
+    "html-minifier-terser": "^7.2.0",
     "inquirer": "6.5.2",
     "joi": "17.6.0",
-    "js-beautify": "1.14.0",
+    "js-beautify": "1.14.9",
     "lodash.clonedeep": "4.5.0",
     "lodash.merge": "4.6.2",
     "mkdirp": "1.0.4",
@@ -102,49 +108,50 @@
     "@codeceptjs/detox-helper": "1.0.2",
     "@codeceptjs/mock-request": "0.3.1",
     "@faker-js/faker": "7.6.0",
-    "@pollyjs/adapter-puppeteer": "6.0.5",
+    "@pollyjs/adapter-puppeteer": "6.0.6",
     "@pollyjs/core": "5.1.0",
+    "@types/chai": "^4.3.7",
     "@types/inquirer": "9.0.3",
     "@types/node": "20.4.4",
     "@wdio/sauce-service": "8.3.8",
     "@wdio/selenium-standalone-service": "8.3.2",
-    "@wdio/utils": "8.3.0",
+    "@wdio/utils": "8.16.22",
     "apollo-server-express": "2.25.3",
     "chai-as-promised": "7.1.1",
     "chai-subset": "1.6.0",
     "contributor-faces": "1.0.3",
     "documentation": "12.3.0",
     "dtslint": "4.1.6",
-    "electron": "26.1.0",
-    "eslint": "8.45.0",
+    "electron": "27.0.2",
+    "eslint": "8.50.0",
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-plugin-import": "2.25.4",
     "eslint-plugin-mocha": "6.3.0",
-    "expect": "29.6.2",
+    "expect": "29.7.0",
     "express": "4.17.2",
     "graphql": "14.6.0",
-    "husky": "8.0.1",
+    "husky": "8.0.3",
     "inquirer-test": "2.0.1",
     "jsdoc": "3.6.10",
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.10.1",
-    "playwright": "1.35.1",
+    "playwright": "1.39.0",
     "puppeteer": "21.1.1",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.0",
-    "runok": "0.9.2",
+    "runok": "0.9.3",
     "sinon": "15.2.0",
     "sinon-chai": "3.7.0",
-    "testcafe": "3.0.1",
+    "testcafe": "3.3.0",
     "ts-morph": "19.0.0",
     "ts-node": "10.9.1",
     "tsd-jsdoc": "2.5.0",
     "typedoc": "0.24.8",
     "typedoc-plugin-markdown": "3.13.4",
-    "typescript": "5.1.6",
+    "typescript": "5.2.2",
     "wdio-docker-service": "1.5.0",
     "webdriverio": "8.3.8",
-    "xml2js": "0.6.0",
+    "xml2js": "0.6.2",
     "xmldom": "0.6.0",
     "xpath": "0.0.33"
   },

package/translations/de-DE.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: 'Ich',
+  contexts: {
+    Feature: 'Funktionalität',
+    Scenario: 'Szenario',
+    ScenarioOutline: 'Szenariogrundriss',
+  },
   actions: {
     amOutsideAngularApp: 'befinde_mich_außerhalb_der_angular_app',
     amInsideAngularApp: 'bedinde_mich_innerhalb_der_angular_app',

package/translations/fr-FR.js

@@ -3,6 +3,7 @@ module.exports = {
   contexts: {
     Feature: 'Fonctionnalité',
     Scenario: 'Scénario',
+    ScenarioOutline: 'Plan du scénario',
     Before: 'Avant',
     After: 'Après',
     BeforeSuite: 'AvantLaSuite',
@@ -12,11 +13,15 @@ module.exports = {
     amOutsideAngularApp: 'suisALExtérieurDeLApplicationAngular',
     amInsideAngularApp: 'suisALIntérieurDeLApplicationAngular',
     waitForElement: 'attendsLElément',
-    waitForClickable: 'attends',
+    waitForClickable: 'attendsDeCliquer',
     waitForVisible: 'attendsPourVoir',
+    waitForEnabled: 'attendsLActivationDe',
+    waitForInvisible: 'attendsLInvisibilitéDe',
+    waitInUrl: 'attendsDansLUrl',
     waitForText: 'attendsLeTexte',
     moveTo: 'vaisSur',
     refresh: 'rafraîchis',
+    refreshPage: 'rafraîchisLaPage',
     haveModule: 'ajouteLeModule',
     resetModule: 'réinitialiseLeModule',
     amOnPage: 'suisSurLaPage',
@@ -59,5 +64,13 @@ module.exports = {
     grabCookie: 'prendsLeCookie',
     resizeWindow: 'redimensionneLaFenêtre',
     wait: 'attends',
+    clearField: 'effaceLeChamp',
+    dontSeeElementInDOM: 'neVoisPasDansLeDOM',
+    moveCursorTo: 'bougeLeCurseurSur',
+    scrollTo: 'défileVers',
+    sendGetRequest: 'envoieLaRequêteGet',
+    sendPutRequest: 'envoieLaRequêtePut',
+    sendDeleteRequest: 'envoieLaRequêteDelete',
+    sendPostRequest: 'envoieLaRequêtePost',
   },
 };

package/translations/it-IT.js

@@ -3,6 +3,7 @@ module.exports = {
   contexts: {
     Feature: 'Caratteristica',
     Scenario: 'lo_scenario',
+    ScenarioOutline: 'Schema dello scenario',
     Before: 'Prima',
     After: 'Dopo',
     BeforeSuite: 'Prima_della_suite',

package/translations/ja-JP.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: '私は',
+  contexts: {
+    Feature: 'フィーチャ',
+    Scenario: 'シナリオ',
+    ScenarioOutline: 'シナリオアウトライン',
+  },
   actions: {
     amOutsideAngularApp: 'Angularの外に出る',
     amInsideAngularApp: 'Angularの中に入る',

package/translations/pl-PL.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: 'Ja',
+  contexts: {
+    Feature: 'Funkcja',
+    Scenario: 'Scenariusz',
+    ScenarioOutline: 'Szablon scenariusza',
+  },
   actions: {
     amOutsideAngularApp: 'jestem_poza_aplikacją_angular',
     amInsideAngularApp: 'jestem_w_aplikacji_angular',

package/translations/pt-BR.js

@@ -3,6 +3,7 @@ module.exports = {
   contexts: {
     Feature: 'Funcionalidade',
     Scenario: 'Cenário',
+    ScenarioOutline: 'Esquema do Cenário',
     Before: 'Antes',
     After: 'Depois',
     BeforeSuite: 'AntesDaSuite',

package/translations/ru-RU.js

@@ -3,6 +3,7 @@ module.exports = {
   contexts: {
     Feature: 'Цель',
     Scenario: 'Сценарий',
+    ScenarioOutline: 'Структура сценария',
     Before: 'Начало',
     After: 'Конец',
     BeforeSuite: 'Перед_всем',

package/translations/zh-CN.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: '我',
+  contexts: {
+    Feature: '功能',
+    Scenario: '场景',
+    ScenarioOutline: '场景大纲',
+  },
   actions: {
     amOutsideAngularApp: '在Angular应用外',
     amInsideAngularApp: '在Angular应用内',

package/translations/zh-TW.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: '我',
+  contexts: {
+    Feature: '功能',
+    Scenario: '場景',
+    ScenarioOutline: '場景大綱',
+  },
   actions: {
     amOutsideAngularApp: '在Angular應用外',
     amInsideAngularApp: '在Angular應用內',