Files
osmedeus/internal/database/database.go
T
j3ssie ec19282e64 fix(database): run column migrations before index creation
- Reorder Migrate() to add columns to existing tables BEFORE creating
  indexes, since CREATE TABLE IF NOT EXISTS is a no-op on existing
  databases and some indexes (e.g. finding_hash) reference migrated
  columns that would otherwise be missing
- Add explanatory comment in internal/database/database.go documenting
  why column migrations must precede index creation
- Surface a helpful CLI hint in pkg/cli/root.go pointing users to
  'osmedeus db migrate' when startup fails with 'failed to run
  migrations', so stale schemas are easier to recover from
2026-05-31 01:08:43 +08:00

708 lines
21 KiB
Go

package database
import (
"context"
"database/sql"
"fmt"
"os"
"path/filepath"
"strings"
"sync"
"time"
"github.com/j3ssie/osmedeus/v5/internal/config"
"github.com/uptrace/bun"
"github.com/uptrace/bun/dialect/pgdialect"
"github.com/uptrace/bun/dialect/sqlitedialect"
"github.com/uptrace/bun/driver/pgdriver"
"github.com/uptrace/bun/driver/sqliteshim"
)
var (
db *bun.DB
lazyConfig *config.Config
lazyMu sync.Mutex
)
// Connect establishes a database connection based on configuration
func Connect(cfg *config.Config) (*bun.DB, error) {
switch {
case cfg.IsPostgres():
return connectPostgres(cfg)
case cfg.IsSQLite():
return connectSQLite(cfg)
default:
return nil, fmt.Errorf("unsupported database engine: %s", cfg.Database.DBEngine)
}
}
// connectSQLite establishes a SQLite connection
func connectSQLite(cfg *config.Config) (*bun.DB, error) {
dbPath := cfg.GetDBPath()
// Ensure directory exists
dir := filepath.Dir(dbPath)
if err := os.MkdirAll(dir, 0755); err != nil {
return nil, fmt.Errorf("failed to create database directory: %w", err)
}
// Build DSN with pragmas for better performance
dsn := fmt.Sprintf("%s?_pragma=foreign_keys(1)&_pragma=journal_mode(WAL)&_pragma=busy_timeout(5000)", dbPath)
sqldb, err := sql.Open(sqliteshim.ShimName, dsn)
if err != nil {
return nil, fmt.Errorf("failed to open SQLite database: %w", err)
}
// SQLite connection pooling settings
sqldb.SetMaxOpenConns(1) // SQLite only supports one writer at a time
sqldb.SetMaxIdleConns(1)
db = bun.NewDB(sqldb, sqlitedialect.New())
// Test connection
if err := db.Ping(); err != nil {
return nil, fmt.Errorf("failed to ping SQLite database: %w", err)
}
// Apply additional performance pragmas
applySQLitePerformancePragmas(context.Background())
// Initialize cache after successful connection
_ = InitCache(nil)
return db, nil
}
// applySQLitePerformancePragmas applies additional SQLite performance settings
func applySQLitePerformancePragmas(ctx context.Context) {
if db == nil {
return
}
pragmas := []string{
"PRAGMA synchronous = NORMAL", // Faster writes, safe with WAL
"PRAGMA cache_size = -10000", // 10MB cache (negative = KB)
"PRAGMA temp_store = MEMORY", // Temp tables in memory
"PRAGMA mmap_size = 83886080", // 80MB memory-mapped I/O
}
for _, pragma := range pragmas {
_, _ = db.ExecContext(ctx, pragma)
}
}
// connectPostgres establishes a PostgreSQL connection
func connectPostgres(cfg *config.Config) (*bun.DB, error) {
dsn := fmt.Sprintf("postgres://%s:%s@%s:%d/%s?sslmode=%s",
cfg.Database.Username,
cfg.Database.Password,
cfg.Database.Host,
cfg.Database.Port,
cfg.Database.DBName,
getSSLMode(cfg.Database.SSLMode),
)
sqldb := sql.OpenDB(pgdriver.NewConnector(pgdriver.WithDSN(dsn)))
// PostgreSQL connection pool settings
sqldb.SetMaxOpenConns(25) // Limit concurrent connections
sqldb.SetMaxIdleConns(5) // Keep some connections ready
sqldb.SetConnMaxLifetime(time.Hour) // Recycle connections periodically
sqldb.SetConnMaxIdleTime(10 * time.Minute) // Close idle connections
db = bun.NewDB(sqldb, pgdialect.New())
// Test connection
if err := db.Ping(); err != nil {
return nil, fmt.Errorf("failed to connect to PostgreSQL: %w", err)
}
return db, nil
}
// getSSLMode returns the SSL mode or default
func getSSLMode(mode string) string {
if mode == "" {
return "disable"
}
return mode
}
// SetLazyConfig stores a config for deferred database connection.
// The actual connection is established on the first GetDB() call.
func SetLazyConfig(cfg *config.Config) {
lazyMu.Lock()
defer lazyMu.Unlock()
lazyConfig = cfg
}
// GetDB returns the global database instance, connecting lazily if
// SetLazyConfig was called but Connect has not yet been invoked.
func GetDB() *bun.DB {
if db != nil {
return db
}
lazyMu.Lock()
defer lazyMu.Unlock()
if db != nil {
return db
}
if lazyConfig == nil {
return nil
}
cfg := lazyConfig
lazyConfig = nil // prevent retry loops on persistent failure
if _, err := Connect(cfg); err != nil {
return nil
}
return db
}
// SetDB sets the global database instance (for testing)
func SetDB(newDB *bun.DB) {
db = newDB
}
// Close closes the database connection and cache
func Close() error {
// Close cache first
closeGlobalCache()
if db != nil {
return db.Close()
}
return nil
}
// Migrate runs database migrations
func Migrate(ctx context.Context) error {
models := []interface{}{
(*Run)(nil),
(*StepResult)(nil),
(*Artifact)(nil),
(*Asset)(nil),
(*EventLog)(nil),
(*Schedule)(nil),
(*Workspace)(nil),
(*WorkflowMeta)(nil),
(*Vulnerability)(nil),
(*AssetDiffSnapshot)(nil),
(*VulnDiffSnapshot)(nil),
(*AgentSession)(nil),
}
for _, model := range models {
_, err := db.NewCreateTable().
Model(model).
IfNotExists().
Exec(ctx)
if err != nil {
return fmt.Errorf("failed to create table: %w", err)
}
}
// Add columns to existing tables BEFORE creating indexes. CREATE TABLE
// IF NOT EXISTS is a no-op for existing databases, so their tables retain
// the old schema. Some indexes below reference migrated columns (e.g.
// finding_hash), so the columns must exist first or index creation fails.
// Add current_pid column to runs table if it doesn't exist (for existing databases)
if err := addRunsPIDColumn(ctx); err != nil {
return err
}
// Add optional column to artifacts table if it doesn't exist (for existing databases)
if err := addArtifactsOptionalColumn(ctx); err != nil {
return err
}
// Add remarks column to assets table if it doesn't exist (for existing databases)
if err := addAssetRemarksColumn(ctx); err != nil {
return err
}
// Add language column to assets table if it doesn't exist (for existing databases)
if err := addAssetLanguageColumn(ctx); err != nil {
return err
}
// Add blob_content column to assets table if it doesn't exist (for existing databases)
if err := addAssetBlobContentColumn(ctx); err != nil {
return err
}
// Add external_url column to assets table if it doesn't exist (for existing databases)
if err := addAssetExternalURLColumn(ctx); err != nil {
return err
}
// Add size column to assets table if it doesn't exist (for existing databases)
if err := addAssetSizeColumn(ctx); err != nil {
return err
}
// Add loc column to assets table if it doesn't exist (for existing databases)
if err := addAssetLOCColumn(ctx); err != nil {
return err
}
// Add CDN/WAF classification columns to assets table if they don't exist
if err := addAssetCDNColumns(ctx); err != nil {
return err
}
// Add port tracking columns to assets table if they don't exist
if err := addAssetPortColumns(ctx); err != nil {
return err
}
// Add queue metadata columns to runs table if they don't exist
if err := addRunsQueueColumns(ctx); err != nil {
return err
}
// Add webhook columns to runs table if they don't exist
if err := addRunsWebhookColumns(ctx); err != nil {
return err
}
// Add finding_hash column to vulnerabilities table if it doesn't exist
if err := addVulnFindingHashColumn(ctx); err != nil {
return err
}
// Create indexes for Run table
if err := createRunIndexes(ctx); err != nil {
return err
}
// Create indexes for Asset table
if err := createAssetIndexes(ctx); err != nil {
return err
}
// Create indexes for EventLog table
if err := createEventLogIndexes(ctx); err != nil {
return err
}
// Create indexes for WorkflowMeta table
if err := createWorkflowMetaIndexes(ctx); err != nil {
return err
}
// Create indexes for Vulnerability table
if err := createVulnerabilityIndexes(ctx); err != nil {
return err
}
// Create indexes for Workspace table
if err := createWorkspaceIndexes(ctx); err != nil {
return err
}
// Create indexes for AssetDiffSnapshot table
if err := createAssetDiffIndexes(ctx); err != nil {
return err
}
// Create indexes for VulnDiffSnapshot table
if err := createVulnDiffIndexes(ctx); err != nil {
return err
}
return nil
}
// createRunIndexes creates indexes for the runs table
func createRunIndexes(ctx context.Context) error {
indexes := []string{
"CREATE INDEX IF NOT EXISTS idx_runs_run_uuid ON runs(run_uuid)",
"CREATE INDEX IF NOT EXISTS idx_runs_run_group_id ON runs(run_group_id)",
"CREATE INDEX IF NOT EXISTS idx_runs_status ON runs(status)",
"CREATE INDEX IF NOT EXISTS idx_runs_workflow_name ON runs(workflow_name)",
"CREATE INDEX IF NOT EXISTS idx_runs_target ON runs(target)",
"CREATE INDEX IF NOT EXISTS idx_runs_is_queued ON runs(is_queued)",
"CREATE INDEX IF NOT EXISTS idx_runs_webhook_uuid ON runs(webhook_uuid)",
}
for _, idx := range indexes {
if _, err := db.ExecContext(ctx, idx); err != nil {
return fmt.Errorf("failed to create index: %w", err)
}
}
return nil
}
// addRunsPIDColumn adds the current_pid column to runs table for existing databases
// This is safe to run multiple times - it checks if column exists first
func addRunsPIDColumn(ctx context.Context) error {
// SQLite and PostgreSQL have different syntax for adding columns
// We use a simple approach: try to add the column and ignore "already exists" errors
_, err := db.ExecContext(ctx, "ALTER TABLE runs ADD COLUMN current_pid INTEGER DEFAULT 0")
if err != nil {
errStr := strings.ToLower(err.Error())
// Ignore "column already exists" errors (SQLite and PostgreSQL have different messages)
if strings.Contains(errStr, "duplicate column") ||
strings.Contains(errStr, "already exists") ||
strings.Contains(errStr, "sqlstate 42701") {
return nil
}
return fmt.Errorf("failed to add current_pid column: %w", err)
}
return nil
}
// addArtifactsOptionalColumn adds the optional column to artifacts table for existing databases
// This is safe to run multiple times - it checks if column exists first
func addArtifactsOptionalColumn(ctx context.Context) error {
_, err := db.ExecContext(ctx, "ALTER TABLE artifacts ADD COLUMN optional BOOLEAN DEFAULT FALSE")
if err != nil {
errStr := strings.ToLower(err.Error())
if strings.Contains(errStr, "duplicate column") ||
strings.Contains(errStr, "already exists") ||
strings.Contains(errStr, "sqlstate 42701") {
return nil
}
return fmt.Errorf("failed to add optional column: %w", err)
}
return nil
}
// addAssetRemarksColumn adds the remarks column to assets table for existing databases
func addAssetRemarksColumn(ctx context.Context) error {
_, err := db.ExecContext(ctx, "ALTER TABLE assets ADD COLUMN remarks JSON")
if err != nil {
errStr := strings.ToLower(err.Error())
if strings.Contains(errStr, "duplicate column") ||
strings.Contains(errStr, "already exists") ||
strings.Contains(errStr, "sqlstate 42701") {
return nil
}
return fmt.Errorf("failed to add remarks column: %w", err)
}
return nil
}
// addAssetLanguageColumn adds the language column to assets table for existing databases
func addAssetLanguageColumn(ctx context.Context) error {
_, err := db.ExecContext(ctx, "ALTER TABLE assets ADD COLUMN language TEXT DEFAULT ''")
if err != nil {
errStr := strings.ToLower(err.Error())
if strings.Contains(errStr, "duplicate column") ||
strings.Contains(errStr, "already exists") ||
strings.Contains(errStr, "sqlstate 42701") {
return nil
}
return fmt.Errorf("failed to add language column: %w", err)
}
return nil
}
// addAssetBlobContentColumn adds the blob_content column to assets table for existing databases
func addAssetBlobContentColumn(ctx context.Context) error {
_, err := db.ExecContext(ctx, "ALTER TABLE assets ADD COLUMN blob_content TEXT DEFAULT ''")
if err != nil {
errStr := strings.ToLower(err.Error())
if strings.Contains(errStr, "duplicate column") ||
strings.Contains(errStr, "already exists") ||
strings.Contains(errStr, "sqlstate 42701") {
return nil
}
return fmt.Errorf("failed to add blob_content column: %w", err)
}
return nil
}
// addAssetSizeColumn adds the size column to assets table for existing databases
func addAssetSizeColumn(ctx context.Context) error {
_, err := db.ExecContext(ctx, "ALTER TABLE assets ADD COLUMN size INTEGER DEFAULT 0")
if err != nil {
errStr := strings.ToLower(err.Error())
if strings.Contains(errStr, "duplicate column") ||
strings.Contains(errStr, "already exists") ||
strings.Contains(errStr, "sqlstate 42701") {
return nil
}
return fmt.Errorf("failed to add size column: %w", err)
}
return nil
}
// addAssetLOCColumn adds the loc column to assets table for existing databases
func addAssetLOCColumn(ctx context.Context) error {
_, err := db.ExecContext(ctx, "ALTER TABLE assets ADD COLUMN loc INTEGER DEFAULT 0")
if err != nil {
errStr := strings.ToLower(err.Error())
if strings.Contains(errStr, "duplicate column") ||
strings.Contains(errStr, "already exists") ||
strings.Contains(errStr, "sqlstate 42701") {
return nil
}
return fmt.Errorf("failed to add loc column: %w", err)
}
return nil
}
// addAssetExternalURLColumn adds the external_url column to assets table for existing databases
func addAssetExternalURLColumn(ctx context.Context) error {
_, err := db.ExecContext(ctx, "ALTER TABLE assets ADD COLUMN external_url TEXT DEFAULT ''")
if err != nil {
errStr := strings.ToLower(err.Error())
if strings.Contains(errStr, "duplicate column") ||
strings.Contains(errStr, "already exists") ||
strings.Contains(errStr, "sqlstate 42701") {
return nil
}
return fmt.Errorf("failed to add external_url column: %w", err)
}
return nil
}
// addAssetCDNColumns adds CDN/WAF classification columns to assets table for existing databases
func addAssetCDNColumns(ctx context.Context) error {
columns := []string{
"ALTER TABLE assets ADD COLUMN is_cdn BOOLEAN DEFAULT FALSE",
"ALTER TABLE assets ADD COLUMN is_cloud BOOLEAN DEFAULT FALSE",
"ALTER TABLE assets ADD COLUMN is_waf BOOLEAN DEFAULT FALSE",
}
for _, ddl := range columns {
_, err := db.ExecContext(ctx, ddl)
if err != nil {
errStr := strings.ToLower(err.Error())
if strings.Contains(errStr, "duplicate column") ||
strings.Contains(errStr, "already exists") ||
strings.Contains(errStr, "sqlstate 42701") {
continue
}
return fmt.Errorf("failed to add CDN column: %w", err)
}
}
return nil
}
// addAssetPortColumns adds port tracking columns to assets table for existing databases
func addAssetPortColumns(ctx context.Context) error {
columns := []string{
"ALTER TABLE assets ADD COLUMN open_ports TEXT DEFAULT '[]'",
"ALTER TABLE assets ADD COLUMN port_json_data TEXT DEFAULT ''",
}
for _, ddl := range columns {
_, err := db.ExecContext(ctx, ddl)
if err != nil {
errStr := strings.ToLower(err.Error())
if strings.Contains(errStr, "duplicate column") ||
strings.Contains(errStr, "already exists") ||
strings.Contains(errStr, "sqlstate 42701") {
continue
}
return fmt.Errorf("failed to add port column: %w", err)
}
}
return nil
}
// addRunsQueueColumns adds queue metadata columns to runs table for existing databases
func addRunsQueueColumns(ctx context.Context) error {
columns := []string{
"ALTER TABLE runs ADD COLUMN is_queued BOOLEAN DEFAULT FALSE",
"ALTER TABLE runs ADD COLUMN input_is_file BOOLEAN DEFAULT FALSE",
"ALTER TABLE runs ADD COLUMN input_file_path TEXT DEFAULT ''",
}
for _, ddl := range columns {
_, err := db.ExecContext(ctx, ddl)
if err != nil {
errStr := strings.ToLower(err.Error())
if strings.Contains(errStr, "duplicate column") ||
strings.Contains(errStr, "already exists") ||
strings.Contains(errStr, "sqlstate 42701") {
continue
}
return fmt.Errorf("failed to add queue column: %w", err)
}
}
return nil
}
// addRunsWebhookColumns adds webhook columns to runs table for existing databases
func addRunsWebhookColumns(ctx context.Context) error {
columns := []string{
"ALTER TABLE runs ADD COLUMN webhook_uuid TEXT DEFAULT ''",
"ALTER TABLE runs ADD COLUMN webhook_auth_key TEXT DEFAULT ''",
}
for _, ddl := range columns {
_, err := db.ExecContext(ctx, ddl)
if err != nil {
errStr := strings.ToLower(err.Error())
if strings.Contains(errStr, "duplicate column") ||
strings.Contains(errStr, "already exists") ||
strings.Contains(errStr, "sqlstate 42701") {
continue
}
return fmt.Errorf("failed to add webhook column: %w", err)
}
}
return nil
}
// addVulnFindingHashColumn adds the finding_hash column to vulnerabilities table for existing databases
func addVulnFindingHashColumn(ctx context.Context) error {
_, err := db.ExecContext(ctx, "ALTER TABLE vulnerabilities ADD COLUMN finding_hash TEXT DEFAULT ''")
if err != nil {
errStr := strings.ToLower(err.Error())
if strings.Contains(errStr, "duplicate column") ||
strings.Contains(errStr, "already exists") ||
strings.Contains(errStr, "sqlstate 42701") {
return nil
}
return fmt.Errorf("failed to add finding_hash column: %w", err)
}
return nil
}
// createAssetIndexes creates indexes for the assets table
func createAssetIndexes(ctx context.Context) error {
indexes := []string{
"CREATE INDEX IF NOT EXISTS idx_assets_workspace ON assets(workspace)",
"CREATE INDEX IF NOT EXISTS idx_assets_asset_value ON assets(asset_value)",
"CREATE INDEX IF NOT EXISTS idx_assets_status_code ON assets(status_code)",
"CREATE INDEX IF NOT EXISTS idx_assets_host_ip ON assets(host_ip)",
"CREATE UNIQUE INDEX IF NOT EXISTS idx_assets_unique ON assets(workspace, asset_value, url)",
}
for _, idx := range indexes {
if _, err := db.ExecContext(ctx, idx); err != nil {
return fmt.Errorf("failed to create index: %w", err)
}
}
return nil
}
// createEventLogIndexes creates indexes for the event_logs table
func createEventLogIndexes(ctx context.Context) error {
indexes := []string{
"CREATE INDEX IF NOT EXISTS idx_event_logs_topic ON event_logs(topic)",
"CREATE INDEX IF NOT EXISTS idx_event_logs_workspace ON event_logs(workspace)",
"CREATE INDEX IF NOT EXISTS idx_event_logs_run_id ON event_logs(run_id)",
"CREATE INDEX IF NOT EXISTS idx_event_logs_created_at ON event_logs(created_at)",
// Composite index for unprocessed event queries (ListUnprocessed, Search with processed filter)
"CREATE INDEX IF NOT EXISTS idx_event_logs_processed_created ON event_logs(processed, created_at)",
}
for _, idx := range indexes {
if _, err := db.ExecContext(ctx, idx); err != nil {
return fmt.Errorf("failed to create index: %w", err)
}
}
return nil
}
// createWorkflowMetaIndexes creates indexes for the workflow_meta table
func createWorkflowMetaIndexes(ctx context.Context) error {
indexes := []string{
"CREATE INDEX IF NOT EXISTS idx_workflow_meta_kind ON workflow_meta(kind)",
"CREATE INDEX IF NOT EXISTS idx_workflow_meta_checksum ON workflow_meta(checksum)",
}
for _, idx := range indexes {
if _, err := db.ExecContext(ctx, idx); err != nil {
return fmt.Errorf("failed to create index: %w", err)
}
}
return nil
}
// createVulnerabilityIndexes creates indexes for the vulnerabilities table
func createVulnerabilityIndexes(ctx context.Context) error {
indexes := []string{
"CREATE INDEX IF NOT EXISTS idx_vulnerabilities_workspace ON vulnerabilities(workspace)",
"CREATE INDEX IF NOT EXISTS idx_vulnerabilities_severity ON vulnerabilities(severity)",
"CREATE INDEX IF NOT EXISTS idx_vulnerabilities_confidence ON vulnerabilities(confidence)",
"CREATE INDEX IF NOT EXISTS idx_vulnerabilities_asset_value ON vulnerabilities(asset_value)",
"CREATE INDEX IF NOT EXISTS idx_vulnerabilities_finding_hash ON vulnerabilities(finding_hash)",
}
for _, idx := range indexes {
if _, err := db.ExecContext(ctx, idx); err != nil {
return fmt.Errorf("failed to create index: %w", err)
}
}
return nil
}
// createWorkspaceIndexes creates indexes for the workspaces table
func createWorkspaceIndexes(ctx context.Context) error {
indexes := []string{
"CREATE INDEX IF NOT EXISTS idx_workspaces_data_source ON workspaces(data_source)",
}
for _, idx := range indexes {
if _, err := db.ExecContext(ctx, idx); err != nil {
return fmt.Errorf("failed to create index: %w", err)
}
}
return nil
}
// createAssetDiffIndexes creates indexes for the asset_diffs table
func createAssetDiffIndexes(ctx context.Context) error {
indexes := []string{
"CREATE INDEX IF NOT EXISTS idx_asset_diffs_workspace ON asset_diffs(workspace_name)",
"CREATE INDEX IF NOT EXISTS idx_asset_diffs_created_at ON asset_diffs(created_at)",
}
for _, idx := range indexes {
if _, err := db.ExecContext(ctx, idx); err != nil {
return fmt.Errorf("failed to create index: %w", err)
}
}
return nil
}
// createVulnDiffIndexes creates indexes for the vuln_diffs table
func createVulnDiffIndexes(ctx context.Context) error {
indexes := []string{
"CREATE INDEX IF NOT EXISTS idx_vuln_diffs_workspace ON vuln_diffs(workspace_name)",
"CREATE INDEX IF NOT EXISTS idx_vuln_diffs_created_at ON vuln_diffs(created_at)",
}
for _, idx := range indexes {
if _, err := db.ExecContext(ctx, idx); err != nil {
return fmt.Errorf("failed to create index: %w", err)
}
}
return nil
}
// Transaction wraps a function in a database transaction
func Transaction(ctx context.Context, fn func(ctx context.Context, tx bun.Tx) error) error {
return db.RunInTx(ctx, nil, func(ctx context.Context, tx bun.Tx) error {
return fn(ctx, tx)
})
}
// IsSQLite returns true if the current database is SQLite
func IsSQLite() bool {
if db == nil {
return false
}
return db.Dialect().Name().String() == "sqlite"
}
// IsPostgres returns true if the current database is PostgreSQL
func IsPostgres() bool {
if db == nil {
return false
}
return db.Dialect().Name().String() == "pg"
}