使用mock-fs的Jest测试中调用console.log失败的原因与解决方法

可能的诱因 #

我之前也碰到过一模一样的坑，主要是这几个原因在搞鬼：

• mock-fs 劫持了标准输出流：mock-fs 不止模拟文件系统，还会替换 Node.js 原生的 process.stdout 和 process.stderr 实现。当你调用 console.log 时，其实是往被 mock 后的流里写内容，而 Jest 在测试收尾时会检查这些流的状态，如果 mock 的流没正确恢复，就会触发失败检测。
• 异步操作与流恢复时机冲突：你的测试用了 done 回调处理异步逻辑，而 afterEach 里的 mockFs.restore() 可能在 console.log 的输出流还没处理完就执行了，导致流状态异常，让 Jest 误判为测试失败。
• 未捕获的流错误：mock-fs 模拟的流在写入时可能悄悄产生错误，但这些错误没被捕获，最终导致测试失败，而且错误信息可能被掩盖，让你觉得是“莫名失败”。

解决方法 #

针对这些问题，你可以试试下面几个方案：

1. 恢复mock前确保console输出完成 #

因为 console.log 是异步写入流的，所以在 afterEach 里恢复 mock 之前，得等输出流的操作彻底完成。可以用这个方法等待流处理完毕：

afterEach(async () => {
  await new Promise(resolve => {
    if (!process.stdout.write('')) {
      process.stdout.once('drain', resolve);
    } else {
      resolve();
    }
  });
  mockFs.restore();
});

2. 用Jest的mock工具接管console.log #

直接用 Jest 的 spy 来 mock console.log，让输出不走被 mock 的流，就能避开冲突：

test('readdir callback', (done) => {
  const logSpy = jest.spyOn(console, 'log').mockImplementation();
  fs.readdir('/dir', (err, res) => {
    if (err) {
      done(err);
      return;
    }
    console.log(res);
    logSpy.mockRestore();
    done();
  });
});

3. 升级mock-fs到最新版 #

有些旧版本的 mock-fs 在处理标准流时存在bug，升级到最新稳定版大概率能解决问题，运行这个命令就行：

npm update mock-fs

4. 手动恢复标准流 #

如果 mock-fs 没正确恢复 process.stdout 和 process.stderr，可以在 afterEach 里手动还原：

afterEach(async () => {
  mockFs.restore();
  // 手动恢复原生的标准输出和错误流
  process.stdout = process.__stdout;
  process.stderr = process.__stderr;
});

注：部分版本的 mock-fs 会把原生流存在 process.__stdout 和 process.__stderr 里，不确定的话可以先打印这两个属性确认。

修正你的示例代码 #

看你提供的代码还没写完错误处理，记得要正确调用 done()，不然测试会超时失败，容易被误以为是 console.log 的锅。完整的测试代码应该是这样：

import fs from 'mz/fs';
import mockFs from 'mock-fs';

beforeEach(async () => {
  mockFs({
    '/dir': {
      '.pkgrc': JSON.stringify([])
    }
  });
});

afterEach(async () => {
  await new Promise(resolve => {
    process.stdout.write('', resolve);
  });
  mockFs.restore();
});

test('readdir callback', (done) => {
  fs.readdir('/dir', (err, res) => {
    if (err) {
      done(err);
      return;
    }
    console.log(res);
    done();
  });
});

内容的提问来源于stack exchange，提问作者ThomasReggi