Files
aptly/utils/filelock.go
T
Nick Bozhenko 463c34a38e Fix race conditions and improve etcd timeout handling
This commit addresses several critical race conditions and improves the reliability
of etcd operations through better timeout and retry handling.

## Race Condition Fixes

1. **Task Resource Management Bug**
   - Fixed incorrect variable usage in task/list.go:78
   - Was using completed task's resources instead of idle task's resources
   - This caused resource conflicts and potential deadlocks

2. **Database Channel Initialization**
   - Added sync.Once pattern to ensure thread-safe channel initialization
   - Prevents panic from concurrent access during startup
   - Created initDBRequests() function for safe initialization

3. **Published Storage Double-Checked Locking**
   - Implemented double-checked locking pattern in GetPublishedStorage
   - Reduces lock contention while preventing concurrent initialization
   - Improves performance for frequently accessed storage

4. **File Operation Synchronization**
   - Created FileLockRegistry in utils/filelock.go
   - Prevents concurrent file operations (create, rename, delete, link)
   - Implements deadlock prevention for multi-file operations
   - Critical for preventing file corruption during parallel publishes

5. **WaitGroup Miscount Prevention**
   - Added defer pattern to ensure Done() is always called
   - Protects against panics during task execution
   - Prevents "negative WaitGroup counter" errors

## etcd Improvements

1. **Timeout Protection**
   - Replaced global context.TODO() with per-operation timeout contexts
   - Default timeout: 60 seconds (configurable)
   - Prevents indefinite hangs when etcd is unresponsive

2. **Environment Variable Configuration**
   - APTLY_ETCD_TIMEOUT: Operation timeout (default: 60s)
   - APTLY_ETCD_DIAL_TIMEOUT: Connection timeout (default: 60s)
   - APTLY_ETCD_KEEPALIVE: Keep-alive timeout (default: 7200s)
   - APTLY_ETCD_MAX_MSG_SIZE: Max message size (default: 50MB)

3. **Retry Logic for Read Operations**
   - Get operations retry up to 3 times with exponential backoff
   - Only retries on temporary/network errors
   - Improves reliability without risking data inconsistency

4. **Enhanced Error Logging**
   - All etcd errors now logged with operation context
   - Replaces silent failures with actionable error messages
   - Improves debugging and monitoring capabilities

5. **Increased Message Size Limits**
   - Default increased from 10MB to 50MB
   - Configurable via environment variable
   - Prevents "message too large" errors for large operations

## Testing

- Added comprehensive tests for etcd timeout functionality
- Tests verify context timeout, retry logic, and configuration
- All existing tests pass with the new implementation

## Documentation

- Updated README.rst with etcd configuration section
- Documented all environment variables and their defaults
- Added examples and feature descriptions

These changes significantly improve the reliability and debuggability of aptly
when using etcd as the database backend, while also fixing critical race
conditions that could cause data corruption or service crashes.
2025-07-10 10:05:49 -04:00

74 lines
1.8 KiB
Go

package utils
import (
"path/filepath"
"sync"
)
// FileLockRegistry manages file-level locks to prevent concurrent access
type FileLockRegistry struct {
locks map[string]*sync.Mutex
mu sync.Mutex
}
// Global file lock registry
var fileLocks = &FileLockRegistry{
locks: make(map[string]*sync.Mutex),
}
// LockFile acquires a lock for the given file path and returns an unlock function
func LockFile(path string) func() {
// Normalize path to absolute to ensure consistency
absPath, err := filepath.Abs(path)
if err != nil {
// If we can't get absolute path, use the original
absPath = path
}
fileLocks.mu.Lock()
lock, exists := fileLocks.locks[absPath]
if !exists {
lock = &sync.Mutex{}
fileLocks.locks[absPath] = lock
}
fileLocks.mu.Unlock()
lock.Lock()
return func() { lock.Unlock() }
}
// LockFiles acquires locks for multiple file paths and returns an unlock function
func LockFiles(paths []string) func() {
// Sort paths to prevent deadlock when locking multiple files
normalizedPaths := make([]string, 0, len(paths))
for _, path := range paths {
absPath, err := filepath.Abs(path)
if err != nil {
absPath = path
}
normalizedPaths = append(normalizedPaths, absPath)
}
// Simple sorting to ensure consistent lock order
for i := 0; i < len(normalizedPaths)-1; i++ {
for j := i + 1; j < len(normalizedPaths); j++ {
if normalizedPaths[i] > normalizedPaths[j] {
normalizedPaths[i], normalizedPaths[j] = normalizedPaths[j], normalizedPaths[i]
}
}
}
// Acquire all locks
unlocks := make([]func(), 0, len(normalizedPaths))
for _, path := range normalizedPaths {
unlock := LockFile(path)
unlocks = append(unlocks, unlock)
}
// Return function that unlocks all in reverse order
return func() {
for i := len(unlocks) - 1; i >= 0; i-- {
unlocks[i]()
}
}
}