fix: dont touch external fields or objects in contract logic (#6903)

Author: jdolle

integration-tests/tests/schema/contracts.spec.ts

@@ -479,3 +479,191 @@ test('inaccessible is not applied on type if at least one type extension has a p
   expect(result.contracts?.[0].errors).toEqual([]);
   expect(result.contracts?.[0].sdl).toContain('type Brr {');
 });
+
+test('@external fields are always included if exclude @tag is used', async () => {
+  const result = await client.composeAndValidate.mutate({
+    type: 'federation',
+    native: true,
+    schemas: [
+      {
+        raw: /* GraphQL */ `
+          extend schema
+            @link(url: "https://specs.apollo.dev/link/v1.0")
+            @link(url: "https://specs.apollo.dev/federation/v2.8", import: ["@key", "@tag"])
+
+          type Query {
+            user: User
+          }
+
+          type User @key(fields: "id") {
+            id: ID!
+            ssn: String @tag(name: "private")
+          }
+        `,
+        source: 'user.graphql',
+        url: 'https://localhost:3000/graphql',
+      },
+      {
+        raw: /* GraphQL */ `
+          extend schema
+            @link(url: "https://specs.apollo.dev/link/v1.0")
+            @link(
+              url: "https://specs.apollo.dev/federation/v2.8"
+              import: ["@key", "@external", "@requires"]
+            )
+
+          type User @key(fields: "id") {
+            id: ID!
+            ssn: String @external
+            creditScore: Int @requires(fields: "ssn")
+          }
+        `,
+        source: 'credit.graphql',
+        url: 'https://localhost:3001/graphql',
+      },
+    ],
+    external: null,
+    contracts: [
+      {
+        id: 'foo',
+        filter: {
+          removeUnreachableTypesFromPublicApiSchema: false,
+          exclude: ['private'],
+          include: null,
+        },
+      },
+    ],
+  });
+
+  expect(result.errors).toEqual([]);
+  expect(result.contracts?.[0].errors).toEqual([]);
+  expect(result.contracts?.[0].sdl).toMatchInlineSnapshot(`
+    type User {
+      id: ID!
+      creditScore: Int
+    }
+
+    type Query {
+      user: User
+    }
+  `);
+});
+
+test('@external fields are always included if include @tag is used', async () => {
+  const result = await client.composeAndValidate.mutate({
+    type: 'federation',
+    native: true,
+    schemas: [
+      {
+        raw: /* GraphQL */ `
+          extend schema
+            @link(url: "https://specs.apollo.dev/link/v1.0")
+            @link(url: "https://specs.apollo.dev/federation/v2.8", import: ["@key", "@tag"])
+
+          type Query {
+            user: User @tag(name: "public")
+          }
+
+          type User @key(fields: "id") {
+            id: ID! @tag(name: "public")
+            ssn: String
+          }
+        `,
+        source: 'user.graphql',
+        url: 'https://localhost:3000/graphql',
+      },
+      {
+        raw: /* GraphQL */ `
+          extend schema
+            @link(url: "https://specs.apollo.dev/link/v1.0")
+            @link(
+              url: "https://specs.apollo.dev/federation/v2.8"
+              import: ["@key", "@external", "@requires", "@tag"]
+            )
+
+          type User @key(fields: "id") {
+            id: ID!
+            ssn: String @external
+            creditScore: Int @requires(fields: "ssn") @tag(name: "public")
+          }
+        `,
+        source: 'credit.graphql',
+        url: 'https://localhost:3001/graphql',
+      },
+    ],
+    external: null,
+    contracts: [
+      {
+        id: 'foo',
+        filter: {
+          removeUnreachableTypesFromPublicApiSchema: false,
+          exclude: null,
+          include: ['public'],
+        },
+      },
+    ],
+  });
+
+  expect(result.errors).toEqual([]);
+  expect(result.contracts?.[0].errors).toEqual([]);
+  expect(result.contracts?.[0].sdl).toMatchInlineSnapshot(`
+    type User {
+      id: ID!
+      creditScore: Int
+    }
+
+    type Query {
+      user: User
+    }
+  `);
+});
+
+test('include with exclude is possible', async () => {
+  const result = await client.composeAndValidate.mutate({
+    type: 'federation',
+    native: true,
+    schemas: [
+      {
+        raw: /* GraphQL */ `
+          extend schema
+            @link(url: "https://specs.apollo.dev/link/v1.0")
+            @link(url: "https://specs.apollo.dev/federation/v2.8", import: ["@key", "@tag"])
+
+          type Query {
+            user: User @tag(name: "public")
+          }
+
+          type User @key(fields: "id") @tag(name: "public") {
+            id: ID!
+            ssn: String @tag(name: "private")
+          }
+        `,
+        source: 'user.graphql',
+        url: 'https://localhost:3000/graphql',
+      },
+    ],
+    external: null,
+    contracts: [
+      {
+        id: 'foo',
+        filter: {
+          removeUnreachableTypesFromPublicApiSchema: false,
+          exclude: ['private'],
+          include: ['public'],
+        },
+      },
+    ],
+  });
+
+  expect(result.errors).toEqual([]);
+  expect(result.contracts?.[0].errors).toEqual([]);
+  expect(result.contracts?.[0].sdl).toMatchInlineSnapshot(`
+    type Query {
+      user: User
+    }
+
+    type User {
+      id: ID!
+    }
+  `);
+});

packages/services/schema/src/lib/federation-tag-extraction.ts

@@ -111,6 +111,10 @@ export function applyTagFilterToInaccessibleTransformOnSubgraphSchema(
     '@inaccessible',
   );
   const tagDirectiveName = resolveImportName('https://specs.apollo.dev/federation', '@tag');
+  const externalDirectiveName = resolveImportName(
+    'https://specs.apollo.dev/federation',
+    '@external',
+  );
 
   function getTagsForSchemaCoordinate(coordinate: string) {
     return tagRegister.get(coordinate) ?? new Set();
@@ -140,6 +144,11 @@ export function applyTagFilterToInaccessibleTransformOnSubgraphSchema(
     fieldLikeNode: InputValueDefinitionNode | FieldDefinitionNode,
     node: InputValueDefinitionNode,
   ) {
+    // Check for external tag because we cannot contribute directives to external fields.
+    if (node.directives?.find(d => d.name.value === externalDirectiveName)) {
+      return node;
+    }
+
     const tagsOnNode = getTagsForSchemaCoordinate(
       `${objectLikeNode.name.value}.${fieldLikeNode.name.value}(${node.name.value}:)`,
     );
@@ -212,6 +221,11 @@ export function applyTagFilterToInaccessibleTransformOnSubgraphSchema(
             } as FieldDefinitionNode;
           }
 
+          // Check for external tag because we cannot contribute directives to external fields.
+          if (fieldNode.directives?.find(d => d.name.value === externalDirectiveName)) {
+            return fieldNode;
+          }
+
           if (
             (filter.include.size && !hasIntersection(tagsOnNode, filter.include)) ||
             (filter.exclude.size && hasIntersection(tagsOnNode, filter.exclude))