refactor(): make federation config more extensible, scalable

kamilmysliwiec · kamilmysliwiec · commit b52432254590 · 2022-07-20T14:00:37.000+02:00
diff --git a/packages/apollo/tests/code-first-graphql-federation2/posts-service/federation-posts.module.ts b/packages/apollo/tests/code-first-graphql-federation2/posts-service/federation-posts.module.ts
@@ -11,7 +11,7 @@ import { User } from './posts/user.entity';
     GraphQLModule.forRoot<ApolloDriverConfig>({
       driver: ApolloFederationDriver,
       autoSchemaFile: {
-        useFed2: true,
+        federation: 2,
       },
       buildSchemaOptions: {
         orphanedTypes: [User],
diff --git a/packages/apollo/tests/code-first-graphql-federation2/users-service/federation-users.module.ts b/packages/apollo/tests/code-first-graphql-federation2/users-service/federation-users.module.ts
@@ -10,7 +10,7 @@ import { UsersModule } from './users/users.module';
     GraphQLModule.forRoot<ApolloDriverConfig>({
       driver: ApolloFederationDriver,
       autoSchemaFile: {
-        useFed2: true,
+        federation: 2,
       },
       plugins: [ApolloServerPluginInlineTraceDisabled()],
     }),
diff --git a/packages/apollo/tests/jest-e2e.ts b/packages/apollo/tests/jest-e2e.ts
@@ -10,7 +10,7 @@ const config: Config.InitialOptions = {
   moduleFileExtensions: ['js', 'json', 'ts'],
   rootDir: '../.',
   testRegex: '.spec.ts$',
-  testPathIgnorePatterns: ['.fed2-spec.ts$'],
+  testPathIgnorePatterns: ['.fed([1-9]).spec.ts$'],
   moduleNameMapper,
   transform: {
     '^.+\\.(t|j)s$': 'ts-jest',
diff --git a/packages/graphql/lib/federation/graphql-federation.factory.ts b/packages/graphql/lib/federation/graphql-federation.factory.ts
@@ -1,6 +1,6 @@
 import { mergeSchemas } from '@graphql-tools/schema';
 import { printSchemaWithDirectives } from '@graphql-tools/utils';
-import { Injectable, Logger } from '@nestjs/common';
+import { Injectable } from '@nestjs/common';
 import { loadPackage } from '@nestjs/common/utils/load-package.util';
 import { isString } from '@nestjs/common/utils/shared.utils';
 import {
@@ -27,13 +27,18 @@ import { forEach, isEmpty } from 'lodash';
 import { GraphQLSchemaBuilder } from '../graphql-schema.builder';
 import { GraphQLSchemaHost } from '../graphql-schema.host';
 import {
-  GqlModuleOptions,
-  BuildFederatedSchemaOptions,
   AutoSchemaFileValue,
+  BuildFederatedSchemaOptions,
+  FederationConfig,
+  FederationVersion,
+  GqlModuleOptions,
 } from '../interfaces';
 import { ResolversExplorerService, ScalarsExplorerService } from '../services';
-import { extend, getFederation2Info, stringifyWithoutQuotes } from '../utils';
+import { extend } from '../utils';
 import { transformSchema } from '../utils/transform-schema.util';
+import { TypeDefsDecoratorFactory } from './type-defs-decorator.factory';
+
+const DEFAULT_FEDERATION_VERSION: FederationVersion = 1;
 
 @Injectable()
 export class GraphQLFederationFactory {
@@ -42,6 +47,7 @@ export class GraphQLFederationFactory {
     private readonly scalarsExplorerService: ScalarsExplorerService,
     private readonly gqlSchemaBuilder: GraphQLSchemaBuilder,
     private readonly gqlSchemaHost: GraphQLSchemaHost,
+    private readonly typeDefsDecoratorFactory: TypeDefsDecoratorFactory,
   ) {}
 
   async mergeWithSchema<T extends GqlModuleOptions>(
@@ -102,7 +108,9 @@ export class GraphQLFederationFactory {
       await import('@apollo/subgraph/package.json')
     ).version;
 
-    const isApolloSubgraph2 = Number(apolloSubgraphVersion.split('.')[0]) >= 2;
+    const apolloSubgraphMajorVersion = Number(
+      apolloSubgraphVersion.split('.')[0],
+    );
     const printSubgraphSchema = apolloSubgraph.printSubgraphSchema;
 
     if (!buildFederatedSchema) {
@@ -114,45 +122,20 @@ export class GraphQLFederationFactory {
       options,
       this.resolversExplorerService.getAllCtors(),
     );
-    let typeDefs = isApolloSubgraph2
-      ? printSchemaWithDirectives(autoGeneratedSchema)
-      : printSubgraphSchema(autoGeneratedSchema);
+    let typeDefs =
+      apolloSubgraphMajorVersion >= 2
+        ? printSchemaWithDirectives(autoGeneratedSchema)
+        : printSubgraphSchema(autoGeneratedSchema);
 
-    const useFed2 = getFederation2Info(options.autoSchemaFile);
+    const [federationVersion, federationOptions] =
+      this.getFederationVersionAndConfig(options.autoSchemaFile);
 
-    if (useFed2 && isApolloSubgraph2) {
-      const {
-        directives = [
-          '@key',
-          '@shareable',
-          '@external',
-          '@override',
-          '@requires',
-        ],
-        importUrl = 'https://specs.apollo.dev/federation/v2.0',
-      } = typeof useFed2 === 'boolean' ? {} : useFed2;
-      const mappedDirectives = directives
-        .map((directive) => {
-          if (!isString(directive)) {
-            return stringifyWithoutQuotes(directive);
-          }
-          let finalDirective = directive;
-          if (!directive.startsWith('@')) {
-            finalDirective = `@${directive}`;
-          }
-          return `"${finalDirective}"`;
-        })
-        .join(', ');
-
-      typeDefs = `
-        extend schema @link(url: "${importUrl}", import: [${mappedDirectives}])
-        ${typeDefs}
-      `;
-    } else if (useFed2 && !isApolloSubgraph2) {
-      Logger.error(
-        'You are trying to use Apollo Federation 2 but you are not using @apollo/subgraph@^2.0.0, please upgrade',
-        'GraphQLFederationFactory',
-      );
+    const typeDefsDecorator = this.typeDefsDecoratorFactory.create(
+      federationVersion,
+      apolloSubgraphMajorVersion,
+    );
+    if (typeDefsDecorator) {
+      typeDefs = typeDefsDecorator.decorate(typeDefs, federationOptions);
     }
 
     let executableSchema: GraphQLSchema = buildFederatedSchema({
@@ -341,17 +324,23 @@ export class GraphQLFederationFactory {
     const scalarsMap = this.scalarsExplorerService.getScalarsMap();
     try {
       const buildSchemaOptions = options.buildSchemaOptions || {};
-      const useFed2 = getFederation2Info(options.autoSchemaFile);
+      const directives = [...specifiedDirectives];
+      const [federationVersion] =
+        this.getFederationVersionAndConfig(autoSchemaFile);
+
+      if (federationVersion < 2) {
+        directives.push(...this.loadFederationDirectives());
+      }
+      if (buildSchemaOptions?.directives) {
+        directives.push(...buildSchemaOptions.directives);
+      }
+
       return await this.gqlSchemaBuilder.generateSchema(
         resolvers,
         autoSchemaFile,
         {
           ...buildSchemaOptions,
-          directives: [
-            ...specifiedDirectives,
-            ...(useFed2 ? [] : this.loadFederationDirectives()),
-            ...((buildSchemaOptions && buildSchemaOptions.directives) || []),
-          ],
+          directives,
           scalarsMap,
           skipCheck: true,
         },
@@ -366,6 +355,21 @@ export class GraphQLFederationFactory {
     }
   }
 
+  private getFederationVersionAndConfig(
+    autoSchemaFile: AutoSchemaFileValue,
+  ): [FederationVersion, FederationConfig?] {
+    if (!autoSchemaFile || typeof autoSchemaFile !== 'object') {
+      return [DEFAULT_FEDERATION_VERSION];
+    }
+    if (typeof autoSchemaFile.federation !== 'object') {
+      return [autoSchemaFile.federation ?? DEFAULT_FEDERATION_VERSION];
+    }
+    return [
+      autoSchemaFile.federation?.version ?? DEFAULT_FEDERATION_VERSION,
+      autoSchemaFile.federation,
+    ];
+  }
+
   private loadFederationDirectives() {
     const { federationDirectives, directivesWithNoDefinitionNeeded } =
       loadPackage('@apollo/subgraph/dist/directives', 'SchemaBuilder', () =>
diff --git a/packages/graphql/lib/federation/type-defs-decorator.factory.ts b/packages/graphql/lib/federation/type-defs-decorator.factory.ts
@@ -0,0 +1,31 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { FederationConfig, FederationVersion } from '../interfaces';
+import { TypeDefsFederation2Decorator } from './type-defs-federation2.decorator';
+
+export interface TypeDefsDecorator<T = FederationConfig> {
+  decorate(typeDefs: string, options: T): string;
+}
+
+@Injectable()
+export class TypeDefsDecoratorFactory {
+  private readonly logger = new Logger(TypeDefsDecoratorFactory.name);
+
+  create(
+    federationVersion: FederationVersion,
+    apolloSubgraphVersion: number,
+  ): TypeDefsDecorator | undefined {
+    switch (federationVersion) {
+      case 2: {
+        if (apolloSubgraphVersion === 1) {
+          this.logger.error(
+            'You are trying to use Apollo Federation 2 but you are not using @apollo/subgraph@^2.0.0, please upgrade',
+          );
+          return;
+        }
+        return new TypeDefsFederation2Decorator();
+      }
+      default:
+        return;
+    }
+  }
+}
diff --git a/packages/graphql/lib/federation/type-defs-federation2.decorator.ts b/packages/graphql/lib/federation/type-defs-federation2.decorator.ts
@@ -0,0 +1,35 @@
+import { isString } from '@nestjs/common/utils/shared.utils';
+import { Federation2Config } from '../interfaces';
+import { stringifyWithoutQuotes } from '../utils';
+
+export class TypeDefsFederation2Decorator {
+  decorate(typeDefs: string, config: Federation2Config = { version: 2 }) {
+    const {
+      directives = [
+        '@key',
+        '@shareable',
+        '@external',
+        '@override',
+        '@requires',
+      ],
+      importUrl = 'https://specs.apollo.dev/federation/v2.0',
+    } = config;
+    const mappedDirectives = directives
+      .map((directive) => {
+        if (!isString(directive)) {
+          return stringifyWithoutQuotes(directive);
+        }
+        let finalDirective = directive;
+        if (!directive.startsWith('@')) {
+          finalDirective = `@${directive}`;
+        }
+        return `"${finalDirective}"`;
+      })
+      .join(', ');
+
+    return `
+      extend schema @link(url: "${importUrl}", import: [${mappedDirectives}])
+      ${typeDefs}
+    `;
+  }
+}
diff --git a/packages/graphql/lib/graphql.module.ts b/packages/graphql/lib/graphql.module.ts
@@ -6,10 +6,11 @@ import {
   Provider,
 } from '@nestjs/common/interfaces';
 import { HttpAdapterHost } from '@nestjs/core';
-import { MetadataScanner } from '@nestjs/core/metadata-scanner';
 import { ROUTE_MAPPED_MESSAGE } from '@nestjs/core/helpers/messages';
+import { MetadataScanner } from '@nestjs/core/metadata-scanner';
 import { AbstractGraphQLDriver } from './drivers/abstract-graphql.driver';
 import { GraphQLFederationFactory } from './federation/graphql-federation.factory';
+import { TypeDefsDecoratorFactory } from './federation/type-defs-decorator.factory';
 import { GraphQLAstExplorer } from './graphql-ast.explorer';
 import { GraphQLSchemaBuilder } from './graphql-schema.builder';
 import { GraphQLSchemaHost } from './graphql-schema.host';
@@ -37,6 +38,7 @@ import { extend, generateString } from './utils';
     GraphQLSchemaBuilder,
     GraphQLSchemaHost,
     GraphQLFederationFactory,
+    TypeDefsDecoratorFactory,
   ],
   exports: [
     GraphQLTypesLoader,
@@ -49,7 +51,9 @@ export class GraphQLModule<
   TAdapter extends AbstractGraphQLDriver = AbstractGraphQLDriver,
 > implements OnModuleInit, OnModuleDestroy
 {
-  private static readonly logger = new Logger(GraphQLModule.name, { timestamp: true });
+  private static readonly logger = new Logger(GraphQLModule.name, {
+    timestamp: true,
+  });
 
   get graphQlAdapter(): TAdapter {
     return this._graphQlAdapter as TAdapter;
@@ -160,7 +164,9 @@ export class GraphQLModule<
     });
 
     if (options.path) {
-      GraphQLModule.logger.log(ROUTE_MAPPED_MESSAGE(options.path, RequestMethod.POST));
+      GraphQLModule.logger.log(
+        ROUTE_MAPPED_MESSAGE(options.path, RequestMethod.POST),
+      );
     }
   }
 
diff --git a/packages/graphql/lib/interfaces/schema-file-config.interface.ts b/packages/graphql/lib/interfaces/schema-file-config.interface.ts
@@ -3,7 +3,11 @@ export interface AliasDirectiveImport {
   as: string;
 }
 
+export type FederationVersion = 1 | 2;
+export type FederationConfig = Federation2Config;
+
 export interface Federation2Config {
+  version: 2;
   /**
    * The imported directives
    * @default ['@key', '@shareable', '@external', '@override', '@requires']
@@ -16,23 +20,16 @@ export interface Federation2Config {
   importUrl?: string;
 }
 
-export type UseFed2Value = boolean | Federation2Config;
-
 export interface SchemaFileConfig {
   /**
-   * If enabled, it will use federation 2 schema
-   * 
-   * **Note:** You need to have installed @apollo/subgraph@^2.0.0 and enable `autoSchemaFile`
-   * 
-   * This will add to your schema:
-   * ```graphql
-      extend schema @link(url: "https://specs.apollo.dev/federation/v2.0", import: ["@key", "@shareable", "@external", "@override", "@requires"])
-   * ```
-  */
-  useFed2?: UseFed2Value;
+   * Federation version and its configuration,
+   *
+   * @default 1
+   */
+  federation?: FederationVersion | FederationConfig;
 
   /**
-   * The path to the schema file
+   * Path to the schema file.
    */
   path?: string;
 }
diff --git a/packages/graphql/lib/utils/auto-schema-file.util.ts b/packages/graphql/lib/utils/auto-schema-file.util.ts
@@ -1,5 +1,5 @@
-import { isString, isObject } from '@nestjs/common/utils/shared.utils';
-import { AutoSchemaFileValue, UseFed2Value } from '../interfaces';
+import { isObject, isString } from '@nestjs/common/utils/shared.utils';
+import { AutoSchemaFileValue } from '../interfaces';
 
 export function getPathForAutoSchemaFile(
   autoSchemaFile: AutoSchemaFileValue,
@@ -12,12 +12,3 @@ export function getPathForAutoSchemaFile(
   }
   return null;
 }
-
-export function getFederation2Info(
-  autoSchemaFile: AutoSchemaFileValue,
-): UseFed2Value {
-  if (isObject(autoSchemaFile)) {
-    return autoSchemaFile.useFed2;
-  }
-  return false;
-}
diff --git a/packages/graphql/lib/utils/index.ts b/packages/graphql/lib/utils/index.ts
@@ -4,5 +4,5 @@ export * from './extract-metadata.util';
 export * from './generate-token.util';
 export * from './get-number-of-arguments.util';
 export * from './normalize-route-path.util';
-export * from './object.util';
 export * from './remove-temp.util';
+export * from './stringify-without-quotes.util';
diff --git a/packages/graphql/lib/utils/stringify-without-quotes.util.ts b/packages/graphql/lib/utils/stringify-without-quotes.util.ts
