mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-04-27 20:28:16 +00:00
3e6a34297d
Squashes 25 PR commits onto current main. AppConfig becomes a pure value object with no ambient lookup. Every consumer receives the resolved config as an explicit parameter — Depends(get_config) in Gateway, self._app_config in DeerFlowClient, runtime.context.app_config in agent runs, AppConfig.from_file() at the LangGraph Server registration boundary. Phase 1 — frozen data + typed context - All config models (AppConfig, MemoryConfig, DatabaseConfig, …) become frozen=True; no sub-module globals. - AppConfig.from_file() is pure (no side-effect singleton loaders). - Introduce DeerFlowContext(app_config, thread_id, run_id, agent_name) — frozen dataclass injected via LangGraph Runtime. - Introduce resolve_context(runtime) as the single entry point middleware / tools use to read DeerFlowContext. Phase 2 — pure explicit parameter passing - Gateway: app.state.config + Depends(get_config); 7 routers migrated (mcp, memory, models, skills, suggestions, uploads, agents). - DeerFlowClient: __init__(config=...) captures config locally. - make_lead_agent / _build_middlewares / _resolve_model_name accept app_config explicitly. - RunContext.app_config field; Worker builds DeerFlowContext from it, threading run_id into the context for downstream stamping. - Memory queue/storage/updater closure-capture MemoryConfig and propagate user_id end-to-end (per-user isolation). - Sandbox/skills/community/factories/tools thread app_config. - resolve_context() rejects non-typed runtime.context. - Test suite migrated off AppConfig.current() monkey-patches. - AppConfig.current() classmethod deleted. Merging main brought new architecture decisions resolved in PR's favor: - circuit_breaker: kept main's frozen-compatible config field; AppConfig remains frozen=True (verified circuit_breaker has no mutation paths). - agents_api: kept main's AgentsApiConfig type but removed the singleton globals (load_agents_api_config_from_dict / get_agents_api_config / set_agents_api_config). 8 routes in agents.py now read via Depends(get_config). - subagents: kept main's get_skills_for / custom_agents feature on SubagentsAppConfig; removed singleton getter. registry.py now reads app_config.subagents directly. - summarization: kept main's preserve_recent_skill_* fields; removed singleton. - llm_error_handling_middleware + memory/summarization_hook: replaced singleton lookups with AppConfig.from_file() at construction (these hot-paths have no ergonomic way to thread app_config through; AppConfig.from_file is a pure load). - worker.py + thread_data_middleware.py: DeerFlowContext.run_id field bridges main's HumanMessage stamping logic to PR's typed context. Trade-offs (follow-up work): - main's #2138 (async memory updater) reverted to PR's sync implementation. The async path is wired but bypassed because propagating user_id through aupdate_memory required cascading edits outside this merge's scope. - tests/test_subagent_skills_config.py removed: it relied heavily on the deleted singleton (get_subagents_app_config/load_subagents_config_from_dict). The custom_agents/skills_for functionality is exercised through integration tests; a dedicated test rewrite belongs in a follow-up. Verification: backend test suite — 2560 passed, 4 skipped, 84 failures. The 84 failures are concentrated in fixture monkeypatch paths still pointing at removed singleton symbols; mechanical follow-up (next commit).
168 lines
6.9 KiB
Python
168 lines
6.9 KiB
Python
"""Tests for user-scoped path resolution in Paths."""
|
|
import pytest
|
|
from pathlib import Path
|
|
|
|
from deerflow.config.paths import Paths
|
|
|
|
|
|
@pytest.fixture
|
|
def paths(tmp_path: Path) -> Paths:
|
|
return Paths(tmp_path)
|
|
|
|
|
|
class TestValidateUserId:
|
|
def test_valid_user_id(self, paths: Paths):
|
|
d = paths.user_dir("u-abc-123")
|
|
assert d == paths.base_dir / "users" / "u-abc-123"
|
|
|
|
def test_rejects_path_traversal(self, paths: Paths):
|
|
with pytest.raises(ValueError, match="Invalid user_id"):
|
|
paths.user_dir("../escape")
|
|
|
|
def test_rejects_slash(self, paths: Paths):
|
|
with pytest.raises(ValueError, match="Invalid user_id"):
|
|
paths.user_dir("foo/bar")
|
|
|
|
def test_rejects_empty(self, paths: Paths):
|
|
with pytest.raises(ValueError, match="Invalid user_id"):
|
|
paths.user_dir("")
|
|
|
|
|
|
class TestUserDir:
|
|
def test_user_dir(self, paths: Paths):
|
|
assert paths.user_dir("alice") == paths.base_dir / "users" / "alice"
|
|
|
|
|
|
class TestUserMemoryFile:
|
|
def test_user_memory_file(self, paths: Paths):
|
|
assert paths.user_memory_file("bob") == paths.base_dir / "users" / "bob" / "memory.json"
|
|
|
|
|
|
class TestUserAgentMemoryFile:
|
|
def test_user_agent_memory_file(self, paths: Paths):
|
|
expected = paths.base_dir / "users" / "bob" / "agents" / "myagent" / "memory.json"
|
|
assert paths.user_agent_memory_file("bob", "myagent") == expected
|
|
|
|
def test_user_agent_memory_file_lowercases_name(self, paths: Paths):
|
|
expected = paths.base_dir / "users" / "bob" / "agents" / "myagent" / "memory.json"
|
|
assert paths.user_agent_memory_file("bob", "MyAgent") == expected
|
|
|
|
|
|
class TestUserThreadDir:
|
|
def test_user_thread_dir(self, paths: Paths):
|
|
expected = paths.base_dir / "users" / "u1" / "threads" / "t1"
|
|
assert paths.thread_dir("t1", user_id="u1") == expected
|
|
|
|
def test_thread_dir_no_user_id_falls_back_to_legacy(self, paths: Paths):
|
|
expected = paths.base_dir / "threads" / "t1"
|
|
assert paths.thread_dir("t1") == expected
|
|
|
|
|
|
class TestUserSandboxDirs:
|
|
def test_sandbox_work_dir(self, paths: Paths):
|
|
expected = paths.base_dir / "users" / "u1" / "threads" / "t1" / "user-data" / "workspace"
|
|
assert paths.sandbox_work_dir("t1", user_id="u1") == expected
|
|
|
|
def test_sandbox_uploads_dir(self, paths: Paths):
|
|
expected = paths.base_dir / "users" / "u1" / "threads" / "t1" / "user-data" / "uploads"
|
|
assert paths.sandbox_uploads_dir("t1", user_id="u1") == expected
|
|
|
|
def test_sandbox_outputs_dir(self, paths: Paths):
|
|
expected = paths.base_dir / "users" / "u1" / "threads" / "t1" / "user-data" / "outputs"
|
|
assert paths.sandbox_outputs_dir("t1", user_id="u1") == expected
|
|
|
|
def test_sandbox_user_data_dir(self, paths: Paths):
|
|
expected = paths.base_dir / "users" / "u1" / "threads" / "t1" / "user-data"
|
|
assert paths.sandbox_user_data_dir("t1", user_id="u1") == expected
|
|
|
|
def test_acp_workspace_dir(self, paths: Paths):
|
|
expected = paths.base_dir / "users" / "u1" / "threads" / "t1" / "acp-workspace"
|
|
assert paths.acp_workspace_dir("t1", user_id="u1") == expected
|
|
|
|
def test_legacy_sandbox_work_dir(self, paths: Paths):
|
|
expected = paths.base_dir / "threads" / "t1" / "user-data" / "workspace"
|
|
assert paths.sandbox_work_dir("t1") == expected
|
|
|
|
|
|
class TestHostPathsWithUserId:
|
|
def test_host_thread_dir_with_user_id(self, paths: Paths):
|
|
result = paths.host_thread_dir("t1", user_id="u1")
|
|
assert "users" in result
|
|
assert "u1" in result
|
|
assert "threads" in result
|
|
assert "t1" in result
|
|
|
|
def test_host_thread_dir_legacy(self, paths: Paths):
|
|
result = paths.host_thread_dir("t1")
|
|
assert "threads" in result
|
|
assert "t1" in result
|
|
assert "users" not in result
|
|
|
|
def test_host_sandbox_user_data_dir_with_user_id(self, paths: Paths):
|
|
result = paths.host_sandbox_user_data_dir("t1", user_id="u1")
|
|
assert "users" in result
|
|
assert "user-data" in result
|
|
|
|
def test_host_sandbox_work_dir_with_user_id(self, paths: Paths):
|
|
result = paths.host_sandbox_work_dir("t1", user_id="u1")
|
|
assert "workspace" in result
|
|
|
|
def test_host_sandbox_uploads_dir_with_user_id(self, paths: Paths):
|
|
result = paths.host_sandbox_uploads_dir("t1", user_id="u1")
|
|
assert "uploads" in result
|
|
|
|
def test_host_sandbox_outputs_dir_with_user_id(self, paths: Paths):
|
|
result = paths.host_sandbox_outputs_dir("t1", user_id="u1")
|
|
assert "outputs" in result
|
|
|
|
def test_host_acp_workspace_dir_with_user_id(self, paths: Paths):
|
|
result = paths.host_acp_workspace_dir("t1", user_id="u1")
|
|
assert "acp-workspace" in result
|
|
|
|
|
|
class TestEnsureAndDeleteWithUserId:
|
|
def test_ensure_thread_dirs_creates_user_scoped(self, paths: Paths):
|
|
paths.ensure_thread_dirs("t1", user_id="u1")
|
|
assert paths.sandbox_work_dir("t1", user_id="u1").is_dir()
|
|
assert paths.sandbox_uploads_dir("t1", user_id="u1").is_dir()
|
|
assert paths.sandbox_outputs_dir("t1", user_id="u1").is_dir()
|
|
assert paths.acp_workspace_dir("t1", user_id="u1").is_dir()
|
|
|
|
def test_delete_thread_dir_removes_user_scoped(self, paths: Paths):
|
|
paths.ensure_thread_dirs("t1", user_id="u1")
|
|
assert paths.thread_dir("t1", user_id="u1").exists()
|
|
paths.delete_thread_dir("t1", user_id="u1")
|
|
assert not paths.thread_dir("t1", user_id="u1").exists()
|
|
|
|
def test_delete_thread_dir_idempotent(self, paths: Paths):
|
|
paths.delete_thread_dir("nonexistent", user_id="u1") # should not raise
|
|
|
|
def test_ensure_thread_dirs_legacy_still_works(self, paths: Paths):
|
|
paths.ensure_thread_dirs("t1")
|
|
assert paths.sandbox_work_dir("t1").is_dir()
|
|
|
|
def test_user_scoped_and_legacy_are_independent(self, paths: Paths):
|
|
paths.ensure_thread_dirs("t1", user_id="u1")
|
|
paths.ensure_thread_dirs("t1")
|
|
# Both exist independently
|
|
assert paths.thread_dir("t1", user_id="u1").exists()
|
|
assert paths.thread_dir("t1").exists()
|
|
# Delete one doesn't affect the other
|
|
paths.delete_thread_dir("t1", user_id="u1")
|
|
assert not paths.thread_dir("t1", user_id="u1").exists()
|
|
assert paths.thread_dir("t1").exists()
|
|
|
|
|
|
class TestResolveVirtualPathWithUserId:
|
|
def test_resolve_virtual_path_with_user_id(self, paths: Paths):
|
|
paths.ensure_thread_dirs("t1", user_id="u1")
|
|
result = paths.resolve_virtual_path("t1", "/mnt/user-data/workspace/file.txt", user_id="u1")
|
|
expected_base = paths.sandbox_user_data_dir("t1", user_id="u1").resolve()
|
|
assert str(result).startswith(str(expected_base))
|
|
|
|
def test_resolve_virtual_path_legacy(self, paths: Paths):
|
|
paths.ensure_thread_dirs("t1")
|
|
result = paths.resolve_virtual_path("t1", "/mnt/user-data/workspace/file.txt")
|
|
expected_base = paths.sandbox_user_data_dir("t1").resolve()
|
|
assert str(result).startswith(str(expected_base))
|