Introducción a la arquitectura “EleganFlow”

EleganFlow: Arquitectura Modular, Robusta y Elegante

La arquitectura de software EleganFlow es un enfoque modular diseñado para aplicaciones construidas con el framework NestJS, aunque puede ser implementada en otros lenguajes y frameworks. Esta arquitectura se basa en la separación de responsabilidades en tres etapas claramente definidas: Verificación, Proceso y Presentación. Cada etapa se compone de reglas o procesos individuales que se alinean con el principio de responsabilidad única, lo que facilita la comprensión, el mantenimiento y la extensibilidad del sistema.

Justificación

En la mayoría de las aplicaciones modernas, la necesidad de mantener un código limpio, modular y fácilmente extensible es crucial. La arquitectura EleganFlow ofrece un marco estructurado donde cada componente tiene un propósito claro y se puede modificar o ampliar sin afectar otras partes del sistema. Además, el uso de principios de diseño como el principio de estrategia y responsabilidad única asegura que las reglas y procesos sean independientes, permitiendo un desarrollo más ágil y un código más robusto.

Principios

1. Principio de Responsabilidad Única

Cada regla o proceso tiene una única responsabilidad dentro de su contexto, lo que facilita su mantenimiento y comprensión.

2. Principio de Estrategia

Las reglas y procesos se implementan como estrategias independientes que pueden ser fácilmente modificadas o reemplazadas sin afectar el sistema en su totalidad.

3. Modularidad

Cada etapa del flujo (Verificación, Proceso, Presentación) es modular y funciona de manera autónoma, lo que permite una fácil integración y extensión.

4. Retroalimentación

En caso de falla en cualquier etapa, el sistema proporciona retroalimentación clara al usuario, indicando el estatus del proceso.

Estructura de la Arquitectura

Primera Etapa: Verificación

• Sintaxis: Validación inicial de la estructura y tipos de datos mediante DTOs (Data Transfer Objects).
• Semántica: Validación profunda basada en reglas de negocio. Cada regla es una implementación de la estrategia y se agrupan en una lista de verificación. La lista de verificación asegura que todas las reglas se cumplan antes de proceder al siguiente paso. Si alguna regla falla, se proporciona retroalimentación al usuario.

Segunda Etapa: Proceso

• Process: Cada paso del procesamiento de datos se implementa como un “process” que sigue el principio de responsabilidad única. Estos procesos se agrupan en un “blueprint” que define el flujo completo de procesamiento.
• Iteración y Enriquecimiento: Los procesos pueden depender de la información generada en etapas previas. Estos datos se pasan a través de un objeto común que alimenta las funciones o clases estratégicas de cada proceso.
• Rollback y Retroalimentación: En caso de falla en algún proceso, se puede realizar un rollback para deshacer las acciones previas o informar al usuario sobre el estatus del proceso.

Tercera Etapa: Presentación de Datos

• Transformación y Respuesta: En esta etapa se construye la respuesta final que se presentará al usuario. Puede involucrar consultas a la base de datos o simplemente formatear los resultados de las etapas previas. La función de presentación no debe generar nuevos registros en la base de datos.
• Interfaz de Salida Común: Para mantener la simplicidad y consistencia en las respuestas, se utiliza una interfaz de salida común con la siguiente estructura:

{
  "ok": boolean,
  "constraints": [],
  "message": string,
  "data": object
}

Ventajas

• Modularidad y Flexibilidad: La separación clara de etapas y la implementación de reglas y procesos como estrategias independientes permiten una mayor flexibilidad en el desarrollo y mantenimiento del sistema.
• Claridad y Simplicidad: Cada etapa y componente tiene un propósito claro, lo que facilita la comprensión del flujo de trabajo y la depuración del código.
• Reutilización: Las reglas y procesos, al ser independientes y modulares, pueden reutilizarse en diferentes partes del sistema o en otros proyectos.
• Retroalimentación Clara: El sistema proporciona información detallada en caso de errores, facilitando la identificación de problemas.

Desventajas

• Complejidad Inicial: La implementación de la arquitectura EleganFlow puede requerir un esfuerzo inicial considerable para definir todas las reglas, procesos y la interfaz de salida común.
• Sobrecarga de Desarrollo: La necesidad de mantener la modularidad y responsabilidad única en cada componente puede resultar en un incremento de la carga de desarrollo, especialmente en proyectos más simples.
• Curva de Aprendizaje: Los desarrolladores nuevos en el equipo pueden necesitar tiempo para adaptarse a esta arquitectura y comprender su funcionamiento.