@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

// ./config/configuration.ts

export default () => ({
  
  service: process.env.<SERVICE_NAME> || <service_name>,

  redis: {
    host: process.env.REDIS_HOST || 'localhost',
    port: parseInt(process.env.REDIS_PORT, 10) || 6379,
    password: process.env.REDIS_PASSWORD || '',
  },

  cache: {
    prefix: process.env.CACHE_PREFIX || 'API-CACHE',
    ttl: parseInt(process.env.CACHE_TTL, 10) || 600,
    logCacheHit: process.env.CACHE_HIT_LOG === 'true',
  },

  ...
});

Modulo

// app.module.ts

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { APP_INTERCEPTOR } from '@nestjs/core';
import { CacherInterceptor, RpcConfigModule } from '@nclabs/rpc-config';
import configuration from './config/configuration';

@Module({
  imports: [    
    // Config - importante para o cache que a configuração seja global
    ConfigModule.forRoot({   
      cache: true,
      isGlobal: true,
      load: [configuration],
    }),
    // RPC Config Module
    RpcConfigModule.forRoot(),
  ],
  ...
  providers: [
    ...
    // Cache Manager Interceptor
    {
      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 ACTION
   */  
  @Rest({
    rpc: config.service,
    rest: {
      methods: ['GET', 'POST'],
      path: '/user-credential/:id',
    },
    cache: {
      keys: ['#headers.authorization', '#params.username'],
      ttl: 200,
    },
  })
  userCredential(@Payload() params: { username: string }): Observable<UserCredential> {
    return this.appService.getUserCredential();
  }

  ...

  /**
   * 
   *    RPC ACTION
   */  
  @Action({
    rpc: 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
   */  
  @Event({
    rpc: config.service,
    name: 'user-changed',
  })
  eventTeste(@Payload() params: UserPayload /* @Ctx() context: NatsContext */): void {
    // do something
    return;
  }

  ...
}