# ashwin492/journallapp architecture

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

- Interactive diagram: https://gitdiagram.com/ashwin492/journallapp
- Repository: https://github.com/ashwin492/journallapp

## Overview

##### Project Type and Purpose
- This is a monolithic, back-end web application built with Spring Boot.
- Purpose: provide a secure, role-based journal API with features such as JWT authentication, CRUD on journal entries, weekly sentiment reporting (via Kafka), real-time weather lookups, Redis caching, and email notifications.

##### File Structure
- Top-level: Maven wrapper, pom.xml, README.md, CI workflow.
- src/main/java/net/engineeringdigest/journalApp:
- api/response – DTOs for external API responses (e.g., weather).
- cache – application-level caching abstractions.
- config – SpringSecurity, RedisConfig, SwaggerConfig.
- controller – REST controllers (JournalEntryController, UserController, PublicController, AdminController, GoogleAuthController).
- service – business logic (JournalEntryService, UserService, WeatherService, EmailService, RedisService, SentimentConsumerService, UserDetailsServiceImpl).
- repository – data access (Spring Data MongoRepository interfaces + custom impl).
- entity/dto/enums/model – domain objects and supporting types.
- filter – JwtFilter for incoming request authentication.
- scheduler – periodic tasks (UserScheduler).
- util – JwtUtil, other helpers.
- Configuration files: application.yml, logback.xml.
- Test tree mirrors main packages.

##### Key Insights from README
- Underlying database: MongoDB (user & journal entries).
- Caching: Redis for external API responses.
- Messaging: Kafka consumer on “weekly-sentiments” topic, triggers email digests.
- Security: Spring Security + JWT + BCrypt + role-based access (USER vs ADMIN).
- External integrations: Weather REST API, JavaMailSender, Google OAuth.

##### Main Components
- API Layer (Controllers + JwtFilter)
- Business Layer (Services)
- Data Layer (Repositories + MongoDB)
- Infrastructure Components:
- Redis Cache
- Kafka Consumer / Broker
- External Weather REST API
- Email SMTP Server (JavaMailSender)
- Google OAuth Provider
- Supporting Components:
- Scheduler
- Swagger UI (for API docs)

##### Relationships and Data Flows
- Incoming HTTP requests → JwtFilter → Controllers → Services → Repositories → MongoDB
- WeatherService checks Redis first; on cache miss calls external Weather REST API → caches result in Redis → returns to controller → client.
- SentimentConsumerService listens to Kafka → on message arrival invokes EmailService → sends via SMTP.
- User registration / login flows interact with UserService → save/find in MongoDB. JWT generated by JwtUtil.
- Scheduler triggers periodic tasks via UserScheduler → may enqueue Kafka messages or perform cron-driven operations.

##### Architectural Patterns and Principles
- Layered (Controller → Service → Repository)
- Dependency Injection (Spring)
- Separation of Concerns (security, caching, scheduling, messaging)
- Single Deployable Unit (monolith)
- Event-driven integration with Kafka

##### Elements
- Application code (light blue)
- Infrastructure (light green)
- External services (light orange)
- Cloud/stack symbols for external APIs (Weather, Google OAuth)

##### Final Advice
- Be exhaustive: represent every package group or external dependency as a distinct component.
- Keep labels concise but precise.
- Iterate with the team to refine clarity and completeness.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% API Layer
    subgraph "API Layer (Spring MVC)"
        JwtFilter["JwtFilter"]:::app
        AdminController["AdminController"]:::app
        GoogleAuthController["GoogleAuthController"]:::app
        JournalEntryController["JournalEntryController"]:::app
        PublicController["PublicController"]:::app
        UserController["UserController"]:::app
    end

    %% Config Layer
    subgraph "Configuration"
        SpringSecurity["SpringSecurity"]:::app
        RedisConfig["RedisConfig"]:::app
        SwaggerConfig["SwaggerConfig"]:::app
    end

    %% Service Layer
    subgraph "Service Layer (Spring @Service)"
        JournalEntryService["JournalEntryService"]:::app
        UserService["UserService"]:::app
        WeatherService["WeatherService"]:::app
        EmailService["EmailService"]:::app
        RedisService["RedisService"]:::app
        SentimentConsumerService["SentimentConsumerService"]:::app
        UserDetailsServiceImpl["UserDetailsServiceImpl"]:::app
    end

    %% Scheduler
    subgraph "Scheduling"
        UserScheduler["UserScheduler"]:::app
    end

    %% Data Layer
    subgraph "Data Layer (Spring Data MongoDB)"
        JournalEntryRepository["JournalEntryRepository"]:::app
        UserRepository["UserRepository"]:::app
        UserRepositoryImpl["UserRepositoryImpl"]:::app
        ConfigJournalAppRepository["ConfigJournalAppRepository"]:::app
        MongoDB[(MongoDB)]:::infra
    end

    %% Infrastructure
    subgraph "Infrastructure"
        Redis[(Redis Cache)]:::infra
        Kafka[(Kafka Broker)]:::infra
        SMTP[(SMTP Server)]:::infra
    end

    %% External Services
    subgraph "External Services"
        WeatherAPI["External Weather REST API"]:::external
        GoogleOAuth["Google OAuth Provider"]:::external
    end

    %% Application Entry Point
    JournalApplication["JournalApplication"]:::app

    %% Flows
    HTTP["HTTP/REST"]:::external -->|auth| JwtFilter
    JwtFilter -->|forward| AdminController
    JwtFilter -->|forward| GoogleAuthController
    JwtFilter -->|forward| JournalEntryController
    JwtFilter -->|forward| PublicController
    JwtFilter -->|forward| UserController

    AdminController -->|calls| JournalEntryService
    GoogleAuthController -->|calls| UserService
    JournalEntryController -->|calls| JournalEntryService
    PublicController -->|calls| WeatherService
    UserController -->|calls| UserService

    SpringSecurity -->|secures| JwtFilter
    RedisConfig -->|configures| RedisService
    SwaggerConfig -->|provides| HTTP

    JournalEntryService -->|uses| JournalEntryRepository
    UserService -->|uses| UserRepository
    SentimentConsumerService -->|uses| EmailService
    SentimentConsumerService -->|listens Kafka| Kafka
    EmailService -->|sends SMTP| SMTP
    WeatherService -->|checks cache| RedisService
    RedisService -->|gets/sets| Redis
    WeatherService -->|HTTP| WeatherAPI
    UserScheduler -->|runs cron| SentimentConsumerService

    JournalEntryRepository -->|JDBC/MongoDriver| MongoDB
    UserRepository -->|JDBC/MongoDriver| MongoDB
    UserRepositoryImpl -->|JDBC/MongoDriver| MongoDB
    ConfigJournalAppRepository -->|JDBC/MongoDriver| MongoDB

    UserDetailsServiceImpl -->|used by| SpringSecurity

    JournalApplication -->|boots| SpringSecurity
    JournalApplication -->|boots| RedisConfig
    JournalApplication -->|boots| SwaggerConfig

    %% Click Events - Controllers
    click AdminController "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/controller/AdminController.java"
    click GoogleAuthController "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/controller/GoogleAuthController.java"
    click JournalEntryController "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/controller/JournalEntryController.java"
    click PublicController "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/controller/PublicController.java"
    click UserController "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/controller/UserController.java"

    %% Click Events - Filter
    click JwtFilter "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/filter/JwtFilter.java"

    %% Click Events - Services
    click JournalEntryService "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/service/JournalEntryService.java"
    click UserService "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/service/UserService.java"
    click WeatherService "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/service/WeatherService.java"
    click EmailService "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/service/EmailService.java"
    click RedisService "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/service/RedisService.java"
    click SentimentConsumerService "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/service/SentimentConsumerService.java"
    click UserDetailsServiceImpl "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/service/UserDetailsServiceImpl.java"

    %% Click Events - Repositories
    click JournalEntryRepository "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/repository/JournalEntryRepository.java"
    click UserRepository "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/repository/UserRepository.java"
    click UserRepositoryImpl "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/repository/UserRepositoryImpl.java"
    click ConfigJournalAppRepository "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/repository/ConfigJournalAppRepository.java"

    %% Click Events - Entities & DTOs
    click JournalEntry "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/entity/JournalEntry.java"
    click User "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/entity/User.java"
    click ConfigJournalAppEntity "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/entity/ConfigJournalAppEntity.java"
    click UserDTO "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/dto/UserDTO.java"
    click SentimentData "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/model/SentimentData.java"
    click WeatherResponse "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/api/response/WeatherResponse.java"

    %% Click Events - Configurations
    click SpringSecurity "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/config/SpringSecurity.java"
    click RedisConfig "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/config/RedisConfig.java"
    click SwaggerConfig "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/config/SwaggerConfig.java"

    %% Click Events - Caching
    click AppCache "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/cache/AppCache.java"

    %% Click Events - Scheduling
    click UserScheduler "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/scheduler/UserScheduler.java"

    %% Click Events - Utilities
    click JwtUtil "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/utilis/JwtUtil.java"

    %% Click Events - Constants & Enums
    click Placeholders "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/constants/Placeholders.java"
    click Sentiment "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/enums/Sentiment.java"

    %% Click Events - Application Entry
    click JournalApplication "https://github.com/ashwin492/journallapp/blob/main/src/main/java/net/engineeringdigest/journalApp/JournalApplication.java"
    click applicationYml "https://github.com/ashwin492/journallapp/blob/main/src/main/resources/application.yml"
    click logback "https://github.com/ashwin492/journallapp/blob/main/src/main/resources/logback.xml"

    %% Styles
    classDef app fill:#D0E6FF,stroke:#036,stroke-width:1px
    classDef infra fill:#D0FFD0,stroke:#260,stroke-width:1px
    classDef external fill:#FFE0B2,stroke:#975,stroke-width:1px
```
