TS2339报错:TypeScript中Mock SQS Queue.sendMessage()时提示类型无mock属性
SQS sendMessage 单元测试Mock的类型报错修复方案
报错核心原因
当TS抛出TS2339: Property 'mock' does not exist on type '(type: string) => Promise '时,本质是两个问题叠加:
- 类型层面:手动将原生的
queue.sendMessage赋值为jest.fn()后,TypeScript 仍然保留了这个方法原本的原生函数类型定义,没有识别到它已经被替换为带mock属性的Jest Mock实例,因此访问mock属性时触发类型校验失败。 - 逻辑层面:当前测试代码的执行顺序完全颠倒——先修改Mock、再立刻断言调用次数,全程没有触发被测系统里
pushJobIntoQueue的实际执行,哪怕修好了类型问题,断言结果也永远不会符合预期。
可落地的调整方案
方案1(推荐):从依赖注入层整体Mock SqsService
不要在测试模块里导入真实的SqsService,从根上隔离外部依赖,同时完全规避类型不匹配问题:
- 在测试模块初始化阶段,直接提供
SqsService的Mock实现,替换真实的服务实例:
// 提前定义全局可访问的Mock函数,方便后续断言 const mockSendMessage = jest.fn().mockResolvedValue({ MessageId: 'test-mq-id' }); // 测试模块配置 const module: TestingModule = await Test.createTestingModule({ providers: [ NetworkService, // 其他业务依赖的Repository Mock { provide: SqsService, useValue: { // 匹配SqsService的initQueue接口,返回携带Mock sendMessage的队列对象 initQueue: jest.fn().mockReturnValue({ sendMessage: mockSendMessage, }) } } ] }).compile();
- 修正测试执行顺序,先触发被测逻辑再做断言:
it('should put every network into queue', async () => { // 准备测试数据 const networks = Array(20).fill(networkDataBuilder()); const expectedCallCount = networks.length; // 清空之前测试遗留的Mock调用记录,避免干扰断言结果 mockSendMessage.mockClear(); // 调用NetworkService中会触发pushJobIntoQueue执行的公开入口方法 await service.batchProcessNetworks(networks); // 验证断言 expect(mockSendMessage).toHaveBeenCalledTimes(expectedCallCount); // 可额外校验入参是否符合业务约定 networks.forEach(network => { expect(mockSendMessage).toHaveBeenCalledWith( JSON.stringify({ type: 'calculInteractions', networkId: network.id, isInteractionsShared: true, }) ); }); });
方案2(临时绕过):运行时修改实例方法时加类型断言
如果不想替换整个SqsService,坚持在拿到真实实例后手动修改sendMessage,就需要手动通过类型断言告诉TS当前方法的实际类型,绕过原生类型校验:
const queue = sqsService.initQueue('cm-contact-interactions'); // 替换原生sendMessage为Mock,并做类型断言 (queue.sendMessage as jest.Mock) = jest.fn(); // 访问mock属性时同样需要带上类型断言,才不会触发TS报错 expect((queue.sendMessage as jest.Mock).mock.calls.length).toBe(expectedCallCount);
注意:这种方式属于临时绕过校验,测试过程中可能残留真实SQS服务的隐式行为,不建议在生产测试代码中长期使用。
内容的提问来源于stack exchange,提问作者A Mehmeto
相关产品推荐
相关产品推荐

