如何在NestJS中用Jest模拟Mongoose lean()查询并解决类型冲突
NestJS 下 Mongoose Repository 单测 lean() 链式调用的类型冲突解决方案
问题本质
当前出现的TS类型不匹配,核心诱因来自两点:
- Mongoose 原生
Model、Query类型设计了多层嵌套的复杂泛型体系,手写的裸链式Mock对象完全无法对齐这套严格的泛型约束。尤其是lean()方法的返回结果带有一个可被任意推导的泛型参数P,TS会判定P可能是任意类型,你传入的PersonModel文档实例自然无法满足这个泛型要求 - 测试逻辑和真实运行行为存在偏差:
.lean()的核心作用就是把Mongoose文档转换为不带任何实例方法的纯JS对象,而Mock逻辑里让lean返回Mongoose文档实例,本身就和实际运行逻辑不符,进一步触发了类型校验拦截
可落地的解决方法
1. 简化测试场景的类型定义,不硬套原生Mongoose的复杂类型
原生Model<PersonModel>类型覆盖了几十上百个Mongoose原生方法、嵌套的链式签名,单测场景下根本不需要对齐这套完整类型,你可以单独为测试场景定义简化的模型接口,只覆盖实际用到的方法:
// 测试专用的简化模型类型,完全匹配实际用到的方法签名 type TestablePersonModel = { find: jest.Mock; findOne: jest.Mock; findOneAndUpdate: jest.Mock; updateOne: jest.Mock; } // 取模块实例时直接使用自定义的简化类型,绕开原生类型的严格约束 let MockPersonModel: TestablePersonModel; beforeEach(async () => { const mockModule: TestingModule = await Test.createTestingModule({ providers: [ ..., { provide: getModelToken(Person.name), useValue: modelMockObject, }, ], }).compile(); MockPersonModel = mockModule.get<TestablePersonModel>(getModelToken(Person.name)); });
这种方式下,你写的任何链式Mock返回值都不会被TS严格校验复杂的泛型签名,因为自定义类型根本没有绑定那套复杂的泛型规则。
2. 封装通用的链式调用Mock工厂,提前对齐方法签名
不需要每次在测试用例里手写findOne -> lean -> exec的三层链式结构,提前封装一个通用的Query创建方法,一次性把所有常用链式方法的Mock逻辑写好:
// 通用的链式Query Mock工厂,接收需要返回的测试数据,自动构建完整的链式结构 const createMockQuery = <T>(returnData: T) => ({ lean: jest.fn().mockResolvedValue(returnData), exec: jest.fn().mockResolvedValue(returnData), // 用到sort/skip/limit等其他链式方法时,直接在这里补全即可 }); // 初始化模型Mock时直接绑定工厂方法,不用每次测试单独搭链式结构 const modelMockObject = { find: jest.fn(() => createMockQuery(null)), findOne: jest.fn(() => createMockQuery(null)), findOneAndUpdate: jest.fn(() => createMockQuery(null)), updateOne: jest.fn(() => createMockQuery(null)), };
测试用例里只需要在spyOn的时候给工厂方法传入对应的测试数据即可:
// 注意:lean的返回值是纯JS对象,不是Mongoose文档实例,要对齐真实运行行为 const testPersonData = { name: 'etc' }; jest.spyOn(MockPersonModel, 'findOne').mockReturnValueOnce(createMockQuery(testPersonData));
3. 必要时用类型断言对齐复杂的原生类型校验
如果你确实需要保留原生Model的类型校验,不想自定义简化类型,可以在写Mock返回值的时候通过类型断言绕开泛型校验的冲突,不建议直接用裸any,可以通过unknown做中转让断言更可控:
import { Query } from 'mongoose'; jest.spyOn(MockPersonModel, 'findOne').mockReturnValueOnce( { // lean的返回值是纯JS对象,不是文档实例 lean: () => ({ exec: async () => ({ name: 'etc' }) }), } as unknown as Query<PersonModel | null, PersonModel> );
这种方式既保留了大部分原生类型的校验能力,又不会因为手写Mock的结构简单被TS拦截。
常见避坑提示
- 不要在
.lean()的Mock返回值里放new Person(...)这类Mongoose文档实例,lean的真实返回值是无方法的纯对象,放文档实例不仅会触发类型错误,也会让测试逻辑和真实运行行为不一致 - 不要把所有链式逻辑都写在单个测试用例里,提前封装工厂方法可以减少90%的重复代码和类型错误
- 单测的Mock不需要对齐Mongoose的所有原生能力,只需要对齐你实际业务逻辑用到的方法即可,过度追求类型完全匹配只会增加不必要的测试成本
内容的提问来源于stack exchange,提问作者Manuel Carballido
相关产品推荐
相关产品推荐

