aolmez/akka-bank

An application showcasing how akka can be used in financial operations.

Akka Bank

A showcase application using akka framework, in order to emulate financials operations, ensuring the idempotence, parallelism and concurrency of its operations. It was also developed with event sourcing in mind

About

This is a showcase application that uses akka framework as the core of its functionality. I decided to use akka as the chosen framework, mostly for its natural non-blocking concept and its ability of helping you to construct an concurrent and distributed application. The application shows four operations:

• READ ~ given an account, return its balance
• CREDIT ~ given an account, increases its balance by the chosen value
• DEBIT ~ given an account, decreases its balance by the chosen value
• TRANSFER ~ given two accounts - an receiver and an requester - decreases the balance from the requester and adds it to the receiver balance

Architecture

Akka-Bank was developed with event sourcing in mind, it has an EventStore class, that mocks the events of the accounts and when an Account actor is instanciated it will check for his events and compose its balance. The AccountSupervisor is responsible for forwarding all events to the responsible actor and the TransferSaga is exclusively responsible for handling the transfer business rules. The account actors were developed with idempotence, so if some reason the same operation is to be requested, it will return a proper message instead of re-executing the requests.operation.

How it works?

The Account was developed with idempotence in mind, once it is instantiated it gathers all events from itself and compose its balance. Whenever an Account handle an event that it has already been executed, it will return a message stating that it has been already executed. If it receives an event of Debit but the result of its deduction would reduce its balance below a limit threshold, the Account will answer with an error response; it shapes how TransferSaga handles transfer events.

Since the focus of this application is the transfer, most of the other functions do not have full error handling. When TransferSaga receives an event of transfer, it will tell both accounts that make part of this transfer either to credit or debit, then it will await for a Future response, if both accounts respond with success, it will then answer the AccountSupervisor with a success response; however if the account tha would be debited respond with an error, the TransferSaga will trigger a compensation telling the account that was credited to debit the value. Though that might not be the best of the approaches, this showcase how the concurrency could be used, not awaiting for the first response.

The EventStore represents the events of all accounts, the idea behind it is to mock a event sourcing. This application was developed with event driven architecture in mind, all events are stored in the store and are immutable.

For simplicity, there's no create account endpoint, however the Main is been created with 3 accounts, as well all of its past events. In order to test new accounts or add more events, simple edit the previous file with all that's intended.

Stack

• Akka
• Akka-Http
• Junit

Documentation

https://documenter.getpostman.com/view/7830954/SVmvRyB2

Running

Run the server

mvn package && java -jar target/akka-bank-1.0-SNAPSHOT-allinone.jar

Runing tests

mvn test

The tests are heavily focused on the actors and its interactions.