Feature: broader uses for watch plugins #6473

tdd · 2018-06-15T11:04:01Z

Summary

As discussed in #6467, watch plugins could be much more useful if they could change a wider range of global config options. This implements a white-listed wider set, tests and docs it.

Two immediate use cases are toggler plugins for tests verbosity and coverage collection. They're already ready and tested on my local machine, but I have no idea how to get them inside the jest-community org, and I'll need the relevant minimum Jest version for a pertinent peerDependency.

Test plan

All tests pass on my machine. Extra tests are located in packages/jest-cli/__tests__/watch.test.js, and focus on confirming white-listing of allowed global config options is effective.

The docs in /docs were also updated (but they don't seem to be used by website/'s yarn start or yarn build, so I only checked their rendering in VS Code's Markdown preview).

This is not semver-major, as there are no breaking changes IMHO, this is more of an extra feature, so looks semver-minor to me.

Hope you like it!

Closes #6467

facebook-github-bot · 2018-06-15T11:04:18Z

Thank you for your pull request. We require contributors to sign our Contributor License Agreement, and yours has expired.

Before we can review or merge your code, we need you to email cla@fb.com with your details so we can update your status.

codecov-io · 2018-06-15T11:18:23Z

Codecov Report

Merging #6473 into master will decrease coverage by 0.03%.
The diff coverage is 65.51%.

@@            Coverage Diff             @@
##           master    #6473      +/-   ##
==========================================
- Coverage   63.61%   63.58%   -0.04%     
==========================================
  Files         235      235              
  Lines        8971     8991      +20     
  Branches        3        4       +1     
==========================================
+ Hits         5707     5717      +10     
- Misses       3263     3273      +10     
  Partials        1        1

Impacted Files	Coverage Δ
packages/jest-cli/src/watch.js	`79.02% <ø> (ø)`	⬆️
packages/jest-cli/src/lib/update_global_config.js	`72.72% <65.51%> (-18.94%)`	⬇️

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 40b0c6a...f36e644. Read the comment docs.

tdd · 2018-06-15T11:20:31Z

@rogeliog this is for your reviewing pleasure 😉

SimenB · 2018-06-15T12:01:53Z

docs/WatchPlugins.md

+
+#### Authorized configuration keys
+
+For stability and safety reasons, only part of the global configuration keys can be updated with `updateConfigAndRun`. The current white list is as follows:


https://facebook.github.io/jest/docs/en/cli.html#changedsince, https://facebook.github.io/jest/docs/en/cli.html#lastcommit and https://facebook.github.io/jest/docs/en/cli.html#onlychanged would be awesome as well. Maybe https://facebook.github.io/jest/docs/en/cli.html#logheapusage?

Hey @SimenB!

--changedSince and --lastCommit do not have any direct equivalent in the global configuration object. They're used by getChangedFilesForRoots in jest-changed-files, and are also ignored when --onlyChanged (which is the default watch mode), so they don't seem to make sense in that mode. At any rate, the watch architecture would not let us change that on the fly right now, this is a bootstrap-time computation.

--onlyChanged is already togglable in watch mode: these are the a key (all tests, same as --watchAll) vs. o key (only changed tests, same as --onlyChanged).

--logHeapUsage does have a matching boolean in the global config, so I'm open to adding it, what do others think?

in the same way toggling onlyChanged is useful, I think changedSince would be useful. It would then overwrite onlyChanged.

@SimenB I agree it would be nice, but Jest's current architecture doesn't let us do it. It computes the watched list at boot time, then keeps it in a closure where specific global config options may amend it (such as the watch mode). There's no stuff in there right now for changedSince or lastCommit, and I feel the change would be significant.

This specific PR is bound by what's in the global config. Should this feature set become config-based, I'll be glad to expand the white list, but it's a different feature scope IMHO.

@rogeliog sounds like we need another of your magical refactor runs 😀

Yeah we would need to change a couple of things in order to make that happen 🙃

SimenB · 2018-06-15T12:02:19Z

packages/jest-cli/src/__tests__/watch.test.js

+      {virtual: true},
+    );
+
+    // updateGlobalConfig.mockReset();


Woops, forgot to strip this 😒

SimenB · 2018-06-15T12:02:38Z

packages/jest-cli/src/__tests__/watch.test.js

@@ -86,6 +86,11 @@ jest.doMock(
  {virtual: true},
 );

+const regularUpdateGlobalConfig = require('../lib/update_global_config')


You can import it to avoid the .default call

Yes, but as I'm mocking it right the next line, it seemed more interesting to keep it close by?

jest.doMock should be called prior to require call

SimenB · 2018-06-15T12:03:30Z

@tdd did you see the CLA comment?

tdd · 2018-06-15T12:21:43Z

@SimenB I did see the CLA comment and e-mailed to update and renew my CLA status. The online form fails in obscure ways for updates (always has, nobody's fixing it).

facebook-github-bot · 2018-06-15T21:12:24Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

rogeliog

Thanks for the PR! I'm excited about this!

rogeliog · 2018-06-19T15:32:37Z

docs/WatchPlugins.md

+
+#### Authorized configuration keys
+
+For stability and safety reasons, only part of the global configuration keys can be updated with `updateConfigAndRun`. The current white list is as follows:


Yeah we would need to change a couple of things in order to make that happen 🙃

rogeliog · 2018-06-19T15:34:32Z

packages/jest-cli/src/__tests__/watch.test.js

+    );
+
+    // updateGlobalConfig.mockReset();
+    const whiteListedOptions = [


I think we could use it.each([objectWithWhitelistedOptionsAndOtherOptions])('')

https://facebook.github.io/jest/docs/en/api.html#testeachtable-name-fn

Right! Good point… Let me try…

rogeliog · 2018-06-19T15:39:57Z

packages/jest-cli/src/watch.js

  } = {}) => {
    const previousUpdateSnapshot = globalConfig.updateSnapshot;
+    // It is unfortunate that Flow isn't smart enough yet to let us
+    // implement a generic assign loop over a list of white-listed
+    // option names here :-(
    globalConfig = updateGlobalConfig(globalConfig, {


Now that there are a lot of options, maybe we could move a lot of this !== undefined logic into the updateGlobalConfig function, so that it is the only place that knows how to handle all of that logic

Yeah, that's an option. I really disliked the un-DRYness of this part of the code, but making it dynamically iterate over a list of props confused the heck out of Flow 😒 .

I'll try and move that logic inside updateGlobalConfig and see how it goes.

tdd · 2018-06-20T13:33:32Z

Hey @rogeliog!

Here's my update. It addresses the various suggestions you had, and it looks like it's going to greenlight through. Let me know what the next steps would be!

tdd · 2018-06-22T12:02:59Z

Hey @rogeliog just following up on this. Have you had time to peruse the latest changes? I'd love to know how and when we can move ahead with this 😉

Refs jestjs#6467

tdd · 2018-06-22T12:06:51Z

Just pushed a force update to fix upstream merge conflicts over CHANGELOG.md after having rebased on top of it.

rogeliog

Awesome! Thanks a lot!

thymikee · 2018-07-07T17:37:34Z

@tdd mind resolving conflicts? :)

tdd · 2018-07-07T20:03:49Z

@thymikee dang, there were none when this was originally approved. Also, all checks passed. Checking it now.

tdd · 2018-07-07T20:31:22Z

Grmbl, this thing stayed too long in limbo, approved but unmerged, as other PRs for watch plugins came in that broke this one. Will need to investigate. (Also, not cool, team 😐 )

thymikee · 2018-07-07T21:14:04Z

I'm pretty sure @rogeliog can help you with figuring out what's wrong now :).
Thanks for your patience though! We try our best to review and merge stuff as early as possible, but there's a lot to do 😅.

tdd · 2018-07-07T21:41:38Z

Hey @thymikee I sure would appreciate @rogeliog's help on this, the issue is the same across the board, when require'ing watch plugins' paths. jest-resolve b0rks further down the line. This is not code I touched in my PR and I have no idea just now about why the path would be missing here—and not break watch.js in master?

rogeliog · 2018-07-08T04:15:51Z

Yes, I'm more than happy to help. I'll take a look

Refs jestjs#6693 Fixes jestjs#6473

tdd · 2018-07-15T09:08:59Z

Hey all! FWIW the initial release of the toggle-config plugin is out, now that 23.4.1 includes this.

Will move it to jest-community soon. Check it out: https://github.com/deliciousinsights/jest-watch-toggle-config#readme

- Some built-in keys remain overridable (specificically `t` and `p`). - Any key registered by a third-party watch plugin cannot be overridden by one listed later in the plugins list config. Fixes jestjs#6693. Refs jestjs#6473.

Refs #6693 Fixes #6473

- Some built-in keys remain overridable (specificically `t` and `p`). - Any key registered by a third-party watch plugin cannot be overridden by one listed later in the plugins list config. Fixes jestjs#6693. Refs jestjs#6473.

tdd · 2018-07-15T12:47:13Z

Hey @rogeliog @SimenB I added you as admins on my toggle-config plugin so you would transfer it to jest-community. Once you've done so and added me back as contributor to it, I'll update its package.json, set up its Travis CI badge, semver-patch it and republish.

SimenB · 2018-07-15T12:59:14Z

Done, and added you as admin

tdd · 2018-07-15T13:15:23Z

Awesome, thank you!

- Some built-in keys remain overridable (specificically `t` and `p`). - Any key registered by a third-party watch plugin cannot be overridden by one listed later in the plugins list config. Fixes jestjs#6693. Refs jestjs#6473.

@SimenB

## Summary Watch plugins now are checked for key conflicts… - Some built-in keys remain overridable (specificically `t` and `p`). - Any key registered by a third-party watch plugin cannot be overridden by one listed later in the plugins list config. Fixes #6693. Refs #6473. ## Test plan Additional tests are provided that check every conflict / overwritable scenario discussed. ## Request for feedback / “spec” evolution The “spec” is an ongoing discussion in #6693 — in particular, the overwritability of some built-in keys, such as `a`, `f` and `o`, may be subject to discussion. This PR tracks the decisions in there and may evolve a bit still. Ping @SimenB @thymikee @rogeliog for review and discussion.

github-actions · 2021-05-12T11:07:19Z

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.

SimenB reviewed Jun 15, 2018

View reviewed changes

facebook-github-bot added the cla signed label Jun 15, 2018

rogeliog reviewed Jun 19, 2018

View reviewed changes

tdd added 6 commits June 22, 2018 14:05

Allow WatchPlugins access to a broader list of global config options

f21640d

Refs jestjs#6467

Tests for whitelisting config options in WatchPlugins

21a93b4

Docs on allowed config options in WatchPlugins

bd8a325

chore: Changelog

cfa476e

tests: leverage it.each to clean up code

e09f018

refactor: centralize config update logic

a5f5c4b

tdd force-pushed the feat/broader-watch-plugins branch from ca07148 to a5f5c4b Compare June 22, 2018 12:06

rogeliog approved these changes Jun 22, 2018

View reviewed changes

Merge branch 'master' into feat/broader-watch-plugins

1cd159a

Merge branch 'master' into feat/broader-watch-plugins

1366412

This was referenced Jul 13, 2018

Update jest in / from 21.2.1 to 23.4.1 LibreTubeApp/LibreTube#134

Open

Update jest in / from 23.4.0 to 23.4.1 opencomponents/storage-adapters#82

Merged

Update jest in / from 21.2.1 to 23.4.1 pcardune/redux-firebase-mirror#155

Open

tdd mentioned this pull request Jul 14, 2018

Improve DX for watch plugin key conflicts #6693

Closed

dependencies bot mentioned this pull request Jul 14, 2018

Update jest in / from 23.4.0 to 23.4.1 opencomponents/oc-template-react#258

Merged

tdd added a commit to deliciousinsights/jest that referenced this pull request Jul 15, 2018

fix(tests): broader watch plugin options test is now correct

f243f6a

Refs jestjs#6693 Fixes jestjs#6473

tdd mentioned this pull request Jul 15, 2018

Fix tests for recent broader-options watch plugins PR #6696

Merged

SimenB pushed a commit that referenced this pull request Jul 15, 2018

fix(tests): broader watch plugin options test is now correct (#6696)

d05e53a

Refs #6693 Fixes #6473

dependencies bot mentioned this pull request Jul 15, 2018

Update jest in / from 23.3.0 to 23.4.1 prettier-solidity/prettier-plugin-solidity#14

Merged

tdd mentioned this pull request Jul 15, 2018

Check watch plugins for key conflicts #6697

Merged

This was referenced Jul 15, 2018

Update jest in / from 23.4.0 to 23.4.1 opencomponents/base-templates#327

Merged

Update jest in / from 23.1.0 to 23.4.1 severest/retrobot#169

Closed

This was referenced Aug 1, 2018

Update jest in /modules/api from 22.4.3 to 23.4.2 project-accelerate/accelerate#207

Open

Update jest in /modules/frontend from 22.4.3 to 23.4.2 project-accelerate/accelerate#235

Open

dependencies bot mentioned this pull request Nov 1, 2018

Update jest in / from 22.1.4 to 23.6.0 leonardofaria/leozera-ui#250

Closed

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


		#### Authorized configuration keys

		For stability and safety reasons, only part of the global configuration keys can be updated with `updateConfigAndRun`. The current white list is as follows:

Feature: broader uses for watch plugins #6473

Feature: broader uses for watch plugins #6473

Conversation

tdd commented Jun 15, 2018 • edited

Summary

Test plan

facebook-github-bot commented Jun 15, 2018

codecov-io commented Jun 15, 2018 • edited

Codecov Report

tdd commented Jun 15, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SimenB commented Jun 15, 2018

tdd commented Jun 15, 2018

facebook-github-bot commented Jun 15, 2018

rogeliog left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tdd commented Jun 20, 2018

tdd commented Jun 22, 2018

tdd commented Jun 22, 2018

rogeliog left a comment

Choose a reason for hiding this comment

thymikee commented Jul 7, 2018 • edited

tdd commented Jul 7, 2018

tdd commented Jul 7, 2018

thymikee commented Jul 7, 2018

tdd commented Jul 7, 2018

rogeliog commented Jul 8, 2018

tdd commented Jul 15, 2018

tdd commented Jul 15, 2018

SimenB commented Jul 15, 2018

tdd commented Jul 15, 2018

github-actions bot commented May 12, 2021

tdd commented Jun 15, 2018 •

edited

codecov-io commented Jun 15, 2018 •

edited

thymikee commented Jul 7, 2018 •

edited