update step timeout error message for each interface (#1028)

Author: bruce-lindsay

features/before_after_all_hook_timeouts.feature

@@ -28,9 +28,9 @@ Feature: before / after all hook timeouts
     When I run cucumber-js
     Then it fails
     And the error output contains the text snippets:
-      | a handler errored, process exiting        |
-      | function timed out after 500 milliseconds |
-      | features/support/handlers.js:5            |
+      | a handler errored, process exiting                                          |
+      | function timed out, ensure the callback is executed within 500 milliseconds |
+      | features/support/handlers.js:5                                              |
 
     Examples:
       | TYPE      |

features/hook_timeouts.feature

@@ -34,7 +34,7 @@ Feature: Step definition timeouts
     Then it fails
     And the output contains the text:
       """
-      function timed out after 500 milliseconds
+      function timed out, ensure the callback is executed within 500 milliseconds
       """
 
 
@@ -63,7 +63,7 @@ Feature: Step definition timeouts
     Then it fails
     And the output contains the text:
       """
-      function timed out after 500 milliseconds
+      function timed out, ensure the callback is executed within 500 milliseconds
       """
 
 

features/step_definition_timeouts.feature

@@ -44,13 +44,13 @@ Feature: Step definition timeouts
     Then it fails
     And the output contains the text:
       """
-      function timed out after 500 milliseconds
+      function timed out, ensure the <TYPE> <ASSERT> within 500 milliseconds
       """
 
     Examples:
-      | TYPE     |
-      | callback |
-      | promise  |
+      | TYPE     | ASSERT      |
+      | callback | is executed |
+      | promise  | resolves    |
 
 
   Scenario Outline: slow steps can increase their timeout
@@ -81,13 +81,13 @@ Feature: Step definition timeouts
     Then it fails
     And the output contains the text:
       """
-      function timed out after 500 milliseconds
+      function timed out, ensure the <TYPE> <ASSERT> within 500 milliseconds
       """
 
     Examples:
-      | TYPE     |
-      | callback |
-      | promise  |
+      | TYPE     | ASSERT      |
+      | callback | is executed |
+      | promise  | resolves    |
 
 
   Scenario Outline: steps can disable timeouts

src/user_code_runner.js

@@ -54,7 +54,10 @@ export default class UserCodeRunner {
     if (timeoutInMilliseconds >= 0) {
       const timeoutPromise = new Promise((resolve, reject) => {
         timeoutId = Time.setTimeout(() => {
-          const timeoutMessage = `function timed out after ${timeoutInMilliseconds} milliseconds`
+          const timeoutMessage =
+            'function timed out, ensure the ' +
+            (callbackInterface ? 'callback is executed' : 'promise resolves') +
+            ` within ${timeoutInMilliseconds} milliseconds`
           reject(new Error(timeoutMessage))
         }, timeoutInMilliseconds)
       })

src/user_code_runner_spec.js

@@ -131,7 +131,7 @@ describe('UserCodeRunner', () => {
           const { error, result } = await UserCodeRunner.run(this.options)
           expect(error).to.be.instanceof(Error)
           expect(error.message).to.eql(
-            'function timed out after 100 milliseconds'
+            'function timed out, ensure the callback is executed within 100 milliseconds'
           )
           expect(result).to.eql(undefined)
         })
@@ -204,7 +204,7 @@ describe('UserCodeRunner', () => {
         })
       })
 
-      describe('function times out', () => {
+      describe('promise times out', function() {
         beforeEach(function() {
           this.options.fn = function() {
             return Promise.resolve('result').delay(200)
@@ -215,7 +215,7 @@ describe('UserCodeRunner', () => {
           const { error, result } = await UserCodeRunner.run(this.options)
           expect(error).to.be.instanceof(Error)
           expect(error.message).to.eql(
-            'function timed out after 100 milliseconds'
+            'function timed out, ensure the promise resolves within 100 milliseconds'
           )
           expect(result).to.eql(undefined)
         })