fix: retain stitching sdl directives on schema definition nodes (#8094)

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Author: jdolle

.changeset/easy-emus-move.md

@@ -0,0 +1,5 @@
+---
+'hive': patch
+---
+
+Include directives in output SDL for schema stitching projects

integration-tests/fixtures/schema-with-directives.graphql

@@ -0,0 +1,5 @@
+directive @public on SCHEMA | OBJECT
+
+type Query @public {
+  isAnExample: Boolean
+}

integration-tests/tests/cli/__snapshots__/schema.spec.ts.snap

@@ -92,14 +92,6 @@ stdout--------------------------------------------:
 ℹ Available at http://__URL__
 `;
 
-exports[`FEDERATION > can update a service without providing a url if previously published > schemaPublish (initial) 1`] = `
-:::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::
-
-stdout--------------------------------------------:
-✔ Published initial schema.
-ℹ Available at http://__URL__
-`;
-
 exports[`FEDERATION > can update the service url and show it in comparison query > schemaPublish (initial) 1`] = `
 :::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::
 
@@ -361,103 +353,6 @@ stdout--------------------------------------------:
 ℹ Available at http://__URL__
 `;
 
-exports[`SINGLE > can update a service without providing a url if previously published > schema publish initial 1`] = `
-:::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::
-
-stdout--------------------------------------------:
-✔ Published initial schema.
-ℹ Available at http://__URL__
-`;
-
-exports[`SINGLE > can update a service without providing a url if previously published > schema publish same url 1`] = ``;
-
-exports[`SINGLE > can update a service without providing a url if previously published > schemaPublish (initial) 1`] = `
-:::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::
-
-stdout--------------------------------------------:
-✔ Published initial schema.
-ℹ Available at http://__URL__
-`;
-
-exports[`SINGLE > check validates the service name > onlyNumbers 1`] = `
-:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
-exitCode------------------------------------------:
-1
-stderr--------------------------------------------:
-__NONE__
-stdout--------------------------------------------:
-✖ Detected 1 error
-
-   - Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), underscore (_), or forward slash (/).
-
-
-`;
-
-exports[`SINGLE > check validates the service name > specialCharacters 1`] = `
-:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
-exitCode------------------------------------------:
-1
-stderr--------------------------------------------:
-__NONE__
-stdout--------------------------------------------:
-✖ Detected 1 error
-
-   - Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), underscore (_), or forward slash (/).
-
-
-`;
-
-exports[`SINGLE > check validates the service name > success 1`] = `
-:::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::
-
-stdout--------------------------------------------:
-✔ Schema registry is empty, nothing to compare your schema with.
-View full report:
-http://__URL__
-`;
-
-exports[`SINGLE > publish validates the service name > onlyNumbers 1`] = `
-:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
-exitCode------------------------------------------:
-2
-stderr--------------------------------------------:
- ›   Error: Schema publish failed.  [300]
- ›   > See https://__URL__ for
- ›    a complete list of error codes and recommended fixes.
- ›   To disable this message set HIVE_NO_ERROR_TIP=1
-stdout--------------------------------------------:
-✖ Detected 1 error
-
-   - Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), underscore (_), or forward slash (/).
-
-
-`;
-
-exports[`SINGLE > publish validates the service name > specialCharacters 1`] = `
-:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
-exitCode------------------------------------------:
-2
-stderr--------------------------------------------:
- ›   Error: Schema publish failed.  [300]
- ›   > See https://__URL__ for
- ›    a complete list of error codes and recommended fixes.
- ›   To disable this message set HIVE_NO_ERROR_TIP=1
-stdout--------------------------------------------:
-✖ Detected 1 error
-
-   - Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), underscore (_), or forward slash (/).
-
-
-`;
-
-exports[`SINGLE > publish validates the service name > success 1`] = `
-:::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::
-
-stdout--------------------------------------------:
-✔ Published initial schema.
-ℹ Available at http://__URL__
-`;
-
 exports[`SINGLE > publishing invalid schema SDL provides meaningful feedback for the user. > schemaPublish 1`] = `
 :::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
 exitCode------------------------------------------:
@@ -629,24 +524,6 @@ stdout--------------------------------------------:
 ℹ Available at http://__URL__
 `;
 
-exports[`STITCHING > can update a service without providing a url if previously published > schema publish initial 1`] = `
-:::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::
-
-stdout--------------------------------------------:
-✔ Published initial schema.
-ℹ Available at http://__URL__
-`;
-
-exports[`STITCHING > can update a service without providing a url if previously published > schema publish same url 1`] = ``;
-
-exports[`STITCHING > can update a service without providing a url if previously published > schemaPublish (initial) 1`] = `
-:::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::
-
-stdout--------------------------------------------:
-✔ Published initial schema.
-ℹ Available at http://__URL__
-`;
-
 exports[`STITCHING > can update the service url and show it in comparison query > schemaPublish (initial) 1`] = `
 :::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::
 

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

@@ -526,6 +526,47 @@ describe.each([ProjectType.Stitching, ProjectType.Federation, ProjectType.Single
       },
     );
 
+    test
+      /** federation relies on composeDirective which we don't test here */
+      .skipIf(projectType === ProjectType.Federation)
+      .concurrent(
+        'schema:fetch sdl includes directives on the schema definition',
+        async ({ expect }) => {
+          const { createOrg } = await initSeed().createOwner();
+          const { inviteAndJoinMember, createProject } = await createOrg();
+          await inviteAndJoinMember();
+          const { createTargetAccessToken } = await createProject(projectType);
+          const { secret, latestSchema } = await createTargetAccessToken({});
+
+          const cli = createCLI({
+            readonly: secret,
+            readwrite: secret,
+          });
+
+          await schemaPublish([
+            '--registry.accessToken',
+            secret,
+            '--author',
+            'Kamil',
+            '--commit',
+            'abc123',
+            ...serviceNameArgs,
+            ...serviceUrlArgs,
+            'fixtures/schema-with-directives.graphql',
+          ]);
+
+          const schema = await latestSchema();
+          const fetchCmd = cli.fetch({
+            type: 'sdl',
+            commit: 'abc123',
+          });
+          expect(schema.latestVersion?.sdl).toIncludeSubstringWithoutWhitespace(
+            'type Query @public',
+          );
+          await expect(fetchCmd).resolves.toIncludeSubstringWithoutWhitespace('type Query @public');
+        },
+      );
+
     test.concurrent(
       'schema:fetch can fetch a latest schema with target:registry:read access',
       async ({ expect }) => {

packages/services/schema/package.json

@@ -13,6 +13,7 @@
     "@graphql-tools/merge": "9.1.1",
     "@graphql-tools/stitch": "9.4.29",
     "@graphql-tools/stitching-directives": "3.1.38",
+    "@graphql-tools/utils": "11.1.0",
     "@hive/service-common": "workspace:*",
     "@sentry/node": "7.120.2",
     "@theguild/federation-composition": "0.22.3",

packages/services/schema/src/composition/stitching.ts

@@ -5,13 +5,13 @@ import {
   GraphQLSchema,
   Kind,
   parse,
-  printSchema,
   validateSchema,
 } from 'graphql';
 import { validateSDL } from 'graphql/validation/validate.js';
 import { stitchSchemas } from '@graphql-tools/stitch';
 import { stitchingDirectives } from '@graphql-tools/stitching-directives';
 import { errorWithSource, toValidationError } from '../lib/errors';
+import { printCleanSchema } from '../lib/print-clean-schema';
 import { trimDescriptions } from '../lib/trim-descriptions';
 import type { ComposeAndValidateInput } from '../types';
 import type { CompositionErrorType } from './shared';
@@ -86,7 +86,7 @@ export async function composeStitching(args: ComposeStitchingArgs) {
           }),
         ),
       });
-      sdl = printSchema(stitchedSchema);
+      sdl = printCleanSchema(stitchedSchema);
     } catch (error) {
       errors.push(toValidationError(error, 'composition'));
     }

packages/services/schema/src/lib/print-clean-schema.ts

@@ -0,0 +1,32 @@
+import { GraphQLSchema, Kind, print } from 'graphql';
+import { getDocumentNodeFromSchema } from '@graphql-tools/utils';
+
+/** Prints the SDL but excludes the schema definition if it is the standard definition */
+export function printCleanSchema(schema: GraphQLSchema): string {
+  const documentNode = getDocumentNodeFromSchema(schema);
+
+  const filteredDefinitions = documentNode.definitions.filter(node => {
+    if (node.kind === Kind.SCHEMA_DEFINITION) {
+      const hasDirectives = node.directives && node.directives.length > 0;
+      const hasDescription = !!node.description;
+
+      const isStandardDefinition = node.operationTypes.every(op => {
+        if (op.operation === 'query' && op.type.name.value === 'Query') return true;
+        if (op.operation === 'mutation' && op.type.name.value === 'Mutation') return true;
+        if (op.operation === 'subscription' && op.type.name.value === 'Subscription') return true;
+        return false;
+      });
+
+      // Omit the block only if it has no directives/descriptions and uses standard names
+      if (!hasDirectives && !hasDescription && isStandardDefinition) {
+        return false;
+      }
+    }
+    return true;
+  });
+
+  return print({
+    ...documentNode,
+    definitions: filteredDefinitions,
+  });
+}