Skip to content

Circular requires audit #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Circular requires audit #134

wants to merge 2 commits into from
+255 −33

Conversation

enisdenjo
Copy link
Member

@enisdenjo enisdenjo commented Jun 4, 2025 •
edited
Loading

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
          }
        }
      },
    },
  },
}

@enisdenjo enisdenjo requested review from ardatan and kamilkisiela June 4, 2025 11:34
@enisdenjo enisdenjo marked this pull request as draft June 4, 2025 11:36
@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 4, 2025 •
edited
Loading

Compatibility Results

Summary

Gateway Compatibility Test Cases Test Suites
Hive Router 100.00% 🟢 191 🟢 43
Hive Gateway 98.95% 🟢 189 ❌ 2 🟢 42 ❌ 1
Apollo Router 97.91% 🟢 187 ❌ 4 🟢 41 ❌ 2
Apollo Gateway 97.38% 🟢 186 ❌ 5 🟢 40 ❌ 3
Grafbase Gateway 92.15% 🟢 176 ❌ 15 🟢 38 ❌ 5
Cosmo Router 91.10% 🟢 174 ❌ 17 🟢 36 ❌ 7
Inigo Gateway 48.17% 🟢 92 ❌ 99 🟢 12 ❌ 31

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 Router

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-indirect-extension 
🟢
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 
🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢

Hive Gateway

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-indirect-extension 
🟢
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

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-indirect-extension 
🟢
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

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-indirect-extension 
🟢
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

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-indirect-extension 
❌
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

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-indirect-extension 
❌
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

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-indirect-extension 
❌
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 
❌❌❌❌❌❌❌❌❌🟢❌❌

@enisdenjo enisdenjo marked this pull request as ready for review June 10, 2025 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ardatan ardatan Awaiting requested review from ardatan

@kamilkisiela kamilkisiela Awaiting requested review from kamilkisiela

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@enisdenjo @ardatan