# gaetanbloch/meal-order architecture

> Architecture diagram of the GitHub repository gaetanbloch/meal-order, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gaetanbloch/meal-order
- Repository: https://github.com/gaetanbloch/meal-order

## Overview

##### Project type and purpose
- This is a multi-module, event-driven microservices system for processing “meal orders.”
- It uses Domain-Driven Design (DDD), Hexagonal (Ports & Adapters) architecture, CQRS for commands/queries, the Outbox pattern with Debezium for reliable event publication, and Saga orchestration for long-running business transactions.

##### File structure
- Top-level modules:
- common – shared kernel (core DDD annotations, validation, Outbox+Debezium setup, Avro schemas)
- customer – Customer bounded context microservice
- order – Order bounded context microservice
- payment – Payment bounded context microservice
- restaurant – Restaurant bounded context microservice
- Each module follows the same layered structure:
- application/cqrs (command/query handlers)
- application/port/input + output (use case interfaces)
- domain (entities, value objects, events, services)
- infrastructure/adapter (secondary adapters for persistence, messaging)
- presentation/adapter (primary adapters – REST resources)
- Shared configuration: each service has its own application.properties and Maven pom.xml; all share the common module.

##### Key architectural insights from README
- Minimal README suggests “meal-order” orchestrates all contexts.
- Avro schemas in common/src/main/resources/avro specify the contract for messages exchanged over Kafka.

##### Detail
- Four bounded context services plus the common library
- Full Outbox→Debezium→Kafka→Consumer cycle for each service
- Saga steps across services (e.g., OrderCreated → PaymentRequested → PaymentCompleted → RestaurantApprovalRequested → RestaurantApproved → OrderCompleted)
- Don’t omit the Schema Registry / Avro schema definitions

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External
    HTTP["HTTP Client / API Gateway"]:::external

    %% Shared Library
    COMMON["Common Module"]:::shared
    AVRO["Avro Schemas"]:::shared
    OUTBOX_CONF["Outbox+Debezium Config"]:::shared
    SAGA["Saga Orchestration Support"]:::shared

    %% Kafka
    KAFKA["Kafka Cluster\n+ Schema Registry"]:::kafka

    %% Customer Service
    subgraph "Customer Service"
        direction TB
        CS_API["CustomerResource REST API"]:::service
        CS_App["Customer CQRS Handlers"]:::service
        CS_Port["Customer Ports (Input/Output)"]:::service
        CS_Domain["Customer Domain"]:::service
        CS_Infra["Customer Infrastructure"]:::service
        CS_DB["CustomerDB\n(PostgreSQL)"]:::db
        CS_Outbox["Customer Outbox Table"]:::db
    end

    %% Order Service
    subgraph "Order Service"
        direction TB
        OR_API["OrderResource REST API"]:::service
        OR_App["Order CQRS Handlers\n& Message Listeners"]:::service
        OR_Port["Order Ports (Input/Output)"]:::service
        OR_Domain["Order Domain"]:::service
        OR_Infra["Order Infrastructure"]:::service
        OR_DB["OrderDB\n(PostgreSQL)"]:::db
        OR_Outbox["Order Outbox Table"]:::db
    end

    %% Payment Service
    subgraph "Payment Service"
        direction TB
        PAY_App["PaymentCommandHandler"]:::service
        PAY_Port["Payment Ports (Input/Output)"]:::service
        PAY_Domain["Payment Domain"]:::service
        PAY_Infra["Payment Infrastructure"]:::service
        PAY_DB["PaymentDB\n(PostgreSQL)"]:::db
        PAY_Outbox["Payment Outbox Table"]:::db
    end

    %% Restaurant Service
    subgraph "Restaurant Service"
        direction TB
        REST_App["RestaurantCommandHandler"]:::service
        REST_Port["Restaurant Ports (Input/Output)"]:::service
        REST_Domain["Restaurant Domain"]:::service
        REST_Infra["Restaurant Infrastructure"]:::service
        REST_DB["RestaurantDB\n(PostgreSQL)"]:::db
        REST_Outbox["Restaurant Outbox Table"]:::db
    end

    %% Debezium Connectors
    D_Cust["Debezium Connector\n(Customer Outbox)"]:::deb
    D_Order["Debezium Connector\n(Order Outbox)"]:::deb
    D_Pay["Debezium Connector\n(Payment Outbox)"]:::deb
    D_Rest["Debezium Connector\n(Restaurant Outbox)"]:::deb

    %% Flows Customer
    HTTP -->|REST call| CS_API
    CS_API -->|invoke| CS_App
    CS_App -->|write| CS_DB
    CS_App -->|insert| CS_Outbox
    CS_Outbox -->|change event| D_Cust
    D_Cust -->|publish| KAFKA
    KAFKA -->|consume| CS_Infra

    %% Flows Order
    HTTP -->|REST call| OR_API
    OR_API -->|invoke| OR_App
    OR_App -->|write| OR_DB
    OR_App -->|insert| OR_Outbox
    OR_Outbox -->|change event| D_Order
    D_Order -->|publish| KAFKA
    KAFKA -->|consume| OR_Infra

    %% Flows Payment
    KAFKA -->|consume| PAY_Infra
    PAY_Infra -->|invoke| PAY_App
    PAY_App -->|write| PAY_DB
    PAY_App -->|insert| PAY_Outbox
    PAY_Outbox -->|change event| D_Pay
    D_Pay -->|publish| KAFKA

    %% Flows Restaurant
    KAFKA -->|consume| REST_Infra
    REST_Infra -->|invoke| REST_App
    REST_App -->|write| REST_DB
    REST_App -->|insert| REST_Outbox
    REST_Outbox -->|change event| D_Rest
    D_Rest -->|publish| KAFKA

    %% Common connections
    COMMON --> AVRO
    COMMON --> OUTBOX_CONF
    COMMON --> SAGA

    %% Click Events
    click COMMON "https://github.com/gaetanbloch/meal-order/blob/main/common/pom.xml"
    click COMMON "https://github.com/gaetanbloch/meal-order/tree/main/common/src/main/java/io/gbloch/meal"
    click AVRO "https://github.com/gaetanbloch/meal-order/tree/main/common/src/main/resources/avro"
    click OUTBOX_CONF "https://github.com/gaetanbloch/meal-order/tree/main/common/src/main/java/io/gbloch/meal/infrastructure/outbox"
    click SAGA "https://github.com/gaetanbloch/meal-order/tree/main/common/src/main/java/io/gbloch/meal/infrastructure/saga"

    click CS_API "https://github.com/gaetanbloch/meal-order/blob/main/customer/src/main/java/io/gbloch/meal/customer/presentation/adapter/primary/CustomerResource.java"
    click CS_App "https://github.com/gaetanbloch/meal-order/tree/main/customer/src/main/java/io/gbloch/meal/customer/application/cqrs"
    click CS_Port "https://github.com/gaetanbloch/meal-order/tree/main/customer/src/main/java/io/gbloch/meal/customer/application/port/input"
    click CS_Port "https://github.com/gaetanbloch/meal-order/tree/main/customer/src/main/java/io/gbloch/meal/customer/application/port/output"
    click CS_Domain "https://github.com/gaetanbloch/meal-order/tree/main/customer/src/main/java/io/gbloch/meal/customer/domain"
    click CS_Infra "https://github.com/gaetanbloch/meal-order/tree/main/customer/src/main/java/io/gbloch/meal/customer/infrastucture/adapter/secondary"

    click OR_API "https://github.com/gaetanbloch/meal-order/blob/main/order/src/main/java/io/gbloch/meal/order/presentation/adapter/primary/OrderResource.java"
    click OR_App "https://github.com/gaetanbloch/meal-order/tree/main/order/src/main/java/io/gbloch/meal/order/application/cqrs"
    click OR_App "https://github.com/gaetanbloch/meal-order/tree/main/order/src/main/java/io/gbloch/meal/order/application/message"
    click OR_Port "https://github.com/gaetanbloch/meal-order/tree/main/order/src/main/java/io/gbloch/meal/order/application/port/input"
    click OR_Port "https://github.com/gaetanbloch/meal-order/tree/main/order/src/main/java/io/gbloch/meal/order/application/port/output"
    click OR_Domain "https://github.com/gaetanbloch/meal-order/tree/main/order/src/main/java/io/gbloch/meal/order/domain"
    click OR_Infra "https://github.com/gaetanbloch/meal-order/tree/main/order/src/main/java/io/gbloch/meal/order/infrastucture/adapter/secondary"

    click PAY_App "https://github.com/gaetanbloch/meal-order/blob/main/payment/src/main/java/io/gbloch/meal/payment/application/cqrs/command/PaymentCommandHandler.java"
    click PAY_Port "https://github.com/gaetanbloch/meal-order/tree/main/payment/src/main/java/io/gbloch/meal/payment/application/port/input"
    click PAY_Port "https://github.com/gaetanbloch/meal-order/tree/main/payment/src/main/java/io/gbloch/meal/payment/application/port/output"
    click PAY_Domain "https://github.com/gaetanbloch/meal-order/tree/main/payment/src/main/java/io/gbloch/meal/payment/domain"
    click PAY_Infra "https://github.com/gaetanbloch/meal-order/tree/main/payment/src/main/java/io/gbloch/meal/payment/infrastucture/adapter/secondary"

    click REST_App "https://github.com/gaetanbloch/meal-order/blob/main/restaurant/src/main/java/io/gbloch/meal/restaurant/application/cqrs/command/RestaurantCommandHandler.java"
    click REST_Port "https://github.com/gaetanbloch/meal-order/tree/main/restaurant/src/main/java/io/gbloch/meal/restaurant/application/port/input"
    click REST_Port "https://github.com/gaetanbloch/meal-order/tree/main/restaurant/src/main/java/io/gbloch/meal/restaurant/application/port/output"
    click REST_Domain "https://github.com/gaetanbloch/meal-order/tree/main/restaurant/src/main/java/io/gbloch/meal/restaurant/domain"
    click REST_Infra "https://github.com/gaetanbloch/meal-order/tree/main/restaurant/src/main/java/io/gbloch/meal/restaurant/infrastucture/adapter/secondary"

    %% Styles
    classDef service fill:#ccffcc,stroke:#333,stroke-width:1px
    classDef db fill:#cce5ff,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5
    classDef deb fill:#ffe5cc,stroke:#333,stroke-width:1px
    classDef kafka fill:#ffff99,stroke:#333,stroke-width:1px
    classDef shared fill:#f2f2f2,stroke:#333,stroke-width:1px
    classDef external fill:#e6e6e6,stroke:#333,stroke-width:1px
```
