@compusoluciones/grpc-connections

Módulo encargado de realizar las conexiones entre micro-servicios de siclik CompuSoluciones.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@compusoluciones/grpc-connections
Minified + gzip package size for @compusoluciones/grpc-connections in KB

Readme

Modulo de conexiones GRPC

Libreria de comunicaciones disponibles entre los diferentes micro servicios que existirán y convivirán en siclik de CompuSoluciones.

Arquitectura

.
|── lib
| └─ services // biblioteca de servicios que se ofrece
| └─ connections.js
| └─ helper.js
| └─ request.js
| └─ validate-config.js
| index.js // Unión de los micro servicios
|── .eslintrc.js
|── .gitignore
|── index.js
|── index.d.ts
|── package.json
|── yarn.lock
.

Actualizar versión

Cuando se realicen modificaciones o actualizaciones en el sdk es necesario actualizarlo también en npm siguiendo los siguientes pasos:

  • Tener una cuenta de npm con el correo de la empresa @compusoluciones
  • Acceso a la organización compusoluciones dada por una administrador de la misma.
  • Permisos para publicar en la organización.
  • Tener instalado el gestor de paquetes npm en tu maquina.
  • Asociar npm a tu cuenta con npm login (solo la primera vez).
  • Publicar con npm publish --access=public

Uso de la librería de protos

Para hacer funcionar el sdk es necesario importar las funcionalidades que nos ofrece la librería de protos. Es por esto que si se esta pensando en crear una nueva conexión en el sdk que requiera un proto no existente, primero se hay que dirigirse al proyecto protocol-buffers, se cree la conexión con el proto y se publique la nueva versión siguiendo las instrucciones en el README de dicho proyecto.

Cuando tengamos disponible para uso el proto necesario para nuestra nueva conexión es momento de dirigirnos al index del proyecto que sera el punto de entrada para las conexiones ofrecidas por el sdk.

Importar proto

Una vez que tengamos actualizado el modulo que contiene los protos podemos usarlos para establecer las conexiones de la siguiente manera desde el archivo connections.js que se encuentra en cada una de las carpetas de los micro servicios, siguiendo el ejemplo:

const grpc = require('grpc');

const protobuf = require('@compusoluciones/protocol-buffers')();
const packageDefinition = protobuf.userProto();
const { user } = grpc.loadPackageDefinition(packageDefinition);

En el ejemplo anterior se comienza importando el modulo grpc que es necesario para poder cargar el proto importado y generar las conexiones.

Posteriormente se comienza cargando la librería protocol-buffers que es la que contiene los protos que indican la manera en la que los servicios se comunicaran entre si. Después se declara la variable packageDefinition que es donde guardaremos los protos del servicio en especifico que necesitaremos, que en el ejemplo es el de users. Y por ultimo se procederemos a cargarlo en grpc con la función que nos ofrece loadPackageDefinition dando como parámetro el proto que guardamos anteriormente.

Realizar conexión

Una vez que logramos cargar nuestro archivo proto solo basta con realizar la conexión con el modulo de grpc de la siguiente manera:

new user.UserService(`${URL}:${PORT}`, credentials);

Forma de uso en micro servicios

Instalación

Cuando tengamos una función que realiza cierta conexión con algún micro servicio, podemos pasar a usar nuestro modulo desde node_modules instalado desde el gestor de paquetes npm de la siguiente manera:

// Desde NPM
$ npm install @compusoluciones/grpc-connections

// Desde YARN
$ yarn add @compusoluciones/grpc-connections

Establecer conexiones

Para establecer una conexión con otro micro servicio desde el nuestro, primero debemos recurrir a la documentación que existe en cada uno de los servicios que existe en este proyecto desde la carpeta service y posteriormente al micro servicio que necesitamos.

Una vez que conozcamos las funciones que existen y la manera de usarlas procederemos a importarlas y usarlas. En el siguiente ejemplo usaremos la conexión para obtener información de un usuario por medio de un correo electrónico valido brindada por la conexión de usuarios.

const grpcConnection = require('@compusoluciones/grpc-connections');

const { microServiceConfig } = require('./config');

const { users } = grpcConnection();

const getUserData = (userAccount, token) => (
users((microServiceConfig.users).getUserByEmail(userAccount, token)
.catch(throwCustomError)
);

Notas de uso

En el index esta disponible una función llamada validate() la cual nos ayudara a validar la información de conexión necesaria para conectar con el micro servicio solicitado que son servicePort y serviceUrl los cuales deben de ser enviados en el momento que se desea establecer la conexión.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.