chore: remove support for browser field in config (#9943)

SimenB · web-flow · commit e19adcba981f · 2020-05-02T09:19:46.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@
 
 ### Fixes
 
+- `[jest-config, jest-resolve]` [**BREAKING**] Remove support for `browser` field ([#9943](https://github.com/facebook/jest/pull/9943))
+
 ### Chore & Maintenance
 
 - `[expect, jest-mock, pretty-format]` [**BREAKING**] Remove `build-es5` from package ([#9945](https://github.com/facebook/jest/pull/9945))
diff --git a/TestUtils.ts b/TestUtils.ts
@@ -67,7 +67,6 @@ const DEFAULT_GLOBAL_CONFIG: Config.GlobalConfig = {
 
 const DEFAULT_PROJECT_CONFIG: Config.ProjectConfig = {
   automock: false,
-  browser: false,
   cache: false,
   cacheDirectory: '/test_cache_dir/',
   clearMocks: false,
diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -105,12 +105,6 @@ Default: `0`
 
 By default, Jest runs all tests and produces all errors into the console upon completion. The bail config option can be used here to have Jest stop running tests after `n` failures. Setting bail to `true` is the same as setting bail to `1`.
 
-### `browser` [boolean]
-
-Default: `false`
-
-Respect Browserify's [`"browser"` field](https://github.com/substack/browserify-handbook#browser-field) in `package.json` when resolving modules. Some modules export different versions based on whether they are operating in Node or a browser.
-
 ### `cacheDirectory` [string]
 
 Default: `"/tmp/<path>"`
@@ -689,7 +683,6 @@ This option allows the use of a custom resolver. This resolver must be a node mo
 ```json
 {
   "basedir": string,
-  "browser": bool,
   "defaultResolver": "function(request, options)",
   "extensions": [string],
   "moduleDirectory": [string],
@@ -700,7 +693,18 @@ This option allows the use of a custom resolver. This resolver must be a node mo
 
 The function should either return a path to the module that should be resolved or throw an error if the module can't be found.
 
-Note: the defaultResolver passed as options is the jest default resolver which might be useful when you write your custom one. It takes the same arguments as your custom one, e.g. (request, options).
+Note: the defaultResolver passed as options is the Jest default resolver which might be useful when you write your custom one. It takes the same arguments as your custom one, e.g. `(request, options)`.
+
+For example, if you want to respect Browserify's [`"browser"` field](https://github.com/browserify/browserify-handbook/blob/master/readme.markdown#browser-field), you can use the following configuration:
+
+```json
+{
+  ...
+  "jest": {
+    "resolver": "browser-resolve"
+  }
+}
+```
 
 ### `restoreMocks` [boolean]
 
diff --git a/e2e/__tests__/__snapshots__/moduleNameMapper.test.ts.snap b/e2e/__tests__/__snapshots__/moduleNameMapper.test.ts.snap
@@ -36,7 +36,7 @@ FAIL __tests__/index.js
       12 | module.exports = () => 'test';
       13 | 
 
-      at createNoMappedModuleFoundError (../../packages/jest-resolve/build/index.js:545:17)
+      at createNoMappedModuleFoundError (../../packages/jest-resolve/build/index.js:542:17)
       at Object.require (index.js:10:1)
 `;
 
@@ -65,6 +65,6 @@ FAIL __tests__/index.js
       12 | module.exports = () => 'test';
       13 | 
 
-      at createNoMappedModuleFoundError (../../packages/jest-resolve/build/index.js:545:17)
+      at createNoMappedModuleFoundError (../../packages/jest-resolve/build/index.js:542:17)
       at Object.require (index.js:10:1)
 `;
diff --git a/e2e/__tests__/__snapshots__/resolveNoFileExtensions.test.ts.snap b/e2e/__tests__/__snapshots__/resolveNoFileExtensions.test.ts.snap
@@ -37,6 +37,6 @@ FAIL __tests__/test.js
         |                  ^
       9 | 
 
-      at Resolver.resolveModule (../../packages/jest-resolve/build/index.js:299:11)
+      at Resolver.resolveModule (../../packages/jest-resolve/build/index.js:297:11)
       at Object.require (index.js:8:18)
 `;
diff --git a/e2e/__tests__/__snapshots__/showConfig.test.ts.snap b/e2e/__tests__/__snapshots__/showConfig.test.ts.snap
@@ -5,7 +5,6 @@ exports[`--showConfig outputs config info and exits 1`] = `
   "configs": [
     {
       "automock": false,
-      "browser": false,
       "cache": false,
       "cacheDirectory": "/tmp/jest",
       "clearMocks": false,
diff --git a/e2e/__tests__/resolveBrowserField.test.ts b/e2e/__tests__/resolveBrowserField.test.ts
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
@@ -56,9 +56,6 @@ module.exports = {
   // Stop running tests after \`n\` failures
   // bail: 0,
 
-  // Respect \\"browser\\" field in package.json when resolving modules
-  // browser: false,
-
   // The directory where Jest should store its cached dependency information
   // cacheDirectory: \\"/tmp/jest\\",
 
diff --git a/packages/jest-config/src/Defaults.ts b/packages/jest-config/src/Defaults.ts
@@ -15,7 +15,6 @@ const NODE_MODULES_REGEXP = replacePathSepForRegex(NODE_MODULES);
 const defaultOptions: Config.DefaultOptions = {
   automock: false,
   bail: 0,
-  browser: false,
   cache: true,
   cacheDirectory: getCacheDirectory(),
   changedFilesWithAncestor: false,
diff --git a/packages/jest-config/src/Deprecated.ts b/packages/jest-config/src/Deprecated.ts
@@ -11,6 +11,14 @@ import prettyFormat = require('pretty-format');
 const format = (value: unknown) => prettyFormat(value, {min: true});
 
 export default {
+  browser: () => `  Option ${chalk.bold(
+    '"browser"',
+  )} has been deprecated. Please install "browser-resolve" and use the "resolver" option in Jest configuration as follows:
+  {
+    ${chalk.bold('"resolve"')}: ${chalk.bold('"browser-resolve"')}
+  }
+  `,
+
   mapCoverage: () => `  Option ${chalk.bold(
     '"mapCoverage"',
   )} has been removed, as it's no longer necessary.
diff --git a/packages/jest-config/src/Descriptions.ts b/packages/jest-config/src/Descriptions.ts
@@ -10,7 +10,6 @@ import type {Config} from '@jest/types';
 const descriptions: {[key in keyof Config.InitialOptions]: string} = {
   automock: 'All imported modules in your tests should be mocked automatically',
   bail: 'Stop running tests after `n` failures',
-  browser: 'Respect "browser" field in package.json when resolving modules',
   cacheDirectory:
     'The directory where Jest should store its cached dependency information',
   clearMocks: 'Automatically clear mock calls and instances between every test',
diff --git a/packages/jest-config/src/ValidConfig.ts b/packages/jest-config/src/ValidConfig.ts
@@ -15,7 +15,6 @@ const NODE_MODULES_REGEXP = replacePathSepForRegex(NODE_MODULES);
 const initialOptions: Config.InitialOptions = {
   automock: false,
   bail: multipleValidOptions(false, 0),
-  browser: false,
   cache: true,
   cacheDirectory: '/tmp/user/jest',
   changedFilesWithAncestor: false,
diff --git a/packages/jest-config/src/__tests__/normalize.test.js b/packages/jest-config/src/__tests__/normalize.test.js
@@ -154,20 +154,6 @@ describe('automock', () => {
   });
 });
 
-describe('browser', () => {
-  it('falsy browser is not overwritten', () => {
-    const {options} = normalize(
-      {
-        browser: true,
-        rootDir: '/root/path/foo',
-      },
-      {},
-    );
-
-    expect(options.browser).toBe(true);
-  });
-});
-
 describe('collectCoverageOnlyFrom', () => {
   it('normalizes all paths relative to rootDir', () => {
     const {options} = normalize(
diff --git a/packages/jest-config/src/index.ts b/packages/jest-config/src/index.ts
@@ -163,7 +163,6 @@ const groupOptions = (
   }),
   projectConfig: Object.freeze({
     automock: options.automock,
-    browser: options.browser,
     cache: options.cache,
     cacheDirectory: options.cacheDirectory,
     clearMocks: options.clearMocks,
diff --git a/packages/jest-config/src/normalize.ts b/packages/jest-config/src/normalize.ts
@@ -869,7 +869,6 @@ export default function normalize(
         break;
       }
       case 'automock':
-      case 'browser':
       case 'cache':
       case 'changedSince':
       case 'changedFilesWithAncestor':
diff --git a/packages/jest-core/src/lib/__tests__/__snapshots__/log_debug_messages.test.ts.snap b/packages/jest-core/src/lib/__tests__/__snapshots__/log_debug_messages.test.ts.snap
@@ -4,7 +4,6 @@ exports[`prints the config object 1`] = `
 {
   "configs": {
     "automock": false,
-    "browser": false,
     "cache": false,
     "cacheDirectory": "/test_cache_dir/",
     "clearMocks": false,
diff --git a/packages/jest-resolve/package.json b/packages/jest-resolve/package.json
@@ -18,7 +18,6 @@
   },
   "dependencies": {
     "@jest/types": "^25.5.0",
-    "browser-resolve": "^1.11.3",
     "chalk": "^3.0.0",
     "graceful-fs": "^4.2.4",
     "jest-pnp-resolver": "^1.2.1",
@@ -28,7 +27,6 @@
     "slash": "^3.0.0"
   },
   "devDependencies": {
-    "@types/browser-resolve": "^1.11.0",
     "@types/graceful-fs": "^4.1.3",
     "@types/resolve": "^1.14.0",
     "jest-haste-map": "^25.5.1"
diff --git a/packages/jest-resolve/src/defaultResolver.ts b/packages/jest-resolve/src/defaultResolver.ts
@@ -7,7 +7,6 @@
 
 import * as fs from 'graceful-fs';
 import {sync as resolveSync} from 'resolve';
-import {sync as browserResolve} from 'browser-resolve';
 import {sync as realpath} from 'realpath-native';
 import pnpResolver from 'jest-pnp-resolver';
 import type {Config} from '@jest/types';
@@ -31,9 +30,7 @@ export default function defaultResolver(
     return pnpResolver(path, options);
   }
 
-  const resolve = options.browser ? browserResolve : resolveSync;
-
-  const result = resolve(path, {
+  const result = resolveSync(path, {
     basedir: options.basedir,
     extensions: options.extensions,
     isDirectory,
diff --git a/packages/jest-resolve/src/index.ts b/packages/jest-resolve/src/index.ts
@@ -62,7 +62,6 @@ class Resolver {
 
   constructor(moduleMap: ModuleMap, options: ResolverConfig) {
     this._options = {
-      browser: options.browser,
       defaultPlatform: options.defaultPlatform,
       extensions: options.extensions,
       hasCoreModules:
@@ -184,7 +183,6 @@ class Resolver {
     const resolveNodeModule = (name: Config.Path, throwIfNotFound = false) =>
       Resolver.findNodeModule(name, {
         basedir: dirname,
-        browser: this._options.browser,
         extensions,
         moduleDirectory,
         paths,
@@ -438,7 +436,6 @@ class Resolver {
               this.getModule(updatedName) ||
               Resolver.findNodeModule(updatedName, {
                 basedir: dirname,
-                browser: this._options.browser,
                 extensions,
                 moduleDirectory,
                 paths,
diff --git a/packages/jest-resolve/src/types.ts b/packages/jest-resolve/src/types.ts
@@ -8,7 +8,6 @@
 import type {Config} from '@jest/types';
 
 export type ResolverConfig = {
-  browser?: boolean;
   defaultPlatform?: string | null;
   extensions: Array<string>;
   hasCoreModules: boolean;
diff --git a/packages/jest-runtime/src/__tests__/resolve_browser.test.js b/packages/jest-runtime/src/__tests__/resolve_browser.test.js
diff --git a/packages/jest-runtime/src/index.ts b/packages/jest-runtime/src/index.ts
@@ -302,7 +302,6 @@ class Runtime {
     moduleMap: HasteMap.ModuleMap,
   ): Resolver {
     return new Resolver(moduleMap, {
-      browser: config.browser,
       defaultPlatform: config.haste.defaultPlatform,
       extensions: config.moduleFileExtensions.map(extension => '.' + extension),
       hasCoreModules: true,
diff --git a/packages/jest-transform/src/__tests__/__snapshots__/script_transformer.test.js.snap b/packages/jest-transform/src/__tests__/__snapshots__/script_transformer.test.js.snap
diff --git a/packages/jest-types/src/Config.ts b/packages/jest-types/src/Config.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
@@ -5,7 +5,6 @@ exports[`--showConfig outputs config info and exits 1`] = `
`5`	`5`	`"configs": [`
`6`	`6`	`{`
`7`	`7`	`"automock": false,`
`8`		`- "browser": false,`
`9`	`8`	`"cache": false,`
`10`	`9`	`"cacheDirectory": "/tmp/jest",`
`11`	`10`	`"clearMocks": false,`