Circular requires audit

[enisdenjo]

a

type Query {
  feed: [Post]
}

type Post @key(fields: "id") {
  id: ID!
  byNovice: Boolean! @external
  byExpert: Boolean! @requires(fields: "byNovice")
}

type Author @key(fields: "id") {
  id: ID!
  name: String!
  yearsOfExperience: Int!
}

b

type Post @key(fields: "id") {
  id: ID!
  author: Author!
  byNovice: Boolean! @requires(fields: "author { yearsOfExperience }")
}

type Author @key(fields: "id") {
  id: ID!
  yearsOfExperience: Int! @external
}

query

{
  feed {
    byExpert
  }
}

creates a circular requires plan: a -> (b -> a -> b) -> a

QueryPlan {
  Sequence {
    Fetch(service: "a") {
      {
        feed {
          __typename
          id
        }
      }
    },
    Flatten(path: "feed.@") {
      Fetch(service: "b") {
        {
          ... on Post {
            __typename
            id
          }
        } =>
        {
          ... on Post {
            author {
              __typename
              id
            }
          }
        }
      },
    },
    Flatten(path: "[email protected]") {
      Fetch(service: "a") {
        {
          ... on Author {
            __typename
            id
          }
        } =>
        {
          ... on Author {
            yearsOfExperience
          }
        }
      },
    },
    Flatten(path: "feed.@") {
      Fetch(service: "b") {
        {
          ... on Post {
            __typename
            author {
              yearsOfExperience
            }
            id
          }
        } =>
        {
          ... on Post {
            byNovice
          }
        }
      },
    },
    Flatten(path: "feed.@") {
      Fetch(service: "a") {
        {
          ... on Post {
            __typename
            byNovice
            id
          }
        } =>
        {
          ... on Post {
            byExpert
          }
        }
      },
    },
  },
}

[github-actions]

Compatibility Results

Summary

Gateway	Compatibility	Test Cases	Test Suites
Hive Gateway	98.94%	🟢 187 ❌ 2	🟢 41 ❌ 1
Apollo Router	97.88%	🟢 185 ❌ 4	🟢 40 ❌ 2
Apollo Gateway	97.35%	🟢 184 ❌ 5	🟢 39 ❌ 3
Cosmo Router	93.65%	🟢 177 ❌ 12	🟢 36 ❌ 6
Grafbase Gateway	91.01%	🟢 172 ❌ 17	🟢 36 ❌ 6
Inigo Gateway	0.00%	❌ 189	❌ 42

Detailed Results

Take a closer look at the results for each gateway.

You can look at the full list of tests here. Every test id corresponds to a directory in the src/test-suites folder.

Hive Gateway

• Repository
• Website

Results

abstract-types

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

child-type-mismatch

🟢🟢🟢🟢

circular-reference-interface

🟢🟢

complex-entity-call

🟢

corrupted-supergraph-node-id

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

enum-intersection

🟢🟢🟢🟢🟢

fed1-external-extends

🟢🟢🟢🟢

fed1-external-extends-resolvable

🟢

fed1-external-extension

🟢🟢🟢🟢

fed2-external-extends

🟢🟢🟢🟢

fed2-external-extension

🟢🟢🟢🟢

include-skip

🟢🟢🟢🟢

input-object-intersection

🟢🟢🟢

interface-object-with-requires

🟢🟢🟢🟢🟢🟢🟢

keys-mashup

🟢

mutations

🟢🟢🟢

mysterious-external

🟢🟢

nested-provides

🟢🟢

node

🟢

non-resolvable-interface-object

🟢🟢🟢🟢🟢🟢🟢

null-keys

🟢

override-type-interface

🟢🟢🟢🟢

override-with-requires

🟢🟢🟢🟢

parent-entity-call

🟢

parent-entity-call-complex

🟢

provides-on-interface

🟢🟢

provides-on-union

🟢🟢

requires-circular

❌❌

requires-interface

🟢🟢🟢🟢🟢

requires-requires

🟢🟢🟢🟢🟢

requires-with-argument

🟢🟢🟢🟢🟢

requires-with-fragments

🟢🟢🟢🟢🟢🟢

shared-root

🟢🟢

simple-entity-call

🟢

simple-inaccessible

🟢🟢🟢🟢

simple-interface-object

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

simple-override

🟢🟢

simple-requires-provides

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

typename

🟢🟢🟢🟢🟢🟢

unavailable-override

🟢🟢

union-interface-distributed

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

union-intersection

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

Apollo Router

• Repository
• Website

Results

abstract-types

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

child-type-mismatch

🟢🟢🟢🟢

circular-reference-interface

🟢🟢

complex-entity-call

🟢

corrupted-supergraph-node-id

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

enum-intersection

🟢🟢🟢🟢🟢

fed1-external-extends

🟢🟢🟢🟢

fed1-external-extends-resolvable

🟢

fed1-external-extension

🟢🟢🟢🟢

fed2-external-extends

🟢🟢🟢🟢

fed2-external-extension

🟢🟢🟢🟢

include-skip

🟢🟢🟢🟢

input-object-intersection

🟢🟢🟢

interface-object-with-requires

🟢🟢🟢🟢🟢🟢🟢

keys-mashup

❌

mutations

🟢🟢🟢

mysterious-external

🟢🟢

nested-provides

🟢🟢

node

🟢

non-resolvable-interface-object

🟢🟢🟢🟢🟢🟢🟢

null-keys

🟢

override-type-interface

🟢🟢🟢🟢

override-with-requires

🟢🟢🟢🟢

parent-entity-call

🟢

parent-entity-call-complex

🟢

provides-on-interface

🟢🟢

provides-on-union

🟢🟢

requires-circular

🟢🟢

requires-interface

🟢🟢🟢🟢🟢

requires-requires

🟢🟢🟢🟢🟢

requires-with-argument

🟢🟢❌❌❌

requires-with-fragments

🟢🟢🟢🟢🟢🟢

shared-root

🟢🟢

simple-entity-call

🟢

simple-inaccessible

🟢🟢🟢🟢

simple-interface-object

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

simple-override

🟢🟢

simple-requires-provides

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

typename

🟢🟢🟢🟢🟢🟢

unavailable-override

🟢🟢

union-interface-distributed

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

union-intersection

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

Apollo Gateway

• Repository
• Website

Results

abstract-types

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

child-type-mismatch

🟢🟢🟢🟢

circular-reference-interface

🟢🟢

complex-entity-call

🟢

corrupted-supergraph-node-id

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

enum-intersection

🟢🟢🟢🟢🟢

fed1-external-extends

🟢🟢🟢🟢

fed1-external-extends-resolvable

🟢

fed1-external-extension

🟢🟢🟢🟢

fed2-external-extends

🟢🟢🟢🟢

fed2-external-extension

🟢🟢🟢🟢

include-skip

🟢🟢🟢🟢

input-object-intersection

🟢🟢🟢

interface-object-with-requires

🟢🟢🟢🟢🟢🟢🟢

keys-mashup

❌

mutations

🟢🟢🟢

mysterious-external

🟢🟢

nested-provides

🟢🟢

node

🟢

non-resolvable-interface-object

🟢❌🟢🟢🟢🟢🟢

null-keys

🟢

override-type-interface

🟢🟢🟢🟢

override-with-requires

🟢🟢🟢🟢

parent-entity-call

🟢

parent-entity-call-complex

🟢

provides-on-interface

🟢🟢

provides-on-union

🟢🟢

requires-circular

🟢🟢

requires-interface

🟢🟢🟢🟢🟢

requires-requires

🟢🟢🟢🟢🟢

requires-with-argument

🟢🟢❌❌❌

requires-with-fragments

🟢🟢🟢🟢🟢🟢

shared-root

🟢🟢

simple-entity-call

🟢

simple-inaccessible

🟢🟢🟢🟢

simple-interface-object

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

simple-override

🟢🟢

simple-requires-provides

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

typename

🟢🟢🟢🟢🟢🟢

unavailable-override

🟢🟢

union-interface-distributed

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

union-intersection

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

Cosmo Router

• Repository
• Website

Results

abstract-types

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

child-type-mismatch

❌❌❌🟢

circular-reference-interface

🟢🟢

complex-entity-call

❌

corrupted-supergraph-node-id

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

enum-intersection

🟢🟢🟢🟢🟢

fed1-external-extends

🟢🟢🟢🟢

fed1-external-extends-resolvable

🟢

fed1-external-extension

🟢🟢🟢🟢

fed2-external-extends

🟢🟢🟢🟢

fed2-external-extension

🟢🟢🟢🟢

include-skip

🟢🟢🟢🟢

input-object-intersection

🟢🟢🟢

interface-object-with-requires

🟢🟢🟢🟢🟢🟢🟢

keys-mashup

🟢

mutations

❌❌❌

mysterious-external

🟢🟢

nested-provides

🟢🟢

node

🟢

non-resolvable-interface-object

🟢🟢🟢🟢🟢🟢🟢

null-keys

🟢

override-type-interface

🟢🟢🟢🟢

override-with-requires

🟢🟢🟢🟢

parent-entity-call

🟢

parent-entity-call-complex

❌

provides-on-interface

❌❌

provides-on-union

❌❌

requires-circular

🟢🟢

requires-interface

🟢🟢🟢🟢🟢

requires-requires

🟢🟢🟢🟢🟢

requires-with-argument

🟢🟢🟢🟢🟢

requires-with-fragments

🟢🟢🟢🟢🟢🟢

shared-root

🟢🟢

simple-entity-call

🟢

simple-inaccessible

🟢🟢🟢🟢

simple-interface-object

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

simple-override

🟢🟢

simple-requires-provides

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

typename

🟢🟢🟢🟢🟢🟢

unavailable-override

🟢🟢

union-interface-distributed

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

union-intersection

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

Grafbase Gateway

• Repository
• Website

Results

abstract-types

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

child-type-mismatch

🟢🟢🟢🟢

circular-reference-interface

🟢🟢

complex-entity-call

🟢

corrupted-supergraph-node-id

❌🟢❌🟢🟢❌🟢🟢🟢🟢

enum-intersection

🟢🟢🟢🟢🟢

fed1-external-extends

🟢🟢🟢🟢

fed1-external-extends-resolvable

🟢

fed1-external-extension

🟢🟢🟢🟢

fed2-external-extends

🟢🟢🟢🟢

fed2-external-extension

🟢🟢🟢🟢

include-skip

🟢🟢🟢🟢

input-object-intersection

🟢🟢🟢

interface-object-with-requires

🟢🟢🟢🟢🟢🟢🟢

keys-mashup

🟢

mutations

🟢🟢🟢

mysterious-external

🟢🟢

nested-provides

🟢🟢

node

🟢

non-resolvable-interface-object

🟢🟢🟢🟢🟢🟢🟢

null-keys

🟢

override-type-interface

❌❌❌❌

override-with-requires

🟢🟢🟢🟢

parent-entity-call

🟢

parent-entity-call-complex

🟢

provides-on-interface

❌❌

provides-on-union

🟢❌

requires-circular

🟢🟢

requires-interface

🟢🟢🟢🟢🟢

requires-requires

🟢🟢🟢🟢🟢

requires-with-argument

🟢🟢🟢🟢🟢

requires-with-fragments

🟢🟢🟢🟢🟢🟢

shared-root

🟢🟢

simple-entity-call

🟢

simple-inaccessible

🟢🟢🟢🟢

simple-interface-object

🟢🟢🟢🟢🟢🟢🟢🟢❌❌❌❌❌

simple-override

🟢🟢

simple-requires-provides

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

typename

🟢🟢🟢🟢🟢🟢

unavailable-override

🟢🟢

union-interface-distributed

🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

union-intersection

🟢🟢🟢🟢🟢🟢🟢🟢❌🟢🟢❌

Inigo Gateway

• Repository
• Website

Results

abstract-types

❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌❌

child-type-mismatch

❌❌❌❌

circular-reference-interface

❌❌

complex-entity-call

❌

corrupted-supergraph-node-id

❌❌❌❌❌❌❌❌❌❌

enum-intersection

❌❌❌❌❌

fed1-external-extends

❌❌❌❌

fed1-external-extends-resolvable

❌

fed1-external-extension

❌❌❌❌

fed2-external-extends

❌❌❌❌

fed2-external-extension

❌❌❌❌

include-skip

❌❌❌❌

input-object-intersection

❌❌❌

interface-object-with-requires

❌❌❌❌❌❌❌

keys-mashup

❌

mutations

❌❌❌

mysterious-external

❌❌

nested-provides

❌❌

node

❌

non-resolvable-interface-object

❌❌❌❌❌❌❌

null-keys

❌

override-type-interface

❌❌❌❌

override-with-requires

❌❌❌❌

parent-entity-call

❌

parent-entity-call-complex

❌

provides-on-interface

❌❌

provides-on-union

❌❌

requires-circular

❌❌

requires-interface

❌❌❌❌❌

requires-requires

❌❌❌❌❌

requires-with-argument

❌❌❌❌❌

requires-with-fragments

❌❌❌❌❌❌

shared-root

❌❌

simple-entity-call

❌

simple-inaccessible

❌❌❌❌

simple-interface-object

❌❌❌❌❌❌❌❌❌❌❌❌❌

simple-override

❌❌

simple-requires-provides

❌❌❌❌❌❌❌❌❌❌❌❌

typename

❌❌❌❌❌❌

unavailable-override

❌❌

union-interface-distributed

❌❌❌❌❌❌❌❌❌❌

union-intersection

❌❌❌❌❌❌❌❌❌❌❌❌