codeceptjs 3.1.3 → 3.2.3

package/lib/step.js

@@ -13,6 +13,27 @@ const STACK_LINE = 4;
  * @param {string} name
  */
 class Step {
+  static get TIMEOUT_ORDER() {
+    return {
+      /**
+       * timeouts set with order below zero only override timeouts of higher order if their value is smaller
+       */
+      testOrSuite: -5,
+      /**
+       * 0-9 - designated for override of timeouts set from code, 5 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=true
+       */
+      stepTimeoutHard: 5,
+      /**
+       * 10-19 - designated for timeouts set from code, 15 is order of I.setTimeout(t) operation
+       */
+      codeLimitTime: 15,
+      /**
+       * 20-29 - designated for timeout settings which could be overriden in tests code, 25 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=false
+       */
+      stepTimeoutSoft: 25,
+    };
+  }
+
   constructor(helper, name) {
     /** @member {string} */
     this.actor = 'I'; // I = actor
@@ -38,6 +59,41 @@ class Step {
     this.metaStep = undefined;
     /** @member {string} */
     this.stack = '';
+
+    const timeouts = new Map();
+    /**
+     * @method
+     * @returns {number|undefined}
+     */
+    this.getTimeout = function () {
+      let totalTimeout;
+      // iterate over all timeouts starting from highest values of order
+      new Map([...timeouts.entries()].sort().reverse()).forEach((timeout, order) => {
+        if (timeout !== undefined && (
+          // when orders >= 0 - timeout value overrides those set with higher order elements
+          order >= 0
+
+          // when `order < 0 && totalTimeout === undefined` - timeout is used when nothing is set by elements with higher order
+          || totalTimeout === undefined
+
+          // when `order < 0` - timeout overrides higher values of timeout or 'no timeout' (totalTimeout === 0) set by elements with higher order
+          || timeout > 0 && (timeout < totalTimeout || totalTimeout === 0)
+        )) {
+          totalTimeout = timeout;
+        }
+      });
+      return totalTimeout;
+    };
+    /**
+     * @method
+     * @param {number} timeout - timeout in milliseconds or 0 if no timeout
+     * @param {number} order - order defines the priority of timeout, timeouts set with lower order override those set with higher order.
+     *                         When order below 0 value of timeout only override if new value is lower
+     */
+    this.setTimeout = function (timeout, order) {
+      timeouts.set(order, timeout);
+    };
+
     this.setTrace();
   }
 
@@ -228,6 +284,8 @@ class MetaStep extends Step {
   }
 }
 
+Step.TIMEOUTS = {};
+
 /** @type {Class<MetaStep>} */
 Step.MetaStep = MetaStep;
 

package/lib/store.js

@@ -5,6 +5,8 @@
 const store = {
   /** @type {boolean} */
   debugMode: false,
+  /** @type {boolean} */
+  timeouts: true,
 };
 
 module.exports = store;

package/lib/ui.js

@@ -65,7 +65,7 @@ module.exports = function (suite) {
 
       suite.addTest(scenario.test(test));
       if (opts.retries) test.retries(opts.retries);
-      if (opts.timeout) test.timeout(opts.timeout);
+      if (opts.timeout) test.totalTimeout = opts.timeout;
       test.opts = opts;
 
       return new ScenarioConfig(test);
@@ -103,7 +103,7 @@ module.exports = function (suite) {
       suite.timeout(0);
 
       if (opts.retries) suite.retries(opts.retries);
-      if (opts.timeout) suite.timeout(opts.timeout);
+      if (opts.timeout) suite.totalTimeout = opts.timeout;
 
       suite.tags = title.match(/(\@[a-zA-Z0-9-_]+)/g) || []; // match tags from title
       suite.file = file;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.1.3",
+  "version": "3.2.3",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -10,7 +10,6 @@
     "webdriver",
     "testcafe",
     "playwright",
-    "protractor",
     "bdd",
     "tdd",
     "testing"
@@ -103,7 +102,7 @@
     "chai-subset": "^1.6.0",
     "contributor-faces": "^1.0.3",
     "documentation": "^12.3.0",
-    "dtslint": "^3.6.12",
+    "dtslint": "^4.1.6",
     "electron": "^12.0.0",
     "eslint": "^6.8.0",
     "eslint-config-airbnb-base": "^14.2.1",
@@ -122,7 +121,6 @@
     "nightmare": "^3.0.2",
     "nodemon": "^1.19.4",
     "playwright": "^1.9.1",
-    "protractor": "^5.4.4",
     "puppeteer": "^10.0.0",
     "qrcode-terminal": "^0.12.0",
     "rosie": "^1.6.0",
@@ -133,9 +131,9 @@
     "testcafe": "^1.9.4",
     "ts-morph": "^3.1.3",
     "tsd-jsdoc": "^2.5.0",
-    "typescript": "^3.7.5",
+    "typescript": "^4.4.3",
     "wdio-docker-service": "^1.5.0",
-    "webdriverio": "^6.10.7",
+    "webdriverio": "^7.14.1",
     "xml2js": "^0.4.23",
     "xmldom": "^0.1.31",
     "xpath": "0.0.27"

package/typings/index.d.ts

@@ -10,6 +10,8 @@ declare namespace CodeceptJS {
   type Cookie = {
     name: string;
     value: string;
+    domain?: string,
+    path?: string,
   };
 
   interface PageScrollPosition {
@@ -66,7 +68,7 @@ declare namespace CodeceptJS {
   type StringOrSecret = string | CodeceptJS.Secret;
 
   interface HookCallback {
-    (args: SupportObject): void;
+    (args: SupportObject): void | Promise<void>;
   }
   interface Scenario extends IScenario {
     only: IScenario;
@@ -195,6 +197,7 @@ declare namespace Mocha {
   }
 
   interface Test extends Runnable {
+    artifacts: [],
     tags: any[];
   }
 }
@@ -202,3 +205,7 @@ declare namespace Mocha {
 declare module "codeceptjs" {
   export = codeceptjs;
 }
+
+declare module "@codeceptjs/helper" {
+  export = CodeceptJS.Helper;
+}