# dev-mayanktiwari/mlogs-email-service architecture

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

- Interactive diagram: https://gitdiagram.com/dev-mayanktiwari/mlogs-email-service
- Repository: https://github.com/dev-mayanktiwari/mlogs-email-service

## Overview

##### Project Type and Purpose
- This is a standalone email microservice in the MLOGS ecosystem.
- Its sole responsibility is to process email-related tasks (account confirmation, password reset, notifications) via queued jobs.
- It uses BullMQ (Redis) for queuing, Nodemailer for sending emails, and optionally MongoDB for logging.

##### File Structure
- Top-level files: Dockerfile, docker-compose.yaml, ecosystem.config.js (process manager), nodemon.json (dev runner).
- src/config: Redis and Nodemailer configuration.
- src/queues: queue names (general, password, dead-letter).
- src/services: logic for each email type (welcome, reset, etc.).
- src/workers: BullMQ Workers subscribing to each queue.
- src/services/mongoDbConnectService.ts: optional logging to MongoDB.
- src/server.ts: entry point bootstrapping workers and HTTP (health) server.

##### Readme Insights
- Relies on upstream MLOGS backend to push jobs into Redis.
- Uses BullMQ for queue management and dead-letter handling.
- External dependencies: Redis, SMTP server (via Nodemailer), optional MongoDB.

##### Main Components and Interactions
a. Upstream Producer
– MLOGS Backend Service (external)
– Pushes jobs into Redis queues via BullMQ (GeneralQueue, PasswordQueue)
b. Message Broker
– Redis instance
– Stores queued jobs and dead-letter queue
c. Email Microservice
– server.ts: starts HTTP health API and Workers
– Workers (generalQueueWorker, passwordQueueWorker, deadLetterQueueWorker)
– Services: sendWelcomeEmail, sendPasswordReset, sendAccountConfirmation, sendAdminNotification, etc.
– Config modules: redisConfig, nodemailerConfig
– Utils: logger
– Optional MongoDB connector for logging
d. External Systems
– SMTP Server (e.g., Gmail SMTP or any provider)
– MongoDB Atlas or local Mongo (for logs)
– Administrator Email (for failure notifications)

Interactions (data flow):
1. MLOGS Backend → Redis (enqueue job)
2. Worker polls Redis queue → fetches job
3. Worker invokes Service → formats & sends email via Nodemailer → SMTP
4. On success/failure → log outcome (MongoDB) & possibly enqueue to dead-letter
5. Dead-letter Worker → reads from dead-letter queue → triggers sendAdminNotification

##### Architectural Patterns & Design Principles
- Microservice – single responsibility for email.
- Asynchronous Processing – decoupled via message queue.
- Retry & DLQ – isolated dead-letter handling.
- Modular Code – clear separation: config, queues, services, workers, utils.
- Observability – logging, health endpoint, Docker/Ecosystem configs.

##### Must-Include Elements

– The microservice’s sole focus on email processing
– The asynchronous, queue-based architecture
– All critical integrations: Redis, SMTP, MongoDB
– Internal modular architecture: config, workers, services, utils

Keep it as detailed as possible—break the microservice into the smallest logical components—to give maximum clarity to developers and stakeholders.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Producer
    MLOGS_Backend["MLOGS Backend Service"]:::external

    %% Docker Compose Boundary
    subgraph "Docker Compose" 
        direction TB
        Redis[(Redis)]:::broker
        MongoDB[(MongoDB)]:::storage
    end

    %% Email Microservice Boundary
    subgraph "Email Microservice" 
        direction TB
        %% Config & Utils
        ConfigIndex["Config Index (env loader)"]:::config
        RedisConfig["Redis Configuration"]:::config
        NodemailerConfig["Nodemailer Configuration"]:::config
        Constants["Queue Constants"]:::config
        Logger["Logger Utility"]:::util
        Types["Type Definitions"]:::util

        %% Server
        HTTPServer["HTTP Server (Health API & Bootstrap)"]:::server

        %% Services Layer
        subgraph "Services" 
            direction TB
            WelcomeEmail["sendWelcomeEmail"]:::service
            AccountConfirm["sendAccountConfirmationEmail"]:::service
            PasswordReset["sendPasswordReset"]:::service
            PasswordChanged["sendPasswordChangedEmail"]:::service
            BlogPostNotify["sendBlogPostEmail"]:::service
            AdminNotify["sendAdminNotification"]:::service
            MongoConnector["mongoDbConnectService"]:::service
        end

        %% Workers Layer
        subgraph "Queue Workers"
            direction TB
            GeneralWorker["General Queue Worker"]:::worker
            PasswordWorker["Password Queue Worker"]:::worker
            DeadLetterWorker["Dead-Letter Queue Worker"]:::worker
        end
    end

    %% External Dependencies
    SMTP["SMTP Server"]:::external
    AdminEmail["Administrator Email"]:::external

    %% Interactions
    MLOGS_Backend -->|"enqueue job"| Redis
    GeneralWorker -->|"fetch job (GeneralQueue)"| Redis
    PasswordWorker -->|"fetch job (PasswordQueue)"| Redis
    DeadLetterWorker -->|"fetch job (DeadLetterQueue)"| Redis

    GeneralWorker -->|"invoke service"| WelcomeEmail
    GeneralWorker -->|"invoke service"| BlogPostNotify
    PasswordWorker -->|"invoke service"| PasswordReset
    PasswordWorker -->|"invoke service"| PasswordChanged
    DeadLetterWorker -->|"invoke service"| AdminNotify

    %% Email Sending
    WelcomeEmail -->|"send email"| SMTP
    AccountConfirm -->|"send email"| SMTP
    PasswordReset -->|"send email"| SMTP
    PasswordChanged -->|"send email"| SMTP
    BlogPostNotify -->|"send email"| SMTP
    AdminNotify -->|"send alert"| AdminEmail

    %% Logging
    WelcomeEmail -->|"log outcome"| MongoDB
    AccountConfirm -->|"log outcome"| MongoDB
    PasswordReset -->|"log outcome"| MongoDB
    PasswordChanged -->|"log outcome"| MongoDB
    BlogPostNotify -->|"log outcome"| MongoDB
    AdminNotify -->|"log outcome"| MongoDB

    %% Server bootstrap dependencies
    HTTPServer --> ConfigIndex
    ConfigIndex --> RedisConfig
    ConfigIndex --> NodemailerConfig
    ConfigIndex --> Constants
    HTTPServer --> Logger
    HTTPServer --> Types

    %% Styles
    classDef external fill:#E0F7FA,stroke:#00838F,color:#006064
    classDef broker fill:#FFF3E0,stroke:#FB8C00,color:#E65100
    classDef storage fill:#E8F5E9,stroke:#43A047,color:#1B5E20
    classDef config fill:#E3F2FD,stroke:#1E88E5,color:#0D47A1
    classDef util fill:#F3E5F5,stroke:#8E24AA,color:#4A148C
    classDef server fill:#E1F5FE,stroke:#039BE5,color:#01579B
    classDef worker fill:#E8EAF6,stroke:#5C6BC0,color:#283593
    classDef service fill:#FFFDE7,stroke:#FDD835,color:#F57F17

    %% Click Events
    click HTTPServer "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/server.ts"
    click RedisConfig "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/config/redisConfig.ts"
    click NodemailerConfig "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/config/nodemailerConfig.ts"
    click ConfigIndex "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/config/index.ts"
    click Constants "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/constant/index.ts"
    click DeadLetterWorker "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/workers/deadLetterQueueWorker.ts"
    click GeneralWorker "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/workers/generalQueueWorker.ts"
    click PasswordWorker "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/workers/passwordQueueWorker.ts"
    click WelcomeEmail "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/services/sendWelcomeEmail.ts"
    click AccountConfirm "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/services/sendAccountConfirmationEmail.ts"
    click PasswordReset "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/services/sendPasswordReset.ts"
    click PasswordChanged "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/services/sendPasswordChangedEmail.ts"
    click BlogPostNotify "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/services/sendBlogPostEmail.ts"
    click AdminNotify "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/services/sendAdminNotification.ts"
    click MongoConnector "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/services/mongoDbConnectService.ts"
    click Logger "https://github.com/dev-mayanktiwari/mlogs-email-service/blob/main/src/utils/logger.ts"
```
