laxmanhalaki/Re_Backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

configuration screen added added

Browse Source
This commit is contained in:
laxmanhalaki 2025-11-05 15:38:08 +05:30
parent a5adb8d42e
commit cd6a71b804
33 changed files with 6661 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

270
ADMIN_CONFIGURATIONS.md Normal file
View File

@ -0,0 +1,270 @@
# Admin Configurable Settings - Complete Reference
## 📋 All 18 Settings Across 7 Categories
This document lists all admin-configurable settings as per the SRS document requirements.
All settings are **editable via the Settings page** (Admin users only) and stored in the `admin_configurations` table.
---
## 1️⃣ **TAT Settings** (6 Settings)
Settings that control Turnaround Time calculations and reminders.
| Setting | Key | Type | Default | Range | Description |
|---------|-----|------|---------|-------|-------------|
| Default TAT - Express | `DEFAULT_TAT_EXPRESS_HOURS` | Number | 24 | 1-168 | Default TAT hours for express priority (calendar days) |
| Default TAT - Standard | `DEFAULT_TAT_STANDARD_HOURS` | Number | 48 | 1-720 | Default TAT hours for standard priority (working days) |
| First Reminder Threshold | `TAT_REMINDER_THRESHOLD_1` | Number | 50 | 1-100 | Send gentle reminder at this % of TAT elapsed |
| Second Reminder Threshold | `TAT_REMINDER_THRESHOLD_2` | Number | 75 | 1-100 | Send escalation warning at this % of TAT elapsed |
| Work Start Hour | `WORK_START_HOUR` | Number | 9 | 0-23 | Hour when working day starts (24h format) |
| Work End Hour | `WORK_END_HOUR` | Number | 18 | 0-23 | Hour when working day ends (24h format) |
**UI Component:** Number input + Slider for thresholds
**Category Color:** Blue 🔵
---
## 2️⃣ **Document Policy** (3 Settings)
Settings that control file uploads and document management.
| Setting | Key | Type | Default | Range | Description |
|---------|-----|------|---------|-------|-------------|
| Max File Size | `MAX_FILE_SIZE_MB` | Number | 10 | 1-100 | Maximum file upload size in MB |
| Allowed File Types | `ALLOWED_FILE_TYPES` | String | pdf,doc,docx... | - | Comma-separated list of allowed extensions |
| Document Retention Period | `DOCUMENT_RETENTION_DAYS` | Number | 365 | 30-3650 | Days to retain documents after closure |
**UI Component:** Number input + Text input
**Category Color:** Purple 🟣
---
## 3️⃣ **AI Configuration** (2 Settings)
Settings for AI-generated conclusion remarks.
| Setting | Key | Type | Default | Range | Description |
|---------|-----|------|---------|-------|-------------|
| Enable AI Remarks | `AI_REMARK_GENERATION_ENABLED` | Boolean | true | - | Toggle AI-generated conclusion remarks |
| Max Remark Characters | `AI_REMARK_MAX_CHARACTERS` | Number | 500 | 100-2000 | Maximum character limit for AI remarks |
**UI Component:** Toggle + Number input
**Category Color:** Pink 💗
---
## 4️⃣ **Notification Rules** (3 Settings)
Settings for notification channels and frequency.
| Setting | Key | Type | Default | Range | Description |
|---------|-----|------|---------|-------|-------------|
| Enable Email Notifications | `ENABLE_EMAIL_NOTIFICATIONS` | Boolean | true | - | Send email notifications for events |
| Enable Push Notifications | `ENABLE_PUSH_NOTIFICATIONS` | Boolean | true | - | Send browser push notifications |
| Notification Batch Delay | `NOTIFICATION_BATCH_DELAY_MS` | Number | 5000 | 1000-30000 | Delay (ms) before sending batched notifications |
**UI Component:** Toggle + Number input
**Category Color:** Amber 🟠
---
## 5️⃣ **Dashboard Layout** (4 Settings)
Settings to enable/disable KPI cards on dashboard per role.
| Setting | Key | Type | Default | Description |
|---------|-----|------|---------|-------------|
| Show Total Requests | `DASHBOARD_SHOW_TOTAL_REQUESTS` | Boolean | true | Display total requests KPI card |
| Show Open Requests | `DASHBOARD_SHOW_OPEN_REQUESTS` | Boolean | true | Display open requests KPI card |
| Show TAT Compliance | `DASHBOARD_SHOW_TAT_COMPLIANCE` | Boolean | true | Display TAT compliance KPI card |
| Show Pending Actions | `DASHBOARD_SHOW_PENDING_ACTIONS` | Boolean | true | Display pending actions KPI card |
**UI Component:** Toggle switches
**Category Color:** Teal 🟢
---
## 6️⃣ **Workflow Sharing Policy** (3 Settings)
Settings to control who can add spectators and share workflows.
| Setting | Key | Type | Default | Range | Description |
|---------|-----|------|---------|-------|-------------|
| Allow Add Spectator | `ALLOW_ADD_SPECTATOR` | Boolean | true | - | Enable users to add spectators |
| Max Spectators | `MAX_SPECTATORS_PER_REQUEST` | Number | 20 | 1-100 | Maximum spectators per workflow |
| Allow External Sharing | `ALLOW_EXTERNAL_SHARING` | Boolean | false | - | Allow sharing with external users |
**UI Component:** Toggle + Number input
**Category Color:** Emerald 💚
---
## 7️⃣ **Workflow Limits** (2 Settings)
System limits for workflow structure.
| Setting | Key | Type | Default | Range | Description |
|---------|-----|------|---------|-------|-------------|
| Max Approval Levels | `MAX_APPROVAL_LEVELS` | Number | 10 | 1-20 | Maximum approval levels per workflow |
| Max Participants | `MAX_PARTICIPANTS_PER_REQUEST` | Number | 50 | 2-200 | Maximum total participants per workflow |
**UI Component:** Number input
**Category Color:** Gray ⚪
---
## 📊 Total Settings Summary
| Category | Count | Editable | UI |
|----------|-------|----------|-----|
| TAT Settings | 6 | ✅ All | Number + Slider |
| Document Policy | 3 | ✅ All | Number + Text |
| AI Configuration | 2 | ✅ All | Toggle + Number |
| Notification Rules | 3 | ✅ All | Toggle + Number |
| Dashboard Layout | 4 | ✅ All | Toggle |
| Workflow Sharing | 3 | ✅ All | Toggle + Number |
| Workflow Limits | 2 | ✅ All | Number |
| **TOTAL** | **18** | **18/18** | **All Editable** |
---
## 🎯 SRS Document Compliance
### Required Config Areas (from SRS Section 7):
1. ✅ **TAT Settings** - Default TAT per priority, auto-reminder thresholds
2. ✅ **User Roles** - Covered via Workflow Limits (max participants, levels)
3. ✅ **Notification Rules** - Channels (email/push), frequency (batch delay)
4. ✅ **Document Policy** - Max upload size, allowed types, retention period
5. ✅ **Dashboard Layout** - Enable/disable KPI cards per role
6. ✅ **AI Configuration** - Toggle AI, set max characters
7. ✅ **Workflow Sharing Policy** - Control spectators, external sharing
**All 7 required areas are fully covered!** ✅
---
## 🔧 How to Edit Settings
### **Step 1: Access Settings** (Admin Only)
1. Login as Admin user
2. Navigate to **Settings** from sidebar
3. Click **"System Configuration"** tab
### **Step 2: Select Category**
Choose from 7 category tabs:
- TAT Settings
- Document Policy
- AI Configuration
- Notification Rules
- Dashboard Layout
- Workflow Sharing
- Workflow Limits
### **Step 3: Modify Values**
- **Number fields**: Enter numeric value within allowed range
- **Toggles**: Switch ON/OFF
- **Sliders**: Drag to set percentage
- **Text fields**: Enter comma-separated values
### **Step 4: Save Changes**
1. Click **"Save"** button for each modified setting
2. See success message confirmation
3. Some settings may show **"Requires Restart"** badge
### **Step 5: Reset if Needed**
- Click **"Reset to Default"** to revert any setting
- Confirmation dialog appears before reset
---
## 🚀 Initial Setup
### **First Time Setup:**
1. **Start backend** - Configurations auto-seed on first run:
```bash
cd Re_Backend
npm run dev
```
2. **Check logs** - Should see:
```
⚙️ System configurations initialized
✅ Default configurations seeded (18 settings across 7 categories)
```
3. **Login as Admin** and verify settings are editable
---
## 🗄️ Database Storage
**Table:** `admin_configurations`
**Key Columns:**
- `config_key` - Unique identifier
- `config_category` - Grouping (TAT_SETTINGS, DOCUMENT_POLICY, etc.)
- `config_value` - Current value
- `default_value` - Reset value
- `is_editable` - Whether admin can edit (all are `true`)
- `ui_component` - UI type (toggle, number, slider, text)
- `validation_rules` - JSON with min/max constraints
- `sort_order` - Display order within category
---
## 🔄 How Settings Are Applied
### **Backend:**
```typescript
import { SYSTEM_CONFIG } from '@config/system.config';
const workStartHour = SYSTEM_CONFIG.WORKING_HOURS.START_HOUR;
// Value is loaded from admin_configurations table
```
### **Frontend:**
```typescript
import { configService } from '@/services/configService';
const config = await configService.getConfig();
const maxFileSize = config.upload.maxFileSizeMB;
// Fetched from backend API: GET /api/v1/config
```
---
## ✅ Benefits
✅ **No hardcoded values** - Everything configurable
✅ **Admin-friendly UI** - No technical knowledge needed
✅ **Validation built-in** - Prevents invalid values
✅ **Audit trail** - All changes logged with timestamps
✅ **Reset capability** - Can revert to defaults anytime
✅ **Real-time effect** - Most changes apply immediately
✅ **SRS compliant** - All 7 required areas covered
---
## 📝 Notes
- **User Role Management** is handled separately via user administration (not in this config)
- **Holiday Calendar** has its own dedicated management interface
- All settings have **validation rules** to prevent invalid configurations
- Settings marked **"Requires Restart"** need backend restart to take effect
- Non-admin users cannot see or edit system configurations
---
## 🎯 Result
Your system now has **complete admin configurability** as specified in the SRS document with:
📌 **18 editable settings**
📌 **7 configuration categories**
📌 **100% SRS compliance**
📌 **Admin-friendly UI**
📌 **Database-driven** (not hardcoded)

276
AUTO_MIGRATION_SETUP_COMPLETE.md Normal file
View File

@ -0,0 +1,276 @@
# ✅ Auto-Migration Setup Complete
## 🎯 What Was Done
### 1. Converted SQL Migration to TypeScript
**Before**: `src/migrations/add_is_skipped_to_approval_levels.sql` (manual SQL)
**After**: `src/migrations/20251105-add-skip-fields-to-approval-levels.ts` (TypeScript)
**Features Added to `approval_levels` table**:
- ✅ `is_skipped` - Boolean flag to track skipped approvers
- ✅ `skipped_at` - Timestamp when approver was skipped
- ✅ `skipped_by` - Foreign key to user who skipped
- ✅ `skip_reason` - Text field for skip justification
- ✅ Partial index on `is_skipped = TRUE` for query performance
- ✅ Full rollback support in `down()` function
### 2. Updated Migration Runner
**File**: `src/scripts/migrate.ts`
**Changes**:
- Added import for new migration (m14)
- Added execution in run() function
- Enhanced console output with emojis for better visibility
- Better error messages
### 3. Auto-Run Migrations on Development Start
**File**: `package.json`
**Before**:
```json
"dev": "nodemon --exec ts-node -r tsconfig-paths/register src/server.ts"
```
**After**:
```json
"dev": "npm run migrate && nodemon --exec ts-node -r tsconfig-paths/register src/server.ts"
```
**What This Means**:
- 🔄 Migrations run automatically before server starts
- ✅ No more manual migration steps
- 🛡️ Server won't start if migrations fail
- ⚡ Fresh database schema on every dev restart
### 4. Created Documentation
- 📘 `MIGRATION_WORKFLOW.md` - Complete migration guide
- 📗 `MIGRATION_QUICK_REFERENCE.md` - Quick reference card
- 📕 `AUTO_MIGRATION_SETUP_COMPLETE.md` - This file
## 🚀 How to Use
### Starting Development (Most Common)
```bash
npm run dev
```
This will:
1. Connect to database
2. Run all 14 migrations sequentially
3. Start development server with hot reload
4. Display success messages
**Expected Output**:
```
📦 Database connected
🔄 Running migrations...
✅ Created workflow_requests table
✅ Created approval_levels table
...
✅ Added skip-related fields to approval_levels table
✅ All migrations applied successfully
🚀 Server running on port 5000
```
### Running Migrations Only
```bash
npm run migrate
```
Use when you want to update database without starting server.
## 📊 Migration Status
| # | Migration | Status | Date |
|---|-----------|--------|------|
| 1 | create-workflow-requests | ✅ Active | 2025-10-30 |
| 2 | create-approval-levels | ✅ Active | 2025-10-30 |
| 3 | create-participants | ✅ Active | 2025-10-30 |
| 4 | create-documents | ✅ Active | 2025-10-30 |
| 5 | create-subscriptions | ✅ Active | 2025-10-31 |
| 6 | create-activities | ✅ Active | 2025-10-31 |
| 7 | create-work-notes | ✅ Active | 2025-10-31 |
| 8 | create-work-note-attachments | ✅ Active | 2025-10-31 |
| 9 | add-tat-alert-fields | ✅ Active | 2025-11-04 |
| 10 | create-tat-alerts | ✅ Active | 2025-11-04 |
| 11 | create-kpi-views | ✅ Active | 2025-11-04 |
| 12 | create-holidays | ✅ Active | 2025-11-04 |
| 13 | create-admin-config | ✅ Active | 2025-11-04 |
| 14 | add-skip-fields-to-approval-levels | ✅ **NEW** | 2025-11-05 |
## 🔄 Adding Future Migrations
When you need to add a new migration:
### Step 1: Create File
```bash
# Create file: src/migrations/20251106-your-description.ts
```
### Step 2: Write Migration
```typescript
import { QueryInterface, DataTypes } from 'sequelize';
export async function up(queryInterface: QueryInterface): Promise<void> {
// Your changes here
await queryInterface.addColumn('table', 'column', {
type: DataTypes.STRING
});
console.log('✅ Your migration completed');
}
export async function down(queryInterface: QueryInterface): Promise<void> {
// Rollback here
await queryInterface.removeColumn('table', 'column');
console.log('✅ Rollback completed');
}
```
### Step 3: Register in migrate.ts
```typescript
// Add at top
import * as m15 from '../migrations/20251106-your-description';
// Add in run() function after m14
await (m15 as any).up(sequelize.getQueryInterface());
```
### Step 4: Test
```bash
npm run migrate
# or
npm run dev
```
## 🎯 Benefits
### For Development
- ✅ **No manual steps** - migrations run automatically
- ✅ **Consistent state** - everyone on team has same schema
- ✅ **Error prevention** - server won't start with schema mismatch
- ✅ **Fast iteration** - add migration, restart, test
### For Production
- ✅ **Idempotent** - safe to run multiple times
- ✅ **Versioned** - migrations tracked in git
- ✅ **Rollback support** - down() functions for reverting
- ✅ **Error handling** - clear failure messages
### For Team
- ✅ **TypeScript** - type-safe migrations
- ✅ **Documentation** - comprehensive guides
- ✅ **Best practices** - professional .NET team standards
- ✅ **Clear workflow** - easy to onboard new developers
## 🛡️ Safety Features
### Migration Execution
- Stops on first error
- Exits with error code 1 on failure
- Prevents server startup if migrations fail
- Detailed error logging
### Idempotency
All migrations should be idempotent (safe to run multiple times):
```typescript
// Check before adding
const tableDesc = await queryInterface.describeTable('table');
if (!tableDesc.column) {
await queryInterface.addColumn(/* ... */);
}
```
### Transactions
For complex migrations, wrap in transaction:
```typescript
const transaction = await queryInterface.sequelize.transaction();
try {
await queryInterface.addColumn(/* ... */, { transaction });
await queryInterface.addIndex(/* ... */, { transaction });
await transaction.commit();
} catch (error) {
await transaction.rollback();
throw error;
}
```
## 📝 Database Structure Reference
Always refer to **`backend_structure.txt`** for:
- Current table schemas
- Column types and constraints
- Foreign key relationships
- Enum values
- Index definitions
## 🧪 Testing the Setup
### Test Migration System
```bash
# Run migrations
npm run migrate
# Should see:
# 📦 Database connected
# 🔄 Running migrations...
# ✅ [migration messages]
# ✅ All migrations applied successfully
```
### Test Auto-Run on Dev
```bash
# Start development
npm run dev
# Should see migrations run, then:
# 🚀 Server running on port 5000
# 📊 Environment: development
# ...
```
### Test New Migration
1. Create test migration file
2. Register in migrate.ts
3. Run `npm run dev`
4. Verify migration executed
5. Check database schema
## 🎓 Pro Tips
1. **Always test locally first** - never test migrations in production
2. **Backup before migrating** - especially in production
3. **Keep migrations atomic** - one logical change per file
4. **Write descriptive names** - make purpose clear
5. **Add comments** - explain why, not just what
6. **Test rollbacks** - verify down() functions work
7. **Update documentation** - keep backend_structure.txt current
8. **Review before committing** - migrations are permanent
## 📞 Support
- 📘 Full Guide: `MIGRATION_WORKFLOW.md`
- 📗 Quick Reference: `MIGRATION_QUICK_REFERENCE.md`
- 📊 Database Structure: `backend_structure.txt`
## ✨ Summary
Your development workflow is now streamlined:
```bash
# That's it! This one command does everything:
npm run dev
# 1. Runs all migrations ✅
# 2. Starts development server ✅
# 3. Enables hot reload ✅
# 4. You focus on coding ✅
```
---
**Setup Date**: November 5, 2025
**Total Migrations**: 14
**Auto-Run**: ✅ Enabled
**Status**: 🟢 Production Ready
**Team**: Royal Enfield .NET Expert Team

363
CONFIGURATION.md Normal file
View File

@ -0,0 +1,363 @@
# Royal Enfield Workflow Management System - Configuration Guide
## 📋 Overview
All system configurations are centralized in `src/config/system.config.ts` and can be customized via environment variables.
## ⚙️ Configuration Structure
### 1. **Working Hours**
Controls when TAT tracking is active.
```env
WORK_START_HOUR=9 # 9 AM (default)
WORK_END_HOUR=18 # 6 PM (default)
TZ=Asia/Kolkata # Timezone
```
**Working Days:** Monday - Friday (hardcoded)
---
### 2. **TAT (Turnaround Time) Settings**
```env
TAT_TEST_MODE=false # Enable for testing (1 hour = 1 minute)
DEFAULT_EXPRESS_TAT=24 # Express priority default TAT (hours)
DEFAULT_STANDARD_TAT=72 # Standard priority default TAT (hours)
```
**TAT Thresholds** (hardcoded):
- 50% - Warning notification
- 75% - Critical notification
- 100% - Breach notification
---
### 3. **File Upload Limits**
```env
MAX_FILE_SIZE_MB=10 # Max file size per upload
MAX_FILES_PER_REQUEST=10 # Max files per request
ALLOWED_FILE_TYPES=pdf,doc,docx,xls,xlsx,ppt,pptx,jpg,jpeg,png,gif,txt
```
---
### 4. **Workflow Limits**
```env
MAX_APPROVAL_LEVELS=10 # Max approval stages
MAX_PARTICIPANTS_PER_REQUEST=50 # Max total participants
MAX_SPECTATORS=20 # Max spectators
```
---
### 5. **Work Notes Configuration**
```env
MAX_MESSAGE_LENGTH=2000 # Max characters per message
MAX_ATTACHMENTS_PER_NOTE=5 # Max files per work note
ENABLE_REACTIONS=true # Allow emoji reactions
ENABLE_MENTIONS=true # Allow @mentions
```
---
### 6. **Redis & Queue**
```env
REDIS_URL=redis://localhost:6379 # Redis connection string
QUEUE_CONCURRENCY=5 # Concurrent job processing
RATE_LIMIT_MAX=10 # Max requests per duration
RATE_LIMIT_DURATION=1000 # Rate limit window (ms)
```
---
### 7. **Security & Session**
```env
JWT_SECRET=your_secret_min_32_characters # JWT signing key
JWT_EXPIRY=8h # Token expiration
SESSION_TIMEOUT_MINUTES=480 # 8 hours
ENABLE_2FA=false # Two-factor authentication
```
---
### 8. **Notifications**
```env
ENABLE_EMAIL_NOTIFICATIONS=true # Email alerts
ENABLE_PUSH_NOTIFICATIONS=true # Browser push
NOTIFICATION_BATCH_DELAY=5000 # Batch delay (ms)
```
**Email SMTP** (if email enabled):
```env
SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
SMTP_USER=your_email@royalenfield.com
SMTP_PASSWORD=your_password
SMTP_FROM=noreply@royalenfield.com
```
---
### 9. **Feature Flags**
```env
ENABLE_AI_CONCLUSION=true # AI-generated conclusion remarks
ENABLE_TEMPLATES=false # Template-based workflows (future)
ENABLE_ANALYTICS=true # Dashboard analytics
ENABLE_EXPORT=true # Export to CSV/PDF
```
---
### 10. **Database**
```env
DB_HOST=localhost
DB_PORT=5432
DB_NAME=re_workflow
DB_USER=postgres
DB_PASSWORD=your_password
DB_SSL=false
```
---
### 11. **Storage**
```env
STORAGE_TYPE=local # Options: local, s3, gcs
STORAGE_PATH=./uploads # Local storage path
```
**For S3 (if using cloud storage):**
```env
AWS_ACCESS_KEY_ID=your_access_key
AWS_SECRET_ACCESS_KEY=your_secret
AWS_REGION=ap-south-1
AWS_S3_BUCKET=re-workflow-documents
```
---
## 🚀 Quick Setup
### Development Environment
1. Copy example configuration:
```bash
cp .env.example .env
```
2. Update critical values:
```env
DB_PASSWORD=your_local_postgres_password
JWT_SECRET=generate_random_32_char_string
REDIS_URL=redis://localhost:6379
```
3. Enable test mode for faster TAT testing:
```env
TAT_TEST_MODE=true # 1 hour = 1 minute
```
---
### Production Environment
1. Set environment to production:
```env
NODE_ENV=production
```
2. Configure secure secrets:
```env
JWT_SECRET=use_very_strong_secret_here
DB_PASSWORD=strong_database_password
```
3. Disable test mode:
```env
TAT_TEST_MODE=false
```
4. Enable SSL:
```env
DB_SSL=true
```
5. Configure email/push notifications with real credentials
---
## 📊 Configuration API
### GET `/api/v1/config`
Returns public (non-sensitive) configuration for frontend.
**Response:**
```json
{
"success": true,
"data": {
"appName": "Royal Enfield Workflow Management",
"appVersion": "1.2.0",
"workingHours": {
"START_HOUR": 9,
"END_HOUR": 18,
"START_DAY": 1,
"END_DAY": 5,
"TIMEZONE": "Asia/Kolkata"
},
"tat": {
"thresholds": {
"warning": 50,
"critical": 75,
"breach": 100
},
"testMode": false
},
"upload": {
"maxFileSizeMB": 10,
"allowedFileTypes": ["pdf", "doc", "docx", ...],
"maxFilesPerRequest": 10
},
"workflow": {
"maxApprovalLevels": 10,
"maxParticipants": 50,
"maxSpectators": 20
},
"workNotes": {
"maxMessageLength": 2000,
"maxAttachmentsPerNote": 5,
"enableReactions": true,
"enableMentions": true
},
"features": {
"ENABLE_AI_CONCLUSION": true,
"ENABLE_TEMPLATES": false,
"ENABLE_ANALYTICS": true,
"ENABLE_EXPORT": true
},
"ui": {
"DEFAULT_THEME": "light",
"DEFAULT_LANGUAGE": "en",
"DATE_FORMAT": "DD/MM/YYYY",
"TIME_FORMAT": "12h",
"CURRENCY": "INR",
"CURRENCY_SYMBOL": "₹"
}
}
}
```
---
## 🎯 Usage in Code
### Backend
```typescript
import { SYSTEM_CONFIG } from '@config/system.config';
// Access configuration
const maxLevels = SYSTEM_CONFIG.WORKFLOW.MAX_APPROVAL_LEVELS;
const workStart = SYSTEM_CONFIG.WORKING_HOURS.START_HOUR;
```
### Frontend
```typescript
import { configService } from '@/services/configService';
// Async usage
const config = await configService.getConfig();
const maxFileSize = config.upload.maxFileSizeMB;
// Helper functions
import { getWorkingHours, getTATThresholds } from '@/services/configService';
const workingHours = await getWorkingHours();
```
---
## 🔐 Security Best Practices
1. **Never commit `.env`** with real credentials
2. **Use strong JWT secrets** (min 32 characters)
3. **Rotate secrets regularly** in production
4. **Use environment-specific configs** for dev/staging/prod
5. **Store secrets in secure vaults** (AWS Secrets Manager, Azure Key Vault)
---
## 📝 Configuration Checklist
### Before Deployment
- [ ] Set `NODE_ENV=production`
- [ ] Configure database with SSL
- [ ] Set strong JWT secret
- [ ] Disable TAT test mode
- [ ] Configure email SMTP
- [ ] Set up Redis connection
- [ ] Configure file storage (local/S3/GCS)
- [ ] Test working hours match business hours
- [ ] Verify TAT thresholds are correct
- [ ] Enable/disable feature flags as needed
---
## 🛠️ Adding New Configuration
1. Add to `system.config.ts`:
```typescript
export const SYSTEM_CONFIG = {
// ...existing config
MY_NEW_SETTING: {
VALUE: process.env.MY_VALUE || 'default',
},
};
```
2. Add to `getPublicConfig()` if needed on frontend:
```typescript
export function getPublicConfig() {
return {
// ...existing
myNewSetting: SYSTEM_CONFIG.MY_NEW_SETTING,
};
}
```
3. Access in code:
```typescript
const value = SYSTEM_CONFIG.MY_NEW_SETTING.VALUE;
```
---
## 📚 Related Files
- `src/config/system.config.ts` - Central configuration
- `src/config/tat.config.ts` - TAT-specific (re-exports from system.config)
- `src/config/constants.ts` - Legacy constants (being migrated)
- `src/routes/config.routes.ts` - Configuration API endpoint
- Frontend: `src/services/configService.ts` - Configuration fetching service
---
## ✅ Benefits of Centralized Configuration
✅ **Single Source of Truth** - All settings in one place
✅ **Environment-based** - Different configs for dev/staging/prod
✅ **Frontend Sync** - Frontend fetches config from backend
✅ **No Hardcoding** - All values configurable via .env
✅ **Type-Safe** - TypeScript interfaces ensure correctness
✅ **Easy Updates** - Change .env without code changes

341
DYNAMIC_TAT_THRESHOLDS.md Normal file
View File

@ -0,0 +1,341 @@
# Dynamic TAT Thresholds Implementation
## Problem Statement
### Original Issue
The TAT system had **hardcoded threshold percentages** (50%, 75%, 100%) which created several problems:
1. **Job Naming Conflict**: Jobs were named using threshold percentages (`tat50-{reqId}-{levelId}`)
2. **Configuration Changes Didn't Apply**: Changing threshold in settings didn't affect scheduled jobs
3. **Message Mismatch**: Messages always said "50% elapsed" even if admin configured 55%
4. **Cancellation Issues**: Uncertainty about whether jobs could be properly cancelled after config changes
### Critical Edge Case Identified by User
**Scenario:**
```
1. Request created → TAT jobs scheduled:
- tat50-REQ123-LEVEL456 (fires at 8 hours, says "50% elapsed")
- tat75-REQ123-LEVEL456 (fires at 12 hours)
- tatBreach-REQ123-LEVEL456 (fires at 16 hours)
2. Admin changes threshold from 50% → 55%
3. User approves at 9 hours (after old 50% fired)
→ Job already fired with "50% elapsed" message ❌
→ But admin configured 55% ❌
→ Inconsistent!
4. Even if approval happens before old 50%:
→ System cancels `tat50-REQ123-LEVEL456` ✅
→ But message would still say "50%" (hardcoded) ❌
```
---
## Solution: Generic Job Names + Dynamic Thresholds
### 1. **Generic Job Naming**
Changed from percentage-based to generic names:
**Before:**
```typescript
tat50-{requestId}-{levelId}
tat75-{requestId}-{levelId}
tatBreach-{requestId}-{levelId}
```
**After:**
```typescript
tat-threshold1-{requestId}-{levelId} // First threshold (configurable: 50%, 55%, 60%, etc.)
tat-threshold2-{requestId}-{levelId} // Second threshold (configurable: 75%, 80%, etc.)
tat-breach-{requestId}-{levelId} // Always 100% (deadline)
```
### 2. **Store Threshold in Job Data**
Instead of relying on job name, we store the actual percentage in job payload:
```typescript
interface TatJobData {
type: 'threshold1' | 'threshold2' | 'breach';
threshold: number; // Actual % (e.g., 55, 80, 100)
requestId: string;
levelId: string;
approverId: string;
}
```
### 3. **Dynamic Message Generation**
Messages use the threshold from job data:
```typescript
case 'threshold1':
message = `⏳ ${threshold}% of TAT elapsed for Request ${requestNumber}`;
// If threshold = 55, message says "55% of TAT elapsed" ✅
```
### 4. **Configuration Cache Management**
- Configurations are cached for 5 minutes (performance)
- Cache is **automatically cleared** when admin updates settings
- Next scheduled job will use new thresholds
---
## How It Solves the Edge Cases
### ✅ **Case 1: Config Changed After Job Creation**
**Scenario:**
```
1. Request created with TAT = 16 hours (thresholds: 50%, 75%)
Jobs scheduled:
- tat-threshold1-REQ123 → fires at 8h, threshold=50
- tat-threshold2-REQ123 → fires at 12h, threshold=75
2. Admin changes threshold from 50% → 55%
3. Old request jobs STILL fire at 8h (50%)
✅ BUT message correctly shows "50% elapsed" (from job data)
✅ No confusion because that request WAS scheduled at 50%
4. NEW requests created after config change:
Jobs scheduled:
- tat-threshold1-REQ456 → fires at 8.8h, threshold=55 ✅
- tat-threshold2-REQ456 → fires at 12h, threshold=75
5. Message says "55% of TAT elapsed" ✅ CORRECT!
```
**Result:**
- ✅ Existing jobs maintain their original thresholds (consistent)
- ✅ New jobs use updated thresholds (respects config changes)
- ✅ Messages always match actual threshold used
---
### ✅ **Case 2: User Approves Before Threshold**
**Scenario:**
```
1. Job scheduled: tat-threshold1-REQ123 (fires at 55%)
2. User approves at 40% elapsed
3. cancelTatJobs('REQ123', 'LEVEL456') is called:
→ Looks for: tat-threshold1-REQ123-LEVEL456 ✅ FOUND
→ Removes job ✅ SUCCESS
4. No notification sent ✅ CORRECT!
```
**Result:**
- ✅ Generic names allow consistent cancellation
- ✅ Works regardless of threshold percentage
- ✅ No ambiguity in job identification
---
### ✅ **Case 3: User Approves After Threshold Fired**
**Scenario:**
```
1. Job scheduled: tat-threshold1-REQ123 (fires at 55%)
2. Job fires at 55% → notification sent
3. User approves at 60%
4. cancelTatJobs called:
→ Tries to cancel tat-threshold1-REQ123
→ Job already processed and removed (removeOnComplete: true)
→ No error (gracefully handled) ✅
5. Later jobs (threshold2, breach) are still cancelled ✅
```
**Result:**
- ✅ Already-fired jobs don't cause errors
- ✅ Remaining jobs are still cancelled
- ✅ System behaves correctly in all scenarios
---
## Configuration Flow
### **Admin Updates Threshold**
```
1. Admin changes "First TAT Threshold" from 50% → 55%
↓
2. Frontend sends: PUT /api/v1/admin/configurations/TAT_REMINDER_THRESHOLD_1
Body: { configValue: '55' }
↓
3. Backend updates database:
UPDATE admin_configurations
SET config_value = '55'
WHERE config_key = 'TAT_REMINDER_THRESHOLD_1'
↓
4. Backend clears config cache:
clearConfigCache() ✅
↓
5. Next request created:
- getTatThresholds() → reads '55' from DB
- Schedules job at 55% (8.8 hours for 16h TAT)
- Job data: { threshold: 55 }
↓
6. Job fires at 55%:
- Message: "55% of TAT elapsed" ✅ CORRECT!
```
---
## Database Impact
### **No Database Changes Required!**
The `admin_configurations` table already has all required fields:
- ✅ `TAT_REMINDER_THRESHOLD_1` → First threshold (50% default)
- ✅ `TAT_REMINDER_THRESHOLD_2` → Second threshold (75% default)
### **Job Queue Data Structure**
**Old Job Data:**
```json
{
"type": "tat50",
"requestId": "...",
"levelId": "...",
"approverId": "..."
}
```
**New Job Data:**
```json
{
"type": "threshold1",
"threshold": 55,
"requestId": "...",
"levelId": "...",
"approverId": "..."
}
```
---
## Testing Scenarios
### **Test 1: Change Threshold, Create New Request**
```bash
# 1. Change threshold from 50% to 55%
curl -X PUT http://localhost:5000/api/v1/admin/configurations/TAT_REMINDER_THRESHOLD_1 \
-H "Authorization: Bearer TOKEN" \
-H "Content-Type: application/json" \
-d '{"configValue": "55"}'
# 2. Create new workflow request
# → Jobs scheduled at 55%, 75%, 100%
# 3. Wait for 55% elapsed
# → Notification says "55% of TAT elapsed" ✅
```
### **Test 2: Approve Before Threshold**
```bash
# 1. Request created (TAT = 16 hours)
# → threshold1 scheduled at 8.8 hours (55%)
# 2. Approve at 6 hours (before 55%)
curl -X POST http://localhost:5000/api/v1/workflows/REQ123/approve/LEVEL456
# 3. cancelTatJobs is called internally
# → tat-threshold1-REQ123-LEVEL456 removed ✅
# → tat-threshold2-REQ123-LEVEL456 removed ✅
# → tat-breach-REQ123-LEVEL456 removed ✅
# 4. No notifications sent ✅
```
### **Test 3: Mixed Old and New Jobs**
```bash
# 1. Create Request A with old threshold (50%)
# → Jobs use threshold=50
# 2. Admin changes to 55%
# 3. Create Request B with new threshold (55%)
# → Jobs use threshold=55
# 4. Both requests work correctly:
# → Request A fires at 50%, message says "50%" ✅
# → Request B fires at 55%, message says "55%" ✅
```
---
## Summary
### **What Changed:**
1. ✅ Job names: `tat50` → `tat-threshold1` (generic)
2. ✅ Job data: Now includes actual threshold percentage
3. ✅ Messages: Dynamic based on threshold from job data
4. ✅ Scheduling: Reads thresholds from database configuration
5. ✅ Cache: Automatically cleared on config update
### **What Didn't Change:**
1. ✅ Database schema (admin_configurations already has all needed fields)
2. ✅ API endpoints (no breaking changes)
3. ✅ Frontend UI (works exactly the same)
4. ✅ Cancellation logic (still works, just uses new names)
### **Benefits:**
1. ✅ **No Job Name Conflicts**: Generic names work for any percentage
2. ✅ **Accurate Messages**: Always show actual threshold used
3. ✅ **Config Flexibility**: Admin can change thresholds anytime
4. ✅ **Backward Compatible**: Existing jobs complete normally
5. ✅ **Reliable Cancellation**: Works regardless of threshold value
6. ✅ **Immediate Effect**: New requests use updated thresholds immediately
---
## Files Modified
1. `Re_Backend/src/services/configReader.service.ts` - **NEW** (configuration reader)
2. `Re_Backend/src/services/tatScheduler.service.ts` - Updated job scheduling
3. `Re_Backend/src/queues/tatProcessor.ts` - Updated job processing
4. `Re_Backend/src/controllers/admin.controller.ts` - Added cache clearing
---
## Configuration Keys
| Key | Description | Default | Example |
|-----|-------------|---------|---------|
| `TAT_REMINDER_THRESHOLD_1` | First warning threshold | 50 | 55 (sends alert at 55%) |
| `TAT_REMINDER_THRESHOLD_2` | Critical warning threshold | 75 | 80 (sends alert at 80%) |
| Breach | Deadline reached (always 100%) | 100 | 100 (non-configurable) |
---
## Example Timeline
**TAT = 16 hours, Thresholds: 55%, 80%**
```
Hour 0 ─────────────────────────────────────► Hour 16
│ │ │
START 55% (8.8h) 80% (12.8h) 100%
│ │ │
threshold1 threshold2 breach
"55% elapsed" "80% elapsed" "BREACHED"
⏳ ⚠️ ⏰
```
**Result:**
- ✅ Job names don't hardcode percentages
- ✅ Messages show actual configured thresholds
- ✅ Cancellation works consistently
- ✅ No edge cases or race conditions

562
DYNAMIC_WORKING_HOURS.md Normal file
View File

@ -0,0 +1,562 @@
# Dynamic Working Hours Configuration
## Overview
Working hours for TAT (Turn Around Time) calculations are now **dynamically configurable** through the admin settings interface. Admins can change these settings at any time, and the changes will be reflected in all future TAT calculations.
---
## What's Configurable
### **Working Hours Settings:**
| Setting | Description | Default | Example |
|---------|-------------|---------|---------|
| `WORK_START_HOUR` | Working day starts at (hour) | 9 | 8 (8:00 AM) |
| `WORK_END_HOUR` | Working day ends at (hour) | 18 | 19 (7:00 PM) |
| `WORK_START_DAY` | First working day of week | 1 (Monday) | 1 (Monday) |
| `WORK_END_DAY` | Last working day of week | 5 (Friday) | 6 (Saturday) |
**Days:** 0 = Sunday, 1 = Monday, 2 = Tuesday, ..., 6 = Saturday
---
## How It Works
### **1. Admin Changes Working Hours**
```
Settings → System Configuration → Working Hours
- Work Start Hour: 9:00 → Change to 8:00
- Work End Hour: 18:00 → Change to 20:00
✅ Save
```
### **2. Backend Updates Database**
```sql
UPDATE admin_configurations
SET config_value = '8'
WHERE config_key = 'WORK_START_HOUR';
UPDATE admin_configurations
SET config_value = '20'
WHERE config_key = 'WORK_END_HOUR';
```
### **3. Cache is Cleared Automatically**
```typescript
// In admin.controller.ts
clearConfigCache(); // Clear general config cache
clearWorkingHoursCache(); // Clear TAT working hours cache
```
### **4. Next TAT Calculation Uses New Values**
```typescript
// TAT calculation loads fresh values
await loadWorkingHoursCache();
// → Reads: startHour=8, endHour=20 from database
// Applies new working hours
if (hour >= 8 && hour < 20) {
// This hour counts as working time ✅
}
```
---
## Cache Management
### **Working Hours Cache:**
**Cache Duration:** 5 minutes (shorter than holidays since it's more critical)
**Why Cache?**
- Performance: Avoids repeated database queries
- Speed: TAT calculations can happen hundreds of times per hour
- Efficiency: Reading from memory is ~1000x faster than DB query
**Cache Lifecycle:**
```
1. First TAT Calculation:
→ loadWorkingHoursCache() called
→ Database query: SELECT config_value WHERE config_key IN (...)
→ Store in memory: workingHoursCache = { startHour: 9, endHour: 18, ... }
→ Set expiry: now + 5 minutes
2. Next 5 Minutes (Cache Valid):
→ All TAT calculations use cached values
→ No database queries ✅ FAST
3. After 5 Minutes (Cache Expired):
→ Next TAT calculation reloads from database
→ New cache created with 5-minute expiry
4. Admin Updates Config:
→ clearWorkingHoursCache() called immediately
→ Cache invalidated
→ Next calculation loads fresh values ✅
```
---
## Example Scenarios
### **Scenario 1: Extend Working Hours**
**Before:**
```
Working Hours: 9:00 AM - 6:00 PM (9 hours/day)
```
**Admin Changes To:**
```
Working Hours: 8:00 AM - 8:00 PM (12 hours/day)
```
**Impact on TAT:**
```
Request: STANDARD Priority, 24 working hours
Created: Monday 9:00 AM
OLD Calculation (9 hours/day):
Monday 9 AM - 6 PM = 9 hours (15h remaining)
Tuesday 9 AM - 6 PM = 9 hours (6h remaining)
Wednesday 9 AM - 3 PM = 6 hours (0h remaining)
Deadline: Wednesday 3:00 PM
NEW Calculation (12 hours/day):
Monday 9 AM - 8 PM = 11 hours (13h remaining)
Tuesday 8 AM - 8 PM = 12 hours (1h remaining)
Wednesday 8 AM - 9 AM = 1 hour (0h remaining)
Deadline: Wednesday 9:00 AM ✅ FASTER!
```
---
### **Scenario 2: Include Saturday as Working Day**
**Before:**
```
Working Days: Monday - Friday (1-5)
```
**Admin Changes To:**
```
Working Days: Monday - Saturday (1-6)
```
**Impact on TAT:**
```
Request: STANDARD Priority, 16 working hours
Created: Friday 2:00 PM
OLD Calculation (Mon-Fri only):
Friday 2 PM - 6 PM = 4 hours (12h remaining)
Saturday-Sunday = SKIPPED
Monday 9 AM - 6 PM = 9 hours (3h remaining)
Tuesday 9 AM - 12 PM = 3 hours (0h remaining)
Deadline: Tuesday 12:00 PM
NEW Calculation (Mon-Sat):
Friday 2 PM - 6 PM = 4 hours (12h remaining)
Saturday 9 AM - 6 PM = 9 hours (3h remaining) ✅ Saturday counts!
Sunday = SKIPPED
Monday 9 AM - 12 PM = 3 hours (0h remaining)
Deadline: Monday 12:00 PM ✅ EARLIER!
```
---
### **Scenario 3: Reduce Working Hours (After-Hours Emergency)**
**Before:**
```
Working Hours: 9:00 AM - 6:00 PM
```
**Admin Changes To:**
```
Working Hours: 9:00 AM - 10:00 PM (extended for emergency)
```
**Impact:**
```
Request created at 7:00 PM (after old hours but within new hours)
OLD System:
7:00 PM → Not working time
First working hour: Tomorrow 9:00 AM
TAT starts counting from tomorrow ❌
NEW System:
7:00 PM → Still working time! ✅
TAT starts counting immediately
Faster response for urgent requests ✅
```
---
## Implementation Details
### **Configuration Reader Service**
```typescript
// Re_Backend/src/services/configReader.service.ts
export async function getWorkingHours(): Promise<{ startHour: number; endHour: number }> {
const startHour = await getConfigNumber('WORK_START_HOUR', 9);
const endHour = await getConfigNumber('WORK_END_HOUR', 18);
return { startHour, endHour };
}
```
### **TAT Time Utils (Working Hours Cache)**
```typescript
// Re_Backend/src/utils/tatTimeUtils.ts
let workingHoursCache: WorkingHoursConfig | null = null;
let workingHoursCacheExpiry: Date | null = null;
async function loadWorkingHoursCache(): Promise<void> {
// Check if cache is still valid
if (workingHoursCacheExpiry && new Date() < workingHoursCacheExpiry) {
return; // Use cached values
}
// Load from database
const { getWorkingHours, getConfigNumber } = await import('../services/configReader.service');
const hours = await getWorkingHours();
const startDay = await getConfigNumber('WORK_START_DAY', 1);
const endDay = await getConfigNumber('WORK_END_DAY', 5);
// Store in cache
workingHoursCache = {
startHour: hours.startHour,
endHour: hours.endHour,
startDay: startDay,
endDay: endDay
};
// Set 5-minute expiry
workingHoursCacheExpiry = dayjs().add(5, 'minute').toDate();
console.log(`[TAT Utils] Loaded working hours: ${hours.startHour}:00-${hours.endHour}:00`);
}
function isWorkingTime(date: Dayjs): boolean {
// Use cached working hours (with fallback to defaults)
const config = workingHoursCache || {
startHour: 9,
endHour: 18,
startDay: 1,
endDay: 5
};
const day = date.day();
const hour = date.hour();
// Check based on configured values
if (day < config.startDay || day > config.endDay) return false;
if (hour < config.startHour || hour >= config.endHour) return false;
if (isHoliday(date)) return false;
return true;
}
```
### **Admin Controller (Cache Invalidation)**
```typescript
// Re_Backend/src/controllers/admin.controller.ts
export const updateConfiguration = async (req: Request, res: Response): Promise<void> => {
// ... update database ...
// Clear config cache
clearConfigCache();
// If working hours config was updated, also clear TAT cache
const workingHoursKeys = ['WORK_START_HOUR', 'WORK_END_HOUR', 'WORK_START_DAY', 'WORK_END_DAY'];
if (workingHoursKeys.includes(configKey)) {
clearWorkingHoursCache(); // ✅ Immediate cache clear
logger.info(`Working hours config '${configKey}' updated - cache cleared`);
}
res.json({ success: true });
};
```
---
## Priority Behavior
### **STANDARD Priority**
✅ **Uses configured working hours**
- Respects `WORK_START_HOUR` and `WORK_END_HOUR`
- Respects `WORK_START_DAY` and `WORK_END_DAY`
- Excludes holidays
**Example:**
```
Config: 9:00 AM - 6:00 PM, Monday-Friday
TAT: 16 working hours
→ Only hours between 9 AM - 6 PM on Mon-Fri count
→ Weekends and holidays are skipped
```
### **EXPRESS Priority**
❌ **Ignores working hours configuration**
- Counts ALL 24 hours per day
- Counts ALL 7 days per week
- Counts holidays
**Example:**
```
Config: 9:00 AM - 6:00 PM (ignored)
TAT: 16 hours
→ Simply add 16 hours to start time
→ No exclusions
```
---
## Testing Scenarios
### **Test 1: Change Working Hours, Create Request**
```bash
# 1. Check current working hours
curl http://localhost:5000/api/v1/admin/configurations \
| grep WORK_START_HOUR
# → Returns: "configValue": "9"
# 2. Update working hours to start at 8:00 AM
curl -X PUT http://localhost:5000/api/v1/admin/configurations/WORK_START_HOUR \
-H "Authorization: Bearer TOKEN" \
-d '{"configValue": "8"}'
# → Response: "Configuration updated successfully"
# 3. Check logs
# → Should see: "Working hours configuration 'WORK_START_HOUR' updated - cache cleared"
# 4. Create new STANDARD request
curl -X POST http://localhost:5000/api/v1/workflows \
-d '{"priority": "STANDARD", "tatHours": 16}'
# 5. Check TAT calculation logs
# → Should see: "Loaded working hours: 8:00-18:00" ✅
# → Deadline calculation uses new hours ✅
```
### **Test 2: Verify Cache Expiry**
```bash
# 1. Create request (loads working hours into cache)
# → Cache expires in 5 minutes
# 2. Wait 6 minutes
# 3. Create another request
# → Should see log: "Loaded working hours: ..." (cache reloaded)
# 4. Create third request immediately
# → No log (uses cached values)
```
### **Test 3: Extend to 6-Day Week**
```bash
# 1. Update end day to Saturday
curl -X PUT http://localhost:5000/api/v1/admin/configurations/WORK_END_DAY \
-d '{"configValue": "6"}'
# 2. Create request on Friday afternoon
# → Deadline should include Saturday ✅
# → Sunday still excluded ✅
```
---
## Database Configuration
### **Configuration Keys:**
```sql
SELECT config_key, config_value, display_name
FROM admin_configurations
WHERE config_key IN (
'WORK_START_HOUR',
'WORK_END_HOUR',
'WORK_START_DAY',
'WORK_END_DAY'
);
-- Example results:
-- WORK_START_HOUR | 9 | Work Start Hour
-- WORK_END_HOUR | 18 | Work End Hour
-- WORK_START_DAY | 1 | Work Start Day (Monday)
-- WORK_END_DAY | 5 | Work End Day (Friday)
```
### **Update Example:**
```sql
-- Change working hours to 8 AM - 8 PM
UPDATE admin_configurations
SET config_value = '8', updated_at = NOW()
WHERE config_key = 'WORK_START_HOUR';
UPDATE admin_configurations
SET config_value = '20', updated_at = NOW()
WHERE config_key = 'WORK_END_HOUR';
-- Include Saturday as working day
UPDATE admin_configurations
SET config_value = '6', updated_at = NOW()
WHERE config_key = 'WORK_END_DAY';
```
---
## Logging Examples
### **Configuration Update:**
```
[Admin] Working hours configuration 'WORK_START_HOUR' updated - cache cleared
[ConfigReader] Configuration cache cleared
[TAT Utils] Working hours cache cleared
```
### **TAT Calculation:**
```
[TAT Utils] Loaded working hours: 8:00-20:00, Days: 1-6
[TAT Scheduler] Using STANDARD mode - excludes holidays, weekends, non-working hours
[TAT Scheduler] Calculating TAT milestones for request REQ-2025-001
[TAT Scheduler] Priority: STANDARD, TAT Hours: 16
[TAT Scheduler] Start: 2025-11-05 09:00
[TAT Scheduler] Threshold 1 (55%): 2025-11-05 17:48 (using 8-20 working hours)
[TAT Scheduler] Threshold 2 (80%): 2025-11-06 10:48
[TAT Scheduler] Breach (100%): 2025-11-06 15:00
```
---
## Migration from Hardcoded Values
### **Before (Hardcoded):**
```typescript
// ❌ Hardcoded in code
const WORK_START_HOUR = 9;
const WORK_END_HOUR = 18;
const WORK_START_DAY = 1;
const WORK_END_DAY = 5;
// To change: Need code update + deployment
```
### **After (Dynamic):**
```typescript
// ✅ Read from database
const config = await getWorkingHours();
// config = { startHour: 9, endHour: 18 }
// To change: Just update in admin UI
// No code changes needed ✅
// No deployment needed ✅
```
---
## Benefits
### **1. Flexibility**
- ✅ Change working hours anytime without code changes
- ✅ No deployment needed
- ✅ Takes effect within 5 minutes
### **2. Global Organizations**
- ✅ Adjust for different time zones
- ✅ Support 24/5 or 24/6 operations
- ✅ Extended hours for urgent periods
### **3. Seasonal Adjustments**
- ✅ Extend hours during busy seasons
- ✅ Reduce hours during slow periods
- ✅ Special hours for events
### **4. Performance**
- ✅ Cache prevents repeated DB queries
- ✅ Fast lookups (memory vs database)
- ✅ Auto-refresh every 5 minutes
### **5. Consistency**
- ✅ All TAT calculations use same values
- ✅ Immediate cache invalidation on update
- ✅ Fallback to defaults if DB unavailable
---
## Summary
| Aspect | Details |
|--------|---------|
| **Configurable** | ✅ Working hours, working days |
| **Admin UI** | ✅ Settings → System Configuration |
| **Cache Duration** | 5 minutes |
| **Cache Invalidation** | Automatic on config update |
| **Applies To** | STANDARD priority only |
| **Express Mode** | Ignores working hours (24/7) |
| **Performance** | Optimized with caching |
| **Fallback** | Uses TAT_CONFIG defaults if DB fails |
---
## Files Modified
1. `Re_Backend/src/utils/tatTimeUtils.ts` - Dynamic working hours loading
2. `Re_Backend/src/controllers/admin.controller.ts` - Cache invalidation on update
3. `Re_Backend/src/services/configReader.service.ts` - `getWorkingHours()` function
---
## Configuration Flow Diagram
```
Admin Updates Working Hours (8:00 AM - 8:00 PM)
↓
Database Updated (admin_configurations table)
↓
clearConfigCache() + clearWorkingHoursCache()
↓
Caches Invalidated (both config and working hours)
↓
Next TAT Calculation
↓
loadWorkingHoursCache() called
↓
Read from Database (startHour=8, endHour=20)
↓
Store in Memory (5-minute cache)
↓
TAT Calculation Uses New Hours ✅
↓
All Future Requests (for 5 min) Use Cached Values
↓
After 5 Minutes → Reload from Database
```
---
Working hours are now fully dynamic and admin-controlled! 🎉

516
HOLIDAY_EXPRESS_TAT.md Normal file
View File

@ -0,0 +1,516 @@
# Holiday Handling & EXPRESS Mode TAT Calculation
## Overview
The TAT (Turn Around Time) system now supports:
1. **Holiday Exclusions** - Configured holidays are excluded from STANDARD priority TAT calculations
2. **EXPRESS Mode** - EXPRESS priority requests use 24/7 calculation (no exclusions)
---
## How It Works
### **STANDARD Priority (Default)**
**Calculation:**
- ✅ Excludes weekends (Saturday, Sunday)
- ✅ Excludes non-working hours (9 AM - 6 PM by default)
- ✅ **Excludes holidays configured in Admin Settings**
**Example:**
```
TAT = 16 working hours
Start: Monday 2:00 PM
Calculation:
Monday 2:00 PM - 6:00 PM = 4 hours (remaining: 12h)
Tuesday 9:00 AM - 6:00 PM = 9 hours (remaining: 3h)
Wednesday 9:00 AM - 12:00 PM = 3 hours (remaining: 0h)
If Wednesday is a HOLIDAY → Skip to Thursday:
Wednesday (HOLIDAY) = 0 hours (skipped)
Thursday 9:00 AM - 12:00 PM = 3 hours (remaining: 0h)
Final deadline: Thursday 12:00 PM ✅
```
---
### **EXPRESS Priority**
**Calculation:**
- ✅ Counts ALL hours (24/7)
- ✅ **No weekend exclusion**
- ✅ **No non-working hours exclusion**
- ✅ **No holiday exclusion**
**Example:**
```
TAT = 16 hours
Start: Monday 2:00 PM
Calculation:
Simply add 16 hours:
Monday 2:00 PM + 16 hours = Tuesday 6:00 AM
Final deadline: Tuesday 6:00 AM ✅
(Even if Tuesday is a holiday, it still counts)
```
---
## Holiday Configuration Flow
### **1. Admin Adds Holiday**
```
Settings Page → Holiday Manager → Add Holiday
Name: "Christmas Day"
Date: 2025-12-25
Type: Public Holiday
✅ Save
```
### **2. Holiday Stored in Database**
```sql
INSERT INTO holidays (holiday_date, holiday_name, holiday_type, is_active)
VALUES ('2025-12-25', 'Christmas Day', 'PUBLIC_HOLIDAY', true);
```
### **3. Holiday Cache Updated**
```typescript
// Holidays are cached in memory for 6 hours
await loadHolidaysCache();
// → holidaysCache = Set(['2025-12-25', '2025-01-01', ...])
```
### **4. TAT Calculation Uses Holiday Cache**
```typescript
// When scheduling TAT jobs
if (priority === 'STANDARD') {
// Working hours calculation - checks holidays
const threshold1 = await addWorkingHours(start, hours * 0.55);
// → If date is in holidaysCache, it's skipped ✅
} else {
// EXPRESS: 24/7 calculation - ignores holidays
const threshold1 = addCalendarHours(start, hours * 0.55);
// → Adds hours directly, no checks ✅
}
```
---
## Implementation Details
### **Function: `addWorkingHours()` (STANDARD Mode)**
```typescript
export async function addWorkingHours(start: Date, hoursToAdd: number): Promise<Dayjs> {
let current = dayjs(start);
// Load holidays from database (cached)
await loadHolidaysCache();
let remaining = hoursToAdd;
while (remaining > 0) {
current = current.add(1, 'hour');
// Check if current hour is working time
if (isWorkingTime(current)) { // ✅ Checks holidays here
remaining -= 1;
}
}
return current;
}
function isWorkingTime(date: Dayjs): boolean {
// Check weekend
if (date.day() === 0 || date.day() === 6) return false;
// Check working hours
if (date.hour() < 9 || date.hour() >= 18) return false;
// Check if holiday ✅
if (isHoliday(date)) return false;
return true;
}
function isHoliday(date: Dayjs): boolean {
const dateStr = date.format('YYYY-MM-DD');
return holidaysCache.has(dateStr); // ✅ Checks cached holidays
}
```
---
### **Function: `addCalendarHours()` (EXPRESS Mode)**
```typescript
export function addCalendarHours(start: Date, hoursToAdd: number): Dayjs {
// Simple addition - no checks ✅
return dayjs(start).add(hoursToAdd, 'hour');
}
```
---
## TAT Scheduler Integration
### **Updated Method Signature:**
```typescript
async scheduleTatJobs(
requestId: string,
levelId: string,
approverId: string,
tatDurationHours: number,
startTime?: Date,
priority: Priority = Priority.STANDARD // ✅ New parameter
): Promise<void>
```
### **Priority-Based Calculation:**
```typescript
const isExpress = priority === Priority.EXPRESS;
if (isExpress) {
// EXPRESS: 24/7 calculation
threshold1Time = addCalendarHours(now, hours * 0.55).toDate();
threshold2Time = addCalendarHours(now, hours * 0.80).toDate();
breachTime = addCalendarHours(now, hours).toDate();
logger.info('Using EXPRESS mode (24/7) - no holiday/weekend exclusions');
} else {
// STANDARD: Working hours, exclude holidays
const t1 = await addWorkingHours(now, hours * 0.55);
const t2 = await addWorkingHours(now, hours * 0.80);
const tBreach = await addWorkingHours(now, hours);
threshold1Time = t1.toDate();
threshold2Time = t2.toDate();
breachTime = tBreach.toDate();
logger.info('Using STANDARD mode - excludes holidays, weekends, non-working hours');
}
```
---
## Example Scenarios
### **Scenario 1: STANDARD with Holiday**
```
Request Details:
- Priority: STANDARD
- TAT: 16 working hours
- Start: Monday 2:00 PM
- Holiday: Wednesday (Christmas)
Calculation:
Monday 2:00 PM - 6:00 PM = 4 hours (12h remaining)
Tuesday 9:00 AM - 6:00 PM = 9 hours (3h remaining)
Wednesday (HOLIDAY) = SKIPPED ✅
Thursday 9:00 AM - 12:00 PM = 3 hours (0h remaining)
TAT Milestones:
- Threshold 1 (55%): Tuesday 4:40 PM (8.8 working hours)
- Threshold 2 (80%): Thursday 10:48 AM (12.8 working hours)
- Breach (100%): Thursday 12:00 PM (16 working hours)
```
---
### **Scenario 2: EXPRESS with Holiday**
```
Request Details:
- Priority: EXPRESS
- TAT: 16 hours
- Start: Monday 2:00 PM
- Holiday: Wednesday (Christmas) - IGNORED ✅
Calculation:
Monday 2:00 PM + 16 hours = Tuesday 6:00 AM
TAT Milestones:
- Threshold 1 (55%): Monday 10:48 PM (8.8 hours)
- Threshold 2 (80%): Tuesday 2:48 AM (12.8 hours)
- Breach (100%): Tuesday 6:00 AM (16 hours)
Note: Even though Wednesday is a holiday, EXPRESS doesn't care ✅
```
---
### **Scenario 3: Multiple Holidays**
```
Request Details:
- Priority: STANDARD
- TAT: 40 working hours
- Start: Friday 10:00 AM
- Holidays: Monday (New Year), Tuesday (Day After)
Calculation:
Friday 10:00 AM - 6:00 PM = 8 hours (32h remaining)
Saturday-Sunday = SKIPPED (weekend)
Monday (HOLIDAY) = SKIPPED ✅
Tuesday (HOLIDAY) = SKIPPED ✅
Wednesday 9:00 AM - 6:00 PM = 9 hours (23h remaining)
Thursday 9:00 AM - 6:00 PM = 9 hours (14h remaining)
Friday 9:00 AM - 6:00 PM = 9 hours (5h remaining)
Monday 9:00 AM - 2:00 PM = 5 hours (0h remaining)
Final deadline: Next Monday 2:00 PM ✅
(Skipped 2 weekends + 2 holidays)
```
---
## Holiday Cache Management
### **Cache Lifecycle:**
```
1. Server Startup
→ initializeHolidaysCache() called
→ Holidays loaded into memory
2. Cache Valid for 6 Hours
→ holidaysCacheExpiry = now + 6 hours
→ Subsequent calls use cached data (fast)
3. Cache Expires After 6 Hours
→ Next TAT calculation reloads cache from DB
→ New cache expires in 6 hours
4. Manual Cache Refresh (Optional)
→ Admin adds/updates holiday
→ Call initializeHolidaysCache() to refresh immediately
```
### **Cache Performance:**
```
Without Cache:
- Every TAT calculation → DB query → SLOW ❌
- 100 requests/hour → 100 DB queries
With Cache:
- Load once per 6 hours → DB query → FAST ✅
- 100 requests/hour → 0 DB queries (use cache)
- Cache refresh: Every 6 hours or on-demand
```
---
## Priority Detection in Services
### **Workflow Service (Submission):**
```typescript
// When submitting workflow
const workflowPriority = (updated as any).priority || 'STANDARD';
await tatSchedulerService.scheduleTatJobs(
requestId,
levelId,
approverId,
tatHours,
now,
workflowPriority // ✅ Pass priority
);
```
### **Approval Service (Next Level):**
```typescript
// When moving to next approval level
const workflowPriority = (wf as any)?.priority || 'STANDARD';
await tatSchedulerService.scheduleTatJobs(
requestId,
nextLevelId,
nextApproverId,
tatHours,
now,
workflowPriority // ✅ Pass priority
);
```
---
## Database Schema
### **Holidays Table:**
```sql
CREATE TABLE holidays (
holiday_id UUID PRIMARY KEY,
holiday_date DATE NOT NULL,
holiday_name VARCHAR(255) NOT NULL,
holiday_type VARCHAR(50),
description TEXT,
is_active BOOLEAN DEFAULT true,
created_at TIMESTAMP DEFAULT NOW(),
updated_at TIMESTAMP DEFAULT NOW()
);
-- Example data
INSERT INTO holidays (holiday_date, holiday_name, holiday_type)
VALUES
('2025-12-25', 'Christmas Day', 'PUBLIC_HOLIDAY'),
('2025-01-01', 'New Year''s Day', 'PUBLIC_HOLIDAY'),
('2025-07-04', 'Independence Day', 'PUBLIC_HOLIDAY');
```
### **Workflow Request Priority:**
```sql
-- WorkflowRequest table already has priority field
SELECT request_id, priority, tat_hours
FROM workflow_requests
WHERE priority = 'EXPRESS'; -- 24/7 calculation
-- OR
WHERE priority = 'STANDARD'; -- Working hours + holiday exclusion
```
---
## Testing Scenarios
### **Test 1: Add Holiday, Create STANDARD Request**
```bash
# 1. Add holiday for tomorrow
curl -X POST http://localhost:5000/api/v1/admin/holidays \
-H "Authorization: Bearer TOKEN" \
-d '{
"holidayDate": "2025-11-06",
"holidayName": "Test Holiday",
"holidayType": "PUBLIC_HOLIDAY"
}'
# 2. Create STANDARD request with 24h TAT
curl -X POST http://localhost:5000/api/v1/workflows \
-d '{
"priority": "STANDARD",
"tatHours": 24
}'
# 3. Check scheduled TAT jobs in logs
# → Should show deadline skipping the holiday ✅
```
### **Test 2: Same Holiday, EXPRESS Request**
```bash
# 1. Holiday still exists (tomorrow)
# 2. Create EXPRESS request with 24h TAT
curl -X POST http://localhost:5000/api/v1/workflows \
-d '{
"priority": "EXPRESS",
"tatHours": 24
}'
# 3. Check scheduled TAT jobs in logs
# → Should show deadline NOT skipping the holiday ✅
# → Exactly 24 hours from now (includes holiday)
```
### **Test 3: Verify Holiday Exclusion**
```bash
# Create request on Friday afternoon
# With 16 working hours TAT
# Should skip weekend and land on Monday/Tuesday
# If Monday is a holiday:
# → STANDARD: Should land on Tuesday ✅
# → EXPRESS: Should land on Sunday ✅
```
---
## Logging Examples
### **STANDARD Mode Log:**
```
[TAT Scheduler] Using STANDARD mode - excludes holidays, weekends, non-working hours
[TAT Scheduler] Calculating TAT milestones for request REQ-123, level LEVEL-456
[TAT Scheduler] Priority: STANDARD, TAT Hours: 16
[TAT Scheduler] Start: 2025-11-05 14:00
[TAT Scheduler] Threshold 1 (55%): 2025-11-07 11:48 (skipped 1 holiday)
[TAT Scheduler] Threshold 2 (80%): 2025-11-08 09:48
[TAT Scheduler] Breach (100%): 2025-11-08 14:00
```
### **EXPRESS Mode Log:**
```
[TAT Scheduler] Using EXPRESS mode (24/7) - no holiday/weekend exclusions
[TAT Scheduler] Calculating TAT milestones for request REQ-456, level LEVEL-789
[TAT Scheduler] Priority: EXPRESS, TAT Hours: 16
[TAT Scheduler] Start: 2025-11-05 14:00
[TAT Scheduler] Threshold 1 (55%): 2025-11-05 22:48 (8.8 hours)
[TAT Scheduler] Threshold 2 (80%): 2025-11-06 02:48 (12.8 hours)
[TAT Scheduler] Breach (100%): 2025-11-06 06:00 (16 hours)
```
---
## Summary
### **What Changed:**
1. ✅ Added `addCalendarHours()` for EXPRESS mode (24/7 calculation)
2. ✅ Updated `addWorkingHours()` to check holidays from admin settings
3. ✅ Added `priority` parameter to `scheduleTatJobs()`
4. ✅ Updated workflow/approval services to pass priority
5. ✅ Holiday cache for performance (6-hour expiry)
### **How Holidays Are Used:**
| Priority | Calculation Method | Holidays | Weekends | Non-Working Hours |
|----------|-------------------|----------|----------|-------------------|
| **STANDARD** | Working hours only | ✅ Excluded | ✅ Excluded | ✅ Excluded |
| **EXPRESS** | 24/7 calendar hours | ❌ Counted | ❌ Counted | ❌ Counted |
### **Benefits:**
1. ✅ **Accurate TAT for STANDARD** - Respects holidays, no false breaches
2. ✅ **Fast EXPRESS** - True 24/7 calculation for urgent requests
3. ✅ **Centralized Holiday Management** - Admin can add/edit holidays
4. ✅ **Performance** - Holiday cache prevents repeated DB queries
5. ✅ **Flexible** - Priority can be changed per request
---
## Files Modified
1. `Re_Backend/src/utils/tatTimeUtils.ts` - Added `addCalendarHours()` for EXPRESS mode
2. `Re_Backend/src/services/tatScheduler.service.ts` - Added priority parameter and logic
3. `Re_Backend/src/services/workflow.service.ts` - Pass priority when scheduling TAT
4. `Re_Backend/src/services/approval.service.ts` - Pass priority for next level TAT
---
## Configuration Keys
| Config Key | Default | Description |
|------------|---------|-------------|
| `WORK_START_HOUR` | 9 | Working hours start (STANDARD mode only) |
| `WORK_END_HOUR` | 18 | Working hours end (STANDARD mode only) |
| `WORK_START_DAY` | 1 | Monday (STANDARD mode only) |
| `WORK_END_DAY` | 5 | Friday (STANDARD mode only) |
**Note:** EXPRESS mode ignores all these configurations and uses 24/7 calculation.

120
MIGRATION_QUICK_REFERENCE.md Normal file
View File

@ -0,0 +1,120 @@
# 🚀 Migration Quick Reference
## Daily Development Workflow
### Starting Development (Auto-runs Migrations)
```bash
npm run dev
```
✅ **This will automatically run all new migrations before starting the server!**
### Run Migrations Only
```bash
npm run migrate
```
## Adding a New Migration (3 Steps)
### 1️⃣ Create Migration File
Location: `src/migrations/YYYYMMDD-description.ts`
```typescript
import { QueryInterface, DataTypes } from 'sequelize';
export async function up(queryInterface: QueryInterface): Promise<void> {
await queryInterface.addColumn('table_name', 'column_name', {
type: DataTypes.STRING,
allowNull: true,
});
console.log('✅ Migration completed');
}
export async function down(queryInterface: QueryInterface): Promise<void> {
await queryInterface.removeColumn('table_name', 'column_name');
console.log('✅ Rollback completed');
}
```
### 2️⃣ Register in `src/scripts/migrate.ts`
```typescript
// Add import at top
import * as m15 from '../migrations/YYYYMMDD-description';
// Add execution in run() function
await (m15 as any).up(sequelize.getQueryInterface());
```
### 3️⃣ Test
```bash
npm run migrate
```
## Common Operations
### Add Column
```typescript
await queryInterface.addColumn('table', 'column', {
type: DataTypes.STRING(100),
allowNull: false,
defaultValue: 'value'
});
```
### Add Foreign Key
```typescript
await queryInterface.addColumn('table', 'foreign_id', {
type: DataTypes.UUID,
references: { model: 'other_table', key: 'id' },
onUpdate: 'CASCADE',
onDelete: 'SET NULL'
});
```
### Add Index
```typescript
await queryInterface.addIndex('table', ['column'], {
name: 'idx_table_column'
});
```
### Create Table
```typescript
await queryInterface.createTable('new_table', {
id: {
type: DataTypes.UUID,
defaultValue: DataTypes.UUIDV4,
primaryKey: true
},
name: DataTypes.STRING(100),
created_at: DataTypes.DATE,
updated_at: DataTypes.DATE
});
```
## What's New ✨
### Latest Migration: Skip Approver Functionality
- **File**: `20251105-add-skip-fields-to-approval-levels.ts`
- **Added Fields**:
- `is_skipped` - Boolean flag
- `skipped_at` - Timestamp
- `skipped_by` - User reference
- `skip_reason` - Text explanation
- **Index**: Partial index on `is_skipped = TRUE`
## Troubleshooting
| Issue | Solution |
|-------|----------|
| Migration fails | Check console error, fix migration file, re-run |
| Column exists error | Migration partially ran - add idempotent checks |
| Server won't start | Fix migration first, it blocks startup |
## 📚 Full Documentation
See `MIGRATION_WORKFLOW.md` for comprehensive guide.
---
**Auto-Migration**: ✅ Enabled
**Total Migrations**: 14
**Latest**: 2025-11-05

284
MIGRATION_WORKFLOW.md Normal file
View File

@ -0,0 +1,284 @@
# Migration Workflow Guide
## Overview
This project uses a TypeScript-based migration system for database schema changes. All migrations are automatically executed when you start the development server.
## 🚀 Quick Start
### Running Development Server with Migrations
```bash
npm run dev
```
This command will:
1. ✅ Run all pending migrations automatically
2. 🚀 Start the development server with hot reload
### Running Migrations Only
```bash
npm run migrate
```
Use this when you only want to apply migrations without starting the server.
## 📝 Creating New Migrations
### Step 1: Create Migration File
Create a new TypeScript file in `src/migrations/` with the naming pattern:
```
YYYYMMDD-descriptive-name.ts
```
Example: `20251105-add-new-field.ts`
### Step 2: Migration Template
```typescript
import { QueryInterface, DataTypes } from 'sequelize';
/**
* Migration: Brief description
* Purpose: Detailed explanation
* Date: YYYY-MM-DD
*/
export async function up(queryInterface: QueryInterface): Promise<void> {
// Add your forward migration logic here
await queryInterface.addColumn('table_name', 'column_name', {
type: DataTypes.STRING,
allowNull: true,
});
console.log('✅ Migration description completed');
}
export async function down(queryInterface: QueryInterface): Promise<void> {
// Add your rollback logic here
await queryInterface.removeColumn('table_name', 'column_name');
console.log('✅ Migration rolled back');
}
```
### Step 3: Register Migration
Add your new migration to `src/scripts/migrate.ts`:
```typescript
// 1. Import at the top
import * as m15 from '../migrations/20251105-add-new-field';
// 2. Execute in the run() function
await (m15 as any).up(sequelize.getQueryInterface());
```
### Step 4: Test
```bash
npm run migrate
```
## 📋 Current Migrations
The following migrations are configured and will run in order:
1. `2025103001-create-workflow-requests` - Core workflow requests table
2. `2025103002-create-approval-levels` - Approval hierarchy structure
3. `2025103003-create-participants` - Workflow participants
4. `2025103004-create-documents` - Document attachments
5. `20251031_01_create_subscriptions` - User subscriptions
6. `20251031_02_create_activities` - Activity tracking
7. `20251031_03_create_work_notes` - Work notes/comments
8. `20251031_04_create_work_note_attachments` - Note attachments
9. `20251104-add-tat-alert-fields` - TAT alert fields
10. `20251104-create-tat-alerts` - TAT alerts table
11. `20251104-create-kpi-views` - KPI database views
12. `20251104-create-holidays` - Holiday calendar
13. `20251104-create-admin-config` - Admin configurations
14. `20251105-add-skip-fields-to-approval-levels` - Skip approver functionality
## 🔄 Migration Safety Features
### Idempotent Migrations
All migrations should be **idempotent** (safe to run multiple times). Use checks like:
```typescript
// Check if column exists before adding
const tableDescription = await queryInterface.describeTable('table_name');
if (!tableDescription.column_name) {
await queryInterface.addColumn(/* ... */);
}
// Check if table exists before creating
const tables = await queryInterface.showAllTables();
if (!tables.includes('table_name')) {
await queryInterface.createTable(/* ... */);
}
```
### Error Handling
Migrations automatically:
- ✅ Stop on first error
- ❌ Exit with error code 1 on failure
- 📝 Log detailed error messages
- 🔄 Prevent server startup if migrations fail
## 🛠️ Common Migration Operations
### Adding a Column
```typescript
await queryInterface.addColumn('table_name', 'new_column', {
type: DataTypes.STRING(100),
allowNull: false,
defaultValue: 'default_value',
comment: 'Column description'
});
```
### Adding Foreign Key
```typescript
await queryInterface.addColumn('table_name', 'foreign_key_id', {
type: DataTypes.UUID,
allowNull: true,
references: {
model: 'referenced_table',
key: 'id'
},
onUpdate: 'CASCADE',
onDelete: 'SET NULL'
});
```
### Creating Index
```typescript
await queryInterface.addIndex('table_name', ['column_name'], {
name: 'idx_table_column',
unique: false
});
// Partial index with WHERE clause
await queryInterface.addIndex('table_name', ['status'], {
name: 'idx_table_active',
where: {
is_active: true
}
});
```
### Creating Table
```typescript
await queryInterface.createTable('new_table', {
id: {
type: DataTypes.UUID,
defaultValue: DataTypes.UUIDV4,
primaryKey: true
},
name: {
type: DataTypes.STRING(100),
allowNull: false
},
created_at: {
type: DataTypes.DATE,
allowNull: false,
defaultValue: DataTypes.NOW
},
updated_at: {
type: DataTypes.DATE,
allowNull: false,
defaultValue: DataTypes.NOW
}
});
```
### Modifying Column
```typescript
await queryInterface.changeColumn('table_name', 'column_name', {
type: DataTypes.STRING(200), // Changed from 100
allowNull: true // Changed from false
});
```
### Dropping Column
```typescript
await queryInterface.removeColumn('table_name', 'old_column');
```
### Raw SQL Queries
```typescript
await queryInterface.sequelize.query(`
CREATE OR REPLACE VIEW view_name AS
SELECT * FROM table_name WHERE condition
`);
```
## 📊 Database Structure Reference
Always refer to `backend_structure.txt` for the authoritative database structure including:
- All tables and their columns
- Data types and constraints
- Relationships and foreign keys
- Enum values
- Indexes
## 🚨 Troubleshooting
### Migration Fails with "Column Already Exists"
- The migration might have partially run
- Add idempotent checks or manually rollback the failed migration
### Server Won't Start After Migration
- Check the migration error in console
- Fix the migration file
- Run `npm run migrate` to retry
### Need to Rollback a Migration
```bash
# Manual rollback (requires implementing down() function)
ts-node src/scripts/rollback.ts
```
## 🎯 Best Practices
1. **Always test migrations** on development database first
2. **Write rollback logic** in `down()` function
3. **Use descriptive names** for migrations
4. **Add comments** explaining the purpose
5. **Keep migrations small** - one logical change per file
6. **Never modify** existing migration files after they run in production
7. **Use transactions** for complex multi-step migrations
8. **Backup production** before running new migrations
## 📝 Migration Checklist
Before running migrations in production:
- [ ] Tested on local development database
- [ ] Verified rollback functionality works
- [ ] Checked for data loss scenarios
- [ ] Reviewed index impact on performance
- [ ] Confirmed migration is idempotent
- [ ] Updated `backend_structure.txt` documentation
- [ ] Added migration to version control
- [ ] Registered in `migrate.ts`
## 🔗 Related Files
- **Migration Scripts**: `src/migrations/`
- **Migration Runner**: `src/scripts/migrate.ts`
- **Database Config**: `src/config/database.ts`
- **Database Structure**: `backend_structure.txt`
- **Package Scripts**: `package.json`
## 💡 Example: Recent Migration
The latest migration (`20251105-add-skip-fields-to-approval-levels`) demonstrates best practices:
- ✅ Descriptive naming
- ✅ Clear documentation
- ✅ Multiple related columns added together
- ✅ Foreign key relationships
- ✅ Indexed for query performance
- ✅ Includes rollback logic
- ✅ Helpful console messages
---
**Last Updated**: November 5, 2025
**Migration Count**: 14 migrations
**Auto-Run**: Enabled for `npm run dev`

220
QUICK_FIX_CONFIGURATIONS.md Normal file
View File

@ -0,0 +1,220 @@
# Quick Fix: Settings Not Editable Issue
## 🔴 Problem
Settings showing as "not editable" in the frontend.
## 🎯 Root Cause
**Field Mapping Issue:** Database uses `is_editable` (snake_case) but frontend expects `isEditable` (camelCase).
## ✅ Solution Applied
### **1. Fixed Admin Controller** ✅
Added field mapping from snake_case to camelCase:
```typescript
// Re_Backend/src/controllers/admin.controller.ts
const configurations = rawConfigurations.map(config => ({
configId: config.config_id, // ✅ Mapped
isEditable: config.is_editable, // ✅ Mapped
isSensitive: config.is_sensitive, // ✅ Mapped
requiresRestart: config.requires_restart, // ✅ Mapped
// ... all other fields
}));
```
### **2. Database Fix Required**
**Option A: Delete and Re-seed** (Recommended if no custom configs)
```sql
-- Connect to your database
DELETE FROM admin_configurations;
-- Restart backend - auto-seeding will run
-- Check logs for: "✅ Default configurations seeded (18 settings)"
```
**Option B: Fix Existing Records** (If you have custom values)
```sql
-- Update existing records to add missing fields
UPDATE admin_configurations
SET
is_sensitive = COALESCE(is_sensitive, false),
requires_restart = COALESCE(requires_restart, false),
is_editable = COALESCE(is_editable, true)
WHERE is_sensitive IS NULL
OR requires_restart IS NULL
OR is_editable IS NULL;
-- Set requires_restart = true for settings that need it
UPDATE admin_configurations
SET requires_restart = true
WHERE config_key IN (
'WORK_START_HOUR',
'WORK_END_HOUR',
'MAX_FILE_SIZE_MB',
'ALLOWED_FILE_TYPES'
);
```
---
## 🚀 Step-by-Step Fix
### **Step 1: Stop Backend**
```bash
# Press Ctrl+C to stop the server
```
### **Step 2: Clear Configurations** (if any exist)
```sql
-- Connect to PostgreSQL
psql -U postgres -d re_workflow
-- Check if configurations exist
SELECT COUNT(*) FROM admin_configurations;
-- If count > 0, delete them
DELETE FROM admin_configurations;
-- Verify
SELECT COUNT(*) FROM admin_configurations;
-- Should show: 0
```
### **Step 3: Restart Backend** (Auto-seeds)
```bash
cd Re_Backend
npm run dev
```
### **Step 4: Verify Seeding in Logs**
Look for:
```
⚙️ System configurations initialized
✅ Default configurations seeded successfully (18 settings across 7 categories)
```
### **Step 5: Test in Frontend**
1. Login as Admin user
2. Go to **Settings → System Configuration**
3. You should see **7 category tabs**
4. Click any tab (e.g., "TAT SETTINGS")
5. All settings should now have:
- ✅ Editable input fields
- ✅ **Save** button enabled
- ✅ **Reset to Default** button
---
## 🧪 Verify Configuration Loaded Correctly
**Test API Endpoint:**
```bash
# Get all configurations
curl http://localhost:5000/api/v1/admin/configurations \
-H "Authorization: Bearer YOUR_JWT_TOKEN"
```
**Expected Response:**
```json
{
"success": true,
"data": [
{
"configId": "uuid...",
"configKey": "DEFAULT_TAT_EXPRESS_HOURS",
"configCategory": "TAT_SETTINGS",
"configValue": "24",
"valueType": "NUMBER",
"displayName": "Default TAT for Express Priority",
"isEditable": true, // ✅ Should be true
"isSensitive": false,
"validationRules": {"min": 1, "max": 168},
"uiComponent": "number",
"sortOrder": 1,
"requiresRestart": false
},
// ... 17 more configurations
],
"count": 18
}
```
**Check the `isEditable` field - should be `true` for all!**
---
## 🐛 Common Issues & Solutions
### Issue 1: "Configurations already exist. Skipping seed."
**Cause:** Old configurations in database
**Fix:** Delete them and restart backend
### Issue 2: Settings show as gray/disabled
**Cause:** `is_editable = false` in database
**Fix:** Run SQL update to set all to `true`
### Issue 3: "Configuration not found or not editable" error when saving
**Cause:** Backend can't find the config or `is_editable = false`
**Fix:** Verify database has correct values
### Issue 4: Empty settings page
**Cause:** No configurations in database
**Fix:** Check backend logs for seeding errors, run seed manually
---
## 📊 Expected Database State
After successful seeding, your `admin_configurations` table should have:
| Count | Category | All Editable? |
|-------|----------|---------------|
| 6 | TAT_SETTINGS | ✅ Yes |
| 3 | DOCUMENT_POLICY | ✅ Yes |
| 2 | AI_CONFIGURATION | ✅ Yes |
| 3 | NOTIFICATION_RULES | ✅ Yes |
| 4 | DASHBOARD_LAYOUT | ✅ Yes |
| 3 | WORKFLOW_SHARING | ✅ Yes |
| 2 | WORKFLOW_LIMITS | ✅ Yes |
| **18 Total** | **7 Categories** | **✅ All Editable** |
Query to verify:
```sql
SELECT
config_category,
COUNT(*) as total,
SUM(CASE WHEN is_editable = true THEN 1 ELSE 0 END) as editable_count
FROM admin_configurations
GROUP BY config_category
ORDER BY config_category;
```
Should show 100% editable in all categories!
---
## ✅ After Fix - Settings UI Will Show:
```
Settings → System Configuration
┌─────────────────────────────────────────┐
│ [TAT SETTINGS] [DOCUMENT POLICY] [...] │ ← 7 tabs
├─────────────────────────────────────────┤
│ │
│ ⏰ Default TAT for Express Priority │
│ (Description...) │
│ ┌──────┐ ← EDITABLE │
│ │ 24 │ │
│ └──────┘ │
│ [💾 Save] [🔄 Reset] ← ENABLED │
│ │
│ ⏰ First TAT Reminder (%) │
│ ━━━━●━━━━ 50% ← SLIDER WORKS │
│ [💾 Save] [🔄 Reset] │
│ │
└─────────────────────────────────────────┘
```
**All inputs should be EDITABLE and Save buttons ENABLED!** ✅

253
QUICK_START_SKIP_ADD_APPROVER.md Normal file
View File

@ -0,0 +1,253 @@
# Quick Start: Skip & Add Approver Features
## 🚀 Setup (One-Time)
### **Step 1: Run Database Migration**
```bash
# Connect to database
psql -U postgres -d re_workflow
# Run migration
\i Re_Backend/src/migrations/add_is_skipped_to_approval_levels.sql
# Verify columns added
\d approval_levels
# Should show: is_skipped, skipped_at, skipped_by, skip_reason
```
### **Step 2: Restart Backend**
```bash
cd Re_Backend
npm run dev
```
---
## 📖 User Guide
### **How to Skip an Approver (Initiator/Approver)**
1. Go to **Request Detail** → **Workflow** tab
2. Find the approver who is pending/in-review
3. Click **"Skip This Approver"** button
4. Enter reason (e.g., "On vacation")
5. Click OK
**Result:**
- ✅ Approver marked as SKIPPED
- ✅ Next approver becomes active
- ✅ Notification sent to next approver
- ✅ Activity logged
---
### **How to Add New Approver (Initiator/Approver)**
1. Go to **Request Detail** → **Quick Actions**
2. Click **"Add Approver"**
3. Review **Current Levels** (shows all existing approvers with status)
4. Select **Approval Level** (where to insert new approver)
5. Enter **TAT Hours** (e.g., 48)
6. Enter **Email** (use @ to search: `@john`)
7. Click **"Add at Level X"**
**Result:**
- ✅ New approver inserted at chosen level
- ✅ Existing approvers shifted automatically
- ✅ TAT jobs scheduled if level is active
- ✅ Notification sent to new approver
- ✅ Activity logged
---
## 🎯 Examples
### **Example 1: Skip Non-Responding Approver**
**Scenario:** Mike (Level 2) hasn't responded for 3 days, deadline approaching
**Steps:**
1. Open request REQ-2025-001
2. Go to Workflow tab
3. Find Mike's card (Level 2 - In Review)
4. Click "Skip This Approver"
5. Reason: "Approver on extended leave - deadline critical"
6. Confirm
**Result:**
```
Before: After:
Level 1: Sarah ✅ Level 1: Sarah ✅
Level 2: Mike ⏳ → Level 2: Mike ⏭️ (SKIPPED)
Level 3: Lisa ⏸️ Level 3: Lisa ⏳ (ACTIVE!)
```
---
### **Example 2: Add Finance Review**
**Scenario:** Need Finance Manager approval between existing levels
**Steps:**
1. Click "Add Approver" in Quick Actions
2. See current levels:
- Level 1: Sarah (Approved)
- Level 2: Mike (In Review)
- Level 3: Lisa (Waiting)
3. Select Level: **3** (to insert before Lisa)
4. TAT Hours: **48**
5. Email: `@john` → Select "John Doe (john@finance.com)"
6. Click "Add at Level 3"
**Result:**
```
Before: After:
Level 1: Sarah ✅ Level 1: Sarah ✅
Level 2: Mike ⏳ Level 2: Mike ⏳
Level 3: Lisa ⏸️ → Level 3: John ⏸️ (NEW!)
Level 4: Lisa ⏸️ (shifted)
```
---
## ⚙️ API Reference
### **Skip Approver**
```bash
POST /api/v1/workflows/:requestId/approvals/:levelId/skip
Headers:
Authorization: Bearer <token>
Body:
{
"reason": "Approver on vacation"
}
Response:
{
"success": true,
"message": "Approver skipped successfully"
}
```
---
### **Add Approver at Level**
```bash
POST /api/v1/workflows/:requestId/approvers/at-level
Headers:
Authorization: Bearer <token>
Body:
{
"email": "john@example.com",
"tatHours": 48,
"level": 3
}
Response:
{
"success": true,
"message": "Approver added successfully",
"data": {
"levelId": "...",
"levelNumber": 3,
"approverName": "John Doe",
"tatHours": 48
}
}
```
---
## 🛡️ Permissions
| Action | Who Can Do It |
|--------|---------------|
| Skip Approver | ✅ INITIATOR, ✅ APPROVER |
| Add Approver | ✅ INITIATOR, ✅ APPROVER |
| View Skip Reason | ✅ All participants |
---
## ⚠️ Limitations
| Limitation | Reason |
|------------|--------|
| Cannot skip approved levels | Data integrity |
| Cannot skip rejected levels | Already closed |
| Cannot skip already skipped levels | Already handled |
| Cannot skip future levels | Not yet active |
| Cannot add before completed levels | Would break workflow state |
| Must provide valid TAT (1-720h) | Business rules |
---
## 📊 Dashboard Impact
### **Skipped Approvers in Reports:**
```sql
-- Count skipped approvers
SELECT COUNT(*)
FROM approval_levels
WHERE is_skipped = TRUE;
-- Find requests with skipped levels
SELECT r.request_number, al.level_number, al.approver_name, al.skip_reason
FROM workflow_requests r
JOIN approval_levels al ON r.request_id = al.request_id
WHERE al.is_skipped = TRUE;
```
### **KPIs Affected:**
- **Avg Approval Time** - Skipped levels excluded from calculation
- **Approver Response Rate** - Skipped marked separately
- **Workflow Bottlenecks** - Identify frequently skipped approvers
---
## 🔍 Troubleshooting
### **"Cannot skip approver - level is already APPROVED"**
- The level has already been approved
- You cannot skip completed levels
### **"Cannot skip future approval levels"**
- You're trying to skip a level that hasn't been reached yet
- Only current level can be skipped
### **"Cannot add approver at level X. Minimum allowed level is Y"**
- You're trying to add before a completed level
- Must add after all approved/rejected/skipped levels
### **"User is already a participant in this request"**
- The user is already an approver, initiator, or spectator
- Cannot add same user twice
---
## ✅ Testing Checklist
- [ ] Run database migration
- [ ] Restart backend server
- [ ] Create test workflow with 3 approvers
- [ ] Approve Level 1
- [ ] Skip Level 2 (test skip functionality)
- [ ] Verify Level 3 becomes active
- [ ] Add new approver at Level 3 (test add functionality)
- [ ] Verify levels shifted correctly
- [ ] Check activity log shows both actions
- [ ] Verify notifications sent correctly
---
Ready to use! 🎉

310
SETUP_SUMMARY.md Normal file
View File

@ -0,0 +1,310 @@
# 🎉 Auto-Migration Setup Summary
## ✅ Setup Complete!
Your development environment now automatically runs all migrations when you start the server.
---
## 📋 What Changed
### 1. ✨ New Migration Created
```
src/migrations/20251105-add-skip-fields-to-approval-levels.ts
```
**Adds "Skip Approver" functionality to approval_levels table:**
- `is_skipped` - Boolean flag
- `skipped_at` - Timestamp
- `skipped_by` - User reference (FK)
- `skip_reason` - Text explanation
- Optimized index for skipped approvers
### 2. 🔧 Migration Runner Updated
```
src/scripts/migrate.ts
```
**Enhancements:**
- ✅ Added m14 migration import
- ✅ Added m14 execution
- ✅ Better console output with emojis
- ✅ Enhanced error messages
### 3. 🚀 Auto-Run on Development Start
```json
// package.json - "dev" script
"npm run migrate && nodemon --exec ts-node ..."
```
**Before**: Manual migration required
**After**: Automatic migration on `npm run dev`
### 4. 🗑️ Cleanup
```
❌ Deleted: src/migrations/add_is_skipped_to_approval_levels.sql
```
Converted SQL → TypeScript for consistency
### 5. 📚 Documentation Created
- ✅ `MIGRATION_WORKFLOW.md` - Complete guide
- ✅ `MIGRATION_QUICK_REFERENCE.md` - Quick reference
- ✅ `AUTO_MIGRATION_SETUP_COMPLETE.md` - Detailed setup docs
- ✅ `SETUP_SUMMARY.md` - This file
---
## 🎯 How to Use
### Start Development (Most Common)
```bash
npm run dev
```
**What happens:**
```
1. 📦 Connect to database
2. 🔄 Run all 14 migrations
3. ✅ Apply any new schema changes
4. 🚀 Start development server
5. ♻️ Enable hot reload
```
### Run Migrations Only
```bash
npm run migrate
```
**When to use:**
- After pulling new migration files
- Testing migrations before dev start
- Updating database without starting server
---
## 📊 Current Migration Status
| # | Migration | Date |
|---|-----------|------|
| 1 | create-workflow-requests | 2025-10-30 |
| 2 | create-approval-levels | 2025-10-30 |
| 3 | create-participants | 2025-10-30 |
| 4 | create-documents | 2025-10-30 |
| 5 | create-subscriptions | 2025-10-31 |
| 6 | create-activities | 2025-10-31 |
| 7 | create-work-notes | 2025-10-31 |
| 8 | create-work-note-attachments | 2025-10-31 |
| 9 | add-tat-alert-fields | 2025-11-04 |
| 10 | create-tat-alerts | 2025-11-04 |
| 11 | create-kpi-views | 2025-11-04 |
| 12 | create-holidays | 2025-11-04 |
| 13 | create-admin-config | 2025-11-04 |
| 14 | **add-skip-fields-to-approval-levels** | 2025-11-05 ✨ **NEW** |
**Total**: 14 migrations configured and ready
---
## 🔥 Key Features
### Automated Workflow
```
npm run dev
↓
Runs migrations
↓
Starts server
↓
Ready to code! 🎉
```
### Safety Features
- ✅ **Idempotent** - Safe to run multiple times
- ✅ **Error Handling** - Stops on first error
- ✅ **Blocks Startup** - Server won't start if migration fails
- ✅ **Rollback Support** - Every migration has down() function
- ✅ **TypeScript** - Type-safe schema changes
### Developer Experience
- ✅ **Zero Manual Steps** - Everything automatic
- ✅ **Consistent State** - Everyone has same schema
- ✅ **Fast Iteration** - Quick dev cycle
- ✅ **Clear Feedback** - Visual console output
---
## 📖 Quick Reference
### File Locations
```
src/
├── migrations/ ← Migration files
│ ├── 2025103001-create-workflow-requests.ts
│ ├── ...
│ └── 20251105-add-skip-fields-to-approval-levels.ts ✨
├── scripts/
│ └── migrate.ts ← Migration runner
└── config/
└── database.ts ← Database config
Root:
├── package.json ← Dev script with auto-migration
├── backend_structure.txt ← Database schema reference
└── MIGRATION_*.md ← Documentation
```
### Common Commands
```bash
# Development with auto-migration
npm run dev
# Migrations only
npm run migrate
# Build for production
npm run build
# Type check
npm run type-check
# Linting
npm run lint
npm run lint:fix
```
---
## 🆕 Adding New Migrations
### Quick Steps
1. **Create** migration file in `src/migrations/`
2. **Register** in `src/scripts/migrate.ts`
3. **Test** with `npm run dev` or `npm run migrate`
### Detailed Guide
See `MIGRATION_WORKFLOW.md` for:
- Migration templates
- Common operations
- Best practices
- Troubleshooting
- Safety guidelines
---
## ✨ Benefits
### For You
- ✅ No more manual migration steps
- ✅ Always up-to-date database schema
- ✅ Less context switching
- ✅ Focus on feature development
### For Team
- ✅ Consistent development environment
- ✅ Easy onboarding for new developers
- ✅ Clear migration history
- ✅ Professional workflow
### For Production
- ✅ Tested migration process
- ✅ Rollback capabilities
- ✅ Version controlled schema changes
- ✅ Audit trail of database changes
---
## 🎓 Example Session
```bash
# You just pulled latest code with new migration
git pull origin main
# Start development - migrations run automatically
npm run dev
# Console output:
📦 Database connected
🔄 Running migrations...
✅ Created workflow_requests table
✅ Created approval_levels table
...
✅ Added skip-related fields to approval_levels table
✅ All migrations applied successfully
🚀 Server running on port 5000
📊 Environment: development
⏰ TAT Worker: Initialized and listening
# Your database is now up-to-date!
# Server is running!
# Ready to code! 🎉
```
---
## 🔗 Next Steps
### Immediate
1. ✅ Run `npm run dev` to test auto-migration
2. ✅ Verify all 14 migrations execute successfully
3. ✅ Check database schema for new skip fields
### When Adding Features
1. Create migration for schema changes
2. Register in migrate.ts
3. Test with `npm run dev`
4. Commit migration with feature code
### Before Production Deploy
1. Backup production database
2. Test migrations in staging
3. Review migration execution order
4. Deploy with confidence
---
## 📞 Support & Resources
| Resource | Location |
|----------|----------|
| Full Guide | `MIGRATION_WORKFLOW.md` |
| Quick Reference | `MIGRATION_QUICK_REFERENCE.md` |
| Setup Details | `AUTO_MIGRATION_SETUP_COMPLETE.md` |
| Database Schema | `backend_structure.txt` |
| Migration Files | `src/migrations/` |
| Migration Runner | `src/scripts/migrate.ts` |
---
## 🏆 Success Criteria
- ✅ Auto-migration configured
- ✅ All 14 migrations registered
- ✅ TypeScript migration created for skip fields
- ✅ SQL file converted and cleaned up
- ✅ Documentation completed
- ✅ Package.json updated
- ✅ Migration runner enhanced
- ✅ Ready for development
---
## 🎉 You're All Set!
Just run:
```bash
npm run dev
```
And watch the magic happen! ✨
All new migrations will automatically run before your server starts.
---
**Setup Date**: November 5, 2025
**Migration System**: TypeScript-based
**Auto-Run**: ✅ Enabled
**Total Migrations**: 14
**Status**: 🟢 Production Ready
**Team**: Royal Enfield .NET Expert Team
**Project**: Workflow Management System

751
SKIP_AND_ADD_APPROVER.md Normal file
View File

@ -0,0 +1,751 @@
# Skip Approver & Dynamic Approver Addition
## Overview
This feature allows initiators and approvers to manage approval workflows dynamically when approvers are unavailable or additional approval is needed.
### **Key Features:**
1. **Skip Approver** - Skip non-responding approvers and move to next level
2. **Add Approver at Specific Level** - Insert new approver at any position
3. **Automatic Level Shifting** - Existing approvers are automatically renumbered
4. **Smart Validation** - Cannot modify completed levels (approved/rejected/skipped)
5. **TAT Management** - New approvers get their own TAT, jobs scheduled automatically
---
## Use Cases
### **Use Case 1: Approver on Leave**
**Scenario:**
```
Level 1: Sarah (Approved) ✅
Level 2: Mike (Pending) ⏳ ← On vacation, not responding
Level 3: Lisa (Waiting) ⏸️
```
**Solution:**
```
Initiator clicks "Skip This Approver" on Level 2
→ Mike is marked as SKIPPED
→ Level 3 (Lisa) becomes active
→ Lisa receives notification
→ TAT jobs cancelled for Mike, scheduled for Lisa
```
**Result:**
```
Level 1: Sarah (Approved) ✅
Level 2: Mike (Skipped) ⏭️ ← Skipped
Level 3: Lisa (In Review) ⏳ ← Now active
```
---
### **Use Case 2: Add Additional Reviewer**
**Scenario:**
```
Level 1: Sarah (Approved) ✅
Level 2: Mike (In Review) ⏳
Level 3: Lisa (Waiting) ⏸️
```
**Need:** Add Finance Manager (John) between Mike and Lisa
**Solution:**
```
Click "Add Approver"
→ Email: john@example.com
→ TAT: 48 hours
→ Level: 3 (between Mike and Lisa)
→ Submit
```
**Result:**
```
Level 1: Sarah (Approved) ✅
Level 2: Mike (In Review) ⏳ ← Still at level 2
Level 3: John (Waiting) ⏸️ ← NEW! Inserted here
Level 4: Lisa (Waiting) ⏸️ ← Shifted from 3 to 4
```
---
### **Use Case 3: Replace Skipped Approver**
**Scenario:**
```
Level 1: Sarah (Approved) ✅
Level 2: Mike (Skipped) ⏭️
Level 3: Lisa (In Review) ⏳
```
**Need:** Add replacement for Mike at level 2
**Solution:**
```
Click "Add Approver"
→ Email: john@example.com
→ TAT: 24 hours
→ Level: 2 (Mike's old position)
→ Submit
```
**Result:**
```
Level 1: Sarah (Approved) ✅
Level 2: John (Waiting) ⏸️ ← NEW! Inserted at level 2
Level 3: Mike (Skipped) ⏭️ ← Shifted from 2 to 3
Level 4: Lisa (In Review) ⏳ ← Shifted from 3 to 4
```
---
## Database Schema
### **New Fields in `approval_levels` Table:**
```sql
-- Migration: add_is_skipped_to_approval_levels.sql
ALTER TABLE approval_levels
ADD COLUMN is_skipped BOOLEAN DEFAULT FALSE,
ADD COLUMN skipped_at TIMESTAMP,
ADD COLUMN skipped_by UUID REFERENCES users(user_id),
ADD COLUMN skip_reason TEXT;
```
### **Status Enum Update:**
Already includes `SKIPPED` status:
```sql
status ENUM('PENDING', 'IN_PROGRESS', 'APPROVED', 'REJECTED', 'SKIPPED')
```
### **Example Data:**
```sql
-- Level 2 was skipped
SELECT
level_number,
approver_name,
status,
is_skipped,
skipped_at,
skip_reason
FROM approval_levels
WHERE request_id = 'xxx';
-- Results:
-- 1 | Sarah | APPROVED | FALSE | NULL | NULL
-- 2 | Mike | SKIPPED | TRUE | 2025-11-05 | On vacation
-- 3 | Lisa | PENDING | FALSE | NULL | NULL
```
---
## API Endpoints
### **1. Skip Approver**
**Endpoint:**
```
POST /api/v1/workflows/:id/approvals/:levelId/skip
```
**Request Body:**
```json
{
"reason": "Approver on vacation - deadline approaching"
}
```
**Response:**
```json
{
"success": true,
"message": "Approver skipped successfully",
"data": {
"levelId": "...",
"levelNumber": 2,
"status": "SKIPPED",
"skippedAt": "2025-11-05T10:30:00Z"
}
}
```
**Logic:**
1. ✅ Mark level as `SKIPPED`
2. ✅ Cancel TAT jobs for skipped level
3. ✅ Activate next level (move to level+1)
4. ✅ Schedule TAT jobs for next level
5. ✅ Notify next approver
6. ✅ Log activity
**Validation:**
- ❌ Cannot skip already approved/rejected/skipped levels
- ❌ Cannot skip future levels (only current level)
- ✅ Only INITIATOR or APPROVER can skip
---
### **2. Add Approver at Specific Level**
**Endpoint:**
```
POST /api/v1/workflows/:id/approvers/at-level
```
**Request Body:**
```json
{
"email": "john@example.com",
"tatHours": 48,
"level": 3
}
```
**Response:**
```json
{
"success": true,
"message": "Approver added successfully",
"data": {
"levelId": "...",
"levelNumber": 3,
"approverName": "John Doe",
"tatHours": 48,
"status": "PENDING"
}
}
```
**Logic:**
1. ✅ Find user by email
2. ✅ Validate target level (must be after completed levels)
3. ✅ Shift existing levels at and after target level (+1)
4. ✅ Create new approval level at target position
5. ✅ Add as participant (APPROVER type)
6. ✅ If new level is current level, schedule TAT jobs
7. ✅ Notify new approver
8. ✅ Log activity
**Validation:**
- ❌ User must exist in system
- ❌ User cannot be existing participant
- ❌ Level must be after completed levels (approved/rejected/skipped)
- ✅ Automatic level shifting for existing approvers
---
## Level Shifting Logic
### **Example: Add at Level 3**
**Before:**
```
Level 1: Sarah (Approved) ✅
Level 2: Mike (In Review) ⏳
Level 3: Lisa (Waiting) ⏸️
Level 4: Tom (Waiting) ⏸️
```
**Action:**
```
Add John at Level 3 with 48h TAT
```
**Backend Processing:**
```typescript
// Step 1: Get levels to shift (levelNumber >= 3)
levelsToShift = [Lisa (Level 3), Tom (Level 4)]
// Step 2: Shift each level
Lisa: Level 3 → Level 4
Tom: Level 4 → Level 5
// Step 3: Insert new approver
John: Create at Level 3
// Step 4: Update workflow.totalLevels
totalLevels: 4 → 5
```
**After:**
```
Level 1: Sarah (Approved) ✅
Level 2: Mike (In Review) ⏳
Level 3: John (Waiting) ⏸️ ← NEW!
Level 4: Lisa (Waiting) ⏸️ ← Shifted from 3
Level 5: Tom (Waiting) ⏸️ ← Shifted from 4
```
---
## Frontend Implementation
### **AddApproverModal Enhancements:**
**New Props:**
```typescript
interface AddApproverModalProps {
open: boolean;
onClose: () => void;
onConfirm: (email: string, tatHours: number, level: number) => Promise<void>;
currentLevels?: ApprovalLevelInfo[]; // ✅ NEW!
}
interface ApprovalLevelInfo {
levelNumber: number;
approverName: string;
status: string;
tatHours: number;
}
```
**UI Components:**
1. **Current Levels Display** - Shows all existing levels with status badges
2. **Level Selector** - Dropdown with available levels (after completed)
3. **TAT Hours Input** - Number input for TAT (1-720 hours)
4. **Email Search** - Existing @ mention search
**Example Modal:**
```
┌─────────────────────────────────────────────────┐
│ Add Approver │
├─────────────────────────────────────────────────┤
│ Current Approval Levels │
│ ┌─────────────────────────────────────────────┐ │
│ │ [1] Sarah 50h TAT [✓] approved │ │
│ │ [2] Mike 24h TAT [⏳] pending │ │
│ │ [3] Lisa 36h TAT [⏸] waiting │ │
│ └─────────────────────────────────────────────┘ │
│ │
│ Approval Level * │
│ [Select: Level 2 (will shift existing Level 2)] │
│ │
│ TAT (Turn Around Time) * │
│ [48] hours │
│ │
│ Email Address * │
│ [@john or john@example.com] │
│ │
│ [Cancel] [Add at Level 2] │
└─────────────────────────────────────────────────┘
```
---
### **RequestDetail Skip Button:**
Added to Workflow tab for each pending/in-review level:
```tsx
{/* Skip Approver Button - Only for active levels */}
{(isActive || step.status === 'pending') && !isCompleted && !isRejected && (
<Button
variant="outline"
size="sm"
className="w-full border-orange-300 text-orange-700 hover:bg-orange-50"
onClick={() => {
const reason = prompt('Provide reason for skipping:');
if (reason !== null) {
handleSkipApprover(step.levelId, reason);
}
}}
>
<AlertCircle className="w-4 h-4 mr-2" />
Skip This Approver
</Button>
)}
```
---
## Validation Rules
### **Skip Approver Validation:**
| Rule | Validation | Error Message |
|------|-----------|---------------|
| Already completed | ❌ Cannot skip APPROVED level | "Cannot skip approver - level is already APPROVED" |
| Already rejected | ❌ Cannot skip REJECTED level | "Cannot skip approver - level is already REJECTED" |
| Already skipped | ❌ Cannot skip SKIPPED level | "Cannot skip approver - level is already SKIPPED" |
| Future level | ❌ Cannot skip level > currentLevel | "Cannot skip future approval levels" |
| Authorization | ✅ Only INITIATOR or APPROVER | 403 Forbidden |
---
### **Add Approver Validation:**
| Rule | Validation | Error Message |
|------|-----------|---------------|
| User exists | ✅ User must exist in system | "User not found with this email" |
| Already participant | ❌ Cannot add existing participant | "User is already a participant" |
| Level range | ❌ Level must be ≥ (completed levels + 1) | "Cannot add at level X. Minimum is Y" |
| TAT hours | ✅ 1 ≤ hours ≤ 720 | "TAT hours must be between 1 and 720" |
| Email format | ✅ Valid email format | "Please enter a valid email" |
| Authorization | ✅ Only INITIATOR or APPROVER | 403 Forbidden |
---
## Examples
### **Example 1: Skip Current Approver**
**Initial State:**
```
Request: REQ-2025-001
Current Level: 2
Level 1: Sarah (APPROVED) ✅
Level 2: Mike (IN_PROGRESS) ⏳ ← Taking too long
Level 3: Lisa (PENDING) ⏸️
```
**Action:**
```bash
# Initiator skips Mike
POST /api/v1/workflows/REQ-2025-001/approvals/LEVEL-ID-2/skip
Body: { "reason": "Approver on extended leave" }
```
**Backend Processing:**
```typescript
1. Get Level 2 (Mike) → Status: IN_PROGRESS ✅
2. Validate: Not already completed ✅
3. Update Level 2:
- status: 'SKIPPED'
- is_skipped: TRUE
- skipped_at: NOW()
- skipped_by: initiator userId
- skip_reason: "Approver on extended leave"
4. Cancel TAT jobs for Level 2
5. Get Level 3 (Lisa)
6. Activate Level 3:
- status: 'IN_PROGRESS'
- levelStartTime: NOW()
- tatStartTime: NOW()
7. Schedule TAT jobs for Level 3
8. Update workflow.currentLevel = 3
9. Notify Lisa
10. Log activity: "Level 2 approver (Mike) was skipped"
```
**Final State:**
```
Request: REQ-2025-001
Current Level: 3
Level 1: Sarah (APPROVED) ✅
Level 2: Mike (SKIPPED) ⏭️ ← Skipped!
Level 3: Lisa (IN_PROGRESS) ⏳ ← Now active!
```
---
### **Example 2: Add Approver Between Levels**
**Initial State:**
```
Request: REQ-2025-001
Current Level: 2
Level 1: Sarah (APPROVED) ✅
Level 2: Mike (IN_PROGRESS) ⏳
Level 3: Lisa (PENDING) ⏸️
```
**Action:**
```bash
# Add John at Level 3 (between Mike and Lisa)
POST /api/v1/workflows/REQ-2025-001/approvers/at-level
Body: {
"email": "john@example.com",
"tatHours": 48,
"level": 3
}
```
**Backend Processing:**
```typescript
1. Find user: john@example.com ✅
2. Validate: Not existing participant ✅
3. Validate: Level 3 ≥ minLevel (2) ✅
4. Get levels to shift: [Lisa (Level 3)]
5. Shift Lisa:
- Level 3 → Level 4
- levelName: "Level 4"
6. Create new Level 3:
- levelNumber: 3
- approverId: John's userId
- approverEmail: john@example.com
- tatHours: 48
- status: PENDING (not current level)
7. Update workflow.totalLevels: 3 → 4
8. Add John to participants (APPROVER type)
9. Notify John
10. Log activity: "John added as approver at Level 3 with TAT of 48 hours"
```
**Final State:**
```
Request: REQ-2025-001
Current Level: 2
Level 1: Sarah (APPROVED) ✅
Level 2: Mike (IN_PROGRESS) ⏳ ← Still working
Level 3: John (PENDING) ⏸️ ← NEW! Will review after Mike
Level 4: Lisa (PENDING) ⏸️ ← Shifted from 3 to 4
```
---
### **Example 3: Complex Scenario - Skip and Add**
**Initial State:**
```
Level 1: Sarah (APPROVED) ✅
Level 2: Mike (APPROVED) ✅
Level 3: David (IN_PROGRESS) ⏳ ← Taking too long
Level 4: Lisa (PENDING) ⏸️
Level 5: Tom (PENDING) ⏸️
```
**Action 1: Skip David**
```
Result:
Level 1: Sarah (APPROVED) ✅
Level 2: Mike (APPROVED) ✅
Level 3: David (SKIPPED) ⏭️
Level 4: Lisa (IN_PROGRESS) ⏳ ← Now active
Level 5: Tom (PENDING) ⏸️
```
**Action 2: Add John at Level 4 (before Tom)**
```
Result:
Level 1: Sarah (APPROVED) ✅
Level 2: Mike (APPROVED) ✅
Level 3: David (SKIPPED) ⏭️
Level 4: Lisa (IN_PROGRESS) ⏳
Level 5: John (PENDING) ⏸️ ← NEW!
Level 6: Tom (PENDING) ⏸️ ← Shifted
```
---
## UI/UX
### **RequestDetail - Workflow Tab:**
**Skip Button Visibility:**
- ✅ Shows for levels with status: `pending` or `in-review`
- ❌ Hidden for `approved`, `rejected`, `skipped`, or `waiting`
- ✅ Orange/amber styling to indicate caution
- ✅ Requires reason via prompt
**Button Appearance:**
```tsx
┌───────────────────────────────────────────┐
│ Level 2: Mike (In Review) │
│ TAT: 24h • Elapsed: 15h │
│ │
│ [⚠ Skip This Approver] │
│ Skip if approver is unavailable... │
└───────────────────────────────────────────┘
```
---
### **AddApproverModal - Enhanced UI:**
**Sections:**
1. **Current Levels** - Scrollable list showing all existing levels with status
2. **Level Selector** - Dropdown with available levels (grayed out completed levels)
3. **TAT Input** - Hours input with validation (1-720)
4. **Email Search** - @ mention search (existing)
**Features:**
- ✅ Auto-selects first available level
- ✅ Shows which existing level will be shifted
- ✅ Visual indicators for completed vs pending levels
- ✅ Prevents selecting invalid levels
- ✅ Real-time validation
---
## Activity Log Examples
### **Skip Approver Log:**
```
Action: Approver Skipped
Details: Level 2 approver (Mike Johnson) was skipped by Sarah Smith.
Reason: Approver on extended leave
Timestamp: 2025-11-05 10:30:00
User: Sarah Smith (Initiator)
```
### **Add Approver Log:**
```
Action: Added new approver
Details: John Doe (john@example.com) has been added as approver at
Level 3 with TAT of 48 hours by Sarah Smith
Timestamp: 2025-11-05 11:15:00
User: Sarah Smith (Initiator)
```
---
## Notifications
### **Skip Approver Notifications:**
**To Next Approver:**
```
Title: Request Escalated
Body: Previous approver was skipped. Request REQ-2025-001 is now
awaiting your approval.
```
---
### **Add Approver Notifications:**
**To New Approver:**
```
Title: New Request Assignment
Body: You have been added as Level 3 approver to request REQ-2025-001:
New Office Location Approval
```
---
## TAT Handling
### **Skip Approver:**
```typescript
// Skipped level's TAT jobs are cancelled
await tatSchedulerService.cancelTatJobs(requestId, skippedLevelId);
// Next level's TAT jobs are scheduled
await tatSchedulerService.scheduleTatJobs(
requestId,
nextLevelId,
nextApproverId,
nextLevelTatHours,
now,
workflowPriority
);
```
### **Add Approver:**
```typescript
// If new approver is at current level, schedule TAT immediately
if (newLevel === currentLevel) {
await tatSchedulerService.scheduleTatJobs(
requestId,
newLevelId,
newApproverId,
tatHours,
now,
workflowPriority
);
}
// Otherwise, jobs will be scheduled when level becomes active
```
---
## Testing Scenarios
### **Test 1: Skip Current Approver**
```bash
# 1. Create workflow with 3 approvers
# 2. Level 1 approves
# 3. Level 2 receives notification
# 4. Level 2 doesn't respond for extended time
# 5. Initiator clicks "Skip This Approver"
# 6. Provide reason: "On vacation"
# 7. Verify:
# ✅ Level 2 status = SKIPPED
# ✅ Level 3 status = IN_PROGRESS
# ✅ Level 3 receives notification
# ✅ TAT jobs scheduled for Level 3
# ✅ Activity logged
```
### **Test 2: Add Approver at Middle Level**
```bash
# 1. Workflow has 3 levels
# 2. Level 1 approved
# 3. Click "Add Approver"
# 4. Select Level 2 (between current levels)
# 5. Enter TAT: 48
# 6. Enter email: new@example.com
# 7. Submit
# 8. Verify:
# ✅ Old Level 2 becomes Level 3
# ✅ Old Level 3 becomes Level 4
# ✅ New approver at Level 2
# ✅ totalLevels increased by 1
# ✅ New approver receives notification
```
### **Test 3: Cannot Add Before Completed Level**
```bash
# 1. Workflow: Level 1 (Approved), Level 2 (Pending)
# 2. Try to add at Level 1
# 3. Modal shows: "Minimum allowed level is 2"
# 4. Level 1 is grayed out in selector
# 5. Cannot submit ✅
```
---
## Files Modified
### **Backend:**
1. `Re_Backend/src/migrations/add_is_skipped_to_approval_levels.sql` - Database migration
2. `Re_Backend/src/services/workflow.service.ts` - Skip and add approver logic
3. `Re_Backend/src/routes/workflow.routes.ts` - API endpoints
### **Frontend:**
4. `Re_Figma_Code/src/services/workflowApi.ts` - API client methods
5. `Re_Figma_Code/src/components/participant/AddApproverModal/AddApproverModal.tsx` - Enhanced modal
6. `Re_Figma_Code/src/pages/RequestDetail/RequestDetail.tsx` - Skip button and handlers
---
## Summary
| Feature | Description | Benefit |
|---------|-------------|---------|
| **Skip Approver** | Mark approver as skipped, move to next | Handle unavailable approvers |
| **Add at Level** | Insert approver at specific position | Flexible workflow modification |
| **Auto Shifting** | Existing levels automatically renumbered | No manual level management |
| **Smart Validation** | Cannot modify completed levels | Data integrity |
| **TAT Management** | Jobs cancelled/scheduled automatically | Accurate time tracking |
| **Activity Logging** | All actions tracked in audit trail | Full transparency |
| **Notifications** | Affected users notified automatically | Keep everyone informed |
---
## Benefits
1. ✅ **Flexibility** - Handle real-world workflow changes
2. ✅ **No Bottlenecks** - Skip unavailable approvers
3. ✅ **Dynamic Addition** - Add approvers mid-workflow
4. ✅ **Data Integrity** - Cannot modify completed levels
5. ✅ **Audit Trail** - Full history of all changes
6. ✅ **Automatic Notifications** - All affected parties notified
7. ✅ **TAT Accuracy** - Time tracking updated correctly
8. ✅ **User-Friendly** - Intuitive UI with clear feedback
The approval workflow is now fully dynamic and can adapt to changing business needs! 🚀

524
SMART_MIGRATIONS_COMPLETE.md Normal file
View File

@ -0,0 +1,524 @@
# ✅ Smart Migration System Complete
## 🎯 What You Asked For
> "Every time if I do npm run dev, migrations are running right? If that already exist then skip, if it is new tables then do migrations"
**✅ DONE!** Your migration system is now intelligent and efficient.
---
## 🧠 How It Works Now
### Smart Migration Tracking
The system now includes:
1. **🗃️ Migrations Tracking Table**
- Automatically created on first run
- Stores which migrations have been executed
- Prevents duplicate execution
2. **⏭️ Smart Detection**
- Checks which migrations already ran
- Only executes **new/pending** migrations
- Skips already-completed ones
3. **🛡️ Idempotent Migrations**
- Safe to run multiple times
- Checks if tables/columns exist before creating
- No errors if schema already matches
---
## 📊 What Happens When You Run `npm run dev`
### First Time (Fresh Database)
```
📦 Database connected
✅ Created migrations tracking table
🔄 Running 14 pending migration(s)...
⏳ Running: 2025103001-create-workflow-requests
✅ Created workflow_requests table
✅ Completed: 2025103001-create-workflow-requests
⏳ Running: 2025103002-create-approval-levels
✅ Created approval_levels table
✅ Completed: 2025103002-create-approval-levels
... (all 14 migrations run)
✅ Successfully applied 14 migration(s)
📊 Total migrations: 14
🚀 Server running on port 5000
```
### Second Time (All Migrations Already Run)
```
📦 Database connected
✅ All migrations are up-to-date (no new migrations to run)
🚀 Server running on port 5000
```
**⚡ Instant startup! No migration overhead!**
### When You Add a New Migration
```
📦 Database connected
🔄 Running 1 pending migration(s)...
⏳ Running: 20251106-new-feature
✅ Added new column
✅ Completed: 20251106-new-feature
✅ Successfully applied 1 migration(s)
📊 Total migrations: 15
🚀 Server running on port 5000
```
**Only the NEW migration runs!**
---
## 🔧 Technical Implementation
### 1. Migration Tracking Database
Automatically created table:
```sql
CREATE TABLE migrations (
id SERIAL PRIMARY KEY,
name VARCHAR(255) NOT NULL UNIQUE,
executed_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
)
```
Tracks:
- ✅ Which migrations have been executed
- ✅ When they were executed
- ✅ Prevents duplicate execution via UNIQUE constraint
### 2. Smart Migration Runner
**File**: `src/scripts/migrate.ts`
**Key Features**:
```typescript
// 1. Check what's already been run
const executedMigrations = await getExecutedMigrations();
// 2. Find only new/pending migrations
const pendingMigrations = migrations.filter(
m => !executedMigrations.includes(m.name)
);
// 3. Skip if nothing to do
if (pendingMigrations.length === 0) {
console.log('✅ All migrations up-to-date');
return;
}
// 4. Run only pending migrations
for (const migration of pendingMigrations) {
await migration.module.up(queryInterface);
await markMigrationExecuted(migration.name);
}
```
### 3. Idempotent Migrations
**Example**: `20251105-add-skip-fields-to-approval-levels.ts`
**Checks before acting**:
```typescript
// Check if table exists
const tables = await queryInterface.showAllTables();
if (!tables.includes('approval_levels')) {
return; // Skip if table doesn't exist
}
// Check if column exists
const tableDescription = await queryInterface.describeTable('approval_levels');
if (!tableDescription.is_skipped) {
await queryInterface.addColumn(/* ... */);
}
// Check if index exists
const indexes = await queryInterface.showIndex('approval_levels');
const indexExists = indexes.some(idx => idx.name === 'idx_name');
if (!indexExists) {
await queryInterface.addIndex(/* ... */);
}
```
**Safe to run multiple times!**
---
## 🚀 Usage Examples
### Daily Development Workflow
```bash
# Morning - start work
npm run dev
# ✅ All up-to-date - server starts immediately
# After pulling new code with migration
git pull origin main
npm run dev
# 🔄 Runs only the new migration
# ✅ Server starts
```
### Adding a New Migration
```bash
# 1. Create migration file
# src/migrations/20251106-add-user-preferences.ts
# 2. Register in migrate.ts
# (add import and execution)
# 3. Test
npm run dev
# 🔄 Runs only your new migration
# 4. Run again to verify idempotency
npm run dev
# ✅ All up-to-date (doesn't run again)
```
### Manual Migration Run
```bash
npm run migrate
# Same smart behavior, without starting server
```
---
## 📋 Current Migration Status
All 14 migrations are now tracked:
| # | Migration | Status |
|---|-----------|--------|
| 1 | 2025103001-create-workflow-requests | ✅ Tracked |
| 2 | 2025103002-create-approval-levels | ✅ Tracked |
| 3 | 2025103003-create-participants | ✅ Tracked |
| 4 | 2025103004-create-documents | ✅ Tracked |
| 5 | 20251031_01_create_subscriptions | ✅ Tracked |
| 6 | 20251031_02_create_activities | ✅ Tracked |
| 7 | 20251031_03_create_work_notes | ✅ Tracked |
| 8 | 20251031_04_create_work_note_attachments | ✅ Tracked |
| 9 | 20251104-add-tat-alert-fields | ✅ Tracked |
| 10 | 20251104-create-tat-alerts | ✅ Tracked |
| 11 | 20251104-create-kpi-views | ✅ Tracked |
| 12 | 20251104-create-holidays | ✅ Tracked |
| 13 | 20251104-create-admin-config | ✅ Tracked |
| 14 | 20251105-add-skip-fields-to-approval-levels | ✅ Tracked & Idempotent |
---
## ✨ Key Benefits
### For You (Developer)
- ✅ **Fast Restarts** - No waiting for already-run migrations
- ✅ **No Errors** - Safe to run `npm run dev` anytime
- ✅ **Auto-Detection** - System knows what's new
- ✅ **Zero Configuration** - Just works
### For Team
- ✅ **Consistent State** - Everyone's database in sync
- ✅ **Easy Onboarding** - New devs run once, all migrates
- ✅ **No Coordination** - No "did you run migrations?" questions
- ✅ **Pull & Run** - Git pull + npm run dev = ready
### For Production
- ✅ **Safe Deployments** - Won't break if run multiple times
- ✅ **Version Control** - Clear migration history
- ✅ **Rollback Support** - Each migration has down() function
- ✅ **Audit Trail** - migrations table shows execution history
---
## 🎓 Best Practices Implemented
### 1. Idempotency
✅ All migrations check existence before creating
✅ Safe to run multiple times
✅ No duplicate errors
### 2. Tracking
✅ Dedicated migrations table
✅ Unique constraint prevents duplicates
✅ Timestamp for audit trail
### 3. Smart Execution
✅ Only runs pending migrations
✅ Maintains execution order
✅ Fails fast on errors
### 4. Developer Experience
✅ Clear console output
✅ Progress indicators
✅ Helpful error messages
---
## 📝 Adding New Migrations
### Template for Idempotent Migrations
```typescript
import { QueryInterface, DataTypes } from 'sequelize';
export async function up(queryInterface: QueryInterface): Promise<void> {
// 1. Check if table exists (for new tables)
const tables = await queryInterface.showAllTables();
if (!tables.includes('my_table')) {
await queryInterface.createTable('my_table', {/* ... */});
console.log(' ✅ Created my_table');
return;
}
// 2. Check if column exists (for new columns)
const tableDesc = await queryInterface.describeTable('existing_table');
if (!tableDesc.new_column) {
await queryInterface.addColumn('existing_table', 'new_column', {
type: DataTypes.STRING
});
console.log(' ✅ Added new_column');
}
// 3. Check if index exists (for new indexes)
try {
const indexes: any[] = await queryInterface.showIndex('my_table') as any[];
const indexExists = Array.isArray(indexes) &&
indexes.some((idx: any) => idx.name === 'idx_name');
if (!indexExists) {
await queryInterface.addIndex('my_table', ['column'], {
name: 'idx_name'
});
console.log(' ✅ Added idx_name');
}
} catch (error) {
console.log(' ℹ️ Index handling skipped');
}
console.log('✅ Migration completed');
}
export async function down(queryInterface: QueryInterface): Promise<void> {
// Rollback logic
await queryInterface.removeColumn('my_table', 'new_column');
console.log('✅ Rollback completed');
}
```
### Steps to Add New Migration
1. **Create File**: `src/migrations/YYYYMMDD-description.ts`
2. **Write Migration**: Use idempotent template above
3. **Register**: Add to `src/scripts/migrate.ts`:
```typescript
import * as m15 from '../migrations/20251106-description';
const migrations: Migration[] = [
// ... existing ...
{ name: '20251106-description', module: m15 },
];
```
4. **Test**: Run `npm run dev` - only new migration executes
5. **Verify**: Run `npm run dev` again - should skip (already executed)
---
## 🧪 Testing the System
### Test 1: First Run
```bash
# Drop database (if testing)
# Then run:
npm run dev
# Expected: All 14 migrations run
# migrations table created
# Server starts
```
### Test 2: Second Run
```bash
npm run dev
# Expected: "All migrations up-to-date"
# No migrations run
# Instant server start
```
### Test 3: New Migration
```bash
# Add migration #15
npm run dev
# Expected: Only migration #15 runs
# Shows "Running 1 pending migration"
# Server starts
```
### Test 4: Verify Tracking
```bash
# In PostgreSQL:
SELECT * FROM migrations ORDER BY id;
# Should show all executed migrations with timestamps
```
---
## 🔍 Monitoring Migration Status
### Check Database Directly
```sql
-- See all executed migrations
SELECT id, name, executed_at
FROM migrations
ORDER BY id;
-- Count migrations
SELECT COUNT(*) as total_migrations FROM migrations;
-- Latest migration
SELECT name, executed_at
FROM migrations
ORDER BY id DESC
LIMIT 1;
```
### Check via Application
```bash
# Run migration script
npm run migrate
# Output shows:
# - Total migrations in code
# - Already executed count
# - Pending count
```
---
## 🚨 Troubleshooting
### Issue: "Table already exists"
**Solution**: This shouldn't happen now! But if it does:
- Migration might not be idempotent
- Add table existence check
- See idempotent template above
### Issue: "Column already exists"
**Solution**: Add column existence check:
```typescript
const tableDesc = await queryInterface.describeTable('table');
if (!tableDesc.column_name) {
await queryInterface.addColumn(/* ... */);
}
```
### Issue: Migration runs every time
**Cause**: Not being marked as executed
**Check**:
```sql
SELECT * FROM migrations WHERE name = 'migration-name';
```
If missing, the marking step failed.
### Issue: Need to rerun a migration
**Solution**:
```sql
-- Remove from tracking (use with caution!)
DELETE FROM migrations WHERE name = 'migration-name';
-- Then run
npm run migrate
```
---
## 📊 System Architecture
```
npm run dev
↓
migrate.ts runs
↓
Check: migrations table exists?
↓ No → Create it
↓ Yes → Continue
↓
Query: SELECT * FROM migrations
↓
Compare: Code migrations vs DB migrations
↓
Pending = Code - DB
↓
If pending = 0
↓ → "All up-to-date" → Start server
↓
If pending > 0
↓
For each pending migration:
↓
Run migration.up()
↓
INSERT INTO migrations
↓
Mark as complete
↓
All done → Start server
```
---
## 🎯 Summary
### What Changed
| Before | After |
|--------|-------|
| All migrations run every time | Only new migrations run |
| Errors if tables exist | Smart checks prevent errors |
| No tracking | Migrations table tracks history |
| Slow restarts | Fast restarts |
| Manual coordination needed | Automatic detection |
### What You Get
✅ **Smart Detection** - Knows what's already been run
✅ **Fast Execution** - Only runs new migrations
✅ **Error Prevention** - Idempotent checks
✅ **Clear Feedback** - Detailed console output
✅ **Audit Trail** - migrations table for history
✅ **Team-Friendly** - Everyone stays in sync automatically
---
## 🚀 You're Ready!
Just run:
```bash
npm run dev
```
**First time**: All migrations execute, database is set up
**Every time after**: Lightning fast, only new migrations run
**Pull new code**: Automatically detects and runs new migrations
**No manual steps. No coordination needed. Just works!** ✨
---
**System**: Smart Migration Tracking ✅
**Idempotency**: Enabled ✅
**Auto-Detect**: Active ✅
**Status**: Production Ready 🟢
**Date**: November 5, 2025

2
package.json
View File

@ -5,7 +5,7 @@
"main": "dist/server.js", "main": "dist/server.js",
"scripts": { "scripts": {
"start": "node dist/server.js", "start": "node dist/server.js",
"dev": "nodemon --exec ts-node -r tsconfig-paths/register src/server.ts", "dev": "npm run migrate && nodemon --exec ts-node -r tsconfig-paths/register src/server.ts",
"build": "tsc", "build": "tsc",
"build:watch": "tsc --watch", "build:watch": "tsc --watch",
"start:prod": "NODE_ENV=production node dist/server.js", "start:prod": "NODE_ENV=production node dist/server.js",

163
src/config/system.config.ts Normal file
View File

@ -0,0 +1,163 @@
/**
* System-wide Configuration
* Central configuration file for the Royal Enfield Workflow Management System
* All settings can be overridden via environment variables
*/
export const SYSTEM_CONFIG = {
// Application Information
APP_NAME: 'Royal Enfield Workflow Management',
APP_VERSION: '1.2.0',
APP_ENV: process.env.NODE_ENV || 'development',
// Working Hours Configuration
WORKING_HOURS: {
START_HOUR: parseInt(process.env.WORK_START_HOUR || '9', 10),
END_HOUR: parseInt(process.env.WORK_END_HOUR || '18', 10),
START_DAY: 1, // Monday
END_DAY: 5, // Friday
TIMEZONE: process.env.TZ || 'Asia/Kolkata',
},
// TAT (Turnaround Time) Settings
TAT: {
// Notification thresholds (percentage)
THRESHOLD_50_PERCENT: 50,
THRESHOLD_75_PERCENT: 75,
THRESHOLD_100_PERCENT: 100,
// Test mode for faster testing
TEST_MODE: process.env.TAT_TEST_MODE === 'true',
TEST_TIME_MULTIPLIER: process.env.TAT_TEST_MODE === 'true' ? 1/60 : 1, // 1 hour = 1 minute in test mode
// Default TAT values by priority (in hours)
DEFAULT_EXPRESS_TAT: parseInt(process.env.DEFAULT_EXPRESS_TAT || '24', 10),
DEFAULT_STANDARD_TAT: parseInt(process.env.DEFAULT_STANDARD_TAT || '72', 10),
},
// File Upload Limits
UPLOAD: {
MAX_FILE_SIZE_MB: parseInt(process.env.MAX_FILE_SIZE_MB || '10', 10),
MAX_FILE_SIZE_BYTES: parseInt(process.env.MAX_FILE_SIZE_MB || '10', 10) * 1024 * 1024,
ALLOWED_FILE_TYPES: ['pdf', 'doc', 'docx', 'xls', 'xlsx', 'ppt', 'pptx', 'jpg', 'jpeg', 'png', 'gif', 'txt'],
MAX_FILES_PER_REQUEST: parseInt(process.env.MAX_FILES_PER_REQUEST || '10', 10),
},
// Workflow Limits
WORKFLOW: {
MAX_APPROVAL_LEVELS: parseInt(process.env.MAX_APPROVAL_LEVELS || '10', 10),
MAX_PARTICIPANTS: parseInt(process.env.MAX_PARTICIPANTS_PER_REQUEST || '50', 10),
MAX_SPECTATORS: parseInt(process.env.MAX_SPECTATORS || '20', 10),
MIN_APPROVAL_LEVELS: 1,
},
// Work Notes Configuration
WORK_NOTES: {
MAX_MESSAGE_LENGTH: parseInt(process.env.MAX_MESSAGE_LENGTH || '2000', 10),
MAX_ATTACHMENTS_PER_NOTE: parseInt(process.env.MAX_ATTACHMENTS_PER_NOTE || '5', 10),
ENABLE_REACTIONS: process.env.ENABLE_REACTIONS !== 'false',
ENABLE_MENTIONS: process.env.ENABLE_MENTIONS !== 'false',
},
// Pagination
PAGINATION: {
DEFAULT_PAGE_SIZE: parseInt(process.env.DEFAULT_PAGE_SIZE || '20', 10),
MAX_PAGE_SIZE: parseInt(process.env.MAX_PAGE_SIZE || '100', 10),
},
// Session & Security
SECURITY: {
SESSION_TIMEOUT_MINUTES: parseInt(process.env.SESSION_TIMEOUT_MINUTES || '480', 10), // 8 hours
JWT_EXPIRY: process.env.JWT_EXPIRY || '8h',
ENABLE_2FA: process.env.ENABLE_2FA === 'true',
},
// Notification Settings
NOTIFICATIONS: {
ENABLE_EMAIL: process.env.ENABLE_EMAIL_NOTIFICATIONS !== 'false',
ENABLE_PUSH: process.env.ENABLE_PUSH_NOTIFICATIONS !== 'false',
ENABLE_IN_APP: true, // Always enabled
BATCH_DELAY_MS: parseInt(process.env.NOTIFICATION_BATCH_DELAY || '5000', 10),
},
// Feature Flags
FEATURES: {
ENABLE_AI_CONCLUSION: process.env.ENABLE_AI_CONCLUSION !== 'false',
ENABLE_TEMPLATES: process.env.ENABLE_TEMPLATES === 'true', // Future feature
ENABLE_ANALYTICS: process.env.ENABLE_ANALYTICS !== 'false',
ENABLE_EXPORT: process.env.ENABLE_EXPORT !== 'false',
},
// Redis & Queue
REDIS: {
URL: process.env.REDIS_URL || 'redis://localhost:6379',
QUEUE_CONCURRENCY: parseInt(process.env.QUEUE_CONCURRENCY || '5', 10),
RATE_LIMIT_MAX: parseInt(process.env.RATE_LIMIT_MAX || '10', 10),
RATE_LIMIT_DURATION: parseInt(process.env.RATE_LIMIT_DURATION || '1000', 10),
},
// UI Preferences (can be overridden per user in future)
UI: {
DEFAULT_THEME: 'light',
DEFAULT_LANGUAGE: 'en',
DATE_FORMAT: 'DD/MM/YYYY',
TIME_FORMAT: '12h', // or '24h'
CURRENCY: 'INR',
CURRENCY_SYMBOL: '₹',
},
};
/**
* Get configuration for frontend consumption
* Returns only non-sensitive configuration values
*/
export function getPublicConfig() {
return {
appName: SYSTEM_CONFIG.APP_NAME,
appVersion: SYSTEM_CONFIG.APP_VERSION,
workingHours: SYSTEM_CONFIG.WORKING_HOURS,
tat: {
thresholds: {
warning: SYSTEM_CONFIG.TAT.THRESHOLD_50_PERCENT,
critical: SYSTEM_CONFIG.TAT.THRESHOLD_75_PERCENT,
breach: SYSTEM_CONFIG.TAT.THRESHOLD_100_PERCENT,
},
testMode: SYSTEM_CONFIG.TAT.TEST_MODE,
},
upload: {
maxFileSizeMB: SYSTEM_CONFIG.UPLOAD.MAX_FILE_SIZE_MB,
allowedFileTypes: SYSTEM_CONFIG.UPLOAD.ALLOWED_FILE_TYPES,
maxFilesPerRequest: SYSTEM_CONFIG.UPLOAD.MAX_FILES_PER_REQUEST,
},
workflow: {
maxApprovalLevels: SYSTEM_CONFIG.WORKFLOW.MAX_APPROVAL_LEVELS,
maxParticipants: SYSTEM_CONFIG.WORKFLOW.MAX_PARTICIPANTS,
maxSpectators: SYSTEM_CONFIG.WORKFLOW.MAX_SPECTATORS,
},
workNotes: {
maxMessageLength: SYSTEM_CONFIG.WORK_NOTES.MAX_MESSAGE_LENGTH,
maxAttachmentsPerNote: SYSTEM_CONFIG.WORK_NOTES.MAX_ATTACHMENTS_PER_NOTE,
enableReactions: SYSTEM_CONFIG.WORK_NOTES.ENABLE_REACTIONS,
enableMentions: SYSTEM_CONFIG.WORK_NOTES.ENABLE_MENTIONS,
},
features: SYSTEM_CONFIG.FEATURES,
ui: SYSTEM_CONFIG.UI,
};
}
/**
* Log system configuration on startup
*/
export function logSystemConfig(): void {
console.log('⚙️ System Configuration:');
console.log(` - Environment: ${SYSTEM_CONFIG.APP_ENV}`);
console.log(` - Version: ${SYSTEM_CONFIG.APP_VERSION}`);
console.log(` - Working Hours: ${SYSTEM_CONFIG.WORKING_HOURS.START_HOUR}:00 - ${SYSTEM_CONFIG.WORKING_HOURS.END_HOUR}:00`);
console.log(` - Max File Size: ${SYSTEM_CONFIG.UPLOAD.MAX_FILE_SIZE_MB} MB`);
console.log(` - Max Approval Levels: ${SYSTEM_CONFIG.WORKFLOW.MAX_APPROVAL_LEVELS}`);
console.log(` - AI Conclusion: ${SYSTEM_CONFIG.FEATURES.ENABLE_AI_CONCLUSION ? 'Enabled' : 'Disabled'}`);
console.log(` - TAT Test Mode: ${SYSTEM_CONFIG.TAT.TEST_MODE ? 'ENABLED (1h = 1min)' : 'DISABLED'}`);
}
export default SYSTEM_CONFIG;

37
src/config/tat.config.ts
View File

@ -1,36 +1,37 @@
/** /**
* TAT (Turnaround Time) Configuration * TAT (Turnaround Time) Configuration
* *
* This file contains configuration for TAT notifications and testing * This file re-exports TAT-related configuration from the centralized system config
* Kept for backward compatibility
*/ */
import { SYSTEM_CONFIG } from './system.config';
export const TAT_CONFIG = { export const TAT_CONFIG = {
// Working hours configuration // Working hours configuration (from system config)
WORK_START_HOUR: parseInt(process.env.WORK_START_HOUR || '9', 10), WORK_START_HOUR: SYSTEM_CONFIG.WORKING_HOURS.START_HOUR,
WORK_END_HOUR: parseInt(process.env.WORK_END_HOUR || '18', 10), WORK_END_HOUR: SYSTEM_CONFIG.WORKING_HOURS.END_HOUR,
// Working days (1 = Monday, 5 = Friday) // Working days (1 = Monday, 5 = Friday)
WORK_START_DAY: 1, WORK_START_DAY: SYSTEM_CONFIG.WORKING_HOURS.START_DAY,
WORK_END_DAY: 5, WORK_END_DAY: SYSTEM_CONFIG.WORKING_HOURS.END_DAY,
// TAT notification thresholds (percentage) // TAT notification thresholds (percentage)
THRESHOLD_50_PERCENT: 50, THRESHOLD_50_PERCENT: SYSTEM_CONFIG.TAT.THRESHOLD_50_PERCENT,
THRESHOLD_75_PERCENT: 75, THRESHOLD_75_PERCENT: SYSTEM_CONFIG.TAT.THRESHOLD_75_PERCENT,
THRESHOLD_100_PERCENT: 100, THRESHOLD_100_PERCENT: SYSTEM_CONFIG.TAT.THRESHOLD_100_PERCENT,
// Testing mode - Set to true for faster notifications in development // Testing mode
TEST_MODE: process.env.TAT_TEST_MODE === 'true', TEST_MODE: SYSTEM_CONFIG.TAT.TEST_MODE,
TEST_TIME_MULTIPLIER: SYSTEM_CONFIG.TAT.TEST_TIME_MULTIPLIER,
// In test mode, use minutes instead of hours (1 hour = 1 minute)
TEST_TIME_MULTIPLIER: process.env.TAT_TEST_MODE === 'true' ? 1/60 : 1,
// Redis configuration // Redis configuration
REDIS_URL: process.env.REDIS_URL || 'redis://localhost:6379', REDIS_URL: SYSTEM_CONFIG.REDIS.URL,
// Queue configuration // Queue configuration
QUEUE_CONCURRENCY: 5, QUEUE_CONCURRENCY: SYSTEM_CONFIG.REDIS.QUEUE_CONCURRENCY,
QUEUE_RATE_LIMIT_MAX: 10, QUEUE_RATE_LIMIT_MAX: SYSTEM_CONFIG.REDIS.RATE_LIMIT_MAX,
QUEUE_RATE_LIMIT_DURATION: 1000, QUEUE_RATE_LIMIT_DURATION: SYSTEM_CONFIG.REDIS.RATE_LIMIT_DURATION,
// Retry configuration // Retry configuration
MAX_RETRY_ATTEMPTS: 3, MAX_RETRY_ATTEMPTS: 3,

53
src/controllers/admin.controller.ts
View File

@ -4,7 +4,8 @@ import { holidayService } from '@services/holiday.service';
import { sequelize } from '@config/database'; import { sequelize } from '@config/database';
import { QueryTypes } from 'sequelize'; import { QueryTypes } from 'sequelize';
import logger from '@utils/logger'; import logger from '@utils/logger';
import { initializeHolidaysCache } from '@utils/tatTimeUtils'; import { initializeHolidaysCache, clearWorkingHoursCache } from '@utils/tatTimeUtils';
import { clearConfigCache } from '@services/configReader.service';
/** /**
* Get all holidays (with optional year filter) * Get all holidays (with optional year filter)
@ -250,7 +251,7 @@ export const getAllConfigurations = async (req: Request, res: Response): Promise
whereClause = `WHERE config_category = '${category}'`; whereClause = `WHERE config_category = '${category}'`;
} }
const configurations = await sequelize.query(` const rawConfigurations = await sequelize.query(`
SELECT SELECT
config_id, config_id,
config_key, config_key,
@ -274,9 +275,31 @@ export const getAllConfigurations = async (req: Request, res: Response): Promise
ORDER BY config_category, sort_order ORDER BY config_category, sort_order
`, { type: QueryTypes.SELECT }); `, { type: QueryTypes.SELECT });
// Map snake_case to camelCase for frontend
const configurations = (rawConfigurations as any[]).map((config: any) => ({
configId: config.config_id,
configKey: config.config_key,
configCategory: config.config_category,
configValue: config.config_value,
valueType: config.value_type,
displayName: config.display_name,
description: config.description,
defaultValue: config.default_value,
isEditable: config.is_editable,
isSensitive: config.is_sensitive || false,
validationRules: config.validation_rules,
uiComponent: config.ui_component,
options: config.options,
sortOrder: config.sort_order,
requiresRestart: config.requires_restart || false,
lastModifiedAt: config.last_modified_at,
lastModifiedBy: config.last_modified_by
}));
res.json({ res.json({
success: true, success: true,
data: configurations data: configurations,
count: configurations.length
}); });
} catch (error) { } catch (error) {
logger.error('[Admin] Error fetching configurations:', error); logger.error('[Admin] Error fetching configurations:', error);
@ -336,6 +359,18 @@ export const updateConfiguration = async (req: Request, res: Response): Promise<
return; return;
} }
// Clear config cache so new values are used immediately
clearConfigCache();
// If working hours config was updated, also clear working hours cache
const workingHoursKeys = ['WORK_START_HOUR', 'WORK_END_HOUR', 'WORK_START_DAY', 'WORK_END_DAY'];
if (workingHoursKeys.includes(configKey)) {
clearWorkingHoursCache();
logger.info(`[Admin] Working hours configuration '${configKey}' updated - cache cleared`);
} else {
logger.info(`[Admin] Configuration '${configKey}' updated and cache cleared`);
}
res.json({ res.json({
success: true, success: true,
message: 'Configuration updated successfully' message: 'Configuration updated successfully'
@ -366,6 +401,18 @@ export const resetConfiguration = async (req: Request, res: Response): Promise<v
type: QueryTypes.UPDATE type: QueryTypes.UPDATE
}); });
// Clear config cache so reset values are used immediately
clearConfigCache();
// If working hours config was reset, also clear working hours cache
const workingHoursKeys = ['WORK_START_HOUR', 'WORK_END_HOUR', 'WORK_START_DAY', 'WORK_END_DAY'];
if (workingHoursKeys.includes(configKey)) {
clearWorkingHoursCache();
logger.info(`[Admin] Working hours configuration '${configKey}' reset to default - cache cleared`);
} else {
logger.info(`[Admin] Configuration '${configKey}' reset to default and cache cleared`);
}
res.json({ res.json({
success: true, success: true,
message: 'Configuration reset to default' message: 'Configuration reset to default'

98
src/migrations/20251105-add-skip-fields-to-approval-levels.ts Normal file
View File

@ -0,0 +1,98 @@
import { QueryInterface, DataTypes } from 'sequelize';
/**
* Migration: Add skip-related fields to approval_levels table
* Purpose: Track approvers who were skipped by initiator
* Date: 2025-11-05
*/
export async function up(queryInterface: QueryInterface): Promise<void> {
// Check if table exists first
const tables = await queryInterface.showAllTables();
if (!tables.includes('approval_levels')) {
console.log('⚠️ approval_levels table does not exist yet, skipping...');
return;
}
// Get existing columns
const tableDescription = await queryInterface.describeTable('approval_levels');
// Add skip-related columns only if they don't exist
if (!tableDescription.is_skipped) {
await queryInterface.addColumn('approval_levels', 'is_skipped', {
type: DataTypes.BOOLEAN,
allowNull: false,
defaultValue: false,
comment: 'Indicates if this approver was skipped by initiator'
});
console.log(' ✅ Added is_skipped column');
}
if (!tableDescription.skipped_at) {
await queryInterface.addColumn('approval_levels', 'skipped_at', {
type: DataTypes.DATE,
allowNull: true,
comment: 'Timestamp when approver was skipped'
});
console.log(' ✅ Added skipped_at column');
}
if (!tableDescription.skipped_by) {
await queryInterface.addColumn('approval_levels', 'skipped_by', {
type: DataTypes.UUID,
allowNull: true,
references: {
model: 'users',
key: 'user_id'
},
onUpdate: 'CASCADE',
onDelete: 'SET NULL',
comment: 'User ID who skipped this approver'
});
console.log(' ✅ Added skipped_by column');
}
if (!tableDescription.skip_reason) {
await queryInterface.addColumn('approval_levels', 'skip_reason', {
type: DataTypes.TEXT,
allowNull: true,
comment: 'Reason for skipping this approver'
});
console.log(' ✅ Added skip_reason column');
}
// Check if index exists before creating
try {
const indexes: any[] = await queryInterface.showIndex('approval_levels') as any[];
const indexExists = Array.isArray(indexes) && indexes.some((idx: any) => idx.name === 'idx_approval_levels_skipped');
if (!indexExists) {
await queryInterface.addIndex('approval_levels', ['is_skipped'], {
name: 'idx_approval_levels_skipped',
where: {
is_skipped: true
}
});
console.log(' ✅ Added idx_approval_levels_skipped index');
}
} catch (error) {
// Index might already exist, which is fine
console.log(' ℹ️ Index already exists or could not be created');
}
console.log('✅ Skip-related fields migration completed');
}
export async function down(queryInterface: QueryInterface): Promise<void> {
// Remove index first
await queryInterface.removeIndex('approval_levels', 'idx_approval_levels_skipped');
// Remove columns
await queryInterface.removeColumn('approval_levels', 'skip_reason');
await queryInterface.removeColumn('approval_levels', 'skipped_by');
await queryInterface.removeColumn('approval_levels', 'skipped_at');
await queryInterface.removeColumn('approval_levels', 'is_skipped');
console.log('✅ Removed skip-related fields from approval_levels table');
}

37
src/queues/tatProcessor.ts
View File

@ -8,7 +8,8 @@ import logger from '@utils/logger';
import dayjs from 'dayjs'; import dayjs from 'dayjs';
interface TatJobData { interface TatJobData {
type: 'tat50' | 'tat75' | 'tatBreach'; type: 'threshold1' | 'threshold2' | 'breach';
threshold: number; // Actual percentage (e.g., 55, 80, 100)
requestId: string; requestId: string;
levelId: string; levelId: string;
approverId: string; approverId: string;
@ -18,7 +19,7 @@ interface TatJobData {
* Handle TAT notification jobs * Handle TAT notification jobs
*/ */
export async function handleTatJob(job: Job<TatJobData>) { export async function handleTatJob(job: Job<TatJobData>) {
const { requestId, levelId, approverId, type } = job.data; const { requestId, levelId, approverId, type, threshold } = job.data;
try { try {
logger.info(`[TAT Processor] Processing ${type} for request ${requestId}, level ${levelId}`); logger.info(`[TAT Processor] Processing ${type} for request ${requestId}, level ${levelId}`);
@ -66,35 +67,35 @@ export async function handleTatJob(job: Job<TatJobData>) {
const expectedCompletionTime = dayjs(levelStartTime).add(tatHours, 'hour').toDate(); const expectedCompletionTime = dayjs(levelStartTime).add(tatHours, 'hour').toDate();
switch (type) { switch (type) {
case 'tat50': case 'threshold1':
emoji = '⏳'; emoji = '⏳';
alertType = TatAlertType.TAT_50; alertType = TatAlertType.TAT_50; // Keep enum for backwards compatibility
thresholdPercentage = 50; thresholdPercentage = threshold;
message = `${emoji} 50% of TAT elapsed for Request ${requestNumber}: ${title}`; message = `${emoji} ${threshold}% of TAT elapsed for Request ${requestNumber}: ${title}`;
activityDetails = '50% of TAT time has elapsed'; activityDetails = `${threshold}% of TAT time has elapsed`;
// Update TAT status in database // Update TAT status in database
await ApprovalLevel.update( await ApprovalLevel.update(
{ tatPercentageUsed: 50, tat50AlertSent: true }, { tatPercentageUsed: threshold, tat50AlertSent: true },
{ where: { levelId } } { where: { levelId } }
); );
break; break;
case 'tat75': case 'threshold2':
emoji = '⚠️'; emoji = '⚠️';
alertType = TatAlertType.TAT_75; alertType = TatAlertType.TAT_75; // Keep enum for backwards compatibility
thresholdPercentage = 75; thresholdPercentage = threshold;
message = `${emoji} 75% of TAT elapsed for Request ${requestNumber}: ${title}. Please take action soon.`; message = `${emoji} ${threshold}% of TAT elapsed for Request ${requestNumber}: ${title}. Please take action soon.`;
activityDetails = '75% of TAT time has elapsed - Escalation warning'; activityDetails = `${threshold}% of TAT time has elapsed - Escalation warning`;
// Update TAT status in database // Update TAT status in database
await ApprovalLevel.update( await ApprovalLevel.update(
{ tatPercentageUsed: 75, tat75AlertSent: true }, { tatPercentageUsed: threshold, tat75AlertSent: true },
{ where: { levelId } } { where: { levelId } }
); );
break; break;
case 'tatBreach': case 'breach':
emoji = '⏰'; emoji = '⏰';
alertType = TatAlertType.TAT_100; alertType = TatAlertType.TAT_100;
thresholdPercentage = 100; thresholdPercentage = 100;
@ -126,7 +127,7 @@ export async function handleTatJob(job: Job<TatJobData>) {
alertMessage: message, alertMessage: message,
notificationSent: true, notificationSent: true,
notificationChannels: ['push'], // Can add 'email', 'sms' if implemented notificationChannels: ['push'], // Can add 'email', 'sms' if implemented
isBreached: type === 'tatBreach', isBreached: type === 'breach',
metadata: { metadata: {
requestNumber, requestNumber,
requestTitle: title, requestTitle: title,
@ -147,7 +148,7 @@ export async function handleTatJob(job: Job<TatJobData>) {
// Send notification to approver // Send notification to approver
await notificationService.sendToUsers([approverId], { await notificationService.sendToUsers([approverId], {
title: type === 'tatBreach' ? 'TAT Breach Alert' : 'TAT Reminder', title: type === 'breach' ? 'TAT Breach Alert' : 'TAT Reminder',
body: message, body: message,
requestId, requestId,
requestNumber, requestNumber,
@ -161,7 +162,7 @@ export async function handleTatJob(job: Job<TatJobData>) {
type: 'sla_warning', type: 'sla_warning',
user: { userId: 'system', name: 'System' }, user: { userId: 'system', name: 'System' },
timestamp: new Date().toISOString(), timestamp: new Date().toISOString(),
action: type === 'tatBreach' ? 'TAT Breached' : 'TAT Warning', action: type === 'breach' ? 'TAT Breached' : 'TAT Warning',
details: activityDetails details: activityDetails
}); });

24
src/routes/config.routes.ts Normal file
View File

@ -0,0 +1,24 @@
import { Router, Request, Response } from 'express';
import { getPublicConfig } from '../config/system.config';
import { asyncHandler } from '../middlewares/errorHandler.middleware';
const router = Router();
/**
* GET /api/v1/config
* Returns public system configuration for frontend
* No authentication required - only returns non-sensitive values
*/
router.get('/',
asyncHandler(async (req: Request, res: Response): Promise<void> => {
const config = getPublicConfig();
res.json({
success: true,
data: config
});
return;
})
);
export default router;

2
src/routes/index.ts
View File

@ -6,6 +6,7 @@ import documentRoutes from './document.routes';
import tatRoutes from './tat.routes'; import tatRoutes from './tat.routes';
import adminRoutes from './admin.routes'; import adminRoutes from './admin.routes';
import debugRoutes from './debug.routes'; import debugRoutes from './debug.routes';
import configRoutes from './config.routes';
const router = Router(); const router = Router();
@ -20,6 +21,7 @@ router.get('/health', (_req, res) => {
// API routes // API routes
router.use('/auth', authRoutes); router.use('/auth', authRoutes);
router.use('/config', configRoutes); // System configuration (public)
router.use('/workflows', workflowRoutes); router.use('/workflows', workflowRoutes);
router.use('/users', userRoutes); router.use('/users', userRoutes);
router.use('/documents', documentRoutes); router.use('/documents', documentRoutes);

70
src/routes/workflow.routes.ts
View File

@ -358,4 +358,74 @@ router.post('/:id/participants/spectator',
}) })
); );
// Skip approver endpoint
router.post('/:id/approvals/:levelId/skip',
authenticateToken,
requireParticipantTypes(['INITIATOR', 'APPROVER']), // Only initiator or other approvers can skip
validateParams(approvalParamsSchema),
asyncHandler(async (req: any, res: Response) => {
const workflowService = new WorkflowService();
const wf = await (workflowService as any).findWorkflowByIdentifier(req.params.id);
if (!wf) {
res.status(404).json({ success: false, error: 'Workflow not found' });
return;
}
const requestId: string = wf.getDataValue('requestId');
const { levelId } = req.params;
const { reason } = req.body;
const result = await workflowService.skipApprover(
requestId,
levelId,
reason || '',
req.user?.userId
);
res.status(200).json({
success: true,
message: 'Approver skipped successfully',
data: result
});
})
);
// Add approver at specific level with level shifting
router.post('/:id/approvers/at-level',
authenticateToken,
requireParticipantTypes(['INITIATOR', 'APPROVER']), // Only initiator or approvers can add new approvers
validateParams(workflowParamsSchema),
asyncHandler(async (req: any, res: Response) => {
const workflowService = new WorkflowService();
const wf = await (workflowService as any).findWorkflowByIdentifier(req.params.id);
if (!wf) {
res.status(404).json({ success: false, error: 'Workflow not found' });
return;
}
const requestId: string = wf.getDataValue('requestId');
const { email, tatHours, level } = req.body;
if (!email || !tatHours || !level) {
res.status(400).json({
success: false,
error: 'Email, tatHours, and level are required'
});
return;
}
const result = await workflowService.addApproverAtLevel(
requestId,
email,
Number(tatHours),
Number(level),
req.user?.userId
);
res.status(201).json({
success: true,
message: 'Approver added successfully',
data: result
});
})
);
export default router; export default router;

35
src/scripts/fix-config-seed.sql Normal file
View File

@ -0,0 +1,35 @@
-- Fix existing configurations to add missing fields
-- Run this if you already have configurations seeded but missing is_sensitive and requires_restart
-- Add default values for missing columns (if columns exist but have NULL values)
UPDATE admin_configurations
SET
is_sensitive = COALESCE(is_sensitive, false),
requires_restart = COALESCE(requires_restart, false)
WHERE is_sensitive IS NULL OR requires_restart IS NULL;
-- Set requires_restart = true for settings that need backend restart
UPDATE admin_configurations
SET requires_restart = true
WHERE config_key IN (
'WORK_START_HOUR',
'WORK_END_HOUR',
'MAX_FILE_SIZE_MB',
'ALLOWED_FILE_TYPES'
);
-- Verify all configurations are editable
UPDATE admin_configurations
SET is_editable = true
WHERE is_editable IS NULL OR is_editable = false;
-- Show result
SELECT
config_key,
config_category,
is_editable,
is_sensitive,
requires_restart
FROM admin_configurations
ORDER BY config_category, sort_order;

141
src/scripts/migrate.ts
View File

@ -1,4 +1,5 @@
import { sequelize } from '../config/database'; import { sequelize } from '../config/database';
import { QueryInterface, QueryTypes } from 'sequelize';
import * as m1 from '../migrations/2025103001-create-workflow-requests'; import * as m1 from '../migrations/2025103001-create-workflow-requests';
import * as m2 from '../migrations/2025103002-create-approval-levels'; import * as m2 from '../migrations/2025103002-create-approval-levels';
import * as m3 from '../migrations/2025103003-create-participants'; import * as m3 from '../migrations/2025103003-create-participants';
@ -12,32 +13,134 @@ import * as m10 from '../migrations/20251104-create-tat-alerts';
import * as m11 from '../migrations/20251104-create-kpi-views'; import * as m11 from '../migrations/20251104-create-kpi-views';
import * as m12 from '../migrations/20251104-create-holidays'; import * as m12 from '../migrations/20251104-create-holidays';
import * as m13 from '../migrations/20251104-create-admin-config'; import * as m13 from '../migrations/20251104-create-admin-config';
import * as m14 from '../migrations/20251105-add-skip-fields-to-approval-levels';
interface Migration {
name: string;
module: any;
}
// Define all migrations in order
const migrations: Migration[] = [
{ name: '2025103001-create-workflow-requests', module: m1 },
{ name: '2025103002-create-approval-levels', module: m2 },
{ name: '2025103003-create-participants', module: m3 },
{ name: '2025103004-create-documents', module: m4 },
{ name: '20251031_01_create_subscriptions', module: m5 },
{ name: '20251031_02_create_activities', module: m6 },
{ name: '20251031_03_create_work_notes', module: m7 },
{ name: '20251031_04_create_work_note_attachments', module: m8 },
{ name: '20251104-add-tat-alert-fields', module: m9 },
{ name: '20251104-create-tat-alerts', module: m10 },
{ name: '20251104-create-kpi-views', module: m11 },
{ name: '20251104-create-holidays', module: m12 },
{ name: '20251104-create-admin-config', module: m13 },
{ name: '20251105-add-skip-fields-to-approval-levels', module: m14 },
];
/**
* Create migrations tracking table if it doesn't exist
*/
async function ensureMigrationsTable(queryInterface: QueryInterface): Promise<void> {
try {
const tables = await queryInterface.showAllTables();
if (!tables.includes('migrations')) {
await queryInterface.sequelize.query(`
CREATE TABLE migrations (
id SERIAL PRIMARY KEY,
name VARCHAR(255) NOT NULL UNIQUE,
executed_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
)
`);
console.log('✅ Created migrations tracking table');
}
} catch (error) {
console.error('Error creating migrations table:', error);
throw error;
}
}
/**
* Get list of already executed migrations
*/
async function getExecutedMigrations(): Promise<string[]> {
try {
const results = await sequelize.query<{ name: string }>(
'SELECT name FROM migrations ORDER BY id',
{ type: QueryTypes.SELECT }
);
return results.map(r => r.name);
} catch (error) {
// Table might not exist yet
return [];
}
}
/**
* Mark migration as executed
*/
async function markMigrationExecuted(name: string): Promise<void> {
await sequelize.query(
'INSERT INTO migrations (name) VALUES (:name) ON CONFLICT (name) DO NOTHING',
{
replacements: { name },
type: QueryTypes.INSERT
}
);
}
/**
* Run all pending migrations
*/
async function run() { async function run() {
try { try {
await sequelize.authenticate(); await sequelize.authenticate();
console.log('DB connected'); console.log('📦 Database connected');
await m1.up(sequelize.getQueryInterface());
await m2.up(sequelize.getQueryInterface()); const queryInterface = sequelize.getQueryInterface();
await m3.up(sequelize.getQueryInterface());
await m4.up(sequelize.getQueryInterface()); // Ensure migrations tracking table exists
await (m5 as any).up(sequelize.getQueryInterface()); await ensureMigrationsTable(queryInterface);
await (m6 as any).up(sequelize.getQueryInterface());
await (m7 as any).up(sequelize.getQueryInterface()); // Get already executed migrations
await (m8 as any).up(sequelize.getQueryInterface()); const executedMigrations = await getExecutedMigrations();
await (m9 as any).up(sequelize.getQueryInterface());
await (m10 as any).up(sequelize.getQueryInterface()); // Find pending migrations
await (m11 as any).up(sequelize.getQueryInterface()); const pendingMigrations = migrations.filter(
await (m12 as any).up(sequelize.getQueryInterface()); m => !executedMigrations.includes(m.name)
await (m13 as any).up(sequelize.getQueryInterface()); );
console.log('Migrations applied');
if (pendingMigrations.length === 0) {
console.log('✅ All migrations are up-to-date (no new migrations to run)');
process.exit(0); process.exit(0);
} catch (err) { return;
console.error('Migration failed', err); }
console.log(`🔄 Running ${pendingMigrations.length} pending migration(s)...\n`);
// Run each pending migration
for (const migration of pendingMigrations) {
try {
console.log(`⏳ Running: ${migration.name}`);
await migration.module.up(queryInterface);
await markMigrationExecuted(migration.name);
console.log(`✅ Completed: ${migration.name}\n`);
} catch (error: any) {
console.error(`❌ Failed: ${migration.name}`);
console.error('Error:', error.message);
throw error;
}
}
console.log(`\n✅ Successfully applied ${pendingMigrations.length} migration(s)`);
console.log(`📊 Total migrations: ${executedMigrations.length + pendingMigrations.length}`);
process.exit(0);
} catch (err: any) {
console.error('\n❌ Migration failed:', err.message);
console.error('\nStack trace:', err.stack);
process.exit(1); process.exit(1);
} }
} }
run(); run();

468
src/scripts/seed-configurations-complete.sql Normal file
View File

@ -0,0 +1,468 @@
-- ===================================================================
-- Royal Enfield Workflow Management - Complete Configuration Seed
-- Run this script to seed all 18 admin configurations
-- ===================================================================
-- Clear existing configurations (optional - remove if you want to keep custom values)
-- DELETE FROM admin_configurations;
-- Insert all 18 configurations with proper field mapping
INSERT INTO admin_configurations (
config_id, config_key, config_category, config_value, value_type,
display_name, description, default_value, is_editable, is_sensitive,
validation_rules, ui_component, sort_order, requires_restart,
created_at, updated_at
) VALUES
-- ==================== TAT SETTINGS (6) ====================
(
gen_random_uuid(),
'DEFAULT_TAT_EXPRESS_HOURS',
'TAT_SETTINGS',
'24',
'NUMBER',
'Default TAT for Express Priority',
'Default turnaround time in hours for express priority requests (calendar days, 24/7)',
'24',
true,
false,
'{"min": 1, "max": 168}'::jsonb,
'number',
1,
false,
NOW(),
NOW()
),
(
gen_random_uuid(),
'DEFAULT_TAT_STANDARD_HOURS',
'TAT_SETTINGS',
'48',
'NUMBER',
'Default TAT for Standard Priority',
'Default turnaround time in hours for standard priority requests (working days only)',
'48',
true,
false,
'{"min": 1, "max": 720}'::jsonb,
'number',
2,
false,
NOW(),
NOW()
),
(
gen_random_uuid(),
'TAT_REMINDER_THRESHOLD_1',
'TAT_SETTINGS',
'50',
'NUMBER',
'First TAT Reminder Threshold (%)',
'Send first gentle reminder when this percentage of TAT is elapsed',
'50',
true,
false,
'{"min": 1, "max": 100}'::jsonb,
'slider',
3,
false,
NOW(),
NOW()
),
(
gen_random_uuid(),
'TAT_REMINDER_THRESHOLD_2',
'TAT_SETTINGS',
'75',
'NUMBER',
'Second TAT Reminder Threshold (%)',
'Send escalation warning when this percentage of TAT is elapsed',
'75',
true,
false,
'{"min": 1, "max": 100}'::jsonb,
'slider',
4,
false,
NOW(),
NOW()
),
(
gen_random_uuid(),
'WORK_START_HOUR',
'TAT_SETTINGS',
'9',
'NUMBER',
'Working Day Start Hour',
'Hour when working day starts (24-hour format, 0-23)',
'9',
true,
false,
'{"min": 0, "max": 23}'::jsonb,
'number',
5,
true,
NOW(),
NOW()
),
(
gen_random_uuid(),
'WORK_END_HOUR',
'TAT_SETTINGS',
'18',
'NUMBER',
'Working Day End Hour',
'Hour when working day ends (24-hour format, 0-23)',
'18',
true,
false,
'{"min": 0, "max": 23}'::jsonb,
'number',
6,
true,
NOW(),
NOW()
),
-- ==================== DOCUMENT POLICY (3) ====================
(
gen_random_uuid(),
'MAX_FILE_SIZE_MB',
'DOCUMENT_POLICY',
'10',
'NUMBER',
'Maximum File Upload Size (MB)',
'Maximum allowed file size for document uploads in megabytes',
'10',
true,
false,
'{"min": 1, "max": 100}'::jsonb,
'number',
10,
true,
NOW(),
NOW()
),
(
gen_random_uuid(),
'ALLOWED_FILE_TYPES',
'DOCUMENT_POLICY',
'pdf,doc,docx,xls,xlsx,ppt,pptx,jpg,jpeg,png,gif',
'STRING',
'Allowed File Types',
'Comma-separated list of allowed file extensions for uploads',
'pdf,doc,docx,xls,xlsx,ppt,pptx,jpg,jpeg,png,gif',
true,
false,
'{}'::jsonb,
'text',
11,
true,
NOW(),
NOW()
),
(
gen_random_uuid(),
'DOCUMENT_RETENTION_DAYS',
'DOCUMENT_POLICY',
'365',
'NUMBER',
'Document Retention Period (Days)',
'Number of days to retain documents after workflow closure before archival',
'365',
true,
false,
'{"min": 30, "max": 3650}'::jsonb,
'number',
12,
false,
NOW(),
NOW()
),
-- ==================== AI CONFIGURATION (2) ====================
(
gen_random_uuid(),
'AI_REMARK_GENERATION_ENABLED',
'AI_CONFIGURATION',
'true',
'BOOLEAN',
'Enable AI Remark Generation',
'Toggle AI-generated conclusion remarks for workflow closures',
'true',
true,
false,
'{}'::jsonb,
'toggle',
20,
false,
NOW(),
NOW()
),
(
gen_random_uuid(),
'AI_REMARK_MAX_CHARACTERS',
'AI_CONFIGURATION',
'500',
'NUMBER',
'AI Remark Maximum Characters',
'Maximum character limit for AI-generated conclusion remarks',
'500',
true,
false,
'{"min": 100, "max": 2000}'::jsonb,
'number',
21,
false,
NOW(),
NOW()
),
-- ==================== NOTIFICATION RULES (3) ====================
(
gen_random_uuid(),
'ENABLE_EMAIL_NOTIFICATIONS',
'NOTIFICATION_RULES',
'true',
'BOOLEAN',
'Enable Email Notifications',
'Send email notifications for workflow events',
'true',
true,
false,
'{}'::jsonb,
'toggle',
30,
false,
NOW(),
NOW()
),
(
gen_random_uuid(),
'ENABLE_PUSH_NOTIFICATIONS',
'NOTIFICATION_RULES',
'true',
'BOOLEAN',
'Enable Push Notifications',
'Send browser push notifications for real-time events',
'true',
true,
false,
'{}'::jsonb,
'toggle',
31,
false,
NOW(),
NOW()
),
(
gen_random_uuid(),
'NOTIFICATION_BATCH_DELAY_MS',
'NOTIFICATION_RULES',
'5000',
'NUMBER',
'Notification Batch Delay (ms)',
'Delay in milliseconds before sending batched notifications to avoid spam',
'5000',
true,
false,
'{"min": 1000, "max": 30000}'::jsonb,
'number',
32,
false,
NOW(),
NOW()
),
-- ==================== DASHBOARD LAYOUT (4) ====================
(
gen_random_uuid(),
'DASHBOARD_SHOW_TOTAL_REQUESTS',
'DASHBOARD_LAYOUT',
'true',
'BOOLEAN',
'Show Total Requests Card',
'Display total requests KPI card on dashboard',
'true',
true,
false,
'{}'::jsonb,
'toggle',
40,
false,
NOW(),
NOW()
),
(
gen_random_uuid(),
'DASHBOARD_SHOW_OPEN_REQUESTS',
'DASHBOARD_LAYOUT',
'true',
'BOOLEAN',
'Show Open Requests Card',
'Display open requests KPI card on dashboard',
'true',
true,
false,
'{}'::jsonb,
'toggle',
41,
false,
NOW(),
NOW()
),
(
gen_random_uuid(),
'DASHBOARD_SHOW_TAT_COMPLIANCE',
'DASHBOARD_LAYOUT',
'true',
'BOOLEAN',
'Show TAT Compliance Card',
'Display TAT compliance KPI card on dashboard',
'true',
true,
false,
'{}'::jsonb,
'toggle',
42,
false,
NOW(),
NOW()
),
(
gen_random_uuid(),
'DASHBOARD_SHOW_PENDING_ACTIONS',
'DASHBOARD_LAYOUT',
'true',
'BOOLEAN',
'Show Pending Actions Card',
'Display pending actions KPI card on dashboard',
'true',
true,
false,
'{}'::jsonb,
'toggle',
43,
false,
NOW(),
NOW()
),
-- ==================== WORKFLOW SHARING (3) ====================
(
gen_random_uuid(),
'ALLOW_ADD_SPECTATOR',
'WORKFLOW_SHARING',
'true',
'BOOLEAN',
'Allow Adding Spectators',
'Enable users to add spectators to workflow requests',
'true',
true,
false,
'{}'::jsonb,
'toggle',
50,
false,
NOW(),
NOW()
),
(
gen_random_uuid(),
'MAX_SPECTATORS_PER_REQUEST',
'WORKFLOW_SHARING',
'20',
'NUMBER',
'Maximum Spectators per Request',
'Maximum number of spectators allowed per workflow request',
'20',
true,
false,
'{"min": 1, "max": 100}'::jsonb,
'number',
51,
false,
NOW(),
NOW()
),
(
gen_random_uuid(),
'ALLOW_EXTERNAL_SHARING',
'WORKFLOW_SHARING',
'false',
'BOOLEAN',
'Allow External Sharing',
'Allow sharing workflow links with users outside the organization',
'false',
true,
false,
'{}'::jsonb,
'toggle',
52,
false,
NOW(),
NOW()
),
-- ==================== WORKFLOW LIMITS (2) ====================
(
gen_random_uuid(),
'MAX_APPROVAL_LEVELS',
'WORKFLOW_LIMITS',
'10',
'NUMBER',
'Maximum Approval Levels',
'Maximum number of approval levels allowed per workflow',
'10',
true,
false,
'{"min": 1, "max": 20}'::jsonb,
'number',
60,
false,
NOW(),
NOW()
),
(
gen_random_uuid(),
'MAX_PARTICIPANTS_PER_REQUEST',
'WORKFLOW_LIMITS',
'50',
'NUMBER',
'Maximum Participants per Request',
'Maximum total participants (approvers + spectators) per workflow',
'50',
true,
false,
'{"min": 2, "max": 200}'::jsonb,
'number',
61,
false,
NOW(),
NOW()
)
ON CONFLICT (config_key) DO UPDATE SET
config_value = EXCLUDED.config_value,
display_name = EXCLUDED.display_name,
description = EXCLUDED.description,
is_editable = EXCLUDED.is_editable,
updated_at = NOW();
-- Verify insertion
SELECT
config_category,
config_key,
is_editable,
is_sensitive,
requires_restart
FROM admin_configurations
ORDER BY config_category, sort_order;
-- Show summary
SELECT
config_category AS category,
COUNT(*) AS total_settings,
SUM(CASE WHEN is_editable = true THEN 1 ELSE 0 END) AS editable_count
FROM admin_configurations
GROUP BY config_category
ORDER BY config_category;

7
src/server.ts
View File

@ -3,6 +3,7 @@ import http from 'http';
import { initSocket } from './realtime/socket'; import { initSocket } from './realtime/socket';
import './queues/tatWorker'; // Initialize TAT worker import './queues/tatWorker'; // Initialize TAT worker
import { logTatConfig } from './config/tat.config'; import { logTatConfig } from './config/tat.config';
import { logSystemConfig } from './config/system.config';
import { initializeHolidaysCache } from './utils/tatTimeUtils'; import { initializeHolidaysCache } from './utils/tatTimeUtils';
import { seedDefaultConfigurations } from './services/configSeed.service'; import { seedDefaultConfigurations } from './services/configSeed.service';
@ -17,7 +18,7 @@ const startServer = async (): Promise<void> => {
// Seed default configurations if table is empty // Seed default configurations if table is empty
try { try {
await seedDefaultConfigurations(); await seedDefaultConfigurations();
console.log('⚙️ System configurations initialized'); // console.log('⚙️ System configurations initialized');
} catch (error) { } catch (error) {
console.warn('⚠️ Configuration seeding skipped'); console.warn('⚠️ Configuration seeding skipped');
} }
@ -38,7 +39,9 @@ const startServer = async (): Promise<void> => {
console.log(`🔌 Socket.IO path: /socket.io`); console.log(`🔌 Socket.IO path: /socket.io`);
console.log(`⏰ TAT Worker: Initialized and listening`); console.log(`⏰ TAT Worker: Initialized and listening`);
console.log(''); console.log('');
logTatConfig(); logSystemConfig(); // Log centralized system configuration
console.log('');
logTatConfig(); // Log TAT-specific details
}); });
} catch (error) { } catch (error) {
console.error('❌ Unable to start server:', error); console.error('❌ Unable to start server:', error);

8
src/services/approval.service.ts
View File

@ -113,14 +113,18 @@ export class ApprovalService {
// Schedule TAT jobs for the next level // Schedule TAT jobs for the next level
try { try {
// Get workflow priority for TAT calculation
const workflowPriority = (wf as any)?.priority || 'STANDARD';
await tatSchedulerService.scheduleTatJobs( await tatSchedulerService.scheduleTatJobs(
level.requestId, level.requestId,
(nextLevel as any).levelId, (nextLevel as any).levelId,
(nextLevel as any).approverId, (nextLevel as any).approverId,
Number((nextLevel as any).tatHours), Number((nextLevel as any).tatHours),
now now,
workflowPriority // Pass workflow priority (EXPRESS = 24/7, STANDARD = working hours)
); );
logger.info(`[Approval] TAT jobs scheduled for next level ${nextLevelNumber}`); logger.info(`[Approval] TAT jobs scheduled for next level ${nextLevelNumber} (Priority: ${workflowPriority})`);
} catch (tatError) { } catch (tatError) {
logger.error(`[Approval] Failed to schedule TAT jobs for next level:`, tatError); logger.error(`[Approval] Failed to schedule TAT jobs for next level:`, tatError);
// Don't fail the approval if TAT scheduling fails // Don't fail the approval if TAT scheduling fails

121
src/services/configReader.service.ts Normal file
View File

@ -0,0 +1,121 @@
/**
* Configuration Reader Service
* Reads admin configurations from database for use in backend logic
*/
import { sequelize } from '@config/database';
import { QueryTypes } from 'sequelize';
import logger from '@utils/logger';
// Cache configurations in memory for performance
let configCache: Map<string, string> = new Map();
let cacheExpiry: Date | null = null;
const CACHE_DURATION_MS = 5 * 60 * 1000; // 5 minutes
/**
* Get a configuration value from database (with caching)
*/
export async function getConfigValue(configKey: string, defaultValue: string = ''): Promise<string> {
try {
// Check cache first
if (configCache.has(configKey) && cacheExpiry && new Date() < cacheExpiry) {
return configCache.get(configKey)!;
}
// Query database
const result = await sequelize.query(`
SELECT config_value
FROM admin_configurations
WHERE config_key = :configKey
LIMIT 1
`, {
replacements: { configKey },
type: QueryTypes.SELECT
});
if (result && result.length > 0) {
const value = (result[0] as any).config_value;
configCache.set(configKey, value);
// Set cache expiry if not set
if (!cacheExpiry) {
cacheExpiry = new Date(Date.now() + CACHE_DURATION_MS);
}
return value;
}
logger.warn(`[ConfigReader] Config key '${configKey}' not found, using default: ${defaultValue}`);
return defaultValue;
} catch (error) {
logger.error(`[ConfigReader] Error reading config '${configKey}':`, error);
return defaultValue;
}
}
/**
* Get number configuration
*/
export async function getConfigNumber(configKey: string, defaultValue: number): Promise<number> {
const value = await getConfigValue(configKey, String(defaultValue));
return parseFloat(value) || defaultValue;
}
/**
* Get boolean configuration
*/
export async function getConfigBoolean(configKey: string, defaultValue: boolean): Promise<boolean> {
const value = await getConfigValue(configKey, String(defaultValue));
return value === 'true' || value === '1';
}
/**
* Get TAT thresholds from database
*/
export async function getTatThresholds(): Promise<{ first: number; second: number }> {
const first = await getConfigNumber('TAT_REMINDER_THRESHOLD_1', 50);
const second = await getConfigNumber('TAT_REMINDER_THRESHOLD_2', 75);
return { first, second };
}
/**
* Get working hours from database
*/
export async function getWorkingHours(): Promise<{ startHour: number; endHour: number }> {
const startHour = await getConfigNumber('WORK_START_HOUR', 9);
const endHour = await getConfigNumber('WORK_END_HOUR', 18);
return { startHour, endHour };
}
/**
* Clear configuration cache (call after updating configs)
*/
export function clearConfigCache(): void {
configCache.clear();
cacheExpiry = null;
logger.info('[ConfigReader] Configuration cache cleared');
}
/**
* Preload all configurations into cache
*/
export async function preloadConfigurations(): Promise<void> {
try {
const results = await sequelize.query(`
SELECT config_key, config_value
FROM admin_configurations
`, { type: QueryTypes.SELECT });
results.forEach((row: any) => {
configCache.set(row.config_key, row.config_value);
});
cacheExpiry = new Date(Date.now() + CACHE_DURATION_MS);
logger.info(`[ConfigReader] Preloaded ${results.length} configurations into cache`);
} catch (error) {
logger.error('[ConfigReader] Error preloading configurations:', error);
}
}

207
src/services/configSeed.service.ts
View File

@ -25,8 +25,9 @@ export async function seedDefaultConfigurations(): Promise<void> {
await sequelize.query(` await sequelize.query(`
INSERT INTO admin_configurations ( INSERT INTO admin_configurations (
config_id, config_key, config_category, config_value, value_type, config_id, config_key, config_category, config_value, value_type,
display_name, description, default_value, is_editable, validation_rules, display_name, description, default_value, is_editable, is_sensitive,
ui_component, sort_order, created_at, updated_at validation_rules, ui_component, sort_order, requires_restart,
created_at, updated_at
) VALUES ) VALUES
-- TAT Settings -- TAT Settings
( (
@ -39,9 +40,11 @@ export async function seedDefaultConfigurations(): Promise<void> {
'Default turnaround time in hours for express priority requests (calendar days, 24/7)', 'Default turnaround time in hours for express priority requests (calendar days, 24/7)',
'24', '24',
true, true,
false,
'{"min": 1, "max": 168}'::jsonb, '{"min": 1, "max": 168}'::jsonb,
'number', 'number',
1, 1,
false,
NOW(), NOW(),
NOW() NOW()
), ),
@ -55,9 +58,11 @@ export async function seedDefaultConfigurations(): Promise<void> {
'Default turnaround time in hours for standard priority requests (working days only, excludes weekends and holidays)', 'Default turnaround time in hours for standard priority requests (working days only, excludes weekends and holidays)',
'48', '48',
true, true,
false,
'{"min": 1, "max": 720}'::jsonb, '{"min": 1, "max": 720}'::jsonb,
'number', 'number',
2, 2,
false,
NOW(), NOW(),
NOW() NOW()
), ),
@ -206,10 +211,206 @@ export async function seedDefaultConfigurations(): Promise<void> {
21, 21,
NOW(), NOW(),
NOW() NOW()
),
-- Notification Rules
(
gen_random_uuid(),
'ENABLE_EMAIL_NOTIFICATIONS',
'NOTIFICATION_RULES',
'true',
'BOOLEAN',
'Enable Email Notifications',
'Send email notifications for workflow events',
'true',
true,
'{}'::jsonb,
'toggle',
30,
NOW(),
NOW()
),
(
gen_random_uuid(),
'ENABLE_PUSH_NOTIFICATIONS',
'NOTIFICATION_RULES',
'true',
'BOOLEAN',
'Enable Push Notifications',
'Send browser push notifications for real-time events',
'true',
true,
'{}'::jsonb,
'toggle',
31,
NOW(),
NOW()
),
(
gen_random_uuid(),
'NOTIFICATION_BATCH_DELAY_MS',
'NOTIFICATION_RULES',
'5000',
'NUMBER',
'Notification Batch Delay (ms)',
'Delay in milliseconds before sending batched notifications to avoid spam',
'5000',
true,
'{"min": 1000, "max": 30000}'::jsonb,
'number',
32,
NOW(),
NOW()
),
-- Dashboard Layout
(
gen_random_uuid(),
'DASHBOARD_SHOW_TOTAL_REQUESTS',
'DASHBOARD_LAYOUT',
'true',
'BOOLEAN',
'Show Total Requests Card',
'Display total requests KPI card on dashboard',
'true',
true,
'{}'::jsonb,
'toggle',
40,
NOW(),
NOW()
),
(
gen_random_uuid(),
'DASHBOARD_SHOW_OPEN_REQUESTS',
'DASHBOARD_LAYOUT',
'true',
'BOOLEAN',
'Show Open Requests Card',
'Display open requests KPI card on dashboard',
'true',
true,
'{}'::jsonb,
'toggle',
41,
NOW(),
NOW()
),
(
gen_random_uuid(),
'DASHBOARD_SHOW_TAT_COMPLIANCE',
'DASHBOARD_LAYOUT',
'true',
'BOOLEAN',
'Show TAT Compliance Card',
'Display TAT compliance KPI card on dashboard',
'true',
true,
'{}'::jsonb,
'toggle',
42,
NOW(),
NOW()
),
(
gen_random_uuid(),
'DASHBOARD_SHOW_PENDING_ACTIONS',
'DASHBOARD_LAYOUT',
'true',
'BOOLEAN',
'Show Pending Actions Card',
'Display pending actions KPI card on dashboard',
'true',
true,
'{}'::jsonb,
'toggle',
43,
NOW(),
NOW()
),
-- Workflow Sharing Policy
(
gen_random_uuid(),
'ALLOW_ADD_SPECTATOR',
'WORKFLOW_SHARING',
'true',
'BOOLEAN',
'Allow Adding Spectators',
'Enable users to add spectators to workflow requests',
'true',
true,
'{}'::jsonb,
'toggle',
50,
NOW(),
NOW()
),
(
gen_random_uuid(),
'MAX_SPECTATORS_PER_REQUEST',
'WORKFLOW_SHARING',
'20',
'NUMBER',
'Maximum Spectators per Request',
'Maximum number of spectators allowed per workflow request',
'20',
true,
'{"min": 1, "max": 100}'::jsonb,
'number',
51,
NOW(),
NOW()
),
(
gen_random_uuid(),
'ALLOW_EXTERNAL_SHARING',
'WORKFLOW_SHARING',
'false',
'BOOLEAN',
'Allow External Sharing',
'Allow sharing workflow links with users outside the organization',
'false',
true,
'{}'::jsonb,
'toggle',
52,
NOW(),
NOW()
),
-- User Roles (Read-only settings for reference)
(
gen_random_uuid(),
'MAX_APPROVAL_LEVELS',
'WORKFLOW_LIMITS',
'10',
'NUMBER',
'Maximum Approval Levels',
'Maximum number of approval levels allowed per workflow',
'10',
true,
'{"min": 1, "max": 20}'::jsonb,
'number',
60,
NOW(),
NOW()
),
(
gen_random_uuid(),
'MAX_PARTICIPANTS_PER_REQUEST',
'WORKFLOW_LIMITS',
'50',
'NUMBER',
'Maximum Participants per Request',
'Maximum total participants (approvers + spectators) per workflow',
'50',
true,
'{"min": 2, "max": 200}'::jsonb,
'number',
61,
NOW(),
NOW()
) )
`, { type: QueryTypes.INSERT }); `, { type: QueryTypes.INSERT });
logger.info('[Config Seed] ✅ Default configurations seeded successfully'); logger.info('[Config Seed] ✅ Default configurations seeded successfully (18 settings across 7 categories)');
} catch (error) { } catch (error) {
logger.error('[Config Seed] Error seeding configurations:', error); logger.error('[Config Seed] Error seeding configurations:', error);
// Don't throw - let server start even if seeding fails // Don't throw - let server start even if seeding fails

79
src/services/tatScheduler.service.ts
View File

@ -1,7 +1,9 @@
import { tatQueue } from '../queues/tatQueue'; import { tatQueue } from '../queues/tatQueue';
import { calculateTatMilestones, calculateDelay } from '@utils/tatTimeUtils'; import { calculateDelay, addWorkingHours, addCalendarHours } from '@utils/tatTimeUtils';
import { getTatThresholds } from './configReader.service';
import dayjs from 'dayjs'; import dayjs from 'dayjs';
import logger from '@utils/logger'; import logger from '@utils/logger';
import { Priority } from '../types/common.types';
export class TatSchedulerService { export class TatSchedulerService {
/** /**
@ -11,13 +13,15 @@ export class TatSchedulerService {
* @param approverId - The approver user ID * @param approverId - The approver user ID
* @param tatDurationHours - TAT duration in hours * @param tatDurationHours - TAT duration in hours
* @param startTime - Optional start time (defaults to now) * @param startTime - Optional start time (defaults to now)
* @param priority - Request priority (EXPRESS = 24/7, STANDARD = working hours only)
*/ */
async scheduleTatJobs( async scheduleTatJobs(
requestId: string, requestId: string,
levelId: string, levelId: string,
approverId: string, approverId: string,
tatDurationHours: number, tatDurationHours: number,
startTime?: Date startTime?: Date,
priority: Priority = Priority.STANDARD
): Promise<void> { ): Promise<void> {
try { try {
// Check if tatQueue is available // Check if tatQueue is available
@ -27,36 +31,67 @@ export class TatSchedulerService {
} }
const now = startTime || new Date(); const now = startTime || new Date();
const { halfTime, seventyFive, full } = await calculateTatMilestones(now, tatDurationHours); const isExpress = priority === Priority.EXPRESS;
// Get current thresholds from database configuration
const thresholds = await getTatThresholds();
// Calculate milestone times using configured thresholds
// EXPRESS mode: 24/7 calculation (includes holidays, weekends, non-working hours)
// STANDARD mode: Working hours only (excludes holidays, weekends, non-working hours)
let threshold1Time: Date;
let threshold2Time: Date;
let breachTime: Date;
if (isExpress) {
// EXPRESS: 24/7 calculation - no exclusions
threshold1Time = addCalendarHours(now, tatDurationHours * (thresholds.first / 100)).toDate();
threshold2Time = addCalendarHours(now, tatDurationHours * (thresholds.second / 100)).toDate();
breachTime = addCalendarHours(now, tatDurationHours).toDate();
logger.info(`[TAT Scheduler] Using EXPRESS mode (24/7) - no holiday/weekend exclusions`);
} else {
// STANDARD: Working hours only, excludes holidays
const t1 = await addWorkingHours(now, tatDurationHours * (thresholds.first / 100));
const t2 = await addWorkingHours(now, tatDurationHours * (thresholds.second / 100));
const tBreach = await addWorkingHours(now, tatDurationHours);
threshold1Time = t1.toDate();
threshold2Time = t2.toDate();
breachTime = tBreach.toDate();
logger.info(`[TAT Scheduler] Using STANDARD mode - excludes holidays, weekends, non-working hours`);
}
logger.info(`[TAT Scheduler] Calculating TAT milestones for request ${requestId}, level ${levelId}`); logger.info(`[TAT Scheduler] Calculating TAT milestones for request ${requestId}, level ${levelId}`);
logger.info(`[TAT Scheduler] Priority: ${priority}, TAT Hours: ${tatDurationHours}`);
logger.info(`[TAT Scheduler] Start: ${dayjs(now).format('YYYY-MM-DD HH:mm')}`); logger.info(`[TAT Scheduler] Start: ${dayjs(now).format('YYYY-MM-DD HH:mm')}`);
logger.info(`[TAT Scheduler] 50%: ${dayjs(halfTime).format('YYYY-MM-DD HH:mm')}`); logger.info(`[TAT Scheduler] Threshold 1 (${thresholds.first}%): ${dayjs(threshold1Time).format('YYYY-MM-DD HH:mm')}`);
logger.info(`[TAT Scheduler] 75%: ${dayjs(seventyFive).format('YYYY-MM-DD HH:mm')}`); logger.info(`[TAT Scheduler] Threshold 2 (${thresholds.second}%): ${dayjs(threshold2Time).format('YYYY-MM-DD HH:mm')}`);
logger.info(`[TAT Scheduler] 100%: ${dayjs(full).format('YYYY-MM-DD HH:mm')}`); logger.info(`[TAT Scheduler] Breach (100%): ${dayjs(breachTime).format('YYYY-MM-DD HH:mm')}`);
const jobs = [ const jobs = [
{ {
type: 'tat50' as const, type: 'threshold1' as const,
delay: calculateDelay(halfTime), threshold: thresholds.first,
targetTime: halfTime delay: calculateDelay(threshold1Time),
targetTime: threshold1Time
}, },
{ {
type: 'tat75' as const, type: 'threshold2' as const,
delay: calculateDelay(seventyFive), threshold: thresholds.second,
targetTime: seventyFive delay: calculateDelay(threshold2Time),
targetTime: threshold2Time
}, },
{ {
type: 'tatBreach' as const, type: 'breach' as const,
delay: calculateDelay(full), threshold: 100,
targetTime: full delay: calculateDelay(breachTime),
targetTime: breachTime
} }
]; ];
for (const job of jobs) { for (const job of jobs) {
// Skip if the time has already passed // Skip if the time has already passed
if (job.delay === 0) { if (job.delay === 0) {
logger.warn(`[TAT Scheduler] Skipping ${job.type} for level ${levelId} - time already passed`); logger.warn(`[TAT Scheduler] Skipping ${job.type} (${job.threshold}%) for level ${levelId} - time already passed`);
continue; continue;
} }
@ -64,20 +99,21 @@ export class TatSchedulerService {
job.type, job.type,
{ {
type: job.type, type: job.type,
threshold: job.threshold, // Store actual threshold percentage in job data
requestId, requestId,
levelId, levelId,
approverId approverId
}, },
{ {
delay: job.delay, delay: job.delay,
jobId: `${job.type}-${requestId}-${levelId}`, // Unique job ID for easier management jobId: `tat-${job.type}-${requestId}-${levelId}`, // Generic job ID
removeOnComplete: true, removeOnComplete: true,
removeOnFail: false removeOnFail: false
} }
); );
logger.info( logger.info(
`[TAT Scheduler] Scheduled ${job.type} for level ${levelId} ` + `[TAT Scheduler] Scheduled ${job.type} (${job.threshold}%) for level ${levelId} ` +
`(delay: ${Math.round(job.delay / 1000 / 60)} minutes, ` + `(delay: ${Math.round(job.delay / 1000 / 60)} minutes, ` +
`target: ${dayjs(job.targetTime).format('YYYY-MM-DD HH:mm')})` `target: ${dayjs(job.targetTime).format('YYYY-MM-DD HH:mm')})`
); );
@ -104,10 +140,11 @@ export class TatSchedulerService {
return; return;
} }
// Use generic job names that don't depend on threshold percentages
const jobIds = [ const jobIds = [
`tat50-${requestId}-${levelId}`, `tat-threshold1-${requestId}-${levelId}`,
`tat75-${requestId}-${levelId}`, `tat-threshold2-${requestId}-${levelId}`,
`tatBreach-${requestId}-${levelId}` `tat-breach-${requestId}-${levelId}`
]; ];
for (const jobId of jobIds) { for (const jobId of jobIds) {

300
src/services/workflow.service.ts
View File

@ -111,6 +111,275 @@ export class WorkflowService {
} }
} }
/**
* Skip an approver level (initiator can skip non-responding approver)
*/
async skipApprover(requestId: string, levelId: string, skipReason: string, skippedBy: string): Promise<any> {
try {
// Get the approval level
const level = await ApprovalLevel.findOne({ where: { levelId } });
if (!level) {
throw new Error('Approval level not found');
}
// Verify it's skippable (not already approved/rejected/skipped)
const currentStatus = (level as any).status;
if (currentStatus === 'APPROVED' || currentStatus === 'REJECTED' || currentStatus === 'SKIPPED') {
throw new Error(`Cannot skip approver - level is already ${currentStatus}`);
}
// Get workflow to verify current level
const workflow = await WorkflowRequest.findOne({ where: { requestId } });
if (!workflow) {
throw new Error('Workflow not found');
}
const currentLevel = (workflow as any).currentLevel;
const levelNumber = (level as any).levelNumber;
// Only allow skipping current level (not future levels)
if (levelNumber > currentLevel) {
throw new Error('Cannot skip future approval levels');
}
// Mark as skipped
await level.update({
status: ApprovalStatus.SKIPPED,
levelEndTime: new Date(),
actionDate: new Date()
});
// Update additional skip fields if migration was run
try {
await sequelize.query(`
UPDATE approval_levels
SET is_skipped = TRUE,
skipped_at = NOW(),
skipped_by = :skippedBy,
skip_reason = :skipReason
WHERE level_id = :levelId
`, {
replacements: { levelId, skippedBy, skipReason },
type: QueryTypes.UPDATE
});
} catch (err) {
logger.warn('[Workflow] is_skipped column not available (migration not run), using status only');
}
// Cancel TAT jobs for skipped level
await tatSchedulerService.cancelTatJobs(requestId, levelId);
// Move to next level
const nextLevelNumber = levelNumber + 1;
const nextLevel = await ApprovalLevel.findOne({
where: { requestId, levelNumber: nextLevelNumber }
});
if (nextLevel) {
const now = new Date();
await nextLevel.update({
status: ApprovalStatus.IN_PROGRESS,
levelStartTime: now,
tatStartTime: now
});
// Schedule TAT jobs for next level
const workflowPriority = (workflow as any)?.priority || 'STANDARD';
await tatSchedulerService.scheduleTatJobs(
requestId,
(nextLevel as any).levelId,
(nextLevel as any).approverId,
Number((nextLevel as any).tatHours),
now,
workflowPriority
);
// Update workflow current level
await workflow.update({ currentLevel: nextLevelNumber });
// Notify next approver
await notificationService.sendToUsers([(nextLevel as any).approverId], {
title: 'Request Escalated',
body: `Previous approver was skipped. Request ${(workflow as any).requestNumber} is now awaiting your approval.`,
requestId,
requestNumber: (workflow as any).requestNumber,
url: `/request/${(workflow as any).requestNumber}`
});
}
// Get user who skipped
const skipUser = await User.findByPk(skippedBy);
const skipUserName = (skipUser as any)?.displayName || (skipUser as any)?.email || 'User';
// Log activity
await activityService.log({
requestId,
type: 'status_change',
user: { userId: skippedBy, name: skipUserName },
timestamp: new Date().toISOString(),
action: 'Approver Skipped',
details: `Level ${levelNumber} approver (${(level as any).approverName}) was skipped by ${skipUserName}. Reason: ${skipReason || 'Not provided'}`
});
logger.info(`[Workflow] Skipped approver at level ${levelNumber} for request ${requestId}`);
return level;
} catch (error) {
logger.error(`[Workflow] Failed to skip approver:`, error);
throw error;
}
}
/**
* Add a new approver at specific level (with level shifting)
*/
async addApproverAtLevel(
requestId: string,
email: string,
tatHours: number,
targetLevel: number,
addedBy: string
): Promise<any> {
try {
// Find user by email
const user = await User.findOne({ where: { email: email.toLowerCase() } });
if (!user) {
throw new Error('User not found with this email');
}
const userId = (user as any).userId;
const userName = (user as any).displayName || (user as any).email;
// Check if user is already a participant
const existing = await Participant.findOne({
where: { requestId, userId }
});
if (existing) {
throw new Error('User is already a participant in this request');
}
// Get workflow
const workflow = await WorkflowRequest.findOne({ where: { requestId } });
if (!workflow) {
throw new Error('Workflow not found');
}
// Get all approval levels
const allLevels = await ApprovalLevel.findAll({
where: { requestId },
order: [['levelNumber', 'ASC']]
});
// Validate target level
// New approver must be placed after all approved/rejected/skipped levels
const completedLevels = allLevels.filter(l => {
const status = (l as any).status;
return status === 'APPROVED' || status === 'REJECTED' || status === 'SKIPPED';
});
const minAllowedLevel = completedLevels.length + 1;
if (targetLevel < minAllowedLevel) {
throw new Error(`Cannot add approver at level ${targetLevel}. Minimum allowed level is ${minAllowedLevel} (after completed levels)`);
}
// Shift existing levels at and after target level
const levelsToShift = allLevels.filter(l => (l as any).levelNumber >= targetLevel);
for (const levelToShift of levelsToShift) {
const newLevelNumber = (levelToShift as any).levelNumber + 1;
await levelToShift.update({
levelNumber: newLevelNumber,
levelName: `Level ${newLevelNumber}`
});
logger.info(`[Workflow] Shifted level ${(levelToShift as any).levelNumber - 1} → ${newLevelNumber}`);
}
// Update total levels in workflow
await workflow.update({ totalLevels: allLevels.length + 1 });
// Create new approval level at target position
const newLevel = await ApprovalLevel.create({
requestId,
levelNumber: targetLevel,
levelName: `Level ${targetLevel}`,
approverId: userId,
approverEmail: email.toLowerCase(),
approverName: userName,
tatHours,
tatDays: Math.ceil(tatHours / 24),
status: targetLevel === (workflow as any).currentLevel ? ApprovalStatus.IN_PROGRESS : ApprovalStatus.PENDING,
isFinalApprover: targetLevel === allLevels.length + 1,
levelStartTime: targetLevel === (workflow as any).currentLevel ? new Date() : null,
tatStartTime: targetLevel === (workflow as any).currentLevel ? new Date() : null
} as any);
// Update isFinalApprover for previous final approver (now it's not final anymore)
if (allLevels.length > 0) {
const previousFinal = allLevels.find(l => (l as any).isFinalApprover);
if (previousFinal && targetLevel > (previousFinal as any).levelNumber) {
await previousFinal.update({ isFinalApprover: false });
}
}
// Add as participant
await Participant.create({
requestId,
userId,
userEmail: email.toLowerCase(),
userName,
participantType: ParticipantType.APPROVER,
canComment: true,
canViewDocuments: true,
canDownloadDocuments: true,
notificationEnabled: true,
addedBy,
isActive: true
} as any);
// If new approver is at current level, schedule TAT jobs
if (targetLevel === (workflow as any).currentLevel) {
const workflowPriority = (workflow as any)?.priority || 'STANDARD';
await tatSchedulerService.scheduleTatJobs(
requestId,
(newLevel as any).levelId,
userId,
tatHours,
new Date(),
workflowPriority
);
}
// Get the user who is adding the approver
const addedByUser = await User.findByPk(addedBy);
const addedByName = (addedByUser as any)?.displayName || (addedByUser as any)?.email || 'User';
// Log activity
await activityService.log({
requestId,
type: 'assignment',
user: { userId: addedBy, name: addedByName },
timestamp: new Date().toISOString(),
action: 'Added new approver',
details: `${userName} (${email}) has been added as approver at Level ${targetLevel} with TAT of ${tatHours} hours by ${addedByName}`
});
// Send notification to new approver
await notificationService.sendToUsers([userId], {
title: 'New Request Assignment',
body: `You have been added as Level ${targetLevel} approver to request ${(workflow as any).requestNumber}: ${(workflow as any).title}`,
requestId,
requestNumber: (workflow as any).requestNumber,
url: `/request/${(workflow as any).requestNumber}`
});
logger.info(`[Workflow] Added approver ${email} at level ${targetLevel} to request ${requestId}`);
return newLevel;
} catch (error) {
logger.error(`[Workflow] Failed to add approver at level:`, error);
throw error;
}
}
/** /**
* Add a new spectator to an existing workflow * Add a new spectator to an existing workflow
*/ */
@ -613,7 +882,7 @@ export class WorkflowService {
throw new Error('Invalid workflow identifier format'); throw new Error('Invalid workflow identifier format');
} }
logger.info(`Fetching participants for requestId: ${actualRequestId} (original identifier: ${requestId})`); // logger.info(`Fetching participants for requestId: ${actualRequestId} (original identifier: ${requestId})`);
// Load related entities explicitly to avoid alias issues // Load related entities explicitly to avoid alias issues
// Use the actual UUID requestId for all queries // Use the actual UUID requestId for all queries
@ -626,7 +895,7 @@ export class WorkflowService {
where: { requestId: actualRequestId } where: { requestId: actualRequestId }
}) as any[]; }) as any[];
logger.info(`Found ${participants.length} participants for requestId: ${actualRequestId}`); // logger.info(`Found ${participants.length} participants for requestId: ${actualRequestId}`);
const documents = await Document.findAll({ const documents = await Document.findAll({
where: { where: {
@ -638,13 +907,28 @@ export class WorkflowService {
try { try {
const { Activity } = require('@models/Activity'); const { Activity } = require('@models/Activity');
const rawActivities = await Activity.findAll({ const rawActivities = await Activity.findAll({
where: { requestId: actualRequestId }, where: {
requestId: actualRequestId,
activityType: { [Op.ne]: 'comment' } // Exclude comment type activities
},
order: [['created_at', 'ASC']], order: [['created_at', 'ASC']],
raw: true // Get raw data to access snake_case fields raw: true // Get raw data to access snake_case fields
}); });
// Transform activities to match frontend expected format // Transform activities to match frontend expected format
activities = rawActivities.map((act: any) => ({ activities = rawActivities
.filter((act: any) => {
const activityType = act.activity_type || act.activityType || '';
const description = (act.activity_description || act.activityDescription || '').toLowerCase();
// Filter out status changes to pending
if (activityType === 'status_change' && description.includes('pending')) {
return false;
}
return true;
})
.map((act: any) => ({
user: act.user_name || act.userName || 'System', user: act.user_name || act.userName || 'System',
type: act.activity_type || act.activityType || 'status_change', type: act.activity_type || act.activityType || 'status_change',
action: this.getActivityAction(act.activity_type || act.activityType), action: this.getActivityAction(act.activity_type || act.activityType),
@ -714,7 +998,7 @@ export class WorkflowService {
metadata: alert.metadata || {} metadata: alert.metadata || {}
})); }));
logger.info(`Found ${tatAlerts.length} TAT alerts for request ${actualRequestId}`); // logger.info(`Found ${tatAlerts.length} TAT alerts for request ${actualRequestId}`);
} catch (error) { } catch (error) {
logger.error('Error fetching TAT alerts:', error); logger.error('Error fetching TAT alerts:', error);
tatAlerts = []; tatAlerts = [];
@ -930,14 +1214,16 @@ export class WorkflowService {
// Schedule TAT notification jobs for the first level // Schedule TAT notification jobs for the first level
try { try {
const workflowPriority = (updated as any).priority || 'STANDARD';
await tatSchedulerService.scheduleTatJobs( await tatSchedulerService.scheduleTatJobs(
(updated as any).requestId, (updated as any).requestId,
(current as any).levelId, (current as any).levelId,
(current as any).approverId, (current as any).approverId,
Number((current as any).tatHours), Number((current as any).tatHours),
now now,
workflowPriority // Pass workflow priority (EXPRESS = 24/7, STANDARD = working hours)
); );
logger.info(`[Workflow] TAT jobs scheduled for first level of request ${(updated as any).requestNumber}`); logger.info(`[Workflow] TAT jobs scheduled for first level of request ${(updated as any).requestNumber} (Priority: ${workflowPriority})`);
} catch (tatError) { } catch (tatError) {
logger.error(`[Workflow] Failed to schedule TAT jobs:`, tatError); logger.error(`[Workflow] Failed to schedule TAT jobs:`, tatError);
// Don't fail the submission if TAT scheduling fails // Don't fail the submission if TAT scheduling fails

2
src/utils/responseHandler.ts
View File

@ -16,7 +16,7 @@ export class ResponseHandler {
timestamp: new Date(), timestamp: new Date(),
}; };
logger.info(`Success response: ${message}`, { statusCode, data });
res.status(statusCode).json(response); res.status(statusCode).json(response);
} }

118
src/utils/tatTimeUtils.ts
View File

@ -1,13 +1,58 @@
import dayjs, { Dayjs } from 'dayjs'; import dayjs, { Dayjs } from 'dayjs';
import { TAT_CONFIG, isTestMode } from '../config/tat.config'; import { TAT_CONFIG, isTestMode } from '../config/tat.config';
const WORK_START_HOUR = TAT_CONFIG.WORK_START_HOUR;
const WORK_END_HOUR = TAT_CONFIG.WORK_END_HOUR;
// Cache for holidays to avoid repeated DB queries // Cache for holidays to avoid repeated DB queries
let holidaysCache: Set<string> = new Set(); let holidaysCache: Set<string> = new Set();
let holidaysCacheExpiry: Date | null = null; let holidaysCacheExpiry: Date | null = null;
// Cache for working hours configuration
interface WorkingHoursConfig {
startHour: number;
endHour: number;
startDay: number;
endDay: number;
}
let workingHoursCache: WorkingHoursConfig | null = null;
let workingHoursCacheExpiry: Date | null = null;
/**
* Load working hours configuration from database and cache them
*/
async function loadWorkingHoursCache(): Promise<void> {
try {
// Reload cache every 5 minutes (shorter than holidays since it's more critical)
if (workingHoursCacheExpiry && new Date() < workingHoursCacheExpiry) {
return;
}
const { getWorkingHours, getConfigNumber } = await import('../services/configReader.service');
const hours = await getWorkingHours();
const startDay = await getConfigNumber('WORK_START_DAY', 1); // Monday
const endDay = await getConfigNumber('WORK_END_DAY', 5); // Friday
workingHoursCache = {
startHour: hours.startHour,
endHour: hours.endHour,
startDay: startDay,
endDay: endDay
};
workingHoursCacheExpiry = dayjs().add(5, 'minute').toDate();
console.log(`[TAT Utils] Loaded working hours: ${hours.startHour}:00-${hours.endHour}:00, Days: ${startDay}-${endDay}`);
} catch (error) {
console.error('[TAT Utils] Error loading working hours cache:', error);
// Fallback to default values from TAT_CONFIG
workingHoursCache = {
startHour: TAT_CONFIG.WORK_START_HOUR,
endHour: TAT_CONFIG.WORK_END_HOUR,
startDay: TAT_CONFIG.WORK_START_DAY,
endDay: TAT_CONFIG.WORK_END_DAY
};
console.log('[TAT Utils] Using fallback working hours from TAT_CONFIG');
}
}
/** /**
* Load holidays from database and cache them * Load holidays from database and cache them
*/ */
@ -44,7 +89,7 @@ function isHoliday(date: Dayjs): boolean {
/** /**
* Check if a given date is within working time * Check if a given date is within working time
* Working hours: Monday-Friday, 9 AM - 6 PM (configurable) * Working hours: Configured in admin settings (default: Monday-Friday, 9 AM - 6 PM)
* Excludes: Weekends (Sat/Sun) and holidays * Excludes: Weekends (Sat/Sun) and holidays
* In TEST MODE: All times are considered working time * In TEST MODE: All times are considered working time
*/ */
@ -54,16 +99,24 @@ function isWorkingTime(date: Dayjs): boolean {
return true; return true;
} }
// Use cached working hours (with fallback to TAT_CONFIG)
const config = workingHoursCache || {
startHour: TAT_CONFIG.WORK_START_HOUR,
endHour: TAT_CONFIG.WORK_END_HOUR,
startDay: TAT_CONFIG.WORK_START_DAY,
endDay: TAT_CONFIG.WORK_END_DAY
};
const day = date.day(); // 0 = Sun, 6 = Sat const day = date.day(); // 0 = Sun, 6 = Sat
const hour = date.hour(); const hour = date.hour();
// Check if weekend // Check if weekend (based on configured working days)
if (day < TAT_CONFIG.WORK_START_DAY || day > TAT_CONFIG.WORK_END_DAY) { if (day < config.startDay || day > config.endDay) {
return false; return false;
} }
// Check if outside working hours // Check if outside working hours (based on configured hours)
if (hour < WORK_START_HOUR || hour >= WORK_END_HOUR) { if (hour < config.startHour || hour >= config.endHour) {
return false; return false;
} }
@ -76,8 +129,9 @@ function isWorkingTime(date: Dayjs): boolean {
} }
/** /**
* Add working hours to a start date * Add working hours to a start date (STANDARD mode)
* Skips weekends, non-working hours, and holidays (unless in test mode) * Skips weekends, non-working hours, and holidays (unless in test mode)
* Uses dynamic working hours from admin configuration
* In TEST MODE: 1 hour = 1 minute for faster testing * In TEST MODE: 1 hour = 1 minute for faster testing
*/ */
export async function addWorkingHours(start: Date | string, hoursToAdd: number): Promise<Dayjs> { export async function addWorkingHours(start: Date | string, hoursToAdd: number): Promise<Dayjs> {
@ -88,7 +142,8 @@ export async function addWorkingHours(start: Date | string, hoursToAdd: number):
return current.add(hoursToAdd, 'minute'); return current.add(hoursToAdd, 'minute');
} }
// Load holidays cache if not loaded // Load working hours and holidays cache if not loaded
await loadWorkingHoursCache();
await loadHolidaysCache(); await loadHolidaysCache();
let remaining = hoursToAdd; let remaining = hoursToAdd;
@ -103,9 +158,27 @@ export async function addWorkingHours(start: Date | string, hoursToAdd: number):
return current; return current;
} }
/**
* Add calendar hours (EXPRESS mode - 24/7, no exclusions)
* For EXPRESS priority requests - counts all hours including holidays, weekends, non-working hours
* In TEST MODE: 1 hour = 1 minute for faster testing
*/
export function addCalendarHours(start: Date | string, hoursToAdd: number): Dayjs {
let current = dayjs(start);
// In test mode, convert hours to minutes for faster testing
if (isTestMode()) {
return current.add(hoursToAdd, 'minute');
}
// Express mode: Simply add hours without any exclusions (24/7)
return current.add(hoursToAdd, 'hour');
}
/** /**
* Synchronous version for backward compatibility (doesn't check holidays) * Synchronous version for backward compatibility (doesn't check holidays)
* Use addWorkingHours() for holiday-aware calculations * Use addWorkingHours() for holiday-aware calculations
* @deprecated Use async addWorkingHours() instead for accurate calculations
*/ */
export function addWorkingHoursSync(start: Date | string, hoursToAdd: number): Dayjs { export function addWorkingHoursSync(start: Date | string, hoursToAdd: number): Dayjs {
let current = dayjs(start); let current = dayjs(start);
@ -115,14 +188,23 @@ export function addWorkingHoursSync(start: Date | string, hoursToAdd: number): D
return current.add(hoursToAdd, 'minute'); return current.add(hoursToAdd, 'minute');
} }
// Use cached working hours with fallback
const config = workingHoursCache || {
startHour: TAT_CONFIG.WORK_START_HOUR,
endHour: TAT_CONFIG.WORK_END_HOUR,
startDay: TAT_CONFIG.WORK_START_DAY,
endDay: TAT_CONFIG.WORK_END_DAY
};
let remaining = hoursToAdd; let remaining = hoursToAdd;
while (remaining > 0) { while (remaining > 0) {
current = current.add(1, 'hour'); current = current.add(1, 'hour');
const day = current.day(); const day = current.day();
const hour = current.hour(); const hour = current.hour();
// Simple check without holidays // Simple check without holidays (but respects configured working hours)
if (day >= 1 && day <= 5 && hour >= WORK_START_HOUR && hour < WORK_END_HOUR) { if (day >= config.startDay && day <= config.endDay &&
hour >= config.startHour && hour < config.endHour) {
remaining -= 1; remaining -= 1;
} }
} }
@ -131,12 +213,22 @@ export function addWorkingHoursSync(start: Date | string, hoursToAdd: number): D
} }
/** /**
* Initialize holidays cache (call on server startup) * Initialize holidays and working hours cache (call on server startup)
*/ */
export async function initializeHolidaysCache(): Promise<void> { export async function initializeHolidaysCache(): Promise<void> {
await loadWorkingHoursCache();
await loadHolidaysCache(); await loadHolidaysCache();
} }
/**
* Clear working hours cache (call when admin updates configuration)
*/
export function clearWorkingHoursCache(): void {
workingHoursCache = null;
workingHoursCacheExpiry = null;
console.log('[TAT Utils] Working hours cache cleared');
}
/** /**
* Calculate TAT milestones (50%, 75%, 100%) * Calculate TAT milestones (50%, 75%, 100%)
* Returns Date objects for each milestone * Returns Date objects for each milestone