Resolve testing setup issues / buildPlan.test.ts whitespacing (#2959)

.vscode/settings.json

@@ -9,7 +9,6 @@
     "editor.formatOnSave": false,
     "editor.rulers": [80],
     "editor.wordWrapColumn": 80,
-    "files.trimTrailingWhitespace": true,
     "files.insertFinalNewline": true,
   },
   "typescript.tsdk": "./node_modules/typescript/lib",

composition-js/jest.config.js

@@ -4,6 +4,7 @@ const baseConfig = require('../jest.config.base');
 /** @type {import('@jest/types').Config.InitialOptions} */
 module.exports = {
   ...baseConfig,
+  setupFilesAfterEnv: ['./src/__tests__/testSetup.ts'],
   displayName: {
     name: '@apollo/composition',
     color: 'gray'

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

@@ -17,7 +17,6 @@ import {
 import { DirectiveLocation } from "graphql";
 import gql from "graphql-tag";
 import { assertCompositionSuccess, composeAsFed2Subgraphs } from "./testHelper";
-import './matchers';
 import {
   registerKnownFeature,
   unregisterKnownFeatures,

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

@@ -1,5 +1,4 @@
 import gql from 'graphql-tag';
-import './matchers';
 import {
   assertCompositionSuccess,
   errors,

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

@@ -16,7 +16,6 @@ import {
 } from '@apollo/federation-internals';
 import { CompositionOptions, CompositionResult, composeServices } from '../compose';
 import gql from 'graphql-tag';
-import './matchers';
 import { print } from 'graphql';
 import {
   assertCompositionSuccess,

composition-js/src/__tests__/composeFed1Subgraphs.test.ts

@@ -1,7 +1,6 @@
 import { FEDERATION2_LINK_WITH_AUTO_EXPANDED_IMPORTS, ObjectType, printSchema, Schema, SubgraphASTNode, Subgraphs, Supergraph } from '@apollo/federation-internals';
 import { CompositionResult, composeServices, CompositionSuccess } from '../compose';
 import gql from 'graphql-tag';
-import './matchers';
 
 function assertCompositionSuccess(r: CompositionResult): asserts r is CompositionSuccess {
   if (r.errors) {

composition-js/src/__tests__/hints.test.ts

@@ -7,7 +7,7 @@ import {
 } from '../hints';
 import { MergeResult, mergeSubgraphs } from '../merging';
 import { assertCompositionSuccess, composeAsFed2Subgraphs } from './testHelper';
-import { formatExpectedToMatchReceived } from './matchers/toMatchString';
+import { formatExpectedToMatchReceived } from 'apollo-federation-integration-testsuite/src/matchers/toMatchString';
 import { composeServices } from '../compose';
 
 function mergeDocuments(...documents: DocumentNode[]): MergeResult {

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

@@ -1,6 +1,5 @@
 import { printSchema, printType } from "@apollo/federation-internals";
 import gql from "graphql-tag";
-import "./matchers";
 import {
   assertCompositionSuccess,
   schemas,

composition-js/src/__tests__/supergraph_reversibility.test.ts

@@ -1,7 +1,6 @@
 import { assertCompositionSuccess, composeAsFed2Subgraphs } from "./testHelper";
 import gql from 'graphql-tag';
 import { asFed2SubgraphDocument, buildSubgraph, ServiceDefinition, Supergraph } from "@apollo/federation-internals";
-import './matchers';
 
 function composeAndTestReversibility(subgraphs: ServiceDefinition[]) {
   const result = composeAsFed2Subgraphs(subgraphs);

composition-js/src/__tests__/testSetup.ts

@@ -0,0 +1 @@
+import 'apollo-federation-integration-testsuite/dist/matchers';

composition-js/src/__tests__/validation_errors.test.ts

@@ -1,6 +1,5 @@
 import { CompositionResult } from '../compose';
 import gql from 'graphql-tag';
-import './matchers';
 import { composeAsFed2Subgraphs } from './testHelper';
 
 function errorMessages(r: CompositionResult): string[] {

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

@@ -2,3 +2,5 @@ import './toCallService';
 import './toHaveBeenCalledBefore';
 import './toMatchAST';
 import './toMatchQueryPlan';
+import './toMatchString';
+import './toMatchSubgraph';

composition-js/src/__tests__/matchers/toMatchString.ts → federation-integration-testsuite-js/src/matchers/toMatchString.ts

@@ -1,8 +1,6 @@
 // Make this file a module (See: https://github.com/microsoft/TypeScript/issues/17736)
-export {};
+export { };
 
-// TODO: this is the same than in definition.test.ts. Could we move those to a common place (but is it worth having
-// a new module for that)? Maybe there is a better, more jest-native, way to do this.
 // Note(Sylvain): I initially added those because I didn't figure out a way to make `toMatchSnapshotInline` work
 // with strings cleanly: I always either ended up with indentation issuels, or the result looks very ugly in the
 // tests. But it could be I just don't understand well enough how it work.
@@ -44,24 +42,24 @@ expect.extend({
     const pass = this.equals(received, expected);
     const message = pass
       ? () => this.utils.matcherHint('toMatchString', undefined, undefined)
-          + '\n\n'
-          + `Expected: not ${this.printExpected(received)}`
+        + '\n\n'
+        + `Expected: not ${this.printExpected(received)}`
       : () => {
         return (
           this.utils.matcherHint('toMatchString', undefined, undefined,)
           + '\n\n'
           + this.utils.printDiffOrStringify(expected, received, 'Expected', 'Received', true));
       };
-    return {received, expected, message, name: 'toMatchString', pass};
+    return { received, expected, message, name: 'toMatchString', pass };
   },
 
   toMatchStringArray(received: string[], expected: string[]) {
     if (received.length !== expected.length) {
-      const message = () => 
+      const message = () =>
         this.utils.matcherHint('toMatchStringArray', undefined, undefined,)
-          + `\n\nExpected an array of size ${expected.length} but got one of size ${received.length}\n\n`
-          + this.utils.printDiffOrStringify(expected, received, 'Expected', 'Received', true);
-      return {received, expected, message, name: 'toMatchStringArray', pass: false};
+        + `\n\nExpected an array of size ${expected.length} but got one of size ${received.length}\n\n`
+        + this.utils.printDiffOrStringify(expected, received, 'Expected', 'Received', true);
+      return { received, expected, message, name: 'toMatchStringArray', pass: false };
     }
 
     let pass = true;
@@ -77,12 +75,11 @@ expect.extend({
         );
       }
     }
-    const message = () => 
-      this.utils.matcherHint('toMatchString', undefined, undefined) 
-        + '\n\n'
-        + (pass ? `Expected: not ${this.printExpected(expected)}` : messages.join('\n\n'));
+    const message = () =>
+      this.utils.matcherHint('toMatchString', undefined, undefined)
+      + '\n\n'
+      + (pass ? `Expected: not ${this.printExpected(expected)}` : messages.join('\n\n'));
 
-    return {received, expected, message, name: 'toMatchStringArray', pass};
+    return { received, expected, message, name: 'toMatchStringArray', pass };
   }
 });
-

internals-js/jest.config.js

@@ -4,6 +4,7 @@ const baseConfig = require('../jest.config.base');
 /** @type {import('@jest/types').Config.InitialOptions} */
 module.exports = {
   ...baseConfig,
+  setupFilesAfterEnv: ['./src/__tests__/testSetup.ts'],
   displayName: {
     name: '@apollo/federation-internals',
     color: 'magenta'

internals-js/src/__tests__/definitions.test.ts

@@ -8,14 +8,13 @@ import {
   SchemaElement,
   UnionType,
   InputObjectType,
-} from '../../dist/definitions';
+} from '../definitions';
 import {
   printSchema as printGraphQLjsSchema,
 } from 'graphql';
-import { defaultPrintOptions, printSchema } from '../../dist/print';
-import { buildSchema } from '../../dist/buildSchema';
-import { buildSubgraph, federationMetadata, newEmptyFederation2Schema } from '../../dist/federation';
-import './matchers';
+import { defaultPrintOptions, printSchema } from '../print';
+import { buildSchema } from '../buildSchema';
+import { buildSubgraph, federationMetadata, newEmptyFederation2Schema } from '../federation';
 
 function parseSchema(schema: string): Schema {
   try {

internals-js/src/__tests__/graphQLJSSchemaToAST.test.ts

@@ -6,7 +6,6 @@ import {
   print
 } from "graphql";
 import { graphQLJSSchemaToAST } from "../graphQLJSSchemaToAST";
-import './matchers';
 
 function validateRoundtrip(schemaStr: string, expectedWithoutASTNodes: string | undefined = schemaStr) {
   const schema = buildSchema(schemaStr);

internals-js/src/__tests__/operations.test.ts

@@ -3,11 +3,10 @@ import {
   isCompositeType,
   Schema,
   SchemaRootKind,
-} from '../../dist/definitions';
-import { buildSchema } from '../../dist/buildSchema';
-import { FederationBlueprint } from '../../dist/federation';
-import { FragmentRestrictionAtType, MutableSelectionSet, NamedFragmentDefinition, Operation, operationFromDocument, parseOperation } from '../../dist/operations';
-import './matchers';
+} from '../definitions';
+import { buildSchema } from '../buildSchema';
+import { FederationBlueprint } from '../federation';
+import { FragmentRestrictionAtType, MutableSelectionSet, NamedFragmentDefinition, Operation, operationFromDocument, parseOperation } from '../operations';
 import { DocumentNode, FieldNode, GraphQLError, Kind, OperationDefinitionNode, OperationTypeNode, parse, SelectionNode, SelectionSetNode, validate } from 'graphql';
 import { assert } from '../utils';
 import gql from 'graphql-tag';

internals-js/src/__tests__/schemaUpgrader.test.ts

@@ -2,7 +2,6 @@ import { FEDERATION2_LINK_WITH_AUTO_EXPANDED_IMPORTS_UPGRADED, printSchema } fro
 import { ObjectType } from '../definitions';
 import { buildSubgraph, Subgraphs } from '../federation';
 import { UpgradeChangeID, UpgradeResult, upgradeSubgraphsIfNecessary } from '../schemaUpgrader';
-import './matchers';
 
 function changeMessages(res: UpgradeResult, subgraphName: string, id: UpgradeChangeID): string[] {
   const changes = res.changes?.get(subgraphName)?.get(id);

internals-js/src/__tests__/testSetup.ts

@@ -0,0 +1 @@
+import 'apollo-federation-integration-testsuite/dist/matchers';

internals-js/src/__tests__/testUtils.ts

@@ -1,6 +1,5 @@
 import { DocumentNode } from "graphql";
 import { asFed2SubgraphDocument, buildSubgraph, errorCauses } from "..";
-import './matchers';
 
 // Builds the provided subgraph (using name 'S' for the subgraph) and, if the
 // subgraph is invalid/has errors, return those errors as a list of [code, message].

query-graphs-js/jest.config.js

@@ -4,6 +4,7 @@ const baseConfig = require('../jest.config.base');
 /** @type {import('@jest/types').Config.InitialOptions} */
 module.exports = {
   ...baseConfig,
+  setupFilesAfterEnv: ['./src/__tests__/testSetup.ts'],
   displayName: {
     name: "@apollo/query-graphs",
     color: "yellow",

query-graphs-js/src/__tests__/testSetup.ts

@@ -0,0 +1 @@
+import 'apollo-federation-integration-testsuite/dist/matchers';