mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-01-14 07:50:18 -06:00
This commit introduces a comprehensive Kanban board customization system and improves CSRF token configuration for Docker deployments. ## Major Features ### 1. Customizable Kanban Board Columns Add complete kanban column customization system allowing users to define custom workflow states beyond the default columns. **New Components:** - Add KanbanColumn model with full CRUD operations (app/models/kanban_column.py) - Add kanban routes blueprint with admin endpoints (app/routes/kanban.py) - Add kanban column management templates (app/templates/kanban/) - Add migration 019 for kanban_columns table (migrations/) **Features:** - Create unlimited custom columns with unique keys, labels, icons, and colors - Drag-and-drop column reordering with position persistence - Toggle column visibility without deletion - Protected system columns (todo, in_progress, done) prevent accidental deletion - Complete state marking for columns that should mark tasks as done - Real-time updates via SocketIO broadcasts when columns change - Font Awesome icon support (5000+ icons) - Bootstrap color scheme integration - Comprehensive validation and error handling **Integration:** - Update Task model to work with dynamic column statuses (app/models/task.py) - Update task routes to use kanban column API (app/routes/tasks.py) - Update project routes to fetch active columns (app/routes/projects.py) - Add kanban column management links to base template (app/templates/base.html) - Update kanban board templates to render dynamic columns (app/templates/tasks/) - Add cache prevention headers to force fresh column data **API Endpoints:** - GET /api/kanban/columns - Fetch all active columns - POST /api/kanban/columns/reorder - Reorder columns - GET /kanban/columns - Column management interface (admin only) - POST /kanban/columns/create - Create new column (admin only) - POST /kanban/columns/<id>/edit - Edit column (admin only) - POST /kanban/columns/<id>/delete - Delete column (admin only) - POST /kanban/columns/<id>/toggle - Toggle column visibility (admin only) ### 2. Enhanced CSRF Configuration Improve CSRF token configuration and documentation for Docker deployments. **Configuration Updates:** - Add WTF_CSRF_ENABLED environment variable to all docker-compose files - Add WTF_CSRF_TIME_LIMIT environment variable with 1-hour default - Update app/config.py to read CSRF settings from environment - Add SECRET_KEY validation in app/__init__.py to prevent production deployment with default keys **Docker Compose Updates:** - docker-compose.yml: CSRF enabled by default for security testing - docker-compose.remote.yml: CSRF always enabled in production - docker-compose.remote-dev.yml: CSRF enabled with production-like settings - docker-compose.local-test.yml: CSRF can be disabled for local testing - Add helpful comments explaining each CSRF-related environment variable - Update env.example with CSRF configuration examples **Verification Scripts:** - Add scripts/verify_csrf_config.sh for Unix systems - Add scripts/verify_csrf_config.bat for Windows systems - Scripts check SECRET_KEY, CSRF_ENABLED, and CSRF_TIME_LIMIT settings ### 3. Database Initialization Improvements - Update app/__init__.py to run pending migrations on startup - Add automatic kanban column initialization after migrations - Improve error handling and logging during database setup ### 4. Configuration Management - Update app/config.py with new CSRF and kanban-related settings - Add environment variable parsing with sensible defaults - Improve configuration validation and error messages ## Documentation ### New Documentation Files - CUSTOM_KANBAN_README.md: Quick start guide for kanban customization - KANBAN_CUSTOMIZATION.md: Detailed technical documentation - IMPLEMENTATION_SUMMARY.md: Implementation details and architecture - KANBAN_AUTO_REFRESH_COMPLETE.md: Real-time update system documentation - KANBAN_REFRESH_FINAL_FIX.md: Cache and refresh troubleshooting - KANBAN_REFRESH_SOLUTION.md: Technical solution for data freshness - docs/CSRF_CONFIGURATION.md: Comprehensive CSRF setup guide - CSRF_DOCKER_CONFIGURATION_SUMMARY.md: Docker-specific CSRF setup - CSRF_TROUBLESHOOTING.md: Common CSRF issues and solutions - APPLY_KANBAN_MIGRATION.md: Migration application guide - APPLY_FIXES_NOW.md: Quick fix reference - DEBUG_KANBAN_COLUMNS.md: Debugging guide - DIAGNOSIS_STEPS.md: System diagnosis procedures - BROWSER_CACHE_FIX.md: Browser cache troubleshooting - FORCE_NO_CACHE_FIX.md: Cache prevention solutions - SESSION_CLOSE_ERROR_FIX.md: Session handling fixes - QUICK_FIX.md: Quick reference for common fixes ### Updated Documentation - README.md: Add kanban customization feature description - Update project documentation with new features ## Testing ### New Test Files - test_kanban_refresh.py: Test kanban column refresh functionality ## Technical Details **Database Changes:** - New table: kanban_columns with 11 columns - Indexes on: key, position - Default data: 4 system columns (todo, in_progress, review, done) - Support for both SQLite (development) and PostgreSQL (production) **Real-Time Updates:** - SocketIO events: 'kanban_columns_updated' with action type - Automatic page refresh when columns are created/updated/deleted/reordered - Prevents stale data by expiring SQLAlchemy caches after changes **Security:** - Admin-only access to column management - CSRF protection on all column mutation endpoints - API endpoints exempt from CSRF (use JSON and other auth mechanisms) - System column protection prevents data integrity issues - Validation prevents deletion of columns with active tasks **Performance:** - Efficient querying with position-based ordering - Cached column data with cache invalidation on changes - No-cache headers on API responses to prevent stale data - Optimized database indexes for fast lookups ## Breaking Changes None. This is a fully backward-compatible addition. Existing workflows continue to work with the default columns. Custom columns are opt-in via the admin interface. ## Migration Notes 1. Run migration 019 to create kanban_columns table 2. Default columns are initialized automatically on first run 3. No data migration needed for existing tasks 4. Existing task statuses map to new column keys ## Environment Variables New environment variables (all optional with defaults): - WTF_CSRF_ENABLED: Enable/disable CSRF protection (default: true) - WTF_CSRF_TIME_LIMIT: CSRF token expiration in seconds (default: 3600) - SECRET_KEY: Required in production, must be cryptographically secure See env.example for complete configuration reference. ## Deployment Notes
298 lines
11 KiB
Python
298 lines
11 KiB
Python
from datetime import datetime
|
|
from app import db
|
|
from app.utils.timezone import now_in_app_timezone
|
|
|
|
class Task(db.Model):
|
|
"""Task model for breaking down projects into manageable components"""
|
|
|
|
__tablename__ = 'tasks'
|
|
|
|
id = db.Column(db.Integer, primary_key=True)
|
|
project_id = db.Column(db.Integer, db.ForeignKey('projects.id'), nullable=False, index=True)
|
|
name = db.Column(db.String(200), nullable=False, index=True)
|
|
description = db.Column(db.Text, nullable=True)
|
|
status = db.Column(db.String(20), default='todo', nullable=False, index=True) # 'todo', 'in_progress', 'review', 'done', 'cancelled'
|
|
priority = db.Column(db.String(20), default='medium', nullable=False) # 'low', 'medium', 'high', 'urgent'
|
|
estimated_hours = db.Column(db.Float, nullable=True)
|
|
due_date = db.Column(db.Date, nullable=True, index=True)
|
|
assigned_to = db.Column(db.Integer, db.ForeignKey('users.id'), nullable=True, index=True)
|
|
created_by = db.Column(db.Integer, db.ForeignKey('users.id'), nullable=False, index=True)
|
|
created_at = db.Column(db.DateTime, default=now_in_app_timezone, nullable=False)
|
|
updated_at = db.Column(db.DateTime, default=now_in_app_timezone, onupdate=now_in_app_timezone, nullable=False)
|
|
started_at = db.Column(db.DateTime, nullable=True)
|
|
completed_at = db.Column(db.DateTime, nullable=True)
|
|
|
|
# Relationships
|
|
# project relationship is defined via backref in Project model
|
|
assigned_user = db.relationship('User', foreign_keys=[assigned_to], backref='assigned_tasks')
|
|
creator = db.relationship('User', foreign_keys=[created_by], backref='created_tasks')
|
|
time_entries = db.relationship('TimeEntry', backref='task', lazy='dynamic', cascade='all, delete-orphan')
|
|
# comments relationship is defined via backref in Comment model
|
|
|
|
def __init__(self, project_id, name, description=None, priority='medium', estimated_hours=None,
|
|
due_date=None, assigned_to=None, created_by=None):
|
|
self.project_id = project_id
|
|
self.name = name.strip()
|
|
self.description = description.strip() if description else None
|
|
self.priority = priority
|
|
self.estimated_hours = estimated_hours
|
|
self.due_date = due_date
|
|
self.assigned_to = assigned_to
|
|
self.created_by = created_by
|
|
|
|
def __repr__(self):
|
|
return f'<Task {self.name} ({self.status})>'
|
|
|
|
@property
|
|
def is_active(self):
|
|
"""Check if task is active (not done or cancelled)"""
|
|
return self.status not in ['done', 'cancelled']
|
|
|
|
@property
|
|
def is_overdue(self):
|
|
"""Check if task is overdue"""
|
|
if not self.due_date:
|
|
return False
|
|
from datetime import date
|
|
return date.today() > self.due_date and self.status not in ['done', 'cancelled']
|
|
|
|
@property
|
|
def total_hours(self):
|
|
"""Calculate total hours spent on this task"""
|
|
try:
|
|
total_seconds = db.session.query(
|
|
db.func.sum(
|
|
db.func.coalesce(
|
|
db.func.extract('epoch',
|
|
db.func.greatest(
|
|
db.func.least(
|
|
db.func.coalesce(self.time_entries.end_time, now_in_app_timezone()),
|
|
now_in_app_timezone()
|
|
) - self.time_entries.start_time
|
|
)
|
|
),
|
|
0
|
|
)
|
|
)
|
|
).filter(
|
|
self.time_entries.project_id == self.project_id
|
|
).scalar() or 0
|
|
|
|
return round(total_seconds / 3600, 2)
|
|
except Exception:
|
|
return 0.0
|
|
|
|
@property
|
|
def total_billable_hours(self):
|
|
"""Calculate total billable hours spent on this task"""
|
|
try:
|
|
from .time_entry import TimeEntry
|
|
total_seconds = db.session.query(
|
|
db.func.sum(TimeEntry.duration_seconds)
|
|
).filter(
|
|
TimeEntry.task_id == self.id,
|
|
TimeEntry.end_time.isnot(None),
|
|
TimeEntry.billable == True
|
|
).scalar() or 0
|
|
return round(total_seconds / 3600, 2)
|
|
except Exception:
|
|
return 0.0
|
|
|
|
@property
|
|
def progress_percentage(self):
|
|
"""Calculate progress percentage based on estimated vs actual hours"""
|
|
if not self.estimated_hours or self.estimated_hours == 0:
|
|
return 0
|
|
|
|
actual_hours = self.total_hours
|
|
if actual_hours >= self.estimated_hours:
|
|
return 100
|
|
|
|
return round((actual_hours / self.estimated_hours) * 100, 1)
|
|
|
|
@property
|
|
def status_display(self):
|
|
"""Get human-readable status from kanban columns"""
|
|
from .kanban_column import KanbanColumn
|
|
column = KanbanColumn.get_column_by_key(self.status)
|
|
if column:
|
|
return column.label
|
|
# Fallback to hardcoded map if column not found
|
|
status_map = {
|
|
'todo': 'To Do',
|
|
'in_progress': 'In Progress',
|
|
'review': 'Review',
|
|
'done': 'Done',
|
|
'cancelled': 'Cancelled'
|
|
}
|
|
return status_map.get(self.status, self.status.replace('_', ' ').title())
|
|
|
|
@property
|
|
def priority_display(self):
|
|
"""Get human-readable priority"""
|
|
priority_map = {
|
|
'low': 'Low',
|
|
'medium': 'Medium',
|
|
'high': 'High',
|
|
'urgent': 'Urgent'
|
|
}
|
|
return priority_map.get(self.priority, self.priority)
|
|
|
|
@property
|
|
def priority_class(self):
|
|
"""Get CSS class for priority styling"""
|
|
priority_classes = {
|
|
'low': 'priority-low',
|
|
'medium': 'priority-medium',
|
|
'high': 'priority-high',
|
|
'urgent': 'priority-urgent'
|
|
}
|
|
return priority_classes.get(self.priority, 'priority-medium')
|
|
|
|
def start_task(self):
|
|
"""Mark task as in progress"""
|
|
if self.status == 'done':
|
|
raise ValueError("Cannot start a completed task")
|
|
|
|
self.status = 'in_progress'
|
|
self.started_at = now_in_app_timezone()
|
|
self.updated_at = now_in_app_timezone()
|
|
db.session.commit()
|
|
|
|
def pause_task(self):
|
|
"""Pause task (mark as todo)"""
|
|
if self.status != 'in_progress':
|
|
raise ValueError("Can only pause tasks that are in progress")
|
|
|
|
self.status = 'todo'
|
|
self.updated_at = now_in_app_timezone()
|
|
db.session.commit()
|
|
|
|
def mark_for_review(self):
|
|
"""Mark task as ready for review"""
|
|
if self.status not in ['in_progress', 'todo']:
|
|
raise ValueError("Task must be in progress or todo to mark for review")
|
|
|
|
self.status = 'review'
|
|
self.updated_at = now_in_app_timezone()
|
|
db.session.commit()
|
|
|
|
def complete_task(self):
|
|
"""Mark task as completed"""
|
|
if self.status == 'cancelled':
|
|
raise ValueError("Cannot complete a cancelled task")
|
|
|
|
self.status = 'done'
|
|
self.completed_at = now_in_app_timezone()
|
|
self.updated_at = now_in_app_timezone()
|
|
db.session.commit()
|
|
|
|
def cancel_task(self):
|
|
"""Cancel the task"""
|
|
if self.status == 'done':
|
|
raise ValueError("Cannot cancel a completed task")
|
|
|
|
self.status = 'cancelled'
|
|
self.updated_at = now_in_app_timezone()
|
|
db.session.commit()
|
|
|
|
def reassign(self, user_id):
|
|
"""Reassign task to different user"""
|
|
self.assigned_to = user_id
|
|
self.updated_at = now_in_app_timezone()
|
|
db.session.commit()
|
|
|
|
def update_priority(self, priority):
|
|
"""Update task priority"""
|
|
valid_priorities = ['low', 'medium', 'high', 'urgent']
|
|
if priority not in valid_priorities:
|
|
raise ValueError(f"Invalid priority. Must be one of: {', '.join(valid_priorities)}")
|
|
|
|
self.priority = priority
|
|
self.updated_at = now_in_app_timezone()
|
|
db.session.commit()
|
|
|
|
def update_due_date(self, due_date):
|
|
"""Update task due date"""
|
|
self.due_date = due_date
|
|
self.updated_at = now_in_app_timezone()
|
|
db.session.commit()
|
|
|
|
def to_dict(self):
|
|
"""Convert task to dictionary for API responses"""
|
|
return {
|
|
'id': self.id,
|
|
'project_id': self.project_id,
|
|
'name': self.name,
|
|
'description': self.description,
|
|
'status': self.status,
|
|
'status_display': self.status_display,
|
|
'priority': self.priority,
|
|
'priority_display': self.priority_display,
|
|
'priority_class': self.priority_class,
|
|
'estimated_hours': self.estimated_hours,
|
|
'due_date': self.due_date.isoformat() if self.due_date else None,
|
|
'assigned_to': self.assigned_to,
|
|
'assigned_user': self.assigned_user.username if self.assigned_user else None,
|
|
'created_by': self.created_by,
|
|
'creator': self.creator.username if self.creator else None,
|
|
'created_at': self.created_at.isoformat() if self.created_at else None,
|
|
'updated_at': self.updated_at.isoformat() if self.updated_at else None,
|
|
'started_at': self.started_at.isoformat() if self.started_at else None,
|
|
'completed_at': self.completed_at.isoformat() if self.completed_at else None,
|
|
'total_hours': self.total_hours,
|
|
'total_billable_hours': self.total_billable_hours,
|
|
'progress_percentage': self.progress_percentage,
|
|
'is_active': self.is_active,
|
|
'is_overdue': self.is_overdue
|
|
}
|
|
|
|
@classmethod
|
|
def get_tasks_by_project(cls, project_id, status=None, priority=None):
|
|
"""Get tasks for a specific project with optional filters"""
|
|
query = cls.query.filter_by(project_id=project_id)
|
|
|
|
if status:
|
|
query = query.filter_by(status=status)
|
|
|
|
if priority:
|
|
query = query.filter_by(priority=priority)
|
|
|
|
return query.order_by(cls.priority.desc(), cls.due_date.asc(), cls.created_at.asc()).all()
|
|
|
|
@classmethod
|
|
def get_user_tasks(cls, user_id, status=None, include_assigned=True, include_created=True):
|
|
"""Get tasks for a specific user"""
|
|
if not include_assigned and not include_created:
|
|
return []
|
|
|
|
query = cls.query
|
|
|
|
if include_assigned and include_created:
|
|
query = query.filter(
|
|
db.or_(
|
|
cls.assigned_to == user_id,
|
|
cls.created_by == user_id
|
|
)
|
|
)
|
|
elif include_assigned:
|
|
query = query.filter_by(assigned_to=user_id)
|
|
elif include_created:
|
|
query = query.filter_by(created_by=user_id)
|
|
|
|
if status:
|
|
query = query.filter_by(status=status)
|
|
|
|
return query.order_by(cls.priority.desc(), cls.due_date.asc(), cls.created_at.asc()).all()
|
|
|
|
@classmethod
|
|
def get_overdue_tasks(cls):
|
|
"""Get all overdue tasks"""
|
|
from datetime import date
|
|
today = date.today()
|
|
|
|
return cls.query.filter(
|
|
cls.due_date < today,
|
|
cls.status.in_(['todo', 'in_progress', 'review'])
|
|
).order_by(cls.priority.desc(), cls.due_date.asc()).all()
|