Express(Node.js)中request库pipe下载单元测试Stub异常排查

我之前也碰到过几乎一模一样的坑！咱们一步步拆解问题，从最常见的原因开始排查：

1. 首要问题：异步时机没处理对 #

Mocha默认同步执行测试，如果你在pipe完成写入前就去读取文件，那读到空字符串太正常了。必须确保等待pipe的写入完成事件触发后再做断言。

方案1：用done回调处理异步 #

const fs = require('fs');
const request = require('request');
const { expect } = require('chai');

it('should save expected content via pipe', (done) => {
  const testFilePath = './test-temp-file.txt';
  
  // 发起请求并pipe到文件
  request('https://your-api-endpoint.com/download')
    .pipe(fs.createWriteStream(testFilePath))
    // 等待写入完成事件
    .on('finish', () => {
      fs.readFile(testFilePath, 'utf8', (err, content) => {
        if (err) return done(err); // 传递错误给Mocha
        expect(content).to.equal('你的预期内容');
        // 清理测试临时文件
        fs.unlink(testFilePath, done);
      });
    })
    // 别忘了监听请求或写入的错误！
    .on('error', (err) => done(err));
});

方案2：用async/await包装流操作（更优雅） #

把流的完成事件包装成Promise，配合async/await使用：

const { promisify } = require('util');
const fs = require('fs');
const request = require('request');
const { expect } = require('chai');

// 封装pipe完成的Promise
const pipeToFile = (stream, filePath) => {
  return new Promise((resolve, reject) => {
    stream.pipe(fs.createWriteStream(filePath))
      .on('finish', resolve)
      .on('error', reject);
  });
};

const readFile = promisify(fs.readFile);
const unlinkFile = promisify(fs.unlink);

it('should save expected content via pipe', async () => {
  const testFilePath = './test-temp-file.txt';
  const reqStream = request('https://your-api-endpoint.com/download');
  
  await pipeToFile(reqStream, testFilePath);
  const content = await readFile(testFilePath, 'utf8');
  
  expect(content).to.equal('你的预期内容');
  await unlinkFile(testFilePath);
});

2. Request Stub的常见错误 #

如果你用Sinon之类的工具Stub request，必须返回一个可读流，而不是普通的响应对象——否则pipe根本无法工作。

正确的Stub方式（以Sinon为例） #

const sinon = require('sinon');
const { Readable } = require('stream');
const request = require('request');

it('should handle stubbed request correctly', async () => {
  // 创建包含预期内容的可读流
  const mockResponseStream = new Readable();
  mockResponseStream.push('你的预期内容');
  mockResponseStream.push(null); // 标记流结束

  // Stub request.get方法，返回我们的模拟流
  const requestStub = sinon.stub(request, 'get').returns(mockResponseStream);

  // 调用你的下载逻辑（假设封装在downloadModule里）
  const testFilePath = './test-temp-file.txt';
  await downloadModule.saveFile(testFilePath);

  // 验证结果
  const content = await promisify(fs.readFile)(testFilePath, 'utf8');
  expect(content).to.equal('你的预期内容');

  // 清理Stub和临时文件
  requestStub.restore();
  await promisify(fs.unlink)(testFilePath);
});

⚠️ 注意：如果你的代码里用的是request(options)而不是request.get，要对应Stubrequest本身，而不是request.get。

3. 排查pipe写入异常 #

很多时候空文件是因为请求或写入过程中出错了，但你没监听错误事件导致被忽略。可以临时加上错误监听排查：

const reqStream = request('https://your-api-endpoint.com/download');
const writeStream = fs.createWriteStream(testFilePath);

// 临时添加错误日志排查
reqStream.on('error', err => console.error('Request出错:', err));
writeStream.on('error', err => console.error('文件写入出错:', err));

reqStream.pipe(writeStream);

额外建议 #

• 测试时尽量用系统临时目录（require('os').tmpdir()）生成文件，避免和其他测试冲突
• 确保每个测试用例都清理临时文件，防止残留影响后续测试

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