Print deprecation warnings on CLI flags by Aftabnack · Pull Request #5536 · jestjs/jest

Aftabnack · 2018-02-12T18:53:26Z

Summary

Closes Allow jest-validate to print deprecation warnings for CLI flags #5522

Test plan

Integration test to look for deprecation warning printed

codecov-io · 2018-02-12T19:04:19Z

Codecov Report

Merging #5536 into master will decrease coverage by 0.08%.
The diff coverage is 30.76%.

@@            Coverage Diff             @@
##           master    #5536      +/-   ##
==========================================
- Coverage   60.63%   60.54%   -0.09%     
==========================================
  Files         213      213              
  Lines        7311     7328      +17     
  Branches        3        3              
==========================================
+ Hits         4433     4437       +4     
- Misses       2877     2890      +13     
  Partials        1        1

Impacted Files	Coverage Δ
packages/jest-util/src/index.js	`89.47% <ø> (-10.53%)`	⬇️
packages/jest-config/src/index.js	`28.57% <100%> (+2.64%)`	⬆️
packages/jest-validate/src/index.js	`100% <100%> (ø)`	⬆️
packages/jest-validate/src/validate_cli_options.js	`44.44% <18.18%> (ø)`
packages/jest-validate/src/utils.js	`80% <0%> (-20%)`	⬇️

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 966aab6...86ca4ae. Read the comment docs.

Aftabnack · 2018-02-12T20:19:09Z

Couple things to note here:

I have moved validate_cli_opts to jest-validate, as a result I had to add jest-validate as a dependancy in some places. This might increase final size for jest-repl and jest-runtime.
Also, I have exposed jest-config/src/deprecated.js as deprecatedEntries. And used it directly in validate_cli_opts.
I know that will make code more imperative than declarative, but since this won't be necessary when we merge CLI flags with config in future. (If needed I can pass those deprecationEntries from wherever it's called [jest-repl, jest-runtime], which would in turn add to the bundle size of those)

Good things here:

All validations are now in jest-validate package
No extra attributes in jest-cli/src/cli/args.js
Works off of the single source of truth for all deprecations. jest-config/src/deprecated.js

Pointers for future:

Merge CLI flags with whatever's supplied in config file. CLI flags takes precedence
Maintain single source of truth for attributes that are common in CLI flags and Configuration.

SimenB

Needs test and a changelog update 🙂

SimenB · 2018-02-12T22:56:29Z

packages/jest-validate/src/validate_cli_options.js

+    },
+    {},
+  );
+  const deprecations = new Set(Object.keys(CLIDeprecations));


Could you add some tests for this behavior?

thymikee · 2018-02-13T08:04:49Z

Can we now remove jest-validate from jest-util deps? :) Also tests and maybe some screenshots

Aftabnack · 2018-02-13T08:18:02Z

Screenshot after copy pasting mapCoverage deprecation from my other pull.

Aftabnack · 2018-02-13T08:44:02Z

How can I assert on what is being printed on terminal?

thymikee · 2018-02-13T08:45:05Z

Add an integration test and snapshot the stdout

Aftabnack · 2018-02-13T08:46:01Z

I was trying to add that in the package tests under src, there I cannot do this right?

thymikee · 2018-02-13T08:53:39Z

You can add some unit tests for jest-validate and a module that's using it, but we'd still appreciate integration test with running actual CLI.

Aftabnack · 2018-02-13T10:25:24Z

I think I am using the I think I am using jest.mock in a wrong way. Snapshot doesn't have the deprecation message. What am I doing wrong?

thymikee · 2018-02-13T10:43:23Z

integration-tests/__tests__/deprecated-cli-options.test.js

+}));
+
+it('Prints deprecation warnings for CLI flags', () => {
+  const {stderr, stdout} = runJest(dir, ['--cache']);


It's an end to end test, so we should assert on real values. Just pass --preprocessorIgnorePatterns which is already deprecated and you can get rid of mocking jest-config

But the issue is preprocessorIgnorePatterns is not a CLI arg. It throws an error. None of the existing deprecations are in CLI args

And what happens in the future those deprecations are removed from the code. That's why I thought I should mock it.

Maybe we add an internal/undocumented cli arg/config like --printDeprecated

I'd prefer being able to mock it rather than adding a hidden options. That maybe the last resort.

thymikee · 2018-02-13T10:45:17Z

integration-tests/__tests__/deprecated-cli-options.test.js

+
+it('Prints deprecation warnings for CLI flags', () => {
+  const {stderr, stdout} = runJest(dir, ['--cache']);
+  expect(stderr).toMatchSnapshot();


It's sufficient to just do a regex check for Test Suites: 1 passed, 1 total.
Snapshot contains changing data (execution time) which breaks on other machines, unless you replace them with something static.

Aftabnack · 2018-02-13T16:16:31Z

#5536 (comment)

How can I mock jest-config for an integration testcase?

Aftabnack · 2018-02-15T17:39:03Z

Looks like there is no other way to do this.
Can I add a hidden parameter to the jest CLI which will be used to write integration test cases for deprecation.?

/cc @thymikee @SimenB @rickhanlonii

rickhanlonii · 2018-02-15T18:10:39Z

@Aftabnack I'd either add --printDeprecated or just use one that's already there and we can update the test if/when we remove it

Aftabnack · 2018-02-15T18:12:42Z

Since my other PR is merged. I can use mapCoverage to test.

Aftabnack · 2018-02-15T18:56:07Z

I think this is also ready to go!

/cc @thymikee @cpojer

SimenB · 2018-02-16T06:12:51Z

packages/jest-util/src/index.js

  installCommonGlobals,
  isInteractive,
  setGlobal,
-  validateCLIOptions,


technically a breaking change. not sure if it matters, though

It absolutely matters. Please see #5749

SimenB

Nice, thanks!

github-actions · 2021-05-12T19:12:03Z

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.

facebook-github-bot added the CLA Signed ✔️ label Feb 12, 2018

SimenB requested changes Feb 12, 2018

View reviewed changes

SimenB requested a review from thymikee February 12, 2018 22:56

thymikee reviewed Feb 13, 2018

View reviewed changes

Aftabnack force-pushed the jest-validate-cli-deprecations branch from 1400a03 to 1c2b47c Compare February 13, 2018 11:01

Aftabnack force-pushed the jest-validate-cli-deprecations branch from 8eac9ce to f620a4c Compare February 15, 2018 17:55

Aftabnack added 3 commits February 15, 2018 23:43

Moving validate_cli_options from jest-util to jest-validate

ba1366b

Warn on Deprecated Options in CLI args

b9798b5

Added an integration test to test cli deprecations

86ca4ae

Aftabnack force-pushed the jest-validate-cli-deprecations branch from f620a4c to 86ca4ae Compare February 15, 2018 18:42

SimenB reviewed Feb 16, 2018

View reviewed changes

SimenB approved these changes Feb 16, 2018

View reviewed changes

cpojer merged commit ba8a2d5 into jestjs:master Feb 16, 2018

Aftabnack deleted the jest-validate-cli-deprecations branch February 16, 2018 10:30

ghost mentioned this pull request Feb 20, 2018

Update jest in / from 22.3.0 to 22.4.0 opencomponents/storage-adapters#48

Closed

trevorharwell mentioned this pull request Mar 7, 2018

Jest-cli installations break when version is <=22.3.0 #5749

Closed

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

Uh oh!

Conversation

Aftabnack commented Feb 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Uh oh!

codecov-io commented Feb 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Aftabnack commented Feb 12, 2018

Uh oh!

SimenB left a comment

Choose a reason for hiding this comment

Uh oh!

SimenB Feb 12, 2018

Choose a reason for hiding this comment

Uh oh!

thymikee commented Feb 13, 2018

Uh oh!

Aftabnack commented Feb 13, 2018

Uh oh!

Aftabnack commented Feb 13, 2018

Uh oh!

thymikee commented Feb 13, 2018

Uh oh!

Aftabnack commented Feb 13, 2018

Uh oh!

thymikee commented Feb 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Aftabnack commented Feb 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thymikee Feb 13, 2018

Choose a reason for hiding this comment

Uh oh!

Aftabnack Feb 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rickhanlonii Feb 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Aftabnack Feb 13, 2018

Choose a reason for hiding this comment

Uh oh!

thymikee Feb 13, 2018

Choose a reason for hiding this comment

Uh oh!

Aftabnack Feb 13, 2018

Choose a reason for hiding this comment

Uh oh!

Aftabnack commented Feb 13, 2018

Uh oh!

Aftabnack commented Feb 15, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rickhanlonii commented Feb 15, 2018

Uh oh!

Aftabnack commented Feb 15, 2018

Uh oh!

Aftabnack commented Feb 15, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SimenB Feb 16, 2018

Choose a reason for hiding this comment

Uh oh!

trevorharwell Mar 7, 2018

Choose a reason for hiding this comment

Uh oh!

SimenB left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented May 12, 2021

Uh oh!

Reviewers

Assignees

Aftabnack commented Feb 12, 2018 •

edited

Loading

codecov-io commented Feb 12, 2018 •

edited

Loading

thymikee commented Feb 13, 2018 •

edited

Loading

Aftabnack commented Feb 13, 2018 •

edited

Loading

Aftabnack Feb 13, 2018 •

edited

Loading

rickhanlonii Feb 13, 2018 •

edited

Loading

Aftabnack commented Feb 15, 2018 •

edited

Loading

Aftabnack commented Feb 15, 2018 •

edited

Loading