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

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

@@ -0,0 +1,163 @@
+import { createSubgraph } from "../../subgraph.js";
+import { users, accounts } from "./data.js";
+
+export default createSubgraph("a", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@shareable"]
+      )
+
+    type Query {
+      users: [NodeWithName!]!
+    }
+
+    interface NodeWithName @key(fields: "id") {
+      id: ID!
+      name: String
+    }
+
+    type User implements NodeWithName @key(fields: "id") {
+      id: ID!
+      name: String
+      age: Int
+    }
+
+    interface Account @key(fields: "id") {
+      id: ID!
+    }
+
+    type Admin implements Account @key(fields: "id") {
+      id: ID!
+      isMain: Boolean!
+      isActive: Boolean! @shareable
+    }
+
+    type Regular implements Account @key(fields: "id") {
+      id: ID!
+      isMain: Boolean!
+    }
+  `,
+  resolvers: {
+    NodeWithName: {
+      __resolveReference(key: { id: string }) {
+        const node = users.find((u) => u.id === key.id);
+
+        if (!node) {
+          return null;
+        }
+
+        return {
+          __typename: "User",
+          id: node.id,
+          name: node.name,
+          age: node.age,
+        };
+      },
+    },
+    User: {
+      __resolveReference(key: { id: string }) {
+        const user = users.find((u) => u.id === key.id);
+
+        if (!user) {
+          return null;
+        }
+
+        return {
+          __typename: "User",
+          id: user.id,
+          name: user.name,
+          age: user.age,
+        };
+      },
+    },
+    Account: {
+      __resolveReference(key: { id: string }) {
+        const account = accounts.find((account) => account.id === key.id);
+
+        if (!account) {
+          return null;
+        }
+
+        return {
+          __typename: account.__typename,
+          id: account.id,
+          isActive: account.isActive,
+        };
+      },
+    },
+    Admin: {
+      __resolveReference(key: { id: string }) {
+        const admin = accounts.find((account) => account.id === key.id);
+
+        if (!admin) {
+          return null;
+        }
+
+        if (admin.__typename !== "Admin") {
+          return null;
+        }
+
+        return {
+          __typename: admin.__typename,
+          id: admin.id,
+          isMain: admin.isMain,
+          isActive: admin.isActive,
+        };
+      },
+      isMain(admin: { id: string; isMain?: boolean }) {
+        if (typeof admin.isMain === "boolean") {
+          return admin.isMain;
+        }
+
+        const account = accounts.find((a) => a.id === admin.id);
+
+        if (!account) {
+          return null;
+        }
+
+        return account.isMain;
+      },
+    },
+    Regular: {
+      __resolveReference(key: { id: string }) {
+        const admin = accounts.find((account) => account.id === key.id);
+
+        if (!admin) {
+          return null;
+        }
+
+        return {
+          __typename: admin.__typename,
+          id: admin.id,
+          isMain: admin.isMain,
+          isActive: admin.isActive,
+        };
+      },
+      isMain(admin: { id: string; isMain?: boolean }) {
+        if (typeof admin.isMain === "boolean") {
+          return admin.isMain;
+        }
+
+        const account = accounts.find((a) => a.id === admin.id);
+
+        if (!account) {
+          return null;
+        }
+
+        return account.isMain;
+      },
+    },
+    Query: {
+      users() {
+        return users.map((u) => ({
+          __typename: "User",
+          id: u.id,
+          name: u.name,
+          age: u.age,
+        }));
+      },
+    },
+  },
+});

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

@@ -0,0 +1,89 @@
+import { createSubgraph } from "../../subgraph.js";
+import { users, accounts } from "./data.js";
+
+export default createSubgraph("b", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@interfaceObject", "@shareable"]
+      )
+
+    type Query {
+      anotherUsers: [NodeWithName]
+      accounts: [Account] @shareable
+    }
+
+    type Account @key(fields: "id") @interfaceObject {
+      id: ID!
+      name: String!
+    }
+
+    type NodeWithName @key(fields: "id") @interfaceObject {
+      id: ID!
+      username: String
+    }
+  `,
+  resolvers: {
+    NodeWithName: {
+      __resolveReference(key: { id: string }) {
+        const node = users.find((u) => u.id === key.id);
+
+        if (!node) {
+          return null;
+        }
+
+        return {
+          __typename: "User",
+          id: node.id,
+          username: node.username,
+        };
+      },
+      username(node: { id: string }) {
+        const user = users.find((u) => u.id === node.id);
+
+        if (!user) {
+          return null;
+        }
+
+        return user.username;
+      },
+    },
+    Account: {
+      __resolveReference(key: { __typename: string; id: string }) {
+        const account = accounts.find((account) => account.id === key.id);
+
+        if (!account) {
+          return null;
+        }
+
+        return {
+          // I deliberately return a wrong __typename here to make sure it's not used by the gateway
+          __typename: "Never",
+          id: account.id,
+        };
+      },
+      name(account: { id: string }) {
+        return accounts.find((u) => u.id === account.id)?.name;
+      },
+    },
+    Query: {
+      anotherUsers() {
+        return users.map((u) => ({
+          __typename: "User",
+          id: u.id,
+          username: u.username,
+        }));
+      },
+      accounts() {
+        return accounts.map((user) => {
+          return {
+            // I deliberately return a wrong __typename here to make sure it's not used by the gateway
+            __typename: "Never",
+            id: user.id,
+          };
+        });
+      },
+    },
+  },
+});

package/src/test-suites/simple-interface-object/c.subgraph.ts

@@ -0,0 +1,48 @@
+import { createSubgraph } from "../../subgraph.js";
+import { accounts } from "./data.js";
+
+export default createSubgraph("c", {
+  typeDefs: /* GraphQL */ `
+    extend schema
+      @link(
+        url: "https://specs.apollo.dev/federation/v2.3"
+        import: ["@key", "@interfaceObject", "@shareable"]
+      )
+
+    type Account @key(fields: "id") @interfaceObject {
+      id: ID!
+      isActive: Boolean! @shareable
+    }
+  `,
+  resolvers: {
+    Account: {
+      __resolveReference(key: { __typename: string; id: string }) {
+        const account = accounts.find((account) => account.id === key.id);
+
+        if (!account) {
+          return null;
+        }
+
+        return {
+          // I deliberately return a wrong __typename here to make sure it's not used by the gateway
+          __typename: "Never",
+          id: account.id,
+        };
+      },
+      isActive(account: { id: string }) {
+        return false;
+      },
+    },
+    Query: {
+      accounts() {
+        return accounts.map((user) => {
+          return {
+            // I deliberately return a wrong __typename here to make sure it's not used by the gateway
+            __typename: "Never",
+            id: user.id,
+          };
+        });
+      },
+    },
+  },
+});

package/src/test-suites/simple-interface-object/data.ts

@@ -0,0 +1,38 @@
+export const users = [
+  {
+    id: "u1",
+    name: "u1-name",
+    username: "u1-username",
+    age: 11,
+  },
+  {
+    id: "u2",
+    name: "u2-name",
+    username: "u2-username",
+    age: 22,
+  },
+];
+
+export const accounts = [
+  {
+    __typename: "Admin",
+    id: "u1",
+    name: "Alice",
+    isMain: false,
+    isActive: true,
+  },
+  {
+    __typename: "Admin",
+    id: "u2",
+    name: "Bob",
+    isMain: true,
+    isActive: true,
+  },
+  {
+    __typename: "Regular",
+    id: "u3",
+    name: "Charlie",
+    isMain: false,
+    isActive: true,
+  },
+];

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

package/src/test-suites/simple-interface-object/test.ts

@@ -0,0 +1,367 @@
+import { createTest } from "../../testkit.js";
+
+export default [
+  createTest(
+    /* GraphQL */ `
+      query {
+        anotherUsers {
+          id
+          name
+          username
+        }
+      }
+    `,
+    {
+      data: {
+        anotherUsers: [
+          {
+            id: "u1",
+            name: "u1-name",
+            username: "u1-username",
+          },
+          {
+            id: "u2",
+            name: "u2-name",
+            username: "u2-username",
+          },
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        users {
+          id
+          name
+          username
+        }
+      }
+    `,
+    {
+      data: {
+        users: [
+          {
+            id: "u1",
+            name: "u1-name",
+            username: "u1-username",
+          },
+          {
+            id: "u2",
+            name: "u2-name",
+            username: "u2-username",
+          },
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        anotherUsers {
+          ... on User {
+            age
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        anotherUsers: [
+          {
+            age: 11,
+          },
+          {
+            age: 22,
+          },
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        users {
+          ... on User {
+            age
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        users: [
+          {
+            age: 11,
+          },
+          {
+            age: 22,
+          },
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        anotherUsers {
+          ... on User {
+            age
+            id
+            name
+            username
+          }
+          id
+          name
+        }
+      }
+    `,
+    {
+      data: {
+        anotherUsers: [
+          {
+            age: 11,
+            id: "u1",
+            name: "u1-name",
+            username: "u1-username",
+          },
+          {
+            age: 22,
+            id: "u2",
+            name: "u2-name",
+            username: "u2-username",
+          },
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        users {
+          ... on User {
+            age
+            id
+            name
+            username
+          }
+          id
+          name
+        }
+      }
+    `,
+    {
+      data: {
+        users: [
+          {
+            age: 11,
+            id: "u1",
+            name: "u1-name",
+            username: "u1-username",
+          },
+          {
+            age: 22,
+            id: "u2",
+            name: "u2-name",
+            username: "u2-username",
+          },
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        users {
+          ... on User {
+            age
+            id
+            name
+            username
+          }
+          id
+          name
+        }
+      }
+    `,
+    {
+      data: {
+        users: [
+          {
+            age: 11,
+            id: "u1",
+            name: "u1-name",
+            username: "u1-username",
+          },
+          {
+            age: 22,
+            id: "u2",
+            name: "u2-name",
+            username: "u2-username",
+          },
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        accounts {
+          name
+        }
+      }
+    `,
+    {
+      data: {
+        accounts: [
+          {
+            name: "Alice",
+          },
+          {
+            name: "Bob",
+          },
+          {
+            name: "Charlie",
+          },
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        accounts {
+          ... on Admin {
+            name
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        accounts: [
+          {
+            name: "Alice",
+          },
+          {
+            name: "Bob",
+          },
+          {},
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        accounts {
+          name
+          # NOTE
+          # __typename is not available in the interfaceObject, needs to be resolved indirectly
+          __typename
+        }
+      }
+    `,
+    {
+      data: {
+        accounts: [
+          {
+            name: "Alice",
+            __typename: "Admin",
+          },
+          {
+            name: "Bob",
+            __typename: "Admin",
+          },
+          {
+            name: "Charlie",
+            __typename: "Regular",
+          },
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        accounts {
+          ... on Admin {
+            __typename
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        accounts: [
+          {
+            __typename: "Admin",
+          },
+          {
+            __typename: "Admin",
+          },
+          {},
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        accounts {
+          id
+          isActive
+        }
+      }
+    `,
+    {
+      data: {
+        accounts: [
+          {
+            id: "u1",
+            isActive: false,
+          },
+          {
+            id: "u2",
+            isActive: false,
+          },
+          {
+            id: "u3",
+            isActive: false,
+          },
+        ],
+      },
+    },
+  ),
+  createTest(
+    /* GraphQL */ `
+      query {
+        accounts {
+          # NOTE
+          # id is available in the interfaceObject and can be resolved as there's no type condition involved
+          id
+          ... on Admin {
+            isActive
+          }
+        }
+      }
+    `,
+    {
+      data: {
+        accounts: [
+          {
+            id: "u1",
+            isActive: true,
+          },
+          {
+            id: "u2",
+            isActive: true,
+          },
+          {
+            id: "u3",
+          },
+        ],
+      },
+    },
+  ),
+];