Circular requires audit

README.md

@@ -8,14 +8,14 @@ This repository contains a set of tests to evaluate and compare the compatibilit
 
 <!-- gateways:start -->
 
-|                             Gateway                             | Compatibility |  Test Cases  | Test Suites |
-| :-------------------------------------------------------------: | :-----------: | :----------: | :---------: |
-| [Hive Gateway](https://the-guild.dev/graphql/hive/docs/gateway) |    100.00%    |    🟢 187    |    🟢 41    |
-|         [Apollo Router](https://www.apollographql.com/)         |    97.86%     | 🟢 183 ❌ 4  | 🟢 39 ❌ 2  |
-|        [Apollo Gateway](https://www.apollographql.com/)         |    97.33%     | 🟢 182 ❌ 5  | 🟢 38 ❌ 3  |
-|             [Cosmo Router](https://wundergraph.com)             |    95.19%     | 🟢 178 ❌ 9  | 🟢 36 ❌ 5  |
-|            [Grafbase Gateway](https://grafbase.com)             |    90.91%     | 🟢 170 ❌ 17 | 🟢 35 ❌ 6  |
-|                [Inigo Gateway](https://inigo.io)                |    48.66%     | 🟢 91 ❌ 96  | 🟢 12 ❌ 29 |
+|                          Gateway                           | Compatibility |  Test Cases  | Test Suites |
+| :--------------------------------------------------------: | :-----------: | :----------: | :---------: |
+| [Hive Gateway](https://the-guild.dev/graphql/hive/gateway) |    98.94%     | 🟢 187 ❌ 2  | 🟢 41 ❌ 1  |
+|      [Apollo Router](https://www.apollographql.com/)       |    97.88%     | 🟢 185 ❌ 4  | 🟢 40 ❌ 2  |
+|      [Apollo Gateway](https://www.apollographql.com/)      |    97.35%     | 🟢 184 ❌ 5  | 🟢 39 ❌ 3  |
+|          [Cosmo Router](https://wundergraph.com)           |    95.24%     | 🟢 180 ❌ 9  | 🟢 37 ❌ 5  |
+|          [Grafbase Gateway](https://grafbase.com)          |    91.01%     | 🟢 172 ❌ 17 | 🟢 36 ❌ 6  |
+|             [Inigo Gateway](https://inigo.io)              |    48.15%     | 🟢 91 ❌ 98  | 🟢 12 ❌ 30 |
 
 <!-- gateways:end -->
 

REPORT.md

@@ -2,14 +2,14 @@
 
 ## Summary
 
-|                             Gateway                             | Compatibility |  Test Cases  | Test Suites |
-| :-------------------------------------------------------------: | :-----------: | :----------: | :---------: |
-| [Hive Gateway](https://the-guild.dev/graphql/hive/docs/gateway) |    100.00%    |    🟢 187    |    🟢 41    |
-|         [Apollo Router](https://www.apollographql.com/)         |    97.86%     | 🟢 183 ❌ 4  | 🟢 39 ❌ 2  |
-|        [Apollo Gateway](https://www.apollographql.com/)         |    97.33%     | 🟢 182 ❌ 5  | 🟢 38 ❌ 3  |
-|             [Cosmo Router](https://wundergraph.com)             |    95.19%     | 🟢 178 ❌ 9  | 🟢 36 ❌ 5  |
-|            [Grafbase Gateway](https://grafbase.com)             |    90.91%     | 🟢 170 ❌ 17 | 🟢 35 ❌ 6  |
-|                [Inigo Gateway](https://inigo.io)                |    48.66%     | 🟢 91 ❌ 96  | 🟢 12 ❌ 29 |
+|                          Gateway                           | Compatibility |  Test Cases  | Test Suites |
+| :--------------------------------------------------------: | :-----------: | :----------: | :---------: |
+| [Hive Gateway](https://the-guild.dev/graphql/hive/gateway) |    98.94%     | 🟢 187 ❌ 2  | 🟢 41 ❌ 1  |
+|      [Apollo Router](https://www.apollographql.com/)       |    97.88%     | 🟢 185 ❌ 4  | 🟢 40 ❌ 2  |
+|      [Apollo Gateway](https://www.apollographql.com/)      |    97.35%     | 🟢 184 ❌ 5  | 🟢 39 ❌ 3  |
+|          [Cosmo Router](https://wundergraph.com)           |    95.24%     | 🟢 180 ❌ 9  | 🟢 37 ❌ 5  |
+|          [Grafbase Gateway](https://grafbase.com)          |    91.01%     | 🟢 172 ❌ 17 | 🟢 36 ❌ 6  |
+|             [Inigo Gateway](https://inigo.io)              |    48.15%     | 🟢 91 ❌ 98  | 🟢 12 ❌ 30 |
 
 ## Detailed Results
 
@@ -22,7 +22,7 @@ You can look at the full list of tests [here](./src/test-suites/). Every test id
 ### Hive Gateway
 
 - [Repository](https://github.com/graphql-hive/gateway)
-- [Website](https://the-guild.dev/graphql/hive/docs/gateway)
+- [Website](https://the-guild.dev/graphql/hive/gateway)
 
 <details>
 <summary>Results</summary>
@@ -80,6 +80,8 @@ You can look at the full list of tests [here](./src/test-suites/). Every test id
 <pre>🟢🟢</pre>
 <a href="./src/test-suites/provides-on-union">provides-on-union</a>
 <pre>🟢🟢</pre>
+<a href="./src/test-suites/requires-circular">requires-circular</a>
+<pre>❌❌</pre>
 <a href="./src/test-suites/requires-interface">requires-interface</a>
 <pre>🟢🟢🟢🟢🟢</pre>
 <a href="./src/test-suites/requires-requires">requires-requires</a>
@@ -173,6 +175,8 @@ You can look at the full list of tests [here](./src/test-suites/). Every test id
 <pre>🟢🟢</pre>
 <a href="./src/test-suites/provides-on-union">provides-on-union</a>
 <pre>🟢🟢</pre>
+<a href="./src/test-suites/requires-circular">requires-circular</a>
+<pre>🟢🟢</pre>
 <a href="./src/test-suites/requires-interface">requires-interface</a>
 <pre>🟢🟢🟢🟢🟢</pre>
 <a href="./src/test-suites/requires-requires">requires-requires</a>
@@ -266,6 +270,8 @@ You can look at the full list of tests [here](./src/test-suites/). Every test id
 <pre>🟢🟢</pre>
 <a href="./src/test-suites/provides-on-union">provides-on-union</a>
 <pre>🟢🟢</pre>
+<a href="./src/test-suites/requires-circular">requires-circular</a>
+<pre>🟢🟢</pre>
 <a href="./src/test-suites/requires-interface">requires-interface</a>
 <pre>🟢🟢🟢🟢🟢</pre>
 <a href="./src/test-suites/requires-requires">requires-requires</a>
@@ -359,6 +365,8 @@ You can look at the full list of tests [here](./src/test-suites/). Every test id
 <pre>❌❌</pre>
 <a href="./src/test-suites/provides-on-union">provides-on-union</a>
 <pre>❌❌</pre>
+<a href="./src/test-suites/requires-circular">requires-circular</a>
+<pre>🟢🟢</pre>
 <a href="./src/test-suites/requires-interface">requires-interface</a>
 <pre>🟢🟢🟢🟢🟢</pre>
 <a href="./src/test-suites/requires-requires">requires-requires</a>
@@ -452,6 +460,8 @@ You can look at the full list of tests [here](./src/test-suites/). Every test id
 <pre>❌❌</pre>
 <a href="./src/test-suites/provides-on-union">provides-on-union</a>
 <pre>🟢❌</pre>
+<a href="./src/test-suites/requires-circular">requires-circular</a>
+<pre>🟢🟢</pre>
 <a href="./src/test-suites/requires-interface">requires-interface</a>
 <pre>🟢🟢🟢🟢🟢</pre>
 <a href="./src/test-suites/requires-requires">requires-requires</a>
@@ -545,6 +555,8 @@ You can look at the full list of tests [here](./src/test-suites/). Every test id
 <pre>❌❌</pre>
 <a href="./src/test-suites/provides-on-union">provides-on-union</a>
 <pre>❌❌</pre>
+<a href="./src/test-suites/requires-circular">requires-circular</a>
+<pre>❌❌</pre>
 <a href="./src/test-suites/requires-interface">requires-interface</a>
 <pre>❌❌❌❌❌</pre>
 <a href="./src/test-suites/requires-requires">requires-requires</a>

gateways/apollo-gateway/results.txt

@@ -52,6 +52,8 @@ provides-on-interface
 ..
 provides-on-union
 ..
+requires-circular
+..
 requires-interface
 .....
 requires-requires
@@ -82,6 +84,6 @@ union-intersection
 ............
 
 ---
-Total: 187
-Passed: 182
+Total: 189
+Passed: 184
 Failed: 5

gateways/apollo-router/results.txt

@@ -52,6 +52,8 @@ provides-on-interface
 ..
 provides-on-union
 ..
+requires-circular
+..
 requires-interface
 .....
 requires-requires
@@ -82,6 +84,6 @@ union-intersection
 ............
 
 ---
-Total: 187
-Passed: 183
+Total: 189
+Passed: 185
 Failed: 4

gateways/cosmo-router/results.txt

@@ -52,6 +52,8 @@ provides-on-interface
 XX
 provides-on-union
 XX
+requires-circular
+..
 requires-interface
 .....
 requires-requires
@@ -82,6 +84,6 @@ union-intersection
 ............
 
 ---
-Total: 187
-Passed: 178
+Total: 189
+Passed: 180
 Failed: 9

gateways/grafbase-gateway/results.txt

@@ -52,6 +52,8 @@ provides-on-interface
 XX
 provides-on-union
 .X
+requires-circular
+..
 requires-interface
 .....
 requires-requires
@@ -82,6 +84,6 @@ union-intersection
 ........X..X
 
 ---
-Total: 187
-Passed: 170
+Total: 189
+Passed: 172
 Failed: 17

gateways/hive-gateway/gateway.json

@@ -1,7 +1,7 @@
 {
   "name": "Hive Gateway",
   "repository": "https://github.com/graphql-hive/gateway",
-  "website": "https://the-guild.dev/graphql/hive/docs/gateway",
+  "website": "https://the-guild.dev/graphql/hive/gateway",
   "graphql": "http://127.0.0.1:4000/graphql",
   "health": "http://127.0.0.1:4000/healthcheck"
 }

gateways/hive-gateway/results.txt

@@ -52,6 +52,8 @@ provides-on-interface
 ..
 provides-on-union
 ..
+requires-circular
+XX
 requires-interface
 .....
 requires-requires
@@ -82,6 +84,6 @@ union-intersection
 ............
 
 ---
-Total: 187
+Total: 189
 Passed: 187
-Failed: 0
+Failed: 2

gateways/inigo-gateway/results.txt

@@ -52,6 +52,8 @@ provides-on-interface
 XX
 provides-on-union
 XX
+requires-circular
+XX
 requires-interface
 XXXXX
 requires-requires
@@ -82,6 +84,6 @@ union-intersection
 XXXXXXXXX.XX
 
 ---
-Total: 187
+Total: 189
 Passed: 91
-Failed: 96
+Failed: 98

src/index.ts

@@ -45,6 +45,7 @@ async function getTestCases(router: ReturnType<typeof createRouter>) {
       import("./test-suites/requires-with-argument/index.js"),
       import("./test-suites/keys-mashup/index.js"),
       import("./test-suites/null-keys/index.js"),
+      import("./test-suites/requires-circular/index.js"),
     ].map((i) => i.then((e) => e.default))
   );
 

src/test-suites/requires-circular/a.subgraph.ts

@@ -0,0 +1,72 @@
+import { createSubgraph } from "../../subgraph.js";
+import { authors, posts } from "./data.js";
+
+export default createSubgraph("a", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@external", "@requires"]
+      )
+
+    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!
+    }
+  `,
+  resolvers: {
+    Query: {
+      feed() {
+        return posts.map((post) => ({ id: post.id }));
+      },
+    },
+    Post: {
+      __resolveReference(ref: { id: string; byNovice?: boolean }) {
+        const post = posts.find((post) => post.id === ref.id);
+        if (!post) {
+          return null;
+        }
+        if (ref.byNovice == null) {
+          return {
+            id: post.id,
+          };
+        }
+        return {
+          id: post.id,
+          byNovice: ref.byNovice,
+        };
+      },
+      byExpert(post: { byNovice: boolean }) {
+        if (post.byNovice == null) {
+          // ensuring requires is not skipped
+          return null;
+        }
+        return !post.byNovice;
+      },
+    },
+    Author: {
+      __resolveReference(ref: { id: string }) {
+        const author = authors.find((author) => author.id === ref.id);
+        if (!author) {
+          return null;
+        }
+        return {
+          id: author.id,
+          name: author.name,
+          yearsOfExperience: author.yearsOfExperience,
+        };
+      },
+    },
+  },
+});

src/test-suites/requires-circular/b.subgraph.ts

@@ -0,0 +1,46 @@
+import { createSubgraph } from "../../subgraph.js";
+import { posts } from "./data.js";
+
+export default createSubgraph("b", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@external", "@requires"]
+      )
+
+    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
+    }
+  `,
+  resolvers: {
+    Post: {
+      __resolveReference(ref: {
+        id: string;
+        author?: { yearsOfExperience: number };
+      }) {
+        const post = posts.find((post) => post.id === ref.id);
+        if (!post) {
+          return null;
+        }
+        return {
+          id: post.id,
+          author: {
+            id: post.author.id,
+            ...ref.author,
+          },
+        };
+      },
+      byNovice(post: { author: { yearsOfExperience: number } }) {
+        return post.author.yearsOfExperience < 10;
+      },
+    },
+  },
+});

src/test-suites/requires-circular/data.ts

@@ -0,0 +1,25 @@
+export const authors = [
+  {
+    id: "a1",
+    name: "John",
+    yearsOfExperience: 5,
+  },
+  {
+    id: "a2",
+    name: "Jane",
+    yearsOfExperience: 20,
+  },
+];
+
+export const posts = [
+  {
+    id: "p1",
+    body: "p1-body",
+    author: authors[0],
+  },
+  {
+    id: "p2",
+    body: "p2-body",
+    author: authors[1],
+  },
+];

src/test-suites/requires-circular/index.ts

@@ -0,0 +1,6 @@
+import { serve } from "../../supergraph.js";
+import a from "./a.subgraph.js";
+import b from "./b.subgraph.js";
+import test from "./test.js";
+
+export default serve("requires-circular", [a, b], test);