fixing timeout errors

Author: DavertMik

examples/codecept.config.js

@@ -37,9 +37,6 @@ exports.config = {
     steps: ['./step_definitions/steps.js'],
   },
   plugins: {
-    tryTo: {
-      enabled: true,
-    },
     analyze: {
       enabled: true,
     },
@@ -63,9 +60,6 @@ exports.config = {
     subtitles: {
       enabled: true,
     },
-    retryTo: {
-      enabled: true,
-    },
   },
 
   tests: './*_test.js',

lib/listener/exit.js

@@ -1,20 +1,17 @@
 const event = require('../event')
+const debug = require('debug')('codeceptjs:exit')
 
 module.exports = function () {
   let failedTests = []
 
-  event.dispatcher.on(event.test.failed, testOrSuite => {
-    // NOTE When an error happens in one of the hooks (BeforeAll/BeforeEach...) the event object
-    // is a suite and not a test
-    const id = testOrSuite.uid || (testOrSuite.ctx && testOrSuite.ctx.test.uid) || 'empty'
+  event.dispatcher.on(event.test.failed, test => {
+    const id = test.uid || (test.ctx && test.ctx.test.uid) || 'empty'
     failedTests.push(id)
   })
 
   // if test was successful after retries
-  event.dispatcher.on(event.test.passed, testOrSuite => {
-    // NOTE When an error happens in one of the hooks (BeforeAll/BeforeEach...) the event object
-    // is a suite and not a test
-    const id = testOrSuite.uid || (testOrSuite.ctx && testOrSuite.ctx.test.uid) || 'empty'
+  event.dispatcher.on(event.test.passed, test => {
+    const id = test.uid || (test.ctx && test.ctx.test.uid) || 'empty'
     failedTests = failedTests.filter(failed => id !== failed)
   })
 

lib/listener/globalTimeout.js

@@ -125,15 +125,16 @@ module.exports = function () {
       return
     }
 
+    debug(`step ${step.toCode().trim()}:${step.status} duration`, step.duration)
     if (typeof timeout === 'number' && !Number.isNaN(timeout)) timeout -= step.duration
 
     if (typeof timeout === 'number' && timeout <= 0 && recorder.isRunning()) {
       debug(`step ${step.toCode().trim()} timed out`)
-      if (currentTest && currentTest.callback) {
+      if (currentTest && currentTest.callback && currentTest.type == 'test') {
         debug(`Failing test ${currentTest.title} with timeout ${currentTimeout}s`)
         recorder.reset()
         // replace mocha timeout with custom timeout
-        // currentTest.timeout(0.1)
+        currentTest.timeout(0.1)
         currentTest.callback(new Error(`Timeout ${currentTimeout}s exceeded (with Before hook)`))
         currentTest.timedOut = true
       }

lib/mocha/cli.js

@@ -230,11 +230,15 @@ class Cli extends Base {
             stack.shift()
           }
 
+          if (stack[0].trim() == 'Error:') {
+            stack.shift()
+          }
+
           if (output.level() < 3) {
             stack = stack.slice(0, 3)
           }
 
-          err.stack = `${stack.join('\n')}\n\n${output.colors.blue(log)}`.trim()
+          err.stack = `${stack.join('\n')}\n\n${output.colors.blue(log)}`
         } catch (e) {
           console.error(e)
         }

lib/mocha/suite.js

@@ -1,5 +1,4 @@
 const MochaSuite = require('mocha/lib/suite')
-
 /**
  * @typedef {import('mocha')} Mocha
  */

lib/mocha/test.js

@@ -2,7 +2,7 @@ const Test = require('mocha/lib/test')
 const Suite = require('mocha/lib/suite')
 const { test: testWrapper } = require('./asyncWrapper')
 const { enhanceMochaSuite, createSuite } = require('./suite')
-const { genTestId, serializeError, clearString } = require('../utils')
+const { genTestId, serializeError, clearString, relativeDir } = require('../utils')
 const Step = require('../step/base')
 /**
  * Factory function to create enhanced tests
@@ -46,6 +46,7 @@ function enhanceMochaTest(test) {
   test.addToSuite = function (suite) {
     enhanceMochaSuite(suite)
     suite.addTest(testWrapper(this))
+    if (test.file) suite.file = relativeDir(test.file)
     test.tags = [...(test.tags || []), ...(suite.tags || [])]
     test.fullTitle = () => `${suite.title}: ${test.title}`
     test.uid = genTestId(test)
@@ -73,7 +74,7 @@ function deserializeTest(test) {
   )
   test.parent = Object.assign(new Suite(test.parent?.title || 'Suite'), test.parent)
   enhanceMochaSuite(test.parent)
-  test.steps = test.steps.map(step => Object.assign(new Step(step.title), step))
+  if (test.steps) test.steps = test.steps.map(step => Object.assign(new Step(step.title), step))
   return test
 }
 
@@ -117,7 +118,7 @@ function serializeTest(test, err = null) {
     duration: test.duration || 0,
     err,
     parent,
-    steps: [...test.steps].map(step => (step.simplify ? step.simplify() : step)),
+    steps: test.steps?.toArray()?.map(step => (step.simplify ? step.simplify() : step)),
   }
 }
 

lib/mocha/types.d.ts

@@ -18,6 +18,7 @@ declare global {
       opts: Record<string, any>
       throws?: Error | string | RegExp | Function
       totalTimeout?: number
+      relativeFile?: string
       addToSuite(suite: Mocha.Suite): void
       applyOptions(opts: Record<string, any>): void
       simplify(): Record<string, any>

lib/output.js

@@ -135,7 +135,7 @@ module.exports = {
      */
     started: suite => {
       if (!suite.title) return
-      print(`${colors.bold(suite.title)} --`)
+      print(`${colors.bold(suite.title)} --`, colors.underline.grey(suite.file || ''))
       if (suite.comment) print(suite.comment)
     },
   },

lib/plugin/retryTo.js

@@ -1,6 +1,8 @@
-module.exports = function () {
+const { retryTo } = require('../effects')
+
+module.exports = function (config) {
   console.log(`
-Deprecated Warning: 'retryTo' has been moved to the effects module.
+Deprecation Warning: 'retryTo' has been moved to the effects module.
 You should update your tests to use it as follows:
 
 \`\`\`javascript
@@ -16,4 +18,10 @@ await retryTo((tryNum) => {
 
 For more details, refer to the documentation.
   `)
+
+  if (config.registerGlobal) {
+    global.retryTo = retryTo
+  }
+
+  return retryTo
 }

lib/plugin/tryTo.js

@@ -1,4 +1,6 @@
-module.exports = function () {
+const { tryTo } = require('../effects')
+
+module.exports = function (config) {
   console.log(`
 Deprecated Warning: 'tryTo' has been moved to the effects module.
 You should update your tests to use it as follows:
@@ -14,4 +16,10 @@ await tryTo(() => {
 
 For more details, refer to the documentation.
   `)
+
+  if (config.registerGlobal) {
+    global[config.registerGlobal] = tryTo
+  }
+
+  return tryTo
 }