Fix missing console log output in verbose mode #6871

spion · 2018-08-20T23:28:54Z

Summary

This PR fixes missing / overwritten console.log output in verbose mode.

The monkey-patch of stderr and stdout streams' write methods that clears and rewrites the status report at the bottom is not used when streams are in "inherit" mode. Because of that, live unbuffered output from the child workers gets overwritten by subsequent write instructions.

The multi-worker (parallel) runner is used in watch mode, which force-sets runInBand to false when there are 2 or more tests to run. Additionally, its combined with a regular streaming console (not a buffered one) when verbose is set to true.

Therefore the test case that can be used to reproduce the issue is configured with {verbose: true}, runs in watch mode and contains two tests:

https://github.com/spion/jest-logging-repro

yarn install; yarn repro

To make sure the patched version receives those stdout/stderr writes, its necessary to switch the child processes streams from "inherit" mode to "pipe" mode. This way the process outputs are available as streams in the child process instead of directly going to the main stdout/stderr. The streams are then piped manually to the parent process, which ensures the right write instruction gets called.

In most cases, the right test behavior is preserved by passing FORCE_COLOR with the right value as an environment variable to the child process, and setting it to 0 in runJest. However, istanbul-lib-reporter uses an old version of supports-color which incorrectly implements support for the FORCE_COLOR environment variable. Therefore I updated a few of the snapshot tests to strip ansi codes manually themselves from the coverage reports. This has been done in the mean time since I submitted this PR.

Fixes #2441

Test plan

WIP: I will try to add my repro case (except with runInBand = false) to the e2e test suite. Any other thoughts on tests welcome. Would like some feedback before I proceed further.

SimenB · 2018-08-21T07:41:24Z

Exciting! Thank you so much for tackling it.

I don't get why we have to mess with force color?

spion · 2018-08-21T09:03:13Z

@SimenB when the child streams switch from 'inherit' to 'pipe', process.stdout.isTTY / process.stderr.isTTY are no longer true on them so most colorizes decide to stop adding their colors in the output unless that env var is set (e.g. the dark gray console.log and line number are no longer displayed in color)

Another approach would be to have something like BufferedConsole (StreamingConsole?), except instead of sending the output at the end of the method run it sends messages continuously to the parent worker via process.send.

thymikee

Looks ok from my side, but I'd like to have @mjesun eye on it. Also @spion can you update the snapshots so tests pass?

spion · 2018-08-22T19:47:21Z

Not sure why the tests aren't passing in CI, locally I get

Test Suites: 283 passed, 283 total
Tests:       7 skipped, 2855 passed, 2862 total
Snapshots:   1166 passed, 1166 total
Time:        88.746s
Ran all test suites in 13 projects.

thymikee · 2018-08-22T20:12:48Z

Can you run yarn jest worker -u locally?

codecov-io · 2018-08-22T21:06:44Z

Codecov Report

Merging #6871 into master will increase coverage by 0.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #6871      +/-   ##
==========================================
+ Coverage   67.71%   67.72%   +0.01%     
==========================================
  Files         247      247              
  Lines        9501     9504       +3     
  Branches        5        6       +1     
==========================================
+ Hits         6434     6437       +3     
  Misses       3065     3065              
  Partials        2        2

Impacted Files	Coverage Δ
packages/jest-runner/src/index.js	`76.19% <100%> (+1.19%)`	⬆️
...ages/jest-worker/src/workers/ChildProcessWorker.js	`88.37% <100%> (+0.27%)`	⬆️

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 873c641...c90b048. Read the comment docs.

Jest is presenting a bug when running in verbose mode that's impossible to use `console.log` outside a test file. Use logs inside the source modules is one of the main debugging actions to understand what is going on. References: jestjs/jest#2441 (comment) jestjs/jest#6871

SimenB · 2018-09-16T07:54:19Z

@mjesun could you take a look?

SimenB · 2018-09-29T09:41:46Z

Maybe @rafeca has an opinion? :D

spion · 2018-11-21T14:10:06Z

A few things I forgot to mention, in case it helps:

While the fix does ensure that the output is there, I still get some non-deterministic results. For example, a worker will send its "I'm done" message before flushing the stderr/stdout buffers. If that flush happens after all the tests in all workers complete, the main Jest process will accept the output but will not re-render the status report (instead the output will appear below the status-report-and-shortcuts text blub)
I can't figure out if its possible to force flush the console buffers and/or (more importantly) wait for that event to happen. Reimplementing the console (i.e. the StreamingConsole approach) would allow us to wait for this flush to happen before sending the "I'm done" message.
A third alternative would be to rewrite the last status (shortcuts blub) anyway, even if the final flush happens after. That would probably be easiest, but I haven't checked what it would involve.

SimenB · 2018-11-21T16:00:28Z

@spion mind rebasing? 🙂
@rickhanlonii can you test this at FB somehow? I tested in a smaller project at work and it worked out fine there

spion · 2018-11-23T03:01:45Z

Rebased - the patch is now quite tiny because color stripping for snapshots has already been implemented...

packages/jest-worker/src/Worker.js

SimenB

please update the changelog as well 🙂

packages/jest-worker/src/__tests__/Worker.test.js

SimenB

I'd love the feedback of some FB peeps, but this LGTM

rickhanlonii · 2018-11-23T14:55:50Z

cc @cpojer

aleclarson · 2018-11-27T23:49:26Z

Bump. Would love to get this merged (and released). Super annoying :)

thisissami · 2018-11-28T23:36:01Z

Thanks so much for your work @spion! It's been years of this being a consistent issue.

First of all, we don't need them. And secondly, this reduces the webpack output when running the tests. I would have liked to also reduce the stats that are printed, but because of the following bug, only the one of the two bundled files is printed: jestjs/jest#2441 Jest PR with a fix: jestjs/jest#6871 When the PR is merged, we could use this stats config for example: ```json { all: false, assets: true, colors: true, timings: true } ```

…160) First of all, we don't need them. And secondly, this reduces the webpack output when running the tests. I would have liked to also reduce the stats that are printed, but because of the following bug, only the one of the two bundled files is printed: jestjs/jest#2441 Jest PR with a fix: jestjs/jest#6871 When the PR is merged, we could use this stats config for example: ```json { all: false, assets: true, colors: true, timings: true } ```

* master: (24 commits) Add `jest.isolateModules` for scoped module initialization (jestjs#6701) Migrate to Babel 7 (jestjs#7016) docs: changed "Great Scott!" link (jestjs#7524) Use reduce instead of filter+map in dependency_resolver (jestjs#7522) Update Configuration.md (jestjs#7455) Support dashed args (jestjs#7497) Allow % based configuration of max workers (jestjs#7494) chore: Standardize filenames: jest-runner pkg (jestjs#7464) allow `bail` setting to control when to bail out of a failing test run (jestjs#7335) Add issue template labels (jestjs#7470) chore: standardize filenames in e2e/babel-plugin-jest-hoist (jestjs#7467) Add node worker-thread support to jest-worker (jestjs#7408) Add `testPathIgnorePatterns` to CLI documentation (jestjs#7440) pretty-format: Omit non-enumerable symbol properties (jestjs#7448) Add Jest Architecture overview to docs. (jestjs#7449) chore: run appveyor tests on node 10 chore: fix failures e2e test for node 8 (jestjs#7446) chore: update docusaurus to v1.6.0 (jestjs#7445) Enhancement/expect-to-be-close-to-with-infinity (jestjs#7444) Update CHANGELOG formatting (jestjs#7429) ...

thymikee · 2018-12-18T19:47:22Z

I think we hit this bug yarnpkg/yarn#6042 :(

thymikee · 2018-12-18T19:59:27Z

Removing nohoist helps (and it turned out we don't need it, because we only have 1 version of RN). Also tested locally on Jest repo and it seems to work just fine.

thymikee · 2018-12-18T22:11:21Z

Thanks @spion, appreciated!

SimenB · 2018-12-19T15:44:54Z

released as alpha.9 (jest@beta)

SimenB · 2019-01-14T15:51:33Z

@spion this seems to work really well, thank you so much!

While looking at some other code, I noticed that #7408 (which introduced worker support) does not include this - do you think it needs to? Workers don't have the same stdio API (it has separate stdio, stderr and stdout flags): https://nodejs.org/api/worker_threads.html#worker_threads_new_worker_filename_options

spion · 2019-01-14T21:26:44Z

I'm not sure if its needed - I guess I should have added a proper test to the PR 😞 - but it seems to be like after the refactor the pipe option no longer gets passed all the way to the process based workers.

* fix missing logs * calculate FORCE_COLOR * always force_color=0 from runJest * strip ansi codes from buggy version of supportsColor * jest-worker test: add FORCE_COLOR env var * address style issues * update changelog * Update CHANGELOG.md * nohoist seems unnecessary

github-actions · 2021-05-12T03:13:04Z

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 Aug 20, 2018

SimenB requested review from thymikee, mjesun and rickhanlonii August 21, 2018 07:41

thymikee mentioned this pull request Aug 21, 2018

Wrong file name displayed in the terminal #6873

Closed

thymikee approved these changes Aug 21, 2018

View reviewed changes

SimenB added this to the Jest 24 milestone Oct 16, 2018

spion mentioned this pull request Nov 21, 2018

console.log does not output when running tests #2441

Closed

spion added 3 commits November 22, 2018 00:44

fix missing logs

4644918

calculate FORCE_COLOR

e6aa8da

always force_color=0 from runJest

89257ef

spion force-pushed the fix/missing-logs branch 2 times, most recently from bd90227 to e99bb25 Compare November 22, 2018 18:23

spion added 2 commits November 23, 2018 00:17

strip ansi codes from buggy version of supportsColor

4d31ae0

jest-worker test: add FORCE_COLOR env var

7c83449

spion force-pushed the fix/missing-logs branch from e99bb25 to 7c83449 Compare November 23, 2018 00:17

SimenB reviewed Nov 23, 2018

View reviewed changes

packages/jest-worker/src/Worker.js Outdated Show resolved Hide resolved

SimenB requested changes Nov 23, 2018

View reviewed changes

SimenB reviewed Nov 23, 2018

View reviewed changes

packages/jest-worker/src/__tests__/Worker.test.js Outdated Show resolved Hide resolved

spion and others added 3 commits November 23, 2018 13:54

address style issues

79b61b1

update changelog

1c0b2a7

Update CHANGELOG.md

e42f5c8

SimenB approved these changes Nov 23, 2018

View reviewed changes

thymikee changed the title ~~WIP: Fix missing console log output in verbose mode~~ Fix missing console log output in verbose mode Nov 23, 2018

unstubbable mentioned this pull request Dec 8, 2018

fix(integration-tests): do not emit declaration files (to memory-fs) feature-hub/feature-hub#160

Merged

nohoist seems unnecessary

c90b048

thymikee mentioned this pull request Dec 18, 2018

workspaces: ENOENT in lstat, no stack trace yarnpkg/yarn#6042

Open

thymikee merged commit b21ab21 into jestjs:master Dec 18, 2018

spion deleted the fix/missing-logs branch December 19, 2018 01:01

SimenB mentioned this pull request Dec 25, 2018

console.log does not emit output #3853

Closed

SimenB mentioned this pull request Feb 3, 2019

Console output swallowed with parallel execution #6042

Closed

tgandrews mentioned this pull request Feb 6, 2019

Tech Debt - Upgrade jest 24 ONSdigital/eq-author-app#195

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

Fix missing console log output in verbose mode #6871

Fix missing console log output in verbose mode #6871

spion commented Aug 20, 2018 •

edited

Loading

SimenB commented Aug 21, 2018

spion commented Aug 21, 2018 •

edited

Loading

thymikee left a comment

spion commented Aug 22, 2018

thymikee commented Aug 22, 2018

codecov-io commented Aug 22, 2018 •

edited

Loading

SimenB commented Sep 16, 2018

SimenB commented Sep 29, 2018

spion commented Nov 21, 2018 •

edited

Loading

SimenB commented Nov 21, 2018 •

edited

Loading

spion commented Nov 23, 2018

SimenB left a comment

SimenB left a comment

rickhanlonii commented Nov 23, 2018

aleclarson commented Nov 27, 2018 •

edited

Loading

thisissami commented Nov 28, 2018

thymikee commented Dec 18, 2018

thymikee commented Dec 18, 2018

thymikee commented Dec 18, 2018

SimenB commented Dec 19, 2018

SimenB commented Jan 14, 2019

spion commented Jan 14, 2019

github-actions bot commented May 12, 2021

Fix missing console log output in verbose mode #6871

Fix missing console log output in verbose mode #6871

Conversation

spion commented Aug 20, 2018 • edited Loading

Summary

Test plan

SimenB commented Aug 21, 2018

spion commented Aug 21, 2018 • edited Loading

thymikee left a comment

Choose a reason for hiding this comment

spion commented Aug 22, 2018

thymikee commented Aug 22, 2018

codecov-io commented Aug 22, 2018 • edited Loading

Codecov Report

SimenB commented Sep 16, 2018

SimenB commented Sep 29, 2018

spion commented Nov 21, 2018 • edited Loading

SimenB commented Nov 21, 2018 • edited Loading

spion commented Nov 23, 2018

SimenB left a comment

Choose a reason for hiding this comment

SimenB left a comment

Choose a reason for hiding this comment

rickhanlonii commented Nov 23, 2018

aleclarson commented Nov 27, 2018 • edited Loading

thisissami commented Nov 28, 2018

thymikee commented Dec 18, 2018

thymikee commented Dec 18, 2018

thymikee commented Dec 18, 2018

SimenB commented Dec 19, 2018

SimenB commented Jan 14, 2019

spion commented Jan 14, 2019

github-actions bot commented May 12, 2021

spion commented Aug 20, 2018 •

edited

Loading

spion commented Aug 21, 2018 •

edited

Loading

codecov-io commented Aug 22, 2018 •

edited

Loading

spion commented Nov 21, 2018 •

edited

Loading

SimenB commented Nov 21, 2018 •

edited

Loading

aleclarson commented Nov 27, 2018 •

edited

Loading