Absinthe项目中的Schema JSON生成器不再包含已弃用输入字段问题分析

在Elixir生态系统中，Absinthe是一个广受欢迎的GraphQL实现框架。近期，项目维护者发现了一个关于Schema JSON生成器的重要行为变更——从1.7.7版本开始，Mix.Tasks.Absinthe.Schema.Json任务生成的schema.json文件不再包含标记为已弃用(deprecated)的输入字段。

问题背景

在GraphQL规范中，字段弃用是一种常见的API演进策略。它允许开发者逐步淘汰某些字段，同时给客户端应用留出迁移时间。按照常规预期，即使字段被标记为弃用，它们仍应出现在Schema定义中，只是带有特殊的弃用标记。

然而，在Absinthe 1.7.7版本中，用户发现执行Mix.Tasks.Absinthe.Schema.Json任务时，生成的JSON Schema文件完全移除了所有已弃用的输入字段。这与之前版本的行为不一致，也违背了GraphQL的最佳实践——因为客户端应用可能仍在使用这些字段，突然消失会导致兼容性问题。

技术分析

深入分析问题根源，我们发现这与Absinthe的introspection查询实现有关。在Absinthe的introspection.graphql文件中，默认情况下没有为inputFields设置includeDeprecated参数。根据GraphQL规范，当不显式指定时，该参数默认为false，因此导致弃用字段被过滤掉。

这个问题影响三个方面：

1. 输入字段(inputFields)
2. 普通字段(fields)
3. 参数(args)

临时解决方案是修改本地introspection.graphql文件，显式添加includeDeprecated: true参数。但这显然不是理想的长期方案，因为每次更新依赖都需要重新应用修改。

解决方案演进

社区提出了几种解决方案思路：

1. 默认包含弃用字段：修改introspection查询模板，默认包含所有弃用字段。这最接近之前版本的行为，但可能与GraphQL规范默认值不符。

2. 配置化方案：引入新的配置选项，允许用户自行决定是否包含弃用字段。这提供了灵活性，但增加了API复杂度。

3. 版本回退：暂时回退到1.7.6版本，等待更完善的解决方案。

经过讨论，最终采用了配置化方案，通过添加include_deprecated配置选项来平衡规范符合性和向后兼容性需求。

对开发者的建议

对于遇到此问题的开发者，我们建议：

1. 如果急需完整Schema，可以临时使用1.7.6版本
2. 考虑采用社区提供的补丁方案
3. 在客户端应用中尽早迁移弃用字段，减少对Schema完整性的依赖
4. 关注Absinthe的更新，及时采用官方修复方案

这个问题也提醒我们，在GraphQL API演进过程中，不仅要关注字段的弃用标记，还要确保工具链各环节对弃用字段的一致处理。良好的弃用策略应该包括：明确的弃用说明、足够的迁移时间、以及工具链的完整支持。

总结

Absinthe作为成熟的GraphQL实现，这次的行为变更虽然带来了短期不便，但也促使社区更深入地思考GraphQL规范实现的一致性问题。通过社区的积极反馈和贡献，最终找到了既符合规范又满足实际需求的解决方案，体现了开源协作的价值。