# khairu-aqsara/rms-mock-server architecture

> Architecture diagram of the GitHub repository khairu-aqsara/rms-mock-server, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/khairu-aqsara/rms-mock-server
- Repository: https://github.com/khairu-aqsara/rms-mock-server

## Overview

##### Component Relationships

a) Primary Data Flow:
- Client → API Layer (REST endpoints)
- API Layer → Service Layer (Business Logic)
- Service Layer → Data Layer (Database Operations)

b) Async Flow:
- Background Tasks → Event Emitter
- Event Emitter → Service Layer
- Service Layer → Data Layer

##### Specific Implementation Details

Key elements:

a) API Endpoints (Group by domain):
- Portfolio Management (/portfolio)
- Scenario Management (/scenario)
- Optimization Processing (/optimization)
- Shipper Planning (/shipper-planning)
- Health Checks (/check)

b) Models (Show relationships):
- PortfolioModel
- ScenarioModel
- OptimizationModel
- OptResultModel
- ShipperPlanningModel

##### Special Focus Areas

Crucial aspects:

a) Optimization Workflow:
- Portfolio Creation
- Scenario Configuration
- Optimization Triggering
- Background Processing
- Result Storage

b) Async Processing:
- Background Tasks
- Event Emission
- Status Updates

##### Environment Configuration

A separate section showing:
- Database Configuration
- Environment Variables
- External Service Connections

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph CL["Client Layer"]
        Client["API Consumers"]
        SwaggerDocs["Swagger Documentation"]
    end

    subgraph AL["API Layer"]
        direction TB
        API["Express.js REST API"]:::api
        click API "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/app.js"
        
        subgraph Controllers
            PortfolioC["Portfolio Controller"]:::controller
            ScenarioC["Scenario Controller"]:::controller
            OptimizationC["Optimization Controller"]:::controller
            ShipperC["Shipper Planning Controller"]:::controller
            CheckC["Check Controller"]:::controller
            
            click PortfolioC "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/controllers/portfolioController.js"
            click ScenarioC "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/controllers/scenarioController.js"
            click OptimizationC "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/controllers/optimizationController.js"
            click ShipperC "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/controllers/shipperPlanningController.js"
            click CheckC "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/controllers/checkController.js"
        end

        subgraph Routes
            PortfolioR["Portfolio Routes"]:::route
            ScenarioR["Scenario Routes"]:::route
            OptimizationR["Optimization Routes"]:::route
            ShipperR["Shipper Planning Routes"]:::route
            CheckR["Check Routes"]:::route
            
            click PortfolioR "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/routes/portfolioRoutes.js"
            click ScenarioR "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/routes/scenarioRoutes.js"
            click OptimizationR "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/routes/optimizationRoutes.js"
            click ShipperR "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/routes/shipperPlanningRoutes.js"
            click CheckR "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/routes/checkRoutes.js"
        end
    end

    subgraph SL["Service Layer"]
        BgTasks["Background Task Processor"]:::service
        EventEmitter["Event Emitter System"]:::service
        
        click BgTasks "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/services/backgroundTasks.js"
        click EventEmitter "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/services/eventEmitter.js"
    end

    subgraph DL["Data Layer"]
        DB[(SQL Server Database)]:::database
        click DB "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/config/database.js"
        
        PortfolioM["Portfolio Model"]:::model
        ScenarioM["Scenario Model"]:::model
        OptimizationM["Optimization Model"]:::model
        OptResultM["OptResult Model"]:::model
        ShipperM["ShipperPlanning Model"]:::model
        
        click PortfolioM "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/models/portfolioModel.js"
        click ScenarioM "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/models/scenarioModel.js"
        click OptimizationM "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/models/optimizationModel.js"
        click OptResultM "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/models/optResultModel.js"
        click ShipperM "https://github.com/khairu-aqsara/rms-mock-server/blob/main/src/models/shipperPlanningModel.js"
    end

    %% Connections
    Client --> SwaggerDocs
    Client --> API
    SwaggerDocs --> API
    
    API --> PortfolioR & ScenarioR & OptimizationR & ShipperR & CheckR
    
    PortfolioR --> PortfolioC
    ScenarioR --> ScenarioC
    OptimizationR --> OptimizationC
    ShipperR --> ShipperC
    CheckR --> CheckC
    
    PortfolioC --> PortfolioM
    ScenarioC --> ScenarioM
    OptimizationC --> OptimizationM
    OptimizationC -.-> BgTasks
    ShipperC --> ShipperM
    
    BgTasks -.-> EventEmitter
    EventEmitter -.-> OptimizationC
    
    PortfolioM --> DB
    ScenarioM --> DB
    OptimizationM --> DB
    OptResultM --> DB
    ShipperM --> DB

    %% Styles
    classDef api fill:#f9f,stroke:#333,stroke-width:2px
    classDef controller fill:#bbf,stroke:#333,stroke-width:1px
    classDef route fill:#ddf,stroke:#333,stroke-width:1px
    classDef service fill:#fdb,stroke:#333,stroke-width:2px
    classDef model fill:#dfd,stroke:#333,stroke-width:1px
    classDef database fill:#fdd,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        API_L["API Component"]:::api
        Controller_L["Controller"]:::controller
        Route_L["Route"]:::route
        Service_L["Service"]:::service
        Model_L["Model"]:::model
        DB_L[(Database)]:::database
        SYNC["→ Sync Flow"]
        ASYNC["--> Async Flow"]
    end
```
