GraphQL-Ruby 中字段随机消失问题的排查与解决

问题现象

在使用 GraphQL-Ruby 构建的 API 服务中，开发人员遇到了一个奇怪的现象：某个名为 pitLogs 的字段会随机性地从响应中消失，并返回"字段不存在"的错误。这个问题只在生产环境中出现，且具有以下特征：

1. 初始阶段 API 能正常返回包含 pitLogs 字段的响应
2. 经过一段时间后，部分请求开始返回"字段不存在"的错误
3. 最终所有节点都会开始返回错误
4. 重启应用后问题暂时解决，但会再次出现

技术背景

GraphQL-Ruby 是一个用于 Ruby 的 GraphQL 实现，它允许开发者定义类型系统和字段解析逻辑。在这个案例中，pitLogs 字段定义如下：

field :pit_logs, [Types::PitLogType], null: false, scope: false do
  argument :dates, [String], required: false, default_value: '[]'
end

这个字段接受一个可选的日期数组参数，返回一组 PIT 日志数据。

排查过程

初步分析

开发人员首先排除了以下可能性：

1. 可见性(visibility)问题：虽然使用了 GraphQL::Schema::AlwaysVisible，但确认没有自定义 visible? 方法
2. 文件加载问题：如果是加载问题，应该会一直失败而非随机失败
3. 持久化查询问题：graphql-persisted_queries 只缓存查询字符串，不影响结果

深入调查

通过进一步分析，发现以下关键线索：

1. 问题与应用程序服务器(Puma)无关，切换到 Passenger 后问题依旧
2. 在测试环境中无法复现，即使模拟生产环境配置
3. 文档查询结果也会变化，有时包含 pitLogs 字段，有时不包含

关键发现

最终发现问题源于代码中对 GraphQL 类型定义的意外修改：

"Types::InitiativeType".constantize.own_fields.except!("pitLogs")

这里使用了 except! 方法，它会直接修改原始哈希。在 Ruby 中，except! 是破坏性方法，会永久性地从哈希中移除指定键。

问题根源

GraphQL-Ruby 在内部使用哈希来存储字段定义。当应用程序代码调用 except! 方法时，它实际上修改了 GraphQL 类型的内部状态，导致字段定义被永久移除。这就是为什么：

1. 问题会随机出现：取决于哪个请求触发了修改代码路径
2. 重启能暂时解决问题：因为重新加载会重建所有类型定义
3. 生产环境更易出现：可能有更多并发请求触发修改

解决方案

正确的做法是使用非破坏性的 except 方法：

"Types::InitiativeType".constantize.own_fields.except("pitLogs")

这样会返回一个新的哈希，而不会修改原始的类型定义。

经验总结

1. 注意破坏性方法：在 Ruby 中，以 ! 结尾的方法通常是破坏性的，会修改接收者对象
2. 避免修改框架内部状态：GraphQL-Ruby 的类型定义是全局状态，修改它们会影响所有请求
3. 生产环境问题排查：难以复现的问题往往与状态修改或并发有关
4. 文档查询作为诊断工具：GraphQL 的文档查询可以帮助确认类型定义状态

这个案例展示了即使是看似简单的 API 使用问题，也可能有深层次的原因。理解框架内部实现和 Ruby 语言特性对于解决这类问题至关重要。