Skip to content

Commit

Permalink
Ensure verbose mode prints output synchronously
Browse files Browse the repository at this point in the history
  • Loading branch information
conartist6 committed Oct 6, 2021
1 parent 24f9bc8 commit 6413244
Show file tree
Hide file tree
Showing 9 changed files with 117 additions and 11 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
- `[@jest/types]` Mark deprecated configuration options as `@deprecated` ([#11913](https://github.com/facebook/jest/pull/11913))
- `[jest-cli]` Improve `--help` printout by removing defunct `--browser` option ([#11914](https://github.com/facebook/jest/pull/11914))
- `[jest-haste-map]` Use distinct cache paths for different values of `computeDependencies` ([#11916](https://github.com/facebook/jest/pull/11916))
- `[@jest/reporters]` Do not buffer `console.log`s when using verbose reporter [#11054](https://github.com/facebook/jest/pull/11054)

### Chore & Maintenance

Expand Down
16 changes: 16 additions & 0 deletions e2e/__tests__/__snapshots__/consoleDebugging.test.ts.snap
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`console debugging with --verbose 1`] = ``;

exports[`console debugging with --verbose 2`] = `
PASS __tests__/console-debugging.test.js
✓ verbose mode prints console output synchronously
`;

exports[`console debugging with --verbose 3`] = `
Test Suites: 1 passed, 1 total
Tests: 1 passed, 1 total
Snapshots: 1 passed, 1 total
Time: <<REPLACED>>
Ran all test suites.
`;
23 changes: 23 additions & 0 deletions e2e/__tests__/consoleDebugging.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

import {wrap} from 'jest-snapshot-serializer-raw';
import {extractSummary} from '../Utils';
import runJest from '../runJest';

test('console debugging with --verbose', () => {
const {stderr, stdout, exitCode} = runJest('console-debugging', [
'--noStackTrace',
'--no-cache',
]);
const {summary, rest} = extractSummary(stderr);

expect(exitCode).toBe(0);
expect(wrap(stdout)).toMatchSnapshot();
expect(wrap(rest)).toMatchSnapshot();
expect(wrap(summary)).toMatchSnapshot();
});
24 changes: 24 additions & 0 deletions e2e/console-debugging/__tests__/console-debugging.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
'use strict';

const stdoutWrite = require('../stdout-spy');

process.stdout.write = jest.fn(process.stdout.write);

test('verbose mode prints console output synchronously', () => {
console.log('test');

expect(stdoutWrite.text).toMatchInlineSnapshot(`
" console.log
test
at Object.log (__tests__/console-debugging.test.js:14:11)
"
`);
});
6 changes: 6 additions & 0 deletions e2e/console-debugging/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
require('./stdout-spy');

module.exports = {
testEnvironment: 'node',
verbose: true,
};
1 change: 1 addition & 0 deletions e2e/console-debugging/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
18 changes: 18 additions & 0 deletions e2e/console-debugging/stdout-spy.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
const originalStdoutWrite = process.stdout.write;

global.process.__stdoutWriteMock = global.process.__stdoutWriteMock || null;

/*
This is a terrible hack to ensure that we monkeyPath stdoutWrite before
the jest reporter does...
*/
if (!global.process.__stdoutWriteMock) {
global.process.__stdoutWriteMock = (...args) => {
global.process.__stdoutWriteMock.text = args[0];
originalStdoutWrite(...args);
};

process.stdout.write = global.process.__stdoutWriteMock;
}

module.exports = global.process.__stdoutWriteMock;
24 changes: 13 additions & 11 deletions packages/jest-reporters/src/DefaultReporter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,18 @@ export default class DefaultReporter extends BaseReporter {
this._err = process.stderr.write.bind(process.stderr);
this._status = new Status();
this._bufferedOutput = new Set();
this._wrapStdio(process.stdout);
this._wrapStdio(process.stderr);
this.__wrapStdio(process.stdout);
this.__wrapStdio(process.stderr);
this._status.onChange(() => {
this._clearStatus();
this._printStatus();
this.__clearStatus();
this.__printStatus();
});
}

private _wrapStdio(stream: NodeJS.WritableStream | NodeJS.WriteStream) {
const originalWrite = stream.write;
protected __wrapStdio(
stream: NodeJS.WritableStream | NodeJS.WriteStream,
): void {
const write = stream.write.bind(stream);

let buffer: Array<string> = [];
let timeout: NodeJS.Timeout | null = null;
Expand All @@ -62,11 +64,11 @@ export default class DefaultReporter extends BaseReporter {
buffer = [];

// This is to avoid conflicts between random output and status text
this._clearStatus();
this.__clearStatus();
if (string) {
originalWrite.call(stream, string);
write(string);
}
this._printStatus();
this.__printStatus();

this._bufferedOutput.delete(flushBufferedOutput);
};
Expand Down Expand Up @@ -103,7 +105,7 @@ export default class DefaultReporter extends BaseReporter {
}
}

private _clearStatus() {
protected __clearStatus(): void {
if (isInteractive) {
if (this._globalConfig.useStderr) {
this._err(this._clear);
Expand All @@ -113,7 +115,7 @@ export default class DefaultReporter extends BaseReporter {
}
}

private _printStatus() {
protected __printStatus(): void {
const {content, clear} = this._status.get();
this._clear = clear;
if (isInteractive) {
Expand Down
15 changes: 15 additions & 0 deletions packages/jest-reporters/src/VerboseReporter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,21 @@ export default class VerboseReporter extends DefaultReporter {
this._globalConfig = globalConfig;
}

// Verbose mode is for debugging. Buffering of output is undesirable.
// See https://github.com/facebook/jest/issues/8208
protected __wrapStdio(
stream: NodeJS.WritableStream | NodeJS.WriteStream,
): void {
const write = stream.write.bind(stream);

stream.write = (chunk: string) => {
this.__clearStatus();
write(chunk);
this.__printStatus();
return true;
};
}

static filterTestResults(
testResults: Array<AssertionResult>,
): Array<AssertionResult> {
Expand Down

0 comments on commit 6413244

Please sign in to comment.