Merge pull request #1096 from lennyburdette/schema-directives

fix(subgraph): support `@contact` directive in `printSubgraphSchema`

Author: lennyburdette

federation-integration-testsuite-js/package.json

@@ -18,7 +18,7 @@
   },
   "homepage": "https://github.com/apollographql/federation#readme",
   "dependencies": {
-    "apollo-graphql": "^0.9.3",
+    "apollo-graphql": "^0.9.5",
     "graphql-tag": "^2.10.4"
   }
 }

federation-integration-testsuite-js/src/fixtures/books.ts

@@ -6,6 +6,20 @@ export const url = `https://${name}.api.com`;
 export const typeDefs = gql`
   directive @stream on FIELD
   directive @transform(from: String!) on FIELD
+  directive @contact(
+    name: String!
+    url: String
+    description: String
+  ) on SCHEMA
+
+  schema
+    @contact(
+      name: "books-team"
+      url: "mailto:[email protected]"
+      description: "books"
+    ) {
+    query: Query
+  }
 
   enum CacheControlScope {
     PUBLIC
@@ -18,7 +32,6 @@ export const typeDefs = gql`
     inheritMaxAge: Boolean
   ) on FIELD_DEFINITION | OBJECT | INTERFACE | UNION
 
-
   extend type Query {
     book(isbn: String!): Book
     books: [Book]

federation-js/package.json

@@ -24,7 +24,7 @@
   },
   "dependencies": {
     "@apollo/subgraph": "file:../subgraph-js",
-    "apollo-graphql": "^0.9.3",
+    "apollo-graphql": "^0.9.5",
     "apollo-server-types": "^3.0.2",
     "lodash.xorby": "^4.7.0"
   },

federation-js/src/composition/compose.ts

@@ -21,9 +21,9 @@ import {
 } from 'graphql';
 import { transformSchema } from 'apollo-graphql';
 import {
-  otherKnownDirectives,
-  federationDirectives,
-  isFederationDirective,
+  directivesWithNoDefinitionNeeded,
+  isDirectiveWithNoDefinitionNeeded,
+  directivesWithAutoIncludedDefinitions,
 } from '@apollo/subgraph/dist/directives';
 import {
   findDirectivesOnNode,
@@ -361,10 +361,10 @@ export function buildSchemaFromDefinitionsAndExtensions({
 }) {
   let errors: GraphQLError[] | undefined = undefined;
 
-  // We only want to include the definitions of other known Apollo directives
-  // (currently just @tag) if there are usages.
-  const otherKnownDirectivesToInclude =
-    otherKnownDirectives.filter((directive) =>
+  // We only want to include the definitions of auto-included Apollo directives
+  // (just @tag) if there are usages.
+  const autoIncludedDirectiveDefinitions =
+    directivesWithAutoIncludedDefinitions.filter((directive) =>
       directiveMetadata.hasUsages(directive.name),
     );
 
@@ -386,8 +386,8 @@ export function buildSchemaFromDefinitionsAndExtensions({
       JoinOwnerDirective,
       JoinGraphDirective,
       ...specifiedDirectives,
-      ...federationDirectives,
-      ...otherKnownDirectivesToInclude,
+      ...directivesWithNoDefinitionNeeded,
+      ...autoIncludedDirectiveDefinitions,
     ],
     types: [FieldSetScalar, JoinGraphEnum],
   });
@@ -468,7 +468,9 @@ export function buildSchemaFromDefinitionsAndExtensions({
   schema = new GraphQLSchema({
     ...schema.toConfig(),
     directives: [
-      ...schema.getDirectives().filter((x) => !isFederationDirective(x)),
+      ...schema
+        .getDirectives()
+        .filter((x) => !isDirectiveWithNoDefinitionNeeded(x)),
     ],
   });
 

federation-js/src/composition/validate/preNormalization/tagDirective.ts

@@ -1,5 +1,5 @@
 import {
-  federationDirectives,
+  directivesWithNoDefinitionNeeded,
   directiveDefinitionsAreCompatible,
 } from '@apollo/subgraph/dist/directives';
 import {
@@ -18,7 +18,7 @@ import { errorWithCode, logDirective } from '../../utils';
 // Likely brittle but also will be very obvious if this breaks. Based on the
 // content of the error message itself to remove expected errors related to
 // omitted federation directives.
-const errorsMessagesToFilter = federationDirectives.map(
+const errorsMessagesToFilter = directivesWithNoDefinitionNeeded.map(
   (directive) => `Unknown directive "@${directive.name}".`,
 );
 /**

federation-js/src/service/printSupergraphSdl.ts

@@ -38,7 +38,7 @@ import type {
 import { Maybe } from '../composition';
 import { assert } from '../utilities';
 import { printFieldSet } from '../composition/utils';
-import { otherKnownDirectives } from '@apollo/subgraph/dist/directives';
+
 interface PrintingContext {
   // Apollo addition: we need access to a map from serviceName to its corresponding
   // sanitized / uniquified enum value `Name` from the `join__Graph` enum
@@ -128,24 +128,34 @@ function printSchemaDefinition(schema: GraphQLSchema): string {
   );
 }
 
+type CoreDirectiveMap = Record<
+  string,
+  { feature: string; purpose?: 'EXECUTION' }
+>;
+
+const alwaysIncludedCoreDirectives: CoreDirectiveMap = {
+  core: { feature: 'https://specs.apollo.dev/core/v0.2' },
+  join: { feature: 'https://specs.apollo.dev/join/v0.1', purpose: 'EXECUTION' },
+};
+
+const supportedCoreDirectives: CoreDirectiveMap = {
+  tag: { feature: 'https://specs.apollo.dev/tag/v0.1' },
+};
+
 function printCoreDirectives(schema: GraphQLSchema) {
-  const otherKnownDirectiveNames = otherKnownDirectives.map(
-    ({ name }) => name,
-  );
+  const supportedCoreDirectiveNames = Object.keys(supportedCoreDirectives);
   const schemaDirectiveNames = schema.getDirectives().map(({ name }) => name);
-  const otherKnownDirectivesToInclude = schemaDirectiveNames.filter((name) =>
-    otherKnownDirectiveNames.includes(name),
-  );
-  const otherKnownDirectiveSpecUrls = otherKnownDirectivesToInclude.map(
-    (name) => ({
-      feature: `https://specs.apollo.dev/${name}/v0.1`,
-    }),
+  const supportedCoreDirectiveNamesToInclude = schemaDirectiveNames.filter((name) =>
+    supportedCoreDirectiveNames.includes(name),
   );
+  const supportedCoreDirectivesToInclude =
+    supportedCoreDirectiveNamesToInclude.map(
+      (name) => supportedCoreDirectives[name],
+    );
 
   return [
-    { feature: 'https://specs.apollo.dev/core/v0.2' },
-    { feature: 'https://specs.apollo.dev/join/v0.1', purpose: 'EXECUTION' },
-    ...otherKnownDirectiveSpecUrls,
+    ...Object.values(alwaysIncludedCoreDirectives),
+    ...supportedCoreDirectivesToInclude,
   ].map(
     ({ feature, purpose }) =>
       `\n  @core(feature: ${printStringLiteral(feature)}${

gateway-js/CHANGELOG.md

@@ -4,7 +4,7 @@
 
 > The changes noted within this `vNEXT` section have not been released yet.  New PRs and commits which introduce changes should include an entry in this `vNEXT` section as part of their development.  When a release is being prepared, a new header will be (manually) created below and the appropriate changes within that release will be moved into the new section.
 
-- _Nothing yet. Stay tuned._
+- Print `@contact` directive in `printSubgraphSchema` [PR #1096](https://github.com/apollographql/federation/pull/1096)
 
 ## v0.44.0
 

gateway-js/package.json

@@ -30,7 +30,7 @@
     "@apollo/query-planner": "file:../query-planner-js",
     "@opentelemetry/api": "^1.0.1",
     "@types/node-fetch": "2.5.12",
-    "apollo-graphql": "^0.9.3",
+    "apollo-graphql": "^0.9.5",
     "apollo-reporting-protobuf": "^0.8.0 || ^3.0.0",
     "apollo-server-caching": "^0.7.0 || ^3.0.0",
     "apollo-server-core": "^2.23.0 || ^3.0.0",

package-lock.json

@@ -25,7 +25,7 @@
     "access": "public"
   },
   "dependencies": {
-    "apollo-graphql": "^0.9.3",
+    "apollo-graphql": "^0.9.5",
     "chalk": "^4.1.0",
     "deep-equal": "^2.0.5",
     "pretty-format": "^26.0.0"

query-planner-js/package.json

@@ -24,7 +24,7 @@
     "access": "public"
   },
   "dependencies": {
-    "apollo-graphql": "^0.9.3"
+    "apollo-graphql": "^0.9.5"
   },
   "peerDependencies": {
     "graphql": "^15.5.3"

subgraph-js/package.json

@@ -176,4 +176,60 @@ describe('printSubgraphSchema', () => {
       "
     `);
   });
+
+  it('prints directives on schema definition nodes', () => {
+    const schema = buildSubgraphSchema(fixtures[1].typeDefs);
+    expect(printSubgraphSchema(schema)).toMatchInlineSnapshot(`
+      "schema @contact(name: \\"books-team\\", url: \\"mailto:[email protected]\\", description: \\"books\\") {
+        query: Query
+      }
+
+      directive @stream on FIELD
+
+      directive @transform(from: String!) on FIELD
+
+      directive @contact(name: String!, url: String, description: String) on SCHEMA
+
+      directive @cacheControl(maxAge: Int, scope: CacheControlScope, inheritMaxAge: Boolean) on FIELD_DEFINITION | OBJECT | INTERFACE | UNION
+
+      enum CacheControlScope {
+        PUBLIC
+        PRIVATE
+      }
+
+      type Library @key(fields: \\"id\\") {
+        id: ID!
+        name: String
+      }
+
+      type Book @key(fields: \\"isbn\\") {
+        isbn: String!
+        title: String
+        year: Int
+        similarBooks: [Book]!
+        metadata: [MetadataOrError]
+      }
+
+      type KeyValue {
+        key: String!
+        value: String!
+      }
+
+      type Error {
+        code: Int
+        message: String
+      }
+
+      union MetadataOrError = KeyValue | Error
+
+      extend type Query {
+        _entities(representations: [_Any!]!): [_Entity]!
+        _service: _Service!
+        book(isbn: String!): Book
+        books: [Book]
+        library(id: ID!): Library
+      }
+      "
+    `);
+  });
 });

subgraph-js/src/__tests__/printSubgraphSchema.test.ts

@@ -16,7 +16,7 @@ import {
   addResolversToSchema,
   GraphQLResolverMap,
 } from 'apollo-graphql';
-import { federationDirectives, typeIncludesDirective } from './directives';
+import { directivesWithNoDefinitionNeeded, typeIncludesDirective } from './directives';
 
 import { serviceField, entitiesField, EntityType } from './types';
 
@@ -66,7 +66,7 @@ export function buildSubgraphSchema(
     modules,
     new GraphQLSchema({
       query: undefined,
-      directives: [...specifiedDirectives, ...federationDirectives],
+      directives: [...specifiedDirectives, ...directivesWithNoDefinitionNeeded],
     }),
   );