ts-rest项目中使用Serverless路由时扩展Request对象的正确方式

在基于ts-rest构建Serverless应用时，开发者经常需要扩展请求对象(Request)来添加自定义属性。本文深入分析如何正确地在ts-rest的serverless路由中扩展Request对象，避免类型错误。

问题背景

当使用ts-rest的serverless模块时，开发者可能会遇到以下两种常见场景：

1. 尝试通过泛型参数扩展Request对象时，路由处理器类型意外变为never
2. 不指定泛型时，无法访问自定义添加的Request属性

错误示范分析

以下是开发者容易犯的两种典型错误：

// 错误示例1：仅指定Request扩展类型
const router1 = tsr.router<{ testId: string }>(contract, {
  endpoint: () => {...} // 类型变为never
});

// 错误示例2：不指定泛型
const router2 = tsr.router(contract, {
  endpoint: ({ request }) => {
    const { testId } = request; // 类型错误，testId不存在
  }
});

正确解决方案

正确的做法是同时指定Request扩展类型和合约类型：

const router = tsr.router<{ testId: string }, typeof contract>(contract, {
  endpoint: ({ request }) => {
    const { testId } = request; // 正确推断类型
    return {...};
  }
});

新路由构建器方案

ts-rest还提供了更现代化的路由构建器API，它提供了更简洁的方式来扩展Request对象：

const router = tsr.router(contract).build({
  endpoint: {
    middleware: [addTestIdMiddleware], // 添加中间件
    handler: ({ request }) => {
      const { testId } = request; // 自动推断类型
      return {...};
    }
  }
});

这种新API通过中间件机制更自然地实现了Request对象的扩展，同时保持了类型安全。

最佳实践建议

1. 对于简单场景，使用双泛型参数的方式
2. 对于复杂应用，推荐使用新的路由构建器API
3. 自定义属性应通过中间件添加，保持代码整洁
4. 始终确保类型定义与实际运行时行为一致

通过遵循这些模式，开发者可以充分利用ts-rest的类型系统，构建出既安全又灵活的Serverless API。