Servicio en NodeJS que busca encontrar la mayor cantidad de mutantes de acuerdo a unos patrones que estos tienen en su ADN.
| Statements | Branches | Functions | Lines |
|---|---|---|---|
 |
 |
 |
 |
Las instrucciones aquí te permitirán obtener una copia del proyecto en funcionamiento en tu máquina local para propósitos de desarrollo y pruebas. Mira Instalación 🔧 para conocer como instalar el proyecto.
Para realizar la instalación local de debe contar con unos requisitos:
- NodeJS v12+
- NPM
- Postgresql DB
- Redis
Si se tiene instalado Docker es mucho más fácil, solo se necesita:
- Docker
- docker-compose
Hay dos formas de poner a correr nuestro servicio xmen:
- Forma tradicional (instaladar todo en el equipo)
- Docker con docker-compose
Para la forma tradicional, debemos tener antes una base de datos en Postgresql y una instancia de Redis. Primero que todo debemos instalar las dependendencias del proyecto ejecutando:
npm install
Luego debemos modificar las variables de entorno que se encuentran dentro del archivo .env.dev (development). Por ultimo para correr nuestro programa solo debemos ejecutar el comando:
npm run watch
Luego de esto quedará una instancia corriendo en el puerto 3000. Para probar que todo funciona bien puede hacerse una petición HTTP:
GET http://localhost:3000/stats/
Para esta forma, debemos tener previamente instalado docker y docker-compose en nuestro equipo. Luego, lo unico que debemos ejecutar es:
docker-compose up
De esta manera, se creará una instancia de Postgresql, Redis y una de nuestro xmen-service. Luego de esto quedará una instancia corriendo en el puerto 3000. Para probar que todo funciona bien puede hacerse una petición HTTP:
GET http://localhost:3000/stats/
En esta ocasión, las pruebas que realizaremos serán unitarias. Nos enfocaremos en las pruebas del algoritmo de reconocimiento de DNA, para estas pruebas se crean una clase en util, con el patrón Builder, ayudandonos a realizar los tests más fácilmente. Las pruebas se ejecutan automaticamente al hacer un push o pull request con GitHub Actions, pero también podemos ejecutarlas manualmente. Primero debemos instalar los paquetes de npm con el comando:
npm install
Una vez instalados nuestros paquetes de npm podemos ejecutar las pruebas con:
npm test
Ñapa En la ruta /test/stress.py se puede encontrar un script de Python, que realiza 1.000.000 de peticiones, divididas en 12 threads, en mi maquina local me ha arrojado que todas las peticiones se completaron con promedio de 40 segundos.
Para el despliegue a la nube, teniendo en cuenta que el servicio podía recibir muchas peticiones (100 mil a 1 millón), se optó por utilizar un proxy reverso llamado Traefik, esto acompañado del servicio distribuido en varias instancias dentro de varios servidores, orquestado por la herramienta Docker Swarm. Para dar marcha a esto, se utilizó la herramienta de GitHub Actions para realizar un build de la imagen de docker del servicio y hacer push al registrador de imagenes en DockerHub cada vez que se hiciera un push a la rama main del repositorio.
El despliegue será manual. Una vez la imagen esté en DockerHub, dentro del archivo stack.yml podemos ver las configuraciones necesarias para hacer funcionar nuestro servicio. Debemos tener en cuenta que para esto, previamente se configuró DockerSwarm, Traefik, una instancia de Redis y una de Postgresql.
Con el siguiente comando desplegamos nuestro servicio:
docker stack deploy -c stack.yml xmen
Para pruebas podemos hacer peticiones a las siguientes URL:
POST - https://api.rankey.info/xmen/mutant
GET - https://api.rankey.info/xmen/stats
En la carpeta logic de este repositorio se encuentra 3 notebooks con lógicas para resolver el problema del algoritmo. Estos algoritmos se hicieron en Python con Jupyter Notebooks y posteriormente pasados a NodeJS.
- Backtraing - Algoritmo base para resolver el problema
- NodeJS - Entorno en tiempo de ejecución multiplataforma
- Express - Framework en nodejs para realizar APIs
- InversifyJS - Contenedor para inversión de control (IoC)
- TypeORM - ORM para conexión a bases de datos
- Redis - Almacen de datos en memoria
- Postgresql - Base de datos relacional
- Docker - Plataforma de contenedorización open-source
- Docker Swarm - Herramienta de orquestacion de contenedores
- Traefik - HTTP proxy reverso
- Jhon Gil Sepulveda - Trabajo Inicial - rankey1496
Este proyecto está bajo la Licencia ISC