GraphQL Code Generator 4.4.0 版本中 client-preset 的重大变更解析

GraphQL Code Generator 是一个广泛使用的工具，它能够根据 GraphQL 模式自动生成类型定义和客户端代码。在最近的 4.4.0 版本中，client-preset 插件引入了一个具有破坏性的变更，导致许多现有项目出现了类型缺失的问题。

变更背景

在 4.4.0 版本中，client-preset 插件默认启用了 onlyEnumTypes 和 onlyOperationTypes 选项。这意味着生成的类型文件中将只包含枚举类型和操作类型，而不再包含其他 GraphQL 类型定义（如对象类型、接口类型等）。

这个变更的初衷是为了减少生成的代码量，提高性能。然而，由于这是一个默认行为的改变，且没有在版本发布说明中充分强调，导致许多依赖这些类型的项目在升级后出现了问题。

影响范围

这一变更主要影响了以下几种使用场景：

1. 测试数据模拟：许多测试框架和工具（如 graphql-codegen-typescript-mock-data）依赖完整的类型定义来生成模拟数据。

2. 跨组件类型共享：一些项目会直接引用生成的类型定义来共享类型信息。

3. 自定义工具链：部分开发者构建的自定义工具链可能依赖这些"内部"类型。

技术细节

在 4.3.3 及之前版本中，client-preset 会生成完整的类型定义，包括：

• 查询和变更操作类型
• 所有 GraphQL 对象类型
• 接口和联合类型
• 输入类型
• 枚举类型

而在 4.4.0 版本中，默认只生成：

• 查询和变更操作类型
• 枚举类型

解决方案

开发团队提供了几种解决方案：

1. 临时回退方案：可以在配置中显式禁用这些选项：

{
  generates: {
    "src/graphql": {
      preset: 'client',
      config: {
        onlyEnumTypes: false,
        onlyOperationTypes: false,
      }
    }
  }
}

2. 长期解决方案：为其他用途单独生成类型文件：

{
  generates: {
    "src/graphql": {
      preset: 'client'
    },
    "src/graphql/types.generated.ts": {
      plugins: ['typescript']
    }
  }
}

3. 版本锁定：暂时锁定到 4.3.3 版本，等待更稳定的解决方案。

最佳实践建议

1. 明确类型使用边界：避免直接依赖生成的"内部"类型，应该通过操作类型来间接引用。

2. 分离关注点：为不同用途生成独立的类型文件，如客户端使用和测试使用分开。

3. 版本升级策略：对于关键依赖，建议采用渐进式升级策略，先在开发环境验证兼容性。

4. 类型安全测试：考虑使用操作文档类型（DocumentType）来确保测试数据的类型安全。

经验教训

这一事件提醒我们几个重要的软件开发原则：

1. 语义化版本控制：破坏性变更应该通过主版本号升级来标识。

2. 变更沟通：重大变更需要在发布说明中明确标注，并提供迁移指南。

3. 公共API设计：一旦类型被导出，就应该被视为公共API的一部分，即使它们最初是作为"内部"类型设计的。

4. 兼容性考虑：在优化性能或减少代码体积时，需要权衡对现有用户的影响。

未来展望

开发团队已经表示，这些配置选项将在未来的主版本中被移除。因此，开发者应该开始规划迁移到更稳定的架构模式，避免直接依赖可能变化的实现细节。

对于需要完整类型定义的项目，建议采用单独的类型生成配置，这样可以更好地控制生成的内容，并减少对client-preset内部实现的依赖。