How dev-mayanktiwari/mlogs-email-service works
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.