Implement database-backed scheduler lock for multi-worker safety

Enforce single-executor safety regardless of process launcher through a
robust database-backed lock mechanism that works reliably in container
orchestration environments.

Key changes:
1. Add scheduler_lock table to database schema (migration 4)
   - Singleton row (id=1) prevents concurrent execution
   - Stores PID, hostname, creation timestamp, heartbeat timestamp
   - Atomic transaction prevents race conditions

2. Create scheduler lock utility (app/utils/scheduler_lock.py)
   - acquire_scheduler_lock(): Atomically acquire or fail
   - release_scheduler_lock(): Clean up on shutdown
   - update_scheduler_lock_heartbeat(): Keep lock alive (every 10 seconds)
   - get_scheduler_lock_info(): Debug/inspect lock status
   - Stale lock detection: TTL-based (60 second expiry)

3. Reorder startup DAG stages
   - DATABASE now comes first (required for lock acquisition)
   - WORKER_MODE depends on DATABASE (performs lock check after initialization)
   - Maintains all other stage dependencies intact

4. Update startup process (app/startup.py)
   - Replace _check_single_worker_mode() with two-tier check:
     * Fast check: BANGUI_WORKERS env var (if explicitly set to >1)
     * Authoritative check: Database lock (catches misconfiguration)
   - Return startup_db from startup_shared_resources() for lock management

5. Register scheduler lock heartbeat task
   - New task: scheduler_lock_heartbeat (app/tasks/scheduler_lock_heartbeat.py)
   - Updates lock heartbeat every 10 seconds (keeps lock alive)
   - Prevents false positives from temporary load spikes

6. Add lock release to lifespan shutdown (app/main.py)
   - Release lock before closing database
   - Allows other instances to acquire during rolling deployments
   - Graceful handoff between instances

7. Comprehensive test coverage (backend/tests/test_scheduler_lock.py)
   - Lock acquisition success and failure cases
   - Stale lock cleanup on startup
   - Lock release and heartbeat updates
   - Full lifecycle: acquire → heartbeat → release

8. Update documentation (Docs/Architekture.md § 9.3)
   - Explain single-executor requirement
   - Document database-backed locking mechanism
   - Compare with alternative approaches (filesystem, env var)
   - Include troubleshooting guide
   - Container orchestration examples (Docker, Kubernetes, systemd)

Why database-backed instead of filesystem?
   - Atomicity: SQLite transactions prevent TOCTOU race windows
   - Container-safe: Works across containers with shared DB volumes
   - No NFS/SMB edge cases
   - Timestamp-based stale detection (PID reuse is unreliable)
   - More reliable in rolling deployments

Benefits:
   - Works with any process manager (uvicorn, gunicorn, etc.)
   - Handles simultaneous startup attempts correctly
   - Automatic failover on instance crash (stale lock cleanup)
   - Clear error messages with troubleshooting steps
   - No environment variable required (lock is authoritative)
   - Scales to multi-worker deployments if combined with external job store

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
2026-04-29 20:10:53 +02:00
parent 336242ad06
commit 187cd8250d
8 changed files with 768 additions and 82 deletions

View File

@@ -0,0 +1,222 @@
"""Tests for the scheduler lock mechanism.
These tests verify that the database-backed scheduler lock correctly enforces
single-executor safety across multiple startup attempts, including stale lock
cleanup and heartbeat updates.
"""
from __future__ import annotations
import os
import time
from typing import Any
import aiosqlite
import pytest
from app.utils.scheduler_lock import (
SCHEDULER_LOCK_TTL_SECONDS,
acquire_scheduler_lock,
get_scheduler_lock_info,
release_scheduler_lock,
update_scheduler_lock_heartbeat,
)
@pytest.fixture
async def lock_db(tmp_path: Any) -> aiosqlite.Connection:
"""Create a temporary database with scheduler_lock table."""
db_path = tmp_path / "test.db"
db = await aiosqlite.connect(str(db_path))
await db.execute(
"""
CREATE TABLE scheduler_lock (
id INTEGER PRIMARY KEY CHECK (id = 1),
pid INTEGER NOT NULL,
hostname TEXT NOT NULL,
created_at REAL NOT NULL,
heartbeat_at REAL NOT NULL
);
"""
)
await db.commit()
yield db
await db.close()
@pytest.mark.asyncio
async def test_acquire_scheduler_lock_success(lock_db: aiosqlite.Connection) -> None:
"""Test successful lock acquisition."""
result = await acquire_scheduler_lock(lock_db)
assert result is True
# Verify the lock is in the database
cursor = await lock_db.execute("SELECT COUNT(*) FROM scheduler_lock")
count = await cursor.fetchone()
assert count[0] == 1
@pytest.mark.asyncio
async def test_acquire_scheduler_lock_fails_when_held(
lock_db: aiosqlite.Connection,
) -> None:
"""Test that lock acquisition fails if already held."""
# First instance acquires the lock
result1 = await acquire_scheduler_lock(lock_db)
assert result1 is True
# Second instance tries to acquire, should fail
result2 = await acquire_scheduler_lock(lock_db)
assert result2 is False
@pytest.mark.asyncio
async def test_acquire_scheduler_lock_cleans_stale_locks(
lock_db: aiosqlite.Connection,
) -> None:
"""Test that stale locks are automatically cleaned up."""
# Insert a stale lock manually (old heartbeat)
now = time.time()
stale_heartbeat = now - SCHEDULER_LOCK_TTL_SECONDS - 10
await lock_db.execute(
"""
INSERT INTO scheduler_lock (id, pid, hostname, created_at, heartbeat_at)
VALUES (1, 9999, 'stale-host', ?, ?)
""",
(now - 100, stale_heartbeat),
)
await lock_db.commit()
# New instance should clean up the stale lock and acquire
result = await acquire_scheduler_lock(lock_db)
assert result is True
# Verify the old lock is gone and new one is in place
cursor = await lock_db.execute(
"SELECT pid, hostname FROM scheduler_lock WHERE id = 1"
)
row = await cursor.fetchone()
assert row is not None
pid, hostname = row
assert pid == os.getpid()
assert hostname is not None
@pytest.mark.asyncio
async def test_release_scheduler_lock_success(
lock_db: aiosqlite.Connection,
) -> None:
"""Test successful lock release."""
# Acquire the lock
await acquire_scheduler_lock(lock_db)
# Release it
await release_scheduler_lock(lock_db)
# Verify the lock is gone
cursor = await lock_db.execute("SELECT COUNT(*) FROM scheduler_lock")
count = await cursor.fetchone()
assert count[0] == 0
@pytest.mark.asyncio
async def test_release_scheduler_lock_not_held(
lock_db: aiosqlite.Connection,
) -> None:
"""Test that releasing a lock we don't hold is safe."""
# Try to release without acquiring — should not crash
await release_scheduler_lock(lock_db)
# Verify the lock is still empty
cursor = await lock_db.execute("SELECT COUNT(*) FROM scheduler_lock")
count = await cursor.fetchone()
assert count[0] == 0
@pytest.mark.asyncio
async def test_update_scheduler_lock_heartbeat_success(
lock_db: aiosqlite.Connection,
) -> None:
"""Test successful heartbeat update."""
# Acquire the lock
await acquire_scheduler_lock(lock_db)
# Get the original heartbeat
cursor = await lock_db.execute("SELECT heartbeat_at FROM scheduler_lock WHERE id = 1")
original_row = await cursor.fetchone()
original_heartbeat = original_row[0]
# Wait a moment and update the heartbeat
time.sleep(0.01)
result = await update_scheduler_lock_heartbeat(lock_db)
assert result is True
# Verify the heartbeat was updated
cursor = await lock_db.execute("SELECT heartbeat_at FROM scheduler_lock WHERE id = 1")
new_row = await cursor.fetchone()
new_heartbeat = new_row[0]
assert new_heartbeat > original_heartbeat
@pytest.mark.asyncio
async def test_update_scheduler_lock_heartbeat_fails_if_not_held(
lock_db: aiosqlite.Connection,
) -> None:
"""Test that heartbeat update fails if we don't hold the lock."""
result = await update_scheduler_lock_heartbeat(lock_db)
assert result is False
@pytest.mark.asyncio
async def test_get_scheduler_lock_info_returns_details(
lock_db: aiosqlite.Connection,
) -> None:
"""Test that lock info includes all relevant fields."""
await acquire_scheduler_lock(lock_db)
info = await get_scheduler_lock_info(lock_db)
assert info is not None
assert "pid" in info
assert "hostname" in info
assert "created_at" in info
assert "heartbeat_at" in info
assert info["pid"] == os.getpid()
@pytest.mark.asyncio
async def test_get_scheduler_lock_info_returns_none_when_empty(
lock_db: aiosqlite.Connection,
) -> None:
"""Test that lock info returns None when no lock is held."""
info = await get_scheduler_lock_info(lock_db)
assert info is None
@pytest.mark.asyncio
async def test_scheduler_lock_full_lifecycle(
lock_db: aiosqlite.Connection,
) -> None:
"""Test the full lifecycle: acquire, update heartbeat, release."""
# Initially no lock
info = await get_scheduler_lock_info(lock_db)
assert info is None
# Acquire the lock
result = await acquire_scheduler_lock(lock_db)
assert result is True
info = await get_scheduler_lock_info(lock_db)
assert info is not None
initial_heartbeat = info["heartbeat_at"]
# Update heartbeat multiple times
time.sleep(0.01)
result = await update_scheduler_lock_heartbeat(lock_db)
assert result is True
info = await get_scheduler_lock_info(lock_db)
updated_heartbeat = info["heartbeat_at"]
assert updated_heartbeat > initial_heartbeat
# Release the lock
await release_scheduler_lock(lock_db)
info = await get_scheduler_lock_info(lock_db)
assert info is None