codeceptjs 3.7.3 → 3.7.4

package/bin/codecept.js

@@ -164,6 +164,7 @@ program
   .option('--tests', 'run only JS test files and skip features')
   .option('--no-timeouts', 'disable all timeouts')
   .option('-p, --plugins <k=v,k2=v2,...>', 'enable plugins, comma-separated')
+  .option('--shuffle', 'Shuffle the order in which test files run')
 
   // mocha options
   .option('--colors', 'force enabling of colors')

package/lib/codecept.js

@@ -1,5 +1,6 @@
 const { existsSync, readFileSync } = require('fs')
 const { globSync } = require('glob')
+const shuffle = require('lodash.shuffle')
 const fsPath = require('path')
 const { resolve } = require('path')
 
@@ -180,6 +181,10 @@ class Codecept {
         })
       }
     }
+
+    if (this.opts.shuffle) {
+      this.testFiles = shuffle(this.testFiles)
+    }
   }
 
   /**

package/lib/container.js

@@ -28,6 +28,7 @@ let container = {
   translation: {},
   /** @type {Result | null} */
   result: null,
+  sharedKeys: new Set() // Track keys shared via share() function
 }
 
 /**
@@ -174,6 +175,7 @@ class Container {
     container.translation = loadTranslation()
     container.proxySupport = createSupportObjects(newSupport)
     container.plugins = newPlugins
+    container.sharedKeys = new Set() // Clear shared keys
     asyncHelperPromise = Promise.resolve()
     store.actor = null
     debug('container cleared')
@@ -197,7 +199,13 @@ class Container {
    * @param {Object} options - set {local: true} to not share among workers
    */
   static share(data, options = {}) {
-    Container.append({ support: data })
+    // Instead of using append which replaces the entire container,
+    // directly update the support object to maintain proxy references
+    Object.assign(container.support, data)
+    
+    // Track which keys were explicitly shared
+    Object.keys(data).forEach(key => container.sharedKeys.add(key))
+    
     if (!options.local) {
       WorkerStorage.share(data)
     }
@@ -396,10 +404,11 @@ function createSupportObjects(config) {
     {},
     {
       has(target, key) {
-        return keys.includes(key)
+        return keys.includes(key) || container.sharedKeys.has(key)
       },
       ownKeys() {
-        return keys
+        // Return both original config keys and explicitly shared keys
+        return [...new Set([...keys, ...container.sharedKeys])]
       },
       getOwnPropertyDescriptor(target, prop) {
         return {
@@ -409,6 +418,10 @@ function createSupportObjects(config) {
         }
       },
       get(target, key) {
+        // First check if this is an explicitly shared property
+        if (container.sharedKeys.has(key) && key in container.support) {
+          return container.support[key]
+        }
         return lazyLoad(key)
       },
     },

package/lib/helper/Mochawesome.js

@@ -1,4 +1,3 @@
-let addMochawesomeContext
 let currentTest
 let currentSuite
 
@@ -16,7 +15,8 @@ class Mochawesome extends Helper {
       disableScreenshots: false,
     }
 
-    addMochawesomeContext = require('mochawesome/addContext')
+    this._addContext = require('mochawesome/addContext')
+
     this._createConfig(config)
   }
 
@@ -44,28 +44,27 @@ class Mochawesome extends Helper {
     if (this.options.disableScreenshots) return
     let fileName
     // Get proper name if we are fail on hook
-    if (test.ctx.test.type === 'hook') {
+    if (test.ctx?.test?.type === 'hook') {
       currentTest = { test: test.ctx.test }
       // ignore retries if we are in hook
       test._retries = -1
       fileName = clearString(`${test.title}_${currentTest.test.title}`)
     } else {
       currentTest = { test }
-      fileName = `${testToFileName(test)}`
+      fileName = testToFileName(test)
     }
     if (this.options.uniqueScreenshotNames) {
-      const uuid = test.uuid || test.ctx.test.uuid
-      fileName = `${fileName.substring(0, 10)}_${uuid}`
+      fileName = testToFileName(test, { unique: true })
     }
     if (test._retries < 1 || test._retries === test.retryNum) {
       fileName = `${fileName}.failed.png`
-      return addMochawesomeContext(currentTest, fileName)
+      return this._addContext(currentTest, fileName)
     }
   }
 
   addMochawesomeContext(context) {
     if (currentTest === '') currentTest = { test: currentSuite.ctx.test }
-    return addMochawesomeContext(currentTest, context)
+    return this._addContext(currentTest, context)
   }
 }
 

package/lib/helper/Playwright.js

@@ -2377,15 +2377,19 @@ class Playwright extends Helper {
     if (this.options.recordVideo && this.page && this.page.video()) {
       test.artifacts.video = saveVideoForPage(this.page, `${test.title}.failed`)
       for (const sessionName in this.sessionPages) {
-        test.artifacts[`video_${sessionName}`] = saveVideoForPage(this.sessionPages[sessionName], `${test.title}_${sessionName}.failed`)
+        if (sessionName === '') continue
+        test.artifacts[`video_${sessionName}`] = saveVideoForPage(this.sessionPages[sessionName], `${sessionName}_${test.title}.failed`)
       }
     }
 
     if (this.options.trace) {
       test.artifacts.trace = await saveTraceForContext(this.browserContext, `${test.title}.failed`)
       for (const sessionName in this.sessionPages) {
-        if (!this.sessionPages[sessionName].context) continue
-        test.artifacts[`trace_${sessionName}`] = await saveTraceForContext(this.sessionPages[sessionName].context, `${test.title}_${sessionName}.failed`)
+        if (sessionName === '') continue
+        const sessionPage = this.sessionPages[sessionName]
+        const sessionContext = sessionPage.context()
+        if (!sessionContext || !sessionContext.tracing) continue
+        test.artifacts[`trace_${sessionName}`] = await saveTraceForContext(sessionContext, `${sessionName}_${test.title}.failed`)
       }
     }
 
@@ -2399,7 +2403,8 @@ class Playwright extends Helper {
       if (this.options.keepVideoForPassedTests) {
         test.artifacts.video = saveVideoForPage(this.page, `${test.title}.passed`)
         for (const sessionName of Object.keys(this.sessionPages)) {
-          test.artifacts[`video_${sessionName}`] = saveVideoForPage(this.sessionPages[sessionName], `${test.title}_${sessionName}.passed`)
+          if (sessionName === '') continue
+          test.artifacts[`video_${sessionName}`] = saveVideoForPage(this.sessionPages[sessionName], `${sessionName}_${test.title}.passed`)
         }
       } else {
         this.page
@@ -2414,8 +2419,11 @@ class Playwright extends Helper {
         if (this.options.trace) {
           test.artifacts.trace = await saveTraceForContext(this.browserContext, `${test.title}.passed`)
           for (const sessionName in this.sessionPages) {
-            if (!this.sessionPages[sessionName].context) continue
-            test.artifacts[`trace_${sessionName}`] = await saveTraceForContext(this.sessionPages[sessionName].context, `${test.title}_${sessionName}.passed`)
+            if (sessionName === '') continue
+            const sessionPage = this.sessionPages[sessionName]
+            const sessionContext = sessionPage.context()
+            if (!sessionContext || !sessionContext.tracing) continue
+            test.artifacts[`trace_${sessionName}`] = await saveTraceForContext(sessionContext, `${sessionName}_${test.title}.passed`)
           }
         }
       } else {
@@ -3883,9 +3891,18 @@ function saveVideoForPage(page, name) {
 async function saveTraceForContext(context, name) {
   if (!context) return
   if (!context.tracing) return
-  const fileName = `${`${global.output_dir}${pathSeparator}trace${pathSeparator}${uuidv4()}_${clearString(name)}`.slice(0, 245)}.zip`
-  await context.tracing.stop({ path: fileName })
-  return fileName
+  try {
+    const fileName = `${`${global.output_dir}${pathSeparator}trace${pathSeparator}${uuidv4()}_${clearString(name)}`.slice(0, 245)}.zip`
+    await context.tracing.stop({ path: fileName })
+    return fileName
+  } catch (err) {
+    // Handle the case where tracing was not started or context is invalid
+    if (err.message && err.message.includes('Must start tracing before stopping')) {
+      // Tracing was never started on this context, silently skip
+      return null
+    }
+    throw err
+  }
 }
 
 async function highlightActiveElement(element) {

package/lib/mocha/asyncWrapper.js

@@ -121,9 +121,19 @@ module.exports.injected = function (fn, suite, hookName) {
     const errHandler = err => {
       recorder.session.start('teardown')
       recorder.cleanAsyncErr()
-      if (hookName == 'before' || hookName == 'beforeSuite') suiteTestFailedHookError(suite, err, hookName)
-      if (hookName === 'after') suite.eachTest(test => event.emit(event.test.after, test))
-      if (hookName === 'afterSuite') event.emit(event.suite.after, suite)
+      if (['before', 'beforeSuite'].includes(hookName)) {
+        suiteTestFailedHookError(suite, err, hookName)
+      }
+      if (hookName === 'after') {
+        suiteTestFailedHookError(suite, err, hookName)
+        suite.eachTest(test => {
+          event.emit(event.test.after, test)
+        })
+      }
+      if (hookName === 'afterSuite') {
+        suiteTestFailedHookError(suite, err, hookName)
+        event.emit(event.suite.after, suite)
+      }
       recorder.add(() => doneFn(err))
     }
 

package/lib/mocha/gherkin.js

@@ -107,7 +107,7 @@ module.exports = (text, file) => {
       )
       continue
     }
-    if (child.scenario && (currentLanguage ? currentLanguage.contexts.ScenarioOutline.includes(child.scenario.keyword) : child.scenario.keyword === 'Scenario Outline')) {
+    if (child.scenario && (currentLanguage ? currentLanguage.contexts.ScenarioOutline === child.scenario.keyword : child.scenario.keyword === 'Scenario Outline')) {
       for (const examples of child.scenario.examples) {
         const fields = examples.tableHeader.cells.map(c => c.value)
         for (const example of examples.tableBody) {

package/lib/mocha/test.js

@@ -135,9 +135,19 @@ function cloneTest(test) {
   return deserializeTest(serializeTest(test))
 }
 
-function testToFileName(test, suffix = '') {
+/**
+ * Get a filename from the test object
+ * @param {CodeceptJS.Test} test
+ * @param {Object}  options
+ * @param {string}  options.suffix Add a suffix to the filename
+ * @param {boolean} options.unique Add a unique suffix to the file
+ *
+ * @returns {string} the filename
+ */
+function testToFileName(test, { suffix = '', unique = false } = {}) {
   let fileName = test.title
 
+  if (unique) fileName = `${fileName}_${test?.uid || Math.floor(new Date().getTime() / 1000)}`
   if (suffix) fileName = `${fileName}_${suffix}`
   // remove tags with empty string (disable for now)
   // fileName = fileName.replace(/\@\w+/g, '')
@@ -151,6 +161,7 @@ function testToFileName(test, suffix = '') {
   //   fileName = `${clearString(test.parent.title)}_${fileName}`
   // }
   fileName = clearString(fileName).slice(0, 100)
+
   return fileName
 }
 

package/lib/pause.js

@@ -175,7 +175,12 @@ async function parseInput(cmd) {
       output.print(output.styles.success('  OK  '), cmd)
     }
     if (cmd?.startsWith('I.grab')) {
-      output.print(output.styles.debug(val))
+      try {
+        output.print(output.styles.debug(JSON.stringify(val, null, 2)))
+      } catch (err) {
+        output.print(output.styles.error(' ERROR '), 'Failed to stringify result:', err.message)
+        output.print(output.styles.error(' RAW VALUE '), String(val))
+      }
     }
 
     history.push(cmd) // add command to history when successful

package/lib/plugin/commentStep.js

@@ -7,7 +7,7 @@ let currentCommentStep
 const defaultGlobalName = '__'
 
 /**
- * @deprecated
+ * This plugin is **deprecated**, use `Section` instead.
  *
  * Add descriptive nested steps for your tests:
  *

package/lib/plugin/screenshotOnFail.js

@@ -86,7 +86,7 @@ module.exports = function (config) {
         let fileName
 
         if (options.uniqueScreenshotNames && test) {
-          fileName = `${testToFileName(test, _getUUID(test))}.failed.png`
+          fileName = `${testToFileName(test, { unique: true })}.failed.png`
         } else {
           fileName = `${testToFileName(test)}.failed.png`
         }
@@ -137,12 +137,4 @@ module.exports = function (config) {
       true,
     )
   })
-
-  function _getUUID(test) {
-    if (test.uid) {
-      return test.uid
-    }
-
-    return Math.floor(new Date().getTime() / 1000)
-  }
 }

package/lib/workerStorage.js

@@ -7,7 +7,8 @@ const invokeWorkerListeners = (workerObj) => {
   const { threadId } = workerObj;
   workerObj.on('message', (messageData) => {
     if (messageData.event === shareEvent) {
-      share(messageData.data);
+      const Container = require('./container');
+      Container.share(messageData.data);
     }
   });
   workerObj.on('exit', () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.7.3",
+  "version": "3.7.4",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -75,15 +75,15 @@
     "publish-beta": "./runok.js publish:next-beta-version"
   },
   "dependencies": {
-    "@codeceptjs/configure": "1.0.3",
+    "@codeceptjs/configure": "1.0.6",
     "@codeceptjs/helper": "2.0.4",
     "@cucumber/cucumber-expressions": "18",
-    "@cucumber/gherkin": "32",
+    "@cucumber/gherkin": "32.1.2",
     "@cucumber/messages": "27.2.0",
     "@xmldom/xmldom": "0.9.8",
     "acorn": "8.14.1",
     "arrify": "3.0.0",
-    "axios": "1.8.3",
+    "axios": "1.11.0",
     "chalk": "4.1.2",
     "cheerio": "^1.0.0",
     "commander": "11.1.0",
@@ -95,83 +95,85 @@
     "figures": "3.2.0",
     "fn-args": "4.0.0",
     "fs-extra": "11.3.0",
-    "glob": ">=9.0.0 <12",
     "fuse.js": "^7.0.0",
+    "glob": ">=9.0.0 <12",
     "html-minifier-terser": "7.2.0",
     "inquirer": "8.2.6",
     "invisi-data": "^1.0.0",
     "joi": "17.13.3",
     "js-beautify": "1.15.4",
     "lodash.clonedeep": "4.5.0",
+    "lodash.shuffle": "4.2.0",
     "lodash.merge": "4.6.2",
     "mkdirp": "3.0.1",
-    "mocha": "11.1.0",
-    "monocart-coverage-reports": "2.12.3",
+    "mocha": "11.6.0",
+    "monocart-coverage-reports": "2.12.6",
     "ms": "2.1.3",
     "ora-classic": "5.4.2",
     "parse-function": "5.6.10",
-    "parse5": "7.2.1",
+    "parse5": "7.3.0",
     "promise-retry": "1.1.1",
     "resq": "1.11.0",
     "sprintf-js": "1.1.3",
     "uuid": "11.1.0"
   },
   "optionalDependencies": {
-    "@codeceptjs/detox-helper": "1.1.7"
+    "@codeceptjs/detox-helper": "1.1.8"
   },
   "devDependencies": {
     "@apollo/server": "^4",
-    "@codeceptjs/expect-helper": "^1.0.1",
+    "@codeceptjs/expect-helper": "^1.0.2",
     "@codeceptjs/mock-request": "0.3.1",
-    "@eslint/eslintrc": "3.3.0",
-    "@eslint/js": "9.22.0",
-    "@faker-js/faker": "9.6.0",
+    "@eslint/eslintrc": "3.3.1",
+    "@eslint/js": "9.31.0",
+    "@faker-js/faker": "9.8.0",
     "@pollyjs/adapter-puppeteer": "6.0.6",
     "@pollyjs/core": "6.0.6",
-    "@types/chai": "5.2.0",
+    "@types/chai": "5.2.2",
     "@types/inquirer": "9.0.7",
-    "@types/node": "22.13.10",
-    "@wdio/sauce-service": "9.12.0",
+    "@types/node": "24.0.10",
+    "@wdio/sauce-service": "9.12.5",
     "@wdio/selenium-standalone-service": "8.15.0",
-    "@wdio/utils": "9.11.0",
+    "@wdio/utils": "9.15.0",
     "@xmldom/xmldom": "0.9.8",
     "chai": "^4.0.0",
     "chai-as-promised": "7.1.2",
     "chai-subset": "1.6.0",
     "documentation": "14.0.3",
-    "electron": "35.0.1",
-    "eslint": "^9.21.0",
-    "eslint-plugin-import": "2.31.0",
-    "eslint-plugin-mocha": "10.5.0",
-    "expect": "29.7.0",
-    "express": "4.21.2",
-    "globals": "16.0.0",
-    "graphql": "16.10.0",
+    "electron": "37.2.3",
+    "eslint": "^9.24.0",
+    "eslint-plugin-import": "2.32.0",
+    "eslint-plugin-mocha": "11.1.0",
+    "expect": "30.0.5",
+    "express": "5.1.0",
+    "globals": "16.2.0",
+    "graphql": "16.11.0",
     "graphql-tag": "^2.12.6",
     "husky": "9.1.7",
     "inquirer-test": "2.0.1",
     "jsdoc": "^3.6.11",
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.17.4",
-    "playwright": "1.51.0",
+    "mochawesome": "^7.1.3",
+    "playwright": "1.54.1",
     "prettier": "^3.3.2",
-    "puppeteer": "24.4.0",
+    "puppeteer": "24.15.0",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.1",
     "runok": "0.9.3",
-    "semver": "7.7.1",
-    "sinon": "19.0.2",
+    "semver": "7.7.2",
+    "sinon": "21.0.0",
     "sinon-chai": "3.7.0",
     "testcafe": "3.7.2",
-    "ts-morph": "25.0.1",
+    "ts-morph": "26.0.0",
     "ts-node": "10.9.2",
-    "tsd": "^0.31.0",
+    "tsd": "^0.33.0",
     "tsd-jsdoc": "2.5.0",
-    "typedoc": "0.28.0",
-    "typedoc-plugin-markdown": "4.5.0",
-    "typescript": "5.8.2",
+    "typedoc": "0.28.10",
+    "typedoc-plugin-markdown": "4.8.1",
+    "typescript": "5.8.3",
     "wdio-docker-service": "3.2.1",
-    "webdriverio": "9.12.0",
+    "webdriverio": "9.12.5",
     "xml2js": "0.6.2",
     "xpath": "0.0.34"
   },