Setup before tests but after framework loads #7119

ddruker · 2018-10-08T02:06:51Z

Summary

Currently the setupTestFrameworkScriptFile option only allows for a single module to be run before each test file is run but after the test framework has been loaded. The option only accepts a string, which is limited and could force someone to import multiple modules into a single file.

This PR will create a new configuration called setupFilesAfterEnv, which is by default an empty array, that can accept multiple paths.

Please note setupTestFrameworkScriptFile is being deprecated.

Closes #6942

Sample configuration

module.exports = {
  testRunner: "jest-circus/runner",
  setupFiles: ["./before/setupJestBefore.js"],
  setupFilesAfterEnv: [
    "./after/setupAfter1.js",
    "./after/setupAfter2.js"
  ]
};

Test plan

Updated snapshot tests, unit tests and integration tests for configuration.

ddruker · 2018-10-08T02:21:59Z

packages/jest-circus/src/legacy_code_todo_rewrite/jest_adapter.js

@@ -77,6 +77,12 @@ const jestAdapter = async (
    runtime.requireModule(config.setupTestFrameworkScriptFile);
  }

+  if (config.setupTestsAfterJest.length) {


This code will run setup files after any file set in setupTestFrameworkScriptFile. I wasn't sure how we want to handle this. Here are some ideas.

Add details in the docs stating that the files set in the new config will run after that old option.

In preparation for the deprecation of setupTestFrameworkScriptFile, only run the new config if set.

Hmm.. you bring up a good point! I lean more towards option 2 since both serve the same purpose. I can't think of a case where I would have both set in my configuration.

With that, another idea I'd like to suggest is that if both are set, we could log a warning indicating that setupTestsAfterJest is taking precedence, and that setupTestFrameworkScriptFile is being ignored.

Just curious, how's the behaviour like if you pass in a wrong path to a file? Is that error handled or is that handled by the runtime. It would be good to gracefully handle that scenario

What about changing line 77 to:

config.setupTestsAfterJest.push(config.setupTestFrameworkScriptFile);

@rickhanlonii Awesome. We would need to include info in the docs that mentions the module set using setupTestFrameworkScriptFile will run after any code set using the new configuration. If I do that, we should probably remove the original implementation of setupTestFrameworkScriptFile in the lines above. Thoughts?

Yeah agreed, can probably add it to the doocs here https://jestjs.io/docs/en/configuration#setuptestframeworkscriptfile-string

What's the original implementation? Do you mean just line 77?

thymikee · 2018-10-08T06:11:45Z

How about naming this "setupFilesAfterJest"?

SimenB · 2018-10-08T06:32:10Z

IMO this should at least print a deprecation warning for setupTestFrameworkScriptFile, and maybe even remove it as well. No reason to support 2 ways of doing the same thing, silently or otherwise. And the next release is a major, so we're good to make breaking changes

mattphillips · 2018-10-08T12:25:27Z

Yup I agree with @SimenB let’s remove setupTestFrameworkScriptFile as part of this change

ddruker · 2018-10-08T12:53:50Z

@thymikee I like it, although there was some consensus around setupTestsAfterJest in the issue so I moved forward with the name. Your suggestion may make more sense. @SimenB, what do you think?

@SimenB What are the steps to deprecate the setupTestFrameworkScriptFile option? I don't want to make too many assumptions about that process.

rickhanlonii · 2018-10-10T21:01:39Z

Good stuff @ddruker

+1 for either setupFilesAfterJest or setupFilesAfterEnv

These have consistency with the existing setupFiles option. I'd recommend "AfterEnv" over "AfterJest" as it's more specific to the usage and it's not really clear when "after jest" is

SimenB · 2018-10-14T15:28:42Z

What are the steps to deprecate the setupTestFrameworkScriptFile option?

Sorry, didn't notice the question! It's simply a matter of adding the option you want to deprecate in here, and add some appropiate help text for the user: https://github.com/facebook/jest/blob/f00fbecb4b29b1f22582255d13591344a862b88e/packages/jest-config/src/Deprecated.js

THen just remove the old option from the code base

ddruker · 2018-10-14T15:42:23Z

@SimenB What do you think about this suggestion by @rickhanlonii? Just want to make sure we're all on the same page about this.

https://github.com/facebook/jest/pull/7119/files#r224995890

SimenB · 2018-10-14T18:34:28Z

I think we should just remove it, but I won't be difficult about it if people wants it to remain for compat (as long as we print a warning)

mattphillips · 2018-10-14T18:36:35Z

I agree with just removing it, we could perhaps remove it and leave an error message when used that points to the new API docs

SimenB · 2018-10-14T18:59:15Z

Yeah, printing the deprecation message is a must, it's widely used

rickhanlonii · 2018-10-15T01:19:27Z

+1 removing it since the next release is a major - I think the confusion is that we were saying both "deprecate" (which would keep the option with a warning) and remove it (which would remove it with a message)

SimenB · 2018-10-15T06:40:16Z

Yeah, good point. Let me rephrase 🙂

Basically, see how scriptPreprocessor is used throughout jest-config for how we want to handle it.

When setupTestFrameworkScriptFile is used:

print a warning
coerce it into setupTestsAfterJest (or whatever we call it), by wrapping it in an array
delete setupTestFrameworkScriptFile from the config

If both setupTestFrameworkScriptFile and setupTestsAfterJest is used, throw an error.

https://github.com/facebook/jest/blob/f00fbecb4b29b1f22582255d13591344a862b88e/packages/jest-config/src/Deprecated.js#L39-L54
https://github.com/facebook/jest/blob/3abfa18d705c3999820b9124b0ecb8be2f3f7be4/packages/jest-config/src/normalize.js#L208-L242

Don't worry too much about the name (setupTestsAfterJest or setupTestsAfterEnv etc), that's easy enough to do a search & replace for later.

As an aside, we can probably remove a few of the deprecations that's been there for multiple versions.

bambielli · 2018-10-16T13:05:35Z

Hello all, I was directed here by @thymikee

#7174 I opened this issue yesterday, I think the documentation for setupFiles is somewhat misleading. Check the issue for more context.

I'm happy to open a PR if you think it's needed.

SimenB · 2018-10-16T13:16:56Z

A PR clarifying the docs is very much welcome 🙂 Behavior-wise the only change in this PR is allowing an array instead of just a single for setupTestFrameworkFile, setupFiles is unchanged (except we might rename it). This PR will only benefit from clearer docs either way!

docs/Configuration.md

packages/jest-config/src/normalize.js

…druker/jest into enhancement/dd-extend-setup-test-after

SimenB · 2018-10-20T19:42:20Z

LGTM! @thymikee @rickhanlonii mind taking a look?

thymikee

Code-wise looks good, I've left some comments and suggestions on the copy.

docs/Configuration.md

packages/jest-cli/src/cli/args.js

CHANGELOG.md

ddruker · 2018-10-21T13:45:34Z

@thymikee Thanks for the great feedback. I made those copy changes to make the language more consistent throughout.

codecov-io · 2018-10-21T14:03:47Z

Codecov Report

Merging #7119 into master will increase coverage by 0.03%.
The diff coverage is 77.77%.

@@            Coverage Diff            @@
##           master   #7119      +/-   ##
=========================================
+ Coverage   67.27%   67.3%   +0.03%     
=========================================
  Files         248     248              
  Lines        9652    9657       +5     
  Branches        4       3       -1     
=========================================
+ Hits         6493    6500       +7     
+ Misses       3158    3156       -2     
  Partials        1       1

Impacted Files	Coverage Δ
packages/jest-config/src/ValidConfig.js	`100% <ø> (ø)`	⬆️
packages/jest-config/src/Defaults.js	`100% <ø> (ø)`	⬆️
packages/jest-config/src/index.js	`19.35% <ø> (ø)`	⬆️
packages/jest-jasmine2/src/index.js	`0% <0%> (ø)`	⬆️
...ircus/src/legacy_code_todo_rewrite/jest_adapter.js	`0% <0%> (ø)`	⬆️
packages/jest-config/src/normalize.js	`85.77% <100%> (+0.35%)`	⬆️
packages/jest-config/src/Deprecated.js	`66.66% <100%> (+6.66%)`	⬆️

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 ad5b040...cd8e2ae. Read the comment docs.

SimenB · 2018-10-21T18:36:18Z

What a fantastic first contribution to Jest @ddruker! Thank you 🎉

kentcdodds · 2018-10-21T18:41:24Z

Woo! Thanks! This is a great change! Looks like I'll have to update a few videos on testingjavascript.com when this is published 😅 any rough idea about when the next major release could be?

SimenB · 2018-10-21T18:45:19Z

We've published an alpha this week, so the ball has started rolling. The milestone still has quite a bit on it though: https://github.com/facebook/jest/milestone/8

A very tentative timeline would be December 1st, I'd say

thymikee · 2018-10-21T19:34:58Z

I'm pretty sure the deprecation message is descriptive enough not to make you (or anybody else) alter any tutorials 😉. We're also planning on simplifying the config sometime next year so stay tuned!

ddruker · 2018-10-22T16:58:10Z

🙏 Great work everyone! I’m excited to keep contributing.

…

On Oct 21, 2018, at 3:35 PM, Michał Pierzchała ***@***.***> wrote: I'm pretty sure the deprecation message is descriptive enough not to make you (or anybody else) alter any tutorials 😉. We're also planning on simplifying the config sometime next year so stay tuned! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

devinmorgan · 2019-01-21T21:38:09Z

Hey there!

Wanted to know if this feature has been released yet?

I'm interested in using both jest-extended and enzyme but each one requires access to the setupTestFrameworkScriptFile field in the jest configuration and this seems to be the fix that I need.

Any clarification here would be great ❤.

SimenB · 2019-01-21T21:45:35Z

It's available in jest@beta (currently 24.0.0-alpha.12).

However, if you're unable to upgrade, you can do this:

{
  "jest": {
    "setupTestFrameworkScriptFile": "<rootDir>/my-setup.js"
  }
}

// my-setup.js
import 'jest-extended';
import 'jest-enzyme';

setupTestFrameworkScriptFile was deprecated jestjs/jest#7119

This is the regular batch update for outdated dependencies. It includes the long awaited React version 16.8.0 (1) that finally brings the stable Hooks API (2) as well as great performance improvements and bug fixes! Updated Jest's configuration since version `>=24.0.0` deprecated `setupTestFrameworkScriptFile` in favor of the new `setupFilesAfterEnv` (3) option. The ESLint plugin `eslint-plugin-react` includes a lot of improvements and bug fixes regarding the parsing of code structures for better prop validation and display name detection. This resulted in the requirement to implement currently missing prop types in various SFC and class components in the project as well globally (temporally) disabling the `react/display-name` rule to prevent warning message noise. Gatsby and all plugins have been updated to the latest versions to include the latest improvements and bug fixes. `gatsby-plugin manifest` now sets the `legacy` option to `true` by default (4) to include Apple touch icons since the assumption was wrong that iOS supports the icons from the web manifest. As of version 3.3 the "Inter UI" font typeface has been renamed and is now "Inter" (5), without the "UI" part. This change has been ported to the used inter-ui (6) package. The import has been adjusted to match the renamed `inter.css` main file and all references to the "Inter UI" name have been adjusted by removing "UI". Prettier version 1.16.0 (7) comes with support for React Hooks and features for TypeScript and HTML as well as many other improvements and bug fixes. React Pose includes an important fix that also animates all other children when items are moving (8) when using the `PoseGroup` component. >>>>>> Production Dependencies - gatsby `2.0.75` -> `2.0.117` - gatsby-plugin-canonical-urls `2.0.8` -> `2.0.10` - gatsby-plugin-catch-links `2.0.9` -> `2.0.10` - gatsby-plugin-google-gtag `1.0.8` -> `1.0.13` - gatsby-plugin-manifest `2.0.12` -> `2.0.17` - gatsby-plugin-netlify `2.0.6` -> `2.0.9` - gatsby-plugin-no-sourcemaps `2.0.1` -> `2.0.2` - gatsby-plugin-offline `2.0.20` -> `2.0.23` - gatsby-plugin-react-helmet `3.0.5` -> `3.0.6` - gatsby-plugin-remove-trailing-slashes `2.0.6` -> `2.0.7` - gatsby-plugin-robots-txt `1.3.0` -> `1.4.0` - gatsby-plugin-sitemap `2.0.3` -> `2.0.5` - gatsby-plugin-styled-components `3.0.4` -> `3.0.5` - gatsby-source-filesystem `2.0.12` -> `2.0.20` - gatsby-transformer-yaml `2.1.6` -> `2.1.8` - inter-ui `3.1.0` -> `3.3.2` - polished `2.3.1` -> `2.3.3` - react `16.7.0` -> `16.8.1` - react-dom `16.7.0` -> `16.8.1` - react-pose `4.0.4` -> `4.0.6` - typeface-source-code-pro `0.0.54` -> `0.0.71` >>>>>> Development Dependencies - @babel/plugin-proposal-class-properties `7.2.3` -> `7.3.0` - babel-jest `23.6.0` -> `24.1.0` - babel-plugin-transform-react-remove-prop-types `0.4.21` -> `0.4.24` - babel-preset-gatsby `0.1.6` -> `0.1.7` - eslint `5.11.0` -> `5.13.0` - eslint-plugin-import `2.14.0` -> `2.16.0` - eslint-plugin-jsx-a11y `6.1.2` -> `6.2.1` - eslint-plugin-prettier `3.0.0` -> `3.0.1` - eslint-plugin-react `7.11.1` -> `7.12.4` - husky `1.2.1` -> `1.3.1` - jest `23.6.0` -> `24.1.0` - jest-dom `3.0.0` -> `3.0.2` - jest-junit `5.2.0` -> `6.2.1` - lint-staged `8.1.0` -> `8.1.3` - prettier `1.15.3` -> `1.16.4` - react-testing-library `5.4.2` -> `5.5.3` References: (1) https://reactjs.org/blog/2019/02/06/react-v16.8.0.html (2) https://reactjs.org/docs/hooks-intro.html (3) jestjs/jest#7119 (4) gatsbyjs/gatsby#11203 (5) https://github.com/rsms/inter/releases/tag/v3.3 (6) https://www.npmjs.com/package/inter-ui (7) https://prettier.io/blog/2019/01/20/1.16.0.html (8) Popmotion/popmotion#682 Resolves GH-120

github-actions · 2021-05-12T03:12:27Z

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.

ddruker added 5 commits September 30, 2018 16:24

add ability to require multiple modules after framework loaded

0691d94

Merge branch 'master' into enhancement/dd-extend-setup-test-after

a93d759

apply logic to jest-circus

4e5b902

add tests to determine if normalize works

4910e56

add integration tests

07b6cba

facebook-github-bot added the cla signed label Oct 8, 2018

ddruker changed the title ~~Run multiple files before each test but after framework is loaded~~ Setup before tests but after framework loads Oct 8, 2018

update changelog

51fe135

ddruker commented Oct 8, 2018

View reviewed changes

ddruker added 2 commits October 7, 2018 22:56

update descriptions

c9367f8

update snapshots

af4ac93

merging master

1177706

ddruker added 2 commits October 14, 2018 11:30

rename config

f532ef1

remove package.json after all tests

4801f37

thymikee mentioned this pull request Oct 16, 2018

Documentation for setupFile configuration option seems misleading #7174

Closed

SimenB mentioned this pull request Oct 16, 2018

Simplifying configuration #7185

Open

Update CHANGELOG.md

7b322df

SimenB reviewed Oct 20, 2018

View reviewed changes

docs/Configuration.md Outdated Show resolved Hide resolved

ddruker commented Oct 20, 2018

View reviewed changes

packages/jest-config/src/normalize.js Outdated Show resolved Hide resolved

SimenB approved these changes Oct 20, 2018

View reviewed changes

ddruker added 2 commits October 20, 2018 15:22

updates per pr review

6ba2beb

Merge branch 'enhancement/dd-extend-setup-test-after' of github.com:d…

6053897

…druker/jest into enhancement/dd-extend-setup-test-after

thymikee reviewed Oct 21, 2018

View reviewed changes

docs/Configuration.md Outdated Show resolved Hide resolved

packages/jest-cli/src/cli/args.js Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

copy changes

cd8e2ae

thymikee approved these changes Oct 21, 2018

View reviewed changes

SimenB merged commit 3f30a46 into jestjs:master Oct 21, 2018

LekoArts mentioned this pull request Jan 28, 2019

fix(docs): update key name for jest@24 support gatsbyjs/gatsby#11302

Merged

NickyMeuleman added a commit to harshit-test-org/javascript-af that referenced this pull request Jan 29, 2019

refactor(tests): replace testframeworksetup with setupfilesafterenv

6adfd7d

setupTestFrameworkScriptFile was deprecated jestjs/jest#7119

arcticicestudio mentioned this pull request Feb 7, 2019

Dependency Update January 2019 nordtheme/web#120

Closed

aduth mentioned this pull request Feb 21, 2019

Upgrade Jest to version 24 (breaking changes) WordPress/gutenberg#13922

Merged

5 tasks

smockle mentioned this pull request Sep 24, 2019

Update 'jest' to pull in a newer 'mem' primer/react#553

Merged

Mayank1791989 mentioned this pull request Oct 3, 2020

feat: add setupFilesAfterEnv support jest-community/jest-runner-eslint#104

Merged

aweng98 mentioned this pull request Mar 24, 2021

[RW-5959][risk=no] Upgrade jest to latest version all-of-us/workbench#4733

Merged

github-actions bot locked as resolved and limited conversation to collaborators May 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Setup before tests but after framework loads #7119

Setup before tests but after framework loads #7119

ddruker commented Oct 8, 2018 •

edited by SimenB

ddruker Oct 8, 2018

wsmd Oct 8, 2018 •

edited

natealcedo Oct 10, 2018

rickhanlonii Oct 10, 2018

ddruker Oct 14, 2018 •

edited

rickhanlonii Oct 15, 2018

thymikee commented Oct 8, 2018

SimenB commented Oct 8, 2018 •

edited

mattphillips commented Oct 8, 2018

ddruker commented Oct 8, 2018 •

edited

rickhanlonii commented Oct 10, 2018

SimenB commented Oct 14, 2018

ddruker commented Oct 14, 2018 •

edited

SimenB commented Oct 14, 2018

mattphillips commented Oct 14, 2018

SimenB commented Oct 14, 2018

rickhanlonii commented Oct 15, 2018

SimenB commented Oct 15, 2018 •

edited

bambielli commented Oct 16, 2018

SimenB commented Oct 16, 2018

SimenB commented Oct 20, 2018

thymikee left a comment

ddruker commented Oct 21, 2018

codecov-io commented Oct 21, 2018

SimenB commented Oct 21, 2018

kentcdodds commented Oct 21, 2018

SimenB commented Oct 21, 2018

thymikee commented Oct 21, 2018

ddruker commented Oct 22, 2018 via email

devinmorgan commented Jan 21, 2019

SimenB commented Jan 21, 2019

github-actions bot commented May 12, 2021

Setup before tests but after framework loads #7119

Setup before tests but after framework loads #7119

Conversation

ddruker commented Oct 8, 2018 • edited by SimenB

Summary

Test plan

ddruker Oct 8, 2018

Choose a reason for hiding this comment

wsmd Oct 8, 2018 • edited

Choose a reason for hiding this comment

natealcedo Oct 10, 2018

Choose a reason for hiding this comment

rickhanlonii Oct 10, 2018

Choose a reason for hiding this comment

ddruker Oct 14, 2018 • edited

Choose a reason for hiding this comment

rickhanlonii Oct 15, 2018

Choose a reason for hiding this comment

thymikee commented Oct 8, 2018

SimenB commented Oct 8, 2018 • edited

mattphillips commented Oct 8, 2018

ddruker commented Oct 8, 2018 • edited

rickhanlonii commented Oct 10, 2018

SimenB commented Oct 14, 2018

ddruker commented Oct 14, 2018 • edited

SimenB commented Oct 14, 2018

mattphillips commented Oct 14, 2018

SimenB commented Oct 14, 2018

rickhanlonii commented Oct 15, 2018

SimenB commented Oct 15, 2018 • edited

bambielli commented Oct 16, 2018

SimenB commented Oct 16, 2018

SimenB commented Oct 20, 2018

thymikee left a comment

Choose a reason for hiding this comment

ddruker commented Oct 21, 2018

codecov-io commented Oct 21, 2018

Codecov Report

SimenB commented Oct 21, 2018

kentcdodds commented Oct 21, 2018

SimenB commented Oct 21, 2018

thymikee commented Oct 21, 2018

ddruker commented Oct 22, 2018 via email

devinmorgan commented Jan 21, 2019

SimenB commented Jan 21, 2019

github-actions bot commented May 12, 2021

ddruker commented Oct 8, 2018 •

edited by SimenB

wsmd Oct 8, 2018 •

edited

ddruker Oct 14, 2018 •

edited

SimenB commented Oct 8, 2018 •

edited

ddruker commented Oct 8, 2018 •

edited

ddruker commented Oct 14, 2018 •

edited

SimenB commented Oct 15, 2018 •

edited