Jest测试未因错误失败求助：TypeScript库测试异常排查

这个问题我之前也碰到过，核心原因是你用了异步的文件读取API，导致错误抛出的时候测试流程已经跑完了，Jest根本没机会捕获到这个错误。我来给你拆解原因和具体的解决办法：

问题根源 #

你使用的readFile是Node.js的异步API，它的回调函数会在当前事件循环结束后才执行。而populateTasks是同步函数，会直接返回空的tasks数组，测试函数也会立刻执行完毕。等回调里抛出错误时，Jest的测试流程已经结束了，自然不会把这个错误判定为测试失败，就出现了控制台打印错误但测试仍通过的“假通过”情况。

解决方案1：改用同步文件读取（适合简单场景） #

如果你的业务场景允许同步读取文件，可以直接用readFileSync，这样错误会同步抛出，Jest就能正常捕获：

修改后的业务代码：

import { readFileSync } from 'fs';

// 先补上Task的类型定义
export interface Task {
  // 根据你的业务补充字段
}

export function populateTasks(inputFilePath: string): Task[] {
  if (!inputFilePath) {
    throw new Error("Input file path is null: " + inputFilePath);
  }
  const tasks: Task[] = [];
  try {
    const data = readFileSync(inputFilePath);
    handleInputFile(null, data);
    // 这里添加data转tasks的逻辑
  } catch (err) {
    handleInputFile(err, null);
  }
  return tasks;
}

function handleInputFile(err: any, data: any): void {
  if (err) {
    console.log("File not found");
    throw new Error("File not found: " + err);
  }
  console.log(data.toString());
}

对应的测试代码：

import { populateTasks } from './your-file-name';

describe("test", () => {
  test("should throw error when file path is invalid", () => {
    expect(() => populateTasks("tasks")).toThrow("File not found");
  });
});

解决方案2：用Promise包装异步操作（更推荐异步场景） #

如果必须保留异步读取逻辑，建议把populateTasks改成返回Promise，让Jest可以等待异步操作完成再判断结果：

修改后的业务代码：

import { readFile } from 'fs/promises'; // 使用Promise版本的readFile

export interface Task {
  // 类型定义
}

export async function populateTasks(inputFilePath: string): Promise<Task[]> {
  if (!inputFilePath) {
    throw new Error("Input file path is null: " + inputFilePath);
  }
  const tasks: Task[] = [];
  try {
    const data = await readFile(inputFilePath);
    console.log(data.toString());
    // 添加data转tasks的逻辑
  } catch (err) {
    console.log("File not found");
    throw new Error("File not found: " + err);
  }
  return tasks;
}

对应的测试代码：

import { populateTasks } from './your-file-name';

describe("test", () => {
  test("should throw error when file path is invalid", async () => {
    await expect(populateTasks("tasks")).rejects.toThrow("File not found");
  });
});

额外提示：回调式API的兼容方案 #

如果坚持要用回调版的readFile，可以给测试函数加done参数，监听未捕获错误，但这种写法需要注意清理事件监听，避免影响其他测试：

测试代码示例：

describe("test", () => {
  test("should throw error when file path is invalid", (done) => {
    const errorHandler = (err: Error) => {
      expect(err.message).toContain("File not found");
      process.off('uncaughtException', errorHandler); // 清理监听
      done();
    };
    process.on('uncaughtException', errorHandler);
    populateTasks("tasks");
  });
});

不过这种方式比较繁琐，还是更推荐前两种方案。

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