refactored timeouts to fix tests

Author: DavertMik

lib/actor.js

@@ -3,8 +3,7 @@ const MetaStep = require('./step/meta')
 const recordStep = require('./step/record')
 const container = require('./container')
 const { methodsOfObject } = require('./utils')
-const { TIMEOUT_ORDER } = require('./step/timeout')
-const recorder = require('./recorder')
+const { TIMEOUT_ORDER } = require('./timeout')
 const event = require('./event')
 const store = require('./store')
 const output = require('./output')

lib/listener/globalTimeout.js

@@ -4,7 +4,7 @@ const recorder = require('../recorder')
 const Config = require('../config')
 const store = require('../store')
 const debug = require('debug')('codeceptjs:timeout')
-const { TIMEOUT_ORDER } = require('../step/timeout')
+const { TIMEOUT_ORDER, TimeoutError, TestTimeoutError } = require('../timeout')
 const { BeforeSuiteHook, AfterSuiteHook } = require('../mocha/hooks')
 
 module.exports = function () {
@@ -119,25 +119,33 @@ module.exports = function () {
     }
   })
 
+  event.dispatcher.on(event.step.after, step => {
+    if (typeof timeout !== 'number') return
+    if (!store.timeouts) return
+
+    recorder.catchWithoutStop(err => {
+      if (timeout && err instanceof TimeoutError && +Date.now() - step.startTime >= timeout) {
+        debug('Step failed due to global test or suite timeout')
+        throw new TestTimeoutError(currentTimeout)
+      }
+      throw err
+    })
+  })
+
   event.dispatcher.on(event.step.finished, step => {
     if (!store.timeouts) {
       debug('step', step.toCode().trim(), 'timeout disabled')
       return
     }
 
+    if (typeof timeout === 'number') debug('Timeout', timeout)
+
     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) {
-        debug(`Failing test ${currentTest.title} with timeout ${currentTimeout}s`)
-        recorder.reset()
-        // replace mocha timeout with custom timeout
-        currentTest.timeout(0.1)
-        currentTest.callback(new Error(`Timeout ${currentTimeout}s exceeded (with Before hook)`))
-        currentTest.timedOut = true
-      }
+      recorder.throw(new TestTimeoutError(currentTimeout))
     }
   })
 }

lib/plugin/stepTimeout.js

@@ -1,5 +1,5 @@
 const event = require('../event')
-const { TIMEOUT_ORDER } = require('../step/timeout')
+const { TIMEOUT_ORDER } = require('../timeout')
 
 const defaultConfig = {
   timeout: 150,

lib/recorder.js

@@ -3,7 +3,7 @@ const promiseRetry = require('promise-retry')
 const chalk = require('chalk')
 const { printObjectProperties } = require('./utils')
 const { log } = require('./output')
-
+const { TimeoutError } = require('./timeout')
 const MAX_TASKS = 100
 
 let promise
@@ -386,7 +386,7 @@ function getTimeoutPromise(timeoutMs, taskName) {
   return [
     new Promise((done, reject) => {
       timer = setTimeout(() => {
-        reject(new Error(`Action ${taskName} was interrupted on step timeout ${timeoutMs}ms`))
+        reject(new TimeoutError(`Action ${taskName} was interrupted on step timeout ${timeoutMs}ms`))
       }, timeoutMs || 2e9)
     }),
     timer,

lib/step/base.js

@@ -1,6 +1,6 @@
 const color = require('chalk')
 const Secret = require('../secret')
-const { getCurrentTimeout } = require('./timeout')
+const { getCurrentTimeout } = require('../timeout')
 const { ucfirst, humanizeString, serializeError } = require('../utils')
 
 const STACK_LINE = 5

lib/step/record.js

@@ -3,7 +3,7 @@ const recorder = require('../recorder')
 const StepConfig = require('./config')
 const { debug } = require('../output')
 const store = require('../store')
-const { TIMEOUT_ORDER } = require('./timeout')
+const { TIMEOUT_ORDER } = require('../timeout')
 const retryStep = require('./retry')
 function recordStep(step, args) {
   step.status = 'queued'

lib/step/timeout.js lib/timeout.jslib/step/timeout.js renamed to lib/timeout.js

@@ -36,7 +36,23 @@ 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'
+  }
+}
+
 module.exports = {
   TIMEOUT_ORDER,
   getCurrentTimeout,
+  TimeoutError,
+  TestTimeoutError,
 }