chore: default to node test env rather than browser

jestjs · Nov 2, 2020 · af4cec4 · af4cec4
1 parent 6bd96a0
commit af4cec4
Show file tree

Hide file tree

Showing 19 changed files with 33 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ### Features
 
+- `[jest-config]` [**BREAKING**] Default to Node testing environment instead of browser (JSDOM) ([#9874](https://github.com/facebook/jest/pull/9874))
+
 ### Fixes
 
 ### Chore & Maintenance

diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -989,9 +989,9 @@ More about serializers API can be found [here](https://github.com/facebook/jest/
 
 ### `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/jsdom/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:
 
@@ -1071,7 +1071,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/jsdom/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"}`.
 
 ### `testFailureExitCode` [number]
 

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`] = `
       "skipFilter": false,
       "slowTestThreshold": 5,
       "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/dom-diffing/package.json b/e2e/dom-diffing/package.json
@@ -1,3 +1,5 @@
 {
-  "jest": {}
+  "jest": {
+    "testEnvironment": "jsdom"
+  }
 }
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: {
     '\\.[tj]s$': ['babel-jest', {configFile: require.resolve('./.babelrc')}],
   },

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
@@ -33,7 +33,6 @@ module.exports = {
     '<rootDir>/packages/pretty-format/build/plugins/ConvertAnsi.js',
     require.resolve('jest-snapshot-serializer-raw'),
   ],
-  testEnvironment: './packages/jest-environment-node',
   testPathIgnorePatterns: [
     '/test-types/',
     '/__arbitraries__/',

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
@@ -255,7 +255,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
@@ -124,8 +124,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 () => {
@@ -135,8 +134,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/generateConfigFile.ts b/packages/jest-cli/src/init/generateConfigFile.ts
@@ -57,9 +57,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
@@ -54,7 +54,7 @@ const defaultOptions: Config.DefaultOptions = {
   skipFilter: false,
   slowTestThreshold: 5,
   snapshotSerializers: [],
-  testEnvironment: 'jest-environment-jsdom',
+  testEnvironment: 'jest-environment-node',
   testEnvironmentOptions: {},
   testFailureExitCode: 1,
   testLocationInResults: false,

diff --git a/website/versioned_docs/version-22.x/Configuration.md b/website/versioned_docs/version-22.x/Configuration.md
@@ -800,7 +800,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/jsdom/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"}`.
 
 ### `testFailureExitCode` [number]
 

diff --git a/website/versioned_docs/version-23.x/Configuration.md b/website/versioned_docs/version-23.x/Configuration.md
@@ -826,7 +826,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/jsdom/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"}`.
 
 ### `testFailureExitCode` [number]
 

diff --git a/website/versioned_docs/version-24.x/Configuration.md b/website/versioned_docs/version-24.x/Configuration.md
@@ -967,7 +967,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/jsdom/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"}`.
 
 ### `testFailureExitCode` [number]
 

diff --git a/website/versioned_docs/version-25.x/Configuration.md b/website/versioned_docs/version-25.x/Configuration.md
@@ -989,7 +989,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/jsdom/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"}`.
 
 ### `testFailureExitCode` [number]