ComfyUI/tests-unit/app_test/test_db_init_locking.py

import logging
import os
import sqlite3

import pytest
import torch
from alembic import command
from alembic.config import Config
from filelock import FileLock, Timeout

from app.database import db as db_module
from comfy.cli_args import args as cli_args

if not torch.cuda.is_available():
    cli_args.cpu = True

import main  # noqa: E402

_PRE_HEAD = "0006_add_loader_path"


def _make_config(db_path: str) -> Config:
    root = os.path.join(os.path.dirname(__file__), "../..")
    cfg = Config(os.path.abspath(os.path.join(root, "alembic.ini")))
    cfg.set_main_option("script_location", os.path.abspath(os.path.join(root, "alembic_db")))
    cfg.set_main_option("sqlalchemy.url", f"sqlite:///{db_path}")
    return cfg


def _current_revision(db_path: str) -> str:
    with sqlite3.connect(db_path) as conn:
        rows = conn.execute("SELECT version_num FROM alembic_version").fetchall()
    assert len(rows) == 1
    return rows[0][0]


@pytest.fixture
def stale_db(tmp_path, monkeypatch):
    db_path = str(tmp_path / "comfyui.db")
    command.upgrade(_make_config(db_path), _PRE_HEAD)

    monkeypatch.setattr(db_module.args, "database_url", f"sqlite:///{db_path}")
    monkeypatch.setattr(db_module, "Session", None)
    monkeypatch.setattr(db_module, "_db_lock", None)
    yield db_path
    if db_module._db_lock is not None:
        db_module._db_lock.release(force=True)


def test_init_file_db_migrates_when_lock_is_free(stale_db):
    db_module._init_file_db(db_module.args.database_url)

    assert _current_revision(stale_db) != _PRE_HEAD
    assert os.path.exists(stale_db + ".bkp")


def test_successful_init_keeps_holding_the_lock(stale_db):
    db_module._init_file_db(db_module.args.database_url)

    contender = FileLock(stale_db + ".lock")
    with pytest.raises(Timeout):
        contender.acquire(timeout=0)


def test_failed_init_releases_the_lock(stale_db, monkeypatch):
    def _explode():
        raise RuntimeError("alembic config exploded")

    monkeypatch.setattr(db_module, "get_alembic_config", _explode)

    with pytest.raises(RuntimeError, match="alembic config exploded"):
        db_module._init_file_db(db_module.args.database_url)

    contender = FileLock(stale_db + ".lock")
    try:
        contender.acquire(timeout=0)
    except Timeout:
        pytest.fail(
            "a failed init stranded the lock; setup_database logs and CONTINUES when assets are "
            "disabled, so this process would block every other instance for its whole lifetime "
            "over a database it never opened"
        )
    contender.release()


def test_held_lock_blocks_before_any_migration_work(stale_db, monkeypatch):
    monkeypatch.setattr(db_module, "_LOCK_WAIT_SECONDS", 0.1)
    holder = FileLock(stale_db + ".lock")
    holder.acquire(timeout=0)
    try:
        with pytest.raises(RuntimeError, match="Another ComfyUI process may already be using it"):
            db_module._init_file_db(db_module.args.database_url)

        assert not os.path.exists(stale_db + ".bkp")
        assert _current_revision(stale_db) == _PRE_HEAD
        assert db_module.Session is None
    finally:
        holder.release()


def test_legacy_database_copy_runs_under_file_lock(tmp_path, monkeypatch):
    legacy_db = tmp_path / "legacy" / "comfyui.db"
    target_db = tmp_path / "current" / "comfyui.db"
    legacy_db.parent.mkdir()
    legacy_db.write_bytes(b"legacy database")
    copied: list[tuple[str, str]] = []
    real_copy = db_module.shutil.copy

    def _copy_while_locked(source: str, destination: str):
        contender = FileLock(str(target_db) + ".lock")
        try:
            with pytest.raises(Timeout):
                contender.acquire(timeout=0)
        finally:
            if contender.is_locked:
                contender.release()
        copied.append((source, destination))
        return real_copy(source, destination)

    monkeypatch.setattr(db_module.args, "database_url", None)
    monkeypatch.setattr(db_module, "get_db_path", lambda: str(target_db))
    monkeypatch.setattr(
        db_module, "get_legacy_default_db_path", lambda: str(legacy_db)
    )
    monkeypatch.setattr(db_module, "_migrate_and_bind", lambda *_args: None)
    monkeypatch.setattr(db_module.shutil, "copy", _copy_while_locked)
    monkeypatch.setattr(db_module, "_db_lock", None)

    try:
        db_module._init_file_db(f"sqlite:///{target_db}")
    finally:
        if db_module._db_lock is not None:
            db_module._db_lock.release(force=True)

    assert copied == [(str(legacy_db) + ".bak", str(target_db))]


def test_setup_database_routes_file_lock_to_lock_guidance(monkeypatch, caplog):
    monkeypatch.setattr(main, "dependencies_available", lambda: True)

    def _raise_file_lock():
        raise RuntimeError(
            "Could not acquire lock on database 'x.db'. "
            "Another ComfyUI process may already be using it. "
            "Use --database-url to specify a separate database file."
        )

    monkeypatch.setattr(main, "init_db", _raise_file_lock)
    monkeypatch.setattr(main.args, "enable_assets", False)

    with caplog.at_level(logging.ERROR):
        result = main.setup_database(None)

    assert result is None
    assert "Database is locked. Another ComfyUI process is already using this database." in caplog.text
    assert "Failed to initialize database." not in caplog.text


def test_setup_database_exits_for_file_lock_when_assets_are_enabled(monkeypatch, caplog):
    monkeypatch.setattr(main, "dependencies_available", lambda: True)

    def _raise_file_lock():
        raise RuntimeError(
            "Could not acquire lock on database 'x.db'. "
            "Another ComfyUI process may already be using it. "
            "Use --database-url to specify a separate database file."
        )

    monkeypatch.setattr(main, "init_db", _raise_file_lock)
    monkeypatch.setattr(main.args, "enable_assets", True)

    with caplog.at_level(logging.ERROR), pytest.raises(SystemExit) as error:
        main.setup_database(None)

    assert error.value.code == 1
    assert "Database is locked. Another ComfyUI process is already using this database." in caplog.text
    assert "The --enable-assets flag requires a working database connection." not in caplog.text


def test_setup_database_exits_for_driver_lock_when_assets_are_disabled(monkeypatch, caplog):
    monkeypatch.setattr(main, "dependencies_available", lambda: True)

    def _raise_driver_lock():
        raise Exception("sqlite3.OperationalError: database is locked")

    monkeypatch.setattr(main, "init_db", _raise_driver_lock)
    monkeypatch.setattr(main.args, "enable_assets", False)

    with caplog.at_level(logging.ERROR), pytest.raises(SystemExit) as error:
        main.setup_database(None)

    assert error.value.code == 1
    assert "Database is locked. Another ComfyUI process is already using this database." in caplog.text


def test_failed_restore_does_not_mask_the_upgrade_error(stale_db, monkeypatch, caplog):
    real_backup = db_module._backup_database

    def _upgrade_explodes(*_args, **_kwargs):
        raise RuntimeError("upgrade exploded")

    def _restore_explodes(source_path, destination_path):
        if destination_path == stale_db:
            raise OSError("restore exploded")
        real_backup(source_path, destination_path)

    monkeypatch.setattr(db_module.command, "upgrade", _upgrade_explodes)
    monkeypatch.setattr(db_module, "_backup_database", _restore_explodes)

    with caplog.at_level(logging.ERROR), pytest.raises(RuntimeError, match="upgrade exploded"):
        db_module._init_file_db(db_module.args.database_url)

    backup_path = stale_db + ".bkp"
    assert os.path.exists(backup_path)
    assert any(backup_path in record.getMessage() for record in caplog.records)