如何在Express路由中监视函数调用？Supertest测试求助

你遇到的这个问题其实很常见——当用Supertest测试Express路由时，默认只能断言HTTP响应，没法直接监视路由内部调用的函数。核心原因是路由内部的函数如果是局部定义或者直接引入的私有模块，Jest没法直接访问到它，得通过模块模拟或者依赖注入的方式来解决。下面给你两种最常用的方案：

方案一：模拟邮件发送模块（推荐） #

如果你的欢迎邮件发送逻辑是抽成单独模块的（比如mailer.js），那用Jest的jest.mock来模拟整个模块是最简洁的方式：

1. 先整理你的邮件模块 #

假设你的mailer.js是这样的：

// mailer.js
exports.sendWelcomeEmail = async (userEmail) => {
  // 这里是调用邮件服务商API的逻辑，比如Nodemailer/SendGrid
};

2. 路由文件里正常引入使用 #

// routes/auth.js
const express = require('express');
const { sendWelcomeEmail } = require('../mailer');
const router = express.Router();

router.post('/register', async (req, res) => {
  // 1. 处理用户注册逻辑：创建用户、验证参数等
  const newUser = { email: req.body.email /* 其他用户信息 */ };
  
  // 2. 发送欢迎邮件
  await sendWelcomeEmail(newUser.email);
  
  // 3. 返回响应
  res.status(201).json({ message: '注册成功' });
});

module.exports = router;

3. 测试文件里模拟并监视 #

const request = require('supertest');
const app = require('../app');
// 引入邮件模块，Jest会自动使用我们的模拟版本
const { sendWelcomeEmail } = require('../mailer');

// 告诉Jest模拟整个mailer模块，所有导出的函数都会变成Jest模拟函数
jest.mock('../mailer');

describe('POST /auth/register', () => {
  beforeEach(() => {
    // 每个测试前清除模拟函数的调用记录，避免测试间互相影响
    sendWelcomeEmail.mockClear();
  });

  it('注册成功时应该调用sendWelcomeEmail并传入正确邮箱', async () => {
    const testEmail = 'test@example.com';

    // 用Supertest发送注册请求
    await request(app)
      .post('/auth/register')
      .send({ email: testEmail, password: '123456' })
      .expect(201);

    // 断言邮件函数被调用了一次，且参数正确
    expect(sendWelcomeEmail).toHaveBeenCalledTimes(1);
    expect(sendWelcomeEmail).toHaveBeenCalledWith(testEmail);
  });
});

方案二：暴露路由内部的函数 #

如果你的邮件发送逻辑是直接写在路由文件里的（不推荐，但如果暂时没法抽模块），可以把这个函数暴露出来，让Jest能通过jest.spyOn监视：

1. 修改路由文件，导出内部函数 #

// routes/auth.js
const express = require('express');
const router = express.Router();

// 把邮件函数导出，或者挂载到router对象上
exports.sendWelcomeEmail = async (userEmail) => {
  // 邮件发送逻辑
};

router.post('/register', async (req, res) => {
  const newUser = { email: req.body.email };
  // 调用导出的函数
  await exports.sendWelcomeEmail(newUser.email);
  res.status(201).json({ message: '注册成功' });
});

module.exports = router;

2. 测试文件里用spyOn监视 #

const request = require('supertest');
const app = require('../app');
const authRouter = require('../routes/auth');

describe('POST /auth/register', () => {
  it('注册成功时应该调用内部的sendWelcomeEmail', async () => {
    // 创建一个spy，替换原函数为模拟函数，同时保留原函数的引用
    const sendEmailSpy = jest.spyOn(authRouter, 'sendWelcomeEmail').mockResolvedValue();

    await request(app)
      .post('/auth/register')
      .send({ email: 'test@example.com', password: '123456' })
      .expect(201);

    expect(sendEmailSpy).toHaveBeenCalledTimes(1);
    expect(sendEmailSpy).toHaveBeenCalledWith('test@example.com');

    // 测试结束后恢复原函数，避免影响其他测试
    sendEmailSpy.mockRestore();
  });
});

关于你提到的test.only问题 #

之前用test.only时出现异常，改回全量测试后正常，大概率是因为单个测试时没有正确清除模拟函数的状态，而全量测试可能有beforeEach/afterEach钩子自动清理了mock的调用记录。所以不管用哪种方案，记得在每个测试前用mockClear()或者mockReset()重置模拟函数的状态。

另外要注意：测试时不要真的发送邮件（会浪费资源还可能触发服务商限制），我们只需要断言函数被正确调用即可——这也是模拟的意义所在。

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