mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-09-19 11:06:18 +00:00
* feat(projects): Projects MVP Phase 2 — instructions, document shelf, promotion, trash Implements docs/superpowers/specs/2026-09-12-projects-mvp-phase2-design.md (issue #5160, tracker #5129) in the slice order of the spec's §16. Slices: - A: ProjectsConfig + write-time 422 UTF-8 byte cap; PROJECT_CONTEXT_KEY admission pinning (both server-owned sets + worker hoist); latest-only request-scoped <project> block via DynamicContextMiddleware wrap_model_call/awrap_model_call (idempotent reassembly, reserved ID prefix + marker + provenance, never persisted); journal audit fingerprints; Instructions tab. - B: ProjectDocumentRow + migration 0023; ProjectDocumentRepository with locked check-and-set; hash-qualified immutable shelf storage with Paths helpers; upload/list/content/delete-to-trash routes; project delete trashes the shelf in-transaction; request-scoped bounded <documents> index with honest count/shown + actionable overflow note; list_project_documents/read_project_document tools registered only on pinned runs; PAT allowlist + drift guards; blocking-IO anchors. - C: shared thread-upload ingestion service (uploads router refactored to parity); POST from-thread with provenance; attach-to-thread with lock-staged copy (archived source allowed); read-only thread-files view with per-group truncation reporting. - D: restore (restored/merged/not_found/no_target/content_missing; no file moves), purge (continuous row lock across unlink/delete/commit, retryable on FS errors), retention sweep (lazy + startup, 24h orphan guard, row-side reconciliation never deletes). - E: Documents tab (shelf + conversation-files browser, provenance, archived banner, content-missing rows), /workspace/trash route, sidebar entry, composer attach handoff, i18n (en-US/zh-CN), e2e mocks + specs. Review hardening folded in (10 rounds, all with tests): - force active shelf content (HTML/XML family) to download; nosniff on artifact + content responses; unified unsandboxed-iframe PDF preview (fixes the pre-existing Chromium sandbox blank in the artifact viewer) - scope document trash to the URL project under the document lock - atomic no-overwrite filename reservation for ALL ingestion (seeded claims + os.link commit with suffix retry; same-name re-upload now unique-names instead of replacing); hidden staging only, no visible placeholders; lease cleanup on setup failure - serialize conversion under the document lock with post-lock active revalidation; drain locked filesystem work on cancellation; preserve bytes when an insert's commit state is uncertain (including trashed rows) - original-integrity checks before serving text or cached conversions; content_missing surfaced in list responses (UI reads the flag, no 409-probe); downloads always serve original bytes - bounded streaming document reads with cached char counts; shelf limits declared in middleware release identity - thread-root confinement for from-thread sources; config fallback rejects fractional/infinite values; composer counts staged attachments; pending attachments persist until submission or removal; in-flight instruction/rename edits survive save refetches; shelf and trash pagination; conversation-file and thread-files pages stay subscribed to refetches Docs: README/README_zh, backend API.md/ARCHITECTURE.md, AGENTS.md contracts, config.example.yaml projects block. Review follow-ups (head b4807477 → this revision): - The trash retention sweep is split so repeated lazy triggers stay bounded: the indexed expiry purge still runs on every trigger (GET /api/trash/documents, POST /api/trash/purge) while the O(all rows + all files) reconciliation is throttled to one run per user per 15 minutes (process-local, per-user window). The startup sweep now runs as a background task instead of blocking gateway readiness, and shutdown awaits it (bounded). - The export scrub (stripInternalMarkers) is fence- and indentation-aware like the render path, so a pasted, fenced <project>/<documents> snippet survives markdown export while real injected blocks (never fenced) are still removed. Fence regexes moved to a dependency-free leaf module to avoid the messages↔streamdown import cycle. - The artifact viewer's PDF iframe no longer carries an added title attribute (the upstream e2e contract locates it via :not([title])), and the upstream artifact-preview spec now pins the new contract: PDFs render unsandboxed, images keep sandbox="". * fix(projects): round-2 review — cancel an overrun trash sweep, restore the PDF frame title - Shutdown cancelled only the shield around the background startup sweep, so an all-users reconciliation that outlived the 5s budget kept walking rows and files while the document repo and DB engine were disposed underneath it. The wait now lives in `_shutdown_startup_trash_sweep`, which cancels the task and drains it before worker exit: the shield keeps the wait bounded, the cancel makes it final (CancelledError lands at the sweep's next await, and `_run_startup_trash_sweep` only catches `Exception`, so nothing swallows it). - The browser-preview iframe lost `title={getFileName(filepath)}` in the previous fix round, leaving the PDF frame without an accessible name while its siblings keep theirs. Restore it (WCAG frame titles), assert it in the DOM test, and anchor the e2e on `iframe[title="report.pdf"]` instead of `iframe:not([title])`. * fix(projects): round-3 review — report the sweep's late finish, not a phantom cancel `Task.cancel()` returns False when the sweep already finished inside the window between the deadline firing and the cancel, so the shutdown log claimed a cancellation that never happened. Branch on that outcome: the warning stays for a real cancel, a late finish is logged at info, and both paths still reap the task before worker exit. * fix(projects): round-4 review — make Empty trash delete what it confirms `POST /api/trash/purge` only ran the retention sweep, and the sweep's candidate selection is age-gated, so a freshly trashed document survived "Empty trash" even though the confirmation promises that every listed document is permanently deleted. With one trashed row the route answered `{"purged": 0}` and left it in place; `GET /api/trash/documents` sweeps expired rows before listing, so the visible rows were normally ineligible for the action by construction. Empty trash now drives `purge_all_trashed`: the caller's trashed rows (`list_all_trashed`, no age filter) each go through the same guarded, row-locked `purge` as the single-document delete — bytes first, then the row, in one transaction — so a row restored mid-flight is skipped instead of force-deleted, and an unlink failure rolls that row back and answers 500 with a retryable message. Retention expiry stays where it was: the sweep's `purge_candidates` is now the only age-gated selection, and the lazy retention sweep still runs on the listing and at startup. Tests: the router suite replaces the retention-gated expectation with the reviewer's repro (fresh row purged, bytes unlinked, shelf and other users' trash untouched, a failing unlink stays retryable and 500); a blocking-I/O anchor drives the new entry point through the offload; the mocked e2e covers the action end to end; a new real-backend spec performs it against the real gateway and re-reads `GET /api/trash/documents`. README, API, ARCHITECTURE and the phase-2 design docs (en+zh) state the age-independent contract.
807 lines
34 KiB
Python
807 lines
34 KiB
Python
"""What the agent was actually assembled from, captured at build time.
|
|
|
|
Everything here is knowable only inside the factory: the resolved model after
|
|
runtime overrides, the rendered prompt, the tool list after authorization
|
|
filtering, the composed middleware stack. None of it survives to any later
|
|
observation point.
|
|
"""
|
|
|
|
from pathlib import Path
|
|
|
|
from deerflow_extension_api import AgentAssemblyDescriptor, MiddlewareDescriptor, ToolDescriptor
|
|
|
|
|
|
def test_fingerprint_is_stable_for_identical_assemblies():
|
|
def make():
|
|
return AgentAssemblyDescriptor(
|
|
namespace="lead",
|
|
agent_name="lead-agent",
|
|
requested_model=None,
|
|
effective_model="gpt-x",
|
|
model_parameters={"temperature": 0},
|
|
thinking_enabled=False,
|
|
reasoning_effort=None,
|
|
base_prompt_hash="abc",
|
|
tools=(ToolDescriptor(name="bash", description_hash="d", schema_hash="s", source="builtin"),),
|
|
middlewares=(MiddlewareDescriptor(name="M", module="m", policy_parameters={"limit": 1}),),
|
|
deferred_tool_names=(),
|
|
enabled_skills=(),
|
|
effective_policies={"recursion_limit": 100},
|
|
)
|
|
|
|
assert make().fingerprint == make().fingerprint
|
|
|
|
|
|
def test_fingerprint_changes_when_a_middleware_policy_changes():
|
|
from dataclasses import replace
|
|
|
|
base = AgentAssemblyDescriptor(
|
|
namespace="lead",
|
|
agent_name="lead-agent",
|
|
requested_model=None,
|
|
effective_model="gpt-x",
|
|
model_parameters={},
|
|
thinking_enabled=False,
|
|
reasoning_effort=None,
|
|
base_prompt_hash="abc",
|
|
tools=(),
|
|
middlewares=(MiddlewareDescriptor(name="M", module="m", policy_parameters={"limit": 1}),),
|
|
deferred_tool_names=(),
|
|
enabled_skills=(),
|
|
effective_policies={},
|
|
)
|
|
changed = replace(base, middlewares=(MiddlewareDescriptor(name="M", module="m", policy_parameters={"limit": 2}),))
|
|
assert base.fingerprint != changed.fingerprint
|
|
|
|
|
|
def test_fingerprint_ignores_tool_ordering():
|
|
"""Tool order is an assembly detail, not a behavioural difference."""
|
|
from dataclasses import replace
|
|
|
|
a = ToolDescriptor(name="a", description_hash="1", schema_hash="1", source="builtin")
|
|
b = ToolDescriptor(name="b", description_hash="2", schema_hash="2", source="builtin")
|
|
base = AgentAssemblyDescriptor(
|
|
namespace="lead",
|
|
agent_name="lead-agent",
|
|
requested_model=None,
|
|
effective_model="gpt-x",
|
|
model_parameters={},
|
|
thinking_enabled=False,
|
|
reasoning_effort=None,
|
|
base_prompt_hash="abc",
|
|
tools=(a, b),
|
|
middlewares=(),
|
|
deferred_tool_names=(),
|
|
enabled_skills=(),
|
|
effective_policies={},
|
|
)
|
|
assert base.fingerprint == replace(base, tools=(b, a)).fingerprint
|
|
|
|
|
|
def test_middleware_order_does_affect_the_fingerprint():
|
|
"""Stack order determines what wraps what, so it is behavioural."""
|
|
from dataclasses import replace
|
|
|
|
m1 = MiddlewareDescriptor(name="A", module="m", policy_parameters={})
|
|
m2 = MiddlewareDescriptor(name="B", module="m", policy_parameters={})
|
|
base = AgentAssemblyDescriptor(
|
|
namespace="lead",
|
|
agent_name="lead-agent",
|
|
requested_model=None,
|
|
effective_model="gpt-x",
|
|
model_parameters={},
|
|
thinking_enabled=False,
|
|
reasoning_effort=None,
|
|
base_prompt_hash="abc",
|
|
tools=(),
|
|
middlewares=(m1, m2),
|
|
deferred_tool_names=(),
|
|
enabled_skills=(),
|
|
effective_policies={},
|
|
)
|
|
assert base.fingerprint != replace(base, middlewares=(m2, m1)).fingerprint
|
|
|
|
|
|
class TestShelfIndexReleasePolicy:
|
|
"""The shelf rendering caps change the model-visible ``<documents>`` block,
|
|
so DynamicContextMiddleware declares both effective limits and each change
|
|
moves the assembly fingerprint."""
|
|
|
|
@staticmethod
|
|
def _params(**projects_kwargs):
|
|
from deerflow.agents.middlewares.dynamic_context_middleware import DynamicContextMiddleware
|
|
from deerflow.config.app_config import AppConfig
|
|
from deerflow.config.model_config import ModelConfig
|
|
from deerflow.config.projects_config import ProjectsConfig
|
|
from deerflow.config.sandbox_config import SandboxConfig
|
|
|
|
config = AppConfig(
|
|
models=[ModelConfig(name="m", display_name="m", description=None, use="langchain_openai:ChatOpenAI", model="m", supports_thinking=False, supports_vision=False)],
|
|
projects=ProjectsConfig(**projects_kwargs),
|
|
sandbox=SandboxConfig(use="deerflow.sandbox.local:LocalSandboxProvider"),
|
|
)
|
|
return DynamicContextMiddleware(app_config=config).release_policy_parameters()
|
|
|
|
@staticmethod
|
|
def _descriptor_with(policy):
|
|
return AgentAssemblyDescriptor(
|
|
namespace="lead",
|
|
agent_name="lead-agent",
|
|
requested_model=None,
|
|
effective_model="gpt-x",
|
|
model_parameters={},
|
|
thinking_enabled=False,
|
|
reasoning_effort=None,
|
|
base_prompt_hash="abc",
|
|
tools=(),
|
|
middlewares=(MiddlewareDescriptor(name="DynamicContextMiddleware", module="m", policy_parameters=dict(policy)),),
|
|
deferred_tool_names=(),
|
|
enabled_skills=(),
|
|
effective_policies={},
|
|
)
|
|
|
|
def test_both_effective_shelf_limits_are_declared(self):
|
|
from deerflow.config.projects_config import ProjectsConfig
|
|
|
|
params = self._params()
|
|
assert params["shelf_index_max_entries"] == ProjectsConfig().shelf_index_max_entries
|
|
assert params["shelf_index_max_bytes"] == ProjectsConfig().shelf_index_max_bytes
|
|
|
|
def test_changing_either_shelf_limit_moves_the_fingerprint(self):
|
|
base = self._params()
|
|
by_entries = self._params(shelf_index_max_entries=99)
|
|
by_bytes = self._params(shelf_index_max_bytes=8192)
|
|
# Each knob moves independently.
|
|
assert by_entries["shelf_index_max_entries"] == 99
|
|
assert by_entries["shelf_index_max_bytes"] == base["shelf_index_max_bytes"]
|
|
assert by_bytes["shelf_index_max_bytes"] == 8192
|
|
assert by_bytes["shelf_index_max_entries"] == base["shelf_index_max_entries"]
|
|
base_descriptor = self._descriptor_with(base)
|
|
assert base_descriptor.fingerprint != self._descriptor_with(by_entries).fingerprint
|
|
assert base_descriptor.fingerprint != self._descriptor_with(by_bytes).fingerprint
|
|
|
|
|
|
class TestLeadAgentAssembly:
|
|
def test_make_lead_agent_still_returns_a_bare_graph(self):
|
|
"""langgraph.json declares this factory; its ABI must not move."""
|
|
import inspect
|
|
|
|
from deerflow.agents.lead_agent.agent import make_lead_agent
|
|
|
|
signature = inspect.signature(make_lead_agent)
|
|
assert list(signature.parameters) == ["config"]
|
|
|
|
@staticmethod
|
|
def _isolate_from_the_ambient_config(monkeypatch):
|
|
"""Assemble against a config this test owns, not the machine's.
|
|
|
|
``assemble_lead_agent`` falls back to ``get_app_config()``, so without
|
|
this the test passes only where a developer happens to have a usable
|
|
``config.yaml``. CI checks out ``config.example.yaml``, whose ``models:``
|
|
entries are all commented out, and assembly raises "No chat models are
|
|
configured" before it can produce anything to assert on.
|
|
"""
|
|
from deerflow.agents.lead_agent import agent as lead_agent_module
|
|
from deerflow.config.app_config import AppConfig
|
|
from deerflow.config.model_config import ModelConfig
|
|
from deerflow.config.sandbox_config import SandboxConfig
|
|
from deerflow.config.subagents_config import CustomSubagentConfig, SubagentsAppConfig
|
|
|
|
app_config = AppConfig(
|
|
models=[
|
|
ModelConfig(
|
|
name="assembly-test-model",
|
|
display_name="assembly-test-model",
|
|
description=None,
|
|
use="langchain_openai:ChatOpenAI",
|
|
model="assembly-test-model",
|
|
supports_thinking=False,
|
|
supports_vision=False,
|
|
)
|
|
],
|
|
subagents=SubagentsAppConfig(custom_agents={"researcher": CustomSubagentConfig(description="research", system_prompt="research")}),
|
|
sandbox=SandboxConfig(use="deerflow.sandbox.local:LocalSandboxProvider"),
|
|
)
|
|
monkeypatch.setattr(lead_agent_module, "get_app_config", lambda: app_config)
|
|
monkeypatch.setattr(
|
|
lead_agent_module,
|
|
"create_chat_model",
|
|
lambda **kwargs: object(),
|
|
)
|
|
monkeypatch.setattr(lead_agent_module, "create_agent", lambda **kwargs: kwargs)
|
|
return app_config
|
|
|
|
@staticmethod
|
|
def _extensions_with_an_agent_assembly_observer(observer=None):
|
|
"""A minimal LoadedExtensions carrying one agent-assembly observer.
|
|
|
|
Building the descriptor is real work (hashing every tool's description
|
|
and schema, probing every middleware), so it only happens when an
|
|
observer is actually registered to receive it.
|
|
"""
|
|
from deerflow.extensions.registry import ExtensionRegistry
|
|
|
|
class _NoOpObserver:
|
|
def on_agent_assembled(self, app_store, descriptor):
|
|
return None
|
|
|
|
registry = ExtensionRegistry()
|
|
with registry.attributed_to("test"):
|
|
registry.agent_assembly_observer(observer or _NoOpObserver())
|
|
return registry.build()
|
|
|
|
def test_assemble_returns_both_the_graph_and_a_descriptor(self, monkeypatch):
|
|
from deerflow.agents.lead_agent.agent import LeadAgentAssembly, assemble_lead_agent
|
|
from deerflow.extensions import bind_agent_build_extensions
|
|
|
|
self._isolate_from_the_ambient_config(monkeypatch)
|
|
with bind_agent_build_extensions(self._extensions_with_an_agent_assembly_observer()):
|
|
assembly = assemble_lead_agent({"configurable": {"thread_id": "t-1"}})
|
|
assert isinstance(assembly, LeadAgentAssembly)
|
|
assert assembly.graph is not None
|
|
assert assembly.descriptor.effective_model
|
|
assert assembly.descriptor.fingerprint
|
|
|
|
def test_descriptor_hashes_the_same_scoped_prompt_passed_to_the_graph(self, monkeypatch):
|
|
from deerflow_extension_api import canonical_hash
|
|
|
|
from deerflow.agents.lead_agent import agent as lead_agent_module
|
|
from deerflow.agents.lead_agent.agent import assemble_lead_agent
|
|
from deerflow.config.agents_config import AgentConfig
|
|
from deerflow.extensions import bind_agent_build_extensions
|
|
|
|
self._isolate_from_the_ambient_config(monkeypatch)
|
|
agent_config = AgentConfig(name="custom", allowed_subagents=["general-purpose"])
|
|
monkeypatch.setattr(lead_agent_module, "load_agent_config", lambda name, *, user_id=None: agent_config)
|
|
|
|
prompt_calls = []
|
|
|
|
def render_prompt(**kwargs):
|
|
prompt_calls.append(kwargs)
|
|
return f"allowed_subagents={kwargs['allowed_subagents']}"
|
|
|
|
monkeypatch.setattr(lead_agent_module, "apply_prompt_template", render_prompt)
|
|
with bind_agent_build_extensions(self._extensions_with_an_agent_assembly_observer()):
|
|
assembly = assemble_lead_agent(
|
|
{
|
|
"configurable": {
|
|
"thread_id": "t-scoped-prompt",
|
|
"agent_name": "custom",
|
|
"subagent_enabled": True,
|
|
}
|
|
}
|
|
)
|
|
|
|
assert len(prompt_calls) == 1
|
|
assert prompt_calls[0]["allowed_subagents"] == ["general-purpose"]
|
|
assert assembly.graph["system_prompt"] == "allowed_subagents=['general-purpose']"
|
|
assert assembly.descriptor.base_prompt_hash == canonical_hash(assembly.graph["system_prompt"])
|
|
|
|
def test_descriptor_subagent_policy_respects_custom_agent_allowed_subagents(self, monkeypatch):
|
|
"""Fixes #5205: custom agent assembly descriptor must restrict its
|
|
subagents policy allowlist and runtime limits to allowed_subagents."""
|
|
from deerflow.agents.lead_agent import agent as lead_agent_module
|
|
from deerflow.agents.lead_agent.agent import assemble_lead_agent
|
|
from deerflow.config.agents_config import AgentConfig
|
|
from deerflow.extensions import bind_agent_build_extensions
|
|
|
|
self._isolate_from_the_ambient_config(monkeypatch)
|
|
agent_config = AgentConfig(name="custom", allowed_subagents=["general-purpose"])
|
|
monkeypatch.setattr(lead_agent_module, "load_agent_config", lambda name, *, user_id=None: agent_config)
|
|
|
|
with bind_agent_build_extensions(self._extensions_with_an_agent_assembly_observer()):
|
|
assembly = assemble_lead_agent(
|
|
{
|
|
"configurable": {
|
|
"thread_id": "t-scoped-subagents",
|
|
"agent_name": "custom",
|
|
"subagent_enabled": True,
|
|
}
|
|
}
|
|
)
|
|
|
|
subagent_policy = assembly.descriptor.effective_policies["subagents"]
|
|
assert subagent_policy["enabled"] is True
|
|
assert subagent_policy["type_allowlist"] == ["general-purpose"]
|
|
assert list(subagent_policy["runtime_limits"].keys()) == ["general-purpose"]
|
|
|
|
def test_observers_receive_the_descriptor(self, monkeypatch):
|
|
from deerflow.agents.lead_agent.agent import assemble_lead_agent
|
|
from deerflow.extensions import bind_agent_build_extensions
|
|
|
|
seen = []
|
|
|
|
class Observer:
|
|
def on_agent_assembled(self, app_store, descriptor):
|
|
seen.append(descriptor)
|
|
|
|
monkeypatch.setattr(
|
|
"deerflow.extensions.notify.notify_agent_assembled",
|
|
lambda descriptor, extensions=None: Observer().on_agent_assembled(None, descriptor),
|
|
)
|
|
self._isolate_from_the_ambient_config(monkeypatch)
|
|
with bind_agent_build_extensions(self._extensions_with_an_agent_assembly_observer()):
|
|
assemble_lead_agent({"configurable": {"thread_id": "t-2"}})
|
|
assert len(seen) == 1
|
|
|
|
def test_no_descriptor_is_built_without_a_registered_observer(self, monkeypatch):
|
|
"""The zero-observer fast path must skip the expensive build entirely,
|
|
not just skip notifying — mirroring notify_agent_assembled's own
|
|
zero-observer short-circuit."""
|
|
from deerflow.agents.lead_agent.agent import assemble_lead_agent
|
|
|
|
def _fail(*args, **kwargs):
|
|
raise AssertionError("build_assembly_descriptor must not run without an observer")
|
|
|
|
monkeypatch.setattr("deerflow.agents.assembly_descriptor.build_assembly_descriptor", _fail)
|
|
self._isolate_from_the_ambient_config(monkeypatch)
|
|
assembly = assemble_lead_agent({"configurable": {"thread_id": "t-3"}})
|
|
assert assembly.descriptor is None
|
|
|
|
|
|
class TestFactoryConsumersUnwrapTheGraph:
|
|
"""A missed unwrap fails at request time, not at import time."""
|
|
|
|
def test_worker_unwraps_the_assembly(self):
|
|
from deerflow.agents.lead_agent.agent import LeadAgentAssembly
|
|
from deerflow.runtime.runs.worker import _agent_graph
|
|
|
|
graph = object()
|
|
assert _agent_graph(LeadAgentAssembly(graph=graph, descriptor=object())) is graph
|
|
|
|
def test_worker_leaves_a_third_party_bare_graph_alone(self):
|
|
from deerflow.runtime.runs.worker import _agent_graph
|
|
|
|
graph = object()
|
|
assert _agent_graph(graph) is graph
|
|
|
|
|
|
class TestAssemblyObserverHost:
|
|
def test_registration_survives_rollback_of_a_later_install(self):
|
|
from deerflow.extensions.registry import ExtensionRegistry
|
|
|
|
class Observer:
|
|
def on_agent_assembled(self, app_store, descriptor):
|
|
return None
|
|
|
|
registry = ExtensionRegistry()
|
|
keeper = Observer()
|
|
with registry.attributed_to("keeper"):
|
|
registry.agent_assembly_observer(keeper)
|
|
mark = registry.mark()
|
|
with registry.attributed_to("doomed"):
|
|
registry.agent_assembly_observer(Observer())
|
|
registry.rollback_to(mark)
|
|
|
|
loaded = registry.build()
|
|
assert loaded.agent_assembly_observers == (("keeper", keeper),)
|
|
assert loaded.has_agent_assembly_observers is True
|
|
# The descriptor is app-scoped; it does not create a task store need.
|
|
assert loaded.needs_task_store is False
|
|
|
|
def test_a_broken_observer_does_not_stop_its_successors(self, caplog):
|
|
from deerflow.extensions.notify import notify_agent_assembled
|
|
from deerflow.extensions.registry import ExtensionRegistry
|
|
|
|
seen = []
|
|
|
|
class Broken:
|
|
def on_agent_assembled(self, app_store, descriptor):
|
|
raise RuntimeError("boom")
|
|
|
|
class Working:
|
|
def on_agent_assembled(self, app_store, descriptor):
|
|
seen.append(descriptor)
|
|
|
|
registry = ExtensionRegistry()
|
|
with registry.attributed_to("broken"):
|
|
registry.agent_assembly_observer(Broken())
|
|
with registry.attributed_to("working"):
|
|
registry.agent_assembly_observer(Working())
|
|
loaded = registry.build()
|
|
|
|
notify_agent_assembled("descriptor", loaded)
|
|
|
|
assert seen == ["descriptor"]
|
|
|
|
|
|
class TestBuildIdentityIsOutsideTheFingerprint:
|
|
"""A redeploy that changed nothing must not look like an assembly change."""
|
|
|
|
def _descriptor(self, build):
|
|
return AgentAssemblyDescriptor(
|
|
namespace="lead",
|
|
agent_name="lead-agent",
|
|
requested_model=None,
|
|
effective_model="gpt-x",
|
|
model_parameters={},
|
|
thinking_enabled=False,
|
|
reasoning_effort=None,
|
|
base_prompt_hash="abc",
|
|
tools=(),
|
|
middlewares=(),
|
|
deferred_tool_names=(),
|
|
enabled_skills=(),
|
|
effective_policies={},
|
|
build=build,
|
|
)
|
|
|
|
def test_two_builds_of_the_same_assembly_share_a_fingerprint(self):
|
|
before = self._descriptor({"package_version": "1.0.0", "git_commit": "aaaa", "image_digest": "sha256:aaa"})
|
|
after = self._descriptor({"package_version": "1.0.1", "git_commit": "bbbb", "image_digest": "sha256:bbb"})
|
|
assert before.fingerprint == after.fingerprint
|
|
|
|
def test_the_build_itself_stays_comparable(self):
|
|
"""The coarser question must remain answerable, just separately."""
|
|
before = self._descriptor({"git_commit": "aaaa"})
|
|
after = self._descriptor({"git_commit": "bbbb"})
|
|
assert before.build != after.build
|
|
|
|
def test_the_builder_reports_a_build_without_hashing_it(self):
|
|
from deerflow.agents.assembly_descriptor import build_assembly_descriptor
|
|
|
|
def make():
|
|
return build_assembly_descriptor(
|
|
namespace="deerflow",
|
|
agent_name="lead-agent",
|
|
requested_model=None,
|
|
effective_model="gpt-x",
|
|
model_config=None,
|
|
thinking_enabled=False,
|
|
reasoning_effort=None,
|
|
rendered_base_prompt="prompt",
|
|
tools=[],
|
|
middlewares=[],
|
|
deferred_names=frozenset(),
|
|
enabled_skills=[],
|
|
effective_policies={},
|
|
)
|
|
|
|
descriptor = make()
|
|
assert descriptor.build["package_version"]
|
|
assert "build" not in descriptor.effective_policies
|
|
assert descriptor.fingerprint == make().fingerprint
|
|
|
|
|
|
class TestWrappedExtensionMiddlewaresStayDistinguishable:
|
|
"""Contributed middlewares all share the isolation wrapper's class name."""
|
|
|
|
@staticmethod
|
|
def _wrap(inner, source):
|
|
from deerflow.extensions.isolation import IsolatedMiddleware
|
|
|
|
return IsolatedMiddleware(inner, source, lambda diagnostic: None)
|
|
|
|
@staticmethod
|
|
def _inner(name, *, policy=None):
|
|
from langchain.agents.middleware import AgentMiddleware
|
|
|
|
namespace = {}
|
|
if policy is not None:
|
|
namespace["release_policy_parameters"] = lambda self: dict(policy)
|
|
return type(name, (AgentMiddleware,), namespace)()
|
|
|
|
def test_two_extensions_middlewares_do_not_collapse_into_one_descriptor(self):
|
|
from deerflow.agents.assembly_descriptor import describe_middleware
|
|
|
|
first = describe_middleware(self._wrap(self._inner("AlphaMiddleware"), "ext-a"))
|
|
second = describe_middleware(self._wrap(self._inner("BetaMiddleware"), "ext-b"))
|
|
|
|
assert first.name == "AlphaMiddleware"
|
|
assert second.name == "BetaMiddleware"
|
|
assert first.extension == "ext-a"
|
|
assert second.extension == "ext-b"
|
|
assert first != second
|
|
|
|
def test_a_wrapped_declaration_reaches_the_descriptor(self):
|
|
from deerflow.agents.assembly_descriptor import describe_middleware
|
|
|
|
descriptor = describe_middleware(self._wrap(self._inner("DeclaringMiddleware", policy={"limit": 7}), "ext-a"))
|
|
|
|
assert descriptor.policy_parameters == {"limit": 7}
|
|
assert "probed" not in descriptor.policy_parameters
|
|
|
|
def test_a_policy_change_inside_a_wrapped_middleware_moves_the_fingerprint(self):
|
|
from dataclasses import replace
|
|
|
|
from deerflow.agents.assembly_descriptor import describe_middleware
|
|
|
|
def descriptor_for(limit):
|
|
return AgentAssemblyDescriptor(
|
|
namespace="lead",
|
|
agent_name="lead-agent",
|
|
requested_model=None,
|
|
effective_model="gpt-x",
|
|
model_parameters={},
|
|
thinking_enabled=False,
|
|
reasoning_effort=None,
|
|
base_prompt_hash="abc",
|
|
tools=(),
|
|
middlewares=(describe_middleware(self._wrap(self._inner("DeclaringMiddleware", policy={"limit": limit}), "ext-a")),),
|
|
deferred_tool_names=(),
|
|
enabled_skills=(),
|
|
effective_policies={},
|
|
)
|
|
|
|
assert descriptor_for(1).fingerprint != descriptor_for(2).fingerprint
|
|
|
|
# And the same policy from a different extension is a different agent.
|
|
base = descriptor_for(1)
|
|
other = replace(base, middlewares=(replace(base.middlewares[0], extension="ext-b"),))
|
|
assert base.fingerprint != other.fingerprint
|
|
|
|
def test_an_unwrapped_host_middleware_reports_no_extension(self):
|
|
from deerflow.agents.assembly_descriptor import describe_middleware
|
|
|
|
descriptor = describe_middleware(self._inner("HostMiddleware", policy={"limit": 1}))
|
|
|
|
assert descriptor.extension is None
|
|
assert descriptor.name == "HostMiddleware"
|
|
|
|
|
|
class TestModelParametersProjectEffectiveSettings:
|
|
"""Provider kwargs a user actually sets must move the fingerprint.
|
|
|
|
``ModelConfig`` is ``extra="allow"``, so ``temperature``/``max_tokens``/
|
|
anything else a deployer sets live only as extra fields; a fixed allowlist
|
|
never saw them. And the *effective* per-agent override (issue #4336's
|
|
``model_settings``) must reach the descriptor too, not just the static
|
|
profile.
|
|
"""
|
|
|
|
@staticmethod
|
|
def _build(model_config, *, model_overrides=None):
|
|
from deerflow.agents.assembly_descriptor import build_assembly_descriptor
|
|
|
|
return build_assembly_descriptor(
|
|
namespace="deerflow",
|
|
agent_name="lead-agent",
|
|
requested_model=None,
|
|
effective_model="gpt-x",
|
|
model_config=model_config,
|
|
model_overrides=model_overrides,
|
|
thinking_enabled=False,
|
|
reasoning_effort=None,
|
|
rendered_base_prompt="prompt",
|
|
tools=[],
|
|
middlewares=[],
|
|
deferred_names=frozenset(),
|
|
enabled_skills=[],
|
|
effective_policies={},
|
|
)
|
|
|
|
@staticmethod
|
|
def _model_config(**extra):
|
|
from deerflow.config.model_config import ModelConfig
|
|
|
|
return ModelConfig(
|
|
name="assembly-test-model",
|
|
display_name=None,
|
|
description=None,
|
|
use="langchain_openai:ChatOpenAI",
|
|
model="gpt-x",
|
|
**extra,
|
|
)
|
|
|
|
def test_changing_temperature_changes_the_fingerprint(self):
|
|
cold = self._build(self._model_config(temperature=0.1))
|
|
hot = self._build(self._model_config(temperature=0.9))
|
|
assert cold.fingerprint != hot.fingerprint
|
|
assert cold.model_parameters["temperature"] == 0.1
|
|
|
|
def test_changing_a_per_agent_model_setting_changes_the_fingerprint(self):
|
|
"""The *effective* override, not just the static profile, must count."""
|
|
model_config = self._model_config()
|
|
without_override = self._build(model_config)
|
|
with_override = self._build(model_config, model_overrides={"temperature": 0.7})
|
|
assert without_override.fingerprint != with_override.fingerprint
|
|
assert with_override.model_parameters["temperature"] == 0.7
|
|
|
|
def test_a_none_valued_override_does_not_clobber_the_profile(self):
|
|
model_config = self._model_config(temperature=0.3)
|
|
profile_only = self._build(model_config)
|
|
with_noop_override = self._build(model_config, model_overrides={"temperature": None})
|
|
assert profile_only.fingerprint == with_noop_override.fingerprint
|
|
|
|
def test_api_key_is_never_projected_and_never_moves_the_fingerprint(self):
|
|
quiet = self._build(self._model_config(api_key="sk-aaaaaaaaaaaa"))
|
|
loud = self._build(self._model_config(api_key="sk-bbbbbbbbbbbb"))
|
|
assert "api_key" not in quiet.model_parameters
|
|
assert quiet.fingerprint == loud.fingerprint
|
|
|
|
def test_an_override_named_like_a_credential_is_also_excluded(self):
|
|
model_config = self._model_config()
|
|
descriptor = self._build(model_config, model_overrides={"api_key": "sk-should-not-appear"})
|
|
assert "api_key" not in descriptor.model_parameters
|
|
|
|
|
|
class TestCustomAgentModelSettingsReachTheDescriptor:
|
|
"""End-to-end: a custom agent's ``model_settings`` must move the fingerprint.
|
|
|
|
``agent.py`` computes ``agent_model_overrides`` from ``agent_config.model_settings``
|
|
and passes it into ``create_chat_model``; this checks it also reaches
|
|
``_complete_assembly`` -> ``build_assembly_descriptor`` for the default
|
|
(non-bootstrap) assembly branch. Composes with (rather than subclasses)
|
|
``TestLeadAgentAssembly``'s isolation helpers so this class's own tests are
|
|
the only ones that run under it.
|
|
"""
|
|
|
|
def test_temperature_override_on_a_custom_agent_changes_the_fingerprint(self, monkeypatch):
|
|
from deerflow.agents.lead_agent import agent as lead_agent_module
|
|
from deerflow.agents.lead_agent.agent import assemble_lead_agent
|
|
from deerflow.config.agents_config import AgentConfig, AgentModelSettings
|
|
from deerflow.extensions import bind_agent_build_extensions
|
|
|
|
TestLeadAgentAssembly._isolate_from_the_ambient_config(monkeypatch)
|
|
|
|
def assemble(temperature):
|
|
agent_config = AgentConfig(name="custom", model_settings=AgentModelSettings(temperature=temperature))
|
|
monkeypatch.setattr(lead_agent_module, "load_agent_config", lambda name, user_id=None: agent_config)
|
|
with bind_agent_build_extensions(TestLeadAgentAssembly._extensions_with_an_agent_assembly_observer()):
|
|
return assemble_lead_agent({"configurable": {"thread_id": "t-model-settings", "agent_name": "custom"}})
|
|
|
|
low = assemble(0.1)
|
|
high = assemble(0.9)
|
|
assert low.descriptor.fingerprint != high.descriptor.fingerprint
|
|
assert high.descriptor.model_parameters["temperature"] == 0.9
|
|
|
|
def test_bootstrap_assembly_does_not_invent_model_overrides(self, monkeypatch):
|
|
"""The bootstrap branch has no ``agent_config``, so no overrides exist to project."""
|
|
from deerflow.agents.lead_agent.agent import assemble_lead_agent
|
|
from deerflow.extensions import bind_agent_build_extensions
|
|
|
|
TestLeadAgentAssembly._isolate_from_the_ambient_config(monkeypatch)
|
|
with bind_agent_build_extensions(TestLeadAgentAssembly._extensions_with_an_agent_assembly_observer()):
|
|
assembly = assemble_lead_agent({"configurable": {"thread_id": "t-bootstrap", "is_bootstrap": True}})
|
|
assert "temperature" not in assembly.descriptor.model_parameters
|
|
|
|
|
|
class TestSkillCatalogHashesContent:
|
|
"""Editing SKILL.md changes what ``SkillActivationMiddleware`` injects into
|
|
the turn, so it must change the fingerprint even though name/description/
|
|
allowed-tools are untouched."""
|
|
|
|
@staticmethod
|
|
def _skill(skill_dir: Path, *, required_secrets=(), secrets_autonomous=True):
|
|
from deerflow.skills.types import Skill, SkillCategory
|
|
|
|
skill_file = skill_dir / "SKILL.md"
|
|
return Skill(
|
|
name="my-skill",
|
|
description="A test skill",
|
|
license=None,
|
|
skill_dir=skill_dir,
|
|
skill_file=skill_file,
|
|
relative_path=Path(skill_dir.name),
|
|
category=SkillCategory.CUSTOM,
|
|
required_secrets=required_secrets,
|
|
secrets_autonomous=secrets_autonomous,
|
|
)
|
|
|
|
@staticmethod
|
|
def _build(enabled_skills):
|
|
from deerflow.agents.assembly_descriptor import build_assembly_descriptor
|
|
|
|
return build_assembly_descriptor(
|
|
namespace="deerflow",
|
|
agent_name="lead-agent",
|
|
requested_model=None,
|
|
effective_model="gpt-x",
|
|
model_config=None,
|
|
thinking_enabled=False,
|
|
reasoning_effort=None,
|
|
rendered_base_prompt="prompt",
|
|
tools=[],
|
|
middlewares=[],
|
|
deferred_names=frozenset(),
|
|
enabled_skills=enabled_skills,
|
|
effective_policies={},
|
|
)
|
|
|
|
def test_changing_only_skill_md_content_changes_the_fingerprint(self, tmp_path):
|
|
skill_dir = tmp_path / "my-skill"
|
|
skill_dir.mkdir()
|
|
skill = self._skill(skill_dir)
|
|
|
|
(skill_dir / "SKILL.md").write_text("---\nname: my-skill\n---\nOriginal instructions.\n", encoding="utf-8")
|
|
before = self._build([skill])
|
|
|
|
(skill_dir / "SKILL.md").write_text("---\nname: my-skill\n---\nCompletely different instructions.\n", encoding="utf-8")
|
|
after = self._build([skill])
|
|
|
|
assert before.fingerprint != after.fingerprint
|
|
assert before.enabled_skills == after.enabled_skills # the catalog's visible identity is unchanged
|
|
|
|
def test_required_secrets_flag_changes_the_fingerprint(self):
|
|
from deerflow.skills.types import SecretRequirement
|
|
|
|
no_secrets = self._skill(Path("/nonexistent/skill-a"))
|
|
with_secret = self._skill(Path("/nonexistent/skill-b"), required_secrets=(SecretRequirement(name="API_KEY"),))
|
|
assert self._build([no_secrets]).fingerprint != self._build([with_secret]).fingerprint
|
|
|
|
def test_a_missing_skill_file_is_undescribable_not_fatal(self, tmp_path):
|
|
skill = self._skill(tmp_path / "missing-skill")
|
|
descriptor = self._build([skill])
|
|
assert descriptor.fingerprint
|
|
|
|
|
|
class TestProjectDocumentToolRegistration:
|
|
"""The two shelf tools exist only in project runs (spec §7.3, §10.11).
|
|
|
|
Registration follows the admission-pinned ``PROJECT_CONTEXT_KEY`` and
|
|
nothing else: a run assembled without the key never carries the tools'
|
|
schemas, a run with it always does — even when instructions and shelf
|
|
are both empty. Since the tool list feeds ``build_assembly_descriptor``,
|
|
both variants are pinned here (descriptor and fingerprint).
|
|
"""
|
|
|
|
@staticmethod
|
|
def _assemble(monkeypatch, config):
|
|
from deerflow.agents.lead_agent.agent import assemble_lead_agent
|
|
from deerflow.extensions import bind_agent_build_extensions
|
|
|
|
helpers = TestLeadAgentAssembly
|
|
helpers._isolate_from_the_ambient_config(monkeypatch)
|
|
with bind_agent_build_extensions(helpers._extensions_with_an_agent_assembly_observer()):
|
|
return assemble_lead_agent(config)
|
|
|
|
def test_project_run_registers_both_tools(self, monkeypatch):
|
|
from deerflow.runtime.context_keys import PROJECT_CONTEXT_KEY
|
|
|
|
assembly = self._assemble(
|
|
monkeypatch,
|
|
{
|
|
"configurable": {"thread_id": "t-proj"},
|
|
"context": {PROJECT_CONTEXT_KEY: {"project_id": "p-1", "name": "P", "instructions": "ctx"}},
|
|
},
|
|
)
|
|
tool_names = {getattr(tool, "name", None) for tool in assembly.graph["tools"]}
|
|
assert {"list_project_documents", "read_project_document"} <= tool_names
|
|
descriptor_names = {tool.name for tool in assembly.descriptor.tools}
|
|
assert {"list_project_documents", "read_project_document"} <= descriptor_names
|
|
|
|
def test_non_project_run_registers_neither_tool(self, monkeypatch):
|
|
assembly = self._assemble(monkeypatch, {"configurable": {"thread_id": "t-plain"}})
|
|
tool_names = {getattr(tool, "name", None) for tool in assembly.graph["tools"]}
|
|
assert "list_project_documents" not in tool_names
|
|
assert "read_project_document" not in tool_names
|
|
descriptor_names = {tool.name for tool in assembly.descriptor.tools}
|
|
assert "list_project_documents" not in descriptor_names
|
|
assert "read_project_document" not in descriptor_names
|
|
|
|
def test_both_descriptor_variants_are_distinct_and_stable(self, monkeypatch):
|
|
from deerflow.runtime.context_keys import PROJECT_CONTEXT_KEY
|
|
|
|
with_project = self._assemble(
|
|
monkeypatch,
|
|
{
|
|
"configurable": {"thread_id": "t-proj"},
|
|
"context": {PROJECT_CONTEXT_KEY: {"project_id": "p-1", "name": "P", "instructions": ""}},
|
|
},
|
|
)
|
|
without_project = self._assemble(monkeypatch, {"configurable": {"thread_id": "t-plain"}})
|
|
assert with_project.descriptor.fingerprint != without_project.descriptor.fingerprint
|
|
|
|
again = self._assemble(
|
|
monkeypatch,
|
|
{
|
|
"configurable": {"thread_id": "t-proj"},
|
|
"context": {PROJECT_CONTEXT_KEY: {"project_id": "p-1", "name": "P", "instructions": ""}},
|
|
},
|
|
)
|
|
assert again.descriptor.fingerprint == with_project.descriptor.fingerprint
|
|
|
|
def test_registration_follows_the_key_when_blocks_are_empty(self, monkeypatch):
|
|
"""Empty instructions and an empty shelf still mean a project run."""
|
|
from deerflow.runtime.context_keys import PROJECT_CONTEXT_KEY
|
|
|
|
assembly = self._assemble(
|
|
monkeypatch,
|
|
{
|
|
"configurable": {"thread_id": "t-empty"},
|
|
"context": {PROJECT_CONTEXT_KEY: {"project_id": "p-1", "name": "P", "instructions": "", "shelf": {"total": 0, "entries": []}}},
|
|
},
|
|
)
|
|
tool_names = {getattr(tool, "name", None) for tool in assembly.graph["tools"]}
|
|
assert {"list_project_documents", "read_project_document"} <= tool_names
|