355 lines
14 KiB
Python
355 lines
14 KiB
Python
"""Unit tests for ThreadState reducers.
|
|
|
|
Regression coverage for issue #3123: todos list disappearing after streaming
|
|
completes because a downstream node's partial state update with `todos=None`
|
|
overwrites the previously accumulated value.
|
|
"""
|
|
|
|
from typing import get_type_hints
|
|
|
|
import pytest
|
|
|
|
from deerflow.agents import thread_state as thread_state_module
|
|
from deerflow.agents.thread_state import (
|
|
_SKILL_CONTEXT_MAX_ENTRIES,
|
|
TERMINAL_STATUSES,
|
|
SkillEntry,
|
|
ThreadState,
|
|
merge_artifacts,
|
|
merge_delegations,
|
|
merge_goal,
|
|
merge_sandbox,
|
|
merge_skill_context,
|
|
merge_todos,
|
|
merge_viewed_images,
|
|
)
|
|
from deerflow.subagents.status_contract import SUBAGENT_STATUS_VALUES
|
|
|
|
|
|
class TestMergeSandbox:
|
|
"""Reducer for ThreadState.sandbox - allows idempotent concurrent writes."""
|
|
|
|
def test_none_new_preserves_existing(self):
|
|
existing = {"sandbox_id": "sandbox-1"}
|
|
assert merge_sandbox(existing, None) == existing
|
|
|
|
def test_none_existing_accepts_new(self):
|
|
new = {"sandbox_id": "sandbox-1"}
|
|
assert merge_sandbox(None, new) == new
|
|
|
|
def test_same_sandbox_id_is_idempotent(self):
|
|
existing = {"sandbox_id": "sandbox-1"}
|
|
new = {"sandbox_id": "sandbox-1"}
|
|
assert merge_sandbox(existing, new) == existing
|
|
|
|
def test_both_none_sandbox_id_is_idempotent(self):
|
|
existing = {"sandbox_id": None}
|
|
new = {"sandbox_id": None}
|
|
assert merge_sandbox(existing, new) == existing
|
|
|
|
def test_omitted_sandbox_id_is_idempotent(self):
|
|
"""An omitted sandbox_id represents uninitialized sandbox state."""
|
|
existing = {}
|
|
new = {}
|
|
assert merge_sandbox(existing, new) == existing
|
|
|
|
def test_conflicting_sandbox_ids_raise(self):
|
|
existing = {"sandbox_id": "sandbox-1"}
|
|
new = {"sandbox_id": "sandbox-2"}
|
|
with pytest.raises(ValueError, match="Conflicting sandbox state updates"):
|
|
merge_sandbox(existing, new)
|
|
|
|
|
|
class TestMergeTodos:
|
|
"""Reducer for ThreadState.todos - keeps last non-None value."""
|
|
|
|
def test_new_value_overrides_existing(self):
|
|
existing = [{"id": 1, "text": "old", "done": False}]
|
|
new = [{"id": 1, "text": "old", "done": True}]
|
|
assert merge_todos(existing, new) == new
|
|
|
|
def test_none_new_preserves_existing(self):
|
|
"""THE KEY FIX for #3123: a node that doesn't touch todos must NOT
|
|
wipe them out by returning an implicit None."""
|
|
existing = [{"id": 1, "text": "task", "done": False}]
|
|
assert merge_todos(existing, None) == existing
|
|
|
|
def test_none_existing_accepts_new(self):
|
|
new = [{"id": 1, "text": "first todo"}]
|
|
assert merge_todos(None, new) == new
|
|
|
|
def test_both_none_returns_none(self):
|
|
assert merge_todos(None, None) is None
|
|
|
|
def test_empty_list_is_explicit_clear(self):
|
|
"""An explicit empty list means 'user cleared all todos' and must
|
|
win over the previous list."""
|
|
existing = [{"id": 1, "text": "task"}]
|
|
assert merge_todos(existing, []) == []
|
|
|
|
|
|
class TestMergeGoal:
|
|
"""Reducer for ThreadState.goal - preserves active goal on untouched nodes."""
|
|
|
|
def test_none_new_preserves_existing(self):
|
|
existing = {"objective": "ship the feature", "status": "active"}
|
|
assert merge_goal(existing, None) == existing
|
|
|
|
def test_none_existing_accepts_new(self):
|
|
new = {"objective": "ship the feature", "status": "active"}
|
|
assert merge_goal(None, new) == new
|
|
|
|
def test_new_value_overrides_existing(self):
|
|
existing = {"objective": "old", "status": "active"}
|
|
new = {"objective": "new", "status": "active"}
|
|
assert merge_goal(existing, new) == new
|
|
|
|
|
|
class TestMergeArtifacts:
|
|
"""Sanity check for the existing artifacts reducer."""
|
|
|
|
def test_dedupes_and_preserves_order(self):
|
|
assert merge_artifacts(["a", "b"], ["b", "c"]) == ["a", "b", "c"]
|
|
|
|
def test_none_new_preserves_existing(self):
|
|
assert merge_artifacts(["a"], None) == ["a"]
|
|
|
|
def test_none_existing_accepts_new(self):
|
|
assert merge_artifacts(None, ["a"]) == ["a"]
|
|
|
|
|
|
class TestMergeViewedImages:
|
|
"""Sanity check for the existing viewed_images reducer."""
|
|
|
|
def test_merges_dicts(self):
|
|
existing = {"k1": {"base64": "x", "mime_type": "image/png"}}
|
|
new = {"k2": {"base64": "y", "mime_type": "image/jpeg"}}
|
|
merged = merge_viewed_images(existing, new)
|
|
assert set(merged.keys()) == {"k1", "k2"}
|
|
|
|
def test_empty_dict_clears(self):
|
|
existing = {"k1": {"base64": "x", "mime_type": "image/png"}}
|
|
assert merge_viewed_images(existing, {}) == {}
|
|
|
|
|
|
class TestMergeDelegations:
|
|
"""Reducer for completed subagent/task delegation records."""
|
|
|
|
def test_terminal_statuses_derived_from_status_contract(self):
|
|
assert TERMINAL_STATUSES == frozenset(SUBAGENT_STATUS_VALUES)
|
|
assert "in_progress" not in TERMINAL_STATUSES
|
|
|
|
def test_none_new_preserves_existing(self):
|
|
existing = [{"id": "a", "status": "completed"}]
|
|
assert merge_delegations(existing, None) == existing
|
|
|
|
def test_none_existing_returns_new(self):
|
|
new = [{"id": "a", "status": "completed"}]
|
|
assert merge_delegations(None, new) == new
|
|
|
|
def test_append_new_id_preserves_order(self):
|
|
existing = [{"id": "a", "status": "completed"}]
|
|
new = [{"id": "b", "status": "completed"}]
|
|
out = merge_delegations(existing, new)
|
|
assert [entry["id"] for entry in out] == ["a", "b"]
|
|
|
|
def test_same_id_latest_wins(self):
|
|
existing = [{"id": "a", "status": "running"}]
|
|
new = [{"id": "a", "status": "completed"}]
|
|
out = merge_delegations(existing, new)
|
|
assert out == [{"id": "a", "status": "completed"}]
|
|
assert len(out) == 1
|
|
|
|
def test_same_id_terminal_status_is_not_downgraded(self):
|
|
existing = [{"id": "a", "status": "completed"}]
|
|
new = [{"id": "a", "status": "in_progress"}]
|
|
out = merge_delegations(existing, new)
|
|
assert out == [{"id": "a", "status": "completed"}]
|
|
|
|
def test_same_id_preserves_original_created_at(self):
|
|
existing = [{"id": "a", "status": "completed", "created_at": "first"}]
|
|
new = [{"id": "a", "status": "completed", "created_at": "second", "result_sha256": "x"}]
|
|
|
|
out = merge_delegations(existing, new)
|
|
|
|
assert out == [{"id": "a", "status": "completed", "created_at": "first", "result_sha256": "x"}]
|
|
|
|
def test_over_cap_keeps_most_recent_entries(self):
|
|
cap = getattr(thread_state_module, "_DELEGATION_LEDGER_MAX_ENTRIES", None)
|
|
assert isinstance(cap, int)
|
|
existing = [{"id": f"call_{i}", "status": "completed"} for i in range(cap)]
|
|
new = [{"id": "call_new", "status": "completed"}]
|
|
|
|
out = merge_delegations(existing, new)
|
|
|
|
assert len(out) == cap
|
|
assert out[0]["id"] == "call_1"
|
|
assert out[-1]["id"] == "call_new"
|
|
|
|
|
|
def test_skill_entry_is_a_reference_not_content():
|
|
assert "description" in SkillEntry.__annotations__
|
|
assert "content" not in SkillEntry.__annotations__
|
|
|
|
|
|
def _skill(path: str, description: str = "desc", loaded_at: int = 0) -> "SkillEntry":
|
|
name = path.rstrip("/").rsplit("/", 2)[-2] if path.endswith("SKILL.md") else path.rstrip("/").rsplit("/", 1)[-1]
|
|
return {"name": name, "path": path, "description": description, "loaded_at": loaded_at}
|
|
|
|
|
|
class TestMergeSkillContext:
|
|
def test_new_none_preserves_existing(self):
|
|
existing = [_skill("/mnt/skills/a/SKILL.md")]
|
|
assert merge_skill_context(existing, None) == existing
|
|
|
|
def test_new_none_normalizes_legacy_existing_and_drops_content(self):
|
|
existing = [
|
|
{
|
|
"name": "legacy",
|
|
"path": "/mnt/skills/public/legacy/SKILL.md",
|
|
"content": "VERBATIM_SKILL_BODY",
|
|
"loaded_at": 3,
|
|
}
|
|
]
|
|
|
|
out = merge_skill_context(existing, None)
|
|
|
|
assert out == [
|
|
{
|
|
"name": "legacy",
|
|
"path": "/mnt/skills/public/legacy/SKILL.md",
|
|
"description": "",
|
|
"loaded_at": 3,
|
|
}
|
|
]
|
|
assert "content" not in out[0]
|
|
assert "VERBATIM_SKILL_BODY" not in repr(out)
|
|
|
|
def test_existing_none_returns_new(self):
|
|
new = [_skill("/mnt/skills/a/SKILL.md")]
|
|
assert merge_skill_context(None, new) == new
|
|
|
|
def test_merging_new_path_normalizes_legacy_existing_and_drops_content(self):
|
|
existing = [
|
|
{
|
|
"name": "legacy",
|
|
"path": "/mnt/skills/public/legacy/SKILL.md",
|
|
"content": "VERBATIM_SKILL_BODY",
|
|
"loaded_at": 3,
|
|
}
|
|
]
|
|
new = [_skill("/mnt/skills/public/new/SKILL.md")]
|
|
|
|
out = merge_skill_context(existing, new)
|
|
|
|
assert [entry["path"] for entry in out] == [
|
|
"/mnt/skills/public/legacy/SKILL.md",
|
|
"/mnt/skills/public/new/SKILL.md",
|
|
]
|
|
assert out[0]["description"] == ""
|
|
assert "content" not in out[0]
|
|
assert "VERBATIM_SKILL_BODY" not in repr(out)
|
|
|
|
def test_appends_distinct_paths_in_first_seen_order(self):
|
|
existing = [_skill("/mnt/skills/a/SKILL.md")]
|
|
new = [_skill("/mnt/skills/b/SKILL.md")]
|
|
out = merge_skill_context(existing, new)
|
|
assert [e["path"] for e in out] == ["/mnt/skills/a/SKILL.md", "/mnt/skills/b/SKILL.md"]
|
|
|
|
def test_same_path_later_overwrites_in_place(self):
|
|
existing = [_skill("/mnt/skills/public/a/SKILL.md", description="old", loaded_at=1)]
|
|
new = [_skill("/mnt/skills/public/a/SKILL.md", description="new", loaded_at=9)]
|
|
out = merge_skill_context(existing, new)
|
|
assert len(out) == 1
|
|
assert out[0]["description"] == "new"
|
|
assert out[0]["loaded_at"] == 9
|
|
|
|
def test_over_cap_evicts_oldest_first_seen(self):
|
|
existing = [_skill(f"/mnt/skills/s{i}/SKILL.md") for i in range(_SKILL_CONTEXT_MAX_ENTRIES)]
|
|
new = [_skill("/mnt/skills/newest/SKILL.md")]
|
|
out = merge_skill_context(existing, new)
|
|
assert len(out) == _SKILL_CONTEXT_MAX_ENTRIES
|
|
assert out[0]["path"] == "/mnt/skills/s1/SKILL.md"
|
|
assert out[-1]["path"] == "/mnt/skills/newest/SKILL.md"
|
|
|
|
def test_reloaded_skill_refreshes_recency_before_cap_eviction(self):
|
|
existing = [_skill(f"/mnt/skills/s{i}/SKILL.md") for i in range(_SKILL_CONTEXT_MAX_ENTRIES)]
|
|
new = [
|
|
_skill("/mnt/skills/s0/SKILL.md", description="refreshed"),
|
|
_skill("/mnt/skills/newest/SKILL.md"),
|
|
]
|
|
|
|
out = merge_skill_context(existing, new)
|
|
|
|
assert len(out) == _SKILL_CONTEXT_MAX_ENTRIES
|
|
paths = [entry["path"] for entry in out]
|
|
assert "/mnt/skills/s0/SKILL.md" in paths
|
|
assert "/mnt/skills/s1/SKILL.md" not in paths
|
|
assert paths[-2:] == ["/mnt/skills/s0/SKILL.md", "/mnt/skills/newest/SKILL.md"]
|
|
assert out[-2]["description"] == "refreshed"
|
|
|
|
def test_description_is_capped_when_normalizing_legacy_entries(self):
|
|
existing = [_skill("/mnt/skills/public/huge/SKILL.md", description="x" * 2000)]
|
|
|
|
out = merge_skill_context(existing, None)
|
|
|
|
assert len(out[0]["description"]) <= 500
|
|
|
|
|
|
class TestThreadStateAnnotations:
|
|
"""Regression guards: ensure reducer wiring on ThreadState fields.
|
|
|
|
These tests protect against silent regressions where a field's
|
|
``Annotated[..., reducer]`` is reverted to a plain type, which would
|
|
re-introduce bugs even when the reducer functions themselves remain
|
|
correct.
|
|
"""
|
|
|
|
def test_todos_field_is_wired_to_merge_todos(self):
|
|
"""ThreadState.todos must use merge_todos.
|
|
|
|
Without this Annotated binding, LangGraph falls back to last-value-wins
|
|
behavior, and partial state updates that omit todos will silently clear
|
|
previously streamed values.
|
|
"""
|
|
hints = get_type_hints(ThreadState, include_extras=True)
|
|
todos_hint = hints["todos"]
|
|
assert hasattr(todos_hint, "__metadata__"), "ThreadState.todos must be Annotated with a reducer"
|
|
assert merge_todos in todos_hint.__metadata__, "ThreadState.todos must be wired to merge_todos reducer (see #3123)"
|
|
|
|
def test_goal_field_is_wired_to_merge_goal(self):
|
|
"""ThreadState.goal must preserve active goals across partial writes."""
|
|
hints = get_type_hints(ThreadState, include_extras=True)
|
|
goal_hint = hints["goal"]
|
|
assert hasattr(goal_hint, "__metadata__"), "ThreadState.goal must be Annotated with a reducer"
|
|
assert merge_goal in goal_hint.__metadata__, "ThreadState.goal must be wired to merge_goal reducer"
|
|
|
|
def test_artifacts_field_is_wired_to_merge_artifacts(self):
|
|
"""Sanity check that existing reducer wiring is preserved."""
|
|
hints = get_type_hints(ThreadState, include_extras=True)
|
|
assert merge_artifacts in hints["artifacts"].__metadata__
|
|
|
|
def test_sandbox_field_is_wired_to_merge_sandbox(self):
|
|
"""ThreadState.sandbox must merge idempotent lazy-init updates.
|
|
|
|
Without this Annotated binding, concurrent sandbox tools that all
|
|
persist the same lazily acquired sandbox_id can trigger LangGraph's
|
|
INVALID_CONCURRENT_GRAPH_UPDATE error.
|
|
"""
|
|
hints = get_type_hints(ThreadState, include_extras=True)
|
|
assert merge_sandbox in hints["sandbox"].__metadata__
|
|
|
|
def test_delegations_field_is_wired_to_merge_delegations(self):
|
|
"""ThreadState.delegations must merge task records by id."""
|
|
hints = get_type_hints(ThreadState, include_extras=True)
|
|
assert merge_delegations in hints["delegations"].__metadata__
|
|
|
|
def test_summary_text_field_exists(self):
|
|
"""ThreadState.summary_text stores prose summary outside messages."""
|
|
hints = get_type_hints(ThreadState, include_extras=True)
|
|
assert "summary_text" in hints
|
|
|
|
def test_skill_context_field_is_wired_to_merge_skill_context(self):
|
|
hints = get_type_hints(ThreadState, include_extras=True)
|
|
assert merge_skill_context in hints["skill_context"].__metadata__
|