Node.js 16下SuperTest Headers失效但Node.js 14正常的问题求助

我的依赖版本：supertest: 6.2.4、nock: 13.2.9、express: 4.17.1。测试代码在Node.js v14环境运行正常，但切换到v16后，SuperTest设置的Headers功能失效。相关测试代码如下：

describe('when request has xid headers', () => {
  beforeEach(() => {
    app = express();
    nock('http://localhost', {
      reqheaders: {
        xid: 'xid-test',
      },
    })
    .get('/').reply(200, {});
  });
  it('should have the correct header in the downstream call', (done)=>{
    app.get('/user', (req, res)=>{
      request = {};
      service.get({
        url: '/',
        name: 'fetch something',
        request
      }).then((value => {
        expect(value).toEqual('test');
        done();
      }));
      supertest(app)
      .get('/user')
      .set('xid', 'xid-test')
      .expect(200)
      .end((err, res) => {
        if(err) throw err;
      });
    })
  })
});

可能的原因分析 #

• Node.js v16 HTTP模块行为变更：Node.js v16对HTTP请求头的处理逻辑做了调整，比如头信息大小写的标准化规则更严格。SuperTest 6.2.4可能未完全适配这些变更，导致设置的头无法正确传递到下游请求。

• Nock与Node.js v16的兼容性问题：Nock 13.2.9在Node.js v16下的请求头匹配逻辑可能存在bug，比如它期望的xid头是小写格式，但实际传递的头可能被Node.js标准化为首字母大写（Xid），导致匹配失败，看起来像是SuperTest的头未生效。

• 测试代码逻辑缺陷：你的测试代码存在几个潜在问题，在Node.js v14未暴露，但v16下触发了异常：

  • request = {}是全局变量赋值，会导致上下文污染，下游请求无法正确继承头信息；
  • 在Express路由handler内部发起SuperTest请求，会造成递归调用，而且你没有把SuperTest设置的xid头从当前请求req中取出并传递给service.get，这个逻辑本身就存在问题——正确的做法是从req.headers.xid获取头，再传给下游服务，而非直接复用SuperTest设置的值。

• SuperTest版本适配不足：SuperTest 6.2.4发布于2022年，虽支持Node.js v16，但可能存在未覆盖的兼容场景，部分头传递逻辑在v16下失效。

验证与修复建议 #

1. 修复测试代码逻辑：调整路由handler，从当前请求中获取头信息并传递给下游服务，同时将SuperTest请求移出路由handler：

it('should have the correct header in the downstream call', (done)=>{
  app.get('/user', (req, res)=>{
    // 从当前请求获取xid头
    const request = { headers: { xid: req.headers.xid } };
    service.get({
      url: '/',
      name: 'fetch something',
      request
    }).then((value => {
      expect(value).toEqual('test');
      res.sendStatus(200);
      done();
    })).catch(err => done(err)); // 捕获错误避免测试挂起
  });

  supertest(app)
  .get('/user')
  .set('xid', 'xid-test')
  .expect(200)
  .end((err, res) => {
    if(err) done(err);
  });
});

2. 调整Nock头匹配规则：使用函数匹配方式，避免大小写敏感问题：

nock('http://localhost', {
  reqheaders: {
    xid: (value) => value.toLowerCase() === 'xid-test'
  },
})
.get('/').reply(200, {});

3. 升级依赖版本：尝试将SuperTest升级到v6.3.3（该版本修复了部分Node.js v16兼容问题），或Nock升级到最新v13.x版本，验证是否解决问题。

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