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

package/src/test-suites/provides-on-interface/a.subgraph.ts

@@ -0,0 +1,95 @@
+import { createSubgraph } from "../../subgraph.js";
+import { animals, medias, pubishPoorPlans } from "./data.js";
+
+export default createSubgraph("a", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@shareable", "@external", "@provides"]
+      )
+
+    type Query {
+      media: Media @shareable
+      book: Book @provides(fields: "animals { ... on Dog { name } }")
+    }
+
+    interface Media {
+      id: ID!
+    }
+
+    interface Animal {
+      id: ID!
+    }
+
+    type Book implements Media @key(fields: "id") {
+      id: ID!
+      animals: [Animal] @shareable
+    }
+
+    type Dog implements Animal @key(fields: "id") {
+      id: ID! @external
+      name: String @external
+    }
+
+    type Cat implements Animal @key(fields: "id") {
+      id: ID! @external
+    }
+  `,
+  resolvers: {
+    Query: {
+      media() {
+        if (pubishPoorPlans) {
+          throw new Error("You should be using the 'a' subgraph!");
+        }
+
+        const media = medias[0];
+
+        return {
+          __typename: media.__typename,
+          id: media.id,
+          animals: media.animals.map((animalId) => {
+            const animal = animals.find((a) => a.id === animalId);
+
+            if (!animal) {
+              return null;
+            }
+
+            return {
+              __typename: animal.__typename,
+              id: animal.id,
+            };
+          }),
+        };
+      },
+      book() {
+        const book = medias[0];
+
+        return {
+          __typename: "Book",
+          id: book.id,
+          animals: book.animals.map((animalId) => {
+            const animal = animals.find((a) => a.id === animalId);
+
+            if (!animal) {
+              return null;
+            }
+
+            if (animal.__typename === "Dog") {
+              return {
+                __typename: "Dog",
+                id: animal.id,
+                name: animal.name,
+              };
+            }
+
+            return {
+              __typename: animal.__typename,
+              id: animal.id,
+            };
+          }),
+        };
+      },
+    },
+  },
+});

package/src/test-suites/provides-on-interface/b.subgraph.ts

@@ -0,0 +1,65 @@
+import { createSubgraph } from "../../subgraph.js";
+import { animals, medias } from "./data.js";
+
+export default createSubgraph("b", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@shareable", "@provides", "@external"]
+      )
+
+    type Query {
+      media: Media @shareable @provides(fields: "animals { id name }")
+    }
+
+    interface Media {
+      id: ID!
+      animals: [Animal]
+    }
+
+    interface Animal {
+      id: ID!
+      name: String
+    }
+
+    type Book implements Media {
+      id: ID! @shareable
+      animals: [Animal] @external
+    }
+
+    type Dog implements Animal {
+      id: ID! @external
+      name: String @external
+    }
+
+    type Cat implements Animal {
+      id: ID! @external
+      name: String @external
+    }
+  `,
+  resolvers: {
+    Query: {
+      media() {
+        const media = medias[0];
+        return {
+          __typename: media.__typename,
+          id: media.id,
+          animals: media.animals.map((animalId) => {
+            const animal = animals.find((a) => a.id === animalId);
+
+            if (!animal) {
+              return null;
+            }
+
+            return {
+              __typename: animal.__typename,
+              id: animal.id,
+              name: animal.name,
+            };
+          }),
+        };
+      },
+    },
+  },
+});

package/src/test-suites/provides-on-interface/c.subgraph.ts

@@ -0,0 +1,119 @@
+import { createSubgraph } from "../../subgraph.js";
+import { animals, medias, pubishPoorPlans } from "./data.js";
+
+export default createSubgraph("c", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@shareable"]
+      )
+
+    interface Media {
+      id: ID!
+      animals: [Animal]
+    }
+
+    interface Animal {
+      id: ID!
+      name: String
+    }
+
+    type Book implements Media @key(fields: "id") {
+      id: ID!
+      animals: [Animal] @shareable
+    }
+
+    type Dog implements Animal @key(fields: "id") {
+      id: ID!
+      name: String @shareable
+      age: Int
+    }
+
+    type Cat implements Animal @key(fields: "id") {
+      id: ID!
+      name: String @shareable
+      age: Int
+    }
+  `,
+  resolvers: {
+    Query: {
+      media() {
+        if (pubishPoorPlans) {
+          throw new Error("You should be using the 'a' subgraph!");
+        }
+
+        return medias[0];
+      },
+    },
+    Book: {
+      __resolveReference(key: { id: string }) {
+        const media = medias.find((media) => media.id === key.id);
+
+        return media
+          ? {
+              __typename: "Book",
+              id: media.id,
+              animals: media.animals,
+            }
+          : null;
+      },
+      animals(book: { animals: string[] }) {
+        return book.animals.map((animalId) => {
+          const animal = animals.find((a) => a.id === animalId);
+
+          return animal
+            ? {
+                __typename: animal.__typename,
+                id: animal.id,
+                name: animal.name,
+              }
+            : null;
+        });
+      },
+    },
+    Cat: {
+      __resolveReference(key: { id: string }) {
+        const animal = animals.find((animal) => animal.id === key.id);
+
+        return animal
+          ? {
+              __typename: "Cat",
+              id: animal.id,
+              name: animal.name,
+              age: animal.age,
+            }
+          : null;
+      },
+      age(cat: { id: string }) {
+        const animal = animals.find((a) => a.id === cat.id);
+
+        return animal ? animal.age : null;
+      },
+    },
+    Dog: {
+      __resolveReference(key: { id: string }) {
+        if (pubishPoorPlans) {
+          // Nothing in tests should be calling this resolver
+          throw new Error("You should be using the 'c' subgraph!");
+        }
+
+        const animal = animals.find((animal) => animal.id === key.id);
+
+        return animal
+          ? {
+              __typename: "Dog",
+              id: animal.id,
+              name: animal.name,
+              age: animal.age,
+            }
+          : null;
+      },
+      age(dog: { id: string }) {
+        const animal = animals.find((a) => a.id === dog.id);
+
+        return animal ? animal.age : null;
+      },
+    },
+  },
+});

package/src/test-suites/provides-on-interface/data.ts

@@ -0,0 +1,24 @@
+export const pubishPoorPlans = true;
+
+export const medias = [
+  {
+    __typename: "Book",
+    id: "m1",
+    animals: ["a1", "a2"],
+  },
+];
+
+export const animals = [
+  {
+    __typename: "Dog",
+    id: "a1",
+    name: "Fido",
+    age: 3,
+  },
+  {
+    __typename: "Cat",
+    id: "a2",
+    name: "Whiskers",
+    age: 6,
+  },
+];

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

package/src/test-suites/provides-on-interface/test.ts

@@ -0,0 +1,68 @@
+import { createTest } from "../../testkit.js";
+
+export default [
+  createTest(
+    /* GraphQL */ `
+      query {
+        media {
+          id
+          animals {
+            id
+            name
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        media: {
+          id: "m1",
+          animals: [
+            {
+              id: "a1",
+              name: "Fido",
+            },
+            {
+              id: "a2",
+              name: "Whiskers",
+            },
+          ],
+        },
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        media {
+          id
+          animals {
+            id
+            name
+            ... on Cat {
+              age
+            }
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        media: {
+          id: "m1",
+          animals: [
+            {
+              id: "a1",
+              name: "Fido",
+            },
+            {
+              id: "a2",
+              name: "Whiskers",
+              age: 6,
+            },
+          ],
+        },
+      },
+    },
+  ),
+];

package/src/test-suites/provides-on-union/a.subgraph.ts

@@ -0,0 +1,41 @@
+import { shouldPunishForPoorPlans } from "../../env.js";
+import { createSubgraph } from "../../subgraph.js";
+import { medias } from "./data.js";
+
+export default createSubgraph("a", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@shareable", "@external"]
+      )
+
+    type Query {
+      media: [Media] @shareable
+    }
+
+    union Media = Book | Movie
+
+    type Book @key(fields: "id") {
+      id: ID!
+    }
+
+    type Movie @key(fields: "id") {
+      id: ID!
+    }
+  `,
+  resolvers: {
+    Query: {
+      media(_p: unknown, _a: unknown, context: any) {
+        if (shouldPunishForPoorPlans(context)) {
+          throw new Error("You should not be using the 'a' subgraph!");
+        }
+
+        return medias.map((media) => ({
+          __typename: media.__typename,
+          id: media.id,
+        }));
+      },
+    },
+  },
+});

package/src/test-suites/provides-on-union/b.subgraph.ts

@@ -0,0 +1,47 @@
+import { createSubgraph } from "../../subgraph.js";
+import { medias } from "./data.js";
+
+export default createSubgraph("b", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@shareable", "@provides", "@external"]
+      )
+
+    type Query {
+      media: [Media] @shareable @provides(fields: "... on Book { title }")
+    }
+
+    union Media = Book | Movie
+
+    type Book @key(fields: "id") {
+      id: ID!
+      title: String @external
+    }
+
+    type Movie @key(fields: "id") {
+      id: ID!
+    }
+  `,
+  resolvers: {
+    Query: {
+      media() {
+        return medias.map((media) => {
+          if (media.__typename === "Book") {
+            return {
+              __typename: media.__typename,
+              id: media.id,
+              title: media.title,
+            };
+          }
+
+          return {
+            __typename: media.__typename,
+            id: media.id,
+          };
+        });
+      },
+    },
+  },
+});

package/src/test-suites/provides-on-union/c.subgraph.ts

@@ -0,0 +1,59 @@
+import { shouldPunishForPoorPlans } from "../../env.js";
+import { createSubgraph } from "../../subgraph.js";
+import { medias } from "./data.js";
+
+export default createSubgraph("c", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@shareable"]
+      )
+
+    type Book @key(fields: "id") {
+      id: ID!
+      title: String @shareable
+    }
+
+    type Movie @key(fields: "id") {
+      id: ID!
+      title: String @shareable
+    }
+  `,
+  resolvers: {
+    Book: {
+      __resolveReference(key: { id: string }, context: any) {
+        if (shouldPunishForPoorPlans(context)) {
+          throw new Error("You should be using the 'b' subgraph!");
+        }
+
+        const media = medias.find((media) => media.id === key.id);
+
+        if (!media) {
+          return null;
+        }
+
+        return {
+          __typename: media.__typename,
+          id: media.id,
+          title: media.title,
+        };
+      },
+    },
+    Movie: {
+      __resolveReference(key: { id: string }) {
+        const media = medias.find((media) => media.id === key.id);
+
+        if (!media) {
+          return null;
+        }
+
+        return {
+          __typename: media.__typename,
+          id: media.id,
+          title: media.title,
+        };
+      },
+    },
+  },
+});

package/src/test-suites/provides-on-union/data.ts

@@ -0,0 +1,12 @@
+export const medias = [
+  {
+    __typename: "Book",
+    id: "m1",
+    title: "Book 1",
+  },
+  {
+    __typename: "Movie",
+    id: "m2",
+    title: "Movie 1",
+  },
+];

package/src/test-suites/provides-on-union/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("provides-on-union", [a, b, c], test);

package/src/test-suites/provides-on-union/test.ts

@@ -0,0 +1,62 @@
+import { createTest } from "../../testkit.js";
+
+export default [
+  createTest(
+    /* GraphQL */ `
+      query {
+        media {
+          ... on Book {
+            id
+            title
+          }
+          ... on Movie {
+            id
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        media: [
+          {
+            id: "m1",
+            title: "Book 1",
+          },
+          {
+            id: "m2",
+          },
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        media {
+          ... on Book {
+            id
+            title
+          }
+          ... on Movie {
+            id
+            title
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        media: [
+          {
+            id: "m1",
+            title: "Book 1",
+          },
+          {
+            id: "m2",
+            title: "Movie 1",
+          },
+        ],
+      },
+    },
+  ),
+];

package/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,
+        };
+      },
+    },
+  },
+});