mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-02-14 16:38:41 -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
157 lines
5.9 KiB
Python
157 lines
5.9 KiB
Python
from app import db
|
|
from app.utils.timezone import now_in_app_timezone
|
|
|
|
class KanbanColumn(db.Model):
|
|
"""Model for custom Kanban board columns/task statuses"""
|
|
|
|
__tablename__ = 'kanban_columns'
|
|
|
|
id = db.Column(db.Integer, primary_key=True)
|
|
key = db.Column(db.String(50), unique=True, nullable=False, index=True) # Internal identifier (e.g. 'in_progress')
|
|
label = db.Column(db.String(100), nullable=False) # Display name (e.g. 'In Progress')
|
|
icon = db.Column(db.String(100), default='fas fa-circle') # Font Awesome icon class
|
|
color = db.Column(db.String(50), default='secondary') # Bootstrap color class or hex
|
|
position = db.Column(db.Integer, nullable=False, default=0, index=True) # Order in kanban board
|
|
is_active = db.Column(db.Boolean, default=True, nullable=False) # Can be disabled without deletion
|
|
is_system = db.Column(db.Boolean, default=False, nullable=False) # System columns cannot be deleted
|
|
is_complete_state = db.Column(db.Boolean, default=False, nullable=False) # Marks task as completed
|
|
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)
|
|
|
|
def __init__(self, **kwargs):
|
|
"""Initialize a new KanbanColumn"""
|
|
super(KanbanColumn, self).__init__(**kwargs)
|
|
|
|
def __repr__(self):
|
|
return f'<KanbanColumn {self.key}: {self.label}>'
|
|
|
|
def to_dict(self):
|
|
"""Convert column to dictionary for API responses"""
|
|
return {
|
|
'id': self.id,
|
|
'key': self.key,
|
|
'label': self.label,
|
|
'icon': self.icon,
|
|
'color': self.color,
|
|
'position': self.position,
|
|
'is_active': self.is_active,
|
|
'is_system': self.is_system,
|
|
'is_complete_state': self.is_complete_state,
|
|
'created_at': self.created_at.isoformat() if self.created_at else None,
|
|
'updated_at': self.updated_at.isoformat() if self.updated_at else None
|
|
}
|
|
|
|
@classmethod
|
|
def get_active_columns(cls):
|
|
"""Get all active columns ordered by position"""
|
|
try:
|
|
# Force a fresh query by using db.session directly and avoiding cache
|
|
from app import db
|
|
# This ensures we always get fresh data from the database
|
|
return db.session.query(cls).filter_by(is_active=True).order_by(cls.position.asc()).all()
|
|
except Exception as e:
|
|
# Table might not exist yet during migration
|
|
print(f"Warning: Could not load kanban columns: {e}")
|
|
return []
|
|
|
|
@classmethod
|
|
def get_all_columns(cls):
|
|
"""Get all columns (including inactive) ordered by position"""
|
|
try:
|
|
# Force a fresh query by using db.session directly and avoiding cache
|
|
from app import db
|
|
return db.session.query(cls).order_by(cls.position.asc()).all()
|
|
except Exception as e:
|
|
# Table might not exist yet during migration
|
|
print(f"Warning: Could not load all kanban columns: {e}")
|
|
return []
|
|
|
|
@classmethod
|
|
def get_column_by_key(cls, key):
|
|
"""Get column by its key"""
|
|
try:
|
|
return cls.query.filter_by(key=key).first()
|
|
except Exception as e:
|
|
# Table might not exist yet
|
|
print(f"Warning: Could not find kanban column by key: {e}")
|
|
return None
|
|
|
|
@classmethod
|
|
def get_valid_status_keys(cls):
|
|
"""Get list of all valid status keys (for validation)"""
|
|
columns = cls.get_active_columns()
|
|
if not columns:
|
|
# Fallback to default statuses if table doesn't exist
|
|
return ['todo', 'in_progress', 'review', 'done', 'cancelled']
|
|
return [col.key for col in columns]
|
|
|
|
@classmethod
|
|
def initialize_default_columns(cls):
|
|
"""Initialize default kanban columns if none exist"""
|
|
if cls.query.count() > 0:
|
|
return False # Columns already exist
|
|
|
|
default_columns = [
|
|
{
|
|
'key': 'todo',
|
|
'label': 'To Do',
|
|
'icon': 'fas fa-list-check',
|
|
'color': 'secondary',
|
|
'position': 0,
|
|
'is_system': True,
|
|
'is_complete_state': False
|
|
},
|
|
{
|
|
'key': 'in_progress',
|
|
'label': 'In Progress',
|
|
'icon': 'fas fa-spinner',
|
|
'color': 'warning',
|
|
'position': 1,
|
|
'is_system': True,
|
|
'is_complete_state': False
|
|
},
|
|
{
|
|
'key': 'review',
|
|
'label': 'Review',
|
|
'icon': 'fas fa-user-check',
|
|
'color': 'info',
|
|
'position': 2,
|
|
'is_system': False,
|
|
'is_complete_state': False
|
|
},
|
|
{
|
|
'key': 'done',
|
|
'label': 'Done',
|
|
'icon': 'fas fa-check-circle',
|
|
'color': 'success',
|
|
'position': 3,
|
|
'is_system': True,
|
|
'is_complete_state': True
|
|
}
|
|
]
|
|
|
|
for col_data in default_columns:
|
|
column = cls(**col_data)
|
|
db.session.add(column)
|
|
|
|
db.session.commit()
|
|
return True
|
|
|
|
@classmethod
|
|
def reorder_columns(cls, column_ids):
|
|
"""
|
|
Reorder columns based on list of IDs
|
|
column_ids: list of column IDs in the desired order
|
|
"""
|
|
for position, col_id in enumerate(column_ids):
|
|
column = cls.query.get(col_id)
|
|
if column:
|
|
column.position = position
|
|
column.updated_at = now_in_app_timezone()
|
|
|
|
db.session.commit()
|
|
# Expire all cached data to force fresh reads
|
|
db.session.expire_all()
|
|
return True
|
|
|