Skip to content

Latest commit

 

History

History
87 lines (71 loc) · 3.33 KB

implementation.md

File metadata and controls

87 lines (71 loc) · 3.33 KB
Raw

Implementation details

Application tries to follow clean architecture and is divided by layers:

Domain - contains main models used by application and related common business logic like checking permissions, fields value generation and models relationship. As for now, models are anemic and implemented using dataclasses. Services are plain functions. Domain implementation can be approved by replacing service functions with classes and then with aggregates.

Application - contains more specific logic related to user actions. It calls domain services and interacts with adapters. To do this each service contains DTO classes and Gateway protocols which are just combinations of multiple common protocols. Each use case is an implementation of generic UseCase-protocol: it contains single method with DTO in and DTO out. All use case dependencies are passed to constructor.

Adapters - can be divided to controllers/views and gateways. Controllers call use cases and gateways are used by use cases to access external services. Currently, no implementation provided. Adapters are to be glue between use cases and externals libs or services. We are going to have mock implementations for tests purposes

Frameworks - external libs and objects related to them. Here we can have FastApi with Routers, aiogram-dialog with Windows and so on.

flowchart LR
    style Frameworks fill:#cfefff,stroke:#bcd
    subgraph Frameworks
        FastApi
        AiogramDialog
    end 
    style Adapters fill:#dfffdf,stroke:#bdb
    subgraph Adapters
        style TelegramApp fill:#eff,stroke:#cec
        subgraph TelegramApp
            ClickHandler
            DataGetter
        end
        
        style WebApp fill:#eff,stroke:#cec
        subgraph WebApp
            ViewFunction
        end
        
        style DatabaseGateway fill:#ffe,stroke:#cec
        subgraph DatabaseGateway
            SqlalchemyGatewayImpl
        end
    end
    
    style Application fill:#fdd,stroke:#dbb
    subgraph Application
        style UseCases fill:#fee,stroke:#fcc
        subgraph UseCases
            CreateWishList
            GetOwnWishLists
        end
        style Ports fill:#fee,stroke:#fcc
        subgraph Ports
            WriteDbGateway
            ReadDbGateway
        end
    end
    
    style Domain fill:#ffc,stroke:#ddb
    subgraph Domain
        WishList
        style Services fill:#ffe,stroke:#eec
        subgraph Services
            PermissionsService
            NewWishListService
        end
    end
    
    User --> FastApi
    FastApi --> ViewFunction
    ViewFunction --> GetOwnWishLists
    
    User --> AiogramDialog
    AiogramDialog --> ClickHandler
    AiogramDialog --> DataGetter
    
    ClickHandler --> CreateWishList
    DataGetter --> GetOwnWishLists
    CreateWishList --> WriteDbGateway
    GetOwnWishLists --> ReadDbGateway
    CreateWishList --> WishList
    GetOwnWishLists --> WishList
    WriteDbGateway --> WishList
    ReadDbGateway --> WishList
    
    SqlalchemyGatewayImpl -- implements --> WriteDbGateway
    SqlalchemyGatewayImpl -- implements --> ReadDbGateway
    
    GetOwnWishLists --> PermissionsService
    CreateWishList --> PermissionsService
    CreateWishList --> NewWishListService
Loading