How owaisahmadshah/queue-service works
Queue Service accepts notification jobs over REST, persists them, queues delivery work, and uses channel workers to deliver and record outcomes; exhausted failures can be inspected and replayed. The API also provides user and API-key management, job cancellation, statistics, pagination, and delivery/dead-letter log endpoints. The graph combines sampled call/reference evidence with explicit README capabilities; unsampled route wiring and some channel/queue details are shown only where documented, or omitted when ownership is unclear.
Main entry points: notification-job-service.ts Job Service · app.ts Express App · email-worker.ts Email Worker · webhook-worker.ts Webhook Worker
Components 26
HTTP API
- Express App
src/app.ts - Job Routes
src/routes/notification-job-route.ts - Job Controller
src/controllers/notification-job-controller.ts - Log Routes
src/routes/delivery-logs-route.ts - Log Controllers
src/controllers/delivery-logs-controller.ts - DLQ Controller
src/controllers/dead-letter-logs-controller.ts
Identity and Access
- User Routes
src/routes/user-route.ts - User Controller
src/controllers/user-controller.ts - User Service
src/services/user-service.ts - API Key Management
src/services/api-key-service.ts
Job Lifecycle
- Job Service
src/services/notification-job-service.ts - Delivery Log Service
src/services/delivery-logs-service.ts - Dead Letter Service
src/services/dead-letter-logs-service.ts
Delivery Runtime
- Notification Queues
src/queues/notification-queue.ts - Email Worker
src/workers/email-worker.ts - Webhook Worker
src/workers/webhook-worker.ts - Email Sender
src/services/email-service.ts - Webhook Sender
src/services/webhook-service.ts - Redis
src/config/redis.ts
Persistence
- Job Repository
src/repositories/notification-job-repository.ts - Delivery Log Repository
src/repositories/delivery-logs-repository.ts - Dead Letter Repository
src/repositories/dead-letter-logs-repository.ts - PostgreSQL
src/db/pool.ts
Other components
- Client
- Email Provider
- Webhook Target
Connections 37
- Client → Express App: sends requests
- Express App → Job Routes: mounts routes
src/app.ts - Express App → User Routes: mounts routes
src/app.ts - Express App → Log Routes: mounts routes
src/app.ts - Job Routes → Job Controller: routes to
- User Routes → User Controller: routes to
src/routes/user-route.ts - Job Controller → Job Service: calls
src/controllers/notification-job-controller.ts - User Controller → User Service: calls
src/controllers/user-controller.ts - Log Routes → Log Controllers: routes to
- Log Controllers → Delivery Log Service: calls
src/controllers/delivery-logs-controller.ts - Express App → DLQ Controller: mounts endpoint
- DLQ Controller → Dead Letter Service: calls
src/controllers/dead-letter-logs-controller.ts - User Service → Job Service: creates OTP jobs
src/services/user-service.ts - Job Service → Job Repository: persists jobs
src/services/notification-job-service.ts - Job Service → Notification Queues: enqueues email
src/services/notification-job-service.ts - Email Worker → Job Service: updates job state
src/workers/email-worker.ts - Webhook Worker → Job Service: updates job state
src/workers/webhook-worker.ts - Email Worker → Email Sender: delivers email
src/workers/email-worker.ts - Webhook Worker → Webhook Sender: sends webhook
src/workers/webhook-worker.ts - Email Sender → Email Provider: sends email
- Webhook Sender → Webhook Target: posts payload
- Email Worker → Delivery Log Service: records attempts
src/workers/email-worker.ts - Webhook Worker → Delivery Log Service: records attempts
src/workers/webhook-worker.ts - Delivery Log Service → Delivery Log Repository: stores logs
src/services/delivery-logs-service.ts - Job Service → Delivery Log Service: deletes logs
src/services/notification-job-service.ts - Job Service → Dead Letter Service: deletes DLQ logs
src/services/notification-job-service.ts - Dead Letter Service → Dead Letter Repository: reads and writes
src/services/dead-letter-logs-service.ts - Dead Letter Service → Job Service: replays job
src/services/dead-letter-logs-service.ts - Job Repository → PostgreSQL: queries
src/repositories/notification-job-repository.ts - Delivery Log Repository → PostgreSQL: queries
src/repositories/delivery-logs-repository.ts - Dead Letter Repository → PostgreSQL: queries
src/repositories/dead-letter-logs-repository.ts - Express App → Email Worker: starts worker
src/app.ts - Express App → Webhook Worker: starts worker
src/app.ts - Express App → Notification Queues: initializes queues
src/app.ts - Notification Queues → Redis: uses connection
- Email Worker → Notification Queues: consumes channel jobs
- Webhook Worker → Notification Queues: consumes channel jobs