# rsrini7/notification-sse architecture

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

- Interactive diagram: https://gitdiagram.com/rsrini7/notification-sse
- Repository: https://github.com/rsrini7/notification-sse

## Overview

##### Project type and purpose
- This is a full-stack **notification system** consisting of a Spring Boot backend microservice and two React frontends (Admin UI and User UI).
- It provides real-time, in-app, broadcast, user-specific, and critical (email + in-app) notifications, leveraging Kafka for async processing and SSE for live updates.

##### File structure
- Top-level directories:
- **backend/** – Spring Boot application
- **frontend/admin-ui/** – React Admin UI
- **frontend/user-ui/** – React User UI
- **scripts/** + root scripts – helpers for Docker, Kafka, startup
- Key configuration/build files:
- backend/pom.xml, backend/Dockerfile, docker-compose.yml
- frontend/*/package.json, Dockerfiles
- application.yml, data.sql, schema.sql in backend/src/main/resources
- Patterns:
- MVC controllers, service, repository layers in backend
- Kafka consumers and producers for event-driven processing
- SSE config for push notifications
- JWT security filters

##### README for additional insights
- Confirms architecture: REST APIs, Kafka topics (`notifications`, `broadcast-notifications`, `critical-notifications`), SSE endpoint (`/api/notifications/events?token=…`), email via MailCrab.
- Outlines flows: Admin/User → REST → Backend → (DB + Kafka) → Consumers → SSE + Email.

##### Essential architectural elements
- Detail the three Kafka topics and their consumers
- SSE endpoint and JWT token flow
- Fallback to database queries for history
- Email flow for critical notifications
- Components logically (e.g., “Backend Microservice”) but expand on sub-components for clarity

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        AdminUI["Admin UI"]:::frontend
        UserUI["User UI"]:::frontend
    end

    %% Backend Microservice
    subgraph "Backend Microservice"
        direction TB
        subgraph "Security & Auth"
            JwtAuthFilter["JwtAuthenticationFilter"]:::backend
            JwtTokenProvider["JwtTokenProvider"]:::backend
            SseTokenAuthFilter["SseTokenAuthenticationFilter"]:::backend
            CustomAuthProvider["CustomAuthenticationProvider"]:::backend
            SecurityConfig["SecurityConfig"]:::backend
        end
        subgraph "REST Layer"
            Controllers["REST Controllers"]:::backend
        end
        subgraph "Processing Orchestrator"
            Orchestrator["NotificationProcessingOrchestrator"]:::backend
        end
        subgraph "Service Layer"
            BroadcastService["NotificationBroadcastService"]:::backend
            DispatchService["NotificationDispatchService"]:::backend
            PersistenceService["NotificationPersistenceService"]:::backend
            NotificationService["NotificationService"]:::backend
            TypeService["NotificationTypeService"]:::backend
            UserService["UserService"]:::backend
            EmailService["EmailService"]:::backend
        end
        subgraph "SSE Push Engine"
            SseConfig["SseConfig"]:::backend
            SseEmitterMgr["SseEmitterManager"]:::backend
            SseController["SseController"]:::backend
        end
        subgraph "Kafka Integration"
            KafkaConfig["KafkaConfig"]:::backend
            BroadcastConsumer["BroadcastNotificationConsumer"]:::backend
            CriticalConsumer["CriticalNotificationConsumer"]:::backend
            GeneralConsumer["NotificationConsumer"]:::backend
        end
        subgraph "Persistence"
            Repositories["Repository Layer"]:::backend
            Models["Domain Models"]:::backend
            ConfigFiles["application.yml / schema.sql / data.sql"]:::backend
        end
    end

    %% Infrastructure Layer
    subgraph "Infrastructure"
        direction TB
        KafkaCluster["Kafka Cluster\n- topics: notifications\n- broadcast-notifications\n- critical-notifications"]:::infra
        Database[(Relational Database)]:::datastore
        MailCrab["MailCrab (Email UI)"]:::infra
    end

    %% Dev Orchestration
    subgraph "Dev Orchestration"
        direction TB
        DockerCompose["docker-compose.yml"]:::dev
        BackendDocker["backend/Dockerfile"]:::dev
        AdminDocker["frontend/admin-ui/Dockerfile"]:::dev
        UserDocker["frontend/user-ui/Dockerfile"]:::dev
        Scripts["scripts/*"]:::dev
    end

    %% Flows
    AdminUI -->|"HTTP(S) REST"| Controllers
    UserUI -->|"HTTP(S) REST"| Controllers
    Controllers -->|authenticate| JwtAuthFilter
    Controllers -->|authorize| CustomAuthProvider
    Controllers -->|calls| Orchestrator
    Orchestrator -->|persist| Repositories
    Repositories -->|use| Models
    Orchestrator -->|publish| KafkaCluster
    KafkaCluster -->|consume| BroadcastConsumer
    KafkaCluster -->|consume| CriticalConsumer
    KafkaCluster -->|consume| GeneralConsumer
    BroadcastConsumer -->|invoke| BroadcastService
    GeneralConsumer -->|invoke| DispatchService
    CriticalConsumer -->|invoke| EmailService
    EmailService -->|send| MailCrab
    BroadcastService -->|push via SSE| SseEmitterMgr
    DispatchService -->|push via SSE| SseEmitterMgr
    SseEmitterMgr -->|manage| SseController
    SseController -->|"SSE Stream"| UserUI
    SseConfig -->|configure| SseEmitterMgr
    KafkaConfig -->|configure| KafkaCluster
    Controllers -->|load| ConfigFiles

    %% Dev orchestration
    DockerCompose -->|orchestrates| BackendDocker
    DockerCompose -->|orchestrates| AdminDocker
    DockerCompose -->|orchestrates| UserDocker
    DockerCompose -->|orchestrates| KafkaCluster
    DockerCompose -->|orchestrates| MailCrab
    DockerCompose -->|runs| Scripts

    %% Click Events
    click AdminUI "https://github.com/rsrini7/notification-sse/tree/main/frontend/admin-ui/"
    click UserUI "https://github.com/rsrini7/notification-sse/tree/main/frontend/user-ui/"
    click Controllers "https://github.com/rsrini7/notification-sse/tree/main/backend/src/main/java/com/example/notification/controller/"
    click JwtAuthFilter "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/security/JwtAuthenticationFilter.java"
    click JwtTokenProvider "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/security/JwtTokenProvider.java"
    click SseTokenAuthFilter "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/security/SseTokenAuthenticationFilter.java"
    click CustomAuthProvider "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/security/CustomAuthenticationProvider.java"
    click SecurityConfig "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/config/SecurityConfig.java"
    click Orchestrator "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/service/NotificationProcessingOrchestrator.java"
    click KafkaConfig "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/config/KafkaConfig.java"
    click BroadcastConsumer "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/kafka/BroadcastNotificationConsumer.java"
    click CriticalConsumer "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/kafka/CriticalNotificationConsumer.java"
    click GeneralConsumer "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/kafka/NotificationConsumer.java"
    click SseConfig "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/config/SseConfig.java"
    click SseEmitterMgr "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/service/SseEmitterManager.java"
    click SseController "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/controller/SseController.java"
    click EmailService "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/service/EmailService.java"
    click BroadcastService "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/service/NotificationBroadcastService.java"
    click DispatchService "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/service/NotificationDispatchService.java"
    click PersistenceService "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/service/NotificationPersistenceService.java"
    click NotificationService "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/service/NotificationService.java"
    click TypeService "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/service/NotificationTypeService.java"
    click UserService "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/java/com/example/notification/service/UserService.java"
    click Repositories "https://github.com/rsrini7/notification-sse/tree/main/backend/src/main/java/com/example/notification/repository/"
    click Models "https://github.com/rsrini7/notification-sse/tree/main/backend/src/main/java/com/example/notification/model/"
    click ConfigFiles "https://github.com/rsrini7/notification-sse/blob/main/backend/src/main/resources/application.yml"
    click DockerCompose "https://github.com/rsrini7/notification-sse/blob/main/docker-compose.yml"
    click BackendDocker "https://github.com/rsrini7/notification-sse/tree/main/backend/Dockerfile"
    click AdminDocker "https://github.com/rsrini7/notification-sse/tree/main/frontend/admin-ui/Dockerfile"
    click UserDocker "https://github.com/rsrini7/notification-sse/tree/main/frontend/user-ui/Dockerfile"
    click Scripts "https://github.com/rsrini7/notification-sse/tree/main/scripts/"

    %% Styles
    classDef frontend fill:#a2d2ff,stroke:#333,stroke-width:1px
    classDef backend fill:#caffbf,stroke:#333,stroke-width:1px
    classDef infra fill:#ffd6a5,stroke:#333,stroke-width:1px
    classDef datastore fill:#fdffb6,stroke:#333,stroke-width:1px
    classDef dev fill:#eeeeee,stroke:#333,stroke-width:1px
```
