# foxocorp/foxogram-backend architecture

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

- Interactive diagram: https://gitdiagram.com/foxocorp/foxogram-backend
- Repository: https://github.com/foxocorp/foxogram-backend

## Overview

##### Main Components Structure

a) foxogram-api (REST API Service)
- Controllers layer (Authentication, Channels, Messages, Users)
- Interceptors for security and authentication
- PenaltyBucket utility for rate limiting

b) foxogram-gateway (WebSocket Gateway)
- WebSocket configuration
- Event handling system
- Session management
- RabbitMQ listener

c) foxogram-common (Shared Library)
- Shared components like models, DTOs, and services
- Configuration management
- Utility services

##### External Services Integration
External services with clear connection lines:

- Database (implied by repositories)
- RabbitMQ (message broker)
- MinIO (file storage)
- Email Service
- Metrics (Micrometer)

##### Data Flow Representation

- Client → API interactions
- Client → WebSocket Gateway interactions
- Inter-service communication via RabbitMQ
- Data persistence flows
- Authentication flows

##### Detailed Component Breakdown

For each service, show:
- Input/Output DTOs
- Security layers
- Service layers
- Repository layers
- External service integrations

##### Architectural Patterns to Highlight

- Microservices communication
- Event-driven architecture (RabbitMQ)
- Repository pattern
- MVC pattern in API service
- Interceptor pattern

Remember to:
- Version numbers for major components
- Scalability points
- Security boundaries
- Document all external service dependencies

This will provide a comprehensive view of the Foxogram backend system while maintaining clarity and usefulness for technical discussions and development planning.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client
        C[Client Application]
    end

    subgraph "REST API Service"
        API[API Service]:::api
        click API "https://github.com/foxocorp/foxogram-backend/tree/main/foxogram-api"
        
        subgraph "Controllers"
            AC[Auth Controller]:::controller
            CC[Channels Controller]:::controller
            MC[Messages Controller]:::controller
            UC[Users Controller]:::controller
            click AC "https://github.com/foxocorp/foxogram-backend/tree/main/foxogram-api/src/main/java/su/foxogram/controllers/"
            click CC "https://github.com/foxocorp/foxogram-backend/tree/main/foxogram-api/src/main/java/su/foxogram/controllers/"
            click MC "https://github.com/foxocorp/foxogram-backend/tree/main/foxogram-api/src/main/java/su/foxogram/controllers/"
            click UC "https://github.com/foxocorp/foxogram-backend/tree/main/foxogram-api/src/main/java/su/foxogram/controllers/"
        end

        subgraph "API Components"
            INT[Interceptors]:::security
            RLM[Rate Limiter]:::security
            click INT "https://github.com/foxocorp/foxogram-backend/tree/main/foxogram-api/src/main/java/su/foxogram/interceptors/"
            click RLM "https://github.com/foxocorp/foxogram-backend/blob/main/foxogram-api/src/main/java/su/foxogram/util/PenaltyBucket.java"
        end
    end

    subgraph "WebSocket Gateway"
        WSG[WebSocket Gateway]:::gateway
        click WSG "https://github.com/foxocorp/foxogram-backend/tree/main/foxogram-gateway"
        
        subgraph "Gateway Components"
            WSC[WebSocket Config]:::config
            EH[Event Handlers]:::handler
            SM[Session Manager]:::handler
            RL[RabbitMQ Listener]:::handler
            click WSC "https://github.com/foxocorp/foxogram-backend/blob/main/foxogram-gateway/src/main/java/su/foxogram/config/WebSocketConfig.java"
            click EH "https://github.com/foxocorp/foxogram-backend/tree/main/foxogram-gateway/src/main/java/su/foxogram/handlers/"
            click SM "https://github.com/foxocorp/foxogram-backend/blob/main/foxogram-gateway/src/main/java/su/foxogram/models/Session.java"
            click RL "https://github.com/foxocorp/foxogram-backend/blob/main/foxogram-gateway/src/main/java/su/foxogram/listeners/RabbitListener.java"
        end
    end

    subgraph "Shared Components"
        COM[Common Library]:::common
        click COM "https://github.com/foxocorp/foxogram-backend/tree/main/foxogram-common"
        
        subgraph "Core Services"
            AS[Auth Service]:::service
            CS[Channels Service]:::service
            MS[Messages Service]:::service
            US[Users Service]:::service
            SS[Storage Service]:::service
            JS[JWT Service]:::security
            click AS "https://github.com/foxocorp/foxogram-backend/blob/main/foxogram-common/src/main/java/su/foxogram/services/AuthenticationService.java"
            click CS "https://github.com/foxocorp/foxogram-backend/blob/main/foxogram-common/src/main/java/su/foxogram/services/ChannelsService.java"
            click MS "https://github.com/foxocorp/foxogram-backend/blob/main/foxogram-common/src/main/java/su/foxogram/services/MessagesService.java"
            click US "https://github.com/foxocorp/foxogram-backend/blob/main/foxogram-common/src/main/java/su/foxogram/services/UsersService.java"
            click SS "https://github.com/foxocorp/foxogram-backend/blob/main/foxogram-common/src/main/java/su/foxogram/services/StorageService.java"
            click JS "https://github.com/foxocorp/foxogram-backend/blob/main/foxogram-common/src/main/java/su/foxogram/services/JwtService.java"
        end

        subgraph "Data Models"
            CM[Channel Model]:::model
            MM[Message Model]:::model
            UM[User Model]:::model
            MEM[Member Model]:::model
            click CM "https://github.com/foxocorp/foxogram-backend/blob/main/foxogram-common/src/main/java/su/foxogram/models/Channel.java"
            click MM "https://github.com/foxocorp/foxogram-backend/blob/main/foxogram-common/src/main/java/su/foxogram/models/Message.java"
            click UM "https://github.com/foxocorp/foxogram-backend/blob/main/foxogram-common/src/main/java/su/foxogram/models/User.java"
            click MEM "https://github.com/foxocorp/foxogram-backend/blob/main/foxogram-common/src/main/java/su/foxogram/models/Member.java"
        end
    end

    subgraph "External Services"
        DB[(Database)]:::external
        RMQ[RabbitMQ]:::external
        MINIO[MinIO Storage]:::external
        EMAIL[Email Service]:::external
        METRICS[Micrometer]:::external
    end

    %% Connections
    C --> API
    C --> WSG
    API --> INT
    INT --> RLM
    API --> |Uses| COM
    WSG --> |Uses| COM
    COM --> DB
    COM --> RMQ
    COM --> MINIO
    COM --> EMAIL
    COM --> METRICS
    WSG --> RMQ
    
    %% Styles
    classDef api fill:#2196F3,stroke:#1565C0,color:white
    classDef gateway fill:#1976D2,stroke:#0D47A1,color:white
    classDef controller fill:#90CAF9,stroke:#64B5F6,color:black
    classDef security fill:#FDD835,stroke:#F9A825,color:black
    classDef handler fill:#81C784,stroke:#4CAF50,color:black
    classDef config fill:#B39DDB,stroke:#9575CD,color:black
    classDef service fill:#4DB6AC,stroke:#26A69A,color:black
    classDef model fill:#FFB74D,stroke:#FF9800,color:black
    classDef common fill:#90A4AE,stroke:#607D8B,color:black
    classDef external fill:#E57373,stroke:#E53935,color:white

    %% Legend
    subgraph Legend
        L1[API Service]:::api
        L2[Gateway]:::gateway
        L3[Controller]:::controller
        L4[Security]:::security
        L5[Handler]:::handler
        L6[Config]:::config
        L7[Service]:::service
        L8[Model]:::model
        L9[Common]:::common
        L10[External]:::external
    end
```
