ExpressoTS 框架中的 E2E 测试与 HTTP 服务器管理实践

在 ExpressoTS 框架的 3.0.0 版本中，开发团队对 E2E 测试和 HTTP 服务器管理进行了重要改进。这些变化特别针对 Jest 测试环境下 HTTP 服务器无法正常关闭的问题提供了解决方案。

问题背景

在早期版本的 ExpressoTS 中，开发者在进行端到端测试时会遇到一个常见问题：测试完成后 HTTP 服务器无法正常关闭，导致 Jest 测试进程无法自动终止。这主要是因为框架没有为异步关闭操作提供适当的支持，而且返回的 HTTP 服务器对象缺少必要的关闭方法。

解决方案

ExpressoTS 3.0.0 版本引入了几个关键改进：

1. 新增 close() 方法：现在可以通过 appInstance.close() 显式关闭 HTTP 服务器
2. 随机端口支持：listen(0) 现在可以正确绑定到随机可用端口
3. 类型安全改进：所有生命周期钩子方法现在都明确要求返回 Promise

最佳实践示例

以下是推荐的 E2E 测试实现方式：

import { AppFactory, StatusCode } from "@expressots/core";
import { IWebServerBuilder } from "@expressots/shared";
import { Server } from "http";
import request from "supertest";

describe("AppController", () => {
    let server: Server;
    let webServerBuilder: IWebServerBuilder;

    beforeAll(async () => {
        webServerBuilder = await AppFactory.create(App);
        const app = await webServerBuilder.listen(0); // 使用随机端口
        server = await app.getHttpServer();
    });

    afterAll(async () => {
        await server.close(); // 显式关闭服务器
    });

    it("测试端点响应", async () => {
        return request(server)
            .get("/api")
            .expect(StatusCode.OK);
    });
});

迁移注意事项

从 2.x 升级到 3.0.0 版本时，开发者需要注意：

1. 所有应用生命周期方法现在必须声明为 async 并返回 Promise
2. 需要更新相关依赖版本
3. 开发环境需要安装 tsx 作为开发依赖
4. 配置文件格式有所变化

技术实现细节

新版本在底层做了以下改进：

1. 引入了 IHttpServer 接口规范服务器操作
2. 改进了端口分配逻辑，支持随机端口绑定
3. 增强了类型安全性，避免潜在的异步问题
4. 提供了更清晰的错误提示和文档说明

这些改进使得 ExpressoTS 在测试场景下的表现更加可靠，同时也为开发者提供了更灵活的控制能力。通过合理的服务器管理和生命周期控制，现在可以确保测试环境能够正确初始化和清理，避免资源泄漏和测试干扰。