Tutorial 8 - Sagas
Introducción
Durante el transcurso de la semana, ya hemos podido entender la importancia de los flujos de trabajo y las diferentes maneras en que podemos implementarlos. Concretamente, me refiero a los patrones de orquestación y coreografía. Así mismo, vimos que cuando usamos arquitecturas basadas en eventos, el uso del patrón saga es una buena forma de satisfacer las necesidades transaccionales de nuestros sistemas.
Durante este tutorial veremos como nuestros servicios fueron desmantelados del monolito y el código base para implementar un Coordinador Saga usando Orquestación. Por último, veremos como los servicios fueron implementados usando FastAPI por medio de un servidor Non-blocking I/O Single-Thread. Esto es una pequeña introducción de lo que veremos en el módulo de sistemas reactivos.
Antes de comenzar con el desarrollo, comience viendo el video tutorial donde se explican y elaboran algunos de los métodos a tratar aquí.
Tabla de contenidos
Preparación
Haga un fork del template de AeroAlpes en su repositorio de preferencia. Si necesita ayuda en como realizar este paso, use alguno de los siguientes links:
Si esta usando Gitpod puede ejecutar su código de forma inmediata. De lo contrario, instale las dependencias en su máquina o ambiente de desarrollo, usando el archivo de requirements.txt. La versión de Python que se usa es 3.10 pero el requerimiento mínimo es de 3.7. Para crear ambiente de desarrollo virtuales en su máquina local, es sugerible usar Conda, en los recursos adicionales del sitio puede encontrar un documento sobre su configuración.
En el caso de Docker, es necesario que instale Docker Desktop en su máquina de desarrollo y ejecute los comandos que puede encontrar en el archivo .gitpod.yml.
Para configurar Apache Pulsar debe configurar el cluster completo con los brokers, bookies y zookeepper. En ambientes locales lo mejor que puede hacer es usar el archivo docker-compose.yml que encuentra en el repositorio. Así mismo, puede encontrar los archivos .Dockerfile para cada uno de los servicios que se deben desplegar. Es importante tener en cuenta las configuraciones de red de los servicios, si tiene muchos problemas entre ellos, deje que todos los servicios exponan en la interface 0.0.0.0 y todos se expongan en su localhost.
En el caso de la base de datos puede usar una de las imágenes oficiales de MySQL 8. Para ver su uso vea el archivo docker-compose.yml.
Gitpod puede tardar un poco en instalar las dependencias la primera vez que crea el workspace. Usted puede observar el progreso de la instalación por medio de la vista de terminal en la parte inferior del IDE. Así mismo, en la esquina inferior derecha puede ver los pasos en ejecución con su correspondiente output.
Manos a la obra
Comience por entender los cambios en la estructura del proyecto. Este ya contiene un README con una breve explicación de la arquitectura de alto nivel y los cambios realizados.
Durante este tutorial, vamos a enfocarnos a:
- Completar la implementación del Coordinador de Saga, para que pueda oír los eventos del Broker eventos.
- Extender coordinador para que persista en disco el Saga Log.
- Realizar una implementación de Sagas usando coreografía.
1. Despliegue los servicios
Tal como se mostró en el video tutorial, despliegue todos los servicios. En el README del proyecto puede encontrar como desplegar cada servicio de forma autónoma o vea nuevamente dichos pasos en el video tutorial. Para la implementación de las Sagas los servicios que nos interesan son los servicios de pagos y gds.
2. Oir los eventos
En el archivo src/aeroalpes/modulos/sagas/aplicacion/coordinadores/saga_reservas.py modifique decore la función oir_mensaje para que pueda oir eventos de dominio. Otra opción es que usted decida que esta función oiga eventos de integración y modifique estos eventos a dominio. Cabe aclarar que a nivel de capa de aplicación, usamos los eventos de dominio y comandos de aplicación para evitar quedarnos atados a conceptos de infraestructura. Recuerde que los eventos de integración van a contar con diferentes versiones y por ende no queremos que nuestra lógica quede atada a dichos conceptos.
Tip: En el archivo src/aeroalpes/modulos/vuelos/aplicacion/__init__.py puede encontrar un ejemplo de registro de handlers usando pydispatch. Puede usar este mismo patrón con la función de oir_eventos.
3. Construir el comando
En el mismo archivo modifique el método construir_comando para que, dado un evento de dominio, se capture como argumentos o parametros de entrada para construir un comando. Para entender un poco más, lea el # TODO
4. Implementar el Saga Log
En el mismo archivo modifique el método persistir_en_saga_log para que se persiste en alguna base de datos cada evento y comando. En este caso, usted puede crear un nuevo repositorio usando el adaptador de SQLAlchemy.
5. Ejecutar y probar
Ya una vez con ello, ejecute los servicios y use los endpoints de prueba de cada uno de ellos, para generar eventos y comandos de prueba (puede verlos en los archivos main.py de cada servicio).
6. Prueba final
Intente crear una implementación de Sagas usando coreografía en vez de orquestación. Use los endpoints de prueba de cada servicio para probar la interacción.