chore: default to node test env rather than browser

SimenB · SimenB · commit 402f7f3a20e1 · 2020-04-23T21:49:15.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ### Features
 
+- `[jest-config]` [**BREAKING**] Default to Node testing environment instead of browser ([#9874](https://github.com/facebook/jest/pull/9874))
 - `[@jest/globals]` New package so Jest's globals can be explicitly imported ([#9801](https://github.com/facebook/jest/pull/9801))
 - `[jest-runtime]` Populate `require.cache` ([#9841](https://github.com/facebook/jest/pull/9841))
 
diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -881,9 +881,9 @@ To make a dependency explicit instead of implicit, you can call [`expect.addSnap
 
 ### `testEnvironment` [string]
 
-Default: `"jsdom"`
+Default: `"node"`
 
-The test environment that will be used for testing. The default environment in Jest is a browser-like environment through [jsdom](https://github.com/tmpvar/jsdom). If you are building a node service, you can use the `node` option to use a node-like environment instead.
+The test environment that will be used for testing. The default environment in Jest is a Node.js environment. If you are building a web app, you can use a browser-like environment through [`jsdom`](https://github.com/jsdom/jsdom) instead.
 
 By adding a `@jest-environment` docblock at the top of the file, you can specify another environment to be used for all tests in that file:
 
@@ -963,7 +963,7 @@ beforeAll(() => {
 
 Default: `{}`
 
-Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example you can override options given to [jsdom](https://github.com/tmpvar/jsdom) such as `{userAgent: "Agent/007"}`.
+Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example, you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`.
 
 ### `testMatch` [array\<string>]
 
diff --git a/e2e/__tests__/__snapshots__/consoleLogOutputWhenRunInBand.test.ts.snap b/e2e/__tests__/__snapshots__/consoleLogOutputWhenRunInBand.test.ts.snap
@@ -20,6 +20,6 @@ exports[`prints console.logs when run with forceExit 3`] = `
   console.log
     Hey
 
-      at Object.<anonymous> (__tests__/a-banana.js:1:1)
+      at Object.log (__tests__/a-banana.js:1:30)
 
 `;
diff --git a/e2e/__tests__/__snapshots__/showConfig.test.ts.snap b/e2e/__tests__/__snapshots__/showConfig.test.ts.snap
@@ -51,7 +51,7 @@ exports[`--showConfig outputs config info and exits 1`] = `
       "setupFilesAfterEnv": [],
       "skipFilter": false,
       "snapshotSerializers": [],
-      "testEnvironment": "<<REPLACED_JEST_PACKAGES_DIR>>/jest-environment-jsdom/build/index.js",
+      "testEnvironment": "<<REPLACED_JEST_PACKAGES_DIR>>/jest-environment-node/build/index.js",
       "testEnvironmentOptions": {},
       "testLocationInResults": false,
       "testMatch": [
diff --git a/e2e/__tests__/config.test.ts b/e2e/__tests__/config.test.ts
@@ -59,6 +59,7 @@ test('works with jsdom testEnvironmentOptions config JSON', () => {
   const result = runJest('environmentOptions', [
     '--config=' +
       JSON.stringify({
+        testEnvironment: 'jsdom',
         testEnvironmentOptions: {
           url: 'https://jestjs.io',
         },
diff --git a/e2e/__tests__/resolveBrowserField.test.ts b/e2e/__tests__/resolveBrowserField.test.ts
@@ -35,6 +35,7 @@ test('preserves module identity for symlinks when using browser field resolution
     `,
     'package.json': JSON.stringify({
       jest: {
+        testEnvironment: 'jsdom',
         testMatch: ['<rootDir>/test-files/test.js'],
         browser: true,
       },
diff --git a/examples/angular/jest.config.js b/examples/angular/jest.config.js
@@ -1,6 +1,7 @@
 module.exports = {
   moduleFileExtensions: ['ts', 'html', 'js', 'json'],
   setupFilesAfterEnv: ['<rootDir>/setupJest.js'],
+  testEnvironment: 'jsdom',
   transform: {
     '^.+\\.[t|j]s$': [
       'babel-jest',
diff --git a/examples/jquery/package.json b/examples/jquery/package.json
@@ -13,5 +13,8 @@
   },
   "scripts": {
     "test": "jest"
+  },
+  "jest": {
+    "testEnvironment": "jsdom"
   }
 }
diff --git a/examples/react-testing-library/package.json b/examples/react-testing-library/package.json
@@ -17,5 +17,8 @@
   },
   "scripts": {
     "test": "jest"
+  },
+  "jest": {
+    "testEnvironment": "jsdom"
   }
 }
diff --git a/examples/react/package.json b/examples/react/package.json
@@ -16,5 +16,8 @@
   },
   "scripts": {
     "test": "jest"
+  },
+  "jest": {
+    "testEnvironment": "jsdom"
   }
 }
diff --git a/examples/typescript/package.json b/examples/typescript/package.json
@@ -18,5 +18,8 @@
   },
   "scripts": {
     "test": "jest"
+  },
+  "jest": {
+    "testEnvironment": "jsdom"
   }
 }
diff --git a/jest.config.js b/jest.config.js
@@ -34,7 +34,6 @@ module.exports = {
     '<rootDir>/packages/pretty-format/build/plugins/ConvertAnsi.js',
     require.resolve('jest-snapshot-serializer-raw'),
   ],
-  testEnvironment: './packages/jest-environment-node',
   testPathIgnorePatterns: [
     '/__arbitraries__/',
     '/node_modules/',
diff --git a/packages/jest-cli/src/init/__tests__/__snapshots__/init.test.js.snap b/packages/jest-cli/src/init/__tests__/__snapshots__/init.test.js.snap
@@ -180,7 +180,7 @@ module.exports = {
   // snapshotSerializers: [],
 
   // The test environment that will be used for testing
-  // testEnvironment: \\"jest-environment-jsdom\\",
+  // testEnvironment: \\"jest-environment-node\\",
 
   // Options that will be passed to the testEnvironment
   // testEnvironmentOptions: {},
diff --git a/packages/jest-cli/src/init/__tests__/init.test.js b/packages/jest-cli/src/init/__tests__/init.test.js
@@ -100,8 +100,7 @@ describe('init', () => {
 
         const writtenJestConfig = fs.writeFileSync.mock.calls[0][1];
         const evaluatedConfig = eval(writtenJestConfig);
-        // should modify when the default environment will be changed to "node"
-        expect(evaluatedConfig).toEqual({});
+        expect(evaluatedConfig).toEqual({testEnvironment: 'jsdom'});
       });
 
       it('should create configuration for {environment: "node"}', async () => {
@@ -111,8 +110,7 @@ describe('init', () => {
 
         const writtenJestConfig = fs.writeFileSync.mock.calls[0][1];
         const evaluatedConfig = eval(writtenJestConfig);
-        // should modify when the default environment will be changed to "node"
-        expect(evaluatedConfig).toEqual({testEnvironment: 'node'});
+        expect(evaluatedConfig).toEqual({});
       });
 
       it('should create package.json with configured test command when {scripts: true}', async () => {
diff --git a/packages/jest-cli/src/init/generate_config_file.ts b/packages/jest-cli/src/init/generate_config_file.ts
@@ -45,9 +45,9 @@ const generateConfigFile = (
     });
   }
 
-  if (environment === 'node') {
+  if (environment === 'jsdom') {
     Object.assign(overrides, {
-      testEnvironment: 'node',
+      testEnvironment: 'jsdom',
     });
   }
 
diff --git a/packages/jest-config/src/Defaults.ts b/packages/jest-config/src/Defaults.ts
@@ -53,7 +53,7 @@ const defaultOptions: Config.DefaultOptions = {
   setupFilesAfterEnv: [],
   skipFilter: false,
   snapshotSerializers: [],
-  testEnvironment: 'jest-environment-jsdom',
+  testEnvironment: 'jest-environment-node',
   testEnvironmentOptions: {},
   testFailureExitCode: 1,
   testLocationInResults: false,
diff --git a/website/blog/2017-12-18-jest-22.md b/website/blog/2017-12-18-jest-22.md
@@ -11,7 +11,7 @@ Today we are announcing a new major version of Jest which refines almost all par
 
 ## Good bye Node 4 & welcome JSDOM 11
 
-With this release we are dropping support for Node 4, mainly because one of our main dependencies, JSDOM, ended their support. Jest now comes out of the box with JSDOM 11 which features better support for SVGs, `requestAnimationFrame`, `URL` and `URLSearchParams` built in, and [much more](https://github.com/tmpvar/jsdom/blob/master/Changelog.md).
+With this release we are dropping support for Node 4, mainly because one of our main dependencies, JSDOM, ended their support. Jest now comes out of the box with JSDOM 11 which features better support for SVGs, `requestAnimationFrame`, `URL` and `URLSearchParams` built in, and [much more](https://github.com/jsdom/jsdom/blob/master/Changelog.md).
 
 ## Custom Runners + Easy parallelization with `jest-worker`
 
diff --git a/website/versioned_docs/version-22.x/Configuration.md b/website/versioned_docs/version-22.x/Configuration.md
@@ -651,7 +651,7 @@ To make a dependency explicit instead of implicit, you can call [`expect.addSnap
 
 Default: `"jsdom"`
 
-The test environment that will be used for testing. The default environment in Jest is a browser-like environment through [jsdom](https://github.com/tmpvar/jsdom). If you are building a node service, you can use the `node` option to use a node-like environment instead.
+The test environment that will be used for testing. The default environment in Jest is a browser-like environment through [jsdom](https://github.com/jsdom/jsdom). If you are building a node service, you can use the `node` option to use a node-like environment instead.
 
 If some tests require another environment, you can add a `@jest-environment` docblock.
 
@@ -714,7 +714,7 @@ _Note: Jest comes with JSDOM@11 by default. Due to JSDOM 12 and newer dropping s
 
 Default: `{}`
 
-Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example you can override options given to [jsdom](https://github.com/tmpvar/jsdom) such as `{userAgent: "Agent/007"}`.
+Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example, you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`.
 
 ### `testMatch` [array\<string>]
 
diff --git a/website/versioned_docs/version-23.x/Configuration.md b/website/versioned_docs/version-23.x/Configuration.md
@@ -715,7 +715,7 @@ To make a dependency explicit instead of implicit, you can call [`expect.addSnap
 
 Default: `"jsdom"`
 
-The test environment that will be used for testing. The default environment in Jest is a browser-like environment through [jsdom](https://github.com/tmpvar/jsdom). If you are building a node service, you can use the `node` option to use a node-like environment instead.
+The test environment that will be used for testing. The default environment in Jest is a browser-like environment through [jsdom](https://github.com/jsdom/jsdom). If you are building a node service, you can use the `node` option to use a node-like environment instead.
 
 By adding a `@jest-environment` docblock at the top of the file, you can specify another environment to be used for all tests in that file:
 
@@ -780,7 +780,7 @@ _Note: Jest comes with JSDOM@11 by default. Due to JSDOM 12 and newer dropping s
 
 Default: `{}`
 
-Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example you can override options given to [jsdom](https://github.com/tmpvar/jsdom) such as `{userAgent: "Agent/007"}`.
+Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example, you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`.
 
 ### `testMatch` [array\<string>]
 
diff --git a/website/versioned_docs/version-24.x/Configuration.md b/website/versioned_docs/version-24.x/Configuration.md
@@ -860,7 +860,7 @@ To make a dependency explicit instead of implicit, you can call [`expect.addSnap
 
 Default: `"jsdom"`
 
-The test environment that will be used for testing. The default environment in Jest is a browser-like environment through [jsdom](https://github.com/tmpvar/jsdom). If you are building a node service, you can use the `node` option to use a node-like environment instead.
+The test environment that will be used for testing. The default environment in Jest is a browser-like environment through [jsdom](https://github.com/jsdom/jsdom). If you are building a node service, you can use the `node` option to use a node-like environment instead.
 
 By adding a `@jest-environment` docblock at the top of the file, you can specify another environment to be used for all tests in that file:
 
@@ -942,7 +942,7 @@ _Note: Jest comes with JSDOM@11 by default. Due to JSDOM 12 and newer dropping s
 
 Default: `{}`
 
-Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example you can override options given to [jsdom](https://github.com/tmpvar/jsdom) such as `{userAgent: "Agent/007"}`.
+Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example, you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`.
 
 ### `testMatch` [array\<string>]
 
diff --git a/website/versioned_docs/version-25.1/Configuration.md b/website/versioned_docs/version-25.1/Configuration.md
@@ -871,7 +871,7 @@ To make a dependency explicit instead of implicit, you can call [`expect.addSnap
 
 Default: `"jsdom"`
 
-The test environment that will be used for testing. The default environment in Jest is a browser-like environment through [jsdom](https://github.com/tmpvar/jsdom). If you are building a node service, you can use the `node` option to use a node-like environment instead.
+The test environment that will be used for testing. The default environment in Jest is a browser-like environment through [jsdom](https://github.com/jsdom/jsdom). If you are building a node service, you can use the `node` option to use a node-like environment instead.
 
 By adding a `@jest-environment` docblock at the top of the file, you can specify another environment to be used for all tests in that file:
 
@@ -951,7 +951,7 @@ beforeAll(() => {
 
 Default: `{}`
 
-Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example you can override options given to [jsdom](https://github.com/tmpvar/jsdom) such as `{userAgent: "Agent/007"}`.
+Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example, you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`.
 
 ### `testMatch` [array\<string>]
 
diff --git a/website/versioned_docs/version-25.3/Configuration.md b/website/versioned_docs/version-25.3/Configuration.md
@@ -884,7 +884,7 @@ To make a dependency explicit instead of implicit, you can call [`expect.addSnap
 
 Default: `"jsdom"`
 
-The test environment that will be used for testing. The default environment in Jest is a browser-like environment through [jsdom](https://github.com/tmpvar/jsdom). If you are building a node service, you can use the `node` option to use a node-like environment instead.
+The test environment that will be used for testing. The default environment in Jest is a browser-like environment through [jsdom](https://github.com/jsdom/jsdom). If you are building a node service, you can use the `node` option to use a node-like environment instead.
 
 By adding a `@jest-environment` docblock at the top of the file, you can specify another environment to be used for all tests in that file:
 
@@ -964,7 +964,7 @@ beforeAll(() => {
 
 Default: `{}`
 
-Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example you can override options given to [jsdom](https://github.com/tmpvar/jsdom) such as `{userAgent: "Agent/007"}`.
+Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example, you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`.
 
 ### `testMatch` [array\<string>]
 

Original file line number	Diff line number	Diff line change
`@@ -13,5 +13,8 @@`
`13`	`13`	`},`
`14`	`14`	`"scripts": {`
`15`	`15`	`"test": "jest"`
	`16`	`+ },`
	`17`	`+ "jest": {`
	`18`	`+ "testEnvironment": "jsdom"`
`16`	`19`	`}`
`17`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,5 +17,8 @@`
`17`	`17`	`},`
`18`	`18`	`"scripts": {`
`19`	`19`	`"test": "jest"`
	`20`	`+ },`
	`21`	`+ "jest": {`
	`22`	`+ "testEnvironment": "jsdom"`
`20`	`23`	`}`
`21`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,5 +16,8 @@`
`16`	`16`	`},`
`17`	`17`	`"scripts": {`
`18`	`18`	`"test": "jest"`
	`19`	`+ },`
	`20`	`+ "jest": {`
	`21`	`+ "testEnvironment": "jsdom"`
`19`	`22`	`}`
`20`	`23`	`}`