mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-07-09 16:08:31 +00:00
Some checks are pending
Backend Blocking IO / backend-blocking-io (push) Waiting to run
Unit Tests / backend-unit-tests (push) Waiting to run
E2E Tests / e2e-tests (push) Waiting to run
Frontend Unit Tests / frontend-unit-tests (push) Waiting to run
Lint Check / lint-backend (push) Waiting to run
Lint Check / lint-frontend (push) Waiting to run
Replay E2E (front-back contract) / Layer 1 — backend golden (no API key) (push) Waiting to run
Replay E2E (front-back contract) / Layer 2 — full-stack render (no API key) (push) Waiting to run
* feat(persistence): wire alembic migrations + bootstrap schema on startup Closes #3682. Pre-#3658 DBs lack the `runs.token_usage_by_model` column because alembic was never wired up — startup only ran `create_all`, which never ALTERs existing tables. Adds a hybrid bootstrap in FastAPI lifespan (replaces bare `create_all`): - empty DB → create_all + stamp head - legacy DB → stamp 0001_baseline + upgrade head - versioned DB → upgrade head Concurrency: Postgres `pg_advisory_lock` (cross-process); SQLite per-engine `asyncio.Lock` + 30s `PRAGMA busy_timeout` on both prod and alembic engines. Column revisions use `safe_add_column` / `safe_drop_column` idempotent helpers as fallback. Other bits: - 0001 baseline (chain root) + 0002 add `runs.token_usage_by_model` - `include_object` filter so alembic ignores LangGraph checkpointer tables - `make migrate-rev MSG="..."` for authoring new revisions (no migrate/stamp targets — startup is the only execution path) - Tests: three-branch decision, concurrency, #3682 regression, env filter, blocking-IO gate anchor - CLAUDE.md: new "Schema migrations" section * fix(style): fix lint error * perf(persistence): address review feedback on alembic bootstrap Behavioural fixes - _SQLITE_LOCKS now keyed via WeakKeyDictionary so id-reuse after GC cannot return a stale, loop-bound lock and the cache cannot leak one entry per disposed engine. - safe_add_column compares nullable / server_default against the desired column when the name already exists and emits a warning on drift, surfacing manual-ALTER workarounds instead of silently no-op'ing. - _postgres_lock issues SET LOCAL idle_in_transaction_session_timeout=0 before pg_advisory_lock, so managed Postgres cannot kill the idle lock-holding session mid-upgrade and silently release the advisory lock. - legacy branch now backfills missing baseline tables via a restricted create_all (Base.metadata.create_all scoped to _BASELINE_TABLE_NAMES). Restores pre-#1930 upgraders whose channel_* tables were never provisioned, without pre-empting future create_table revisions for newly-added models. Schema parity - runs.token_usage_by_model gains server_default=text("'{}'") in both the ORM model and the 0001_baseline create_table, matching what 0002 adds via ALTER. create_all and alembic-upgrade paths now produce identical column definitions. - New parity test compares Base.metadata.create_all output against a pure alembic upgrade base->head, asserting column-set, nullable, and server_default agree across all tables (normalized through the same helper safe_add_column's drift check uses). Guards - test_baseline_table_names_constant_matches_0001 pins _BASELINE_TABLE_NAMES to 0001_baseline.upgrade()'s actual output -- the constant cannot drift silently when someone edits 0001. - test_legacy_backfill_skips_non_baseline_tables verifies the restricted backfill does not create a phantom table on Base.metadata, modelling a future revision that would otherwise collide on op.create_table. Doc residuals - Three-branch decision table is now consistent across bootstrap.py top docstring, engine.py comment, test module docstring, and CLAUDE.md. - Stale test anchor in blocking_io/test_persistence_engine_sqlite.py docstring now points at the real file. * fix(style): fix lint error * fix(persistence): close drift detection holes - _check_column_drift compares column type via a family equivalence allowlist ({JSON, JSONB}). Catches the wrong-type workaround `TEXT NOT NULL DEFAULT '{}'` that previously slipped through silently, while keeping Postgres JSON/JSONB dialect reflection quiet. Reflected and desired type are also echoed in every drift warning's payload for operator triage. - Extract _escape_url_for_alembic so bootstrap._alembic_safe_url and scripts/_autogen_revision share the ConfigParser % escape rule instead of duplicating it. - backend/README.md: add `make migrate-rev MSG=...` to Commands and a Schema Migrations section per the repo's README/CLAUDE.md sync policy. - test_base_to_dict.py: scope the test ORM class to an isolated MetaData so the create_all-vs-alembic parity test (added in the previous commit) is not polluted by the phantom table on the full pytest session.
75 lines
3.1 KiB
Python
75 lines
3.1 KiB
Python
"""Regression: ``bootstrap_schema`` offloads ``alembic.command.stamp`` /
|
|
``alembic.command.upgrade`` via ``asyncio.to_thread``.
|
|
|
|
The alembic commands are synchronous: they open their own engine and execute
|
|
DDL. Calling them directly on the FastAPI lifespan event loop would block --
|
|
exactly the failure mode of the issue chain that motivated the hybrid
|
|
bootstrap (sync IO on the loop = silent stalls / timeouts).
|
|
|
|
Anchor strategy
|
|
---------------
|
|
|
|
We can't run a real ``init_engine(backend="sqlite", ...)`` under the strict
|
|
Blockbuster gate without tripping on ``create_async_engine``'s own
|
|
``os.path.abspath`` (which is a pre-existing concern, not the bootstrap's).
|
|
The companion ``test_persistence_engine_sqlite.py`` covers the ``init_engine``
|
|
makedirs offload by mocking ``create_async_engine`` away entirely. That same
|
|
mocking approach would defeat the point here, because the alembic stamp /
|
|
upgrade calls in ``bootstrap_schema`` need a *real* on-disk SQLite DB to
|
|
exercise.
|
|
|
|
So this test installs a spy on ``asyncio.to_thread`` and confirms that the
|
|
two alembic entry points -- ``_stamp`` and ``_upgrade`` from
|
|
``bootstrap_schema`` -- are dispatched through it, not invoked inline. If a
|
|
future refactor inlines either call, the spy records zero invocations for
|
|
that function and the assertion fails.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
from sqlalchemy.ext.asyncio import create_async_engine
|
|
|
|
import deerflow.persistence.models # noqa: F401
|
|
from deerflow.persistence import bootstrap as bootstrap_mod
|
|
|
|
pytestmark = pytest.mark.asyncio
|
|
|
|
|
|
@pytest.mark.allow_blocking_io
|
|
async def test_bootstrap_offloads_alembic_stamp_and_upgrade(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None:
|
|
"""Stamp + upgrade must go through ``asyncio.to_thread``.
|
|
|
|
Marked ``allow_blocking_io`` so the strict Blockbuster gate does not flag
|
|
incidental blocking IO in test-fixture setup (engine creation paths,
|
|
SQLite path resolution). The point of this test is the
|
|
``asyncio.to_thread`` wrapping invariant, which the spy below checks
|
|
deterministically.
|
|
"""
|
|
seen: list[str] = []
|
|
|
|
original_to_thread = asyncio.to_thread
|
|
|
|
async def spy_to_thread(func, *args, **kwargs):
|
|
seen.append(getattr(func, "__name__", repr(func)))
|
|
return await original_to_thread(func, *args, **kwargs)
|
|
|
|
monkeypatch.setattr(bootstrap_mod.asyncio, "to_thread", spy_to_thread)
|
|
|
|
# Use a real SQLite DB so alembic actually runs stamp + upgrade.
|
|
db_path = tmp_path / "spy.db"
|
|
engine = create_async_engine(f"sqlite+aiosqlite:///{db_path.as_posix()}")
|
|
try:
|
|
# Empty branch -> create_all + stamp head. ``_stamp`` must be offloaded.
|
|
await bootstrap_mod.bootstrap_schema(engine, backend="sqlite")
|
|
assert "_stamp" in seen, f"_stamp not offloaded; saw: {seen}"
|
|
|
|
# Re-run -> versioned branch -> upgrade head (no-op at head). ``_upgrade`` must be offloaded.
|
|
seen.clear()
|
|
await bootstrap_mod.bootstrap_schema(engine, backend="sqlite")
|
|
assert "_upgrade" in seen, f"_upgrade not offloaded; saw: {seen}"
|
|
finally:
|
|
await engine.dispose()
|