# renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado architecture

> Architecture diagram of the GitHub repository renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado
- Repository: https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado

## Overview

##### Project type and purpose
- This is a full-stack, microservices-based application implementing the Saga Orchestrator pattern.
- It consists of five Spring Boot services that coordinate a distributed transaction via Apache Kafka.
- Datastores: MongoDB (order history), PostgreSQL (product validation, payment, inventory). No persistent store for the orchestrator.

##### File structure
- Top-level directories:
- order-service
- orchestrator-service
- product-validation-service
- payment-service
- inventory-service
- build.py, docker-compose.yml, README.md
- Each service is a standalone Spring Boot/Gradle project with its own src/main/java and application.yml.
- Configurations for Kafka, exception handlers, DTOs, producers/consumers are under each service’s config and core packages.
- Docker artifacts: Dockerfile in each service, a single docker-compose.yml at root, and a Python build script.

##### README for architectural insights
- Five microservices
- An orchestrator that drives saga steps
- Kafka as message broker
- Three PostgreSQL DBs and one MongoDB
- Endpoints:
- Order-Service exposes REST to start/retrieve saga data (Swagger UI on port 3000).
- Execution via docker-compose or build.py.

a. Main components
- Order-Service (MongoDB)
- Orchestrator-Service (no DB)
- Product-Validation-Service (PostgreSQL)
- Payment-Service (PostgreSQL)
- Inventory-Service (PostgreSQL)
- Apache Kafka cluster (topics for commands & events)
- Databases: 3× PostgreSQL instances, 1× MongoDB
- Redpanda Console (optional visibility)
- docker-compose orchestration layer
b. Relationships and interactions
1. Client → Order-Service (REST API “start saga”)
2. Order-Service produces “OrderCreated” event to Kafka topic
3. Orchestrator-Service consumes “OrderCreated,” logs saga state, and publishes “ValidateProduct” command
4. Product-Validation-Service consumes “ValidateProduct,” writes to its DB, then publishes “ProductValidated” event
5. Orchestrator consumes “ProductValidated,” logs state, sends “ProcessPayment” command
6. Payment-Service consumes “ProcessPayment,” writes to its DB, publishes “PaymentProcessed” event
7. Orchestrator consumes “PaymentProcessed,” logs state, sends “AllocateInventory” command
8. Inventory-Service consumes “AllocateInventory,” writes to its DB, publishes “InventoryAllocated” event
9. Orchestrator consumes “InventoryAllocated,” marks saga as complete; final status can be retrieved via Order-Service
c. Architectural patterns and principles
- Saga Orchestrator pattern for distributed transactions
- Event-driven, asynchronous communication via Kafka topics
- Single responsibility per microservice
- Polyglot persistence (MongoDB for events/logs, PostgreSQL for domain data)
- Centralized error handling and DTO mapping in each service
d. Key technologies and libraries
- Java 17, Spring Boot 3, Spring Kafka
- Docker & docker-compose
- Kafka (Redpanda Console)
- Gradle build scripts (automated via build.py)
- MongoDB, PostgreSQL

##### Important details
- Error or compensation flows (if implemented)
- Orchestration logic outside of any database

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Layer
    Client["Client"]:::client
    %% Order-Service
    subgraph "Order-Service"
        OSApp["OrderServiceApplication"]:::microservice
        OSController["OrderController"]:::microservice
        OSConsumer["EventConsumer"]:::microservice
        OSProducer["SagaProducer"]:::microservice
        OSData["MongoDB\nDocuments & Repositories"]:::db
    end
    %% Orchestrator-Service
    subgraph "Orchestrator-Service"
        ORApp["OrchestratorServiceApplication"]:::orchestrator
        ORConsumer["SagaOrchestratorConsumer"]:::orchestrator
        ORProducer["SagaOrchestratorProducer"]:::orchestrator
        ORTopics["ETopics"]:::orchestrator
    end
    %% Product-Validation-Service
    subgraph "Product-Validation-Service"
        PVApp["ProductValidationServiceApplication"]:::microservice
        PVConsumer["ProductValidationConsumer"]:::microservice
        PVProducer["KafkaProducer"]:::microservice
        PVLogic["ProductValidationService"]:::microservice
        PVRepo["ProductRepository\nValidationRepository"]:::db
    end
    %% Payment-Service
    subgraph "Payment-Service"
        PAApp["PaymentServiceApplication"]:::microservice
        PAConsumer["PaymentConsumer"]:::microservice
        PAProducer["KafkaProducer"]:::microservice
        PARepo["PostgreSQL DB"]:::db
    end
    %% Inventory-Service
    subgraph "Inventory-Service"
        INApp["InventoryServiceApplication"]:::microservice
        INConsumer["InventoryConsumer"]:::microservice
        INProducer["KafkaProducer"]:::microservice
        INRepo["PostgreSQL DB"]:::db
    end
    %% Kafka Cluster
    Kafka["Apache Kafka\n(Redpanda)"]:::kafka
    %% Orchestration
    DockerCompose["docker-compose.yml"]:::infra
    BuildScript["build.py"]:::infra
    README["README.md"]:::infra

    %% Saga Flow
    Client -->|"1 POST /orders (start saga)"| OSApp
    OSApp -->|"2 publish OrderCreated"| Kafka
    Kafka -->|"3 consume OrderCreated"| ORConsumer
    ORConsumer -->|"4 publish ValidateProduct"| Kafka
    Kafka -->|"5 consume ValidateProduct"| PVConsumer
    PVConsumer -->|"6 publish ProductValidated"| Kafka
    Kafka -->|"7 consume ProductValidated"| ORConsumer
    ORConsumer -->|"8 publish ProcessPayment"| Kafka
    Kafka -->|"9 consume ProcessPayment"| PAConsumer
    PAConsumer -->|"10 publish PaymentProcessed"| Kafka
    Kafka -->|"11 consume PaymentProcessed"| ORConsumer
    ORConsumer -->|"12 publish AllocateInventory"| Kafka
    Kafka -->|"13 consume AllocateInventory"| INConsumer
    INConsumer -->|"14 publish InventoryAllocated"| Kafka
    Kafka -->|"15 consume InventoryAllocated"| ORConsumer
    ORConsumer -->|"16 saga complete"| OSApp

    %% Links
    click OSApp "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/order-service/src/main/java/br/com/microservices/orchestrated/orderservice/OrderServiceApplication.java"
    click OSController "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/order-service/src/main/java/br/com/microservices/orchestrated/orderservice/core/controller/OrderController.java"
    click OSConsumer "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/order-service/src/main/java/br/com/microservices/orchestrated/orderservice/core/consumer/EventConsumer.java"
    click OSProducer "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/order-service/src/main/java/br/com/microservices/orchestrated/orderservice/core/producer/SagaProducer.java"
    click OSData "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/tree/master/order-service/src/main/java/br/com/microservices/orchestrated/orderservice/core/document/"
    click ORApp "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/orchestrator-service/src/main/java/br/com/microservices/orchestrated/orchestratorservice/OrchestratorServiceApplication.java"
    click ORConsumer "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/orchestrator-service/src/main/java/br/com/microservices/orchestrated/orchestratorservice/core/consumer/SagaOrchestratorConsumer.java"
    click ORProducer "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/orchestrator-service/src/main/java/br/com/microservices/orchestrated/orchestratorservice/core/producer/SagaOrchestratorProducer.java"
    click ORTopics "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/orchestrator-service/src/main/java/br/com/microservices/orchestrated/orchestratorservice/core/enums/ETopics.java"
    click PVApp "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/product-validation-service/src/main/java/br/com/microservices/orchestrated/productvalidationservice/ProductValidationServiceApplication.java"
    click PVConsumer "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/product-validation-service/src/main/java/br/com/microservices/orchestrated/productvalidationservice/core/consumer/ProductValidationConsumer.java"
    click PVProducer "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/product-validation-service/src/main/java/br/com/microservices/orchestrated/productvalidationservice/core/producer/KafkaProducer.java"
    click PVLogic "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/product-validation-service/src/main/java/br/com/microservices/orchestrated/productvalidationservice/core/service/ProductValidationService.java"
    click PVRepo "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/product-validation-service/src/main/java/br/com/microservices/orchestrated/productvalidationservice/core/repository/ProductRepository.java"
    click PVRepo "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/product-validation-service/src/main/java/br/com/microservices/orchestrated/productvalidationservice/core/repository/ValidationRepository.java"
    click PAApp "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/payment-service/src/main/java/br/com/microservices/orchestrated/paymentservice/PaymentServiceApplication.java"
    click PAConsumer "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/payment-service/src/main/java/br/com/microservices/orchestrated/paymentservice/core/consumer/PaymentConsumer.java"
    click PAProducer "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/payment-service/src/main/java/br/com/microservices/orchestrated/paymentservice/core/producer/KafkaProducer.java"
    click INApp "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/inventory-service/src/main/java/br/com/microservices/orchestrated/inventoryservice/InventoryServiceApplication.java"
    click INConsumer "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/inventory-service/src/main/java/br/com/microservices/orchestrated/inventoryservice/core/consumer/InventoryConsumer.java"
    click INProducer "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/inventory-service/src/main/java/br/com/microservices/orchestrated/inventoryservice/core/producer/KafkaProducer.java"
    click DockerCompose "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/docker-compose.yml"
    click BuildScript "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/build.py"
    click README "https://github.com/renanssantos1/arquitetura-de-microsservicos-padrao-saga-orquestrado/blob/master/README.md"

    %% Styles
    classDef microservice fill:#AED6F1,stroke:#21618C,color:#1B2631;
    classDef db fill:#A9DFBF,stroke:#1D8348,color:#145A32;
    classDef kafka fill:#F9E79F,stroke:#B7950B,color:#6E2C00;
    classDef orchestrator fill:#F5B7B1,stroke:#C0392B,color:#641E16;
    classDef client fill:#D2B4DE,stroke:#6C3483,color:#4A235A;
    classDef infra fill:#D5D8DC,stroke:#566573,color:#17202A;
```
