NestJS将Stream Pipe到Response时报错：Cannot set headers after they are sent

问题场景 #

学习Node.js Streams时，尝试将Readable Stream通过pipe传输到HTTP响应中，出现错误提示：Cannot set headers after they are sent to the client，相关代码如下：

@Post('/pipe-into-response')
pipeIntoResponse(@Body() payload, @Res() response: Response) {
    const stream = new Readable();
    stream.on('end', () => response.end());
    stream.push('Hello World');
    stream.pipe(response);
}

错误成因 #

1. 重复结束响应：stream.pipe(response)会自动管理响应的生命周期，当流结束时会自动调用response.end()。你额外监听了stream的end事件并手动调用response.end()，导致响应被两次标记为结束。第一次结束后，HTTP响应的headers已经发送给客户端，第二次调用response.end()时会尝试修改headers，触发该错误。
2. 流未正确结束：创建的Readable Stream没有标记结束（未调用stream.push(null)），虽然这不是直接触发错误的原因，但会导致流无法正常进入end状态，可能引发其他异常。

解决方法 #

• 移除手动调用response.end()的逻辑，依赖pipe方法自动管理响应结束。
• 在推送完数据后，调用stream.push(null)标记Readable Stream结束，确保流能正常触发end事件。

修正后的代码 #

@Post('/pipe-into-response')
pipeIntoResponse(@Body() payload, @Res() response: Response) {
    const stream = new Readable();
    stream.push('Hello World');
    stream.push(null); // 标记流结束
    stream.pipe(response);
}

如果需要更规范的Readable Stream创建方式，可以实现read方法：

@Post('/pipe-into-response')
pipeIntoResponse(@Body() payload, @Res() response: Response) {
    const stream = new Readable({
        read() {
            this.push('Hello World');
            this.push(null); // 推送结束信号
        }
    });
    stream.pipe(response);
}

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