Jest测试中使用spawn传递环境变量：代码问题排查

存在的问题 #

• 主进程环境变量污染：直接修改process.env会污染Jest主进程的环境，所有后续运行的测试用例都会继承这些变量，可能引发意料之外的测试失败。
• 不可靠的启动等待逻辑：硬编码8秒等待时间完全依赖主观判断，CI环境资源波动大，可能出现服务器还没启动完成就执行测试（导致请求失败），或者服务器早已启动却白白浪费等待时间的情况。
• 缺乏子进程错误处理：没有监听子进程的error事件和stderr输出，一旦服务器启动失败（比如端口被占用、依赖缺失），测试只会超时，无法快速定位问题原因。
• 环境变量传递不明确：spawn默认会继承父进程的全部环境变量，但这里只需要传递指定的几个变量，既冗余又可能引入主进程中其他无关的环境变量，增加测试不确定性。

修正后的代码示例 #

import { spawn, ChildProcess } from 'child_process';
import axios from 'axios';

describe('STARTUP: test', () => {
  let app: ChildProcess;
  const url = 'http://0.0.0.0:3000/';
  // 只定义当前测试需要的环境变量
  const testEnv = {
    ...process.env, // 可选：继承主进程必要的基础env，比如PATH
    HOST: 'localhost',
    DATABASE: 'my_db',
    USERNAME: 'my_admin',
    PASSWORD: 'my_passwd123'
  };

  beforeAll(async () => {
    return new Promise((resolve, reject) => {
      // 显式传递环境变量给子进程
      app = spawn('node', ['index.js'], { env: testEnv });

      // 监听子进程标准输出，判断服务器是否启动完成
      app.stdout.on('data', (data) => {
        const output = data.toString();
        console.log(`Server output: ${output}`);
        // 假设服务器启动成功会打印类似 "Server running on http://0.0.0.0:3000" 的日志
        if (output.includes('Server running on')) {
          resolve(true);
        }
      });

      // 监听子进程错误和标准错误输出
      app.stderr.on('data', (data) => {
        console.error(`Server error: ${data.toString()}`);
      });

      app.on('error', (err) => {
        reject(new Error(`Failed to start server: ${err.message}`));
      });

      // 子进程意外退出的处理
      app.on('exit', (code) => {
        if (code !== null && code !== 0) {
          reject(new Error(`Server exited with code ${code}`));
        }
      });
    });
  });

  afterAll(() => {
    app?.kill();
  });

  it('should return when calling /health', async () => {
    const response = await axios.get(url);
    expect(response.status).toBe(200);
  });
});

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