setTestTimeout/setTimeout

jestjs · Jun 8, 2017 · d458736 · d458736
1 parent 41beefa
commit d458736
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 20 deletions.
diff --git a/docs/en/JestObjectAPI.md b/docs/en/JestObjectAPI.md
@@ -27,7 +27,7 @@ The `jest` object is automatically in scope within every test file. The methods
   - [`jest.runTimersToTime(msToRun)`](#jestruntimerstotimemstorun)
   - [`jest.runOnlyPendingTimers()`](#jestrunonlypendingtimers)
   - [`jest.setMock(moduleName, moduleExports)`](#jestsetmockmodulename-moduleexports)
-  - [`jest.setTestTimeout(timeout)`](#jestsettesttimeouttimeout)
+  - [`jest.setTimeout(timeout)`](#jestsettimeouttimeout)
   - [`jest.unmock(moduleName)`](#jestunmockmodulename)
   - [`jest.useFakeTimers()`](#jestusefaketimers)
   - [`jest.useRealTimers()`](#jestuserealtimers)
@@ -205,16 +205,16 @@ Returns the `jest` object for chaining.
 
 *Note It is recommended to use [`jest.mock()`](#jestmockmodulename-factory-options) instead. The `jest.mock` API's second argument is a module factory instead of the expected exported module object.*
 
-### `jest.setTestTimeout(timeout)`
+### `jest.setTimeout(timeout)`
 
-Set the default timeout interval for tests in milliseconds.
+Set the default timeout interval for tests and before/after hooks in milliseconds.
 
 *Note: The default timeout interval is 5 seconds if this method is not called.*
 
 Example:
 
 ```js
-jest.setTestTimeout(1000); // 1 second
+jest.setTimeout(1000); // 1 second
 ```
 
 ### `jest.unmock(moduleName)`

diff --git a/docs/en/Troubleshooting.md b/docs/en/Troubleshooting.md
@@ -64,10 +64,10 @@ Consider replacing the global promise implementation with your own, for example
 used Promise libraries to a single one.
 
 If your test is long running, you may want to consider to increase the timeout
-by calling  `jest.setTestTimeout`
+by calling  `jest.setTimeout`
 
 ```
-jest.setTestTimeout(10000); // 10 second timeout
+jest.setTimeout(10000); // 10 second timeout
 ```
 
 ### Watchman Issues

diff --git a/integration_tests/__tests__/timeouts-test.js b/integration_tests/__tests__/timeouts-test.js
@@ -23,7 +23,7 @@ afterAll(() => cleanup(DIR));
 test('exceeds the timeout', () => {
   writeFiles(DIR, {
     '__tests__/a-banana.js': `
-      jest.setTestTimeout(20);
+      jest.setTimeout(20);
 
       test('banana', () => {
         return new Promise(resolve => {
@@ -44,7 +44,7 @@ test('exceeds the timeout', () => {
 test('does not exceed the timeout', () => {
   writeFiles(DIR, {
     '__tests__/a-banana.js': `
-      jest.setTestTimeout(100);
+      jest.setTimeout(100);
 
       test('banana', () => {
         return new Promise(resolve => {

diff --git a/packages/jest-circus/src/state.js b/packages/jest-circus/src/state.js
@@ -10,7 +10,6 @@
 
 import type {Event, State, EventHandler} from '../types';
 
-
 const {makeDescribe} = require('./utils');
 const eventHandler = require('./eventHandler');
 

diff --git a/packages/jest-circus/src/utils.js b/packages/jest-circus/src/utils.js
@@ -110,19 +110,19 @@ const getEachHooksForTest = (
   return result;
 };
 
-const _makeTimeoutMessage = (timeout, isHook) => {
-  const message = `Exceeded timeout of ${timeout}ms for a ${isHook ? 'hook' : 'test'}.`;
-  return new Error(message);
-};
+const _makeTimeoutMessage = (timeout, isHook) =>
+  new Error(
+    `Exceeded timeout of ${timeout}ms for a ${isHook ? 'hook' : 'test'}.\nUse jest.setTimeout(newTimeout) to increase the timeout value, if this is a long-running test.`,
+  );
 
 const callAsyncFn = (
   fn: AsyncFn,
   testContext: ?TestContext,
   {
     isHook,
-    timeout,
     test,
-  }: {isHook?: ?boolean, timeout: number, test?: TestEntry},
+    timeout,
+  }: {isHook?: ?boolean, test?: TestEntry, timeout: number},
 ): Promise<any> => {
   return new Promise((resolve, reject) => {
     setTimeout(() => reject(_makeTimeoutMessage(timeout, isHook)), timeout);
@@ -145,7 +145,7 @@ const callAsyncFn = (
 
     // If it's a Promise, return it.
     if (returnedValue instanceof Promise) {
-      return returnedValue.then(resolve).catch(reject);
+      return returnedValue.then(resolve, reject);
     }
 
     if (!isHook && returnedValue !== void 0) {

diff --git a/packages/jest-cli/src/__tests__/SearchSource-test.js b/packages/jest-cli/src/__tests__/SearchSource-test.js
@@ -9,7 +9,7 @@
  */
 'use strict';
 
-jest.setTestTimeout(15000);
+jest.setTimeout(15000);
 
 const path = require('path');
 const skipOnWindows = require('skipOnWindows');

diff --git a/packages/jest-runtime/src/index.js b/packages/jest-runtime/src/index.js
@@ -715,7 +715,7 @@ class Runtime {
     const fn = this._moduleMocker.fn.bind(this._moduleMocker);
     const spyOn = this._moduleMocker.spyOn.bind(this._moduleMocker);
 
-    const setTestTimeout = (timeout: number) => {
+    const setTimeout = (timeout: number) => {
       this._environment.global.jasmine
         ? (this._environment.global.jasmine.DEFAULT_TIMEOUT_INTERVAL = timeout)
         : (this._environment.global[
@@ -758,7 +758,7 @@ class Runtime {
 
       setMock: (moduleName: string, mock: Object) =>
         setMockFactory(moduleName, () => mock),
-      setTestTimeout,
+      setTimeout,
       spyOn,
 
       unmock,

diff --git a/testSetupFile.js b/testSetupFile.js
@@ -10,7 +10,7 @@ const jasmineReporters = require('jasmine-reporters');
 
 // Some of the `jest-runtime` tests are very slow and cause
 // timeouts on travis
-jest.setTestTimeout(70000);
+jest.setTimeout(70000);
 
 if (global.jasmine && process.env.APPVEYOR_API_URL) {
   // Running on AppVeyor, add the custom reporter.