mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-08-11 07:19:03 +00:00
* feat(runs): cross-process run ownership with lease + reconciliation (#3948) Implements work items 2 and 3 of the multi-worker P0 plan (docs/multi_worker.md). Work item 1 (Postgres startup gate, #3960) already landed; this PR makes run creation race-safe across worker processes and lets Postgres deployments recover orphaned inflight runs from crashed workers without mis-marking live runs as orphans. Work item 2 — cross-process atomic create_or_reject - Alembic revision 0004_run_ownership adds runs.owner_worker_id, runs.lease_expires_at, idx_runs_lease, and a partial unique index uq_runs_thread_active (one pending/running run per thread). The index is declared on RunRow.__table_args__ with sqlite_where + postgresql_where (mirroring uq_channel_connection_active_identity) so the empty-DB bootstrap path — which runs Base.metadata.create_all + alembic stamp head without executing any revision's upgrade() — also lands it on fresh deployments. Migration 0004 additionally creates it idempotently for legacy/versioned upgrades. - RunRepository.create_run_atomic is the new atomic primitive: - reject: INSERT directly; the partial unique index catches duplicate active runs; the manager surfaces the result as ConflictError. - interrupt/rollback: SELECT FOR UPDATE the conflicting rows, skip rows whose lease is still valid AND owned by another live worker (raise ConflictError — the INSERT would have failed on the index anyway, and a retry loop cannot make progress), cancel the rest in the same transaction, then INSERT the new row. Rows owned by this worker are interruptible regardless of lease state. - RunManager.create_or_reject dispatches to the store under the existing local lock; same-worker in-memory cancellation runs after the store commit succeeds. MemoryRunStore mirrors the same semantics for tests and database.backend=memory. Work item 3 — lease heartbeat + Postgres reconciliation - RunOwnershipConfig (lease_seconds=30, grace_seconds=10, heartbeat_enabled=false by default), registered as startup-only in reload_boundary.STARTUP_ONLY_FIELDS because the heartbeat background task is created once in langgraph_runtime() and is not rebuilt on config.yaml edits. - When heartbeat_enabled, each worker renewes leases on its own active runs with interval = lease_seconds / 3. The loop is bounded and stop-event-cancellable so shutdown is prompt. - reconcile_orphaned_inflight_runs now runs on every backend — the sqlite-only gate in app/gateway/deps.py is dropped in the same commit so there is no window where Postgres would mis-mark live Worker A runs as orphans. Reconciliation errors only runs whose lease is NULL (legacy pre-ownership rows) or older than grace_seconds. In single-worker mode (heartbeat off, NULL leases) all inflight rows reclaim immediately, preserving the pre-ownership recovery latency. - Heartbeat starts AFTER startup reconciliation and stops BEFORE the in-flight run drain on shutdown so the two cannot race. GATEWAY_WORKERS=1 with heartbeat_enabled=false keeps current behavior. Verified: 170 related tests + full backend suite (minus Docker-gated live tests) green; ruff check + ruff format clean. * fix(runs): tighten unique-violation handling and document clock-sync budget Three follow-up fixes to the cross-process run ownership work in #3948, surfacing during review. 1. _is_unique_violation: detect by driver-native signal, not message text The previous substring heuristic ("unique" + "violat", or "duplicate") missed SQLite's actual phrasing "UNIQUE constraint failed: <table>.<index>" — SQLite says "failed", not "violates", and never "duplicate". On SQLite the detector returned False, the reject path re-raised the raw IntegrityError, and clients saw HTTP 500 instead of ConflictError 409. The conversion is the load-bearing piece of the "store is source of truth" design but was untested — every atomic test used MemoryRunStore, which raises ConflictError directly and never reached this branch. Now prefers driver-native signals: psycopg pgcode/sqlcode "23505" and sqlite3 sqlite_errorcode SQLITE_CONSTRAINT_UNIQUE (reachable through SQLAlchemy IntegrityError.orig). Message matching stays as a fallback with SQLite's exact "unique constraint failed" phrase added. 2. interrupt/rollback: convert exhausted-retry IntegrityError to ConflictError The reject branch converts unique violations to ConflictError. The interrupt/rollback retry loop did not — on the 3rd attempt it re-raised the raw IntegrityError, leaking HTTP 500 for the same race condition that reject surfaces as 409. Symmetric conversion added after the loop; callers now see a consistent ConflictError regardless of strategy. 3. Document clock-sync requirement for multi-worker lease reconciliation reconcile_orphaned_inflight_runs compares another worker's UTC lease_expires_at against this worker's datetime.now(UTC). The only skew budget is grace_seconds (default 10s) — worst case, with the owning worker's heartbeat just about to fire, a peer whose clock is more than ~grace_seconds ahead can mis-reclaim a still-live run as an orphan. Documented in RunOwnershipConfig's docstring (with the math) and in config.example.yaml (with operational guidance), so operators in NTP-poor environments know to raise grace_seconds. Default unchanged: 10s is reasonable for NTP-synced K8s/cloud, and bumping it would slow recovery of genuinely dead workers (lease_seconds + grace_seconds from last heartbeat to reclaim). Tests: - test_create_run_atomic_reject_propagates_conflict_on_unique_violation: end-to-end against a real SQLite-backed RunRepository, pre-inserts an active run, asserts reject-strategy create surfaces as ConflictError rather than raw IntegrityError. - test_is_unique_violation_detects_real_sqlite_integrity_error: unit test for the detector against a real SQLite-raised IntegrityError; asserts driver-level sqlite_errorcode is SQLITE_CONSTRAINT_UNIQUE. - test_interrupt_exhausted_retries_surface_as_conflict_error: pins the symmetric 409 behavior after the retry loop exhausts. Verified: ruff check + ruff format clean; multi-worker + run_repository + owner_isolation + reload_boundary suites green. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * fix(runs): close multi-worker ownership gaps in lease heartbeat and unique-violation detection Five code-review fixes from docs/multi_worker.md: 1. Drop unused ``claim_inflight_runs`` primitive — no caller anywhere. ``create_run_atomic`` does its own inline claim (SELECT FOR UPDATE + cancel) inside the INSERT transaction; a separate claim primitive would split that into two transactions and open a claim→INSERT race. Removes ~40 lines across base.py / memory.py / sql.py plus the unused ``now_iso`` parameter, freeing future RunStore implementations from providing it. 2. Broaden ``_renew_leases`` filter to renew pending/running runs owned by this worker even when ``record.task is None``. The previous ``task is not None`` requirement skipped the brief window between ``create_run_atomic`` inserting the row and the worker spawning the agent task; under event-loop load that window can approach ``lease_seconds``, after which peer reconciliation marks the run ``error`` (visible) or a peer's ``create_or_reject("interrupt")`` silently kills the queued run. Filter now: ``task is None or not task.done()``. 3. Document the unsynchronised ``record.lease_expires_at = new_expiry`` write. ``lease_expires_at`` is the only field on an existing record this path mutates; ``set_status`` / ``_persist_status`` touch other fields, so there is no concurrent writer to race against. Re-acquiring ``self._lock`` would serialise unrelated run mutations for no gain. 4. Gate ``_is_unique_violation`` message fallbacks on ``isinstance(current, (SAIntegrityError, sqlite3.IntegrityError))``. The driver-code path (pgcode/sqlite_errorcode) remains load-bearing; substring fallbacks are now belt-and-suspenders only for cases where the driver attribute isn't reachable through the cause chain. Without the gate, any application exception whose ``str()`` happens to contain "duplicate key" / "unique" + "violat" (CHECK constraint, validation error) would silently surface as HTTP 409 instead of 500. 5. Route ``update_lease`` through ``_call_store_with_retry`` for consistency with every other store call, and wrap ``await self._renew_leases()`` in ``_heartbeat_loop`` with ``except Exception: logger.warning(...)``. Previously a transient error from the snapshot path or an unexpected exception would kill the heartbeat task silently — after which no lease is ever renewed again and every active run eventually looks orphaned. ``except Exception`` lets ``CancelledError`` (BaseException since 3.8) propagate so shutdown cancellation still works. Regression tests: - ``test_heartbeat_renews_pending_run_before_task_is_spawned`` - ``test_is_unique_violation_does_not_misclassify_application_exception`` Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * fix(runs): harden multi-worker migration, memory atomicity, and tz-naive lease comparison Three follow-up fixes to the multi-worker run ownership work: - migration 0004 dedupe pass: cancel superseded duplicate active rows per thread before creating the partial UNIQUE index ``uq_runs_thread_active`` so dirty DBs (Postgres deployments that had reconciliation skipped by the old sqlite-only gate, or any env that ran GATEWAY_WORKERS>1 before this PR) do not abort the alembic upgrade and block gateway startup. Keeps the newest active row per thread, marks the rest as error with an explanatory message. - MemoryRunStore.create_run_atomic interrupt/rollback path: split the single- pass loop into two passes (collect candidates, validate, then mutate) so a ConflictError raised on a later candidate does not leave earlier candidates half-interrupted. Mirrors the SQL store's transactional rollback semantics; the entire test_multi_worker_run_ownership.py suite runs against memory so this divergence was giving false confidence. - RunRepository.create_run_atomic interrupt path: coerce tz-naive ``row.lease_expires_at`` to UTC before comparing against the aware ``cutoff``. SQLite drops tzinfo on read despite ``DateTime(timezone=True)`` (this file's own comment acknowledges it), so the Python-side comparison raised ``TypeError: can't compare offset-naive and offset-aware datetimes`` whenever heartbeat was enabled on SQLite and a lease was non-NULL. Defaults (heartbeat off -> leases always NULL) masked it, but there was no guard against the combination. Follows the existing "naive is UTC" convention from ``coerce_iso``. Each fix ships with a regression test pinning the behavior. Co-Authored-By: heart-scalpel <heart-scalpel@users.noreply.github.com> Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * fix(runs): enforce heartbeat for multi-worker, fix memory-store datetime comparison, lazy-import ConflictError in store layer Three fixes from code review: 1. Extend the startup gate (GATEWAY_WORKERS>1) to also require run_ownership.heartbeat_enabled=true. Without heartbeat every run has a NULL lease, so reconciliation treats all inflight rows as orphans and Worker B would kill Worker A's live runs on every rolling update or scale-up. 2. Fix MemoryRunStore.list_inflight_with_expired_lease to parse created_at as datetime instead of ISO string lexical comparison, and handle tz-naive lease values uniformly with the SQL store. 3. Store layer (sql.py, memory.py) now lazy-imports ConflictError inside create_run_atomic instead of importing from the higher RunManager layer at module level. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * fix(runs): add owner check to update_lease, document create() assumption, restore deleted comment - update_lease (SQL + memory) now requires owner_worker_id match in WHERE clause so the primitive is safe by construction against misuse - create() docstring notes it bypasses atomic create_run_atomic and assumes no active run exists for the thread - restore explanatory comment in MemoryRunStore.aggregate_tokens_by_thread that was dropped in an earlier commit Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * fix(runs): add psycopg3 sqlstate detection and periodic orphan reconciliation - _is_unique_violation now checks sqlstate attribute (psycopg3 uses this instead of pgcode). On Postgres, the only supported multi-worker backend, detection was falling through to the message-substring fallback. - _heartbeat_loop now runs reconcile_orphaned_inflight_runs every 3rd cycle (every lease_seconds) to catch orphans whose lease expires between pod restarts. Single-worker deployments are unaffected (heartbeat off). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com> Co-authored-by: heart-scalpel <heart-scalpel@users.noreply.github.com> Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
821 lines
32 KiB
Python
821 lines
32 KiB
Python
"""Tests for RunRepository (SQLAlchemy-backed RunStore).
|
|
|
|
Uses a temp SQLite DB to test ORM-backed CRUD operations.
|
|
"""
|
|
|
|
import pytest
|
|
from sqlalchemy.dialects import postgresql
|
|
|
|
from deerflow.persistence.run import RunRepository
|
|
from deerflow.runtime import RunManager, RunStatus
|
|
from deerflow.runtime.runs.manager import ConflictError
|
|
from deerflow.runtime.runs.store.base import RunStore
|
|
|
|
|
|
async def _make_repo(tmp_path):
|
|
from deerflow.persistence.engine import get_session_factory, init_engine
|
|
|
|
url = f"sqlite+aiosqlite:///{tmp_path / 'test.db'}"
|
|
await init_engine("sqlite", url=url, sqlite_dir=str(tmp_path))
|
|
return RunRepository(get_session_factory())
|
|
|
|
|
|
async def _cleanup():
|
|
from deerflow.persistence.engine import close_engine
|
|
|
|
await close_engine()
|
|
|
|
|
|
class _CustomRunStoreWithoutProgress(RunStore):
|
|
async def put(self, *args, **kwargs):
|
|
return None
|
|
|
|
async def get(self, *args, **kwargs):
|
|
return None
|
|
|
|
async def list_by_thread(self, *args, **kwargs):
|
|
return []
|
|
|
|
async def update_status(self, *args, **kwargs):
|
|
return None
|
|
|
|
async def delete(self, *args, **kwargs):
|
|
return None
|
|
|
|
async def update_model_name(self, *args, **kwargs):
|
|
return None
|
|
|
|
async def update_run_completion(self, *args, **kwargs):
|
|
return None
|
|
|
|
async def list_pending(self, *args, **kwargs):
|
|
return []
|
|
|
|
async def list_inflight(self, *args, **kwargs):
|
|
return []
|
|
|
|
async def aggregate_tokens_by_thread(self, *args, **kwargs):
|
|
return {}
|
|
|
|
async def update_lease(self, *args, **kwargs):
|
|
return True
|
|
|
|
async def list_inflight_with_expired_lease(self, *args, **kwargs):
|
|
return []
|
|
|
|
async def create_run_atomic(self, *args, **kwargs):
|
|
return {}, []
|
|
|
|
|
|
@pytest.mark.anyio
|
|
async def test_update_run_progress_defaults_to_noop_for_custom_store():
|
|
store = _CustomRunStoreWithoutProgress()
|
|
|
|
await store.update_run_progress("r1", total_tokens=1)
|
|
|
|
|
|
class TestRunRepository:
|
|
@pytest.mark.anyio
|
|
async def test_put_and_get(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", status="pending")
|
|
row = await repo.get("r1")
|
|
assert row is not None
|
|
assert row["run_id"] == "r1"
|
|
assert row["thread_id"] == "t1"
|
|
assert row["status"] == "pending"
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_put_is_idempotent_for_retried_writes(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", assistant_id="old-agent", status="pending")
|
|
|
|
await repo.put("r1", thread_id="t1", assistant_id="new-agent", status="running", error="retry")
|
|
|
|
row = await repo.get("r1")
|
|
assert row["assistant_id"] == "new-agent"
|
|
assert row["status"] == "running"
|
|
assert row["error"] == "retry"
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_get_missing_returns_none(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
assert await repo.get("nope") is None
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_update_status(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1")
|
|
updated = await repo.update_status("r1", "running")
|
|
row = await repo.get("r1")
|
|
assert updated is True
|
|
assert row["status"] == "running"
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_update_status_returns_false_for_missing_row(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
updated = await repo.update_status("missing", "error", error="lost")
|
|
assert updated is False
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_update_status_with_error(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1")
|
|
await repo.update_status("r1", "error", error="boom")
|
|
row = await repo.get("r1")
|
|
assert row["status"] == "error"
|
|
assert row["error"] == "boom"
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_list_by_thread(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", status="success")
|
|
await repo.put("r2", thread_id="t1", status="pending")
|
|
await repo.put("r3", thread_id="t2", status="pending")
|
|
rows = await repo.list_by_thread("t1")
|
|
assert len(rows) == 2
|
|
assert all(r["thread_id"] == "t1" for r in rows)
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_list_by_thread_owner_filter(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", user_id="alice", status="success")
|
|
await repo.put("r2", thread_id="t1", user_id="bob", status="pending")
|
|
rows = await repo.list_by_thread("t1", user_id="alice")
|
|
assert len(rows) == 1
|
|
assert rows[0]["user_id"] == "alice"
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_delete(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1")
|
|
await repo.delete("r1")
|
|
assert await repo.get("r1") is None
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_delete_nonexistent_is_noop(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.delete("nope") # should not raise
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_list_pending(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", status="pending")
|
|
await repo.put("r2", thread_id="t2", status="running")
|
|
await repo.put("r3", thread_id="t3", status="pending")
|
|
pending = await repo.list_pending()
|
|
assert len(pending) == 2
|
|
assert all(r["status"] == "pending" for r in pending)
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_list_inflight_returns_pending_and_running_before_cutoff(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
# Each thread can hold at most one pending/running row (partial unique
|
|
# index ``uq_runs_thread_active``), so spread the inflight rows across
|
|
# distinct threads to exercise the before-cutoff filter.
|
|
await repo.put("pending-old", thread_id="t1", status="pending", created_at="2026-01-01T00:00:00+00:00")
|
|
await repo.put("running-old", thread_id="t2", status="running", created_at="2026-01-01T00:00:01+00:00")
|
|
await repo.put("success-old", thread_id="t3", status="success", created_at="2026-01-01T00:00:02+00:00")
|
|
await repo.put("pending-new", thread_id="t4", status="pending", created_at="2026-01-01T00:00:03+00:00")
|
|
|
|
inflight = await repo.list_inflight(before="2026-01-01T00:00:02+00:00")
|
|
|
|
assert [row["run_id"] for row in inflight] == ["pending-old", "running-old"]
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_update_run_completion(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", status="running")
|
|
updated = await repo.update_run_completion(
|
|
"r1",
|
|
status="success",
|
|
total_input_tokens=100,
|
|
total_output_tokens=50,
|
|
total_tokens=150,
|
|
llm_call_count=2,
|
|
lead_agent_tokens=120,
|
|
subagent_tokens=20,
|
|
middleware_tokens=10,
|
|
message_count=3,
|
|
last_ai_message="The answer is 42",
|
|
first_human_message="What is the meaning?",
|
|
)
|
|
row = await repo.get("r1")
|
|
assert updated is True
|
|
assert row["status"] == "success"
|
|
assert row["total_tokens"] == 150
|
|
assert row["llm_call_count"] == 2
|
|
assert row["lead_agent_tokens"] == 120
|
|
assert row["message_count"] == 3
|
|
assert row["last_ai_message"] == "The answer is 42"
|
|
assert row["first_human_message"] == "What is the meaning?"
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_update_run_completion_returns_false_for_missing_row(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
updated = await repo.update_run_completion("missing", status="error", total_tokens=1)
|
|
assert updated is False
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_metadata_preserved(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", metadata={"key": "value"})
|
|
row = await repo.get("r1")
|
|
assert row["metadata"] == {"key": "value"}
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_kwargs_with_non_serializable(self, tmp_path):
|
|
"""kwargs containing non-JSON-serializable objects should be safely handled."""
|
|
repo = await _make_repo(tmp_path)
|
|
|
|
class Dummy:
|
|
pass
|
|
|
|
await repo.put("r1", thread_id="t1", kwargs={"obj": Dummy()})
|
|
row = await repo.get("r1")
|
|
assert "obj" in row["kwargs"]
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_update_run_completion_preserves_existing_fields(self, tmp_path):
|
|
"""update_run_completion does not overwrite thread_id or assistant_id."""
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", assistant_id="agent1", status="running")
|
|
await repo.update_run_completion("r1", status="success", total_tokens=100)
|
|
row = await repo.get("r1")
|
|
assert row["thread_id"] == "t1"
|
|
assert row["assistant_id"] == "agent1"
|
|
assert row["total_tokens"] == 100
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_update_run_progress_keeps_status_running(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", status="running")
|
|
await repo.update_run_progress(
|
|
"r1",
|
|
total_input_tokens=40,
|
|
total_output_tokens=10,
|
|
total_tokens=50,
|
|
llm_call_count=1,
|
|
message_count=2,
|
|
last_ai_message="partial answer",
|
|
)
|
|
row = await repo.get("r1")
|
|
assert row["status"] == "running"
|
|
assert row["total_tokens"] == 50
|
|
assert row["llm_call_count"] == 1
|
|
assert row["message_count"] == 2
|
|
assert row["last_ai_message"] == "partial answer"
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_update_run_progress_preserves_omitted_fields(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", status="running")
|
|
await repo.update_run_progress(
|
|
"r1",
|
|
total_input_tokens=40,
|
|
total_output_tokens=10,
|
|
total_tokens=50,
|
|
llm_call_count=1,
|
|
lead_agent_tokens=30,
|
|
subagent_tokens=20,
|
|
message_count=2,
|
|
)
|
|
|
|
await repo.update_run_progress("r1", total_tokens=60, last_ai_message="updated")
|
|
|
|
row = await repo.get("r1")
|
|
assert row["total_input_tokens"] == 40
|
|
assert row["total_output_tokens"] == 10
|
|
assert row["total_tokens"] == 60
|
|
assert row["llm_call_count"] == 1
|
|
assert row["lead_agent_tokens"] == 30
|
|
assert row["subagent_tokens"] == 20
|
|
assert row["message_count"] == 2
|
|
assert row["last_ai_message"] == "updated"
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_update_run_progress_skips_terminal_runs(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", status="running")
|
|
await repo.update_run_completion("r1", status="success", total_tokens=100, llm_call_count=1)
|
|
|
|
await repo.update_run_progress("r1", total_tokens=200, llm_call_count=2)
|
|
|
|
row = await repo.get("r1")
|
|
assert row["status"] == "success"
|
|
assert row["total_tokens"] == 100
|
|
assert row["llm_call_count"] == 1
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_aggregate_tokens_by_thread_counts_completed_runs_only(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("success-run", thread_id="t1", status="running")
|
|
await repo.update_run_completion(
|
|
"success-run",
|
|
status="success",
|
|
total_input_tokens=70,
|
|
total_output_tokens=30,
|
|
total_tokens=100,
|
|
lead_agent_tokens=80,
|
|
subagent_tokens=15,
|
|
middleware_tokens=5,
|
|
)
|
|
await repo.put("error-run", thread_id="t1", status="running")
|
|
await repo.update_run_completion(
|
|
"error-run",
|
|
status="error",
|
|
total_input_tokens=20,
|
|
total_output_tokens=30,
|
|
total_tokens=50,
|
|
lead_agent_tokens=40,
|
|
subagent_tokens=10,
|
|
)
|
|
await repo.put("running-run", thread_id="t1", status="running")
|
|
await repo.update_run_completion(
|
|
"running-run",
|
|
status="running",
|
|
total_input_tokens=900,
|
|
total_output_tokens=99,
|
|
total_tokens=999,
|
|
lead_agent_tokens=999,
|
|
)
|
|
await repo.put("other-thread-run", thread_id="t2", status="running")
|
|
await repo.update_run_completion(
|
|
"other-thread-run",
|
|
status="success",
|
|
total_tokens=888,
|
|
lead_agent_tokens=888,
|
|
)
|
|
|
|
agg = await repo.aggregate_tokens_by_thread("t1")
|
|
|
|
assert agg["total_tokens"] == 150
|
|
assert agg["total_input_tokens"] == 90
|
|
assert agg["total_output_tokens"] == 60
|
|
assert agg["total_runs"] == 2
|
|
assert agg["by_model"] == {"unknown": {"tokens": 150, "runs": 2}}
|
|
assert agg["by_caller"] == {
|
|
"lead_agent": 120,
|
|
"subagent": 25,
|
|
"middleware": 5,
|
|
}
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_aggregate_tokens_by_thread_can_include_active_runs(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("success-run", thread_id="t1", status="running")
|
|
await repo.update_run_completion("success-run", status="success", total_tokens=100, lead_agent_tokens=100)
|
|
await repo.put("running-run", thread_id="t1", status="running")
|
|
await repo.update_run_progress("running-run", total_tokens=25, lead_agent_tokens=20, subagent_tokens=5)
|
|
|
|
without_active = await repo.aggregate_tokens_by_thread("t1")
|
|
with_active = await repo.aggregate_tokens_by_thread("t1", include_active=True)
|
|
|
|
assert without_active["total_tokens"] == 100
|
|
assert without_active["total_runs"] == 1
|
|
assert with_active["total_tokens"] == 125
|
|
assert with_active["total_runs"] == 2
|
|
assert with_active["by_caller"] == {
|
|
"lead_agent": 120,
|
|
"subagent": 5,
|
|
"middleware": 0,
|
|
}
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_list_by_thread_ordered_desc(self, tmp_path):
|
|
"""list_by_thread returns newest first."""
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", status="success", created_at="2024-01-01T00:00:00+00:00")
|
|
await repo.put("r2", thread_id="t1", status="pending", created_at="2024-01-02T00:00:00+00:00")
|
|
rows = await repo.list_by_thread("t1")
|
|
assert rows[0]["run_id"] == "r2"
|
|
assert rows[1]["run_id"] == "r1"
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_list_by_thread_limit(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
# Only one row can be pending/running per thread; mark earlier ones
|
|
# terminal so the partial unique index still holds.
|
|
for i in range(4):
|
|
await repo.put(f"r{i}", thread_id="t1", status="success")
|
|
await repo.put("r4", thread_id="t1", status="pending")
|
|
rows = await repo.list_by_thread("t1", limit=2)
|
|
assert len(rows) == 2
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_owner_none_returns_all(self, tmp_path):
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", user_id="alice", status="success")
|
|
await repo.put("r2", thread_id="t1", user_id="bob", status="pending")
|
|
rows = await repo.list_by_thread("t1", user_id=None)
|
|
assert len(rows) == 2
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_model_name_persistence(self, tmp_path):
|
|
"""RunRepository should persist, normalize, and truncate model_name correctly via SQL."""
|
|
from deerflow.persistence.engine import get_session_factory, init_engine
|
|
|
|
url = f"sqlite+aiosqlite:///{tmp_path / 'test.db'}"
|
|
await init_engine("sqlite", url=url, sqlite_dir=str(tmp_path))
|
|
repo = RunRepository(get_session_factory())
|
|
|
|
await repo.put("run-1", thread_id="thread-1", model_name="gpt-4o", status="success")
|
|
row = await repo.get("run-1")
|
|
assert row is not None
|
|
assert row["model_name"] == "gpt-4o"
|
|
|
|
long_name = "a" * 200
|
|
await repo.put("run-2", thread_id="thread-1", model_name=long_name, status="success")
|
|
row2 = await repo.get("run-2")
|
|
assert row2["model_name"] == "a" * 128
|
|
|
|
await repo.put("run-3", thread_id="thread-1", model_name=123, status="success")
|
|
row3 = await repo.get("run-3")
|
|
assert row3["model_name"] == "123"
|
|
|
|
await repo.put("run-4", thread_id="thread-1", model_name=None, status="pending")
|
|
row4 = await repo.get("run-4")
|
|
assert row4["model_name"] is None
|
|
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_aggregate_tokens_by_thread_returns_zeros_when_no_rows(self):
|
|
"""Empty thread aggregates to all-zero totals, no model buckets, and a
|
|
single query — replaces the older test that pinned the now-removed
|
|
``GROUP BY coalesce(model_name)`` shape (issue #3645 reduces by_model
|
|
in Python from each row's per-model JSON column instead)."""
|
|
captured = []
|
|
|
|
class FakeResult:
|
|
def all(self):
|
|
return []
|
|
|
|
class FakeSession:
|
|
async def execute(self, stmt):
|
|
captured.append(stmt)
|
|
return FakeResult()
|
|
|
|
class FakeSessionContext:
|
|
async def __aenter__(self):
|
|
return FakeSession()
|
|
|
|
async def __aexit__(self, exc_type, exc, tb):
|
|
return None
|
|
|
|
repo = RunRepository(lambda: FakeSessionContext())
|
|
|
|
agg = await repo.aggregate_tokens_by_thread("t1")
|
|
assert agg == {
|
|
"total_tokens": 0,
|
|
"total_input_tokens": 0,
|
|
"total_output_tokens": 0,
|
|
"total_runs": 0,
|
|
"by_model": {},
|
|
"by_caller": {"lead_agent": 0, "subagent": 0, "middleware": 0},
|
|
}
|
|
assert len(captured) == 1
|
|
|
|
@pytest.mark.anyio
|
|
async def test_aggregate_tokens_by_thread_compiles_on_postgres_dialect(self):
|
|
"""Compile-smoke the new SELECT on the postgres dialect.
|
|
|
|
The project ships both SQLite and Postgres backends. The new aggregation
|
|
projects ``RunRow.token_usage_by_model`` (a JSON column) directly into
|
|
the row set instead of grouping on a scalar, so the SQL needs to compile
|
|
cleanly under PG's JSON/JSONB binding too. Pins:
|
|
* the JSON column is selected by name (PG would otherwise need a
|
|
``::jsonb`` cast or coalesce around it)
|
|
* there is no GROUP BY / aggregate function left (the per-model
|
|
reduction now happens in Python — see issue #3645)
|
|
"""
|
|
|
|
captured = []
|
|
|
|
class FakeResult:
|
|
def all(self):
|
|
return []
|
|
|
|
class FakeSession:
|
|
async def execute(self, stmt):
|
|
captured.append(stmt)
|
|
return FakeResult()
|
|
|
|
class FakeSessionContext:
|
|
async def __aenter__(self):
|
|
return FakeSession()
|
|
|
|
async def __aexit__(self, exc_type, exc, tb):
|
|
return None
|
|
|
|
repo = RunRepository(lambda: FakeSessionContext())
|
|
await repo.aggregate_tokens_by_thread("t1")
|
|
|
|
compiled = str(captured[0].compile(dialect=postgresql.dialect()))
|
|
assert "token_usage_by_model" in compiled
|
|
assert "GROUP BY" not in compiled.upper()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_run_manager_hydrates_store_only_run_from_sql(self, tmp_path):
|
|
"""RunManager should hydrate historical runs from SQL-backed store."""
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put(
|
|
"sql-store-only",
|
|
thread_id="thread-1",
|
|
assistant_id="lead_agent",
|
|
status="success",
|
|
metadata={"source": "sql"},
|
|
kwargs={"input": "value"},
|
|
model_name="model-a",
|
|
)
|
|
manager = RunManager(store=repo)
|
|
|
|
record = await manager.get("sql-store-only")
|
|
rows = await manager.list_by_thread("thread-1")
|
|
|
|
assert record is not None
|
|
assert record.run_id == "sql-store-only"
|
|
assert record.status == RunStatus.success
|
|
assert record.metadata == {"source": "sql"}
|
|
assert record.kwargs == {"input": "value"}
|
|
assert record.model_name == "model-a"
|
|
assert [run.run_id for run in rows] == ["sql-store-only"]
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_run_manager_cancel_persists_interrupted_status_to_sql(self, tmp_path):
|
|
"""RunManager.cancel should write interrupted status to SQL-backed store."""
|
|
repo = await _make_repo(tmp_path)
|
|
manager = RunManager(store=repo)
|
|
record = await manager.create("thread-1")
|
|
await manager.set_status(record.run_id, RunStatus.running)
|
|
|
|
cancelled = await manager.cancel(record.run_id)
|
|
row = await repo.get(record.run_id)
|
|
|
|
assert cancelled is True
|
|
assert row is not None
|
|
assert row["status"] == "interrupted"
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_update_model_name(self, tmp_path):
|
|
"""RunRepository.update_model_name should update model_name for existing run."""
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", model_name="initial-model")
|
|
await repo.update_model_name("r1", "updated-model")
|
|
row = await repo.get("r1")
|
|
assert row["model_name"] == "updated-model"
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_update_model_name_normalizes_value(self, tmp_path):
|
|
"""RunRepository.update_model_name should normalize and truncate model_name."""
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1")
|
|
long_name = "a" * 200
|
|
await repo.update_model_name("r1", long_name)
|
|
row = await repo.get("r1")
|
|
assert row["model_name"] == "a" * 128
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_update_model_name_to_none(self, tmp_path):
|
|
"""RunRepository.update_model_name should allow setting model_name to None."""
|
|
repo = await _make_repo(tmp_path)
|
|
await repo.put("r1", thread_id="t1", model_name="initial-model")
|
|
await repo.update_model_name("r1", None)
|
|
row = await repo.get("r1")
|
|
assert row["model_name"] is None
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_run_manager_update_model_name_persists_to_sql(self, tmp_path):
|
|
"""RunManager.update_model_name should persist to SQL-backed store without integrity error."""
|
|
repo = await _make_repo(tmp_path)
|
|
manager = RunManager(store=repo)
|
|
record = await manager.create("thread-1")
|
|
|
|
await manager.update_model_name(record.run_id, "gpt-4o")
|
|
|
|
row = await repo.get(record.run_id)
|
|
assert row is not None
|
|
assert row["model_name"] == "gpt-4o"
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_run_manager_update_model_name_twice(self, tmp_path):
|
|
"""RunManager.update_model_name should support multiple updates."""
|
|
repo = await _make_repo(tmp_path)
|
|
manager = RunManager(store=repo)
|
|
record = await manager.create("thread-1")
|
|
|
|
await manager.update_model_name(record.run_id, "model-1")
|
|
await manager.update_model_name(record.run_id, "model-2")
|
|
|
|
row = await repo.get(record.run_id)
|
|
assert row["model_name"] == "model-2"
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_create_run_atomic_reject_propagates_conflict_on_unique_violation(self, tmp_path):
|
|
"""reject path against a real SQLite-backed store must surface as ConflictError, not raw IntegrityError.
|
|
|
|
The partial unique index ``uq_runs_thread_active`` is created by
|
|
``Base.metadata.create_all`` on SQLite too. Every other atomic-create
|
|
test in the suite uses ``MemoryRunStore``, which raises ConflictError
|
|
directly and never exercises the manager's
|
|
``_is_unique_violation``-based conversion. This test is the load-bearing
|
|
coverage for that branch on a real DB: pre-insert an active run on
|
|
thread T, then attempt a reject-strategy create for the same thread,
|
|
and assert ConflictError (HTTP 409) — not a leaking IntegrityError
|
|
(HTTP 500).
|
|
"""
|
|
from datetime import UTC, datetime, timedelta
|
|
|
|
from deerflow.config.run_ownership_config import RunOwnershipConfig
|
|
|
|
repo = await _make_repo(tmp_path)
|
|
manager = RunManager(
|
|
store=repo,
|
|
run_ownership_config=RunOwnershipConfig(
|
|
lease_seconds=30,
|
|
grace_seconds=10,
|
|
heartbeat_enabled=False,
|
|
),
|
|
)
|
|
|
|
# Pre-insert an active run on thread T directly through the store so
|
|
# the partial unique index has something to enforce on the second insert.
|
|
lease = (datetime.now(UTC) + timedelta(seconds=30)).isoformat()
|
|
await repo.create_run_atomic(
|
|
"run-A",
|
|
thread_id="thread-T",
|
|
owner_worker_id="worker-A",
|
|
lease_expires_at=lease,
|
|
multitask_strategy="reject",
|
|
created_at=datetime.now(UTC).isoformat(),
|
|
)
|
|
|
|
# Second reject-strategy create against the same thread must convert the
|
|
# underlying IntegrityError into ConflictError via ``_is_unique_violation``.
|
|
with pytest.raises(ConflictError, match="already has an active run"):
|
|
await manager.create_or_reject(
|
|
"thread-T",
|
|
multitask_strategy="reject",
|
|
)
|
|
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_is_unique_violation_detects_real_sqlite_integrity_error(self, tmp_path):
|
|
"""``_is_unique_violation`` must return True for a real SQLite IntegrityError.
|
|
|
|
SQLite raises ``UNIQUE constraint failed: runs.uq_runs_thread_active``
|
|
which contains "unique" but neither "violat" nor "duplicate" — the
|
|
previous substring-only heuristic returned False on SQLite, leaking the
|
|
raw IntegrityError. This test triggers a real violation against the
|
|
partial unique index and feeds the resulting SQLAlchemy IntegrityError
|
|
(with the wrapped sqlite3.IntegrityError on ``.orig``) through the
|
|
detector to assert True.
|
|
"""
|
|
import sqlite3
|
|
|
|
from sqlalchemy.exc import IntegrityError
|
|
|
|
from deerflow.runtime.runs.manager import _is_unique_violation
|
|
|
|
repo = await _make_repo(tmp_path)
|
|
|
|
# First insert succeeds; second collides on the partial unique index.
|
|
await repo.put("first", thread_id="thread-T", status="pending")
|
|
with pytest.raises(IntegrityError) as exc_info:
|
|
await repo.put("second", thread_id="thread-T", status="pending")
|
|
|
|
# The wrapped driver exception must be a sqlite3 IntegrityError carrying
|
|
# SQLITE_CONSTRAINT_UNIQUE. Walk the chain so we assert on the actual
|
|
# driver-level signal, not the SQLAlchemy wrapper.
|
|
driver = exc_info.value.orig
|
|
assert isinstance(driver, sqlite3.IntegrityError)
|
|
assert driver.sqlite_errorcode == sqlite3.SQLITE_CONSTRAINT_UNIQUE
|
|
|
|
# The detector must return True regardless of message phrasing.
|
|
assert _is_unique_violation(exc_info.value) is True
|
|
|
|
await _cleanup()
|
|
|
|
@pytest.mark.anyio
|
|
async def test_is_unique_violation_does_not_misclassify_application_exception(self):
|
|
"""Message fallbacks must not fire on non-IntegrityError exceptions.
|
|
|
|
A ``ValueError`` / ``RuntimeError`` whose ``str()`` happens to
|
|
contain ``"duplicate key"`` or ``"unique" + "violat"`` substrings
|
|
must NOT be classified as a unique violation — that would silently
|
|
mask real application bugs as HTTP 409 conflicts instead of 500.
|
|
Pre-fix the substring-only fallback fired regardless of exception
|
|
type. The fix gates the fallback on
|
|
``isinstance(current, (SAIntegrityError, sqlite3.IntegrityError))``.
|
|
"""
|
|
from deerflow.runtime.runs.manager import _is_unique_violation
|
|
|
|
assert _is_unique_violation(ValueError("duplicate key in input data: 'email'")) is False
|
|
assert _is_unique_violation(RuntimeError("unique violat detected in config")) is False
|
|
assert _is_unique_violation(Exception("unique constraint failed (in a unit test mock)")) is False
|
|
|
|
@pytest.mark.anyio
|
|
async def test_is_unique_violation_detects_psycopg3_sqlstate(self):
|
|
"""psycopg3 exposes the error code via ``sqlstate``, not ``pgcode``.
|
|
|
|
On Postgres (the only supported multi-worker backend), psycopg3's
|
|
``sqlstate=23505`` must be detected as a unique violation without
|
|
falling through to the message-substring fallback.
|
|
"""
|
|
from sqlalchemy.exc import IntegrityError as SAIntegrityError
|
|
|
|
from deerflow.runtime.runs.manager import _is_unique_violation
|
|
|
|
# Simulate psycopg3's sqlstate attribute on a wrapped IntegrityError
|
|
dbapi_err = Exception()
|
|
dbapi_err.sqlstate = "23505" # psycopg3 uses sqlstate
|
|
|
|
sa_err = SAIntegrityError(
|
|
"duplicate key value violates unique constraint",
|
|
params=None,
|
|
orig=dbapi_err,
|
|
)
|
|
|
|
assert _is_unique_violation(sa_err) is True
|
|
|
|
@pytest.mark.anyio
|
|
async def test_create_run_atomic_interrupt_tolerates_tz_naive_lease_on_sqlite(self, tmp_path):
|
|
"""Interrupt path must not raise TypeError comparing naive vs aware datetimes.
|
|
|
|
SQLite drops tzinfo on read despite ``DateTime(timezone=True)`` (see
|
|
the comment in ``RunRepository._row_to_dict``). The interrupt branch
|
|
of ``create_run_atomic`` compares ``row.lease_expires_at`` against
|
|
the aware ``cutoff = datetime.now(UTC) - ...`` in Python. Under
|
|
default config (heartbeat disabled) leases are always NULL so the
|
|
``is not None`` check short-circuits, but there is no guard against
|
|
``heartbeat_enabled=true`` on SQLite — a naive lease would raise
|
|
``TypeError: can't compare offset-naive and offset-aware datetimes``
|
|
and surface as an opaque 500.
|
|
|
|
Pre-fix this test fails with TypeError; post-fix it raises
|
|
ConflictError (the live other-worker run blocks the interrupt).
|
|
"""
|
|
from datetime import UTC, datetime, timedelta
|
|
|
|
repo = await _make_repo(tmp_path)
|
|
|
|
# Seed an active run owned by another worker with a still-valid lease.
|
|
# The lease value is stored as ISO; SQLite reads it back as a tz-naive
|
|
# datetime — exactly the shape that triggered the bug.
|
|
valid_lease = (datetime.now(UTC) + timedelta(seconds=30)).isoformat()
|
|
await repo.create_run_atomic(
|
|
"valid-lease-run",
|
|
thread_id="thread-T",
|
|
owner_worker_id="other-worker",
|
|
lease_expires_at=valid_lease,
|
|
multitask_strategy="reject",
|
|
created_at=datetime.now(UTC).isoformat(),
|
|
)
|
|
|
|
# The interrupt path must surface a clean ConflictError, not a
|
|
# TypeError from the naive-vs-aware comparison.
|
|
with pytest.raises(ConflictError, match="another worker"):
|
|
await repo.create_run_atomic(
|
|
"run-new",
|
|
thread_id="thread-T",
|
|
owner_worker_id="w1",
|
|
lease_expires_at=(datetime.now(UTC) + timedelta(seconds=30)).isoformat(),
|
|
multitask_strategy="interrupt",
|
|
created_at=datetime.now(UTC).isoformat(),
|
|
)
|
|
|
|
await _cleanup()
|