🗄️ PostgreSQL Database Schema & Migration System Implementation

[codegen-sh]

🗄️ PostgreSQL Database Schema & Migration System

🎯 Overview

This PR implements a comprehensive PostgreSQL database schema and migration system to replace the current file-based task storage with a robust, scalable database solution that supports all 21 task-manager components.

✨ Key Features Implemented

🏗️ Database Schema

• Complete PostgreSQL schema with 7 core tables and supporting structures
• JSONB support for flexible requirements, dependencies, and acceptance criteria
• Hierarchical task relationships with subtasks and dependencies
• Circular dependency prevention through database triggers
• Full-text search capabilities with GIN indexes
• Comprehensive indexing strategy for optimal query performance

🔄 Migration System

• Version-controlled migrations with rollback support
• Data integrity validation and checksum verification
• Automatic backup creation before migrations
• CLI interface for migration management
• Migration from existing JSON files to PostgreSQL

🔌 Connection Management

• Connection pooling with configurable parameters
• Transaction support with automatic rollback on errors
• Health monitoring and automatic reconnection
• Environment-specific configurations (dev/test/prod)
• Query logging and performance monitoring

📊 Data Models & Repository Pattern

• Task and Project models with validation and business logic
• Repository pattern for clean data access layer
• Advanced querying capabilities (search, filters, pagination)
• Relationship management (subtasks, dependencies)
• Bulk operations for performance optimization

📁 Files Added/Modified

Core Database Files

• src/database/schema.sql - Complete database schema
• src/database/connection.js - PostgreSQL connection manager
• src/config/database.js - Database configuration management

Migration System

• src/database/migrations/migration_runner.js - Migration framework
• src/database/migrations/001_initial_schema.js - Initial schema creation
• src/database/migrations/002_create_indexes.js - Performance indexes
• src/database/migrations/003_create_triggers.js - Data integrity triggers
• src/database/migrations/004_migrate_existing_data.js - JSON to PostgreSQL migration

Models & Repositories

• src/database/models/Task.js - Task model with validation
• src/database/models/Project.js - Project model with relationships
• src/database/repositories/TaskRepository.js - Advanced task operations

Testing & Documentation

• tests/database/connection.test.js - Connection manager tests
• tests/database/models.test.js - Model validation tests
• src/database/README.md - Comprehensive documentation
• .env.example - Environment configuration template

🚀 Database Schema Highlights

Tasks Table

CREATE TABLE tasks (
    id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
    title VARCHAR(255) NOT NULL,
    description TEXT,
    requirements JSONB,
    dependencies JSONB,
    acceptance_criteria JSONB,
    complexity_score INTEGER DEFAULT 0,
    status task_status DEFAULT 'backlog',
    priority VARCHAR(50) DEFAULT 'medium',
    parent_task_id UUID REFERENCES tasks(id),
    project_id UUID REFERENCES projects(id),
    -- ... additional fields
);

Key Relationships

• Subtasks: Many-to-many self-referencing with order tracking
• Dependencies: Task blocking relationships with type classification
• Projects: Grouping and context management
• Execution History: Performance tracking and learning data

🔧 Usage Examples

Database Connection

import db from './src/database/connection.js';

await db.initialize();
const result = await db.query('SELECT * FROM tasks WHERE status = $1', ['backlog']);

Using Models

import Task from './src/database/models/Task.js';

const task = new Task({
  title: 'Implement feature X',
  priority: 'high',
  status: 'backlog'
});
await task.save();

Migration Commands

npm run db:migrate     # Run pending migrations
npm run db:status      # Check migration status
npm run db:rollback    # Rollback last migration
npm run db:validate    # Validate integrity

📈 Performance Features

• Optimized indexes for common query patterns
• Connection pooling with configurable limits
• Query optimization with prepared statements
• Full-text search with ranking
• Bulk operations for large datasets

🛡️ Security & Integrity

• Parameterized queries prevent SQL injection
• Foreign key constraints ensure referential integrity
• Check constraints validate data ranges
• Triggers prevent circular dependencies
• SSL/TLS support for encrypted connections

🧪 Testing

Comprehensive test suite covering:

• Database connection and pooling
• Model validation and business logic
• Migration system functionality
• Repository pattern operations

📚 Documentation

Complete documentation includes:

• Architecture overview
• Setup and configuration guide
• API reference
• Performance optimization tips
• Troubleshooting guide

✅ Acceptance Criteria Met

• All tables created with proper constraints
• Indexes optimized for query performance
• Foreign key relationships established
• JSONB fields properly structured
• Migration scripts execute successfully
• Existing data migration support
• Rollback functionality implemented
• Version control system in place

🔗 Integration Ready

This implementation provides the foundation for updating all 21 task-manager components to use the database instead of file-based storage. The repository pattern and model layer make integration straightforward while maintaining backward compatibility during the transition.

🎯 Next Steps

1. Integration Phase: Update task-manager components to use database
2. API Layer: Add RESTful endpoints for database operations
3. Real-time Features: Implement subscriptions for task updates
4. Performance Monitoring: Add query performance tracking
5. Backup System: Implement automated backup procedures

---

Related Issue: ZAM-881 - PostgreSQL Database Schema & Migration System
Branch: codegen/zam-881-sub-issue-1-postgresql-database-schema-migration-system

---

💻 View my work • About Codegen

Summary by Sourcery

Implement a full PostgreSQL backend for task management, including a robust migration framework, a connection manager with pooling and health checks, core schema and SQL definition, data models and repositories for Task and Project, configuration for multiple environments, comprehensive documentation, and a suite of tests

New Features:

• Introduce a PostgreSQL migration system with a CLI-driven MigrationRunner supporting migrate, rollback, status, validate, and create commands
• Add modular migration scripts: initial schema, performance indexes, triggers/functions, and data migration from JSON files

Enhancements:

• Refactor MigrationRunner to simplify configuration and integrate with the shared db connection module
• Revamp README.md to provide architecture overview, setup instructions, usage examples, and troubleshooting guidance

Documentation:

• Add comprehensive database README covering schema, migrations, connection management, models, repositories, and deployment
• Provide .env.example and documentation for environment-specific configuration

Tests:

• Add tests for database connection manager and model validation

[sourcery-ai]

Reviewer's Guide

This PR replaces the existing file-based storage with a full PostgreSQL backend by defining a comprehensive SQL schema, refactoring the migration runner into a unified CLI-driven system, introducing a pooled connection manager, implementing data models and repository classes, and supplying versioned migration scripts and updated documentation.

Entity Relationship Diagram for New PostgreSQL Schema

erDiagram
    PROJECTS {
        UUID id PK
        VARCHAR name
        TEXT description
        JSONB context
        JSONB architecture
        VARCHAR status
    }
    TASKS {
        UUID id PK
        VARCHAR title
        TEXT description
        JSONB requirements
        JSONB dependencies
        JSONB acceptance_criteria
        task_status status
        VARCHAR priority
        UUID project_id FK
        UUID parent_task_id FK
    }
    SUBTASKS {
        UUID id PK
        UUID parent_task_id FK
        UUID child_task_id FK
        INTEGER order_index
    }
    TASK_DEPENDENCIES {
        UUID id PK
        UUID task_id FK
        UUID depends_on_task_id FK
        dependency_type type
    }
    EXECUTION_HISTORY {
        UUID id PK
        UUID task_id FK
        execution_status status
        JSONB error_logs
        JSONB success_patterns
    }
    TEMPLATES {
        UUID id PK
        VARCHAR name
        template_type type
        JSONB content
    }
    LEARNING_DATA {
        UUID id PK
        VARCHAR pattern_type
        JSONB pattern_data
    }
    SCHEMA_MIGRATIONS {
        UUID id PK
        VARCHAR version
        VARCHAR name
        VARCHAR checksum
    }
    SYSTEM_CONFIG {
        UUID id PK
        VARCHAR key
        JSONB value
    }

    PROJECTS ||--o{ TASKS : "has"
    TASKS }o--|| TASKS : "is_parent_of (parent_task_id)"
    TASKS ||--o{ SUBTASKS : "is_parent_in"
    TASKS ||--o{ SUBTASKS : "is_child_in"
    TASKS ||--o{ TASK_DEPENDENCIES : "blocks/is_blocked_by"
    TASKS ||--o{ TASK_DEPENDENCIES : "depends_on/dependent_of"
    TASKS }o--o{ EXECUTION_HISTORY : "has"

Loading

Class Diagram for Database System Components

classDiagram
    class DatabaseConnection {
        -pool: Pool
        -isConnected: boolean
        +initialize()
        +query(sql, params)
        +transaction(callback)
        +getClient()
        +healthCheck()
        +close()
    }
    class MigrationRunner {
        -migrationsDir: string
        -migrationTable: string
        +initialize()
        +migrate()
        +rollback()
        +status()
        +validate()
        +createMigration(name)
        +getMigrationFiles()
        +getExecutedMigrations()
        +executeMigration(migrationFile)
        +rollbackMigration(migrationFile)
    }
    class Task {
        +id: UUID
        +title: string
        +description: string
        +status: string
        +priority: string
        +requirements: JSON
        +dependencies: JSON
        +acceptance_criteria: JSON
        +project_id: UUID
        +parent_task_id: UUID
        +validate()
        +save()
        +delete()
        +getSubtasks()
        +addDependency(taskId, type)
        +getExecutionHistory()
        +toJSON()
        +static findById(id)
        +static findAll(filters)
        +static search(searchText)
    }
    class Project {
        +id: UUID
        +name: string
        +description: string
        +status: string
        +context: JSON
        +architecture: JSON
        +validate()
        +save()
        +delete()
        +getTasks(filters)
        +toJSON()
        +static findById(id)
        +static findAll(filters)
    }
    class TaskRepository {
        +create(taskData): Task
        +findById(id): Task
        +update(id, data): Task
        +delete(id): boolean
        +findAll(filters): Task[]
        +search(searchText): Task[]
        +findReadyTasks(): Task[]
        +getTaskHierarchy(taskId): Task[]
        +addDependency(taskId, dependsOnTaskId, type)
    }

    MigrationRunner ..> DatabaseConnection : uses
    TaskRepository ..> DatabaseConnection : uses
    TaskRepository ..> Task : manages
    Task ..> DatabaseConnection : uses for persistence
    Project ..> DatabaseConnection : uses for persistence

Loading

File-Level Changes

Change	Details	Files
Refactored the migration runner into a streamlined, CLI-driven class	Replaced custom options and private helpers with explicit methods (initialize, migrate, rollback, status, validate, createMigration) Switched from manual connection manager to singleton db instance with checksum tracking Unified up/down execution into executeMigration/rollbackMigration with transaction safety Simplified file discovery and migration versioning logic Updated CLI commands to new method names and argument handling	src/database/migrations/migration_runner.js
Defined the full PostgreSQL schema and supporting structures	Created schema.sql with 7 core tables, custom types, triggers, and constraints Added GIN and B-tree indexes for JSONB, full-text, and relational fields Established triggers for automatic timestamp updates and circular dependency prevention Inserted initial system_config and default project rows	src/database/schema.sql
Built a robust connection manager with pooling and health checks	Introduced DatabaseConnection class with Pool configuration, retry logic, and debug logging Exposed query, transaction, healthCheck, getPoolStats, and reconnect methods Centralized environment-specific settings in config/database.js with validation Replaced legacy connection code with singleton db export	src/database/connection.js src/config/database.js
Added versioned migration scripts for schema, indexes, triggers, and data	001_initial_schema: create core tables, types, extensions 002_create_indexes: performance indexes for all tables 003_create_triggers: data integrity functions and triggers 004_migrate_existing_data: import tasks.json and map legacy IDs	src/database/migrations/001_initial_schema.js src/database/migrations/002_create_indexes.js src/database/migrations/003_create_triggers.js src/database/migrations/004_migrate_existing_data.js
Implemented Task/Project models and repository pattern	Task and Project classes with validate/save/update/delete operations Repository layer for task creation, querying, status updates, bulk operations Advanced relationship methods: subtasks, dependencies, execution history Full-text search, filtering, pagination, and statistics functions	src/database/models/Task.js src/database/models/Project.js src/database/repositories/TaskRepository.js
Overhauled documentation and usage guides	Rewrote README.md to reflect new architecture, setup, and usage Provided examples for connection, models, repositories, and migrations Updated .env.example and added CLI commands section Aligned docs with new file hierarchy and naming conventions	src/database/README.md .env.example

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[korbit-ai]

By default, I don't review pull requests opened by bots. If you would like me to review this pull request anyway, you can request a review via the /korbit-review command in a comment.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.