Add testEnvironmentOptions to apply to jsdom options or node context.

[kmashint]

Summary

There wasn't a way to override options given to jsdom or node environments, e.g. jsdom only allowed for url: config.testURL. But we need to adjust jsdom options such as "userAgent": "Agent/007" or "runScripts": "outside-only", or "resources": "enable".

This adds an optional testEnvironmentOptions Object to the Config that's then Object.assign()ed to the jsdom options or node context.

Test plan

After adjusting the code and docs, the project was built locally and a simple test as below shows the testEnvironmentOptions can be used to override the userAgent given to jsdom.

package.json:

{
  "jest": {
    "testEnvironmentOptions": {
      "userAgent": "Agent/007"
    }
  }
}

my.test.js:

describe("testEnvironmentOptions", function () {
  it("is Agent/007", function () {
    expect(navigator.userAgent).toBe("Agent/007");
  });
});

Command-line test run:

$ ../jest/jest
PASS .\my.test.js
  testEnvironmentOptions
    √ is Agent/007 (3ms)

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        2.683s
Ran all test suites.

[codecov-io]

Codecov Report

Merging #5003 into master will not change coverage.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master    #5003   +/-   ##
=======================================
  Coverage   60.37%   60.37%           
=======================================
  Files         198      198           
  Lines        6637     6637           
  Branches        4        4           
=======================================
  Hits         4007     4007           
  Misses       2630     2630

Impacted Files	Coverage Δ
packages/jest-config/src/normalize.js	92.94% <ø> (ø)	⬆️
packages/jest-config/src/valid_config.js	100% <ø> (ø)	⬆️
packages/jest-config/src/index.js	23.8% <ø> (ø)	⬆️
packages/jest-config/src/defaults.js	100% <ø> (ø)	⬆️
packages/jest-environment-jsdom/src/index.js	40% <100%> (ø)	⬆️
packages/jest-environment-node/src/index.js	76.66% <100%> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6ade256...9f5b435. Read the comment docs.

[SimenB]

I like it! Not sure if @cpojer is up for it, though 🙂

Can you add an integration test verifying that options are passed in?

[kmashint]

Thanks for the review, I'll add an integration test for passing the options.

[cpojer]

I'm ok with it. Many people have asked for it and there is no reason for me to keep pushing back on a config option for this.

[kmashint]

@SimenB I've added an integration test for the testEnvironmentOptions. The config.test.js seemed the most applicable place, but let me know if it should live elsewhere.

[SimenB]

The new test is failing CI.

I'm wondering if one should key the config per environment? Is it an issue that jsdom options are passed to vm, or the other way around?

[kmashint]

I've updated some lint glitches and a CHANGELOG merge conflict.

[github-actions]

This pull request 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.