@nclabs/rpc-config

RPC Config

Utilitário para configuração de rotas e cache em microserviços. Utilido especificamente para projetos nclabs

Instalação

npm i @nclabs/rpc-config

Uso

Configuração

# Environment variables

...

# ##################################################################### # 
#                                 REDIS                                 #
# ##################################################################### # 
REDIS_HOST=<host>
REDIS_PORT=<port>
REDIS_PASSWORD=<password>


# ##################################################################### # 
#                                 CACHE                                 #
# ##################################################################### # 
CACHE_PREFIX=API-CACHE
CACHE_TTL=600
CACHE_HIT_LOG=false

...

Modulo

// app.module.ts

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { RpcConfigModule } from '@nclabs/rpc-config';
import { APP_INTERCEPTOR } from '@nestjs/core';
import { CacherInterceptor } from '@nclabs/rpc-config';

@Module({
  imports: [
    // RPC Config Module - incluindo o cache
    RpcConfigModule.forRoot({
      cache: {
        prefix: process.env.CACHE_PREFIX,
        ttl: parseInt(process.env.CACHE_TTL, 10),
        logCacheHit: process.env.CACHE_HIT_LOG === 'true',
        redis: {
          host: process.env.REDIS_HOST,
          port: parseInt(process.env.REDIS_PORT, 10),
          password: process.env.REDIS_PASSWORD,
        },
      },
    }),

    //
    //   Ou, se não for utilizar o cache, importar o RpcConfigModule sem configuração
    //
    // 
    // RpcConfigModule.forRoot({}),
  ],
  controllers: [AppController],
  providers: [
    AppService,
    // Para utilizar o cache, é necessário adicionar o CacherInterceptor 
    // e utilizar a configuração de cache no RpcConfigModule
    {
      provide: APP_INTERCEPTOR,
      useClass: CacherInterceptor,
    },
  ],
})
export class AppModule {}

Controller

// app.controller.ts

import { Action, Event, Rest } from '@nclabs/rpc-config';
import configuration from './config/configuration';

const config = configuration();

@Controller()
export class AppController {
  ...

  /**
   * 
   *    REST 
   * 
   *    Permite que o metodo seja requisitado pela api-gateway.
   * 
   *    Na configuração abaixo as rotas GET e POST são permitidas na url: 
   * 
   *        <base_url>/user-credential/:id
   * 
   *        * base_url: http://<host>:<api_port>/<api_prefix>
   * 
   */  
  @Rest({
    service: config.service,
    rest: {
      methods: ['GET', 'POST'],
      path: '/user-credential/:id',
    },
    cache: {
      keys: ['#headers.authorization', "#params.username"],
      ttl: 1200, // 20 minutes
    },
  })
  userCredential(@Payload() params: { username: string }): Observable<UserCredential> {
    return this.appService.getUserCredential();
  }


  ...

  /**
   * 
   *    RPC ACTION
   * 
   *    Permite que o metodo seja requisitado através de um RPC client.
   * 
   *    * Mais informações em: 
   *      https://docs.nestjs.com/microservices/basics#sending-messages
   *        
   */  
  @Action({
    service: config.service,
    name: 'get-user-credential',
    cache: {
      keys: ['#params.apiKey'],
    },
  })
  getTokenFromKey(@Payload() params: { apiKey: string }): Obserable<UserCredential> {
    
    console.log('params', params);

    return this.appService.getUserCredential();
  }

  ...

  /**
   * 
   *    RPC EVENT
   * 
   * 
   *    Permite que o envio de um evento para o método através de um RPC client.
   * 
   *    * Mais informações em: 
   *      https://docs.nestjs.com/microservices/basics#publishing-events
   */  
  @Event({
    service: config.service,
    name: 'user-changed',
  })
  eventTeste(@Payload() params: UserPayload /* @Ctx() context: NatsContext */): void {
    
    // do something
    
    return;
  }

  ...
}