ABDI - architecture

abdi.md

ABDI - App Business Data Infrastructure

Description

This is an overview of advanced rails architecture inspired by various patterns and frameworks like Domain Driven Design, Repository patterns, Trailblazer, Dry.rb and others.

Key concepts

Everything revolves around 4 nodes: App, Business, Data, Infrastructure. Each node has certain responsibilities that must be not used by other nodes.

App

Responsibilities

1. Representation

   • datatables
   • decorators
   • facades
   • helpers
   • mailers
   • serializers
   • view

2. Request input/output

   • channels (web-sockets)
   • controllers
   • services for AMQP communication
   • any other kind of external communications

3. No business logic

Business

[

Responsibilities

1. Use case validation
2. Business rules execution
3. Business rules callbacks
4. All business logic goes here

Business node is responsible for implementing client's requests (client is the one who pays for your code). Business node concept is similar to Sagas, Use cases or User stories, but is strict and simple. It's structure should match business processes and real life domains. This is the only reason why application should be developed at all.

Business node consist of:
Operations - human-readable class that describes and performs business requirements. It's an entry point of business logic.
Actions - are bricks for Operations. Could be called only within an Operation.
Forms - data validation layer. First step of Operation call. Operation must not be executed if input data is invalid. Business node could contain any custom components that are required for business requirements satisfaction.

Structure:

├── orders
│   ├── operations
│   │   ├── create.rb # -> calls Orders::Forms::Create, Orders::Actions::CalculatePrice, Orders::Actions::NotifyCustomer
│   │   └── cancel.rb
│   ├── forms
│   │   └── cancel.rb
│   └── actions
│       ├── calculate_price.rb
│       └── notify_customer.rb
└── Products
   ├── operations
   │   ├── create.rb
   │   └── delete.rb
   └── forms
       └── create.rb     

Data

[

Responsibilities

1. Database read
2. Database write
3. No business logic

This node is responsible for database communication. In other words - database read/write.
Data is actually extracted and renamed rails models folder, BUT IT'S NOT behave like models.

The key difference are:

• zero business logic
• no callbacks except system required, like: cache clearing, data normalization, etc.
• only persistence validation for correct DB usage, like: validate latitude if longitude present and vice-versa, validate email format and uniqueness, validate URL format, etc.
  no business validation like: customer region validation, age validation, etc.

Infrastructure

Responsibilities

1. Keep base classes: BaseOperation, BaseAction, etc.
2. Could keep clients for third-party API
3. Could keep any other custom non business constants and classes.
4. No business logic