feat(apollo): add wrapper error classes

Author: kamilmysliwiec

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

@@ -14,7 +14,7 @@ import { ApolloDriverConfig } from '../interfaces';
 import { createAsyncIterator } from '../utils/async-iterator.util';
 
 const apolloPredefinedExceptions: Partial<Record<HttpStatus, string>> = {
-  [HttpStatus.BAD_REQUEST]: ApolloServerErrorCode.BAD_USER_INPUT,
+  [HttpStatus.BAD_REQUEST]: ApolloServerErrorCode.BAD_REQUEST,
   [HttpStatus.UNAUTHORIZED]: 'UNAUTHENTICATED',
   [HttpStatus.FORBIDDEN]: 'FORBIDDEN',
 };

packages/apollo/lib/errors/authentication.error.ts

@@ -0,0 +1,19 @@
+import { GraphQLError, GraphQLErrorOptions } from 'graphql';
+
+/**
+ * This error is thrown when the user is not authenticated.
+ *
+ * "AuthenticationError" class was removed in the latest version of Apollo Server (4.0.0)
+ * It was moved to the @nestjs/apollo package to avoid regressions & make migration easier.
+ */
+export class AuthenticationError extends GraphQLError {
+  constructor(message: string, options?: GraphQLErrorOptions) {
+    super(message, {
+      ...options,
+      extensions: {
+        code: 'UNAUTHENTICATED',
+        ...options?.extensions,
+      },
+    });
+  }
+}

packages/apollo/lib/errors/forbidden.error.ts

@@ -0,0 +1,19 @@
+import { GraphQLError, GraphQLErrorOptions } from 'graphql';
+
+/**
+ * This error is thrown when the user is not authorized to access a resource.
+ *
+ * "ForbiddenError" class was removed in the latest version of Apollo Server (4.0.0)
+ * It was moved to the @nestjs/apollo package to avoid regressions & make migration easier.
+ */
+export class ForbiddenError extends GraphQLError {
+  constructor(message: string, options?: GraphQLErrorOptions) {
+    super(message, {
+      ...options,
+      extensions: {
+        code: 'FORBIDDEN',
+        ...options?.extensions,
+      },
+    });
+  }
+}

packages/apollo/lib/errors/index.ts

@@ -0,0 +1,4 @@
+export * from './authentication.error';
+export * from './forbidden.error';
+export * from './user-input.error';
+export * from './validation.error';

packages/apollo/lib/errors/user-input.error.ts

@@ -0,0 +1,20 @@
+import { ApolloServerErrorCode } from '@apollo/server/errors';
+import { GraphQLError, GraphQLErrorOptions } from 'graphql';
+
+/**
+ * This error is thrown when the user input is invalid.
+ *
+ * "UserInputError" class was removed in the latest version of Apollo Server (4.0.0)
+ * It was moved to the @nestjs/apollo package to avoid regressions & make migration easier.
+ */
+export class UserInputError extends GraphQLError {
+  constructor(message: string, options?: GraphQLErrorOptions) {
+    super(message, {
+      ...options,
+      extensions: {
+        code: ApolloServerErrorCode.BAD_USER_INPUT,
+        ...options?.extensions,
+      },
+    });
+  }
+}

packages/apollo/lib/errors/validation.error.ts

@@ -0,0 +1,20 @@
+import { ApolloServerErrorCode } from '@apollo/server/errors';
+import { GraphQLError, GraphQLErrorOptions } from 'graphql';
+
+/**
+ * This error is thrown when the user input does not pass validation.
+ *
+ * "ValidationError" class was removed in the latest version of Apollo Server (4.0.0)
+ * It was moved to the @nestjs/apollo package to avoid regressions & make migration easier.
+ */
+export class ValidationError extends GraphQLError {
+  constructor(message: string, options?: GraphQLErrorOptions) {
+    super(message, {
+      ...options,
+      extensions: {
+        code: ApolloServerErrorCode.GRAPHQL_VALIDATION_FAILED,
+        ...options?.extensions,
+      },
+    });
+  }
+}

packages/apollo/lib/index.ts

@@ -1,4 +1,5 @@
 export * from './decorators';
 export * from './drivers';
+export * from './errors';
 export * from './interfaces';
 export * from './utils';