codeceptjs 4.0.7 → 4.0.9

package/docs/playwright.md

@@ -63,6 +63,25 @@ Make sure `Playwright` helper is enabled in `codecept.conf.js` config:
 > Turn off the `show` option if you want to run test in headless mode.
 > If you don't specify the browser here, `chromium` will be used. Possible browsers are: `chromium`, `firefox` and `webkit`
 
+To point `firefox` at a custom build instead of the bundled one, pass `executablePath` under the
+`firefox` key:
+
+```js
+  helpers: {
+    Playwright: {
+      url: "http://localhost",
+      browser: 'firefox',
+      firefox: {
+        executablePath: '/path/to/firefox'
+      }
+    }
+  }
+```
+
+Useful with a build like [invisible_playwright](https://github.com/feder-cr/invisible_playwright),
+patched at the source level for a realistic fingerprint, for sites that detect the default Chromium
+path.
+
 Playwright uses different strategies to detect if a page is loaded. In configuration use `waitForNavigation` option for that:
 
 When to consider navigation succeeded, defaults to `load`. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:

package/lib/codecept.js

@@ -289,8 +289,11 @@ class Codecept {
       // Ignore if gherkin module not available
     }
 
-    // Sort test files alphabetically for consistent execution order
-    this.testFiles.sort()
+    // Sort test files alphabetically for consistent execution order,
+    // but skip sorting when --shuffle is active so the randomised order is preserved.
+    if (!this.opts.shuffle) {
+      this.testFiles.sort()
+    }
 
     return new Promise((resolve, reject) => {
       const mocha = container.mocha()

package/lib/data/context.js

@@ -82,8 +82,13 @@ function isTableDataRow(row) {
   return has.call(row, 'data') && has.call(row, 'skip')
 }
 
+function isDataTable(dataTable) {
+  if (dataTable instanceof DataTable) return true
+  return Boolean(dataTable) && Array.isArray(dataTable.array) && Array.isArray(dataTable.rows) && typeof dataTable.add === 'function'
+}
+
 function detectDataType(dataTable) {
-  if (dataTable instanceof DataTable) {
+  if (isDataTable(dataTable)) {
     return dataTable.rows
   }
 

package/lib/effects.js

@@ -50,8 +50,10 @@ function within(context, fn) {
             return recorder.promise().then(() => res)
           })
           .catch(e => {
+            finishHelpers()
             finalize()
             recorder.throw(e)
+            return recorder.promise()
           })
       }
 
@@ -203,7 +205,7 @@ async function retryTo(callback, maxTries, pollInterval = 200) {
   const sessionName = 'retryTo'
 
   return new Promise((done, reject) => {
-    let tries = 1
+    let tries = 0
 
     function handleRetryException(err) {
       recorder.throw(err)
@@ -216,7 +218,7 @@ async function retryTo(callback, maxTries, pollInterval = 200) {
       try {
         await callback(tries)
       } catch (err) {
-        handleRetryException(err)
+        recorder.throw(err)
       }
 
       // Call done if no errors
@@ -228,7 +230,7 @@ async function retryTo(callback, maxTries, pollInterval = 200) {
       // Catch errors and retry
       recorder.session.catch(err => {
         recorder.session.restore(`${sessionName} ${tries}`)
-        if (tries <= maxTries) {
+        if (tries < maxTries) {
           output.debug(`Error ${err}... Retrying`)
           recorder.add(`${sessionName} ${tries}`, () => setTimeout(tryBlock, pollInterval))
         } else {

package/lib/globals.js

@@ -30,10 +30,8 @@ export async function initCodeceptGlobals(dir, config, container) {
   // pause/inject/share stay global even under noGlobals — they're the everyday
   // debugging/wiring entry points and have no useful import alternative for
   // page-object code that runs before the container is available.
-  global.pause = async (...args) => {
-    const pauseModule = await import('./pause.js')
-    return (pauseModule.default || pauseModule)(...args)
-  }
+  const pauseModule = await import('./pause.js')
+  global.pause = pauseModule.default || pauseModule
   global.inject = () => container.support()
   global.share = container.share
 

package/lib/helper/GraphQL.js

@@ -53,14 +53,6 @@ class GraphQL extends Helper {
     this.axios.defaults.headers = this.options.defaultHeaders
   }
 
-  static _checkRequirements() {
-    try {
-      require('axios')
-    } catch (e) {
-      return ['axios']
-    }
-  }
-
   static _config() {
     return [
       {

package/lib/helper/GraphQLDataFactory.js

@@ -174,15 +174,6 @@ class GraphQLDataFactory extends Helper {
     Object.keys(this.factories).forEach(f => (this.created[f] = []))
   }
 
-  static _checkRequirements() {
-    try {
-      require('axios')
-      require('rosie')
-    } catch (e) {
-      return ['axios', 'rosie']
-    }
-  }
-
   _after() {
     if (!this.config.cleanup) {
       return Promise.resolve()

package/lib/mocha/asyncWrapper.js

@@ -197,11 +197,15 @@ export function setup(suite) {
   return function (done) {
     const doneFn = makeDoneCallableOnce(done)
     recorder.startUnlessRunning()
-    import('./test.js').then(testModule => {
-      const { enhanceMochaTest } = testModule.default || testModule
-      event.emit(event.test.before, enhanceMochaTest(suite?.ctx?.currentTest ?? suite?.currentTest))
-      recorder.add(() => doneFn())
-    })
+    import('./test.js')
+      .then(testModule => {
+        const { enhanceMochaTest } = testModule.default || testModule
+        event.emit(event.test.before, enhanceMochaTest(suite?.ctx?.currentTest ?? suite?.currentTest))
+        recorder.add(() => doneFn())
+      })
+      .catch(err => {
+        doneFn(err)
+      })
   }
 }
 
@@ -209,11 +213,15 @@ export function teardown(suite) {
   return function (done) {
     const doneFn = makeDoneCallableOnce(done)
     recorder.startUnlessRunning()
-    import('./test.js').then(testModule => {
-      const { enhanceMochaTest } = testModule.default || testModule
-      event.emit(event.test.after, enhanceMochaTest(suite?.ctx?.currentTest ?? suite?.currentTest))
-      recorder.add(() => doneFn())
-    })
+    import('./test.js')
+      .then(testModule => {
+        const { enhanceMochaTest } = testModule.default || testModule
+        event.emit(event.test.after, enhanceMochaTest(suite?.ctx?.currentTest ?? suite?.currentTest))
+        recorder.add(() => doneFn())
+      })
+      .catch(err => {
+        doneFn(err)
+      })
   }
 }
 

package/lib/pause.js

@@ -19,6 +19,35 @@ let finish
 let next
 let registeredVariables = {}
 let externalHandler = null
+let pauseSessionOpen = false
+
+function onStepAfter() {
+  recorder.add('Start next pause session', () => {
+    // test already finished, nothing to pause
+    if (!store.currentTest) return
+    if (!next) return
+    return pauseSession()
+  })
+}
+
+function onTestFinished() {
+  if (typeof finish === 'function') finish()
+  if (pauseSessionOpen) {
+    recorder.session.restore('pause')
+    pauseSessionOpen = false
+  }
+  if (rl) rl.close()
+  if (!externalHandler) history.save()
+  event.dispatcher.removeListener(event.step.after, onStepAfter)
+  event.dispatcher.removeListener(event.test.finished, onTestFinished)
+}
+
+function registerPauseListeners() {
+  event.dispatcher.removeListener(event.step.after, onStepAfter)
+  event.dispatcher.removeListener(event.test.finished, onTestFinished)
+  event.dispatcher.on(event.step.after, onStepAfter)
+  event.dispatcher.on(event.test.finished, onTestFinished)
+}
 
 /**
  * Pauses test execution and starts interactive shell
@@ -28,22 +57,7 @@ const pause = function (passedObject = {}) {
   if (store.dryRun) return
 
   next = false
-  // add listener to all next steps to provide next() functionality
-  event.dispatcher.on(event.step.after, () => {
-    recorder.add('Start next pause session', () => {
-      // test already finished, nothing to pause
-      if (!store.currentTest) return
-      if (!next) return
-      return pauseSession()
-    })
-  })
-
-  event.dispatcher.on(event.test.finished, () => {
-    if (typeof finish === 'function') finish()
-    recorder.session.restore('pause')
-    if (rl) rl.close()
-    if (!externalHandler) history.save()
-  })
+  registerPauseListeners()
 
   recorder.add('Start new session', () => pauseSession(passedObject))
 }
@@ -51,12 +65,14 @@ const pause = function (passedObject = {}) {
 function pauseSession(passedObject = {}) {
   registeredVariables = passedObject
   recorder.session.start('pause')
+  pauseSessionOpen = true
 
   if (externalHandler) {
     store.onPause = true
     return externalHandler({ registeredVariables }).then(() => {
       store.onPause = false
       recorder.session.restore('pause')
+      pauseSessionOpen = false
     })
   }
 
@@ -107,6 +123,7 @@ async function parseInput(cmd) {
   if (!cmd || cmd === 'resume' || cmd === 'exit') {
     if (typeof finish === 'function') finish()
     recorder.session.restore('pause')
+    pauseSessionOpen = false
     rl.close()
     history.save()
     return nextStep()
@@ -265,6 +282,7 @@ function setPauseHandler(handler) {
  */
 function pauseNow(passedObject = {}) {
   if (store.dryRun) return
+  registerPauseListeners()
   recorder.add('Triggered pause', () => pauseSession(passedObject))
 }
 

package/lib/plugin/junitReporter.js

@@ -66,6 +66,26 @@ export default function (config = {}) {
   config = Object.assign({}, defaultConfig, config)
 
   let written = false
+  const hookFailures = []
+
+  event.dispatcher.on(event.hook.failed, hook => {
+    if (!hook || !['BeforeSuite', 'AfterSuite'].includes(hook.hookName)) return
+    const err = hook.err || hook.error
+    if (!err) return
+    const runnable = hook.ctx && hook.ctx.test
+    const suite = runnable && runnable.parent
+    hookFailures.push({
+      title: hook.title || `${hook.hookName} hook failed`,
+      state: 'failed',
+      err,
+      parent: suite,
+      file: (runnable && runnable.file) || (suite && suite.file),
+      tags: (suite && suite.tags) || [],
+      meta: {},
+      steps: [],
+      duration: (runnable && runnable.duration) || 0,
+    })
+  })
 
   const writeReport = result => {
     if (written) return
@@ -76,7 +96,7 @@ export default function (config = {}) {
     mkdirp.sync(dir)
     const file = path.join(dir, config.outputName)
 
-    fs.writeFileSync(file, buildXml(result, config))
+    fs.writeFileSync(file, buildXml(result, config, hookFailures))
     output.plugin('junitReporter', `JUnit report saved to ${file}`)
   }
 
@@ -84,17 +104,18 @@ export default function (config = {}) {
   event.dispatcher.on(event.workers.result, writeReport)
 }
 
-function buildXml(result, config) {
+function buildXml(result, config, hookFailures = []) {
   const doc = new DOMImplementation().createDocument(null, null, null)
-  const suites = groupBySuite(result.tests)
+  const allTests = result.tests.concat(hookFailures)
+  const suites = groupBySuite(allTests)
 
   const root = doc.createElement('testsuites')
   setAttr(root, 'name', config.testGroupName)
-  setAttr(root, 'tests', result.tests.length)
-  setAttr(root, 'failures', countState(result.tests, 'failed'))
-  setAttr(root, 'skipped', countSkipped(result.tests))
+  setAttr(root, 'tests', allTests.length)
+  setAttr(root, 'failures', countState(allTests, 'failed'))
+  setAttr(root, 'skipped', countSkipped(allTests))
   setAttr(root, 'errors', 0)
-  setAttr(root, 'time', toSeconds(sumDuration(result.tests)))
+  setAttr(root, 'time', toSeconds(sumDuration(allTests)))
   setAttr(root, 'timestamp', toIso(result.stats && result.stats.start))
   doc.appendChild(root)
 

package/lib/session.js

@@ -109,6 +109,7 @@ function session(sessionName, config, fn) {
             output.stepShift = 0
             session.restoreVars(sessionName)
             event.dispatcher.removeListener(event.step.after, addContextToStep)
+            recorder.add('restore session on error', () => recorder.session.restore(`session:${sessionName}`))
             recorder.throw(e)
             return recorder.promise()
           })
@@ -124,6 +125,7 @@ function session(sessionName, config, fn) {
           session.restoreVars(sessionName)
           output.stepShift = 0
           event.dispatcher.removeListener(event.step.after, addContextToStep)
+          recorder.session.restore(`session:${sessionName}`)
           throw e
         })
       }

package/lib/utils/typescript.js

@@ -385,7 +385,9 @@ const __dirname = __dirname_fn(__filename);
     )
 
     // Write the transpiled file with updated imports
-    const tempFile = filePath.replace(/\.ts$/, '.temp.mjs')
+    // Include process.pid + a random suffix so concurrent run-multiple workers
+    // don't write to and delete each other's temp files (see issue #5642).
+    const tempFile = filePath.replace(/\.ts$/, `.${process.pid}.${Math.random().toString(36).slice(2, 10)}.temp.mjs`)
     fs.writeFileSync(tempFile, jsContent)
     transpiledFiles.set(filePath, tempFile)
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "4.0.7",
+  "version": "4.0.9",
   "type": "module",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [