@graphql-hive/federation-gateway-audit 0.0.0 → 0.0.1

package/src/test-suites/non-resolvable-interface-object/test.ts

@@ -0,0 +1,113 @@
+import { createTest } from "../../testkit.js";
+
+export default [
+  createTest(
+    /* GraphQL */ `
+      query {
+        b {
+          id
+          field
+        }
+      }
+    `,
+    {
+      data: {
+        b: {
+          id: "n1",
+          field: "foo",
+        },
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        a {
+          field
+        }
+      }
+    `,
+    {
+      data: null,
+      errors: true,
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        b {
+          id
+        }
+      }
+    `,
+    {
+      data: {
+        b: {
+          id: "n1",
+        },
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        a {
+          id
+        }
+      }
+    `,
+    {
+      data: {
+        a: null,
+      },
+      errors: true,
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        product {
+          id
+        }
+      }
+    `,
+    {
+      data: {
+        product: {
+          id: "p1",
+        },
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        product {
+          id
+          name
+        }
+      }
+    `,
+    {
+      errors: true,
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        product {
+          ... on Bread {
+            id
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        product: {
+          id: "p1",
+        },
+      },
+    },
+  ),
+];

package/src/test-suites/null-keys/a.subgraph.ts

@@ -0,0 +1,40 @@
+import { createSubgraph } from "../../subgraph.js";
+import { books } from "./data.js";
+
+export default createSubgraph("a", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key"])
+
+    type Query {
+      bookContainers: [BookContainer]
+    }
+    type BookContainer {
+      book: Book
+    }
+    type Book @key(fields: "upc") {
+      upc: ID!
+    }
+  `,
+  resolvers: {
+    Query: {
+      bookContainers() {
+        return books.map((book) => ({ book: { upc: book.upc } }));
+      },
+    },
+    Book: {
+      __resolveReference(reference: { upc: String }) {
+        if (reference != null) {
+          let book = books.find((book) => book.upc === reference.upc);
+          if (book != null && book.upc !== null) {
+            return {
+              __typename: "Book",
+              upc: book.upc,
+            };
+          }
+        }
+        throw new Error("Invalid reference");
+      },
+    },
+  },
+});

package/src/test-suites/null-keys/b.subgraph.ts

@@ -0,0 +1,42 @@
+import { createSubgraph } from "../../subgraph.js";
+import { books } from "./data.js";
+
+export default createSubgraph("b", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key"])
+
+    type Book @key(fields: "id") @key(fields: "upc") {
+      id: ID!
+      upc: ID!
+    }
+  `,
+  resolvers: {
+    Book: {
+      __resolveReference(reference: { id: String } | { upc: String }) {
+        if (reference != null) {
+          let book: { id: string; upc: string } | undefined;
+          if ("id" in reference) {
+            book = books.find((book) => book.id === reference.id);
+          }
+          if ("upc" in reference) {
+            book = books.find((book) => book.upc === reference.upc);
+          }
+          if (book != null) {
+            // `a` has `Book` entities with upc: `b1, b2, b3`, but `b` has `Book` entities with only `b1` and `b2`.
+            // `b3` is not available and this subgraph is the only possible step to get to the other subgraph (need of `id` field) to resolve the author.
+            if (book.id === "3") {
+              return null;
+            }
+            return {
+              __typename: "Book",
+              id: book.id,
+              upc: book.upc,
+            };
+          }
+        }
+        throw new Error("Invalid reference");
+      },
+    },
+  },
+});

package/src/test-suites/null-keys/c.subgraph.ts

@@ -0,0 +1,48 @@
+import { createSubgraph } from "../../subgraph.js";
+import { books } from "./data.js";
+
+export default createSubgraph("c", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key"])
+
+    type Book @key(fields: "id") {
+      id: ID!
+      author: Author
+    }
+
+    type Author {
+      id: ID!
+      name: String
+    }
+  `,
+  resolvers: {
+    Book: {
+      __resolveReference(reference: { id: String } | { upc: String }) {
+        if (reference != null) {
+          let book:
+            | { id: string; author: { id: string; name: string } }
+            | undefined;
+          if ("id" in reference && reference.id !== null) {
+            book = books.find((book) => book.id === reference.id);
+          }
+          if ("upc" in reference && reference.upc !== null) {
+            book = books.find((book) => book.upc === reference.upc);
+          }
+          if (book != null) {
+            return {
+              __typename: "Book",
+              id: book.id,
+              author: {
+                __typename: "Author",
+                id: book.author.id,
+                name: book.author.name,
+              },
+            };
+          }
+        }
+        throw new Error("Invalid reference");
+      },
+    },
+  },
+});

package/src/test-suites/null-keys/data.ts

@@ -0,0 +1,32 @@
+export const books = [
+  {
+    __typename: "Book",
+    id: "1",
+    upc: "b1",
+    author: {
+      __typename: "Author",
+      id: "a1",
+      name: "Alice",
+    },
+  },
+  {
+    __typename: "Book",
+    id: "2",
+    upc: "b2",
+    author: {
+      __typename: "Author",
+      id: "a2",
+      name: "Bob",
+    },
+  },
+  {
+    __typename: "Book",
+    id: "3",
+    upc: "b3",
+    author: {
+      __typename: "Author",
+      id: "a3",
+      name: "Jack",
+    },
+  },
+];

package/src/test-suites/null-keys/index.ts

@@ -0,0 +1,7 @@
+import { serve } from "../../supergraph.js";
+import a from "./a.subgraph.js";
+import b from "./b.subgraph.js";
+import c from "./c.subgraph.js";
+import test from "./test.js";
+
+export default serve("null-keys", [a, b, c], test);

package/src/test-suites/null-keys/test.ts

@@ -0,0 +1,46 @@
+import { createTest } from "../../testkit.js";
+
+export default [
+  createTest(
+    /* GraphQL */ `
+      query {
+        bookContainers {
+          book {
+            upc
+            author {
+              name
+            }
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        bookContainers: [
+          {
+            book: {
+              upc: "b1",
+              author: {
+                name: "Alice",
+              },
+            },
+          },
+          {
+            book: {
+              upc: "b2",
+              author: {
+                name: "Bob",
+              },
+            },
+          },
+          {
+            book: {
+              upc: "b3",
+              author: null,
+            },
+          },
+        ],
+      },
+    },
+  ),
+];

package/src/test-suites/override-type-interface/a.subgraph.ts

@@ -0,0 +1,47 @@
+import { createSubgraph } from "../../subgraph.js";
+import { imagePosts } from "./data.js";
+
+export default createSubgraph("a", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key"])
+
+    interface Post {
+      id: ID!
+      createdAt: String!
+    }
+
+    type ImagePost implements Post @key(fields: "id") {
+      id: ID!
+      createdAt: String!
+    }
+
+    type Query {
+      feed: [Post]
+    }
+  `,
+  resolvers: {
+    Query: {
+      feed() {
+        return imagePosts;
+      },
+    },
+    ImagePost: {
+      __resolveReference(key: { id: string }) {
+        const post = imagePosts.find((p) => p.id === key.id);
+
+        if (!post) {
+          return null;
+        }
+
+        return {
+          id: post.id,
+          createdAt: post.createdAt,
+        };
+      },
+      createdAt() {
+        return "NEVER";
+      },
+    },
+  },
+});

package/src/test-suites/override-type-interface/b.subgraph.ts

@@ -0,0 +1,73 @@
+import { createSubgraph } from "../../subgraph.js";
+import { imagePosts, textPosts } from "./data.js";
+
+export default createSubgraph("b", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@shareable", "@override"]
+      )
+
+    interface Post {
+      id: ID!
+      createdAt: String!
+    }
+
+    type TextPost implements Post @key(fields: "id") {
+      id: ID!
+      createdAt: String!
+      body: String!
+    }
+
+    interface AnotherPost {
+      id: ID!
+      createdAt: String!
+    }
+
+    type ImagePost implements AnotherPost @key(fields: "id") {
+      id: ID!
+      createdAt: String! @override(from: "a")
+    }
+
+    type Query {
+      anotherFeed: [AnotherPost]
+    }
+  `,
+  resolvers: {
+    Query: {
+      anotherFeed() {
+        return imagePosts;
+      },
+    },
+    TextPost: {
+      __resolveReference(key: { id: string }) {
+        const post = textPosts.find((p) => p.id === key.id);
+
+        if (!post) {
+          return null;
+        }
+
+        return {
+          id: post.id,
+          createdAt: post.createdAt,
+          body: post.body,
+        };
+      },
+    },
+    ImagePost: {
+      __resolveReference(key: { id: string }) {
+        const post = imagePosts.find((p) => p.id === key.id);
+
+        if (!post) {
+          return null;
+        }
+
+        return {
+          id: post.id,
+          createdAt: post.createdAt,
+        };
+      },
+    },
+  },
+});

package/src/test-suites/override-type-interface/data.ts

@@ -0,0 +1,27 @@
+export const imagePosts = [
+  {
+    __typename: "ImagePost",
+    id: "i1",
+    createdAt: "i1-createdAt",
+  },
+  {
+    __typename: "ImagePost",
+    id: "i2",
+    createdAt: "i2-createdAt",
+  },
+];
+
+export const textPosts = [
+  {
+    __typename: "TextPost",
+    id: "t1",
+    createdAt: "t1-createdAt",
+    body: "t1-body",
+  },
+  {
+    __typename: "TextPost",
+    id: "t2",
+    createdAt: "t2-createdAt",
+    body: "t2-body",
+  },
+];

package/src/test-suites/override-type-interface/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("override-type-interface", [a, b], test);

package/src/test-suites/override-type-interface/test.ts

@@ -0,0 +1,94 @@
+import { createTest } from "../../testkit.js";
+
+export default [
+  createTest(
+    /* GraphQL */ `
+      query {
+        feed {
+          id
+          createdAt
+        }
+      }
+    `,
+    {
+      data: {
+        feed: [
+          {
+            id: "i1",
+            createdAt: "i1-createdAt",
+          },
+          {
+            id: "i2",
+            createdAt: "i2-createdAt",
+          },
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        feed {
+          ... on TextPost {
+            id
+            body
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        feed: [{}, {}],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        anotherFeed {
+          createdAt
+        }
+      }
+    `,
+    {
+      data: {
+        anotherFeed: [
+          {
+            createdAt: "i1-createdAt",
+          },
+          {
+            createdAt: "i2-createdAt",
+          },
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      {
+        anotherFeed {
+          createdAt
+          id
+          ... on ImagePost {
+            createdAt
+            id
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        anotherFeed: [
+          {
+            createdAt: "i1-createdAt",
+            id: "i1",
+          },
+          {
+            createdAt: "i2-createdAt",
+            id: "i2",
+          },
+        ],
+      },
+    },
+  ),
+];

package/src/test-suites/override-with-requires/a.subgraph.ts

@@ -0,0 +1,55 @@
+import { createSubgraph } from "../../subgraph.js";
+import { users } from "./data.js";
+
+export default createSubgraph("a", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@requires", "@external"]
+      )
+
+    type User @key(fields: "id") {
+      id: ID!
+      name: String! @external
+      aName: String! @requires(fields: "name")
+    }
+
+    type Query {
+      userInA: User
+    }
+  `,
+  resolvers: {
+    Query: {
+      userInA() {
+        return users[0];
+      },
+    },
+    User: {
+      __resolveReference(key: { id: string } | { id: string; name: string }) {
+        const user = users.find((u) => u.id === key.id);
+
+        if (!user) {
+          return null;
+        }
+
+        if ("name" in key) {
+          return {
+            id: user.id,
+            name: user.name,
+          };
+        }
+
+        return {
+          id: user.id,
+        };
+      },
+      aName(user: { name: string }) {
+        return `a__${user.name}`;
+      },
+      name() {
+        return "NEVER";
+      },
+    },
+  },
+});

package/src/test-suites/override-with-requires/b.subgraph.ts

@@ -0,0 +1,42 @@
+import { createSubgraph } from "../../subgraph.js";
+import { users } from "./data.js";
+
+export default createSubgraph("b", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@override"]
+      )
+
+    type User @key(fields: "id") {
+      id: ID!
+      name: String! @override(from: "c")
+    }
+
+    type Query {
+      userInB: User
+    }
+  `,
+  resolvers: {
+    Query: {
+      userInB() {
+        return users[1];
+      },
+    },
+    User: {
+      __resolveReference(key: { id: string }) {
+        const user = users.find((u) => u.id === key.id);
+
+        if (!user) {
+          return null;
+        }
+
+        return {
+          id: user.id,
+          name: user.name,
+        };
+      },
+    },
+  },
+});