mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-05-06 20:40:38 -05:00
Dries Peeters
9d1ece5263
This commit implements a complete architectural transformation of the TimeTracker application, introducing modern design patterns and comprehensive feature set. ## Architecture Improvements ### Service Layer (18 Services) - TimeTrackingService: Time entry management with timer functionality - ProjectService: Project operations and lifecycle management - InvoiceService: Invoice creation, management, and status tracking - TaskService: Task management and workflow - ExpenseService: Expense tracking and categorization - ClientService: Client relationship management - PaymentService: Payment processing and invoice reconciliation - CommentService: Comment system for projects, tasks, and quotes - UserService: User management and role operations - NotificationService: Notification delivery system - ReportingService: Report generation and analytics - AnalyticsService: Event tracking and analytics - ExportService: CSV export functionality - ImportService: CSV import with validation - EmailService: Email operations and invoice delivery - PermissionService: Role-based permission management - BackupService: Database backup operations - HealthService: System health checks and monitoring ### Repository Layer (9 Repositories) - BaseRepository: Generic CRUD operations - TimeEntryRepository: Time entry data access - ProjectRepository: Project data access with filtering - InvoiceRepository: Invoice queries and status management - TaskRepository: Task data access - ExpenseRepository: Expense data access - ClientRepository: Client data access - UserRepository: User data access - PaymentRepository: Payment data access - CommentRepository: Comment data access ### Schema Layer (9 Schemas) - Marshmallow schemas for validation and serialization - Create, update, and full schemas for all entities - Input validation and data transformation ### Utility Modules (15 Utilities) - api_responses: Standardized API response helpers - validation: Input validation utilities - query_optimization: N+1 query prevention and eager loading - error_handlers: Centralized error handling - cache: Caching foundation (Redis-ready) - transactions: Transaction management decorators - event_bus: Domain event system - performance: Performance monitoring decorators - logger: Enhanced structured logging - pagination: Pagination utilities - file_upload: Secure file upload handling - search: Full-text search utilities - rate_limiting: Rate limiting helpers - config_manager: Configuration management - datetime_utils: Enhanced date/time utilities ## Database Improvements - Performance indexes migration (15+ indexes) - Query optimization utilities - N+1 query prevention patterns ## Testing Infrastructure - Comprehensive test fixtures (conftest.py) - Service layer unit tests - Repository layer unit tests - Integration test examples ## CI/CD Pipeline - GitHub Actions workflow - Automated linting (Black, Flake8, Pylint) - Security scanning (Bandit, Safety, Semgrep) - Automated testing with coverage - Docker image builds ## Documentation - Architecture migration guide - Quick start guide - API enhancements documentation - Implementation summaries - Refactored route examples ## Key Benefits - Separation of concerns: Business logic decoupled from routes - Testability: Services and repositories can be tested in isolation - Maintainability: Consistent patterns across codebase - Performance: Database indexes and query optimization - Security: Input validation and security scanning - Scalability: Event-driven architecture and health checks ## Statistics - 70+ new files created - 8,000+ lines of code - 18 services, 9 repositories, 9 schemas - 15 utility modules - 5 test files with examples This transformation establishes a solid foundation for future development and follows industry best practices for maintainable, scalable applications.
109 lines
3.1 KiB
Python
109 lines
3.1 KiB
Python
"""
|
|
Service for expense business logic.
|
|
"""
|
|
|
|
from typing import Optional, Dict, Any, List
|
|
from datetime import date
|
|
from decimal import Decimal
|
|
from app import db
|
|
from app.repositories import ExpenseRepository, ProjectRepository
|
|
from app.models import Expense
|
|
from app.utils.db import safe_commit
|
|
|
|
|
|
class ExpenseService:
|
|
"""Service for expense operations"""
|
|
|
|
def __init__(self):
|
|
self.expense_repo = ExpenseRepository()
|
|
self.project_repo = ProjectRepository()
|
|
|
|
def create_expense(
|
|
self,
|
|
project_id: int,
|
|
amount: Decimal,
|
|
description: str,
|
|
expense_date: date,
|
|
category_id: Optional[int] = None,
|
|
billable: bool = False,
|
|
receipt_path: Optional[str] = None,
|
|
created_by: int
|
|
) -> Dict[str, Any]:
|
|
"""
|
|
Create a new expense.
|
|
|
|
Returns:
|
|
dict with 'success', 'message', and 'expense' keys
|
|
"""
|
|
# Validate project
|
|
project = self.project_repo.get_by_id(project_id)
|
|
if not project:
|
|
return {
|
|
'success': False,
|
|
'message': 'Invalid project',
|
|
'error': 'invalid_project'
|
|
}
|
|
|
|
# Validate amount
|
|
if amount <= 0:
|
|
return {
|
|
'success': False,
|
|
'message': 'Amount must be greater than zero',
|
|
'error': 'invalid_amount'
|
|
}
|
|
|
|
# Create expense
|
|
expense = self.expense_repo.create(
|
|
project_id=project_id,
|
|
amount=amount,
|
|
description=description,
|
|
date=expense_date,
|
|
category_id=category_id,
|
|
billable=billable,
|
|
receipt_path=receipt_path,
|
|
created_by=created_by
|
|
)
|
|
|
|
if not safe_commit('create_expense', {'project_id': project_id, 'created_by': created_by}):
|
|
return {
|
|
'success': False,
|
|
'message': 'Could not create expense due to a database error',
|
|
'error': 'database_error'
|
|
}
|
|
|
|
return {
|
|
'success': True,
|
|
'message': 'Expense created successfully',
|
|
'expense': expense
|
|
}
|
|
|
|
def get_project_expenses(
|
|
self,
|
|
project_id: int,
|
|
start_date: Optional[date] = None,
|
|
end_date: Optional[date] = None
|
|
) -> List[Expense]:
|
|
"""Get expenses for a project"""
|
|
return self.expense_repo.get_by_project(
|
|
project_id=project_id,
|
|
start_date=start_date,
|
|
end_date=end_date,
|
|
include_relations=True
|
|
)
|
|
|
|
def get_total_expenses(
|
|
self,
|
|
project_id: Optional[int] = None,
|
|
start_date: Optional[date] = None,
|
|
end_date: Optional[date] = None,
|
|
billable_only: bool = False
|
|
) -> float:
|
|
"""Get total expense amount"""
|
|
return self.expense_repo.get_total_amount(
|
|
project_id=project_id,
|
|
start_date=start_date,
|
|
end_date=end_date,
|
|
billable_only=billable_only
|
|
)
|
|
|