问题场景 #

测试NestJS服务时遇到覆盖率异常：Jest将AppService构造函数里的逗号和大括号标记为未覆盖分支，导致分支覆盖率仅83.87%，但实际业务逻辑已实现100%覆盖。执行npm test后，覆盖率报告明确指出构造函数的大括号属于未覆盖分支。

可复现的示例代码如下：

app.module.ts #

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { CacheModule } from '@nestjs/cache-manager';

@Module({
  imports: [
    CacheModule.register({
      isGlobal: true,
      ttl: 60_000,
      max: 100,
    }),
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

app.service.ts #

import { CACHE_MANAGER, Cache } from '@nestjs/cache-manager';
import { Inject, Injectable } from '@nestjs/common';

@Injectable()
export class AppService {
  constructor(@Inject(CACHE_MANAGER) private readonly cache: Cache) {}

  getHello(): any {
    return this.cache.get('cache:helloWorld');
  }
}

app.service.spec.ts #

import { CACHE_MANAGER } from '@nestjs/cache-manager';
import { Test, TestingModule } from '@nestjs/testing';

import { AppController } from './app.controller';
import { AppService } from './app.service';

describe('AppController', () => {
  let appController: AppController;

  const cacheMock = {
    get: jest.fn(),
  };

  beforeEach(async () => {
    const app: TestingModule = await Test.createTestingModule({
      controllers: [AppController],
      providers: [
        AppService,
        {
          provide: CACHE_MANAGER,
          useValue: cacheMock,
        },
      ],
    }).compile();

    appController = app.get<AppController>(AppController);
  });

  describe('root', () => {
    it('should return "Hello World!"', () => {
      cacheMock.get.mockResolvedValue('Hello World!');

      expect(appController.getHello()).toBe('Hello World!');
    });
  });
});

原因分析 #

这是Jest配合TypeScript编译的常见问题：TypeScript装饰器（如@Inject、@Injectable）编译后会生成额外分支逻辑，Jest覆盖率工具会将这些框架生成的非业务代码分支判定为未覆盖路径，但实际上这类分支不需要手动测试覆盖。

解决方法 #

方法一：调整Jest配置，过滤框架代码干扰 #

在jest.config.js中使用V8覆盖率提供者，并精准配置覆盖率收集规则，排除非业务代码：

module.exports = {
  // 其他已有配置...
  coverageProvider: 'v8',
  collectCoverageFrom: [
    'src/**/*.ts',
    '!src/**/*.module.ts', // 可选：排除模块定义文件
    '!src/main.ts' // 可选：排除应用入口文件
  ],
  coveragePathIgnorePatterns: [
    'node_modules/',
    '.d.ts'
  ]
};

V8覆盖率提供者对TypeScript编译后的代码分析更精准，能有效减少这类误报。

方法二：直接测试构造函数实例化 #

在测试用例中手动实例化AppService，明确覆盖构造函数路径：

// 在app.service.spec.ts的describe块中添加测试用例
it('should initialize AppService correctly', () => {
  const service = new AppService(cacheMock);
  expect(service).toBeInstanceOf(AppService);
});

直接调用构造函数会让Jest识别到该路径已被覆盖，消除未覆盖分支标记。

方法三：用注释忽略特定行（不推荐） #

若不想修改配置或测试代码，可在构造函数对应位置添加注释，告知覆盖率工具忽略该行：

constructor(@Inject(CACHE_MANAGER) private readonly cache: Cache /* istanbul ignore next */) {}

此方法属于临时hack，不建议大规模使用，会降低代码可读性。

内容的提问来源于stack exchange，提问作者João Sarmento