This application contains two micro-services working together and providing REST HTTP endpoints.
- Fully isolated and dockerized application
- Infrastructure level logs(Web server logs)
- Application level logs (For every single API)
- Increased code coverage by writing different unit and feature tests
- Powerful error handling
Follow these steps to simply run the project.
There is a .env.example file in the project's root directory containing OS level environment variables that are used for deploying the whole application.
Every single variable inside the file has a default value, so you do not need to change them; But you can also override your own variables. First copy the example file to the .env file:
cd /path-to-project
cp .env.example .envThen open your favorite text editor like vim or nano and change the variables. All variables have comments which describe them.
For example BACKEND_PORT environment variable shows that the project will run on the following port. You can change them to your desired values.
Note: In this application, laravel
.envfile is removed andOSlevel environment variables are used instead. So if you want to modify any values "after running containers", do not forget to recreate and restart the application container so that your changes will affect. For restarting containers use the following command:docker-compose up -d --force-recreate
Open Terminal and type the following command:
docker-compose up -d Only the first time you're running the application, you must execute the following command:
docker-compose exec assignment-core bootupIt will install dependencies and will migrate/seed the database.
In this application there are two levels of logs, you can figure out more in the following sections:
In the project's root, there is .data directory which is used to store logs (and also used for some other purposes). You can use your preferred logging tool like ELK or etc. to manage them.
Under .data/publisher/log directory, there is a directory named webserver which holds apache server access and error logs and consumer/log directory keeps supervisor log files.
Under storage/logs directory, you can find detailed logs of API calls.
There are different types of testing methods which you can find under publisher/tests and consumer/tests directories. Tests are divided into the following groups:
- feature
- unit
To run tests, in the terminal use the following commands:
docker-compose exec assignment-core vendor/bin/phpunit
docker-compose exec assignment-consumer vendor/bin/phpunitYou can run each group individually by passing --group {groupName} to phpunit command. Of course, it is possible to create many more test cases for this application.
This project includes four docker containers based on php-apache, MySQL, php-cli and Rabbitmq images.
It is under development, So the source code is mounted from the host to containers. On production environment you should remove these volumes.
assignment-core: php:8.0.12-apache
This container is the application gateway; It's responsible for pushing tasks into the queue and also generating proper http responses.
assignment-consumer: php:8.0.12-cli
A command line application for consuming queues and taking proper action based on queue entries.
assignment-db: MySQL:latest(8.0.27)
Keeping track of sent notifications is managed by this database container.
assignment-queue bitnami/rabbitmq
A queue implementing AMQP protocol used as the application async tasks topic.
- As far as this an assignment, there is no fallback in case of having failure in sending notifications. To have a failed tasks queue could be a suggestion.
- To push different types of notifications into different queues.
- To write end-to-end tests for evaluating both producing and consuming processes.
- Adding more tests to increase the code coverage
- Using code quality tools like
phpstan
Majid Akbari Linkedin
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent