Netflix DGS框架中EntitiesProjectionRoot生成问题的排查与解决

问题背景

在使用Netflix DGS(Data Graph Service)框架进行项目升级时，开发者遇到了一个关于测试客户端代码生成的问题。原本在DGS 5.X版本和Spring Boot 2.7环境下正常工作的EntitiesProjectionRoot测试工具类，在升级到DGS 8.2.0和Spring Boot 3.2后突然无法生成。

问题现象

升级后，项目中的client测试文件夹不再自动生成，导致基于EntitiesProjectionRoot的单元测试无法继续使用。这个问题出现在保持DGS Codegen版本6.1.1不变的情况下，仅升级了Spring Boot和DGS框架主版本。

技术分析

EntitiesProjectionRoot是DGS框架提供的一个测试工具类，主要用于构建GraphQL查询的投影(projection)，在单元测试中非常有用。它的消失会影响开发者对GraphQL API的测试能力。

经过排查，发现问题并非由DGS框架本身的bug引起，而是Maven配置上的疏忽。在项目升级过程中，开发者只在主代码生成配置中设置了generateClient参数，而忘记了在测试代码生成配置中做同样的设置。

解决方案

正确的做法是确保在Maven的DGS代码生成插件配置中，同时为main和test两个执行阶段都配置generateClient选项：

<execution>
    <id>generate-test-java</id>
    <phase>generate-test-sources</phase>
    <goals>
        <goal>generate</goal>
    </goals>
    <configuration>
        <generateClient>true</generateClient>
        <!-- 其他测试生成配置 -->
    </configuration>
</execution>

经验总结

1. 版本升级需谨慎：在进行框架大版本升级时，不仅要关注主功能的变更，也要注意测试相关功能的配置变化。

2. 配置一致性检查：对于代码生成工具，确保开发环境和测试环境的生成配置保持一致非常重要。

3. 理解工具原理：了解DGS代码生成器的工作机制有助于快速定位问题。它根据schema文件生成不同类型的代码，而client代码是可选的，需要显式开启。

这个问题虽然最终发现是配置问题，但反映了DGS框架在版本升级过程中可能遇到的典型挑战，值得其他开发者在类似升级场景中借鉴。