deer-flow/backend/tests/test_run_repository.py
heart-scalpel b53c1ae0e0
fix(runs): cancel degrades to lease takeover for multi-worker (#4064)
* fix(runs): cancel degrades to lease takeover for multi-worker

Work item 4 of the multi-worker ownership epic
(https://github.com/bytedance/deer-flow/issues/3948).

Problem: POST /runs/{run_id}/cancel landing on a non-owning worker
returns 409 — the cancel button silently fails under GATEWAY_WORKERS>1
with no sticky routing. cancel() required the current worker to hold
the in-memory task/abort_event, which any non-owner pod cannot satisfy.

Changes:
- RunManager.cancel() returns CancelOutcome enum (cancelled /
  taken_over / lease_valid_elsewhere / not_active_locally /
  not_cancellable / unknown) instead of bool, so the router can map
  each outcome to the right HTTP response.
- New store primitive claim_for_takeover(): a single atomic
  conditional UPDATE that marks a run as error only when
  status IN (pending, running) AND (lease IS NULL OR
  lease < now - grace). Closes the stale-read / concurrent-heartbeat
  race — if the owner renews between our read and write, the UPDATE
  matches 0 rows and we surface lease_valid_elsewhere.
- HTTP cancel + stream-join endpoints route on CancelOutcome:
  cancelled -> 202 (or 204 with wait=true); taken_over -> 202
  immediately (no SSE streaming — the run is terminal on another
  worker, streaming would hang); lease_valid_elsewhere -> 409 +
  Retry-After header computed from lease_expires_at + grace_seconds.
- RunManager.grace_seconds exposed as a public property; the router
  no longer reaches into _run_ownership_config.
- _is_lease_expired extracted to a module-level function, shared by
  RunManager.cancel() and MemoryRunStore.claim_for_takeover().
- GATEWAY_WORKERS=1 + heartbeat_enabled=false is zero-regression:
  the non-local path short-circuits to not_active_locally, preserving
  the original 409 behaviour the existing tests pin.

Tests: 12 new (5 store primitive + 4 cancel-takeover unit + 3 HTTP
including a regression guard verifying POST /stream?action=interrupt
on a dead-owner run returns 202 instead of hanging on SSE).
244 directly-related tests pass; 36/36 blocking-IO gate pass.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* fix(runs): guard update_status and self-terminate on takeover

Two defenses close a split-brain window where the original owner
could overwrite a peer's takeover status:

- update_status (SQL + memory store) now guards on
  status IN ('pending','running'). When takeover already set
  the row to 'error', the owner's final status write matches
  0 rows and is dropped.

- _persist_status: when update_status returns False, check
  whether the row exists before attempting recovery via put().
  If the row exists (takeover by another worker), skip recovery
  instead of blindly upserting over the takeover.

- Heartbeat _renew_leases: when update_lease returns False
  (row no longer pending/running or owner changed), cancel the
  local task so wasted CPU is bounded to the next heartbeat
  tick (~10s) instead of the full task lifetime.

Also fix three reviewer feedback items:

- Re-fetch the store row when cancel() returns
  lease_valid_elsewhere, so Retry-After uses the owner's
  freshly-renewed lease instead of a stale value from
  request start.

- Fallback 'unknown' in takeover error message when
  owner_worker_id is NULL (pre-ownership data).

- Remove dead else-10 branch from grace_seconds property
  (unreachable — all callers are downstream of the
  heartbeat_enabled guard).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* test(runs): pin split-brain defences from update_status guard + heartbeat

Three tests lock down the takeover authoritativeness so a
late-running owner cannot overwrite a peer's claim:

- update_status must reject writes when the store row is already
  terminal (taken over by another worker).
- _persist_status must skip row-recovery via put() when the row
  exists but has been taken over.
- Heartbeat _renew_leases must cancel the local task when
  update_lease returns False (row claimed by another worker).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* fix(runs): precise outcome + log when local cancel loses to peer takeover

Two reviewer precision nits on the split-brain defence:

- _persist_status: branch the skip-reason log on existing["status"].
  error → WARNING "peer takeover" (anomalous); interrupted/success →
  INFO "local cancel/completion race" (expected when user hits stop
  as the run finishes). Stops noisy false-positive takeover warnings
  in operator logs.

- cancel() local path: when _persist_status returns False, re-check
  the store. If a peer's claim_for_takeover flipped the row to error
  between our in-memory cancel and the guarded update_status, surface
  taken_over instead of cancelled so the client sees a status
  consistent with the store.

Test: test_cancel_returns_taken_over_when_peer_claims_during_local_cancel
pins the race outcome.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* fix(runs): widen update_status guard, de-duplicate lease helpers, add coverage

Round 3 of reviewer feedback:

- Widen update_status guard to status IN ('pending','running','interrupted').
  The original guard blocked interrupted→error (the rollback finalize path),
  losing the "Rolled back by user" message. interrupted is now permitted
  while error/success stay locked — takeover protection unchanged.

- claim_for_takeover False now re-reads the store row to distinguish causes:
  owner renewed lease → lease_valid_elsewhere; row went terminal →
  not_cancellable; another worker already took it over → taken_over.

- Extract _raise_lease_valid_elsewhere() helper to de-duplicate the
  409+Retry-After block shared across cancel_run and stream_existing_run.

- Extract _lease_expired_or_null() in persistence/run/sql.py to
  de-duplicate the lease-expiry SQL WHERE clause shared by
  claim_for_takeover and list_inflight_with_expired_lease.

- 11 new tests: 5 SQL-layer claim_for_takeover (expired/valid/NULL/
  terminal/nonexistent), 3 _compute_retry_after unit (NULL/unparseable/
  normal), 2 claim re-read precision (terminal/takeover), 1 stream
  endpoint 409+Retry-After.

Not addressed (non-blocking, reviewer agreed):
- The 2–3 store.gets in the takeover cold path: optimizing the API to
  accept a pre-fetched record would couple the router to the manager
  more tightly than justified by the perf gain.
- The lease-expiry inline loop in MemoryRunStore.list_inflight_with_-
  expired_lease pre-computes cutoff once for all rows; switching to the
  shared _is_lease_expired helper would recompute datetime.now() per row
  with no real benefit.

260 related tests pass; 36/36 blocking-IO gate pass; ruff clean.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* fix(runs): de-duplicate lease-expiry helper, restore defensive fallback

Address final round of review feedback:

- Extract is_lease_expired to deerflow.utils.time (no _ prefix, public
  utility). Manager and MemoryRunStore now import from the same place
  instead of the store reaching backward into the manager for a private
  function.

- Restore defensive else-10 fallback in grace_seconds property (removed
  in an earlier round). The guard is unreachable for current callers but
  protects future ones from AttributeError.

- Comment the transient in-memory interrupted vs store error state when
  a local cancel is superseded by a peer takeover.

- Comment the max(1, ...) floor in _compute_retry_after — the floor is
  a lower bound, not a poll interval; clients should apply jitter.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
Co-authored-by: rayhpeng <rayhpeng@gmail.com>
2026-07-14 07:37:59 +08:00

887 lines
35 KiB
Python

"""Tests for RunRepository (SQLAlchemy-backed RunStore).
Uses a temp SQLite DB to test ORM-backed CRUD operations.
"""
from datetime import UTC, datetime, timedelta
import pytest
from sqlalchemy.dialects import postgresql
from deerflow.persistence.run import RunRepository
from deerflow.runtime import CancelOutcome, 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 {}, []
async def claim_for_takeover(self, *args, **kwargs):
return False
@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 == CancelOutcome.cancelled
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()
# ------------------------------------------------------------------
# claim_for_takeover SQL path
# ------------------------------------------------------------------
@pytest.mark.anyio
async def test_claim_for_takeover_succeeds_with_expired_lease(self, tmp_path):
repo = await _make_repo(tmp_path)
grace = 10
expired = (datetime.now(UTC) - timedelta(seconds=grace + 5)).isoformat()
await repo.put("run-1", thread_id="t1", status="running", owner_worker_id="w-a", lease_expires_at=expired, created_at=datetime.now(UTC).isoformat())
ok = await repo.claim_for_takeover("run-1", grace_seconds=grace, error="claimed")
assert ok is True
row = await repo.get("run-1")
assert row["status"] == "error"
assert row["error"] == "claimed"
await _cleanup()
@pytest.mark.anyio
async def test_claim_for_takeover_fails_on_valid_lease(self, tmp_path):
repo = await _make_repo(tmp_path)
grace = 10
valid = (datetime.now(UTC) + timedelta(seconds=30)).isoformat()
await repo.put("run-1", thread_id="t1", status="running", owner_worker_id="w-a", lease_expires_at=valid, created_at=datetime.now(UTC).isoformat())
ok = await repo.claim_for_takeover("run-1", grace_seconds=grace, error="claimed")
assert ok is False
row = await repo.get("run-1")
assert row["status"] == "running"
await _cleanup()
@pytest.mark.anyio
async def test_claim_for_takeover_succeeds_with_null_lease(self, tmp_path):
repo = await _make_repo(tmp_path)
await repo.put("run-null", thread_id="t1", status="running", created_at=datetime.now(UTC).isoformat())
ok = await repo.claim_for_takeover("run-null", grace_seconds=10, error="claimed")
assert ok is True
row = await repo.get("run-null")
assert row["status"] == "error"
await _cleanup()
@pytest.mark.anyio
async def test_claim_for_takeover_fails_on_terminal_row(self, tmp_path):
repo = await _make_repo(tmp_path)
await repo.put("run-done", thread_id="t1", status="success", created_at=datetime.now(UTC).isoformat())
ok = await repo.claim_for_takeover("run-done", grace_seconds=10, error="claimed")
assert ok is False
await _cleanup()
@pytest.mark.anyio
async def test_claim_for_takeover_nonexistent_run(self, tmp_path):
repo = await _make_repo(tmp_path)
ok = await repo.claim_for_takeover("no-such-run", grace_seconds=10, error="claimed")
assert ok is False
await _cleanup()