Federation Compatibility Test Suite: Successful Parts (#6071)

* Federation Compatibility Test Suite

* Fixes

* More tests

* Fixes and more tests

* Cleanup code

* Do not download the tests

* More

* Go

Author: ardatan

.changeset/great-wasps-jog.md

@@ -0,0 +1,5 @@
+---
+"@graphql-tools/federation": patch
+---
+
+Handle inaccessible enum values

.prettierignore

@@ -19,6 +19,7 @@ packages/load/tests/loaders/schema/test-files/error.ts
 packages/load/tests/loaders/schema/test-files/schema-dir/invalid.graphql
 packages/loaders/git/tests/test-files/type-defs-invalid.graphql
 packages/loaders/json-file/tests/test-files/failing/malformed.json
+packages/federation/test/fixtures/federation-compatibility/*
 .next/
 .bob/
 CHANGELOG.md

package.json

@@ -32,6 +32,7 @@
     "build:api-docs": "ts-node --transpileOnly --compiler-options='{\"module\":\"commonjs\"}' scripts/build-api-docs",
     "ci:lint": "cross-env \"ESLINT_USE_FLAT_CONFIG=false\" eslint --ext .ts . --output-file eslint_report.json --format json",
     "clean-dist": "rimraf \"packages/**/dist\" && rimraf \".bob\"",
+    "fetch-federation-tests": "ts-node --transpileOnly --compiler-options='{\"module\":\"commonjs\"}' scripts/fetch-federation-tests",
     "lint": "cross-env \"ESLINT_USE_FLAT_CONFIG=false\" eslint --ext .ts .",
     "postinstall": "patch-package && husky install",
     "prerelease": "yarn build",

packages/delegate/src/Subschema.ts

@@ -21,6 +21,7 @@ interface ISubschema<K = any, V = any, C = K, TContext = Record<string, any>>
 export class Subschema<K = any, V = any, C = K, TContext = Record<string, any>>
   implements ISubschema<K, V, C, TContext>
 {
+  public name?: string;
   public schema: GraphQLSchema;
 
   public executor?: Executor<TContext>;
@@ -34,6 +35,7 @@ export class Subschema<K = any, V = any, C = K, TContext = Record<string, any>>
   public merge?: Record<string, MergedTypeConfig<any, any, TContext>>;
 
   constructor(config: SubschemaConfig<K, V, C, TContext>) {
+    this.name = config.name;
     this.schema = config.schema;
 
     this.executor = config.executor;

packages/delegate/src/types.ts

@@ -151,6 +151,7 @@ export interface BatchingOptions<K = any, V = any, C = K> {
 }
 
 export interface SubschemaConfig<K = any, V = any, C = K, TContext = Record<string, any>> {
+  name?: string;
   schema: GraphQLSchema;
   createProxyingResolver?: CreateProxyingResolverFn<TContext>;
   rootValue?: any;

packages/federation/src/supergraph.ts

@@ -139,7 +139,8 @@ export function getSubschemasFromSupergraphSdl({
           const fieldDefinitionNodesOfSubgraph: FieldDefinitionNode[] = [];
           typeNode.fields?.forEach(fieldNode => {
             const joinFieldDirectives = fieldNode.directives?.filter(
-              directiveNode => directiveNode.name.value === 'join__field',
+              directiveNode =>
+                directiveNode.name.value === 'join__field' && directiveNode.arguments?.length,
             );
             let notInSubgraph = true;
             joinFieldDirectives?.forEach(joinFieldDirectiveNode => {
@@ -691,6 +692,7 @@ export function getSubschemasFromSupergraphSdl({
       };
     }
     subschemaMap.set(subgraphName, {
+      name: subgraphName,
       schema,
       executor,
       merge: mergeConfig,

packages/federation/src/utils.ts

@@ -10,6 +10,9 @@ export function getKeyForFederation<TRoot>(root: TRoot): TRoot {
 }
 
 export function getKeyFnForFederation(typeName: string, keys: string[]) {
+  if (keys.some(key => key.includes('{'))) {
+    return getKeyForFederation;
+  }
   const allKeyProps = keys.flatMap(key => key.split(' '));
   if (allKeyProps.length > 1) {
     const typeNameEntry = ['__typename', typeName];
@@ -27,6 +30,11 @@ export function getKeyFnForFederation(typeName: string, keys: string[]) {
 }
 
 export function getCacheKeyFnFromKey(key: string) {
+  if (key.includes('{')) {
+    return function cacheKeyFn(root: any) {
+      return JSON.stringify(root);
+    };
+  }
   const keyProps = key.split(' ');
   if (keyProps.length > 1) {
     return function cacheKeyFn(root: any) {
@@ -60,6 +68,17 @@ export function filterInternalFieldsAndTypes(finalSchema: GraphQLSchema) {
       }
       return fieldConfig;
     },
+    [MapperKind.ENUM_VALUE]: valueConfig => {
+      if (valueConfig.astNode?.directives?.some(d => d.name.value === 'inaccessible')) {
+        return null;
+      }
+    },
+    [MapperKind.ARGUMENT]: argConfig => {
+      if (argConfig.astNode?.directives?.some(d => d.name.value === 'inaccessible')) {
+        return null;
+      }
+      return argConfig;
+    },
   });
 }
 

packages/federation/test/federation-compatibility.test.ts

@@ -0,0 +1,57 @@
+import { readdirSync, readFileSync } from 'fs';
+import { join } from 'path';
+import { parse, validate } from 'graphql';
+import { normalizedExecutor } from '@graphql-tools/executor';
+import { getStitchedSchemaFromSupergraphSdl } from '../src/supergraph';
+
+describe('Federation Compatibility', () => {
+  const fixturesDir = join(__dirname, 'fixtures', 'federation-compatibility');
+  readdirSync(fixturesDir).forEach(supergraphName => {
+    describe(supergraphName, () => {
+      const supergraphFixturesDir = join(fixturesDir, supergraphName);
+      const stitchedSchema = getStitchedSchemaFromSupergraphSdl({
+        supergraphSdl: readFileSync(join(supergraphFixturesDir, 'supergraph.graphql'), 'utf-8'),
+      });
+      const tests: { query: string; expected: any }[] = JSON.parse(
+        readFileSync(join(supergraphFixturesDir, 'tests.json'), 'utf-8'),
+      );
+      tests.forEach((test, i) => {
+        it(`test-query-${i}`, async () => {
+          let result;
+          const document = parse(test.query, { noLocation: true });
+          const validationErrors = validate(stitchedSchema, document);
+          if (validationErrors.length > 0) {
+            result = { errors: validationErrors };
+          } else {
+            result = await normalizedExecutor({
+              schema: stitchedSchema,
+              document,
+            });
+          }
+
+          if (test.expected.errors === true) {
+            if (test.expected.data) {
+              expect(result).toMatchObject({
+                data: test.expected.data,
+                errors: expect.any(Array),
+              });
+            } else {
+              expect(result).toMatchObject({
+                errors: expect.any(Array),
+              });
+            }
+          } else {
+            if ('errors' in result && result.errors) {
+              for (const error of result.errors) {
+                console.error(error.message);
+              }
+            }
+            expect(result).toMatchObject({
+              data: test.expected.data,
+            });
+          }
+        });
+      });
+    });
+  });
+});

packages/federation/test/fixtures/federation-compatibility/entity-and-no-entity/supergraph.graphql

@@ -0,0 +1,70 @@
+schema
+  @link(url: "https://specs.apollo.dev/link/v1.0")
+  @link(url: "https://specs.apollo.dev/join/v0.3", for: EXECUTION)
+{
+  query: Query
+}
+
+directive @join__enumValue(graph: join__Graph!) repeatable on ENUM_VALUE
+
+directive @join__field(graph: join__Graph, requires: join__FieldSet, provides: join__FieldSet, type: String, external: Boolean, override: String, usedOverridden: Boolean) repeatable on FIELD_DEFINITION | INPUT_FIELD_DEFINITION
+
+directive @join__graph(name: String!, url: String!) on ENUM_VALUE
+
+directive @join__implements(graph: join__Graph!, interface: String!) repeatable on OBJECT | INTERFACE
+
+directive @join__type(graph: join__Graph!, key: join__FieldSet, extension: Boolean! = false, resolvable: Boolean! = true, isInterfaceObject: Boolean! = false) repeatable on OBJECT | INTERFACE | UNION | ENUM | INPUT_OBJECT | SCALAR
+
+directive @join__unionMember(graph: join__Graph!, member: String!) repeatable on UNION
+
+directive @link(url: String, as: String, for: link__Purpose, import: [link__Import]) repeatable on SCHEMA
+
+union Account
+  @join__type(graph: B)
+  @join__unionMember(graph: B, member: "User")
+  @join__unionMember(graph: B, member: "Admin")
+ = User | Admin
+
+type Admin
+  @join__type(graph: B)
+{
+  id: ID
+  photo: String
+}
+
+scalar join__FieldSet
+
+enum join__Graph {
+  A @join__graph(name: "a", url: "https://federation-compatibility.theguild.workers.dev/entity-and-no-entity/a")
+  B @join__graph(name: "b", url: "https://federation-compatibility.theguild.workers.dev/entity-and-no-entity/b")
+}
+
+scalar link__Import
+
+enum link__Purpose {
+  """
+  `SECURITY` features provide metadata necessary to securely resolve fields.
+  """
+  SECURITY
+
+  """
+  `EXECUTION` features provide metadata necessary for operation execution.
+  """
+  EXECUTION
+}
+
+type Query
+  @join__type(graph: A)
+  @join__type(graph: B)
+{
+  users: [User!]! @join__field(graph: A)
+  accounts: [Account!]! @join__field(graph: B)
+}
+
+type User
+  @join__type(graph: A)
+  @join__type(graph: B, key: "id")
+{
+  id: ID @join__field(graph: A, type: "ID") @join__field(graph: B, type: "ID!")
+  name: String @join__field(graph: B)
+}

packages/federation/test/fixtures/federation-compatibility/entity-and-no-entity/tests.json

@@ -0,0 +1,25 @@
+[
+  {
+    "query": "\n      query {\n        users {\n          id\n          name\n        }\n        accounts {\n          ... on User {\n            id\n            name\n          }\n          ... on Admin {\n            id\n            photo\n          }\n        }\n      }\n    ",
+    "expected": {
+      "data": {
+        "users": [
+          {
+            "id": "n1",
+            "name": "n1-profile"
+          }
+        ],
+        "accounts": [
+          {
+            "id": "n1",
+            "name": "n1-profile"
+          },
+          {
+            "id": "a1",
+            "photo": "a1-photo"
+          }
+        ]
+      }
+    }
+  }
+]