How puneetchhabra22/scalable-notification-system works
This is a multi-service notification platform: clients submit channel-specific requests, the API validates and enriches them, then priority queues distribute work to processing services and channel consumers. Processing personalizes templates, applies user preferences, prevents duplicates, records notification state, and dispatches email, SMS, or push work. The README documents caching, preference controls, quiet hours, and rate limiting; excerpts confirm template-priority lookup, priority Kafka routing, and delivery-state updates. Several API-to-worker and consumer wiring details are not shown, so those links are marked unverified.
Main entry points: NotificationProcessingService.java Request Validation · EmailProcessingService.java Email Consumer · SmsProcessingService.java SMS Consumer · PushNProcessingService.java Push Consumer
Components 22
API and Enrichment
- Notification API
notificationservice/src/main/java/com/puneetchhabra/notificationservice/controllers/NotificationsController.java - Request Validation
notificationservice/src/main/java/com/puneetchhabra/notificationservice/service/NotificationProcessingService.java - Priority Kafka Router
notificationservice/src/main/java/com/puneetchhabra/notificationservice/service/KafkaService.java
Priority Processing
- Priority One Worker
NotificationProcessorPriority1/src/main/java/com/puneetchhabra/NotificationProcessorPriority1/service/NotificationProcessingService.java - Priority Two Worker
NotificationProcessorPriority2/src/main/java/com/puneetchhabra/NotificationProcessorPriority2/service/NotificationProcessingService.java - Priority Three Worker
NotificationProcessorPriority3/src/main/java/com/puneetchhabra/NotificationProcessorPriority3/service/NotificationProcessingService.java - Notification Dispatch
NotificationProcessorPriority1/src/main/java/com/puneetchhabra/NotificationProcessorPriority1/service/SendNotificationService.java - Notification Dispatch
NotificationProcessorPriority2/src/main/java/com/puneetchhabra/NotificationProcessorPriority2/service/SendNotificationService.java - Notification Dispatch
NotificationProcessorPriority3/src/main/java/com/puneetchhabra/NotificationProcessorPriority3/service/SendNotificationService.java
Channel Delivery
- Email Consumer
EmailConsumer/src/main/java/com/puneetchhabra/EmailConsumer/service/EmailProcessingService.java - SMS Consumer
SMSConsumer/src/main/java/com/puneetchhabra/SMSConsumer/service/SmsProcessingService.java - Push Consumer
PushNConsumer/src/main/java/com/puneetchhabra/PushNConsumer/service/PushNProcessingService.java
State and Cache
- Redis Cache
notificationservice/src/main/java/com/puneetchhabra/notificationservice/service/RedisService.java - Template Store
notificationservice/src/main/java/com/puneetchhabra/notificationservice/repo/TemplateRepository.java - Delivery Logs
NotificationProcessorPriority1/src/main/java/com/puneetchhabra/NotificationProcessorPriority1/repo/DeliveryLogRepository.java - Notifications
NotificationProcessorPriority1/src/main/java/com/puneetchhabra/NotificationProcessorPriority1/repo/NotificationRepository.java
Other components
- Client
- Kafka
- MySQL
- SendGrid
- Twilio
- Push Provider
Connections 30
- Client → Notification API: submits request
- Notification API → Request Validation: validates request
notificationservice/src/main/java/com/puneetchhabra/notificationservice/controllers/NotificationsController.java - Request Validation → Redis Cache: reads priority
notificationservice/src/main/java/com/puneetchhabra/notificationservice/service/NotificationProcessingService.java - Request Validation → Template Store: loads template
notificationservice/src/main/java/com/puneetchhabra/notificationservice/service/NotificationProcessingService.java - Request Validation → Priority Kafka Router: forwards request
- Priority Kafka Router → Kafka: routes by priority
notificationservice/src/main/java/com/puneetchhabra/notificationservice/service/KafkaService.java - Kafka → Priority One Worker: delivers priority one
- Kafka → Priority Two Worker: delivers priority two
- Kafka → Priority Three Worker: delivers priority three
- Priority One Worker → Notification Dispatch: dispatches channels
NotificationProcessorPriority1/src/main/java/com/puneetchhabra/NotificationProcessorPriority1/service/NotificationProcessingService.java - Priority Two Worker → Notification Dispatch: dispatches channels
NotificationProcessorPriority2/src/main/java/com/puneetchhabra/NotificationProcessorPriority2/service/NotificationProcessingService.java - Priority Three Worker → Notification Dispatch: dispatches channels
NotificationProcessorPriority3/src/main/java/com/puneetchhabra/NotificationProcessorPriority3/service/NotificationProcessingService.java - Notification Dispatch → Kafka: queues channel work
NotificationProcessorPriority1/src/main/java/com/puneetchhabra/NotificationProcessorPriority1/service/SendNotificationService.java - Notification Dispatch → Kafka: queues channel work
NotificationProcessorPriority2/src/main/java/com/puneetchhabra/NotificationProcessorPriority2/service/SendNotificationService.java - Notification Dispatch → Kafka: queues channel work
NotificationProcessorPriority3/src/main/java/com/puneetchhabra/NotificationProcessorPriority3/service/SendNotificationService.java - Kafka → Email Consumer: delivers email work
- Kafka → SMS Consumer: delivers SMS work
- Kafka → Push Consumer: delivers push work
- Email Consumer → SendGrid: sends email
- SMS Consumer → Twilio: sends SMS
- Push Consumer → Push Provider: sends push
- Email Consumer → Notifications: updates status
EmailConsumer/src/main/java/com/puneetchhabra/EmailConsumer/service/EmailProcessingService.java - Email Consumer → Delivery Logs: writes delivery result
EmailConsumer/src/main/java/com/puneetchhabra/EmailConsumer/service/EmailProcessingService.java - SMS Consumer → Notifications: updates status
SMSConsumer/src/main/java/com/puneetchhabra/SMSConsumer/service/SmsProcessingService.java - SMS Consumer → Delivery Logs: writes delivery result
SMSConsumer/src/main/java/com/puneetchhabra/SMSConsumer/service/SmsProcessingService.java - Push Consumer → Notifications: updates status
PushNConsumer/src/main/java/com/puneetchhabra/PushNConsumer/service/PushNProcessingService.java - Push Consumer → Delivery Logs: writes delivery result
PushNConsumer/src/main/java/com/puneetchhabra/PushNConsumer/service/PushNProcessingService.java - Notification Dispatch → MySQL: persists request state
- Notification Dispatch → MySQL: persists request state
- Notification Dispatch → MySQL: persists request state