https://github.com/chijioke-ibekwe/work-item-processor
Spring boot application that processes and reports work items
https://github.com/chijioke-ibekwe/work-item-processor
Last synced: 3 months ago
JSON representation
Spring boot application that processes and reports work items
- Host: GitHub
- URL: https://github.com/chijioke-ibekwe/work-item-processor
- Owner: chijioke-ibekwe
- Created: 2023-05-27T16:46:17.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-31T17:52:16.000Z (about 2 years ago)
- Last Synced: 2025-01-10T17:31:01.915Z (5 months ago)
- Language: Java
- Size: 87.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Work Item Processor
Work Item Processor is a Spring Boot project that processes and reports work items. A work item is an entity that has
an id, value, status and result property. This application consists of a set of RESTful APIs for performing basic CRUD operations on a work item, and utilizes a producer-consumer design pattern to process created work items asynchronously via a RabbitMQ message broker. It also serves a report of the existing work items on a single web page, using the Thymeleaf templating engine.
Work item processing involves squaring its `value` to obtain the `result` property and updating the status value
from `PROCESSING` to `COMPLETED`. The time it takes for a work item to be processed can be determined by multiplying
the value of the work item by 10ms. If an error occurs while processing a work item, the process is retried 3 times after
which it will be sent to the dead letter queue on RabbitMQ.
## Getting Started
### Prerequisites
For building and running the application you need the following (NB: versions may vary):
1. JDK 17
2. Maven 3
3. Docker
### Key Dependencies
For backend
1. Spring Web
2. Spring Data Mongo
3. Spring AMQP
4. Thymeleaf
## How to Run
To run the application locally:
* Clone the repository using the following command:
```bash
git clone https://github.com//work-item-processor.git
```
* Build the project and run the tests by running:
```
mvn clean package
```
* Run the docker compose file using the command:
```bash
docker-compose up -d
```
This will setup the following in a container:
* A MongoDB database running on `port 27019`
* A Mongo Express admin UI running on `port 8081` (`http://localhost:8081`)
* A RabbitMQ message broker running on `port 5672`, and an admin UI running on `port 15672` (`http://localhost:15672`). To log into this UI, enter username and password as `guest`.
* Run the application
* Upon startup, the following infrastructure will be created on RabbitMQ:
* Exchange: `internal.exchange`
* Dead-Letter Exchange: `internal-dl.exchange`
* Queue: `work-item.queue`
* Dead-Letter Queue: `work-item-dl.queue`
* The app will be started on `http://localhost:8080`
## API Documentation
The application contains the following endpoints:
1. `POST '/api/v1/work-items'`
- Creates a new work item, and emits an event which queues up the work item for processing.
- Body: A JSON containing the value property of the work item. This value must be between 1 and 10:
```json
{
"value": 5,
}
```
- Returns: A JSON with the created work item's ID as shown below:
```json
{
"status": "SUCCESSFUL",
"message": "Work Item created successfully",
"data": {
"id": "507f1f77bcf86cd799439011"
}
}
```
2. `GET '/api/v1/work-items/{itemId}'`
- Fetches a single work item using the work item id as a path variable.
- Returns: A JSON of the work item's details as shown below:
```json
{
"status": "SUCCESSFUL",
"message": null,
"data": {
"id": "507f1f77bcf86cd799439011",
"value": 5,
"status": "COMPLETED",
"result": 25
}
}
```
3. `DELETE '/api/v1/work-items/{itemId}'`
- Deletes a work item using the work item id as a path variable.
- Returns: A JSON as shown below:
```json
{
"status": "SUCCESSFUL",
"message": "Work Item deleted successfully",
"data": null
}
```
4. `GET '/api/v1/work-items/report'`
- Fetches a report of all work items on the database, grouped by value and providing details of the number of work items and the number processed.
```json
{
"status": "SUCCESSFUL",
"message": null,
"data": [
{
"value": 5,
"numberOfWorkItems": 3,
"numberOfProcessedWorkItems": 2
},
{
"value": 7,
"numberOfWorkItems": 2,
"numberOfProcessedWorkItems": 2
}
]
}
```
### Report Web Page
The see the work item report UI visit `http://localhost:8080/work-item-report`
### Status Codes
* `200`
This is returned when the request is successful
* `400`
This is returned when user makes an invalid request like attempting to create a work item with an invalid value
(value that is not an integer between 1 - 10)
* `404`
This is returned when the work item in question does not exist on the database
* `500`
This is returned when you attempt to delete an item that has already been processed
## Load Testing
In order to load test this application to ascertain the power of its asynchronous processing. We'll be using an open
source tool called JMeter. To download JMeter, download and extract the JMeter binaries zip file [here](https://dlcdn.apache.org//jmeter/binaries/apache-jmeter-5.5.zip).
To use this tool in the GUI mode:
* Open the JMeter batch file in the bin folder of the extracted file
* When the GUI is booted up, create a new test plan.
* Create a thread group in the test plan. In the thread properties select the number of threads as `1000`, ramp up period
in seconds as `1` and loop count as `1`. Then, save the thread group.
* In the thread group created, add a sampler of type HttpRequest. In the HttpRequest creation page, enter
`Server Name or IP` as `localhost` and `Port Number` as `8080`. In the HttpRequest section, select request type as `POST`
* and the path as `/api/v1/work-items`. Add the following JSON body data to the request
```json
{
"value": 5
}
```
Then, save the sampler.
* In the thread group, add a config element of type `Http Header Manager` and set a `Content-Type` header with value
`application/json`
* Finally, in the thread group, also create a listener to view the result of the test in your desired format.
Recommendation: Select `View Results in Table`
* Run the test and view the result.
## Author
- Chijioke Ibekwe (https://github.com/chijioke-ibekwe)