# tanersenyurt/feedreader architecture

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

- Interactive diagram: https://gitdiagram.com/tanersenyurt/feedreader
- Repository: https://github.com/tanersenyurt/feedreader

## Overview

##### Main Components

a) Core Components:
- Feed API Module (Entry point)
- Feed Service Module (Business logic)
- GraphQL Service Module (GraphQL interface)
- H2 Database (Embedded database)
- Flyway Migration System

b) External Services:
- RSS Feed Sources
- Heroku Deployment
- SonarCloud Integration
- GitHub Actions CI/CD

##### Architectural Layers

**[External RSS Feeds]**
- ↓
**[API Layer (Feed-API)]**
- ↓
**[Service Layer]**
- GraphQL Service
- Feed Service
- Business Layer
- Sync Process
- Async Process
- Data Layer
- Repository

**[Database Layer]**
- H2 Database

##### Key Elements to Highlight

a) Service Components:
- Separation between sync and async RSS processing services
- GraphQL service integration
- Data flow from RSS sources to storage

b) Data Flow:
- RSS Feed ingestion flow
- GraphQL query handling
- Database operations

##### Specific Implementation Details

**[RSSItem] ← Domain Model**
**[BaseRssProcess] ← Processing Strategy**
**[RssBusinessService] ← Business Logic**
**[RssDataService] ← Data Access**
**[GraphQlDataService] ← GraphQL Interface**

##### Integration Points

Connections for:
- Flyway migrations to database
- GraphQL schema to service
- CI/CD pipeline flow
- Monitoring integration (SonarCloud)

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph External["External Layer"]
        RSS["RSS Feed Sources"]:::external
        Heroku["Heroku Deployment"]:::external
        SonarCloud["SonarCloud"]:::external
        GitHub["GitHub Actions CI/CD"]:::external
    end

    subgraph API["API Layer"]
        FeedReader["FeedReaderApplication"]:::api
        click FeedReader "https://github.com/tanersenyurt/feedreader/blob/main/feed-api/src/main/java/com/tsenyurt/csdm/api/FeedReaderApplication.java"
    end

    subgraph Service["Service Layer"]
        subgraph GraphQL["GraphQL Service"]
            GraphQLService["GraphQlDataService"]:::service
            GraphQLSchema["GraphQL Schema"]:::config
            click GraphQLService "https://github.com/tanersenyurt/feedreader/blob/main/graphql-service/src/main/java/com/tsenyurt/csdm/service/GraphQlDataService.java"
            click GraphQLSchema "https://github.com/tanersenyurt/feedreader/blob/main/graphql-service/src/main/resources/schema.graphql"
        end

        subgraph Business["Business Layer"]
            ContextListener["ContextInitializedListener"]:::service
            BaseProcess["BaseRssProcess"]:::service
            BusinessService["RssBusinessService"]:::service
            SyncProcess["SyncRssProcessService"]:::service
            AsyncProcess["AsyncRssProcessService"]:::service
            
            click ContextListener "https://github.com/tanersenyurt/feedreader/blob/main/feed-service/src/main/java/com/tsenyurt/csdm/listener/ContextInitializedListener.java"
            click BaseProcess "https://github.com/tanersenyurt/feedreader/blob/main/feed-service/src/main/java/com/tsenyurt/csdm/service/business/BaseRssProcess.java"
            click BusinessService "https://github.com/tanersenyurt/feedreader/blob/main/feed-service/src/main/java/com/tsenyurt/csdm/service/business/RssBusinessService.java"
            click SyncProcess "https://github.com/tanersenyurt/feedreader/blob/main/feed-service/src/main/java/com/tsenyurt/csdm/service/business/impl/SyncRssProcessServiceImpl.java"
            click AsyncProcess "https://github.com/tanersenyurt/feedreader/blob/main/feed-service/src/main/java/com/tsenyurt/csdm/service/business/impl/AsyncRssProcessServiceImpl.java"
        end

        subgraph Data["Data Layer"]
            DataService["RssDataService"]:::service
            DataImpl["RssDataServiceImpl"]:::service
            ErrorHandler["FeedReadException"]:::error
            Repository["RssItemRepository"]:::repo
            Domain["RSSItem"]:::domain
            
            click DataService "https://github.com/tanersenyurt/feedreader/blob/main/feed-service/src/main/java/com/tsenyurt/csdm/service/data/RssDataService.java"
            click DataImpl "https://github.com/tanersenyurt/feedreader/blob/main/feed-service/src/main/java/com/tsenyurt/csdm/service/data/impl/RssDataServiceImpl.java"
            click ErrorHandler "https://github.com/tanersenyurt/feedreader/blob/main/feed-service/src/main/java/com/tsenyurt/csdm/service/data/impl/exception/FeedReadException.java"
            click Repository "https://github.com/tanersenyurt/feedreader/blob/main/feed-service/src/main/java/com/tsenyurt/csdm/repository/RssItemRepository.java"
            click Domain "https://github.com/tanersenyurt/feedreader/blob/main/feed-service/src/main/java/com/tsenyurt/csdm/domain/RSSItem.java"
        end
    end

    subgraph DB["Database Layer"]
        H2["H2 Database"]:::database
        Flyway["Flyway Migrations"]:::database
        click Flyway "https://github.com/tanersenyurt/feedreader/blob/main/feed-api/src/main/resources/db/migration/V1__create_tables.sql"
    end

    %% Connections
    RSS --> FeedReader
    FeedReader --> GraphQLService
    FeedReader --> BusinessService
    ContextListener --> BusinessService
    BusinessService --> BaseProcess
    BaseProcess --> SyncProcess
    BaseProcess --> AsyncProcess
    SyncProcess & AsyncProcess --> DataService
    DataService --> DataImpl
    DataImpl --> ErrorHandler
    DataImpl --> Repository
    Repository --> Domain
    Repository --> H2
    Flyway --> H2
    GitHub --> Heroku
    GitHub --> SonarCloud

    %% Styles
    classDef external fill:#87CEEB
    classDef api fill:#90EE90
    classDef service fill:#98FB98
    classDef database fill:#FFD700
    classDef config fill:#D3D3D3
    classDef error fill:#FF6B6B
    classDef repo fill:#DEB887
    classDef domain fill:#E6E6FA

    %% Legend
    subgraph Legend
        L1["External System"]:::external
        L2["API Component"]:::api
        L3["Service Component"]:::service
        L4["Database Component"]:::database
        L5["Configuration"]:::config
        L6["Error Handler"]:::error
        L7["Repository"]:::repo
        L8["Domain Model"]:::domain
    end
```
