Middy.js中ws-response中间件的API Gateway响应格式问题解析

在WebSocket API开发中，Middy.js作为Node.js中间件框架，提供了便捷的ws-response中间件来处理WebSocket响应。然而，近期发现该中间件在与AWS API Gateway集成时存在一个关键性的响应格式问题，会导致客户端收到意外的"Internal server error"错误。

问题现象

当开发者使用Middy的ws-response中间件时，即使Lambda函数正常返回了数据（如{ Data: 'Hello' }），客户端仍然会收到两条消息：

1. 预期的数据消息（如"Hello"）
2. 错误消息{"message": "Internal server error"...}

根本原因分析

深入ws-response中间件源码后发现，问题出在中间件对响应对象的处理方式上。当前实现会在响应对象上直接添加statusCode属性：

request.response.statusCode = 200

这导致最终传递给API Gateway的响应对象结构为：

{
  "ConnectionId": "ZmDx-dJ4FiACFkQ=",
  "Data": "\"Hello\"",
  "statusCode": 200
}

而实际上，API Gateway WebSocket接口期望的响应格式应该是：

{
  "statusCode": 200
}

解决方案

正确的修复方式是重构响应对象的创建方式，确保返回给API Gateway的对象仅包含statusCode字段：

request.response = {
  statusCode: 200
}

这种修改后，API Gateway能正确识别操作状态，同时Lambda返回的有效载荷仍能正常传递给客户端。

技术背景

理解这个问题需要了解AWS API Gateway WebSocket接口的工作机制：

1. Lambda函数通过返回特定格式的响应来告知API Gateway操作状态
2. statusCode字段用于指示操作是否成功（200表示成功）
3. 其他字段（如Data）应通过独立的WebSocket消息发送给客户端
4. 混合格式会导致API Gateway解析失败，从而触发内部错误

最佳实践建议

1. 响应分离原则：保持状态响应和业务数据的分离
2. 中间件配置：确保ws-response中间件是处理链中的最后一个中间件
3. 错误处理：对于错误情况，同样需要返回纯净的statusCode对象
4. 测试验证：部署前使用WebSocket客户端工具验证完整消息流

影响范围

该问题影响所有使用Middy.js ws-response中间件与API Gateway WebSocket集成的应用，特别是在需要返回业务数据的情况下。及时应用修复可以避免客户端收到混淆的错误信息，提升用户体验。

通过理解这个问题的本质和解决方案，开发者可以更好地构建稳定可靠的WebSocket服务架构。