Ensure verbose mode prints output synchronously

Fixes #8208

Author: conartist6

e2e/__tests__/__snapshots__/consoleDebugging.test.ts.snap

@@ -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.
+`;

e2e/__tests__/consoleDebugging.test.ts

@@ -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();
+});

e2e/console-debugging/__tests__/console-debugging.test.js

@@ -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.
+ */
+'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)
+
+"
+`);
+});

e2e/console-debugging/package.json

@@ -0,0 +1,9 @@
+{
+  "jest": {
+    "testEnvironment": "node",
+    "verbose": true,
+    "setupFiles": [
+      "./stdout-spy.js"
+    ]
+  }
+}

e2e/console-debugging/stdout-spy.js

@@ -0,0 +1,10 @@
+const originalStdoutWrite = process.stdout.write;
+
+const stdoutWrite = (...args) => {
+  stdoutWrite.text = args[0];
+  originalStdoutWrite(...args);
+};
+
+process.stdout.write = stdoutWrite;
+
+module.exports = stdoutWrite;

packages/jest-reporters/src/DefaultReporter.ts

@@ -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;
@@ -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);
     };
@@ -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);
@@ -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) {

packages/jest-reporters/src/VerboseReporter.ts

@@ -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> {