Move snapshot serializers and matchers to federaton-integration-tests…

…uite

Snapshot serializers were duplicated in `@apollo/federation` and `@apollo/gateway`. This moves both the snapshot serializers and the matchers to `apollo-federaton-integration-testsuite` (we may want to rename that package).

I temporarily disabled the option for the gateway to include the pretty printed query plan under `__queryPlanExperimental` (which is used to show the query plan in the Playground we ship with Apollo Server), because this lead to a circular dependency between `@apollo/gateway` and apollo-federaton-integration-testsuite`. We should either solve that or switch Playground to use the JSON serialization format for the query plan.

federation-integration-testsuite-js/src/index.ts

@@ -1 +1,5 @@
+export * from './matchers';
+export * from './snapshotSerializers';
 export * from './fixtures';
+
+export { prettyFormatQueryPlan } from './prettyFormatQueryPlan';

federation-integration-testsuite-js/src/matchers/index.ts

@@ -0,0 +1,4 @@
+import './toCallService';
+import './toHaveBeenCalledBefore';
+import './toHaveFetched';
+import './toMatchAST';

gateway-js/src/__tests__/matchers/toCallService.ts → federation-integration-testsuite-js/src/matchers/toCallService.ts

@@ -1,7 +1,6 @@
-import { QueryPlan } from '@apollo/gateway';
-import { PlanNode } from '../../QueryPlan';
-import astSerializer from '../../snapshotSerializers/astSerializer';
-import queryPlanSerializer from '../../snapshotSerializers/queryPlanSerializer';
+import { QueryPlan, PlanNode } from '@apollo/gateway';
+import astSerializer from '../snapshotSerializers/astSerializer';
+import queryPlanSerializer from '../snapshotSerializers/queryPlanSerializer';
 const prettyFormat = require('pretty-format');
 
 declare global {

gateway-js/src/__tests__/matchers/toHaveFetched.ts → federation-integration-testsuite-js/src/matchers/toHaveFetched.ts

@@ -15,8 +15,8 @@ function prepareHttpOptions(requestUrl: string, requestOpts: RequestInit): Reque
   const headers = new Headers();
   headers.set('Content-Type', 'application/json');
   if (requestOpts.headers) {
-    for (let name in requestOpts.headers) {
-      headers.set(name, requestOpts.headers[name]);
+    for (const [name, value] of new Headers(requestOpts.headers)) {
+      headers.set(name, value);
     }
   }
 

federation-integration-testsuite-js/src/prettyFormatQueryPlan.ts

@@ -0,0 +1,9 @@
+import { QueryPlan } from '@apollo/gateway';
+import prettyFormat from 'pretty-format';
+import { astSerializer, queryPlanSerializer } from './snapshotSerializers';
+
+export function prettyFormatQueryPlan(queryPlan: QueryPlan) {
+  return prettyFormat(queryPlan, {
+    plugins: [queryPlanSerializer, astSerializer],
+  });
+}

gateway-js/src/snapshotSerializers/astSerializer.ts → federation-integration-testsuite-js/src/snapshotSerializers/astSerializer.ts

@@ -1,6 +1,6 @@
 import { ASTNode, print, Kind, visit } from 'graphql';
 import { Plugin, Config, Refs } from 'pretty-format';
-import { QueryPlanSelectionNode, QueryPlanInlineFragmentNode } from '../QueryPlan';
+import { QueryPlanSelectionNode, QueryPlanInlineFragmentNode } from '@apollo/gateway';
 import { SelectionNode as GraphQLJSSelectionNode } from 'graphql';
 
 export default {
@@ -18,7 +18,6 @@ export default {
   ): string {
     return print(remapInlineFragmentNodes(value))
       .trim()
-      .replace(/\n\n/g, '\n')
       .replace(/\n/g, '\n' + indentation);
   },
 } as Plugin;

federation-js/src/snapshotSerializers/index.ts → federation-integration-testsuite-js/src/snapshotSerializers/index.ts

@@ -2,6 +2,7 @@ export { default as astSerializer } from './astSerializer';
 export { default as selectionSetSerializer } from './selectionSetSerializer';
 export { default as typeSerializer } from './typeSerializer';
 export { default as graphqlErrorSerializer } from './graphqlErrorSerializer';
+export { default as queryPlanSerializer } from './queryPlanSerializer';
 
 declare global {
   namespace jest {

gateway-js/src/snapshotSerializers/queryPlanSerializer.ts → federation-integration-testsuite-js/src/snapshotSerializers/queryPlanSerializer.ts

@@ -1,5 +1,5 @@
 import { Config, Plugin, Refs } from 'pretty-format';
-import { PlanNode, QueryPlan } from '../QueryPlan';
+import { PlanNode, QueryPlan } from '@apollo/gateway';
 import { parse, Kind, visit, DocumentNode } from 'graphql';
 
 export default {

federation-integration-testsuite-js/tsconfig.json

@@ -3,11 +3,11 @@
   "compilerOptions": {
     "rootDir": "./src",
     "outDir": "./dist",
-    "noImplicitAny": false,
-    "strictNullChecks": false,
     "types": ["node", "jest"]
   },
   "include": ["src/**/*"],
   "exclude": ["**/__tests__"],
-  "references": []
+  "references": [
+    { "path": "../gateway-js" }
+  ]
 }

federation-js/src/composition/__tests__/compose.test.ts

@@ -9,7 +9,7 @@ import {
   astSerializer,
   typeSerializer,
   selectionSetSerializer,
-} from '../../snapshotSerializers';
+} from 'apollo-federation-integration-testsuite';
 import { normalizeTypeDefs } from '../normalize';
 import {
   assertCompositionFailure,

federation-js/src/composition/__tests__/composeAndValidate.test.ts

@@ -11,7 +11,7 @@ import {
   astSerializer,
   typeSerializer,
   graphqlErrorSerializer,
-} from '../../snapshotSerializers';
+} from 'apollo-federation-integration-testsuite';
 import {
   assertCompositionFailure,
   assertCompositionSuccess,

federation-js/src/composition/__tests__/normalize.test.ts

@@ -5,7 +5,7 @@ import {
   normalizeTypeDefs,
   stripCommonPrimitives,
 } from '../normalize';
-import { astSerializer } from '../../snapshotSerializers';
+import { astSerializer } from 'apollo-federation-integration-testsuite';
 import { specifiedDirectives } from 'graphql';
 
 expect.addSnapshotSerializer(astSerializer);

federation-js/src/composition/__tests__/utils.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import deepFreeze from 'deep-freeze';
 import { stripExternalFieldsFromTypeDefs } from '../utils';
-import { astSerializer } from '../../snapshotSerializers';
+import { astSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(astSerializer);
 

federation-js/src/composition/validate/postComposition/__tests__/executableDirectivesIdentical.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import { composeServices } from '../../../compose';
 import { executableDirectivesIdentical } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/postComposition/__tests__/executableDirectivesInAllServices.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import { composeServices } from '../../../compose';
 import { executableDirectivesInAllServices } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/postComposition/__tests__/externalMissingOnBase.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import { composeServices } from '../../../compose';
 import { externalMissingOnBase as validateExternalMissingOnBase } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/postComposition/__tests__/externalTypeMismatch.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import { externalTypeMismatch as validateExternalTypeMismatch } from '../';
 import { composeServices } from '../../../compose';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/postComposition/__tests__/externalUnused.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import { composeServices } from '../../../compose';
 import { externalUnused as validateExternalUnused } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/postComposition/__tests__/keyFieldsMissingOnBase.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import { composeServices } from '../../../compose';
 import { keyFieldsMissingOnBase as validateKeyFieldsMissingOnBase } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 import { assertCompositionSuccess } from '../../../utils';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);

federation-js/src/composition/validate/postComposition/__tests__/keyFieldsSelectInvalidType.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import { composeServices } from '../../../compose';
 import { keyFieldsSelectInvalidType as validateKeyFieldsSelectInvalidType } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 import { assertCompositionSuccess } from '../../../utils';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);

federation-js/src/composition/validate/postComposition/__tests__/keysMatchBaseService.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import { composeServices } from '../../../compose';
 import { keysMatchBaseService as validateKeysMatchBaseService } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 import { assertCompositionSuccess } from '../../../utils';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);

federation-js/src/composition/validate/postComposition/__tests__/providesFieldsMissingExternals.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import { composeServices } from '../../../compose';
 import { providesFieldsMissingExternal as validateProdivesFieldsMissingExternal } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 import { assertCompositionSuccess } from '../../../utils';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);

federation-js/src/composition/validate/postComposition/__tests__/providesFieldsSelectInvalidType.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import { composeServices } from '../../../compose';
 import { providesFieldsSelectInvalidType as validateprovidesFieldsSelectInvalidType } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 import { assertCompositionSuccess } from '../../../utils';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);

federation-js/src/composition/validate/postComposition/__tests__/providesNotOnEntity.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import { composeServices } from '../../../compose';
 import { providesNotOnEntity as validateProvidesNotOnEntity } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/postComposition/__tests__/requiresFieldsMissingExternals.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import { composeServices } from '../../../compose';
 import { requiresFieldsMissingExternal as validateRequiresFieldsMissingExternal } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/postComposition/__tests__/requiresFieldsMissingOnBase.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import { composeServices } from '../../../compose';
 import { requiresFieldsMissingOnBase as validateRequiresFieldsMissingOnBase } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/preComposition/__tests__/duplicateEnumOrScalar.test.ts

@@ -1,6 +1,6 @@
 import gql from 'graphql-tag';
 import { duplicateEnumOrScalar as validateDuplicateEnumOrScalar } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/preComposition/__tests__/duplicateEnumValue.test.ts

@@ -1,6 +1,6 @@
 import gql from 'graphql-tag';
 import { duplicateEnumValue as validateDuplicateEnumValue } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/preComposition/__tests__/externalUsedOnBase.test.ts

@@ -1,6 +1,6 @@
 import gql from 'graphql-tag';
 import { externalUsedOnBase as validateExternalUsedOnBase } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/preComposition/__tests__/keyFieldsMissingExternal.test.ts

@@ -1,6 +1,6 @@
 import gql from 'graphql-tag';
 import { keyFieldsMissingExternal as validateKeyFieldsMissingExternal } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/preComposition/__tests__/requiresUsedOnBase.test.ts

@@ -1,6 +1,6 @@
 import gql from 'graphql-tag';
 import { requiresUsedOnBase as validateRequiresUsedOnBase } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/preComposition/__tests__/reservedFieldUsed.test.ts

@@ -1,6 +1,6 @@
 import gql from 'graphql-tag';
 import { reservedFieldUsed as validateReservedFieldUsed } from '..';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/preNormalization/__tests__/rootFieldUsed.test.ts

@@ -1,6 +1,6 @@
 import gql from 'graphql-tag';
 import { rootFieldUsed as validateRootFieldUsed } from '../';
-import { graphqlErrorSerializer } from '../../../../snapshotSerializers';
+import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(graphqlErrorSerializer);
 

federation-js/src/composition/validate/sdl/__tests__/matchingEnums.test.ts

@@ -13,7 +13,7 @@ import {
   astSerializer,
   typeSerializer,
   selectionSetSerializer,
-} from '../../../../snapshotSerializers';
+} from 'apollo-federation-integration-testsuite';
 import { normalizeTypeDefs } from '../../../normalize';
 import federationDirectives from '../../../../directives';
 import { ServiceDefinition } from '../../../types';

federation-js/src/composition/validate/sdl/__tests__/matchingUnions.test.ts

@@ -9,7 +9,7 @@ import gql from 'graphql-tag';
 import {
   typeSerializer,
   graphqlErrorSerializer,
-} from '../../../../snapshotSerializers';
+} from 'apollo-federation-integration-testsuite';
 import { UniqueUnionTypes } from '..';
 import { ServiceDefinition } from '../../../types';
 import { buildMapsFromServiceList } from '../../../compose';

federation-js/src/composition/validate/sdl/__tests__/possibleTypeExtensions.test.ts

@@ -11,7 +11,7 @@ import { buildMapsFromServiceList } from '../../../compose';
 import {
   typeSerializer,
   graphqlErrorSerializer,
-} from '../../../../snapshotSerializers';
+} from 'apollo-federation-integration-testsuite';
 import federationDirectives from '../../../../directives';
 import { ServiceDefinition } from '../../../types';
 import { PossibleTypeExtensions } from '../possibleTypeExtensions';

federation-js/src/composition/validate/sdl/__tests__/uniqueFieldDefinitionNames.test.ts

@@ -7,7 +7,7 @@ import {
 } from 'graphql';
 import { validateSDL } from 'graphql/validation/validate';
 import gql from 'graphql-tag';
-import { typeSerializer } from '../../../../snapshotSerializers';
+import { typeSerializer } from 'apollo-federation-integration-testsuite';
 import { buildMapsFromServiceList } from '../../../compose';
 import federationDirectives from '../../../../directives';
 import { UniqueFieldDefinitionNames } from '..';

federation-js/src/composition/validate/sdl/__tests__/uniqueTypeNamesWithFields.test.ts

@@ -9,7 +9,7 @@ import gql from 'graphql-tag';
 import {
   typeSerializer,
   graphqlErrorSerializer,
-} from '../../../../snapshotSerializers';
+} from 'apollo-federation-integration-testsuite';
 import federationDirectives from '../../../../directives';
 import { UniqueTypeNamesWithFields } from '..';
 import { ServiceDefinition } from '../../../types';

federation-js/src/service/__tests__/buildFederatedSchema.test.ts

@@ -1,7 +1,7 @@
 import gql from 'graphql-tag';
 import { Kind, graphql, DocumentNode, execute } from 'graphql';
 import { buildFederatedSchema } from '../buildFederatedSchema';
-import { typeSerializer } from '../../snapshotSerializers';
+import { typeSerializer } from 'apollo-federation-integration-testsuite';
 
 expect.addSnapshotSerializer(typeSerializer);
 

federation-js/tsconfig.json

@@ -6,7 +6,5 @@
   },
   "include": ["src/**/*"],
   "exclude": ["**/__tests__"],
-  "references": [
-    { "path": "../federation-integration-testsuite-js" }
-  ]
+  "references": []
 }

federation-js/tsconfig.test.json

@@ -3,5 +3,6 @@
   "include": ["**/__tests__/**/*"],
   "references": [
     { "path": "./" },
+    { "path": "../federation-integration-testsuite-js" },
   ]
 }