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

@@ -19,6 +19,11 @@ FAIL __tests__/test.js
 
     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'
 
@@ -32,6 +37,6 @@ FAIL __tests__/test.js
         |                  ^
       9 | 
 
-      at Resolver.resolveModule (../../packages/jest-resolve/build/index.js:276:11)
+      at Resolver.resolveModule (../../packages/jest-resolve/build/index.js:282: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,6 +20,7 @@ test('show error message with matching files', () => {
   const {rest} = extractSummary(stderr);
 
   expect(exitCode).toBe(1);
+
   expect(wrap(rest)).toMatchSnapshot();
 });
 

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,40 @@ 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');
+
+    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/RuntimeModuleNotFoundError.ts

@@ -0,0 +1,42 @@
+/**
+ * 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.
+ */
+
+import * as path from 'path';
+import {ModuleNotFoundError} from 'jest-resolve';
+import {Config} from '@jest/types';
+import slash = require('slash');
+
+export default class RuntimeModuleNotFoundError extends ModuleNotFoundError {
+  public hint?: string;
+  public requireStack?: Array<Config.Path>;
+  public stackTraceBuilt?: boolean;
+
+  public static buildMessage(
+    error: RuntimeModuleNotFoundError,
+    rootDir: Config.Path,
+  ): void {
+    if (
+      !error.stackTraceBuilt &&
+      error?.requireStack?.length &&
+      error?.requireStack?.length > 1
+    ) {
+      error.message += `
+
+Require stack:
+  ${(error.requireStack as Array<string>)
+    .map(p => p.replace(`${rootDir}${path.sep}`, ''))
+    .map(slash)
+    .join('\n  ')}
+`;
+      error.stackTraceBuilt = true;
+    }
+
+    if (error.hint) {
+      error.message += error.hint;
+    }
+  }
+}

packages/jest-runtime/src/index.ts

@@ -41,6 +41,7 @@ import HasteMap = require('jest-haste-map');
 import Resolver = require('jest-resolve');
 import Snapshot = require('jest-snapshot');
 import stripBOM = require('strip-bom');
+import RuntimeModuleNotFoundError from './RuntimeModuleNotFoundError';
 
 type HasteMapOptions = {
   console?: Console;
@@ -511,15 +512,11 @@ class Runtime {
       }
     } catch (e) {
       if (e.code === 'MODULE_NOT_FOUND') {
-        const appendedMessage = findSiblingsWithFileExtension(
+        e.hint = findSiblingsWithFileExtension(
           this._config.moduleFileExtensions,
           from,
           moduleName,
         );
-
-        if (appendedMessage) {
-          e.message += appendedMessage;
-        }
       }
       throw e;
     }
@@ -841,28 +838,32 @@ class Runtime {
       return;
     }
 
-    compiledFunction.call(
-      localModule.exports,
-      localModule as NodeModule, // module object
-      localModule.exports, // module exports
-      localModule.require as typeof require, // require implementation
-      dirname, // __dirname
-      filename, // __filename
-      this._environment.global, // global object
-      this._createJestObjectFor(
-        filename,
-        localModule.require as LocalModuleRequire,
-      ), // jest object
-      ...this._config.extraGlobals.map(globalVariable => {
-        if (this._environment.global[globalVariable]) {
-          return this._environment.global[globalVariable];
-        }
+    try {
+      compiledFunction.call(
+        localModule.exports,
+        localModule as NodeModule, // module object
+        localModule.exports, // module exports
+        localModule.require as typeof require, // require implementation
+        dirname, // __dirname
+        filename, // __filename
+        this._environment.global, // global object
+        this._createJestObjectFor(
+          filename,
+          localModule.require as LocalModuleRequire,
+        ), // jest object
+        ...this._config.extraGlobals.map(globalVariable => {
+          if (this._environment.global[globalVariable]) {
+            return this._environment.global[globalVariable];
+          }
 
-        throw new Error(
-          `You have requested '${globalVariable}' as a global variable, but it was not present. Please check your config or your global environment.`,
-        );
-      }),
-    );
+          throw new Error(
+            `You have requested '${globalVariable}' as a global variable, but it was not present. Please check your config or your global environment.`,
+          );
+        }),
+      );
+    } catch (error) {
+      this.handleExecutionError(error, localModule);
+    }
 
     this._isCurrentlyExecutingManualMock = origCurrExecutingManualMock;
     this._currentlyExecutingModulePath = lastExecutingModulePath;
@@ -1286,6 +1287,28 @@ class Runtime {
       ...this._config.extraGlobals,
     ];
   }
+
+  private handleExecutionError(e: Error, module: InitialModule): void {
+    const runtimeModuleNotFoundError = e as RuntimeModuleNotFoundError;
+    if (runtimeModuleNotFoundError.code === 'MODULE_NOT_FOUND') {
+      runtimeModuleNotFoundError.requireStack = [module.filename || module.id];
+
+      for (let cursor = module.parent; cursor; cursor = cursor.parent) {
+        runtimeModuleNotFoundError.requireStack.push(
+          cursor.filename || cursor.id,
+        );
+      }
+
+      RuntimeModuleNotFoundError.buildMessage(
+        runtimeModuleNotFoundError,
+        this._config.rootDir,
+      );
+
+      throw runtimeModuleNotFoundError;
+    }
+
+    throw e;
+  }
 }
 
 export = Runtime;