Preparations for [email protected]. (#3712)

* Adjust test to not use deprecated `introspectionQuery` constant. Instead, use `getIntrospectionQuery` instead, which has been around since before [email protected], thus within our supported version ranges. * Adjust documentation links for moved `introspectionQuery` page. This file now lives at `getIntrospectionQuery`. * Applying upstream modification to `printDescription`. I'm assuming we'll want to keep this change which was also applied upstream, though I'm not sure what our longer term plans are for keeping up with these changes. Ref: https://github.com/graphql/graphql-js/pull/2177/files#diff-71ba52e9c625f826d2b0df2963c8633aR320 * Remove empty descriptions which will be included in SDL w/graphql@15. In `graphql@15`, empty descriptions are intentionally included in the SDL output. In order to be excluded entirely, they must be absent (or `null`). Ref: graphql/graphql-js#2177
apollographql · Jan 29, 2020 · 131c9b8 · 131c9b8
1 parent 2ea7c15
commit 131c9b8
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 14 deletions.
diff --git a/docs/source/testing/mocking.md b/docs/source/testing/mocking.md
@@ -187,11 +187,11 @@ server.listen().then(({ url }) => {
 
 ## Mocking a schema using introspection
 
-The GraphQL specification allows clients to introspect the schema with a [special set of types and fields](https://facebook.github.io/graphql/#sec-Introspection) that every schema must include. The results of a [standard introspection query](https://github.com/graphql/graphql-js/blob/master/src/utilities/introspectionQuery.js) can be used to generate an instance of GraphQLSchema which can be mocked as explained above.
+The GraphQL specification allows clients to introspect the schema with a [special set of types and fields](https://facebook.github.io/graphql/#sec-Introspection) that every schema must include. The results of a [standard introspection query](https://github.com/graphql/graphql-js/blob/master/src/utilities/getIntrospectionQuery.js) can be used to generate an instance of GraphQLSchema which can be mocked as explained above.
 
 This helps when you need to mock a schema defined in a language other than JS, for example Go, Ruby, or Python.
 
-To convert an [introspection query](https://github.com/graphql/graphql-js/blob/master/src/utilities/introspectionQuery.js) result to a `GraphQLSchema` object, you can use the `buildClientSchema` utility from the `graphql` package.
+To convert an [introspection query](https://github.com/graphql/graphql-js/blob/master/src/utilities/getIntrospectionQuery.js) result to a `GraphQLSchema` object, you can use the `buildClientSchema` utility from the `graphql` package.
 
 ```js
 const { buildClientSchema } = require('graphql');

diff --git a/packages/apollo-federation/src/directives.ts b/packages/apollo-federation/src/directives.ts
@@ -23,48 +23,40 @@ import {
 
 export const KeyDirective = new GraphQLDirective({
   name: 'key',
-  description: '',
   locations: [DirectiveLocation.OBJECT, DirectiveLocation.INTERFACE],
   args: {
     fields: {
       type: GraphQLNonNull(GraphQLString),
-      description: '',
     },
   },
 });
 
 export const ExtendsDirective = new GraphQLDirective({
   name: 'extends',
-  description: '',
   locations: [DirectiveLocation.OBJECT, DirectiveLocation.INTERFACE],
 });
 
 export const ExternalDirective = new GraphQLDirective({
   name: 'external',
-  description: '',
   locations: [DirectiveLocation.OBJECT, DirectiveLocation.FIELD_DEFINITION],
 });
 
 export const RequiresDirective = new GraphQLDirective({
   name: 'requires',
-  description: '',
   locations: [DirectiveLocation.FIELD_DEFINITION],
   args: {
     fields: {
       type: GraphQLNonNull(GraphQLString),
-      description: '',
     },
   },
 });
 
 export const ProvidesDirective = new GraphQLDirective({
   name: 'provides',
-  description: '',
   locations: [DirectiveLocation.FIELD_DEFINITION],
   args: {
     fields: {
       type: GraphQLNonNull(GraphQLString),
-      description: '',
     },
   },
 });

diff --git a/packages/apollo-federation/src/service/printFederatedSchema.ts b/packages/apollo-federation/src/service/printFederatedSchema.ts
@@ -342,7 +342,7 @@ function printDescription(
     | GraphQLUnionType,
   indentation: string = '',
 ): string {
-  if (!def.description) {
+  if (def.description == null) {
     return '';
   }
 

diff --git a/packages/apollo-federation/src/types.ts b/packages/apollo-federation/src/types.ts
@@ -76,7 +76,6 @@ export const entitiesField: GraphQLFieldConfig<any, any> = {
       type: new GraphQLNonNull(new GraphQLList(new GraphQLNonNull(AnyType))),
     },
   },
-  description: '',
   resolve(_source, { representations }, context, info) {
     return representations.map((reference: { __typename: string } & object) => {
       const { __typename } = reference;

diff --git a/packages/apollo-server-integration-testsuite/src/index.ts b/packages/apollo-server-integration-testsuite/src/index.ts
@@ -10,7 +10,7 @@ import {
   GraphQLError,
   GraphQLNonNull,
   GraphQLScalarType,
-  introspectionQuery,
+  getIntrospectionQuery,
   BREAK,
   DocumentNode,
   getOperationAST,
@@ -620,7 +620,7 @@ export default (createApp: CreateAppFunc, destroyApp?: DestroyAppFunc) => {
         app = await createApp();
         const req = request(app)
           .post('/graphql')
-          .send({ query: introspectionQuery });
+          .send({ query: getIntrospectionQuery() });
         return req.then(res => {
           expect(res.status).toEqual(200);
           expect(res.body.data.__schema.types[0].fields[0].name).toEqual(