forked from rohit/spurrin-backend
230 lines
7.7 KiB
Markdown
230 lines
7.7 KiB
Markdown
# Changes Log
|
|
|
|
## [Unreleased]
|
|
|
|
### Added
|
|
- Created comprehensive README.md with project documentation
|
|
- Implemented structured error handling system
|
|
- Added validation middleware using Joi
|
|
- Created standardized response handlers
|
|
- Implemented async handler utility
|
|
- Added custom error classes
|
|
- Created hospital validation schemas
|
|
- Updated hospital routes with proper middleware
|
|
- Added role-based authorization
|
|
- Implemented request validation
|
|
- Added structured logging
|
|
- Created separate authorization middleware with role-based access control
|
|
- Created request validation middleware with Joi schema validation
|
|
- Added repository layer for database operations
|
|
- Implemented database connection pooling
|
|
- Added custom error classes for better error handling
|
|
- Improved error handling in service layer
|
|
|
|
### Changed
|
|
- Reorganized project structure into src directory
|
|
- Updated hospital controller to use new utilities
|
|
- Improved error handling in hospital routes
|
|
- Enhanced security with proper authentication
|
|
- Standardized API response format
|
|
- Improved code organization and readability
|
|
- Separated authentication and authorization middleware
|
|
- Enhanced validation middleware with better error handling and logging
|
|
- Refactored hospital routes for better middleware usage
|
|
- Moved logo upload logic to controller
|
|
- Updated hospital controller methods to use asyncHandler and standardized responses
|
|
- Standardized authentication and authorization across all hospital routes
|
|
- Improved error handling in hospital user and color management
|
|
- Refactored changePassword method to use asyncHandler and standardized responses
|
|
- Reordered hospital routes to prevent conflicts
|
|
- Fixed route parameter conflicts
|
|
- Moved database operations to repository layer
|
|
- Improved error handling with custom error classes
|
|
- Enhanced database connection management with connection pooling
|
|
|
|
### Removed
|
|
- Removed unused model file (superAdminModel.js)
|
|
- Cleaned up empty directories
|
|
- Removed redundant code
|
|
- Removed inline route handlers in favor of controller methods
|
|
- Removed duplicate hospital list method
|
|
- Removed old authentication middleware usage
|
|
- Removed redundant token validation in changePassword method
|
|
- Removed unused imports from hospital routes
|
|
- Removed direct database queries from service layer
|
|
|
|
### Fixed
|
|
- Fixed error handling in hospital controller
|
|
- Improved validation error messages
|
|
- Enhanced security in authentication flow
|
|
- Fixed response format consistency
|
|
- Fixed asyncHandler import and usage in hospital controller
|
|
- Fixed authorize function import and usage in hospital routes
|
|
- Fixed validateRequest middleware implementation
|
|
- Fixed validateRequest import in hospital routes
|
|
- Fixed missing getAllHospitals method in hospital controller
|
|
- Fixed error handling in hospital controller methods
|
|
- Fixed inconsistent authentication middleware usage
|
|
- Fixed missing controller methods and their implementations
|
|
- Fixed undefined route handler in changePassword endpoint
|
|
- Fixed route conflicts between /users and /:id endpoints
|
|
- Fixed missing changePassword route
|
|
- Fixed route ordering to prevent parameter conflicts
|
|
- Fixed database connection handling
|
|
- Fixed error propagation in service layer
|
|
|
|
## [0.1.0] - Initial Setup
|
|
|
|
### Added
|
|
- Basic project structure
|
|
- Database configuration
|
|
- Authentication middleware
|
|
- Hospital management endpoints
|
|
- File upload functionality
|
|
- Email notification system
|
|
- User management system
|
|
- Password reset functionality
|
|
- Interaction logging system
|
|
|
|
### Security
|
|
- Implemented JWT authentication
|
|
- Added password hashing
|
|
- Implemented role-based access control
|
|
- Added input validation
|
|
- Implemented secure file uploads
|
|
- Added email verification system
|
|
|
|
### Performance
|
|
- Implemented database connection pooling
|
|
- Added request compression
|
|
- Optimized database queries
|
|
- Implemented caching where appropriate
|
|
|
|
### Documentation
|
|
- Added API documentation
|
|
- Created setup instructions
|
|
- Added security guidelines
|
|
- Included contribution guidelines
|
|
|
|
## Hospital Module Improvements
|
|
|
|
### Code Structure and Organization
|
|
- [x] Created dedicated `HospitalService` class for business logic
|
|
- [x] Separated concerns between routes, controller, and service layers
|
|
- [x] Improved error handling and validation
|
|
- [x] Removed duplicate code
|
|
- [x] Added proper input validation
|
|
- [x] Organized routes with proper middleware
|
|
- [x] Added repository layer for database operations
|
|
- [x] Implemented database connection pooling
|
|
- [x] Added custom error classes
|
|
|
|
### Security Enhancements
|
|
- [x] Added rate limiting (100 requests per 15 minutes per IP)
|
|
- [x] Improved file upload security
|
|
- Added file type validation (JPEG, PNG, GIF)
|
|
- Set file size limit (5MB)
|
|
- Secure file naming
|
|
- [x] Added input validation through schemas
|
|
- [x] Enhanced error messages
|
|
- [x] Implemented proper authentication middleware
|
|
- [x] Added authorization checks
|
|
|
|
### Database Optimization
|
|
- [x] Improved query structure
|
|
- [x] Added proper error handling for database operations
|
|
- [x] Implemented better transaction handling
|
|
- [x] Added validation before database operations
|
|
- [x] Improved error messages for database operations
|
|
- [x] Implemented connection pooling
|
|
- [x] Added repository layer for better database abstraction
|
|
|
|
### Additional Improvements
|
|
- [x] Better error handling and logging
|
|
- [x] Consistent response formats
|
|
- [x] Improved code readability
|
|
- [x] Better separation of concerns
|
|
- [x] Added proper validation for all inputs
|
|
- [x] Improved file upload handling
|
|
- [x] Added custom error classes
|
|
- [x] Improved error propagation
|
|
|
|
### Pending Improvements
|
|
- [ ] Add query caching for frequently accessed data
|
|
- [ ] Add request sanitization
|
|
- [ ] Implement proper CORS configuration
|
|
- [ ] Add security headers
|
|
- [ ] Add API documentation
|
|
- [ ] Add unit tests
|
|
- [ ] Add integration tests
|
|
- [ ] Add API tests
|
|
|
|
## File Structure Changes
|
|
```
|
|
src/
|
|
├── controllers/
|
|
│ └── hospitalController.js # Simplified controller with service usage
|
|
├── services/
|
|
│ └── hospitalService.js # Business logic layer
|
|
├── repositories/
|
|
│ └── hospitalRepository.js # Database operations layer
|
|
├── routes/
|
|
│ └── hospitals.js # Updated with security and validation
|
|
├── middlewares/
|
|
│ ├── authMiddleware.js # Authentication middleware
|
|
│ ├── authorizeMiddleware.js # Authorization middleware
|
|
│ └── validateRequest.js # Request validation middleware
|
|
├── utils/
|
|
│ └── errors.js # Custom error classes
|
|
└── validators/
|
|
└── hospitalValidator.js # Validation schemas
|
|
```
|
|
|
|
## Security Improvements
|
|
1. Rate Limiting
|
|
- Added express-rate-limit
|
|
- 100 requests per 15 minutes per IP
|
|
- Custom error message for rate limit exceeded
|
|
|
|
2. File Upload Security
|
|
- File type validation
|
|
- File size limits
|
|
- Secure file naming
|
|
- Proper error handling
|
|
|
|
3. Input Validation
|
|
- Added validation schemas
|
|
- Proper error messages
|
|
- Type checking
|
|
- Required field validation
|
|
|
|
4. Authentication & Authorization
|
|
- Token-based authentication
|
|
- Role-based authorization
|
|
- Proper error handling for unauthorized access
|
|
|
|
## Performance Improvements
|
|
1. Database Operations
|
|
- Optimized queries
|
|
- Better error handling
|
|
- Transaction support
|
|
- Input validation before database operations
|
|
- Connection pooling
|
|
- Repository pattern implementation
|
|
|
|
2. Code Organization
|
|
- Service layer for business logic
|
|
- Repository layer for database operations
|
|
- Controller for request handling
|
|
- Routes for endpoint definition
|
|
- Middleware for cross-cutting concerns
|
|
|
|
## Next Steps
|
|
1. Implement query caching
|
|
2. Add comprehensive testing
|
|
3. Add API documentation
|
|
4. Enhance security measures
|
|
5. Add monitoring and logging
|
|
|
|
flag added to trigger logout to both websockets (secondary and main)
|