codeceptjs 3.7.0-beta.7 → 3.7.0-beta.9

package/lib/{step/timeout.js → timeout.js}

@@ -36,7 +36,31 @@ function getCurrentTimeout(timeouts) {
   return totalTimeout
 }
 
+class TimeoutError extends Error {
+  constructor(message) {
+    super(message)
+    this.name = 'TimeoutError'
+  }
+}
+
+class TestTimeoutError extends TimeoutError {
+  constructor(timeout) {
+    super(`Timeout ${timeout}s exceeded (with Before hook)`)
+    this.name = 'TestTimeoutError'
+  }
+}
+
+class StepTimeoutError extends TimeoutError {
+  constructor(timeout, step) {
+    super(`Step ${step.toCode().trim()} timed out after ${timeout}s`)
+    this.name = 'StepTimeoutError'
+  }
+}
+
 module.exports = {
   TIMEOUT_ORDER,
   getCurrentTimeout,
+  TimeoutError,
+  TestTimeoutError,
+  StepTimeoutError,
 }

package/lib/utils.js

@@ -1,6 +1,7 @@
 const fs = require('fs')
 const os = require('os')
 const path = require('path')
+const chalk = require('chalk')
 const getFunctionArguments = require('fn-args')
 const deepClone = require('lodash.clonedeep')
 const { convertColorToRGBA, isColorProperty } = require('./colorUtils')
@@ -542,3 +543,37 @@ module.exports.humanizeString = function (string) {
   _result[0] = _result[0] === 'i' ? this.ucfirst(_result[0]) : _result[0]
   return _result.join(' ').trim()
 }
+
+module.exports.serializeError = function (error) {
+  if (error) {
+    const { stack, uncaught, message, actual, expected } = error
+    return { stack, uncaught, message, actual, expected }
+  }
+  return null
+}
+
+module.exports.base64EncodeFile = function (filePath) {
+  return Buffer.from(fs.readFileSync(filePath)).toString('base64')
+}
+
+module.exports.markdownToAnsi = function (markdown) {
+  return (
+    markdown
+      // Headers (# Text) - make blue and bold
+      .replace(/^(#{1,6})\s+(.+)$/gm, (_, hashes, text) => {
+        return chalk.bold.blue(`${hashes} ${text}`)
+      })
+      // Bullet points - replace with yellow bullet character
+      .replace(/^[-*]\s+(.+)$/gm, (_, text) => {
+        return `${chalk.yellow('•')} ${text}`
+      })
+      // Bold (**text**) - make bold
+      .replace(/\*\*(.+?)\*\*/g, (_, text) => {
+        return chalk.bold(text)
+      })
+      // Italic (*text*) - make italic (dim in terminals)
+      .replace(/\*(.+?)\*/g, (_, text) => {
+        return chalk.italic(text)
+      })
+  )
+}

package/lib/workers.js

@@ -12,7 +12,8 @@ const { replaceValueDeep, deepClone } = require('./utils')
 const mainConfig = require('./config')
 const output = require('./output')
 const event = require('./event')
-const { repackTestForWorkersTransport: repackTest } = require('./mocha/test')
+const { deserializeTest } = require('./mocha/test')
+const { deserializeSuite } = require('./mocha/suite')
 const recorder = require('./recorder')
 const runHook = require('./hooks')
 const WorkerStorage = require('./workerStorage')
@@ -230,17 +231,10 @@ class Workers extends EventEmitter {
     super()
     this.setMaxListeners(50)
     this.codecept = initializeCodecept(config.testConfig, config.options)
-    this.failuresLog = []
     this.errors = []
     this.numberOfWorkers = 0
     this.closedWorkers = 0
     this.workers = []
-    this.stats = {
-      passes: 0,
-      failures: 0,
-      tests: 0,
-      pending: 0,
-    }
     this.testGroups = []
 
     createOutputDir(config.testConfig)
@@ -353,8 +347,6 @@ class Workers extends EventEmitter {
   }
 
   run() {
-    this.stats.start = new Date()
-    this.stats.failedHooks = 0
     recorder.startUnlessRunning()
     event.dispatcher.emit(event.workers.before)
     process.env.RUNS_WITH_WORKERS = 'true'
@@ -380,7 +372,7 @@ class Workers extends EventEmitter {
    * @returns {Boolean}
    */
   isFailed() {
-    return (this.stats.failures || this.errors.length) > 0
+    return (Container.result().failures.length || this.errors.length) > 0
   }
 
   _listenWorkerEvents(worker) {
@@ -393,33 +385,37 @@ class Workers extends EventEmitter {
       }
 
       switch (message.event) {
-        case event.all.failures:
-          this.failuresLog = this.failuresLog.concat(message.data.failuresLog)
-          this._appendStats(message.data.stats)
+        case event.all.result:
+          // we ensure consistency of result by adding tests in the very end
+          Container.result().addFailures(message.data.failures)
+          Container.result().addStats(message.data.stats)
+          message.data.tests.forEach(test => {
+            Container.result().addTest(deserializeTest(test))
+          })
           break
         case event.suite.before:
-          this.emit(event.suite.before, repackTest(message.data))
+          this.emit(event.suite.before, deserializeSuite(message.data))
           break
         case event.test.before:
-          this.emit(event.test.before, repackTest(message.data))
+          this.emit(event.test.before, deserializeTest(message.data))
           break
         case event.test.started:
-          this.emit(event.test.started, repackTest(message.data))
+          this.emit(event.test.started, deserializeTest(message.data))
           break
         case event.test.failed:
-          this.emit(event.test.failed, repackTest(message.data))
+          this.emit(event.test.failed, deserializeTest(message.data))
           break
         case event.test.passed:
-          this.emit(event.test.passed, repackTest(message.data))
+          this.emit(event.test.passed, deserializeTest(message.data))
           break
         case event.test.skipped:
-          this.emit(event.test.skipped, repackTest(message.data))
+          this.emit(event.test.skipped, deserializeTest(message.data))
           break
         case event.test.finished:
-          this.emit(event.test.finished, repackTest(message.data))
+          this.emit(event.test.finished, deserializeTest(message.data))
           break
         case event.test.after:
-          this.emit(event.test.after, repackTest(message.data))
+          this.emit(event.test.after, deserializeTest(message.data))
           break
         case event.step.finished:
           this.emit(event.step.finished, message.data)
@@ -431,7 +427,7 @@ class Workers extends EventEmitter {
           this.emit(event.step.passed, message.data)
           break
         case event.step.failed:
-          this.emit(event.step.failed, message.data)
+          this.emit(event.step.failed, message.data, message.data.error)
           break
       }
     })
@@ -450,33 +446,26 @@ class Workers extends EventEmitter {
 
   _finishRun() {
     event.dispatcher.emit(event.workers.after, { tests: this.workers.map(worker => worker.tests) })
-    if (this.isFailed()) {
+    if (Container.result().hasFailed) {
       process.exitCode = 1
     } else {
       process.exitCode = 0
     }
-    // removed this.finishedTests because in all /lib only first argument (!this.isFailed()) is used)
-    this.emit(event.all.result, !this.isFailed())
-    this.emit('end') // internal event
-  }
 
-  _appendStats(newStats) {
-    this.stats.passes += newStats.passes
-    this.stats.failures += newStats.failures
-    this.stats.tests += newStats.tests
-    this.stats.pending += newStats.pending
-    this.stats.failedHooks += newStats.failedHooks
+    this.emit(event.all.result, Container.result())
+    event.dispatcher.emit(event.workers.result, Container.result())
+    this.emit('end') // internal event
   }
 
   printResults() {
-    this.stats.end = new Date()
-    this.stats.duration = this.stats.end - this.stats.start
+    const result = Container.result()
+    result.finish()
 
     // Reset process for logs in main thread
     output.process(null)
     output.print()
 
-    this.failuresLog = this.failuresLog
+    this.failuresLog = result.failures
       .filter(log => log.length && typeof log[1] === 'number')
       // mocha/lib/reporters/base.js
       .map(([format, num, title, message, stack], i) => [format, i + 1, title, message, stack])
@@ -487,7 +476,8 @@ class Workers extends EventEmitter {
       this.failuresLog.forEach(log => output.print(...log))
     }
 
-    output.result(this.stats.passes, this.stats.failures, this.stats.pending, ms(this.stats.duration), this.stats.failedHooks)
+    output.result(result.stats.passes, result.stats.failures, result.stats.pending, ms(result.duration), result.stats.failedHooks)
+
     process.env.RUNS_WITH_WORKERS = 'false'
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.7.0-beta.7",
+  "version": "3.7.0-beta.9",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -79,7 +79,7 @@
     "@cucumber/cucumber-expressions": "18",
     "@cucumber/gherkin": "30",
     "@cucumber/messages": "27.0.2",
-    "@xmldom/xmldom": "0.9.6",
+    "@xmldom/xmldom": "0.9.7",
     "acorn": "8.14.0",
     "arrify": "3.0.0",
     "axios": "1.7.9",
@@ -93,8 +93,9 @@
     "escape-string-regexp": "4.0.0",
     "figures": "3.2.0",
     "fn-args": "4.0.0",
+    "fs-extra": "11.3.0",
     "fs-extra": "11.2.0",
-    "glob": ">=9.0.0",
+    "glob": "^11.0.1",
     "fuse.js": "^7.0.0",
     "html-minifier-terser": "7.2.0",
     "inquirer": "6.5.2",
@@ -105,7 +106,7 @@
     "lodash.merge": "4.6.2",
     "mkdirp": "3.0.1",
     "mocha": "11.1.0",
-    "monocart-coverage-reports": "2.11.5",
+    "monocart-coverage-reports": "2.12.0",
     "ms": "2.1.3",
     "ora-classic": "5.4.2",
     "parse-function": "5.6.10",
@@ -133,7 +134,7 @@
     "@wdio/sauce-service": "9.5.7",
     "@wdio/selenium-standalone-service": "8.15.0",
     "@wdio/utils": "9.5.0",
-    "@xmldom/xmldom": "0.9.6",
+    "@xmldom/xmldom": "0.9.7",
     "chai": "^4.0.0",
     "chai-as-promised": "7.1.2",
     "chai-subset": "1.6.0",
@@ -154,7 +155,7 @@
     "json-server": "0.17.4",
     "playwright": "1.49.1",
     "prettier": "^3.3.2",
-    "puppeteer": "24.0.0",
+    "puppeteer": "24.1.0",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.1",
     "runok": "0.9.3",

package/typings/promiseBasedTypes.d.ts

@@ -1204,6 +1204,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1321,6 +1334,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1999,6 +2025,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -2129,6 +2168,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -3208,6 +3260,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6590,6 +6655,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8402,6 +8480,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9796,6 +9887,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;

package/typings/types.d.ts

@@ -1228,6 +1228,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -1345,6 +1358,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -2026,6 +2052,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -2156,6 +2195,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -3301,6 +3353,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6834,6 +6899,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8782,6 +8860,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -10236,6 +10327,19 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;

package/lib/listener/artifacts.js

@@ -1,19 +0,0 @@
-const event = require('../event')
-const recorder = require('../recorder')
-
-/**
- * Create and clean up empty artifacts
- */
-module.exports = function () {
-  event.dispatcher.on(event.test.before, test => {
-    test.artifacts = {}
-  })
-
-  event.dispatcher.on(event.test.after, test => {
-    recorder.add('clean up empty artifacts', () => {
-      for (const key in test.artifacts || {}) {
-        if (!test.artifacts[key]) delete test.artifacts[key]
-      }
-    })
-  })
-}

package/lib/plugin/debugErrors.js

@@ -1,67 +0,0 @@
-const Container = require('../container')
-const recorder = require('../recorder')
-const event = require('../event')
-const supportedHelpers = require('./standardActingHelpers')
-const { scanForErrorMessages } = require('../html')
-const { output } = require('..')
-
-const defaultConfig = {
-  errorClasses: ['error', 'warning', 'alert', 'danger'],
-}
-
-/**
- * Prints errors found in HTML code after each failed test.
- *
- * It scans HTML and searches for elements with error classes.
- * If an element found prints a text from it to console and adds as artifact to the test.
- *
- * Enable this plugin in config:
- *
- * ```js
- * plugins: {
- *  debugErrors: {
- *   enabled: true,
- * }
- * ```
- *
- * Additional config options:
- *
- * * `errorClasses` - list of classes to search for errors (default: `['error', 'warning', 'alert', 'danger']`)
- *
- */
-module.exports = function (config = {}) {
-  const helpers = Container.helpers()
-  let helper
-
-  config = Object.assign(defaultConfig, config)
-
-  for (const helperName of supportedHelpers) {
-    if (Object.keys(helpers).indexOf(helperName) > -1) {
-      helper = helpers[helperName]
-    }
-  }
-
-  if (!helper) return // no helpers for screenshot
-
-  event.dispatcher.on(event.test.failed, test => {
-    recorder.add('HTML snapshot failed test', async () => {
-      try {
-        const currentOutputLevel = output.level()
-        output.level(0)
-        const html = await helper.grabHTMLFrom('body')
-        output.level(currentOutputLevel)
-
-        if (!html) return
-
-        const errors = scanForErrorMessages(html, config.errorClasses)
-        if (errors.length) {
-          output.debug('Detected errors in HTML code')
-          errors.forEach(error => output.debug(error))
-          test.artifacts.errors = errors
-        }
-      } catch (err) {
-        // not really needed
-      }
-    })
-  })
-}