Error Handling in NestJS

Welcome to this lesson on Error Handling in NestJS. So far, we've learned how to integrate MongoDB, transform data store objects to DTOs, and configure middleware in our NestJS application. Today, we'll focus on error handling, a critical aspect of building robust and user-friendly applications. Effective error handling ensures that our application can gracefully manage errors and provide meaningful feedback to users.

By the end of this lesson, you will be able to set up error handling for a NestJS application, create and use exception filters, and test various error scenarios to ensure your application handles errors as expected.

To handle errors effectively, NestJS provides a powerful mechanism called Exception Filters. These filters allow you to manage exceptions and provide custom error responses.

Now, let's move to the heart of our error handling approach: creating an Exception Filter.

Exception Filters in NestJS allow you to catch unhandled exceptions in your application and modify the response that users receive.

We'll walk through the process of creating an HttpExceptionFilter.

Step 1: Import Required Modules Create a new file named http-exception.filter.ts and start by importing the necessary modules:

import { ExceptionFilter, Catch, ArgumentsHost, HttpException, HttpStatus } from '@nestjs/common';
import { Request, Response } from 'express';

Step 2: Define the HttpExceptionFilter Class Next, we define the exception filter class:

@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
  catch(exception: HttpException, host: ArgumentsHost) {
    const ctx = host.switchToHttp();
    const response = ctx.getResponse<Response>();
    const request = ctx.getRequest<Request>();
    const status = exception.getStatus();

    const errorResponse = {
      statusCode: status,
      timestamp: new Date().toISOString(),
      path: request.url,
    };

    if (status === HttpStatus.INTERNAL_SERVER_ERROR) {
      response.status(status).json(errorResponse);
    } else {
      response.status(status).json({
        ...errorResponse,
        message: exception.message,
      });
    }
  }
}

Explanation:

• @Catch(HttpException) decorator tells NestJS to use this filter for HttpExceptions.
• The catch method handles the exception, extracts the relevant details (status, request URL), and constructs a response.
• Different responses for internal server errors and other types of errors ensure relevant information is sent back to the client.