codeceptjs 3.1.0 → 3.2.0

package/lib/plugin/subtitles.js

@@ -0,0 +1,88 @@
+const { v4: uuidv4 } = require('uuid');
+const fsPromise = require('fs').promises;
+const path = require('path');
+const event = require('../event');
+
+// This will convert a given timestamp in milliseconds to
+// an SRT recognized timestamp, ie HH:mm:ss,SSS
+function formatTimestamp(timestampInMs) {
+  const date = new Date(0, 0, 0, 0, 0, 0, timestampInMs);
+  const hours = date.getHours();
+  const minutes = date.getMinutes();
+  const seconds = date.getSeconds();
+  const ms = timestampInMs - (hours * 3600000 + minutes * 60000 + seconds * 1000);
+  return `${hours.toString().padStart(2, '0')}:${minutes.toString().padStart(2, '0')}:${seconds.toString().padStart(2, '0')},${ms.toString().padStart(3, '0')}`;
+}
+
+let steps = {};
+let testStartedAt;
+/**
+ * Automatically captures steps as subtitle, and saves it as an artifact when a video is found for a failed test
+ *
+ * #### Configuration
+ * ```js
+ * plugins: {
+ *  subtitles: {
+ *    enabled: true
+ *  }
+ * }
+ * ```
+ */
+module.exports = function () {
+  event.dispatcher.on(event.test.before, (_) => {
+    testStartedAt = Date.now();
+    steps = {};
+  });
+
+  event.dispatcher.on(event.step.started, (step) => {
+    const stepStartedAt = Date.now();
+    step.id = uuidv4();
+
+    let title = `${step.actor}.${step.name}(${step.args ? step.args.join(',') : ''})`;
+    if (title.length > 100) {
+      title = `${title.substring(0, 100)}...`;
+    }
+
+    steps[step.id] = {
+      start: formatTimestamp(stepStartedAt - testStartedAt),
+      startedAt: stepStartedAt,
+      title,
+    };
+  });
+
+  event.dispatcher.on(event.step.finished, (step) => {
+    if (step && step.id && steps[step.id]) {
+      steps[step.id].end = formatTimestamp(Date.now() - testStartedAt);
+    }
+  });
+
+  event.dispatcher.on(event.test.after, async (test) => {
+    if (test && test.artifacts && test.artifacts.video) {
+      const stepsSortedByStartTime = Object.values(steps);
+      stepsSortedByStartTime.sort((stepA, stepB) => {
+        return stepA.startedAt - stepB.startedAt;
+      });
+
+      let subtitle = '';
+
+      // For an SRT file, every subtitle has to be in the format as mentioned below:
+      //
+      // 1
+      // HH:mm:ss,SSS --> HH:mm:ss,SSS
+      // [title]
+      stepsSortedByStartTime.forEach((step, index) => {
+        if (step.end) {
+          subtitle = `${subtitle}${index + 1}
+${step.start} --> ${step.end}
+${step.title}
+
+`;
+        }
+      });
+
+      const { dir: artifactsDirectory, name: fileName } = path.parse(test.artifacts.video);
+      await fsPromise.writeFile(`${artifactsDirectory}/${fileName}.srt`, subtitle);
+      test.artifacts.subtitle = `${artifactsDirectory}/${fileName}.srt`;
+    }
+  });
+};

package/lib/plugin/tryTo.js

@@ -89,7 +89,7 @@ function tryTo(callback) {
     recorder.session.catch((err) => {
       result = false;
       const msg = err.inspect ? err.inspect() : err.toString();
-      debug(`Unsuccesful try > ${msg}`);
+      debug(`Unsuccessful try > ${msg}`);
       recorder.session.restore('tryTo');
       return result;
     });

package/lib/recorder.js

@@ -3,6 +3,8 @@ const promiseRetry = require('promise-retry');
 
 const { log } = require('./output');
 
+const MAX_TASKS = 100;
+
 let promise;
 let running = false;
 let errFn;
@@ -116,7 +118,7 @@ module.exports = {
      * @inner
      */
     start(name) {
-      log(`${currentQueue()}Starting <${name}> session`);
+      debug(`${currentQueue()}Starting <${name}> session`);
       tasks.push('--->');
       oldPromises.push(promise);
       this.running = true;
@@ -130,7 +132,7 @@ module.exports = {
      */
     restore(name) {
       tasks.push('<---');
-      log(`${currentQueue()}Finalize <${name}> session`);
+      debug(`${currentQueue()}Finalize <${name}> session`);
       this.running = false;
       sessionId = null;
       this.catch(errFn);
@@ -158,10 +160,11 @@ module.exports = {
    *     undefined: `add(fn)` -> `false` and `add('step',fn)` -> `true`
    *     true: it will retries if `retryOpts` set.
    *     false: ignore `retryOpts` and won't retry.
+   * @param {number} [timeout]
    * @return {Promise<*> | undefined}
    * @inner
    */
-  add(taskName, fn = undefined, force = false, retry = undefined) {
+  add(taskName, fn = undefined, force = false, retry = undefined, timeout = undefined) {
     if (typeof taskName === 'function') {
       fn = taskName;
       taskName = fn.toString();
@@ -172,19 +175,21 @@ module.exports = {
       return;
     }
     tasks.push(taskName);
-    debug(`${currentQueue()}Queued | ${taskName}`);
+    if (process.env.DEBUG) debug(`${currentQueue()}Queued | ${taskName}`);
 
     return promise = Promise.resolve(promise).then((res) => {
       const retryOpts = this.retries.slice(-1).pop();
       // no retries or unnamed tasks
       if (!retryOpts || !taskName || !retry) {
-        return Promise.resolve(res).then(fn);
+        const [promise, timer] = getTimeoutPromise(timeout, taskName);
+        return Promise.race([promise, Promise.resolve(res).then(fn)]).finally(() => clearTimeout(timer));
       }
 
       const retryRules = this.retries.slice().reverse();
       return promiseRetry(Object.assign(defaultRetryOptions, retryOpts), (retry, number) => {
         if (number > 1) log(`${currentQueue()}Retrying... Attempt #${number}`);
-        return Promise.resolve(res).then(fn).catch((err) => {
+        const [promise, timer] = getTimeoutPromise(timeout, taskName);
+        return Promise.race([promise, Promise.resolve(res).then(fn)]).finally(() => clearTimeout(timer)).catch((err) => {
           for (const retryObj of retryRules) {
             if (!retryObj.when) return retry(err);
             if (retryObj.when && retryObj.when(err)) return retry(err);
@@ -296,7 +301,7 @@ module.exports = {
    * @inner
    */
   stop() {
-    debug(this.toString());
+    if (process.env.DEBUG) debug(this.toString());
     log(`${currentQueue()}Stopping recording promises`);
     running = false;
   },
@@ -318,7 +323,7 @@ module.exports = {
    * @inner
    */
   scheduled() {
-    return tasks.join('\n');
+    return tasks.slice(-MAX_TASKS).join('\n');
   },
 
   /**
@@ -341,6 +346,14 @@ module.exports = {
 
 };
 
+function getTimeoutPromise(timeoutMs, taskName) {
+  let timer;
+  if (timeoutMs) debug(`Timing out in ${timeoutMs}ms`);
+  return [new Promise((done, reject) => {
+    timer = setTimeout(() => { reject(new Error(`Action ${taskName} was interrupted on step timeout ${timeoutMs}ms`)); }, timeoutMs || 2e9);
+  }), timer];
+}
+
 function currentQueue() {
   let session = '';
   if (sessionId) session = `<${sessionId}> `;

package/lib/step.js

@@ -38,6 +38,9 @@ class Step {
     this.metaStep = undefined;
     /** @member {string} */
     this.stack = '';
+    /** @member {number} */
+    this.totalTimeout = undefined;
+
     this.setTrace();
   }
 
@@ -212,16 +215,18 @@ class MetaStep extends Step {
       step.metaStep = this;
     };
     event.dispatcher.prependListener(event.step.before, registerStep);
+    let rethrownError = null;
     try {
       this.startTime = Date.now();
       result = fn.apply(this.context, this.args);
     } catch (error) {
-      this.status = 'failed';
+      this.setStatus('failed');
+      rethrownError = error;
     } finally {
       this.endTime = Date.now();
-
       event.dispatcher.removeListener(event.step.before, registerStep);
     }
+    if (rethrownError) { throw rethrownError; }
     return result;
   }
 }

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.0",
+  "version": "3.2.0",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -10,7 +10,6 @@
     "webdriver",
     "testcafe",
     "playwright",
-    "protractor",
     "bdd",
     "tdd",
     "testing"
@@ -84,7 +83,8 @@
     "promise-retry": "^1.1.1",
     "requireg": "^0.2.2",
     "resq": "^1.10.0",
-    "sprintf-js": "^1.1.1"
+    "sprintf-js": "^1.1.1",
+    "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@codeceptjs/detox-helper": "^1.0.2",
@@ -102,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",
@@ -121,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",
@@ -132,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

@@ -66,7 +66,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;
@@ -111,6 +111,7 @@ declare const pause: typeof CodeceptJS.pause;
 declare const within: typeof CodeceptJS.within;
 declare const session: typeof CodeceptJS.session;
 declare const DataTable: typeof CodeceptJS.DataTable;
+declare const DataTableArgument: typeof CodeceptJS.DataTableArgument;
 declare const codeceptjs: typeof CodeceptJS.index;
 declare const locate: typeof CodeceptJS.Locator.build;
 declare function inject(): CodeceptJS.SupportObject;
@@ -160,6 +161,7 @@ declare namespace NodeJS {
     within: typeof within;
     session: typeof session;
     DataTable: typeof DataTable;
+    DataTableArgument: typeof DataTableArgument;
     locate: typeof locate;
     inject: typeof inject;
     secret: typeof secret;
@@ -193,6 +195,7 @@ declare namespace Mocha {
   }
 
   interface Test extends Runnable {
+    artifacts: [],
     tags: any[];
   }
 }
@@ -200,3 +203,7 @@ declare namespace Mocha {
 declare module "codeceptjs" {
   export = codeceptjs;
 }
+
+declare module "@codeceptjs/helper" {
+  export = CodeceptJS.Helper;
+}