Merge pull request #375 from Ayinkx1/main

Add SMS messaging microservice

Author: Mkalbani

microservices/sms-service/.env.example

@@ -0,0 +1,25 @@
+NODE_ENV=development
+SERVICE_PORT=3010
+
+DB_HOST=localhost
+DB_PORT=5432
+DB_USER=postgres
+DB_PASSWORD=postgres
+DB_NAME=sms_service
+DB_SYNCHRONIZE=true
+
+SMS_PROVIDER=console
+SMS_DEFAULT_FROM=Quest
+
+TWILIO_ACCOUNT_SID=
+TWILIO_AUTH_TOKEN=
+TWILIO_FROM_NUMBER=
+TWILIO_STATUS_CALLBACK_URL=
+
+AWS_REGION=us-east-1
+AWS_SNS_SENDER_ID=Quest
+
+OTP_TTL_SECONDS=300
+OTP_LENGTH=6
+SMS_RATE_LIMIT_MAX=5
+SMS_RATE_LIMIT_WINDOW_SECONDS=60

microservices/sms-service/README.md

@@ -0,0 +1,45 @@
+# SMS Service
+
+NestJS microservice for sending verification codes, alerts, and time-sensitive text messages.
+
+## Features
+
+- SMS, message, and delivery receipt entities backed by TypeORM/PostgreSQL
+- Provider abstraction with local console sending and Twilio HTTP support
+- Secure OTP generation with hashed verification codes and expiry
+- Handlebars message templates
+- Scheduled message dispatch through `@nestjs/schedule`
+- Delivery receipt webhook endpoint
+- Phone validation, per-phone rate limiting, history, and analytics
+- Docker and docker-compose configuration
+
+## Local Run
+
+```bash
+cd microservices/sms-service
+npm install
+npm run start:dev
+```
+
+The default `SMS_PROVIDER=console` logs outbound SMS messages and marks them sent. Set `SMS_PROVIDER=twilio` with `TWILIO_ACCOUNT_SID`, `TWILIO_AUTH_TOKEN`, and `TWILIO_FROM_NUMBER` to send real SMS.
+
+## API
+
+- `GET /health`
+- `POST /sms/send`
+- `POST /sms/send-template`
+- `POST /sms/otp`
+- `POST /sms/otp/verify`
+- `POST /sms/receipts`
+- `GET /sms`
+- `GET /sms/:id`
+- `POST /sms/:id/cancel`
+- `GET /sms-analytics`
+- `GET /sms-templates`
+
+## Docker
+
+```bash
+cd microservices/sms-service
+docker compose -f docker/docker-compose.yml up --build
+```

microservices/sms-service/docker/Dockerfile

@@ -0,0 +1,34 @@
+FROM node:18-alpine AS builder
+
+WORKDIR /app
+
+COPY package*.json ./
+COPY tsconfig*.json ./
+COPY nest-cli.json ./
+
+RUN npm ci
+
+COPY src ./src
+RUN npm run build
+
+FROM node:18-alpine
+
+WORKDIR /app
+
+RUN apk add --no-cache dumb-init
+
+COPY package*.json ./
+RUN npm ci --only=production && npm cache clean --force
+
+COPY --from=builder /app/dist ./dist
+
+RUN addgroup -g 1001 -S nodejs && adduser -S nodejs -u 1001
+USER nodejs
+
+EXPOSE 3010
+
+HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
+  CMD wget --no-verbose --tries=1 --spider http://localhost:3010/health || exit 1
+
+ENTRYPOINT ["dumb-init", "--"]
+CMD ["node", "dist/main.js"]

microservices/sms-service/docker/docker-compose.yml

@@ -0,0 +1,63 @@
+version: '3.8'
+
+services:
+  sms-service:
+    container_name: sms-service
+    build:
+      context: ..
+      dockerfile: docker/Dockerfile
+    ports:
+      - '3010:3010'
+    environment:
+      - NODE_ENV=development
+      - SERVICE_PORT=3010
+      - DB_HOST=postgres
+      - DB_PORT=5432
+      - DB_USER=${DB_USER:-postgres}
+      - DB_PASSWORD=${DB_PASSWORD:-postgres}
+      - DB_NAME=${DB_NAME:-sms_service}
+      - SMS_PROVIDER=${SMS_PROVIDER:-console}
+      - SMS_DEFAULT_FROM=${SMS_DEFAULT_FROM:-Quest}
+      - TWILIO_ACCOUNT_SID=${TWILIO_ACCOUNT_SID:-}
+      - TWILIO_AUTH_TOKEN=${TWILIO_AUTH_TOKEN:-}
+      - TWILIO_FROM_NUMBER=${TWILIO_FROM_NUMBER:-}
+      - TWILIO_STATUS_CALLBACK_URL=${TWILIO_STATUS_CALLBACK_URL:-}
+      - OTP_TTL_SECONDS=${OTP_TTL_SECONDS:-300}
+      - OTP_LENGTH=${OTP_LENGTH:-6}
+      - SMS_RATE_LIMIT_MAX=${SMS_RATE_LIMIT_MAX:-5}
+      - SMS_RATE_LIMIT_WINDOW_SECONDS=${SMS_RATE_LIMIT_WINDOW_SECONDS:-60}
+    depends_on:
+      postgres:
+        condition: service_healthy
+    networks:
+      - sms-network
+    restart: unless-stopped
+
+  postgres:
+    container_name: postgres-sms
+    image: postgres:15-alpine
+    environment:
+      - POSTGRES_USER=${DB_USER:-postgres}
+      - POSTGRES_PASSWORD=${DB_PASSWORD:-postgres}
+      - POSTGRES_DB=sms_service
+    ports:
+      - '5440:5432'
+    volumes:
+      - postgres_sms_data:/var/lib/postgresql/data
+      - ./init-db.sql:/docker-entrypoint-initdb.d/init-db.sql
+    networks:
+      - sms-network
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    restart: unless-stopped
+
+volumes:
+  postgres_sms_data:
+    driver: local
+
+networks:
+  sms-network:
+    driver: bridge

microservices/sms-service/docker/init-db.sql

@@ -0,0 +1 @@
+CREATE EXTENSION IF NOT EXISTS "uuid-ossp";

microservices/sms-service/eslint.config.mjs

@@ -0,0 +1,42 @@
+import js from '@eslint/js';
+import tsParser from '@typescript-eslint/parser';
+import tsPlugin from '@typescript-eslint/eslint-plugin';
+import prettierPlugin from 'eslint-plugin-prettier';
+import configPrettier from 'eslint-config-prettier';
+
+export default [
+  js.configs.recommended,
+  {
+    files: ['**/*.ts'],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        project: './tsconfig.json',
+        tsconfigRootDir: import.meta.dirname,
+        sourceType: 'module',
+      },
+      globals: {
+        console: 'readonly',
+        process: 'readonly',
+        Buffer: 'readonly',
+        fetch: 'readonly',
+        describe: 'readonly',
+        beforeEach: 'readonly',
+        it: 'readonly',
+        expect: 'readonly',
+        jest: 'readonly',
+      },
+    },
+    plugins: {
+      '@typescript-eslint': tsPlugin,
+      prettier: prettierPlugin,
+    },
+    rules: {
+      ...tsPlugin.configs.recommended.rules,
+      'prettier/prettier': 'error',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+    },
+  },
+  configPrettier,
+];

microservices/sms-service/nest-cli.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}