jest-runner require "jest-environment-jsdom" without it being listed in its dependencies

[arcanis]

🐛 Bug Report

Full error:

Package "[email protected]" (via "/Users/mael/Library/Caches/Yarn/v3/npm-jest-runner-23.6.0-3894bd219ffc3f3cb94dc48a4170a2e6f23a5a38/node_modules/jest-runner/build/run_test.js") is trying to require the package "jest-environment-jsdom" (via "jest-environment-jsdom") without it being listed in its dependencies (exit, graceful-fs, jest-config, jest-docblock, jest-haste-map, jest-jasmine2, jest-leak-detector, jest-message-util, jest-runtime, jest-util, jest-worker, source-map-support, throat, jest-runner)

To Reproduce

I'm not sure exactly how envs are specified in Jest; I got the error by running yarn jest in the create-react-app repo, which doesn't have any special kind of configuration.

Expected behavior

No error should be thrown. The environment should by default be already resolved, so that the require call in jest-runner would be a noop (I'm not sure where this default configuration is set, but basically it should be testEnvironment ||= require.resolve('jest-environment-jsdom') rather than testEnvironment ||= 'jest-environment-jsdom').

[SimenB]

I'm guessing this is a PnP thing?

String comes from here: https://github.com/facebook/jest/blob/f8efff95431dd079abf8ae02b8e541e3019d211b/packages/jest-config/src/Defaults.js#L66

How will this work with people doing @jest-environment my-custom-thing in a docblock and us doing require on it? See https://jestjs.io/docs/en/configuration#testenvironment-string

[SimenB]

The resolution should happen here: https://github.com/facebook/jest/blob/f8efff95431dd079abf8ae02b8e541e3019d211b/packages/jest-config/src/utils.js#L105-L142

Ideas on how to make that better/safer/saner? We've had issues with pnpm as well with the environment require before (see #6145)

EDIT: It should be normalized during startup actually, not sure why it's not enough: https://github.com/facebook/jest/blob/f8efff95431dd079abf8ae02b8e541e3019d211b/packages/jest-config/src/normalize.js#L373-L375

[SimenB]

Last comment, but this might be related: #5913 and https://github.com/facebook/create-react-app/blob/72fe2df6fb014db5e18bed49cf19aab30589e943/packages/react-scripts/scripts/test.js#L61-L113

[arcanis]

How will this work with people doing @jest-environment my-custom-thing in a docblock and us doing require on it?`

Not great :/

Something that could be interesting would be to use a module instance to tell Jest relative to which module should the environments be loaded (and it would default to itself). Similar to the moduleLoader version of the pnp-webpack-plugin:

const PnpWebpackPlugin = require(`pnp-webpack-plugin`);

module.exports = {
  resolve: {
    plugins: [
      PnpWebpackPlugin,
    ],
  },
  resolveLoader: {
    plugins: [
      PnpWebpackPlugin.moduleLoader(module),
    ],
  },
};

[imsnif]

Just adding this here for those who might google their way to this thread:

This can be worked around by installing jest-environment-jsdom in the root package of the project (eg. yarn add -D jest-environment-jsdom).

[aleclarson]

Specifying an explicit testEnvironment in your Jest config also works. Or provide --env=node when running the Jest CLI. So it seems the problem occurs when testEnvironment is undefined.

edit: Please see #7476

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.