feat: add require stack & surface Yarn PnP

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ### Features
 
+- `[jest-runtime]` Require stack in the errors message when a module cannot be resolved ([#9681](https://github.com/facebook/jest/pull/9681))
 - `[jest-config]` Support ESM config files with `.js` extension ([#9573](https://github.com/facebook/jest/pull/9573)).
 - `[jest-runtime]` Override `module.createRequire` to return a Jest-compatible `require` function ([#9469](https://github.com/facebook/jest/pull/9469))
 - `[jest-haste-map]` [**BREAKING**] Remove `mapper` option ([#9581](https://github.com/facebook/jest/pull/9581))
@@ -10,6 +11,7 @@
 
 ### Fixes
 
+- `[jest-runtime]` Yarn PnP errors surfaced to the user ([#9681](https://github.com/facebook/jest/pull/9681))
 - `[expect]` Handle readonly properties correctly ([#9575](https://github.com/facebook/jest/pull/9575))
 - `[jest-cli]` Set `coverageProvider` correctly when provided in config ([#9562](https://github.com/facebook/jest/pull/9562))
 - `[jest-cli]` Allow specifying `.cjs` and `.mjs` config files by `--config` CLI option ([#9578](https://github.com/facebook/jest/pull/9578))

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:519:17)
+      at createNoMappedModuleFoundError (../../packages/jest-resolve/build/index.js:525: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:519:17)
+      at createNoMappedModuleFoundError (../../packages/jest-resolve/build/index.js:525:17)
       at Object.require (index.js:10:1)
 `;

e2e/__tests__/__snapshots__/resolveNoFileExtensions.test.ts.snap

@@ -12,26 +12,3 @@ exports[`show error message when no js moduleFileExtensions 1`] = `
   https://jestjs.io/docs/configuration.html
 
 `;
-
-exports[`show error message with matching files 1`] = `
-FAIL __tests__/test.js
-  ● Test suite failed to run
-
-    Cannot find module './some-json-file' from 'index.js'
-
-    However, Jest was able to find:
-    	'./some-json-file.json'
-
-    You might want to include a file extension in your import, or update your 'moduleFileExtensions', which is currently ['js'].
-
-    See https://jestjs.io/docs/en/configuration#modulefileextensions-arraystring
-
-      6 |  */
-      7 | 
-    > 8 | module.exports = require('./some-json-file');
-        |                  ^
-      9 | 
-
-      at Resolver.resolveModule (../../packages/jest-resolve/build/index.js:276:11)
-      at Object.require (index.js:8:18)
-`;

e2e/__tests__/pnp.test.ts

@@ -24,5 +24,5 @@ it('sucessfully runs the tests inside `pnp/`', () => {
     nodeOptions: `--require ${DIR}/.pnp.js`,
   });
   expect(json.success).toBe(true);
-  expect(json.numTotalTestSuites).toBe(1);
+  expect(json.numTotalTestSuites).toBe(2);
 });

e2e/__tests__/resolveNoFileExtensions.test.ts

@@ -20,7 +20,65 @@ test('show error message with matching files', () => {
   const {rest} = extractSummary(stderr);
 
   expect(exitCode).toBe(1);
-  expect(wrap(rest)).toMatchSnapshot();
+
+  if (process.platform === 'win32') {
+    expect(wrap(rest)).toMatchInlineSnapshot(`
+      FAIL __tests__/test.js
+        ● Test suite failed to run
+
+          Cannot find module './some-json-file' from 'index.js'
+
+          Require stack:
+            index.js
+            __tests__\\test.js
+
+
+          However, Jest was able to find:
+          	'./some-json-file.json'
+
+          You might want to include a file extension in your import, or update your 'moduleFileExtensions', which is currently ['js'].
+
+          See https://jestjs.io/docs/en/configuration#modulefileextensions-arraystring
+
+            6 |  */
+            7 | 
+          > 8 | module.exports = require('./some-json-file');
+              |                  ^
+            9 | 
+
+            at Resolver.resolveModule (../../packages/jest-resolve/build/index.js:282:11)
+            at Object.require (index.js:8:18)
+    `);
+    return;
+  }
+
+  expect(wrap(rest)).toMatchInlineSnapshot(`
+    FAIL __tests__/test.js
+      ● Test suite failed to run
+
+        Cannot find module './some-json-file' from 'index.js'
+
+        Require stack:
+          index.js
+          __tests__/test.js
+
+
+        However, Jest was able to find:
+        	'./some-json-file.json'
+
+        You might want to include a file extension in your import, or update your 'moduleFileExtensions', which is currently ['js'].
+
+        See https://jestjs.io/docs/en/configuration#modulefileextensions-arraystring
+
+          6 |  */
+          7 | 
+        > 8 | module.exports = require('./some-json-file');
+            |                  ^
+          9 | 
+
+          at Resolver.resolveModule (../../packages/jest-resolve/build/index.js:282:11)
+          at Object.require (index.js:8:18)
+  `);
 });
 
 test('show error message when no js moduleFileExtensions', () => {

e2e/pnp/__tests__/undeclared-dependency.test.js

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+it('should surface pnp errors', () => {
+  try {
+    require('undeclared');
+    throw new Error('UNDECLARED_DEPENDENCY should have been thrown');
+  } catch (error) {
+    expect(error.code).toBe('UNDECLARED_DEPENDENCY');
+  }
+});

e2e/pnp/package.json

@@ -1,6 +1,7 @@
 {
   "dependencies": {
-    "foo": "link:./lib"
+    "foo": "link:./lib",
+    "undeclared": "link:./undeclared-dependency"
   },
   "installConfig": {
     "pnp": true

e2e/pnp/undeclared-dependency/index.js

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+const nope = require('unesitent_module__');
+
+module.exports = () => nope;

e2e/pnp/undeclared-dependency/package.json

@@ -0,0 +1,3 @@
+{
+  "version": "0.0.0"
+}

e2e/pnp/yarn.lock

@@ -5,3 +5,7 @@
 "foo@link:./lib":
   version "0.0.0"
   uid ""
+
+"undeclared@link:./undeclared-dependency":
+  version "0.0.0"
+  uid ""

e2e/resolve/Test7.js

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+require('./test1');
+const requiresUnexistingModule = require('./requiresUnexistingModule');
+
+module.exports = {module: requiresUnexistingModule};

e2e/resolve/__tests__/resolve.test.js

@@ -99,11 +99,60 @@ test('should require resolve haste mocks correctly', () => {
   expect(require('Test6').key).toBe('mock');
 });
 
+test('should throw module not found error if the module has dependencies that cannot be found', () => {
+  try {
+    require('Test7');
+    throw new Error('Requiring Test7 should have thrown an error');
+  } catch (error) {
+    expect(error.code).toBe('MODULE_NOT_FOUND');
+
+    if (process.platform === 'win32') {
+      expect(error.message).toMatchInlineSnapshot(`
+              "Cannot find module 'nope' from 'requiresUnexistingModule.js'
+
+              Require stack:
+                requiresUnexistingModule.js
+                Test7.js
+                __tests__\\\\resolve.test.js
+
+
+              However, Jest was able to find:
+              	'./requiresUnexistingModule.js'
+
+              You might want to include a file extension in your import, or update your 'moduleFileExtensions', which is currently ['js', 'json', 'jsx', 'ts', 'tsx', 'node'].
+
+              See https://jestjs.io/docs/en/configuration#modulefileextensions-arraystring"
+          `);
+      return;
+    }
+
+    expect(error.message).toMatchInlineSnapshot(`
+      "Cannot find module 'nope' from 'requiresUnexistingModule.js'
+
+      Require stack:
+        requiresUnexistingModule.js
+        Test7.js
+        __tests__/resolve.test.js
+
+
+      However, Jest was able to find:
+      	'./requiresUnexistingModule.js'
+
+      You might want to include a file extension in your import, or update your 'moduleFileExtensions', which is currently ['js', 'json', 'jsx', 'ts', 'tsx', 'node'].
+
+      See https://jestjs.io/docs/en/configuration#modulefileextensions-arraystring"
+    `);
+  }
+});
+
 test('should throw module not found error if the module cannot be found', () => {
-  expect(() => require('Test7')).toThrow(
-    expect.objectContaining({
-      code: 'MODULE_NOT_FOUND',
-      message: "Cannot find module 'Test7' from 'resolve.test.js'",
-    })
-  );
+  try {
+    require('Test8');
+    throw new Error('Requiring Test8 should have thrown an error');
+  } catch (error) {
+    expect(error.code).toBe('MODULE_NOT_FOUND');
+    expect(error.message.split('\n')[0]).toBe(
+      "Cannot find module 'Test8' from 'resolve.test.js'"
+    );
+  }
 });

e2e/resolve/requiresUnexistingModule.js

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+require('./test2');
+const unexistedModule = require('nope');
+
+module.exports = {module: unexistedModule};

packages/jest-resolve/src/index.ts

@@ -24,6 +24,7 @@ type FindNodeModuleConfig = {
   paths?: Array<Config.Path>;
   resolver?: Config.Path | null;
   rootDir?: Config.Path;
+  throwIfNotFound?: boolean;
 };
 
 type BooleanObject = Record<string, boolean>;
@@ -105,7 +106,11 @@ class Resolver {
         paths: paths ? (nodePaths || []).concat(paths) : nodePaths,
         rootDir: options.rootDir,
       });
-    } catch (e) {}
+    } catch (e) {
+      if (options.throwIfNotFound) {
+        throw e;
+      }
+    }
     return null;
   }
 
@@ -155,7 +160,7 @@ class Resolver {
     const skipResolution =
       options && options.skipNodeResolution && !moduleName.includes(path.sep);
 
-    const resolveNodeModule = (name: Config.Path) =>
+    const resolveNodeModule = (name: Config.Path, throwIfNotFound = false) =>
       Resolver.findNodeModule(name, {
         basedir: dirname,
         browser: this._options.browser,
@@ -164,10 +169,12 @@ class Resolver {
         paths,
         resolver: this._options.resolver,
         rootDir: this._options.rootDir,
+        throwIfNotFound,
       });
 
     if (!skipResolution) {
-      module = resolveNodeModule(moduleName);
+      // @ts-ignore: the "pnp" version named isn't in DefinitelyTyped
+      module = resolveNodeModule(moduleName, Boolean(process.versions.pnp));
 
       if (module) {
         this._moduleNameCache.set(key, module);

packages/jest-runtime/src/helpers.ts

@@ -9,6 +9,7 @@ import * as path from 'path';
 import slash = require('slash');
 import glob = require('glob');
 import {Config} from '@jest/types';
+import {Path} from '@jest/types/src/Config';
 
 export const findSiblingsWithFileExtension = (
   moduleFileExtensions: Config.ProjectConfig['moduleFileExtensions'],
@@ -53,3 +54,12 @@ export const findSiblingsWithFileExtension = (
 
   return '';
 };
+
+export const printRequireStack = (
+  requireStack: Array<string>,
+  rootDir: Path,
+): string => `
+
+Require stack:
+  ${requireStack.map(p => p.replace(`${rootDir}${path.sep}`, '')).join('\n  ')}
+`;