Merge pull request #2636 from nestjs/next

feat: upgrade Mercurius, Apollo, GraphQL to the latest versions

Author: kamilmysliwiec

.gitignore

@@ -19,4 +19,6 @@ test-schema.graphql
 
 # dist
 packages/**/dist
-**/*.tsbuildinfo
+**/*.tsbuildinfo
+
+.yarn/

lerna.json

@@ -1,8 +1,6 @@
 {
-  "packages": [
-    "packages/*"
-  ],
-  "version": "10.2.0",
+  "packages": ["packages/*"],
+  "version": "11.0.0-next.2",
   "npmClient": "yarn",
   "useWorkspaces": true,
   "changelog": {

package.json

@@ -26,7 +26,7 @@
     "prepare": "husky install"
   },
   "resolutions": {
-    "graphql": "15.8.0"
+    "graphql": "16.6.0"
   },
   "devDependencies": {
     "@commitlint/cli": "17.4.4",
@@ -45,7 +45,7 @@
     "eslint-config-prettier": "8.7.0",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-prettier": "4.2.1",
-    "graphql": "15.8.0",
+    "graphql": "16.6.0",
     "graphql-subscriptions": "2.0.0",
     "husky": "8.0.3",
     "jest": "29.5.0",

packages/apollo/lib/apollo.constants.ts renamed to packages/apollo/lib/constants/apollo.constants.ts

@@ -0,0 +1 @@
+export * from './apollo.constants';

packages/apollo/lib/constants/index.ts

@@ -1,5 +1,5 @@
 import { SetMetadata } from '@nestjs/common';
-import { PLUGIN_METADATA } from '../apollo.constants';
+import { PLUGIN_METADATA } from '../constants';
 
 /**
  * Decorator that marks a class as an Apollo plugin.

packages/apollo/lib/decorators/plugin.decorator.ts

@@ -1,37 +1,31 @@
+import { ApolloServer, type BaseContext } from '@apollo/server';
+import { ApolloServerPluginLandingPageGraphQLPlayground } from '@apollo/server-plugin-landing-page-graphql-playground';
+import { ApolloServerErrorCode } from '@apollo/server/errors';
+import { expressMiddleware } from '@apollo/server/express4';
+import { ApolloServerPluginLandingPageDisabled } from '@apollo/server/plugin/disabled';
+import { ApolloServerPluginDrainHttpServer } from '@apollo/server/plugin/drainHttpServer';
 import { HttpStatus } from '@nestjs/common';
 import { loadPackage } from '@nestjs/common/utils/load-package.util';
 import { isFunction } from '@nestjs/common/utils/shared.utils';
 import { AbstractGraphQLDriver } from '@nestjs/graphql';
-import {
-  ApolloError,
-  ApolloServerBase,
-  ApolloServerPluginLandingPageDisabled,
-  ApolloServerPluginLandingPageGraphQLPlayground,
-  AuthenticationError,
-  ForbiddenError,
-  PluginDefinition,
-  UserInputError,
-} from 'apollo-server-core';
 import { GraphQLError, GraphQLFormattedError } from 'graphql';
 import * as omit from 'lodash.omit';
 import { ApolloDriverConfig } from '../interfaces';
 import { createAsyncIterator } from '../utils/async-iterator.util';
 
-const apolloPredefinedExceptions: Partial<
-  Record<HttpStatus, typeof ApolloError | typeof UserInputError>
-> = {
-  [HttpStatus.BAD_REQUEST]: UserInputError,
-  [HttpStatus.UNAUTHORIZED]: AuthenticationError,
-  [HttpStatus.FORBIDDEN]: ForbiddenError,
+const apolloPredefinedExceptions: Partial<Record<HttpStatus, string>> = {
+  [HttpStatus.BAD_REQUEST]: ApolloServerErrorCode.BAD_REQUEST,
+  [HttpStatus.UNAUTHORIZED]: 'UNAUTHENTICATED',
+  [HttpStatus.FORBIDDEN]: 'FORBIDDEN',
 };
 
 export abstract class ApolloBaseDriver<
   T extends Record<string, any> = ApolloDriverConfig,
 > extends AbstractGraphQLDriver<T> {
-  protected _apolloServer: ApolloServerBase;
+  protected apolloServer: ApolloServer<BaseContext>;
 
-  get instance(): ApolloServerBase {
-    return this._apolloServer;
+  get instance(): ApolloServer<BaseContext> {
+    return this.apolloServer;
   }
 
   public async start(apolloOptions: T) {
@@ -48,7 +42,7 @@ export abstract class ApolloBaseDriver<
   }
 
   public stop() {
-    return this._apolloServer?.stop();
+    return this.apolloServer?.stop();
   }
 
   public async mergeDefaultOptions(options: T): Promise<T> {
@@ -68,9 +62,7 @@ export abstract class ApolloBaseDriver<
       defaults = {
         ...defaults,
         plugins: [
-          ApolloServerPluginLandingPageGraphQLPlayground(
-            playgroundOptions,
-          ) as PluginDefinition,
+          ApolloServerPluginLandingPageGraphQLPlayground(playgroundOptions),
         ],
       };
     } else if (
@@ -80,7 +72,7 @@ export abstract class ApolloBaseDriver<
     ) {
       defaults = {
         ...defaults,
-        plugins: [ApolloServerPluginLandingPageDisabled() as PluginDefinition],
+        plugins: [ApolloServerPluginLandingPageDisabled()],
       };
     }
 
@@ -116,67 +108,80 @@ export abstract class ApolloBaseDriver<
   }
 
   protected async registerExpress(
-    apolloOptions: T,
+    options: T,
     { preStartHook }: { preStartHook?: () => void } = {},
   ) {
-    const { ApolloServer } = loadPackage(
-      'apollo-server-express',
-      'GraphQLModule',
-      () => require('apollo-server-express'),
-    );
-    const { disableHealthCheck, path, onHealthCheck, cors, bodyParserConfig } =
-      apolloOptions;
+    const { path, typeDefs, resolvers, schema } = options;
 
     const httpAdapter = this.httpAdapterHost.httpAdapter;
     const app = httpAdapter.getInstance();
+    const drainHttpServerPlugin = ApolloServerPluginDrainHttpServer({
+      httpServer: httpAdapter.getHttpServer(),
+    });
 
     preStartHook?.();
 
-    const apolloServer = new ApolloServer(apolloOptions as any);
-    await apolloServer.start();
+    const server = new ApolloServer({
+      typeDefs,
+      resolvers,
+      schema,
+      ...options,
+      plugins: options.plugins
+        ? options.plugins.concat([drainHttpServerPlugin])
+        : [drainHttpServerPlugin],
+    });
+
+    await server.start();
 
-    apolloServer.applyMiddleware({
-      app,
+    app.use(
       path,
-      disableHealthCheck,
-      onHealthCheck,
-      cors,
-      bodyParserConfig,
-    });
+      expressMiddleware(server, {
+        context: options.context,
+      }),
+    );
 
-    this._apolloServer = apolloServer;
+    this.apolloServer = server;
   }
 
   protected async registerFastify(
-    apolloOptions: T,
+    options: T,
     { preStartHook }: { preStartHook?: () => void } = {},
   ) {
-    const { ApolloServer } = loadPackage(
-      'apollo-server-fastify',
+    const { fastifyApolloDrainPlugin, fastifyApolloHandler } = loadPackage(
+      '@as-integrations/fastify',
       'GraphQLModule',
-      () => require('apollo-server-fastify'),
+      () => require('@as-integrations/fastify'),
     );
 
     const httpAdapter = this.httpAdapterHost.httpAdapter;
     const app = httpAdapter.getInstance();
 
+    const { path, typeDefs, resolvers, schema } = options;
+    const apolloDrainPlugin = fastifyApolloDrainPlugin(app);
+
     preStartHook?.();
-    const apolloServer = new ApolloServer(apolloOptions as any);
-    await apolloServer.start();
-
-    const { disableHealthCheck, onHealthCheck, cors, bodyParserConfig, path } =
-      apolloOptions;
-    await app.register(
-      apolloServer.createHandler({
-        disableHealthCheck,
-        onHealthCheck,
-        cors,
-        bodyParserConfig,
-        path,
+
+    const server = new ApolloServer<BaseContext>({
+      typeDefs,
+      resolvers,
+      schema,
+      ...options,
+      plugins: options.plugins
+        ? options.plugins.concat([apolloDrainPlugin])
+        : [apolloDrainPlugin],
+    });
+
+    await server.start();
+
+    app.route({
+      url: path,
+      method: ['GET', 'POST', 'OPTIONS'],
+      handler: fastifyApolloHandler(server, {
+        context: options.context,
       }),
-    );
+    });
 
-    this._apolloServer = apolloServer;
+    this.apolloServer = server;
   }
 
   private wrapFormatErrorFn(options: T) {
@@ -201,19 +206,25 @@ export abstract class ApolloBaseDriver<
       const exceptionRef = originalError?.extensions?.exception;
       const isHttpException =
         exceptionRef?.response?.statusCode && exceptionRef?.status;
-
       if (!isHttpException) {
         return originalError as GraphQLFormattedError;
       }
-      let error: ApolloError;
+      let error: GraphQLError;
 
       const httpStatus = exceptionRef?.status;
       if (httpStatus in apolloPredefinedExceptions) {
-        error = new apolloPredefinedExceptions[httpStatus](
-          exceptionRef?.message,
-        );
+        error = new GraphQLError(exceptionRef?.message, {
+          extensions: {
+            code: apolloPredefinedExceptions[httpStatus],
+          },
+        });
       } else {
-        error = new ApolloError(exceptionRef.message, httpStatus?.toString());
+        error = new GraphQLError(exceptionRef.message, {
+          extensions: {
+            code: ApolloServerErrorCode.INTERNAL_SERVER_ERROR,
+            status: httpStatus,
+          },
+        });
       }
 
       error.stack = exceptionRef?.stacktrace;
@@ -227,18 +238,26 @@ export abstract class ApolloBaseDriver<
     originalOptions: ApolloDriverConfig = { ...targetOptions },
   ) {
     if (!targetOptions.context) {
-      targetOptions.context = ({ req, request }) => ({ req: req ?? request });
+      targetOptions.context = async (contextOrRequest) => {
+        return {
+          // New ApolloServer fastify integration has Request as first parameter to the Context function
+          req: contextOrRequest.req ?? contextOrRequest,
+        };
+      };
     } else if (isFunction(targetOptions.context)) {
       targetOptions.context = async (...args: unknown[]) => {
         const ctx = await (originalOptions.context as Function)(...args);
-        const { req, request } = args[0] as Record<string, unknown>;
-        return this.assignReqProperty(ctx, req ?? request);
+        const contextOrRequest = args[0] as Record<string, unknown>;
+        return this.assignReqProperty(
+          ctx,
+          contextOrRequest.req ?? contextOrRequest,
+        );
       };
     } else {
-      targetOptions.context = ({ req, request }: Record<string, unknown>) => {
+      targetOptions.context = async (contextOrRequest) => {
         return this.assignReqProperty(
           originalOptions.context as Record<string, any>,
-          req ?? request,
+          contextOrRequest.req ?? contextOrRequest,
         );
       };
     }

packages/apollo/lib/drivers/apollo-base.driver.ts

@@ -2,6 +2,7 @@ import { Injectable } from '@nestjs/common';
 import { loadPackage } from '@nestjs/common/utils/load-package.util';
 import { ModulesContainer } from '@nestjs/core';
 import { extend, GraphQLFederationFactory } from '@nestjs/graphql';
+import { GraphQLSchema } from 'graphql';
 import { ApolloDriverConfig } from '../interfaces';
 import { PluginsExplorerService } from '../services/plugins-explorer.service';
 import { ApolloBaseDriver } from './apollo-base.driver';
@@ -24,24 +25,19 @@ export class ApolloFederationDriver extends ApolloBaseDriver {
       this.pluginsExplorerService.explore(options),
     );
 
-    const adapterOptions = await this.graphqlFederationFactory.mergeWithSchema(
-      options,
-    );
-    await this.runExecutorFactoryIfPresent(adapterOptions);
-
     if (options.definitions && options.definitions.path) {
       const { printSubgraphSchema } = loadPackage(
         '@apollo/subgraph',
         'ApolloFederation',
         () => require('@apollo/subgraph'),
       );
       await this.graphQlFactory.generateDefinitions(
-        printSubgraphSchema(adapterOptions.schema),
+        printSubgraphSchema(options.schema),
         options,
       );
     }
 
-    await super.start(adapterOptions);
+    await super.start(options);
 
     if (options.installSubscriptionHandlers || options.subscriptions) {
       // TL;DR <https://github.com/apollographql/apollo-server/issues/2776>
@@ -51,11 +47,7 @@ export class ApolloFederationDriver extends ApolloBaseDriver {
     }
   }
 
-  private async runExecutorFactoryIfPresent(apolloOptions: ApolloDriverConfig) {
-    if (!apolloOptions.executorFactory) {
-      return;
-    }
-    const executor = await apolloOptions.executorFactory(apolloOptions.schema);
-    apolloOptions.executor = executor;
+  public generateSchema(options: ApolloDriverConfig): Promise<GraphQLSchema> {
+    return this.graphqlFederationFactory.generateSchema(options);
   }
 }

packages/apollo/lib/drivers/apollo-federation.driver.ts

@@ -43,4 +43,8 @@ export class ApolloGatewayDriver extends ApolloBaseDriver<ApolloGatewayDriverCon
       server: await super.mergeDefaultOptions(options?.server ?? {}),
     };
   }
+
+  public generateSchema(_: ApolloGatewayDriverConfig) {
+    return null;
+  }
 }

packages/apollo/lib/drivers/apollo-gateway.driver.ts

@@ -20,17 +20,12 @@ export class ApolloDriver extends ApolloBaseDriver {
     this.pluginsExplorerService = new PluginsExplorerService(modulesContainer);
   }
 
-  public async start(apolloOptions: ApolloDriverConfig) {
-    apolloOptions.plugins = extend(
-      apolloOptions.plugins || [],
-      this.pluginsExplorerService.explore(apolloOptions),
+  public async start(options: ApolloDriverConfig) {
+    options.plugins = extend(
+      options.plugins || [],
+      this.pluginsExplorerService.explore(options),
     );
 
-    const options =
-      await this.graphQlFactory.mergeWithSchema<ApolloDriverConfig>(
-        apolloOptions,
-      );
-
     if (options.definitions && options.definitions.path) {
       await this.graphQlFactory.generateDefinitions(
         printSchema(options.schema),