mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-05-30 20:38:09 +00:00
* fix(runtime): harden JSONL async I/O and DB put_batch thread validation (#2816) - JsonlRunEventStore: offload all file I/O to asyncio.to_thread() so the event loop is never blocked; add per-thread asyncio.Lock to serialise concurrent puts and prevent interleaved JSONL lines - Split _ensure_seq_loaded into a sync _compute_max_seq (runs in thread) and an async wrapper; seq counter is recovered from disk on fresh store init - DbRunEventStore.put_batch: raise ValueError when events span multiple thread_ids (previously silently assumed same thread) - Add test_jsonl_event_store_async_io.py: 12 tests covering lock reuse, concurrent seq monotonicity, disk recovery, and mixed-thread batch rejection Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: address Copilot review comments - delete_by_thread: pop _write_locks after releasing the lock to prevent unbounded growth when threads are repeatedly created and deleted - tests: add regression guard asserting asyncio.to_thread is called for _write_record in put(); assert _write_locks entry removed on delete * fix(lint): move patch import to local scope to fix ruff I001 * fix(lint): apply ruff check+format fixes to test file * fix(runtime): address review feedback for JSONL async I/O hardening (#2816) Use setdefault for atomic lock init in _get_write_lock; pop _write_locks inside the held lock scope in delete_by_thread; update test docstring and assert lock entry also cleared on delete. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: rayhpeng <rayhpeng@gmail.com>
224 lines
8.7 KiB
Python
224 lines
8.7 KiB
Python
"""Concurrency-safety tests for JsonlRunEventStore async I/O hardening (#2816).
|
|
|
|
Verifies:
|
|
- write-lock serialises concurrent puts within the same thread_id
|
|
- put_batch keeps monotonic seq even under concurrent callers
|
|
- seq recovery from disk on fresh store init
|
|
- DB put_batch rejects mixed-thread batches
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
import tempfile
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
from deerflow.runtime.events.store.jsonl import JsonlRunEventStore
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Helpers
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def _make_store(base_dir: Path) -> JsonlRunEventStore:
|
|
return JsonlRunEventStore(base_dir=base_dir)
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Write-lock: per-thread lock exists and is reused
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
@pytest.mark.anyio
|
|
async def test_get_write_lock_returns_asyncio_lock():
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
store = _make_store(Path(tmp))
|
|
lock = store._get_write_lock("t1")
|
|
assert isinstance(lock, asyncio.Lock)
|
|
|
|
|
|
@pytest.mark.anyio
|
|
async def test_get_write_lock_same_thread_reuses_lock():
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
store = _make_store(Path(tmp))
|
|
lock_a = store._get_write_lock("t1")
|
|
lock_b = store._get_write_lock("t1")
|
|
assert lock_a is lock_b
|
|
|
|
|
|
@pytest.mark.anyio
|
|
async def test_get_write_lock_different_threads_get_different_locks():
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
store = _make_store(Path(tmp))
|
|
lock_a = store._get_write_lock("t1")
|
|
lock_b = store._get_write_lock("t2")
|
|
assert lock_a is not lock_b
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Seq monotonicity under concurrent puts
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
@pytest.mark.anyio
|
|
async def test_concurrent_puts_produce_unique_monotonic_seqs():
|
|
"""10 concurrent puts on the same thread must yield distinct, monotonic seq values."""
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
store = _make_store(Path(tmp))
|
|
results = await asyncio.gather(*[store.put(thread_id="t1", run_id=f"r{i}", event_type="trace", category="trace", content=f"msg{i}") for i in range(10)])
|
|
seqs = sorted(r["seq"] for r in results)
|
|
assert seqs == list(range(1, 11)), f"Expected 1-10, got {seqs}"
|
|
|
|
|
|
@pytest.mark.anyio
|
|
async def test_concurrent_puts_different_threads_independent_seqs():
|
|
"""Concurrent puts on different threads keep independent seq counters."""
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
store = _make_store(Path(tmp))
|
|
t1_results, t2_results = await asyncio.gather(
|
|
asyncio.gather(*[store.put(thread_id="t1", run_id="r1", event_type="trace", category="trace") for _ in range(5)]),
|
|
asyncio.gather(*[store.put(thread_id="t2", run_id="r2", event_type="trace", category="trace") for _ in range(5)]),
|
|
)
|
|
t1_seqs = sorted(r["seq"] for r in t1_results)
|
|
t2_seqs = sorted(r["seq"] for r in t2_results)
|
|
assert t1_seqs == [1, 2, 3, 4, 5]
|
|
assert t2_seqs == [1, 2, 3, 4, 5]
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# put_batch: delegates to put() and preserves order
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
@pytest.mark.anyio
|
|
async def test_put_batch_seqs_are_monotonic():
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
store = _make_store(Path(tmp))
|
|
events = [{"thread_id": "t1", "run_id": "r1", "event_type": "trace", "category": "trace", "content": str(i)} for i in range(5)]
|
|
results = await store.put_batch(events)
|
|
seqs = [r["seq"] for r in results]
|
|
assert seqs == sorted(seqs)
|
|
assert len(set(seqs)) == 5
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# _ensure_seq_loaded: recovers max_seq from disk after fresh store init
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
@pytest.mark.anyio
|
|
async def test_ensure_seq_loaded_recovers_from_disk():
|
|
"""A fresh JsonlRunEventStore should pick up the max seq written by a previous instance."""
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
base = Path(tmp)
|
|
store1 = _make_store(base)
|
|
for i in range(3):
|
|
await store1.put(thread_id="t1", run_id="r1", event_type="trace", category="trace", content=str(i))
|
|
|
|
store2 = _make_store(base)
|
|
record = await store2.put(thread_id="t1", run_id="r1", event_type="trace", category="trace", content="new")
|
|
assert record["seq"] == 4, f"Expected seq=4 after recovery, got {record['seq']}"
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# asyncio.to_thread regression guard
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
@pytest.mark.anyio
|
|
async def test_put_offloads_write_via_to_thread():
|
|
"""Regression guard: put() must call asyncio.to_thread for _write_record."""
|
|
original = asyncio.to_thread
|
|
calls: list[str] = []
|
|
|
|
async def spy(*args, **kwargs):
|
|
calls.append(args[0].__name__ if callable(args[0]) else repr(args[0]))
|
|
return await original(*args, **kwargs)
|
|
|
|
from unittest.mock import patch
|
|
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
store = _make_store(Path(tmp))
|
|
with patch("asyncio.to_thread", new=spy):
|
|
await store.put(thread_id="t1", run_id="r1", event_type="trace", category="trace", content="x")
|
|
|
|
assert "_write_record" in calls, f"Expected asyncio.to_thread(_write_record, ...) — got: {calls}"
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Read methods are non-blocking (asyncio.to_thread path exercised)
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
@pytest.mark.anyio
|
|
async def test_list_messages_reads_written_records():
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
store = _make_store(Path(tmp))
|
|
await store.put(thread_id="t1", run_id="r1", event_type="human_message", category="message", content="hello")
|
|
await store.put(thread_id="t1", run_id="r1", event_type="ai_message", category="message", content="world")
|
|
messages = await store.list_messages("t1")
|
|
assert len(messages) == 2
|
|
assert messages[0]["content"] == "hello"
|
|
assert messages[1]["content"] == "world"
|
|
|
|
|
|
@pytest.mark.anyio
|
|
async def test_count_messages_accurate_after_concurrent_writes():
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
store = _make_store(Path(tmp))
|
|
await asyncio.gather(*[store.put(thread_id="t1", run_id="r1", event_type="human_message", category="message") for _ in range(7)])
|
|
count = await store.count_messages("t1")
|
|
assert count == 7
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# delete_by_thread and delete_by_run use the write lock
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
@pytest.mark.anyio
|
|
async def test_delete_by_thread_clears_seq_counter_and_lock():
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
store = _make_store(Path(tmp))
|
|
await store.put(thread_id="t1", run_id="r1", event_type="trace", category="trace")
|
|
await store.delete_by_thread("t1")
|
|
assert "t1" not in store._seq_counters
|
|
assert "t1" not in store._write_locks
|
|
|
|
|
|
@pytest.mark.anyio
|
|
async def test_delete_by_run_removes_run_events():
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
store = _make_store(Path(tmp))
|
|
await store.put(thread_id="t1", run_id="r1", event_type="trace", category="trace")
|
|
await store.put(thread_id="t1", run_id="r2", event_type="trace", category="trace")
|
|
await store.delete_by_run("t1", "r1")
|
|
events = await store.list_events("t1", "r1")
|
|
assert events == []
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# DB put_batch: rejects mixed-thread batches
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
@pytest.mark.anyio
|
|
async def test_db_put_batch_rejects_mixed_thread_ids():
|
|
"""DbRunEventStore.put_batch must raise ValueError for cross-thread batches."""
|
|
from unittest.mock import MagicMock
|
|
|
|
from deerflow.runtime.events.store.db import DbRunEventStore
|
|
|
|
mock_sf = MagicMock()
|
|
store = DbRunEventStore(session_factory=mock_sf)
|
|
|
|
events = [
|
|
{"thread_id": "t1", "run_id": "r1", "event_type": "trace", "category": "trace"},
|
|
{"thread_id": "t2", "run_id": "r2", "event_type": "trace", "category": "trace"},
|
|
]
|
|
|
|
with pytest.raises(ValueError, match="same thread"):
|
|
await store.put_batch(events)
|