# adityabavadekar/messenger architecture

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

- Interactive diagram: https://gitdiagram.com/adityabavadekar/messenger
- Repository: https://github.com/adityabavadekar/messenger

## Overview

##### Project Type and Purpose
- This is an Android native, open-source real-time messaging application called “Wave Messenger.”
- It consists of two Gradle modules:
- “app”: the main Android application containing UI, controllers, services, and local persistence.
- “model”: a pure Kotlin module defining all data classes and domain models.
- It uses Firebase (Auth, Realtime Database, Cloud Storage, FCM), Room DB for offline caching, Android Jetpack (ViewModel, LiveData), SyncAdapters/ContentProvider, and various utility libraries.

##### File Structure
- Top-level: `.github`, CI/CD workflows, `buildSrc` for dependency/version management, `app` and `model` modules.
- `app/src/main/java/com/adityaamolbavadekar/messenger`: subdivided into
- ui (Activities/Fragments, ViewModels)
- database (Room entities, DAOs, Repositories, ViewModels)
- managers (AuthManager, CloudDatabaseManager, CloudStorageManager, FcmTokenManager, PrefsManager, InternetManager, etc.)
- services & sync (FcmService, AuthStateListenerService, SyncAdapter & ContentProvider)
- notifications (NotificationHelper, RetrofitInstance)
- account, contact, installation, dialogs, shortcuts, utils, views packages.
- `model`: Kotlin data classes mirror database records and remote data representations.

##### README Insights
- Confirms: no end-to-end encryption yet; under active development.
- Tech stack call-outs: Material Design, Room, libphonenumber, Firebase Auth/Messaging/Storage/RealtimeDB, Glide, Lottie, Jsoup, Kotlin.

##### Main Components
a. Android Application Module (“app”)
- Presentation Layer: Activities & Fragments
- ViewModel Layer: AndroidViewModel & Presenter classes
- Data Layer: Repositories that orchestrate Room database and CloudDatabaseManager
- Local Persistence: Room Database + DAOs + ContentProvider (for sync)
- Sync & Background Services: SyncAdapter, FcmService, AuthStateListenerService
- Notification Subsystem: FcmService → NotificationHelper → OS Notification API
- Utility & Helper classes (ClipboardUtil, EmojiUtils, LinkPreview, etc.)
- UI Components & Custom Views
b. Model Module (“model”)
- Domain/Data Models: MessageRecord, ConversationRecord, User, ReactionRecord, etc.
c. External Services
- Firebase Auth
- Firebase Realtime Database
- Firebase Cloud Storage
- Firebase Cloud Messaging (FCM)
- Google libphonenumber
d. Third-party Libraries
- Glide, Lottie, Jsoup, PhotoView, PinLog

##### Relationships and Data Flows
- UI → ViewModel: user actions (send message, open conversation)
- ViewModel → Repository: CRUD operations
- Repository → Room DB (local) & CloudDatabaseManager (remote sync)
- SyncAdapter/ContentProvider: periodic two-way sync between Room and Firebase RealtimeDB
- FcmService → NotificationHelper → OS → UI when messages arrive
- CloudStorageManager: file upload/download for attachments
- AuthManager → FirebaseAuth for login/logout flows

##### Architectural Patterns and Principles
- MVVM (Model-View-ViewModel) using AndroidViewModel
- Repository Pattern abstracting local vs. remote data sources
- Single Responsibility: each “Manager” or “Helper” focuses on one concern (auth, internet, prefs, links)
- Modularization: separation of domain models into a distinct `model` module
- Asynchronous data flow: LiveData / callbacks / Coroutine (presumed)

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Presentation Layer"
        UI["UI (Activities/Fragments)"]:::presentation
    end

    subgraph "ViewModel Layer"
        VM["ViewModels"]:::viewmodel
    end

    subgraph "Domain Model Module"
        Model["Model Module"]:::domain
    end

    subgraph "Data & Repository Layer"
        Repo["Repositories"]:::data
        Managers["Managers"]:::data
    end

    subgraph "Local Persistence"
        Room["Room DB + ContentProvider"]:::local
    end

    subgraph "Sync & Background Services"
        Sync["SyncAdapter / Services"]:::service
        FCMService["AuthStateListenerService & FcmService"]:::service
    end

    subgraph "Notification Subsystem"
        Notification["Notification Helper & API"]:::util
    end

    subgraph "Remote Services"
        Auth["Firebase Auth"]:::remote
        RealtimeDB["Firebase Realtime DB"]:::remote
        Storage["Firebase Storage"]:::remote
        FCM["Firebase Cloud Messaging (FCM)"]:::remote
    end

    UI -->|"user actions"| VM
    VM -->|"calls"| Repo
    VM -->|"observes"| Model
    Repo -->|"read/write"| Room
    Repo -->|"sync requests"| Managers
    Managers -->|"authenticate()"| Auth
    Managers -->|"getData() / pushData()"| RealtimeDB
    Managers -->|"upload/download"| Storage
    Managers -->|"manageTokens()"| FCM
    Sync -->|"- - two-way sync - -"| Room
    Sync -->|"- - two-way sync - -"| RealtimeDB
    FCM -->|"-.- push"| FCMService
    FCMService -->|"onMessageReceived()"| Notification
    Notification -->|"showNotification()"| UI

    classDef presentation fill:#D0E6FF,stroke:#1E70BF,color:#000;
    classDef viewmodel fill:#D0E6FF,stroke:#1E70BF,color:#000;
    classDef domain fill:#FFF4D0,stroke:#BF8F1E,color:#000;
    classDef data fill:#DFFFE0,stroke:#1E7F1E,color:#000;
    classDef local fill:#DFFFE0,stroke:#1E7F1E,color:#000;
    classDef service fill:#EEEEEE,stroke:#888888,color:#000;
    classDef util fill:#EEEEEE,stroke:#888888,color:#000;
    classDef remote fill:#FFE8D0,stroke:#BF4C1E,color:#000;

    click UI "https://github.com/adityabavadekar/messenger/tree/master/app/src/main/java/com/adityaamolbavadekar/messenger/ui/"
    click VM "https://github.com/adityabavadekar/messenger/tree/master/app/src/main/java/com/adityaamolbavadekar/messenger/ui/"
    click VM "https://github.com/adityabavadekar/messenger/blob/master/app/src/main/java/com/adityaamolbavadekar/messenger/database/conversations/DatabaseAndroidViewModel.kt"
    click Repo "https://github.com/adityabavadekar/messenger/blob/master/app/src/main/java/com/adityaamolbavadekar/messenger/database/conversations/ApplicationDatabaseRepository.kt"
    click Room "https://github.com/adityabavadekar/messenger/blob/master/app/src/main/java/com/adityaamolbavadekar/messenger/database/conversations/ApplicationDatabase.kt"
    click Room "https://github.com/adityabavadekar/messenger/blob/master/app/src/main/java/com/adityaamolbavadekar/messenger/database/conversations/ConversationDao.kt"
    click Sync "https://github.com/adityabavadekar/messenger/tree/master/app/src/main/java/com/adityaamolbavadekar/messenger/sync/"
    click FCMService "https://github.com/adityabavadekar/messenger/blob/master/app/src/main/java/com/adityaamolbavadekar/messenger/services/AuthStateListenerService.kt"
    click FCMService "https://github.com/adityabavadekar/messenger/blob/master/app/src/main/java/com/adityaamolbavadekar/messenger/services/FcmService.kt"
    click Notification "https://github.com/adityabavadekar/messenger/tree/master/app/src/main/java/com/adityaamolbavadekar/messenger/notifications/"
    click Managers "https://github.com/adityabavadekar/messenger/tree/master/app/src/main/java/com/adityaamolbavadekar/messenger/managers/"
    click Model "https://github.com/adityabavadekar/messenger/tree/master/model/src/main/java/com/adityaamolbavadekar/messenger/model/"
```
