@tresdoce-nestjs-toolkit/http-client

Tresdoce NestJS Toolkit
Http-Client

Este módulo está pensada para ser utilizada en NestJS Starter, o cualquier proyecto que utilice una configuración centralizada, siguiendo la misma arquitectura del starter.

Glosario

• 🥳 Demo
• 📝 Requerimientos básicos
• 🛠️ Instalar dependencia
• ⚙️ Configuración
• 👨‍💻 Uso
• 📄 Changelog
• 📜 License MIT

📝 Requerimientos básicos

• NestJS Starter
• Node.js v20.19.0 or higher (Download)
• YARN v1.22.22 or higher
• NPM v11.2.0 or higher
• NestJS v11.1.0 or higher (Documentación)

🛠️ Instalar dependencia

npm install -S @tresdoce-nestjs-toolkit/http-client

yarn add @tresdoce-nestjs-toolkit/http-client

⚙️ Configuración

El objeto httpClient es opcional a la configuración, la cual admite el objeto de configuración para Axios y Axios-retry por medio de la propiedad httpOptions, y también es posible propagar headers a las peticiones por medio de la propiedad propagateHeaders que es un array de string.

//./src/config/configuration.ts
import { Typings } from '@tresdoce-nestjs-toolkit/paas';
import { registerAs } from '@nestjs/config';

export default registerAs('config', (): Typings.AppConfig => {
  return {
    //...
    httpClient: {
      httpOptions: {
        timeout: 5000,
        retries: 5,
      },
      propagateHeaders: process.env.PROPAGATE_HEADERS_HTTP
        ? process.env.PROPAGATE_HEADERS_HTTP.split(',')
        : [],
    },
    //...
  };
});

Importar HttpClientModule en el módulo que requiera utilizarlo, o bien se puede utilizarla de manera global en el app.module.ts.

En cuanto al HttpClientInterceptor es importante instanciarlo para poder propagar los headers de la traza y cualquier otro header que se configure.

import { APP_INTERCEPTOR } from '@nestjs/core';
import { HttpClientModule, HttpClientInterceptor } from '@tresdoce-nestjs-toolkit/http-client';

@Module({
  imports: [
    //...
    HttpClientModule,
    //...
  ],
  providers: [
    //...
    {
      provide: APP_INTERCEPTOR,
      useClass: HttpClientInterceptor,
    },
    //...
  ],
  //...
})
export class AppModule {}

⚠️ En caso de que la propagación de headers no se realice correctamente, verificar el orden de los APP_INTERCEPTOR

Este módulo utiliza Axios y Axios-retry, por lo que puedes pasarle cualquier configuración de AxiosRequestConfig y/o AxiosRetryConfig por medio del método .register() como si fuera el httpModule original de NestJs, además de utilizar la configuración centralizada.

import { APP_INTERCEPTOR } from '@nestjs/core';
import { HttpClientModule, HttpClientInterceptor } from '@tresdoce-nestjs-toolkit/http-client';

@Module({
  imports: [
    //...
    HttpClientModule.register({
      timeout: 1000,
      retries: 5,
      //...
    }),
    //...
  ],
  providers: [
    //...
    {
      provide: APP_INTERCEPTOR,
      useClass: HttpClientInterceptor,
    },
    //...
  ],
  //...
})
export class AppModule {}

Configuración async

Cuando necesite pasar las opciones del módulo de forma asincrónica en lugar de estática, utilice el método .registerAsync() como si fuera el httpModule original de NestJS.

Hay varias formas para hacer esto.

• useFactory

Desde la configuración centralizada, debera crear un objeto de configuración para el módulo, y luego obtenerlo con la inyección del ConfigService.

HttpClientModule.registerAsync({
  imports: [ConfigModule],
  useFactory: async (configService: ConfigService) => configService.get('config.httpOptions'),
  inject: [ConfigService],
});

O también puede hacerlo asi.

HttpClientModule.registerAsync({
  useFactory: () => ({
    timeout: 1000,
    retries: 5,
    //...
  }),
});

• useClass

HttpClientModule.registerAsync({
  useClass: HttpConfigService,
});

Tenga en cuenta que en este ejemplo, el HttpConfigService tiene que implementar la interfaz HttpModuleOptionsFactory como se muestra a continuación.

@Injectable()
class HttpConfigService implements HttpModuleOptionsFactory {
  async createHttpOptions(): Promise<HttpModuleOptions> {
    const configurationData = await someAsyncMethod();
    return {
      timeout: configurationData.timeout,
      retries: 5,
      //...
    };
  }
}

• useExisting

Si desea reutilizar un proveedor de opciones existente en lugar de crear una copia dentro del HttpClientModule, utilice la sintaxis useExisting.

HttpClientModule.registerAsync({
  imports: [ConfigModule],
  useExisting: ConfigService,
});

👨‍💻 Uso

Inyectar el HttpClientService en el constructor de la clase y realice el request utilizando el servicio instanciando en el constructor.

//./src/app.service.ts
import { HttpClientService } from '@tresdoce-nestjs-toolkit/http-client';

export class AppService {
  constructor(private readonly httpClient: HttpClientService) {}
  //...

  async getInfoFromApi() {
    try {
      const { status, data } = await this.httpClient.get(encodeURI('https://api.domain.com'));
      return data;
    } catch (error) {
      throw new HttpException(error.response.data, error.response.status);
    }
  }

  //...
}

📄 Changelog

Todos los cambios notables de este paquete se documentarán en el archivo Changelog.

Made with ❤