Merge branch 'luas10c-upgrade/apollo-v4' into next

Author: kamilmysliwiec

.gitignore

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

package.json

@@ -26,7 +26,7 @@
     "prepare": "husky install"
   },
   "resolutions": {
-    "graphql": "15.8.0"
+    "graphql": "16.6.0"
   },
   "devDependencies": {
     "@commitlint/cli": "17.4.2",
@@ -45,7 +45,7 @@
     "eslint-config-prettier": "8.6.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.4.1",

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,35 @@
-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,
+import { ApolloServer, type BaseContext } from '@apollo/server';
+import { ApolloServerErrorCode } from '@apollo/server/errors';
+import { expressMiddleware } from '@apollo/server/express4';
+import { ApolloServerPluginLandingPageLocalDefault } from '@apollo/server/plugin/landingPage/default';
+import * as express from 'express';
+import * as http from 'node:http';
+
+import { fastifyApolloHandler } from '@as-integrations/fastify';
+import { HttpStatus } from '@nestjs/common';
+
+const apolloPredefinedExceptions: Partial<Record<HttpStatus, string>> = {
+  [HttpStatus.BAD_REQUEST]: ApolloServerErrorCode.BAD_USER_INPUT,
+  [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 +46,7 @@ export abstract class ApolloBaseDriver<
   }
 
   public stop() {
-    return this._apolloServer?.stop();
+    return this.apolloServer?.stop();
   }
 
   public async mergeDefaultOptions(options: T): Promise<T> {
@@ -67,11 +65,7 @@ export abstract class ApolloBaseDriver<
         typeof options.playground === 'object' ? options.playground : undefined;
       defaults = {
         ...defaults,
-        plugins: [
-          ApolloServerPluginLandingPageGraphQLPlayground(
-            playgroundOptions,
-          ) as PluginDefinition,
-        ],
+        plugins: [ApolloServerPluginLandingPageLocalDefault(playgroundOptions)],
       };
     } else if (
       (options.playground === undefined &&
@@ -80,7 +74,7 @@ export abstract class ApolloBaseDriver<
     ) {
       defaults = {
         ...defaults,
-        plugins: [ApolloServerPluginLandingPageDisabled() as PluginDefinition],
+        plugins: [ApolloServerPluginLandingPageLocalDefault()],
       };
     }
 
@@ -115,68 +109,79 @@ export abstract class ApolloBaseDriver<
       );
   }
 
-  protected async registerExpress(
-    apolloOptions: T,
-    { preStartHook }: { preStartHook?: () => void } = {},
-  ) {
-    const { ApolloServer } = loadPackage(
-      'apollo-server-express',
-      'GraphQLModule',
-      () => require('apollo-server-express'),
-    );
-    const { disableHealthCheck, path, onHealthCheck, cors, bodyParserConfig } =
-      apolloOptions;
+  protected async registerExpress(options: T, hooks?: any) {
+    if (hooks?.preStartHook) {
+      hooks?.preStartHook();
+    }
+
+    const cors = loadPackage('cors', null, () => require('cors'));
+
+    const { path, typeDefs, resolvers, schema } = options;
 
     const httpAdapter = this.httpAdapterHost.httpAdapter;
     const app = httpAdapter.getInstance();
+    const httpServer = http.createServer(app);
 
-    preStartHook?.();
+    // Set up Apollo Server
+    const server = new ApolloServer({
+      typeDefs,
+      resolvers,
+      schema,
+      ...options,
+      /**
+       * @TODO
+       * should remove serverWillStart from default plugins.
+       * after include plugins here
+       */
+      // TODO: fix - dont override plugins
+      // plugins: [ApolloServerPluginDrainHttpServer({ httpServer })],
+    });
 
-    const apolloServer = new ApolloServer(apolloOptions as any);
-    await apolloServer.start();
+    await server.start();
 
-    apolloServer.applyMiddleware({
-      app,
+    app.use(
       path,
-      disableHealthCheck,
-      onHealthCheck,
-      cors,
-      bodyParserConfig,
-    });
+      cors(options.cors),
+      express.json(),
+      expressMiddleware(server),
+    );
 
-    this._apolloServer = apolloServer;
+    this.apolloServer = server;
   }
 
-  protected async registerFastify(
-    apolloOptions: T,
-    { preStartHook }: { preStartHook?: () => void } = {},
-  ) {
-    const { ApolloServer } = loadPackage(
-      'apollo-server-fastify',
-      'GraphQLModule',
-      () => require('apollo-server-fastify'),
+  protected async registerFastify(options: T, hooks?: any) {
+    if (hooks?.preStartHook) {
+      hooks?.preStartHook();
+    }
+
+    const cors = loadPackage('@fastify/cors', null, () =>
+      require('@fastify/cors'),
     );
 
     const httpAdapter = this.httpAdapterHost.httpAdapter;
     const app = httpAdapter.getInstance();
 
-    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 { path, typeDefs, resolvers, schema } = options;
+    const server = new ApolloServer<BaseContext>({
+      typeDefs,
+      resolvers,
+      schema,
+      ...options,
+      // TODO: fix - dont override plugin
+      //plugins: [fastifyApolloDrainPlugin(app)],
+    });
 
-    this._apolloServer = apolloServer;
+    await server.start();
+
+    app.route({
+      url: path,
+      method: ['GET', 'POST', 'OPTIONS'],
+      handler: fastifyApolloHandler(server),
+    });
+
+    await app.register(cors, options.cors);
+
+    this.apolloServer = server;
   }
 
   private wrapFormatErrorFn(options: T) {
@@ -201,22 +206,26 @@ 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, httpStatus?.toString());
       }
 
       error.stack = exceptionRef?.stacktrace;
+      //TODO: we need to verify if previous behavior is to be kept
+      // if so we must open a PR on Apollo to include response inside the raised exception
+      //https://github.com/apollographql/apollo-server/blob/e6d0d6d9cbd78d4914adf2abb04d84710991849a/packages/server/src/errorNormalize.ts#L58
       error.extensions['response'] = exceptionRef?.response;
       return error;
     };

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

@@ -4,12 +4,8 @@ import {
   GqlOptionsFactory,
   SubscriptionConfig,
 } from '@nestjs/graphql';
-import {
-  ApolloServerPluginLandingPageGraphQLPlaygroundOptions,
-  Config,
-  GraphQLExecutor,
-} from 'apollo-server-core';
 import { GraphQLSchema } from 'graphql';
+import { CorsOptions } from 'cors';
 
 export interface ServerRegistration {
   /**
@@ -20,7 +16,7 @@ export interface ServerRegistration {
   /**
    * CORS configuration
    */
-  cors?: any | boolean;
+  cors?: CorsOptions;
 
   /**
    * Body-parser configuration
@@ -39,15 +35,15 @@ export interface ServerRegistration {
 }
 
 export interface ApolloDriverConfig
-  extends Omit<Config, 'typeDefs'>,
+  extends Omit</*Config*/ any, 'typeDefs'>,
     ServerRegistration,
     Omit<GqlModuleOptions, 'context'> {
   /**
    * Executor factory function
    */
   executorFactory?: (
     schema: GraphQLSchema,
-  ) => GraphQLExecutor | Promise<GraphQLExecutor>;
+  ) => /*GraphQLExecutor | Promise<GraphQLExecutor>*/ any;
 
   /**
    * If enabled, "subscriptions-transport-ws" will be automatically registered.
@@ -62,7 +58,7 @@ export interface ApolloDriverConfig
   /**
    * GraphQL playground options.
    */
-  playground?: boolean | ApolloServerPluginLandingPageGraphQLPlaygroundOptions;
+  playground?: boolean;
 
   /**
    * If enabled, will register a global interceptor that automatically maps

packages/apollo/lib/interfaces/apollo-driver-config.interface.ts

@@ -1,7 +1,7 @@
 import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper';
 import { ModulesContainer } from '@nestjs/core/injector/modules-container';
 import { BaseExplorerService, GqlModuleOptions } from '@nestjs/graphql';
-import { PLUGIN_METADATA } from '../apollo.constants';
+import { PLUGIN_METADATA } from '../constants';
 
 export class PluginsExplorerService extends BaseExplorerService {
   constructor(private readonly modulesContainer: ModulesContainer) {

packages/apollo/lib/services/plugins-explorer.service.ts

@@ -1,21 +1,25 @@
 import { INestApplicationContext } from '@nestjs/common';
 import { GraphQLModule } from '@nestjs/graphql';
-import { ApolloServerBase } from 'apollo-server-core';
 import { ApolloDriver } from '..';
 
+import { ApolloServer, type BaseContext } from '@apollo/server';
+
+type GetApolloServer = (
+  app: INestApplicationContext,
+) => ApolloServer<BaseContext>;
+
 /**
  * Returns the underlying ApolloServer instance for a given application.
  * @param app Nest application reference
  * @returns Apollo Server instance used by the host application
  */
-export function getApolloServer(
-  app: INestApplicationContext,
-): ApolloServerBase {
+export const getApolloServer: GetApolloServer = (app) => {
   try {
     const graphqlModule = app.get<GraphQLModule<ApolloDriver>>(GraphQLModule);
     return graphqlModule.graphQlAdapter?.instance;
   } catch (error) {}
+
   throw new Error(
     `Nest could not find the "GraphQLModule" in your application's container. Please, double-check if it's registered in the given application.`,
   );
-}
+};