如何使用Jest对TypeORM的Repository链式方法进行Mock?
针对TypeORM QueryBuilder链式调用的Jest Mock方案
针对你提到的链式调用Mock成本高、无法访问Mock方法的问题,以下是两种可直接落地的实现方案:
方案1:通用链式Mock工厂(推荐,无需为不同查询单独定义)
该方案不需要关心业务代码中QueryBuilder的调用顺序,一次定义即可适配所有查询场景:
- 所有中间查询方法(
select/where/leftJoin等)统一使用mockReturnThis()返回自身实例,天然支持任意顺序的链式调用 - 仅需要单独Mock你需要拿到返回值的终止方法(如
getManyAndCount/getOne等)
示例代码:
// 全局通用的QueryBuilder Mock对象,可复用在所有测试文件 const mockQueryBuilder = { // 中间方法统一返回自身,支持任意链式调用 select: jest.fn().mockReturnThis(), where: jest.fn().mockReturnThis(), andWhere: jest.fn().mockReturnThis(), leftJoin: jest.fn().mockReturnThis(), addSelect: jest.fn().mockReturnThis(), orderBy: jest.fn().mockReturnThis(), limit: jest.fn().mockReturnThis(), offset: jest.fn().mockReturnThis(), // 终止方法按需定义返回值 getManyAndCount: jest.fn().mockResolvedValue([[], 0]) } // Mock对应Repository的createQueryBuilder方法,固定返回上述Mock对象 jest.spyOn(someRepository, 'createQueryBuilder').mockReturnValue(mockQueryBuilder)
使用时可在单测中按需修改终止方法的返回值:
// 单测用例内自定义返回值 mockQueryBuilder.getManyAndCount.mockResolvedValue([mockDataList, 10])
方案2:逐层Mock(适用于需要校验调用参数/顺序的场景)
你之前无法访问到Mock的select方法,核心原因是每次调用someRepository.createQueryBuilder()都会返回一个新的对象,两次调用拿到的引用不同,自然无法匹配到对应的Mock方法,解决方法是预先定义固定的Mock对象引用:
示例代码:
// 预先定义固定的QueryBuilder Mock实例 const mockQb = { select: jest.fn(() => { console.log('hi') // 需要支持后续链式调用的话,返回包含对应方法的对象即可 return { getManyAndCount: jest.fn().mockResolvedValue([[], 0]) } }) } // 让createQueryBuilder永远返回同一个Mock实例 jest.spyOn(someRepository, 'createQueryBuilder').mockReturnValue(mockQb) // 此时即可正常访问到Mock的select方法 someRepository.createQueryBuilder().select() // 正常打印hi
该方案适合需要对调用行为做断言的场景,比如校验select是否传入了指定字段:
expect(mockQb.select).toHaveBeenCalledWith('id', 'name', 'createTime')
内容的提问来源于stack exchange,提问作者Sardorkhuja Tukhtakhodjaev
相关产品推荐
相关产品推荐

