如何测试基于TypeScript构建、含线程的Node.js应用？

一、线程代码组织与测试问题修正 #

不用纠结必须单独写线程文件，但Node.js确实不支持直接传递函数给worker_threads的Worker构造函数——它只能接受文件路径或DataURL，没法直接序列化函数。

解决.ts线程文件测试无编译产物的问题 #

用ts-jest测试时，无需提前编译线程文件，直接利用ts-jest的能力让Node.js识别.ts线程文件：

• 在jest配置中添加ts-node/register钩子，让Worker能直接加载.ts文件：

// jest.config.js
module.exports = {
  // 其他配置项...
  setupFilesAfterEnv: ['./jest.setup.ts'],
};

// jest.setup.ts
import { Worker } from 'worker_threads';
import { register } from 'ts-node';

// 注册ts-node，适配Worker的CommonJS模块要求
register({
  transpileOnly: true,
  compilerOptions: {
    module: 'commonjs',
  },
});

• 主进程封装的calcHash函数直接引用.ts线程文件：

// src/calcHash.ts
import { Worker } from 'worker_threads';

export const calcHash = (text: string): Promise<string> => {
  return new Promise((resolve, reject) => {
    const worker = new Worker('./src/threads/hash.thread.ts', {
      workerData: { text },
    });
    worker.on('message', resolve);
    worker.on('error', reject);
    worker.on('exit', (code) => {
      if (code !== 0) reject(new Error(`线程退出码: ${code}`));
    });
  });
};

• 线程文件专注纯逻辑处理，只负责计算和消息通信：

// src/threads/hash.thread.ts
import { parentPort, workerData } from 'worker_threads';
import { createHash } from 'crypto';

if (!parentPort) throw new Error('必须在Worker线程环境中运行');

const { text } = workerData;
const hash = createHash('sha256').update(text).digest('hex');
parentPort.postMessage(hash);

二、分层测试策略 #

1. 单元测试：单独验证核心计算逻辑 #

把哈希计算的核心逻辑抽离成独立函数，脱离线程API直接测试：

// src/utils/hashUtils.ts
import { createHash } from 'crypto';

export const computeHash = (text: string): string => {
  return createHash('sha256').update(text).digest('hex');
};

// tests/utils/hashUtils.test.ts
import { computeHash } from '../../src/utils/hashUtils';

test('SHA256哈希计算结果正确', () => {
  expect(computeHash('test')).toBe('9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08');
});

2. 集成测试：验证线程封装逻辑 #

直接测试calcHash函数，验证线程通信流程和结果正确性：

// tests/calcHash.test.ts
import { calcHash } from '../../src/calcHash';

test('通过线程计算哈希结果正确', async () => {
  const result = await calcHash('test');
  expect(result).toBe('9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08');
});

3. 测试注意事项 #

• 测试结束后调用worker.terminate()清理线程，避免资源泄漏
• 若线程逻辑依赖环境变量或配置，提前在jest.setup.ts中初始化

三、简化方案：用piscina管理线程 #

如果觉得手动编写Worker逻辑繁琐，可以用piscina库，它支持直接传递函数（内部自动序列化并创建线程），同时兼容TypeScript和jest：

// src/calcHash.ts
import Piscina from 'piscina';

const piscina = new Piscina({
  filename: './src/threads/hash.thread.ts',
});

export const calcHash = (text: string): Promise<string> => {
  return piscina.run(text);
};

线程文件改为导出处理函数：

// src/threads/hash.thread.ts
import { createHash } from 'crypto';

export default async (text: string): Promise<string> => {
  return createHash('sha256').update(text).digest('hex');
};

测试方式与之前一致，piscina会自动处理线程的创建与销毁。

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