FauxRPC项目中google.protobuf.Duration类型的处理问题分析

FauxRPC项目中google.protobuf.Duration类型的处理问题分析

在FauxRPC项目中，当使用protobuf的Duration类型时，自动生成的OpenAPI文档中会出现格式错误的问题。这个问题在模拟Google Cloud Run v2服务时被发现，具体表现为自动生成的示例代码中将Duration字段错误地填充为"/regex/"的正则表达式格式，而实际上应该使用如"15s"这样的标准Duration格式。

问题现象

在FauxRPC生成的OpenAPI文档中，对于包含google.protobuf.Duration类型的字段，自动生成的示例代码会错误地将其表示为"/regex/"的正则表达式格式。例如，在Cloud Run v2服务的RevisionTemplate消息中，timeout字段被错误地生成为：

"timeout": "/regex/"

而实际上，这个字段应该遵循protobuf Duration的标准格式，如"15s"表示15秒。当用户按照自动生成的错误示例发送请求时，会收到格式验证错误的响应。

问题复现

为了更清晰地展示这个问题，我们创建了一个简单的测试proto文件：

syntax = "proto3";

import "google/protobuf/duration.proto";
import "google/protobuf/empty.proto";

service Service {
    rpc Method(MethodRequest) returns (google.protobuf.Empty);
}

message MethodRequest {
    google.protobuf.Duration timeout = 1;
}

使用protoc编译后，通过FauxRPC运行服务并查看生成的OpenAPI文档，会发现timeout字段的示例值被错误地设置为"/regex/"。

正确与错误请求对比

当使用错误的"/regex/"格式发送请求时：

curl --request POST \
  --url http://127.0.0.1:6660/Service/Method \
  --data '{"timeout": "/regex/"}'

服务会返回错误响应：

{"code":"unknown","message":"proto: (line 2:14): invalid google.protobuf.Duration value \"/regex/\""}

而使用正确的Duration格式如"15s"时：

curl --request POST \
  --url http://127.0.0.1:6660/Service/Method \
  --data '{"timeout": "15s"}'

服务会正确处理并返回成功响应：

{}

问题分析

这个问题源于FauxRPC在生成OpenAPI文档时，对protobuf Duration类型的处理不够完善。Duration类型在protobuf中有特定的字符串表示格式，应该被序列化为符合Duration规范的字符串，而不是正则表达式。

正确的Duration格式应该遵循以下规则：

• 必须包含数字和单位后缀
• 支持的单位包括：s(秒)、m(分钟)、h(小时)
• 例如："300s"、"5m"、"1h"都是合法的Duration值

解决方案建议

对于FauxRPC项目，建议在生成OpenAPI文档时：

1. 识别出google.protobuf.Duration类型的字段
2. 为这些字段生成符合Duration规范的示例值，如"15s"、"1m"等
3. 在文档中明确说明Duration字段的格式要求
4. 可以考虑在请求验证阶段增加对Duration格式的严格检查

总结

这个问题虽然看起来不大，但对于使用FauxRPC作为API模拟工具的用户来说，可能会造成一定的困惑。正确的Duration格式处理对于确保API文档的准确性和可用性非常重要。希望FauxRPC能在后续版本中修复这个问题，为用户提供更准确的API文档生成功能。