Update Jest Object docs for retryTimes. Use symbol for global lookup.

jestjs · Jun 25, 2018 · 19bf8a6 · 19bf8a6
1 parent 20667aa
commit 19bf8a6
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 4 deletions.
diff --git a/docs/JestObjectAPI.md b/docs/JestObjectAPI.md
@@ -328,8 +328,18 @@ test('will fail', () => {
 
 To run with jest circus:
 
+Install jest-circus
+
+```
+yarn add --dev jest-circus
 ```
-JEST_CIRCUS=1 jest
+
+Then set as the testRunner in your jest config:
+
+```js
+module.exports = {
+  testRunner: 'jest-circus/runner',
+};
 ```
 
 Returns the `jest` object for chaining.

diff --git a/packages/jest-circus/src/run.js b/packages/jest-circus/src/run.js
@@ -48,7 +48,7 @@ const _runTestsForDescribeBlock = async (describeBlock: DescribeBlock) => {
   }
 
   // Tests that fail and are retried we run after other tests
-  const retryTimes = parseInt(global.retryTimes, 10) || 0;
+  const retryTimes = parseInt(global[Symbol.for('RETRY_TIMES')], 10) || 0;
   const deferredRetryTests = [];
 
   for (const test of describeBlock.tests) {

diff --git a/packages/jest-runtime/src/index.js b/packages/jest-runtime/src/index.js
@@ -831,7 +831,7 @@ class Runtime {
     };
 
     const retryTimes = (numTestRetries: number) => {
-      this._environment.global.retryTimes = numTestRetries;
+      this._environment.global[Symbol.for('RETRY_TIMES')] = numTestRetries;
       return jestObject;
     };
 

diff --git a/types/Jest.js b/types/Jest.js
@@ -32,6 +32,7 @@ export type Jest = {|
   resetModuleRegistry(): Jest,
   resetModules(): Jest,
   restoreAllMocks(): Jest,
+  retryTimes(numRetries: number): Jest,
   runAllImmediates(): void,
   runAllTicks(): void,
   runAllTimers(): void,
@@ -45,7 +46,6 @@ export type Jest = {|
     methodName: string,
     accessType?: 'get' | 'set',
   ): JestMockFn,
-  retryTimes(numRetries: number): Jest,
   unmock(moduleName: string): Jest,
   useFakeTimers(): Jest,
   useRealTimers(): Jest,