Contract root types (#6770)

Author: jdolle

.changeset/fifty-deers-shake.md

@@ -0,0 +1,5 @@
+---
+'hive': patch
+---
+
+Adjust contract logic to allow removing mutation and subscription types

packages/services/schema/src/lib/federation-tag-extraction.spec.ts renamed to packages/services/schema/src/lib/__tests__/federation-tag-extraction.spec.ts

@@ -3,7 +3,7 @@ import {
   applyTagFilterOnSubgraphs,
   applyTagFilterToInaccessibleTransformOnSubgraphSchema,
   type Federation2SubgraphDocumentNodeByTagsFilter,
-} from './federation-tag-extraction';
+} from '../federation-tag-extraction';
 
 describe('applyTagFilterToInaccessibleTransformOnSubgraphSchema', () => {
   describe('correct @inaccessible directive usage based on subgraph version/imports', () => {
@@ -370,6 +370,46 @@ describe('applyTagFilterToInaccessibleTransformOnSubgraphSchema', () => {
       }
     `);
     });
+
+    test('mutation object type is returned in "typesWithAllFieldsInaccessible" if all its fields are excluded', () => {
+      const filter: Federation2SubgraphDocumentNodeByTagsFilter = {
+        include: new Set(),
+        exclude: new Set(['exclude']),
+      };
+      const sdl = parse(/* GraphQL */ `
+        schema @link(url: "https://specs.apollo.dev/federation/v2.0", import: ["@tag"]) {
+          query: Query
+        }
+
+        type Query {
+          field1: String!
+        }
+
+        type Mutation {
+          field1: ID! @tag(name: "exclude")
+        }
+      `);
+
+      const output = applyTagFilterToInaccessibleTransformOnSubgraphSchema(sdl, filter);
+
+      expect(output.typesWithAllFieldsInaccessible.entries().toArray()).toEqual([
+        ['Mutation', true],
+      ]);
+
+      expect(print(output.typeDefs)).toMatchInlineSnapshot(`
+        schema @link(url: "https://specs.apollo.dev/federation/v2.0", import: ["@tag"]) {
+          query: Query
+        }
+
+        type Query {
+          field1: String!
+        }
+
+        type Mutation {
+          field1: ID! @federation__inaccessible
+        }
+      `);
+    });
   });
 
   describe('interface type', () => {

packages/services/schema/src/lib/reachable-type-filter.spec.ts renamed to packages/services/schema/src/lib/__tests__/reachable-type-filter.spec.ts

@@ -1,5 +1,5 @@
 import { parse, print } from 'graphql';
-import { addDirectiveOnTypes, getReachableTypes } from './reachable-type-filter';
+import { addDirectiveOnTypes, getReachableTypes } from '../reachable-type-filter';
 
 describe('getReachableTypes', () => {
   it('includes the query type', () => {

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

@@ -63,34 +63,20 @@ function hasIntersection<T>(a: Set<T>, b: Set<T>): boolean {
   return false;
 }
 
-function getRootTypeNamesFromDocumentNode(document: DocumentNode) {
+function getRootQueryTypeNameFromDocumentNode(document: DocumentNode) {
   let queryName: string | null = 'Query';
-  let mutationName: string | null = 'Mutation';
-  let subscriptionName: string | null = 'Subscription';
 
   for (const definition of document.definitions) {
     if (definition.kind === Kind.SCHEMA_DEFINITION || definition.kind === Kind.SCHEMA_EXTENSION) {
       for (const operationTypeDefinition of definition.operationTypes ?? []) {
         if (operationTypeDefinition.operation === 'query') {
           queryName = operationTypeDefinition.type.name.value;
         }
-        if (operationTypeDefinition.operation === 'mutation') {
-          mutationName = operationTypeDefinition.type.name.value;
-        }
-        if (operationTypeDefinition.operation === 'subscription') {
-          subscriptionName = operationTypeDefinition.type.name.value;
-        }
       }
     }
   }
 
-  const names = new Set<string>();
-
-  names.add(queryName);
-  names.add(mutationName);
-  names.add(subscriptionName);
-
-  return names;
+  return queryName;
 }
 
 type ObjectLikeNode =
@@ -127,7 +113,7 @@ export function applyTagFilterToInaccessibleTransformOnSubgraphSchema(
     tagDirectiveName,
     inaccessibleDirectiveName,
   );
-  const rootTypeNames = getRootTypeNamesFromDocumentNode(documentNode);
+  const rootQueryTypeName = getRootQueryTypeNameFromDocumentNode(documentNode);
 
   const typesWithAllFieldsInaccessibleTracker = new Map<string, boolean>();
 
@@ -355,9 +341,7 @@ export function applyTagFilterToInaccessibleTransformOnSubgraphSchema(
     [Kind.UNION_TYPE_DEFINITION]: scalarAndUnionHandler,
   });
 
-  for (const rootTypeName of rootTypeNames) {
-    typesWithAllFieldsInaccessibleTracker.delete(rootTypeName);
-  }
+  typesWithAllFieldsInaccessibleTracker.delete(rootQueryTypeName);
 
   return {
     typeDefs,