codeceptjs 3.5.10 → 3.5.12-beta.1

package/lib/plugin/retryFailedStep.js

@@ -1,6 +1,7 @@
 const event = require('../event');
 const recorder = require('../recorder');
 const container = require('../container');
+const { log } = require('../output');
 
 const defaultConfig = {
   retries: 3,
@@ -43,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*`
@@ -99,7 +100,10 @@ module.exports = (config) => {
   config.when = when;
 
   event.dispatcher.on(event.step.started, (step) => {
-    if (container.plugins('tryTo')) return;
+    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) {

package/lib/plugin/retryTo.js

@@ -89,9 +89,9 @@ module.exports = function (config) {
     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);

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.5.10",
+  "version": "3.5.12-beta.1",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -23,7 +23,6 @@
   },
   "files": [
     "bin",
-    "docs",
     "lib",
     "translations",
     "typings/**/*.d.ts"
@@ -52,8 +51,11 @@
     "test:unit:webbapi:playwright": "mocha test/helper/Playwright_test.js",
     "test:unit:webbapi:puppeteer": "mocha test/helper/Puppeteer_test.js",
     "test:unit:webbapi:webDriver": "mocha test/helper/WebDriver_test.js",
+    "test:unit:webbapi:webDriver:noSeleniumServer": "mocha test/helper/WebDriver.noSeleniumServer_test.js",
+    "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: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",
@@ -65,13 +67,13 @@
   "dependencies": {
     "@codeceptjs/configure": "0.10.0",
     "@codeceptjs/helper": "2.0.1",
-    "@cucumber/cucumber-expressions": "16",
+    "@cucumber/cucumber-expressions": "17",
     "@cucumber/gherkin": "26",
-    "@cucumber/messages": "22.0.0",
+    "@cucumber/messages": "24.0.1",
     "@xmldom/xmldom": "0.8.10",
     "acorn": "8.11.2",
     "arrify": "2.0.1",
-    "axios": "1.6.2",
+    "axios": "1.6.3",
     "chai": "4.3.8",
     "chai-deep-match": "1.2.1",
     "chai-exclude": "^2.1.0",
@@ -81,8 +83,9 @@
     "chai-string": "^1.5.0",
     "chalk": "4.1.2",
     "commander": "11.1.0",
-    "convert-cssxpath": "1.0.2",
     "cross-spawn": "7.0.3",
+    "csstoxpath": "1.6.0",
+    "devtools": "8.27.2",
     "envinfo": "7.11.0",
     "escape-string-regexp": "4.0.0",
     "figures": "3.2.0",
@@ -103,7 +106,7 @@
     "parse-function": "5.6.4",
     "parse5": "7.1.2",
     "promise-retry": "1.1.1",
-    "resq": "1.10.2",
+    "resq": "1.11.0",
     "sprintf-js": "1.1.1",
     "uuid": "9.0"
   },
@@ -117,20 +120,21 @@
     "@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",
+    "@types/node": "20.10.7",
+    "@wdio/sauce-service": "8.27.0",
     "@wdio/selenium-standalone-service": "8.3.2",
-    "@wdio/utils": "8.20.3",
+    "@wdio/utils": "8.27.2",
+    "@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": "27.0.4",
-    "eslint": "8.55.0",
+    "electron": "28.0.0",
+    "eslint": "8.56.0",
     "eslint-config-airbnb-base": "15.0.0",
-    "eslint-plugin-import": "2.29.0",
+    "eslint-plugin-import": "2.29.1",
     "eslint-plugin-mocha": "6.3.0",
     "expect": "29.7.0",
     "express": "4.18.2",
@@ -143,22 +147,21 @@
     "playwright": "1.40.1",
     "puppeteer": "21.1.1",
     "qrcode-terminal": "0.12.0",
-    "rosie": "2.1.0",
+    "rosie": "2.1.1",
     "runok": "0.9.3",
     "sinon": "17.0.1",
     "sinon-chai": "3.7.0",
     "testcafe": "3.3.0",
-    "ts-morph": "19.0.0",
-    "ts-node": "10.9.1",
+    "ts-morph": "21.0.1",
+    "ts-node": "10.9.2",
     "tsd-jsdoc": "2.5.0",
-    "typedoc": "0.25.3",
-    "typedoc-plugin-markdown": "3.13.4",
-    "typescript": "5.2.2",
+    "typedoc": "0.25.7",
+    "typedoc-plugin-markdown": "3.17.1",
+    "typescript": "5.3.3",
     "wdio-docker-service": "1.5.0",
-    "webdriverio": "8.3.8",
+    "webdriverio": "8.27.2",
     "xml2js": "0.6.2",
-    "@xmldom/xmldom": "0.7.7",
-    "xpath": "0.0.33"
+    "xpath": "0.0.34"
   },
   "engines": {
     "node": ">=16.0",

package/typings/index.d.ts

@@ -97,7 +97,7 @@ declare namespace CodeceptJS {
      *   }
      * }
      * ```
-    */
+     */
     helpers?: {
       /**
        * Run web tests controlling browsers via Playwright engine.
@@ -289,7 +289,7 @@ declare namespace CodeceptJS {
      * ```js
      * bootstrap: 'bootstrap.js',
      * ```
-    */
+     */
     bootstrap?: (() => Promise<void>) | boolean | string;
     /**
      * [Execute code after tests](https://codecept.io/bootstrap/) finished.
@@ -303,7 +303,7 @@ declare namespace CodeceptJS {
      * ```js
      * teardown: 'teardown.js',
      * ```
-    */
+     */
     teardown?: (() => Promise<void>) | boolean | string;
     /**
      * [Execute code before launching tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall)
@@ -312,7 +312,7 @@ declare namespace CodeceptJS {
     bootstrapAll?: (() => Promise<void>) | boolean | string;
     /**
      * [Execute JS code after finishing tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall)
-    */
+     */
     teardownAll?: (() => Promise<void>) | boolean | string;
 
     /** Enable [localized test commands](https://codecept.io/translation/) */
@@ -328,7 +328,7 @@ declare namespace CodeceptJS {
      * ```
      * require: ["should"]
      * ```
-    */
+     */
     require?: Array<string>;
 
     /**
@@ -423,14 +423,17 @@ declare namespace CodeceptJS {
     | { ios: string }
     | { android: string; ios: string }
     | { react: string }
+    | { vue: string }
     | { shadow: string[] }
     | { custom: string };
 
   interface CustomLocators {}
+  interface OtherLocators { props?: object }
   type LocatorOrString =
     | string
     | ILocator
     | Locator
+    | OtherLocators
     | CustomLocators[keyof CustomLocators];
 
   type StringOrSecret = string | CodeceptJS.Secret;