codeceptjs 3.5.7-beta.1 → 3.5.8

package/lib/plugin/heal.js

@@ -8,7 +8,6 @@ const output = require('../output');
 const supportedHelpers = require('./standardActingHelpers');
 
 const defaultConfig = {
-  healTries: 1,
   healLimit: 2,
   healSteps: [
     'click',
@@ -55,14 +54,11 @@ const defaultConfig = {
  *
  */
 module.exports = function (config = {}) {
-  const aiAssistant = AiAssistant.getInstance();
+  const aiAssistant = new AiAssistant();
 
   let currentTest = null;
   let currentStep = null;
   let healedSteps = 0;
-  let caughtError;
-  let healTries = 0;
-  let isHealing = false;
 
   const healSuggestions = [];
 
@@ -71,35 +67,20 @@ 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.after, (step) => {
-    if (isHealing) return;
+  event.dispatcher.on(event.step.before, () => {
     const store = require('../store');
     if (store.debugMode) return;
+
     recorder.catchWithoutStop(async (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 (!aiAssistant.isEnabled) 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');
@@ -130,17 +111,9 @@ module.exports = function (config = {}) {
 
       if (!html) throw err;
 
-      healTries++;
-      await aiAssistant.setHtmlContext(html);
+      aiAssistant.setHtmlContext(html);
       await tryToHeal(step, err);
-
-      recorder.add('close healing session', () => {
-        recorder.session.restore('heal');
-        recorder.ignoreErr(err);
-      });
-      await recorder.promise();
-
-      isHealing = false;
+      recorder.session.restore();
     });
   });
 
@@ -182,9 +155,6 @@ 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({
@@ -193,17 +163,14 @@ module.exports = function (config = {}) {
           snippet: codeSnippet,
         });
 
-        recorder.add('healed', () => output.print(colors.bold.green('  Code healed successfully')));
+        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/recorder.js

@@ -11,7 +11,6 @@ let errFn;
 let queueId = 0;
 let sessionId = null;
 let asyncErr = null;
-let ignoredErrs = [];
 
 let tasks = [];
 let oldPromises = [];
@@ -94,7 +93,6 @@ 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 = [];
@@ -228,10 +226,9 @@ module.exports = {
    * @inner
    */
   catch(customErrFn) {
-    const fnDescription = customErrFn?.toString()?.replace(/\s{2,}/g, ' ').replace(/\n/g, ' ')?.slice(0, 50);
-    debug(`${currentQueue()}Queued | catch with error handler ${fnDescription || ''}`);
+    debug(`${currentQueue()}Queued | catch with error handler`);
     return promise = promise.catch((err) => {
-      log(`${currentQueue()}Error | ${err} ${fnDescription}...`);
+      log(`${currentQueue()}Error | ${err}`);
       if (!(err instanceof Error)) { // strange things may happen
         err = new Error(`[Wrapped Error] ${printObjectProperties(err)}`); // we should be prepared for them
       }
@@ -250,15 +247,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) => {
-      if (ignoredErrs.includes(err)) return; // already caught
-      log(`${currentQueue()}Error (Non-Terminated) | ${err} | ${fnDescription || ''}...`);
+      log(`${currentQueue()}Error | ${err}`);
       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);
       }
     });
   },
@@ -277,10 +274,6 @@ module.exports = {
     });
   },
 
-  ignoreErr(err) {
-    ignoredErrs.push(err);
-  },
-
   /**
    * @param {*} err
    * @inner

package/lib/utils.js

@@ -11,7 +11,7 @@ function deepMerge(target, source) {
 }
 
 module.exports.genTestId = (test) => {
-  return require('crypto').createHash('md5').update(test.fullTitle()).digest('base64')
+  return require('crypto').createHash('sha256').update(test.fullTitle()).digest('base64')
     .slice(0, -2);
 };
 

package/lib/workers.js

@@ -94,10 +94,31 @@ const createWorkerObjects = (testGroups, config, testRoot, options, selectedRuns
     });
   }
   const workersToExecute = [];
+
+  const currentOutputFolder = config.output;
+  let currentMochawesomeReportDir;
+  let currentMochaJunitReporterFile;
+
+  if (config.mocha && config.mocha.reporterOptions) {
+    currentMochawesomeReportDir = config.mocha.reporterOptions?.mochawesome.options.reportDir;
+    currentMochaJunitReporterFile = config.mocha.reporterOptions['mocha-junit-reporter'].options.mochaFile;
+  }
+
   collection.createRuns(selectedRuns, config).forEach((worker) => {
-    const workerName = worker.getOriginalName() || worker.getName();
+    const separator = path.sep;
+    const _config = { ...config };
+    let workerName = worker.name.replace(':', '_');
+    _config.output = `${currentOutputFolder}${separator}${workerName}`;
+    if (config.mocha && config.mocha.reporterOptions) {
+      _config.mocha.reporterOptions.mochawesome.options.reportDir = `${currentMochawesomeReportDir}${separator}${workerName}`;
+
+      const _tempArray = currentMochaJunitReporterFile.split(separator);
+      _tempArray.splice(_tempArray.findIndex(item => item.includes('.xml')), 0, workerName);
+      _config.mocha.reporterOptions['mocha-junit-reporter'].options.mochaFile = _tempArray.join(separator);
+    }
+    workerName = worker.getOriginalName() || worker.getName();
     const workerConfig = worker.getConfig();
-    workersToExecute.push(getOverridenConfig(workerName, workerConfig, config));
+    workersToExecute.push(getOverridenConfig(workerName, workerConfig, _config));
   });
   const workers = [];
   let index = 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.5.7-beta.1",
+  "version": "3.5.8",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -43,8 +43,10 @@
     "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'",
+    "test:appium-quick": "mocha test/helper/AppiumV2_test.js --grep 'quick'",
+    "test:appium-other": "mocha test/helper/AppiumV2_test.js --grep 'second'",
+    "test:ios:appium-quick": "mocha test/helper/AppiumV2_ios_test.js --grep 'quick'",
+    "test:ios:appium-other": "mocha test/helper/AppiumV2_ios_test.js --grep 'second'",
     "test-app:start": "php -S 127.0.0.1:8000 -t test/data/app",
     "test-app:stop": "kill -9 $(lsof -t -i:8000)",
     "test:unit:webbapi:playwright": "mocha test/helper/Playwright_test.js",
@@ -86,9 +88,9 @@
     "fn-args": "4.0.0",
     "fs-extra": "8.1.0",
     "glob": "6.0.1",
-    "html-minifier-terser": "^7.2.0",
+    "html-minifier": "4.0.0",
     "inquirer": "6.5.2",
-    "joi": "17.6.0",
+    "joi": "17.11.0",
     "js-beautify": "1.14.9",
     "lodash.clonedeep": "4.5.0",
     "lodash.merge": "4.6.2",
@@ -115,24 +117,24 @@
     "@types/node": "20.4.4",
     "@wdio/sauce-service": "8.3.8",
     "@wdio/selenium-standalone-service": "8.3.2",
-    "@wdio/utils": "8.16.22",
+    "@wdio/utils": "8.20.3",
     "apollo-server-express": "2.25.3",
     "chai-as-promised": "7.1.1",
     "chai-subset": "1.6.0",
-    "contributor-faces": "1.0.3",
+    "contributor-faces": "1.1.0",
     "documentation": "12.3.0",
-    "dtslint": "4.1.6",
-    "electron": "27.0.2",
-    "eslint": "8.50.0",
+    "dtslint": "4.2.1",
+    "electron": "27.0.4",
+    "eslint": "8.53.0",
     "eslint-config-airbnb-base": "15.0.0",
-    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-import": "2.29.0",
     "eslint-plugin-mocha": "6.3.0",
     "expect": "29.7.0",
-    "express": "4.17.2",
+    "express": "4.18.2",
     "graphql": "14.6.0",
     "husky": "8.0.3",
     "inquirer-test": "2.0.1",
-    "jsdoc": "3.6.10",
+    "jsdoc": "3.6.11",
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.10.1",
     "playwright": "1.39.0",
@@ -140,13 +142,13 @@
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.0",
     "runok": "0.9.3",
-    "sinon": "15.2.0",
+    "sinon": "17.0.1",
     "sinon-chai": "3.7.0",
     "testcafe": "3.3.0",
     "ts-morph": "19.0.0",
     "ts-node": "10.9.1",
     "tsd-jsdoc": "2.5.0",
-    "typedoc": "0.24.8",
+    "typedoc": "0.25.3",
     "typedoc-plugin-markdown": "3.13.4",
     "typescript": "5.2.2",
     "wdio-docker-service": "1.5.0",

package/typings/promiseBasedTypes.d.ts

@@ -508,10 +508,12 @@ declare namespace CodeceptJS {
          * I.setNetworkConnection(4) // airplane mode off, wifi off, data on
          * I.setNetworkConnection(6) // airplane mode off, wifi on, data on
          * ```
-         * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/setNetworkConnection.html).
-         * @returns Appium: support only Android
+         * See corresponding [webdriverio reference](https://webdriver.io/docs/api/chromium/#setnetworkconnection).
+         *
+         * Appium: support only Android
+         * @param value - The network connection mode bitmask
          */
-        setNetworkConnection(): Promise<{}>;
+        setNetworkConnection(value: number): Promise<number>;
         /**
          * Update the current setting on the device
          *
@@ -2816,6 +2818,10 @@ declare namespace CodeceptJS {
      * npm i playwright-core@^1.18 --save
      * ```
      *
+     * Breaking Changes: if you use Playwright v1.38 and later, it will no longer download browsers automatically.
+     *
+     * Run `npx playwright install` to download browsers after `npm install`.
+     *
      * Using playwright-core package, will prevent the download of browser binaries and allow connecting to an existing browser installation or for connecting to a remote one.
      *
      *
@@ -3178,6 +3184,18 @@ declare namespace CodeceptJS {
          * @returns automatically synchronized promise through #recorder
          */
         blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<void>;
+        /**
+         * Return the checked status of given element.
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @param [options] - See https://playwright.dev/docs/api/class-locator#locator-is-checked
+         */
+        grabCheckedElementStatus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<boolean>;
+        /**
+         * Return the disabled status of given element.
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @param [options] - See https://playwright.dev/docs/api/class-locator#locator-is-disabled
+         */
+        grabDisabledElementStatus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<boolean>;
         /**
          * Drag an item to a destination element.
          *
@@ -6171,6 +6189,14 @@ declare namespace CodeceptJS {
      *
      * <!-- configuration -->
      *
+     * #### Trace Recording Customization
+     *
+     * Trace recording provides complete information on test execution and includes screenshots, and network requests logged during run.
+     * Traces will be saved to `output/trace`
+     *
+     * * `trace`: enables trace recording for failed tests; trace are saved into `output/trace` folder
+     * * `keepTraceForPassedTests`: - save trace for passed tests
+     *
      * #### Example #1: Wait for 0 network connections.
      *
      * ```js

package/typings/types.d.ts

@@ -508,10 +508,12 @@ declare namespace CodeceptJS {
          * I.setNetworkConnection(4) // airplane mode off, wifi off, data on
          * I.setNetworkConnection(6) // airplane mode off, wifi on, data on
          * ```
-         * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/setNetworkConnection.html).
-         * @returns Appium: support only Android
+         * See corresponding [webdriverio reference](https://webdriver.io/docs/api/chromium/#setnetworkconnection).
+         *
+         * Appium: support only Android
+         * @param value - The network connection mode bitmask
          */
-        setNetworkConnection(): Promise<{}>;
+        setNetworkConnection(value: number): Promise<number>;
         /**
          * Update the current setting on the device
          *
@@ -2903,6 +2905,10 @@ declare namespace CodeceptJS {
      * npm i playwright-core@^1.18 --save
      * ```
      *
+     * Breaking Changes: if you use Playwright v1.38 and later, it will no longer download browsers automatically.
+     *
+     * Run `npx playwright install` to download browsers after `npm install`.
+     *
      * Using playwright-core package, will prevent the download of browser binaries and allow connecting to an existing browser installation or for connecting to a remote one.
      *
      *
@@ -3265,6 +3271,18 @@ declare namespace CodeceptJS {
          * @returns automatically synchronized promise through #recorder
          */
         blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<void>;
+        /**
+         * Return the checked status of given element.
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @param [options] - See https://playwright.dev/docs/api/class-locator#locator-is-checked
+         */
+        grabCheckedElementStatus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<boolean>;
+        /**
+         * Return the disabled status of given element.
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @param [options] - See https://playwright.dev/docs/api/class-locator#locator-is-disabled
+         */
+        grabDisabledElementStatus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<boolean>;
         /**
          * Drag an item to a destination element.
          *
@@ -6258,6 +6276,8 @@ declare namespace CodeceptJS {
      * @property [disableScreenshots = false] - don't save screenshot on failure.
      * @property [fullPageScreenshots = false] - make full page screenshots on failure.
      * @property [uniqueScreenshotNames = false] - option to prevent screenshot override if you have scenarios with the same name in different suites.
+     * @property [trace = false] - record [tracing information](https://pptr.dev/api/puppeteer.tracing) with screenshots.
+     * @property [keepTraceForPassedTests = false] - save trace for passed tests.
      * @property [keepBrowserState = false] - keep browser state between tests when `restart` is set to false.
      * @property [keepCookies = false] - keep cookies between tests when `restart` is set to false.
      * @property [waitForAction = 100] - how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
@@ -6280,6 +6300,8 @@ declare namespace CodeceptJS {
         disableScreenshots?: boolean;
         fullPageScreenshots?: boolean;
         uniqueScreenshotNames?: boolean;
+        trace?: boolean;
+        keepTraceForPassedTests?: boolean;
         keepBrowserState?: boolean;
         keepCookies?: boolean;
         waitForAction?: number;
@@ -6313,6 +6335,14 @@ declare namespace CodeceptJS {
      *
      * <!-- configuration -->
      *
+     * #### Trace Recording Customization
+     *
+     * Trace recording provides complete information on test execution and includes screenshots, and network requests logged during run.
+     * Traces will be saved to `output/trace`
+     *
+     * * `trace`: enables trace recording for failed tests; trace are saved into `output/trace` folder
+     * * `keepTraceForPassedTests`: - save trace for passed tests
+     *
      * #### Example #1: Wait for 0 network connections.
      *
      * ```js