使用NestJS集成Apollo托管联邦与Apollo网关时遇CheckFailed错误求助

问题描述 #

我按照官方文档在NestJS中集成Apollo托管联邦与Apollo联邦网关，运行网关服务时遇到错误：CheckFailed: one or more checks failed。错误截图如下：
Apollo网关CheckFailed错误截图

若需要查看我的代码，我可以提供。

排查与解决方案 #

1. 确认子服务状态 #

• 确保所有联邦子服务（微服务）已正常启动，网关配置的子服务URL可直接访问
• 用curl或浏览器访问子服务的/graphql端点，验证服务能正常返回GraphQL schema

2. 校验联邦schema合规性 #

• 子服务的schema必须符合Apollo联邦规范：
  • 实体类型需添加@key指令，示例：

    type User @key(fields: "id") {
      id: ID!
      name: String!
    }
    

  • 有@key注解的实体，必须在resolver中实现__resolveReference方法，示例：

    @Resolver(() => User)
    export class UserResolver {
      @ResolveReference()
      resolveReference(reference: { id: string }) {
        return this.usersService.findOne(reference.id);
      }
    }
    

3. 检查网关配置正确性 #

• 确认ApolloGatewayModule的子服务列表配置无误，示例：

  import { ApolloGatewayModule } from '@nestjs/apollo';
  import { Module } from '@nestjs/common';
  
  @Module({
    imports: [
      ApolloGatewayModule.forRoot({
        gateway: {
          serviceList: [
            { name: 'users', url: 'http://localhost:3001/graphql' },
            { name: 'posts', url: 'http://localhost:3002/graphql' },
          ],
        },
      }),
    ],
  })
  export class GatewayModule {}
  

• 若使用托管联邦，需确保managed: true及Apollo Studio配置正确，示例：

  ApolloGatewayModule.forRoot({
    gateway: {
      managed: true,
      __exposeQueryPlanExperimental: false,
    },
    server: {
      playground: true,
    },
    engine: {
      apiKey: 'YOUR_APOLLO_STUDIO_API_KEY',
    },
  })
  

4. 获取详细错误日志 #

• 启动网关时添加环境变量开启调试日志，命令如下：

  DEBUG=apollo-gateway* npm run start:dev
  

• 查看Apollo Studio面板，获取联邦检查失败的具体原因（如schema冲突、子服务不可达等）

5. 验证依赖版本兼容性 #

• 确保@nestjs/apollo、@apollo/gateway、apollo-server-express等依赖版本匹配，建议使用官方文档指定的版本组合

若以上步骤无法解决问题，可以提供网关配置代码、子服务schema及resolver代码，以便进一步排查。

内容的提问来源于stack exchange，提问作者Mustafa Aswadi