https://github.com/ecotoneframework/php-ddd-cqrs-event-sourcing-symfony-laravel-ecotone

Ecotone - ES DDD CQRS PHP Symfony Laravel example
https://github.com/ecotoneframework/php-ddd-cqrs-event-sourcing-symfony-laravel-ecotone

cqrs ddd domain-driven-design ecotone event-sourcing laravel php symfony

Last synced: 4 days ago
JSON representation

Ecotone - ES DDD CQRS PHP Symfony Laravel example

• Host: GitHub
• URL: https://github.com/ecotoneframework/php-ddd-cqrs-event-sourcing-symfony-laravel-ecotone
• Owner: ecotoneframework
• Created: 2021-03-07T19:58:16.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-13T10:33:01.000Z (3 months ago)
• Last Synced: 2024-12-30T14:17:56.379Z (11 days ago)
• Topics: cqrs, ddd, domain-driven-design, ecotone, event-sourcing, laravel, php, symfony
• Language: PHP
• Homepage:
• Size: 1.2 MB
• Stars: 99
• Watchers: 9
• Forks: 23
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ecotone Framework Demo Application

# Objectives

- To provide a simple example of how to implement `Domain Driven Design` and `Messaging Architecture` in PHP.  

- To show how to implement `CQRS`, `Event Sourcing` and `Hexagonal Architecture` in PHP.

- To show how to implement `Resilient`amd `Observable` `Microservices` in PHP.

# Playing with the demo

Run `docker-compose up -d` to start all services, and wait for them to start `docker-compose logs -f`.

This Demo provides two integrated Applications. 

- Customer Service - which allows for reporting issues by customers

- Backoffice Service - which allows for working on tickets by employees

Services communicate with each other using `RabbitMQ` with `Ecotone's Distributed Bus`.  

### Quickstart

- To report issue as a customer, go to [Customer Service](http://localhost:3000/)    

- From [Backoffice Service](http://localhost:3001/prepared-tickets) you may start working on ticket, that was correlated with issue reported by customer.  

- You may also check [Jaeger](http://localhost:3007/) to get full overview of how communication looks like and how each component behave and what is happening.

Additionaly you may check:  

- Whenever issue is reported, confirming email will be sent to the customer, which can be found [Mailbox](http://localhost:3004/).

- First time email is sent it's set up for failing, so you can get feeling of working with system that can recover from error messages using [Ecotone Pulse](http://localhost:3006/service/customer_service).

# Stack

- [Ecotone](https://docs.ecotone.tech/) - PHP Framework for building resilient, business oriented system in PHP

- [Symfony](https://symfony.com/) - PHP Framework for building web applications

- [Laravel](https://laravel.com/) - PHP Framework for building web applications

- [RabbitMQ](https://www.rabbitmq.com/) - Message Broker for asynchronous communication

- [Ecotone Pulse](https://docs.ecotone.tech/modules/ecotone-pulse) - Monitor for any processing errors and recover from failed messages.

- [OpenTelemetry with Jaeger](https://www.jaegertracing.io/) - Distributed Tracing for monitoring and troubleshooting microservices-based distributed systems

# Business Domain

## Customer Service

- `Customer Service` is `Laravel+Ecotone application`, where customers can report issues. This happens using `CQRS` combined with `Eloquent Models`.  

![Laravel CQRS](documentation/customer-service.png "Laravel CQRS") 

------

- Whenever new issue is reported, email is send to the with confirmation. This happens using `Asynchronous Event Handlers`, which are backed by `RabbitMQ`.

![Laravel asynchronous event handling](documentation/issue-reported.png "Laravel asynchronous events")

## Backoffice Service

- `Backoffice Service` is `Symfony+Ecotone application`, where employees can be registered and work on the tickets.  

All issues reported by customers are synchronized to `Backoffice Service` and are correlated with tickets.  

The synchronization between `Customer Service` and `Backoffice Service` is done using `Events` and `Distributed Bus` for cross service communication via `RabbitMQ`.  

![Symfony Microservice](documentation/ddd-cqrs-event-sourcing-php-hexagonal-architecture.png "Symfony Microservice")  

------

- Employees can work on the tickets provides information about the status. As we want to know full history, Tickets are `Event-Sourced`.    

From Event Sourced tickets we build different `Read Model Projections`, which are used to display information about the ticket.  

## Tracing and Monitoring

- The whole communication between Services is monitored and traced using [OpenTelemetry](https://opentelemetry.io/) with `Jaeger`.    

![OpenTelemetry Jaeger](documentation/tracing_jaeger_php.png "OpenTelemetry Tracing in PHP with Jaeger")  

------

- Any issue that happens in the system is reported to `Ecotone Pulse`, which is used to recover from failed messages.  

![Ecotone Pulse](documentation/ecotone_pulse.png "Ecotone Pulse")