Notoriously Psychedelic Modules

    @narando/nest-axios-interceptor
    TypeScript icon, indicating that this package has built-in type declarations

    2.2.0 • Public • Published

    @narando/nest-axios-interceptor

    Easily build and configure axios interceptors for the NestJS HttpModule/HttpService.

    NPM Version Package License NPM Downloads Travis

    Features

    • Define axios interceptors
    • Register interceptor on HttpService.axiosRef
    • Type-safe handling of custom options in request config

    Usage

    ⚠️ If you want to use @narando/nest-axios-interceptor with NestJS Version 6 or 7, please use the v1 release.

    The v2 release is only compatible with NestJS Versions 8 and 9 and @nestjs/axios package.

    Installation

    Install this module:

    $ npm i @narando/nest-axios-interceptor

    Creating an AxiosInterceptor

    Create a new module and import the HttpModule:

    // cats.module.ts
    import { HttpModule, HttpService } from "@nestjs/axios";
    
    @Module({
      imports: [HttpModule],
      providers: [CatsService],
    })
    export class CatsModule {}

    Bootstrap your new interceptor with this boilerplate:

    // logging.axios-interceptor.ts
    import { Injectable } from "@nestjs/common";
    import { HttpService } from "@nestjs/axios";
    import type { AxiosRequestConfig, AxiosResponse } from "axios";
    import {
      AxiosInterceptor,
      AxiosFulfilledInterceptor,
      AxiosRejectedInterceptor,
    } from "@narando/nest-axios-interceptor";
    
    @Injectable()
    export class LoggingAxiosInterceptor extends AxiosInterceptor {
      constructor(httpService: HttpService) {
        super(httpService);
      }
    
      // requestFulfilled(): AxiosFulfilledInterceptor<AxiosRequestConfig> {}
      // requestRejected(): AxiosRejectedInterceptor {}
      // responseFulfilled(): AxiosFulfilledInterceptor<AxiosResponse> {}
      // responseRejected(): AxiosRejectedInterceptor {}
    }

    By default, the interceptor uses identity functions (no-op) for all 4 possible events.

    To add your behaviour, override the class methods for the events you want to handle and return a function that will be used in the interceptor.

    // logging.axios-interceptor.ts
    @Injectable()
    export class LoggingAxiosInterceptor extends AxiosInterceptor {
      constructor(httpService: HttpService) {
        super(httpService);
      }
    
      requestFulfilled(): AxiosFulfilledInterceptor<AxiosRequestConfig> {
        return (config) => {
          // Log outgoing request
          console.log(`Request: ${config.method} ${config.path}`);
    
          return config;
        };
      }
    
      // requestRejected(): AxiosRejectedInterceptor {}
      // responseFulfilled(): AxiosFulfilledInterceptor<AxiosResponse> {}
      // responseRejected(): AxiosRejectedInterceptor {}
    }

    Setting custom options to the request config

    If you want to pass-through data from on interceptor function to another, add it to the request config object.

    First, define your new request config type. To avoid conflicts with other interceptors, we will define a Symbol and use it as the object key:

    // logging.axios-interceptor.ts
    const LOGGING_CONFIG_KEY = Symbol("kLoggingAxiosInterceptor");
    
    // Merging our custom properties with the base config
    interface LoggingConfig extends AxiosRequestConfig {
      [LOGGING_CONFIG_KEY]: {
        id: number;
      };
    }

    Now we have to update the interceptor to use this new config:

      // logging.axios-interceptor.ts
      @Injectable()
    - export class LoggingAxiosInterceptor extends AxiosInterceptor {
    + export class LoggingAxiosInterceptor extends AxiosInterceptor<LoggingConfig> {
        constructor(httpService: HttpService) {
          super(httpService);
        }
    
    -   requestFulfilled(): AxiosFulfilledInterceptor<AxiosRequestConfig> {
    +   requestFulfilled(): AxiosFulfilledInterceptor<LoggingConfig> {
          return (config) => {
            // Log outgoing request
            console.log(`Request: ${config.method} ${config.path}`);
    
            return config;
          };
        }
    
        // requestRejected(): AxiosRejectedInterceptor {}
    -   // responseFulfilled(): AxiosFulfilledInterceptor<AxiosResponse> {}
    +   // responseFulfilled(): AxiosFulfilledInterceptor<AxiosResponseCustomConfig<LoggingConfig>> {}
        // responseRejected(): AxiosRejectedInterceptor {}
      }

    With the updated typing, you can now use the extend configuration:

    // logging.axios-interceptor.ts
    const LOGGING_CONFIG_KEY = Symbol("kLoggingAxiosInterceptor");
    
    @Injectable()
    export class LoggingAxiosInterceptor extends AxiosInterceptor<LoggingConfig> {
      constructor(httpService: HttpService) {
        super(httpService);
      }
    
      requestFulfilled(): AxiosFulfilledInterceptor<LoggingConfig> {
        return (config) => {
          const requestId = 1234;
    
          config[LOGGING_CONFIG_KEY] = {
            id: requestId,
          };
          // Log outgoing request
          console.log(`Request(ID=${requestId}): ${config.method} ${config.path}`);
    
          return config;
        };
      }
    
      // requestRejected(): AxiosRejectedInterceptor {}
    
      responseFulfilled(): AxiosFulfilledInterceptor<
        AxiosResponseCustomConfig<LoggingConfig>
      > {
        return (response) => {
          const requestId = response.config[LOGGING_CONFIG_KEY].id;
          // Log response
          console.log(`Response(ID=${requestId}): ${response.status}`);
    
          return response;
        };
      }
    
      // responseRejected(): AxiosRejectedInterceptor {}
    }

    Handling Errors

    By default, the axios error (rejected) interceptors pass the error with type any. This is not really helpful as we can't do anything with it.

    Internally, axios wraps all errors in a custom object AxiosError. We can use the class method isAxiosError to assert that the passed error is indeed of type AxiosError, and then process it how we want:

    // logging.axios-interceptor.ts
    
    @Injectable()
    export class LoggingAxiosInterceptor extends AxiosInterceptor {
      constructor(httpService: HttpService) {
        super(httpService);
      }
    
      // requestFulfilled(): AxiosFulfilledInterceptor<AxiosRequestConfig> {}
      // requestRejected(): AxiosRejectedInterceptor {}
      // responseFulfilled(): AxiosFulfilledInterceptor<AxiosResponse> {}
    
      responseRejected(): AxiosRejectedInterceptor {
        return (err) => {
          if (this.isAxiosError(err)) {
            const { config, response } = err;
    
            console.log(
              `Error ${response.status} in request "${config.method} ${config.path}`
            );
          } else {
            console.error("Unexpected generic error", err);
          }
    
          throw err;
        };
      }
    }

    License

    This repository is published under the MIT License.

    Keywords

    none

    Install

    npm i @narando/nest-axios-interceptor

    DownloadsWeekly Downloads

    4,893

    Version

    2.2.0

    License

    MIT

    Unpacked Size

    19.5 kB

    Total Files

    27

    Last publish

    Collaborators

    • apricote
    • brandolpho
    • marcmogdanz
    • narandosystem