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

package/src/test-suites/nested-provides/category.subgraph.ts

@@ -0,0 +1,104 @@
+import { shouldPunishForPoorPlans } from "../../env.js";
+import { createSubgraph } from "../../subgraph.js";
+import { categories, products } from "./data.js";
+
+export default createSubgraph("category", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@shareable", "@external", "@provides"]
+      )
+
+    type Query {
+      products: [Product]
+        @shareable
+        @provides(fields: "categories { id name subCategories { id name } }")
+    }
+
+    type Product @key(fields: "id") {
+      id: ID!
+      categories: [Category] @external
+    }
+
+    type Category @key(fields: "id") {
+      id: ID!
+      """
+      This field is provided by Query.products
+      and we deliberately don't resolve it.
+      The test suite is about checking if @provides is used correctly.
+      """
+      name: String
+      subCategories: [Category] @external
+    }
+  `,
+  resolvers: {
+    Query: {
+      products() {
+        return products.map((p) => ({
+          id: p.id,
+          categories: p.categories.map((catId) => {
+            const cat = categories.find((c) => c.id === catId);
+
+            if (!cat) {
+              return null;
+            }
+
+            return {
+              id: cat.id,
+              name: cat.name,
+              subCategories: cat.subCategories.map((subCatId) => {
+                const subCat = categories.find((c) => c.id === subCatId);
+
+                if (!subCat) {
+                  return null;
+                }
+
+                return {
+                  id: subCat.id,
+                  name: subCat.name,
+                };
+              }),
+            };
+          }),
+        }));
+      },
+    },
+    Product: {
+      __resolveReference(key: { id: string }, context: any) {
+        if (shouldPunishForPoorPlans(context)) {
+          throw new Error("You should be using the categories subgraph!");
+        }
+
+        const product = products.find((p) => p.id === key.id);
+
+        if (!product) {
+          return null;
+        }
+
+        return {
+          id: product.id,
+        };
+      },
+    },
+    Category: {
+      __resolveReference(key: { id: string }, context: any) {
+        if (shouldPunishForPoorPlans(context)) {
+          throw new Error("You should be using the categories subgraph!");
+        }
+
+        const cat = categories.find((c) => c.id === key.id);
+
+        if (!cat) {
+          return null;
+        }
+
+        return {
+          id: cat.id,
+          // We explicitly don't resolve `name` here
+          // name: cat.name,
+        };
+      },
+    },
+  },
+});

package/src/test-suites/nested-provides/data.ts

@@ -0,0 +1,28 @@
+export const products = [
+  {
+    id: "p1",
+    categories: ["c1", "c2"],
+  },
+  {
+    id: "p2",
+    categories: ["c3", "c2"],
+  },
+];
+
+export const categories = [
+  {
+    id: "c1",
+    name: "Category 1",
+    subCategories: ["c2"],
+  },
+  {
+    id: "c2",
+    name: "Category 2",
+    subCategories: ["c3"],
+  },
+  {
+    id: "c3",
+    name: "Category 3",
+    subCategories: ["c1"],
+  },
+];

package/src/test-suites/nested-provides/index.ts

@@ -0,0 +1,11 @@
+import { serve } from "../../supergraph.js";
+import allProducts from "./all-products.subgraph.js";
+import category from "./category.subgraph.js";
+import subcategories from "./subcategories.subgraph.js";
+import test from "./test.js";
+
+export default serve(
+  "nested-provides",
+  [allProducts, category, subcategories],
+  test,
+);

package/src/test-suites/nested-provides/subcategories.subgraph.ts

@@ -0,0 +1,89 @@
+import { shouldPunishForPoorPlans } from "../../env.js";
+import { createSubgraph } from "../../subgraph.js";
+import { categories, products } from "./data.js";
+
+export default createSubgraph("subcategories", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@shareable"]
+      )
+
+    type Product @key(fields: "id") {
+      id: ID!
+      categories: [Category] @shareable
+    }
+
+    type Category @key(fields: "id") {
+      id: ID!
+      subCategories: [Category] @shareable
+    }
+  `,
+  resolvers: {
+    Product: {
+      __resolveReference(key: { id: string }, context: any) {
+        if (shouldPunishForPoorPlans(context)) {
+          throw new Error("You should be using the categories subgraph!");
+        }
+
+        const product = products.find((p) => p.id === key.id);
+
+        if (!product) {
+          return null;
+        }
+
+        return {
+          id: product.id,
+          categories: product.categories,
+        };
+      },
+      categories(product: { categories: string[] }, _a: unknown, context: any) {
+        if (shouldPunishForPoorPlans(context)) {
+          throw new Error("You should be using the categories subgraph!");
+        }
+
+        return product.categories.map((catId) => {
+          const cat = categories.find((c) => c.id === catId);
+
+          if (!cat) {
+            return null;
+          }
+
+          return {
+            id: cat.id,
+            subCategories: cat.subCategories,
+          };
+        });
+      },
+    },
+    Category: {
+      __resolveReference(key: { id: string }) {
+        const cat = categories.find((c) => c.id === key.id);
+
+        if (!cat) {
+          return null;
+        }
+
+        return {
+          id: cat.id,
+          subCategories: cat.subCategories,
+        };
+      },
+      subCategories(category: { subCategories: string[] }) {
+        return category.subCategories.map((catId) => {
+          const cat = categories.find((c) => c.id === catId);
+
+          if (!cat) {
+            return null;
+          }
+
+          return {
+            id: cat.id,
+            subCategories: cat.subCategories,
+          };
+        });
+      },
+    },
+  },
+});

package/src/test-suites/nested-provides/test.ts

@@ -0,0 +1,122 @@
+import { createTest } from "../../testkit.js";
+
+export default [
+  createTest(
+    /* GraphQL */ `
+      query {
+        products {
+          id
+          categories {
+            id
+            name
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        products: [
+          {
+            id: "p1",
+            categories: [
+              {
+                id: "c1",
+                name: "Category 1",
+              },
+              {
+                id: "c2",
+                name: "Category 2",
+              },
+            ],
+          },
+          {
+            id: "p2",
+            categories: [
+              {
+                id: "c3",
+                name: "Category 3",
+              },
+              {
+                id: "c2",
+                name: "Category 2",
+              },
+            ],
+          },
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        products {
+          id
+          categories {
+            id
+            name
+            subCategories {
+              id
+              name
+            }
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        products: [
+          {
+            id: "p1",
+            categories: [
+              {
+                id: "c1",
+                name: "Category 1",
+                subCategories: [
+                  {
+                    id: "c2",
+                    name: "Category 2",
+                  },
+                ],
+              },
+              {
+                id: "c2",
+                name: "Category 2",
+                subCategories: [
+                  {
+                    id: "c3",
+                    name: "Category 3",
+                  },
+                ],
+              },
+            ],
+          },
+          {
+            id: "p2",
+            categories: [
+              {
+                id: "c3",
+                name: "Category 3",
+                subCategories: [
+                  {
+                    id: "c1",
+                    name: "Category 1",
+                  },
+                ],
+              },
+              {
+                id: "c2",
+                name: "Category 2",
+                subCategories: [
+                  {
+                    id: "c3",
+                    name: "Category 3",
+                  },
+                ],
+              },
+            ],
+          },
+        ],
+      },
+    },
+  ),
+];

package/src/test-suites/node/data.ts

@@ -0,0 +1,23 @@
+export const products = [
+  {
+    id: "p-1",
+    name: "Product 1",
+    price: 10.0,
+  },
+  {
+    id: "p-2",
+    name: "Product 2",
+    price: 20.0,
+  },
+];
+
+export const categories = [
+  {
+    id: "pc-1",
+    name: "Category 1",
+  },
+  {
+    id: "c-2",
+    name: "Category 2",
+  },
+];

package/src/test-suites/node/index.ts

@@ -0,0 +1,7 @@
+import { serve } from "../../supergraph.js";
+import node from "./node.subgraph.js";
+import nodeTwo from "./node-two.js";
+import types from "./types.subgraph.js";
+import tests from "./test.js";
+
+export default serve("node", [node, nodeTwo, types], tests);

package/src/test-suites/node/node-two.ts

@@ -0,0 +1,49 @@
+import { createSubgraph } from "../../subgraph.js";
+import { categories, products } from "./data.js";
+
+export default createSubgraph("node-two", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key"])
+
+    interface Node {
+      id: ID!
+    }
+
+    type Product implements Node @key(fields: "id") {
+      id: ID!
+    }
+
+    type Category implements Node @key(fields: "id") {
+      id: ID!
+    }
+  `,
+  resolvers: {
+    Product: {
+      __resolveReference(key: { id: string }) {
+        const product = products.find((p) => p.id === key.id);
+
+        if (!product) {
+          return null;
+        }
+
+        return {
+          id: product.id,
+        };
+      },
+    },
+    Category: {
+      __resolveReference(key: { id: string }) {
+        const cat = categories.find((c) => c.id === key.id);
+
+        if (!cat) {
+          return null;
+        }
+
+        return {
+          id: cat.id,
+        };
+      },
+    },
+  },
+});

package/src/test-suites/node/node.subgraph.ts

@@ -0,0 +1,68 @@
+import { createSubgraph } from "../../subgraph.js";
+import { categories, products } from "./data.js";
+
+export default createSubgraph("node", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key"])
+
+    type Query {
+      productNode: Node
+      categoryNode: Node
+    }
+
+    interface Node {
+      id: ID!
+    }
+
+    type Product implements Node @key(fields: "id") {
+      id: ID!
+    }
+
+    type Category implements Node @key(fields: "id") {
+      id: ID!
+    }
+  `,
+  resolvers: {
+    Query: {
+      productNode() {
+        return {
+          __typename: "Product",
+          id: products[0].id,
+        };
+      },
+      categoryNode() {
+        return {
+          __typename: "Category",
+          id: categories[0].id,
+        };
+      },
+    },
+    Product: {
+      __resolveReference(key: { id: string }) {
+        const product = products.find((p) => p.id === key.id);
+
+        if (!product) {
+          return null;
+        }
+
+        return {
+          id: product.id,
+        };
+      },
+    },
+    Category: {
+      __resolveReference(key: { id: string }) {
+        const cat = categories.find((c) => c.id === key.id);
+
+        if (!cat) {
+          return null;
+        }
+
+        return {
+          id: cat.id,
+        };
+      },
+    },
+  },
+});

package/src/test-suites/node/test.ts

@@ -0,0 +1,28 @@
+import { createTest } from "../../testkit.js";
+
+export default [
+  createTest(
+    /* GraphQL */ `
+      {
+        productNode {
+          ... on Product {
+            id
+            name
+            __typename
+            price
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        productNode: {
+          id: "p-1",
+          name: "Product 1",
+          __typename: "Product",
+          price: 10,
+        },
+      },
+    },
+  ),
+];

package/src/test-suites/node/types.subgraph.ts

@@ -0,0 +1,58 @@
+import { createSubgraph } from "../../subgraph.js";
+import { categories, products } from "./data.js";
+
+export default createSubgraph("types", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@shareable"]
+      )
+
+    interface Node {
+      id: ID!
+    }
+
+    type Product implements Node @key(fields: "id") @shareable {
+      id: ID!
+      name: String!
+      price: Float!
+    }
+
+    type Category implements Node @key(fields: "id") {
+      id: ID!
+      name: String!
+    }
+  `,
+  resolvers: {
+    Product: {
+      __resolveReference(key: { id: string }) {
+        const product = products.find((p) => p.id === key.id);
+
+        if (!product) {
+          return null;
+        }
+
+        return {
+          id: product.id,
+          name: product.name,
+          price: product.price,
+        };
+      },
+    },
+    Category: {
+      __resolveReference(key: { id: string }) {
+        const cat = categories.find((c) => c.id === key.id);
+
+        if (!cat) {
+          return null;
+        }
+
+        return {
+          id: cat.id,
+          name: cat.name,
+        };
+      },
+    },
+  },
+});

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

@@ -0,0 +1,40 @@
+import { createSubgraph } from "../../subgraph.js";
+import { products } from "./data.js";
+
+export default createSubgraph("a", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@interfaceObject"]
+      )
+
+    interface Node @key(fields: "id") {
+      id: ID!
+    }
+
+    type Product @key(fields: "id", resolvable: false) @interfaceObject {
+      id: ID!
+    }
+
+    type Query {
+      a: Node
+      product: Product!
+    }
+  `,
+  resolvers: {
+    Query: {
+      a() {
+        return { __typename: "Node", id: "n1" };
+      },
+      product() {
+        return { __typename: "Product", id: products[0].id };
+      },
+    },
+    Node: {
+      __resolveReference() {
+        throw new Error("Not resolvable as it is an interface object");
+      },
+    },
+  },
+});

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

@@ -0,0 +1,55 @@
+import { createSubgraph } from "../../subgraph.js";
+import { products } from "./data.js";
+
+export default createSubgraph("b", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@interfaceObject"]
+      )
+
+    type Node @key(fields: "id", resolvable: false) @interfaceObject {
+      id: ID!
+      field: String
+    }
+
+    interface Product @key(fields: "id") {
+      id: ID!
+    }
+
+    type Bread implements Product @key(fields: "id") {
+      id: ID!
+      name: String!
+    }
+
+    type Query {
+      b: Node
+    }
+  `,
+  resolvers: {
+    Query: {
+      b() {
+        return { __typename: "Node", id: "n1" };
+      },
+    },
+    Node: {
+      __resolveReference() {
+        throw new Error("Not resolvable");
+      },
+      field() {
+        return "foo";
+      },
+    },
+    Product: {
+      __resolveReference(key: { id: string }) {
+        return products.find((p) => p.id === key.id);
+      },
+    },
+    Bread: {
+      __resolveReference(key: { id: string }) {
+        return products.find((p) => p.id === key.id);
+      },
+    },
+  },
+});

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

@@ -0,0 +1,7 @@
+export const products = [
+  {
+    __typename: "Bread",
+    id: "p1",
+    name: "Bread",
+  },
+];

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