codeceptjs 3.6.0-beta.1.ai-healers → 3.6.1

package/lib/locator.js

@@ -1,9 +1,9 @@
-const cssToXPath = require('csstoxpath');
+let cssToXPath;
 const { sprintf } = require('sprintf-js');
 
 const { xpathLocator } = require('./utils');
 
-const locatorTypes = ['css', 'by', 'xpath', 'id', 'name', 'fuzzy', 'frame', 'shadow'];
+const locatorTypes = ['css', 'by', 'xpath', 'id', 'name', 'fuzzy', 'frame', 'shadow', 'pw'];
 /** @class */
 class Locator {
   /**
@@ -51,6 +51,9 @@ class Locator {
     if (isShadow(locator)) {
       this.type = 'shadow';
     }
+    if (isPlaywrightLocator(locator)) {
+      this.type = 'pw';
+    }
 
     Locator.filters.forEach(f => f(locator, this));
   }
@@ -71,6 +74,8 @@ class Locator {
         return this.value;
       case 'shadow':
         return { shadow: this.value };
+      case 'pw':
+        return { pw: this.value };
     }
     return this.value;
   }
@@ -115,6 +120,13 @@ class Locator {
     return this.type === 'css';
   }
 
+  /**
+   * @returns {boolean}
+   */
+  isPlaywrightLocator() {
+    return this.type === 'pw';
+  }
+
   /**
    * @returns {boolean}
    */
@@ -162,8 +174,17 @@ class Locator {
    * @returns {string}
    */
   toXPath(pseudoSelector = '') {
+    const locator = `${this.value}${pseudoSelector}`;
+    const limitation = [':nth-of-type', ':first-of-type', ':last-of-type', ':nth-last-child', ':nth-last-of-type', ':checked', ':disabled', ':enabled', ':required', ':lang', ':nth-child'];
+
+    if (limitation.some(item => locator.includes(item))) {
+      cssToXPath = require('css-to-xpath');
+    } else {
+      cssToXPath = require('csstoxpath');
+    }
+
     if (this.isXPath()) return this.value;
-    if (this.isCSS()) return cssToXPath(`${this.value}${pseudoSelector}`);
+    if (this.isCSS()) return cssToXPath(locator);
 
     throw new Error('Can\'t be converted to XPath');
   }
@@ -250,7 +271,7 @@ class Locator {
    */
   withText(text) {
     text = xpathLocator.literal(text);
-    const xpath = this.toXPath(`:text-contains-case(${text})`);
+    const xpath = sprintf('%s[%s]', this.toXPath(), `contains(., ${text})`);
     return new Locator({ xpath });
   }
 
@@ -261,7 +282,7 @@ class Locator {
    */
   withTextEquals(text) {
     text = xpathLocator.literal(text);
-    const xpath = this.toXPath(`:text-case(${text})`);
+    const xpath = sprintf('%s[%s]', this.toXPath(), `.= ${text}`);
     return new Locator({ xpath });
   }
 
@@ -513,6 +534,16 @@ function removePrefix(xpath) {
     .replace(/^(\.|\/)+/, '');
 }
 
+/**
+ * @private
+ * check if the locator is a Playwright locator
+ * @param {string} locator
+ * @returns {boolean}
+ */
+function isPlaywrightLocator(locator) {
+  return locator.includes('_react') || locator.includes('_vue') || locator.includes('data-testid');
+}
+
 /**
  * @private
  * @param {CodeceptJS.LocatorOrString} locator

package/lib/pause.js

@@ -6,7 +6,7 @@ const debug = require('debug')('codeceptjs:pause');
 const container = require('./container');
 const history = require('./history');
 const store = require('./store');
-const AiAssistant = require('./ai');
+const aiAssistant = require('./ai');
 const recorder = require('./recorder');
 const event = require('./event');
 const output = require('./output');
@@ -18,7 +18,6 @@ let nextStep;
 let finish;
 let next;
 let registeredVariables = {};
-let aiAssistant;
 /**
  * Pauses test execution and starts interactive shell
  * @param {Object<string, *>} [passedObject]
@@ -44,8 +43,6 @@ 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`));
@@ -54,11 +51,9 @@ function pauseSession(passedObject = {}) {
     output.print(colors.yellow(` - Prefix ${colors.bold('=>')} to run js commands ${colors.bold(vars)}`));
 
     if (aiAssistant.isEnabled) {
-      output.print(colors.blue(` ${colors.bold('OpenAI is enabled! (experimental)')} Write what you want and make OpenAI run it`));
-      output.print(colors.blue(' Please note, only HTML fragments with interactive elements are sent to OpenAI'));
+      output.print(colors.blue(` ${colors.bold('AI is enabled! (experimental)')} Write what you want and make AI run it`));
+      output.print(colors.blue(' Please note, only HTML fragments with interactive elements are sent to AI provider'));
       output.print(colors.blue(' Ideas: ask it to fill forms for you or to click'));
-    } else {
-      output.print(colors.blue(` Enable OpenAI assistant by setting ${colors.bold('OPENAI_API_KEY')} env variable`));
     }
   }
   rl = readline.createInterface(process.stdin, process.stdout, completer);
@@ -125,7 +120,7 @@ async function parseInput(cmd) {
         } finally {
           output.level(currentOutputLevel);
         }
-        // aiAssistant.mockResponse("```js\nI.click('Sign in');\n```");
+
         const spinner = ora("Processing OpenAI request...").start();
         cmd = await aiAssistant.writeSteps(cmd);
         spinner.stop();

package/lib/plugin/coverage.js

@@ -1,44 +1,67 @@
 const debugModule = require('debug');
-const fs = require('fs');
-const path = require('path');
-
+const { CoverageReport } = require('monocart-coverage-reports');
 const Container = require('../container');
 const recorder = require('../recorder');
 const event = require('../event');
 const output = require('../output');
-const { clearString } = require('../utils');
+const { deepMerge } = require('../utils');
 
 const defaultConfig = {
-  coverageDir: 'output/coverage',
-  uniqueFileName: true,
+  name: 'CodeceptJS Coverage Report',
+  outputDir: 'output/coverage',
 };
 
 const supportedHelpers = ['Puppeteer', 'Playwright'];
 
-function buildFileName(test, uniqueFileName) {
-  let fileName = clearString(test.title);
-
-  // This prevent data driven to be included in the failed screenshot file name
-  if (fileName.indexOf('{') !== -1) {
-    fileName = fileName.substr(0, fileName.indexOf('{') - 3).trim();
-  }
-
-  if (test.ctx && test.ctx.test && test.ctx.test.type === 'hook') {
-    fileName = clearString(`${test.title}_${test.ctx.test.title}`);
-  }
-
-  if (uniqueFileName) {
-    const uuid = test.uuid
-      || test.ctx.test.uuid
-      || Math.floor(new Date().getTime() / 1000);
-
-    fileName = `${fileName.substring(0, 10)}_${uuid}.coverage.json`;
-  } else {
-    fileName = `${fileName}.coverage.json`;
-  }
-
-  return fileName;
-}
+const v8CoverageHelpers = {
+  Playwright: {
+    startCoverage: async (page) => {
+      await Promise.all([
+        page.coverage.startJSCoverage({
+          resetOnNavigation: false,
+        }),
+        page.coverage.startCSSCoverage({
+          resetOnNavigation: false,
+        }),
+      ]);
+    },
+    takeCoverage: async (page, coverageReport) => {
+      const [jsCoverage, cssCoverage] = await Promise.all([
+        page.coverage.stopJSCoverage(),
+        page.coverage.stopCSSCoverage(),
+      ]);
+      const coverageList = [...jsCoverage, ...cssCoverage];
+      await coverageReport.add(coverageList);
+    },
+  },
+  Puppeteer: {
+    startCoverage: async (page) => {
+      await Promise.all([
+        page.coverage.startJSCoverage({
+          resetOnNavigation: false,
+          includeRawScriptCoverage: true,
+        }),
+        page.coverage.startCSSCoverage({
+          resetOnNavigation: false,
+        }),
+      ]);
+    },
+    takeCoverage: async (page, coverageReport) => {
+      const [jsCoverage, cssCoverage] = await Promise.all([
+        page.coverage.stopJSCoverage(),
+        page.coverage.stopCSSCoverage(),
+      ]);
+      // to raw V8 script coverage
+      const coverageList = [...jsCoverage.map((it) => {
+        return {
+          source: it.text,
+          ...it.rawScriptCoverage,
+        };
+      }), ...cssCoverage];
+      await coverageReport.add(coverageList);
+    },
+  },
+};
 
 /**
  * Dumps code coverage from Playwright/Puppeteer after every test.
@@ -49,94 +72,84 @@ function buildFileName(test, uniqueFileName) {
  * ```js
  * plugins: {
  *    coverage: {
- *      enabled: true
+ *      enabled: true,
+ *      debug: true,
+ *      name: 'CodeceptJS Coverage Report',
+ *      outputDir: 'output/coverage'
  *    }
  * }
  * ```
  *
- * Possible config options:
+ * Possible config options, More could be found at [monocart-coverage-reports](https://github.com/cenfun/monocart-coverage-reports?tab=readme-ov-file#default-options)
+ *
+ * * `debug`: debug info. By default, false.
+ * * `name`: coverage report name.
+ * * `outputDir`: path to coverage report.
+ * * `sourceFilter`: filter the source files.
+ * * `sourcePath`: option to resolve a custom path.
  *
- * * `coverageDir`: directory to dump coverage files
- * * `uniqueFileName`: generate a unique filename by adding uuid
  */
 module.exports = function (config) {
+  config = deepMerge(defaultConfig, config);
+
+  if (config.debug) config.logging = 'debug';
+
   const helpers = Container.helpers();
   let coverageRunning = false;
-  let helper;
 
-  let debug;
-  for (const helperName of supportedHelpers) {
-    if (Object.keys(helpers).indexOf(helperName) > -1) {
-      helper = helpers[helperName];
-      debug = debugModule(`codeceptjs:plugin:${helperName.toLowerCase()}Coverage`);
-    }
+  const v8Names = Object.keys(v8CoverageHelpers);
+  const helperName = Object.keys(helpers).find((it) => v8Names.includes(it));
+  if (!helperName) {
+    console.error(`Coverage is only supported in ${supportedHelpers.join(' or ')}`);
+    // no helpers for screenshot
+    return;
   }
 
-  if (!helper) {
-    console.error('Coverage is only supported in Puppeteer, Playwright');
-    return; // no helpers for screenshot
-  }
+  config.name = `${config.name} - in ${helperName}`;
+  const debug = debugModule(`codeceptjs:plugin:${helperName.toLowerCase()}Coverage`);
+
+  const helper = helpers[helperName];
+  const v8Helper = v8CoverageHelpers[helperName];
 
-  const options = Object.assign(defaultConfig, helper.options, config);
+  const coverageOptions = {
+    ...config,
+  };
+  const coverageReport = new CoverageReport(coverageOptions);
+  coverageReport.cleanCache();
 
-  event.dispatcher.on(event.all.before, async () => {
-    output.debug('*** Collecting coverage for tests ****');
+  event.dispatcher.on(event.all.after, async () => {
+    output.print(`writing ${coverageOptions.outputDir}`);
+    await coverageReport.generate();
   });
 
-  //  Hack!  we're going to try to "start" coverage before each step because this is
+  //  we're going to try to "start" coverage before each step because this is
   //  when the browser is already up and is ready to start coverage.
-  event.dispatcher.on(event.step.before, async () => {
-    recorder.add(
-      'starting coverage',
-      async () => {
-        try {
-          if (!coverageRunning && helper.page && helper.page.coverage) {
-            debug('--> starting coverage <--');
-            coverageRunning = true;
-            await helper.page.coverage.startJSCoverage();
-          }
-        } catch (err) {
-          console.error(err);
-        }
-      },
-      true,
-    );
+  event.dispatcher.on(event.step.before, () => {
+    recorder.add('start coverage', async () => {
+      if (coverageRunning) {
+        return;
+      }
+      if (!helper.page || !helper.page.coverage) {
+        return;
+      }
+      coverageRunning = true;
+      debug('--> starting coverage <--');
+      await v8Helper.startCoverage(helper.page);
+    }, true);
   });
 
   // Save coverage data after every test run
-  event.dispatcher.on(event.test.after, async (test) => {
-    recorder.add(
-      'saving coverage',
-      async () => {
-        try {
-          if (coverageRunning && helper.page && helper.page.coverage) {
-            debug('--> stopping coverage <--');
-            coverageRunning = false;
-            const coverage = await helper.page.coverage.stopJSCoverage();
-
-            const coverageDir = path.resolve(
-              process.cwd(),
-              options.coverageDir,
-            );
-
-            // Checking if coverageDir already exists, if not, create new one
-
-            if (!fs.existsSync(coverageDir)) {
-              fs.mkdirSync(coverageDir, { recursive: true });
-            }
-
-            const coveragePath = path.resolve(
-              coverageDir,
-              buildFileName(test, options.uniqueFileName),
-            );
-            output.print(`writing ${coveragePath}`);
-            fs.writeFileSync(coveragePath, JSON.stringify(coverage));
-          }
-        } catch (err) {
-          console.error(err);
-        }
-      },
-      true,
-    );
+  event.dispatcher.on(event.test.after, (test) => {
+    recorder.add('take coverage', async () => {
+      if (!coverageRunning) {
+        return;
+      }
+      if (!helper.page || !helper.page.coverage) {
+        return;
+      }
+      coverageRunning = false;
+      debug('--> stopping coverage <--');
+      await v8Helper.takeCoverage(helper.page, coverageReport);
+    }, true);
   });
 };

package/lib/step.js

@@ -119,7 +119,9 @@ class Step {
     }
     let result;
     try {
-      result = this.helper[this.helperMethod].apply(this.helper, this.args);
+      if (this.helperMethod !== 'say') {
+        result = this.helper[this.helperMethod].apply(this.helper, this.args);
+      }
       this.setStatus('success');
     } catch (err) {
       this.setStatus('failed');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.6.0-beta.1.ai-healers",
+  "version": "3.6.1",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -23,13 +23,13 @@
   },
   "files": [
     "bin",
-    "docs",
     "lib",
     "translations",
-    "typings/**/*.d.ts"
+    "typings/**/*.d.ts",
+    "docs/webapi/**"
   ],
   "main": "lib/index.js",
-  "typings": "typings/index.d.ts",
+  "types": "typings/index.d.ts",
   "bin": {
     "codeceptjs": "./bin/codecept.js"
   },
@@ -56,54 +56,59 @@
     "test:unit:webbapi:webDriver:devtools": "mocha test/helper/WebDriver_devtools_test.js --exit",
     "test:unit:webbapi:testCafe": "mocha test/helper/TestCafe_test.js",
     "test:unit:expect": "mocha test/helper/Expect_test.js",
+    "test:unit:mockServer": "mocha test/helper/MockServer_test.js",
     "test:plugin": "mocha test/plugin/plugin_test.js",
     "def": "./runok.js def",
     "dev:graphql": "node test/data/graphql/index.js",
     "publish:site": "./runok.js publish:site",
     "update-contributor-faces": "./runok.js contributor:faces",
-    "dtslint": "dtslint typings --localTs './node_modules/typescript/lib'",
+    "types-fix": "node typings/fixDefFiles.js",
+    "dtslint": "npm run types-fix && tsd",
     "prepare": "husky install",
     "prepare-release": "./runok.js versioning && ./runok.js get:commit-log"
   },
   "dependencies": {
-    "@codeceptjs/configure": "0.10.0",
-    "@codeceptjs/helper": "2.0.1",
+    "@codeceptjs/configure": "1.0.1",
+    "@codeceptjs/helper": "2.0.4",
     "@cucumber/cucumber-expressions": "17",
     "@cucumber/gherkin": "26",
-    "@cucumber/messages": "24.0.1",
+    "@cucumber/messages": "24.1.0",
     "@xmldom/xmldom": "0.8.10",
-    "acorn": "8.11.2",
+    "acorn": "8.11.3",
     "arrify": "2.0.1",
-    "axios": "1.6.3",
-    "chai": "4.3.8",
+    "axios": "1.6.7",
+    "chai": "5.1.0",
     "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",
+    "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.1.0",
     "cross-spawn": "7.0.3",
+    "css-to-xpath": "0.1.0",
     "csstoxpath": "1.6.0",
-    "devtools": "8.27.2",
-    "envinfo": "7.11.0",
+    "devtools": "8.33.1",
+    "envinfo": "7.11.1",
     "escape-string-regexp": "4.0.0",
     "figures": "3.2.0",
     "fn-args": "4.0.0",
     "fs-extra": "11.2.0",
     "glob": "6.0.1",
-    "html-minifier-terser": "^7.2.0",
+    "html-minifier-terser": "7.2.0",
     "inquirer": "6.5.2",
-    "joi": "17.11.0",
-    "js-beautify": "1.14.11",
+    "joi": "17.12.2",
+    "js-beautify": "1.15.1",
     "lodash.clonedeep": "4.5.0",
     "lodash.merge": "4.6.2",
     "mkdirp": "1.0.4",
-    "mocha": "10.2.0",
+    "mocha": "10.3.0",
+    "monocart-coverage-reports": "2.7.4",
     "ms": "2.1.3",
     "ora-classic": "5.4.2",
-    "parse-function": "5.6.4",
+    "pactum": "3.6.6",
+    "parse-function": "5.6.10",
     "parse5": "7.1.2",
     "promise-retry": "1.1.1",
     "resq": "1.11.0",
@@ -111,55 +116,55 @@
     "uuid": "9.0"
   },
   "optionalDependencies": {
-    "@codeceptjs/detox-helper": "1.0.2"
+    "@codeceptjs/detox-helper": "1.0.5"
   },
   "devDependencies": {
     "@codeceptjs/mock-request": "0.3.1",
     "@faker-js/faker": "7.6.0",
     "@pollyjs/adapter-puppeteer": "6.0.6",
     "@pollyjs/core": "5.1.0",
-    "@types/chai": "^4.3.7",
+    "@types/chai": "4.3.12",
     "@types/inquirer": "9.0.3",
-    "@types/node": "20.10.7",
-    "@wdio/sauce-service": "8.27.0",
+    "@types/node": "20.11.30",
+    "@wdio/sauce-service": "8.35.1",
     "@wdio/selenium-standalone-service": "8.3.2",
-    "@wdio/utils": "8.27.2",
+    "@wdio/utils": "8.33.1",
     "@xmldom/xmldom": "0.8.10",
     "apollo-server-express": "2.25.3",
     "chai-as-promised": "7.1.1",
     "chai-subset": "1.6.0",
     "contributor-faces": "1.1.0",
     "documentation": "12.3.0",
-    "dtslint": "4.2.1",
-    "electron": "28.0.0",
+    "electron": "28.2.1",
     "eslint": "8.56.0",
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-plugin-import": "2.29.1",
     "eslint-plugin-mocha": "6.3.0",
     "expect": "29.7.0",
-    "express": "4.18.2",
+    "express": "4.19.2",
     "graphql": "14.6.0",
     "husky": "8.0.3",
     "inquirer-test": "2.0.1",
     "jsdoc": "3.6.11",
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.10.1",
-    "playwright": "1.40.1",
-    "puppeteer": "21.1.1",
+    "playwright": "1.43.0",
+    "puppeteer": "22.6.3",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.1",
     "runok": "0.9.3",
     "sinon": "17.0.1",
     "sinon-chai": "3.7.0",
-    "testcafe": "3.3.0",
+    "testcafe": "3.5.0",
     "ts-morph": "21.0.1",
     "ts-node": "10.9.2",
+    "tsd": "^0.31.0",
     "tsd-jsdoc": "2.5.0",
-    "typedoc": "0.25.7",
+    "typedoc": "0.25.12",
     "typedoc-plugin-markdown": "3.17.1",
     "typescript": "5.3.3",
     "wdio-docker-service": "1.5.0",
-    "webdriverio": "8.27.2",
+    "webdriverio": "8.35.1",
     "xml2js": "0.6.2",
     "xpath": "0.0.34"
   },
@@ -167,5 +172,11 @@
     "node": ">=16.0",
     "npm": ">=5.6.0"
   },
-  "es6": true
-}
+  "es6": true,
+  "tsd": {
+    "directory": "typings",
+    "compilerOptions": {
+      "strict": false
+    }
+  }
+}

package/typings/index.d.ts

@@ -8,6 +8,7 @@
 
 declare namespace CodeceptJS {
   type WithTranslation<T> = T &
+    // @ts-ignore
     import("./utils").Translate<T, Translation.Actions>;
 
   type Cookie = {
@@ -382,6 +383,22 @@ declare namespace CodeceptJS {
     [key: string]: any;
   };
 
+  type MockRequest = {
+    method: 'GET'|'PUT'|'POST'|'PATCH'|'DELETE'|string;
+    path: string;
+    queryParams?: object;
+  }
+
+  type MockResponse = {
+    status: number;
+    body?: object;
+  }
+
+  type MockInteraction = {
+    request: MockRequest;
+    response: MockResponse;
+  }
+
   interface PageScrollPosition {
     x: number;
     y: number;
@@ -425,8 +442,8 @@ declare namespace CodeceptJS {
     | { react: string }
     | { vue: string }
     | { shadow: string[] }
-    | { custom: string };
-
+    | { custom: string }
+    | { pw: string };
   interface CustomLocators {}
   interface OtherLocators { props?: object }
   type LocatorOrString =