mirror of
https://gitee.com/wanwujie/deer-flow
synced 2026-04-19 12:24:46 +08:00
refactor: split backend into harness (deerflow.*) and app (app.*) (#1131)
* refactor: extract shared utils to break harness→app cross-layer imports Move _validate_skill_frontmatter to src/skills/validation.py and CONVERTIBLE_EXTENSIONS + convert_file_to_markdown to src/utils/file_conversion.py. This eliminates the two reverse dependencies from client.py (harness layer) into gateway/routers/ (app layer), preparing for the harness/app package split. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * refactor: split backend/src into harness (deerflow.*) and app (app.*) Physically split the monolithic backend/src/ package into two layers: - **Harness** (`packages/harness/deerflow/`): publishable agent framework package with import prefix `deerflow.*`. Contains agents, sandbox, tools, models, MCP, skills, config, and all core infrastructure. - **App** (`app/`): unpublished application code with import prefix `app.*`. Contains gateway (FastAPI REST API) and channels (IM integrations). Key changes: - Move 13 harness modules to packages/harness/deerflow/ via git mv - Move gateway + channels to app/ via git mv - Rename all imports: src.* → deerflow.* (harness) / app.* (app layer) - Set up uv workspace with deerflow-harness as workspace member - Update langgraph.json, config.example.yaml, all scripts, Docker files - Add build-system (hatchling) to harness pyproject.toml - Add PYTHONPATH=. to gateway startup commands for app.* resolution - Update ruff.toml with known-first-party for import sorting - Update all documentation to reflect new directory structure Boundary rule enforced: harness code never imports from app. All 429 tests pass. Lint clean. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * chore: add harness→app boundary check test and update docs Add test_harness_boundary.py that scans all Python files in packages/harness/deerflow/ and fails if any `from app.*` or `import app.*` statement is found. This enforces the architectural rule that the harness layer never depends on the app layer. Update CLAUDE.md to document the harness/app split architecture, import conventions, and the boundary enforcement test. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * feat: add config versioning with auto-upgrade on startup When config.example.yaml schema changes, developers' local config.yaml files can silently become outdated. This adds a config_version field and auto-upgrade mechanism so breaking changes (like src.* → deerflow.* renames) are applied automatically before services start. - Add config_version: 1 to config.example.yaml - Add startup version check warning in AppConfig.from_file() - Add scripts/config-upgrade.sh with migration registry for value replacements - Add `make config-upgrade` target - Auto-run config-upgrade in serve.sh and start-daemon.sh before starting services - Add config error hints in service failure messages Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix comments * fix: update src.* import in test_sandbox_tools_security to deerflow.* Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: handle empty config and search parent dirs for config.example.yaml Address Copilot review comments on PR #1131: - Guard against yaml.safe_load() returning None for empty config files - Search parent directories for config.example.yaml instead of only looking next to config.yaml, fixing detection in common setups Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: correct skills root path depth and config_version type coercion - loader.py: fix get_skills_root_path() to use 5 parent levels (was 3) after harness split, file lives at packages/harness/deerflow/skills/ so parent×3 resolved to backend/packages/harness/ instead of backend/ - app_config.py: coerce config_version to int() before comparison in _check_config_version() to prevent TypeError when YAML stores value as string (e.g. config_version: "1") - tests: add regression tests for both fixes Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: update test imports from src.* to deerflow.*/app.* after harness refactor Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
DanielWalnut
@@ -6,8 +6,8 @@ import asyncio
|
||||
from pathlib import Path
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
from src.channels.base import Channel
|
||||
from src.channels.message_bus import MessageBus, OutboundMessage, ResolvedAttachment
|
||||
from app.channels.base import Channel
|
||||
from app.channels.message_bus import MessageBus, OutboundMessage, ResolvedAttachment
|
||||
|
||||
|
||||
def _run(coro):
|
||||
@@ -102,7 +102,7 @@ class TestOutboundMessageAttachments:
|
||||
class TestResolveAttachments:
|
||||
def test_resolves_existing_file(self, tmp_path):
|
||||
"""Successfully resolves a virtual path to an existing file."""
|
||||
from src.channels.manager import _resolve_attachments
|
||||
from app.channels.manager import _resolve_attachments
|
||||
|
||||
# Create the directory structure: threads/{thread_id}/user-data/outputs/
|
||||
thread_id = "test-thread-123"
|
||||
@@ -115,7 +115,7 @@ class TestResolveAttachments:
|
||||
mock_paths.resolve_virtual_path.return_value = test_file
|
||||
mock_paths.sandbox_outputs_dir.return_value = outputs_dir
|
||||
|
||||
with patch("src.config.paths.get_paths", return_value=mock_paths):
|
||||
with patch("deerflow.config.paths.get_paths", return_value=mock_paths):
|
||||
result = _resolve_attachments(thread_id, ["/mnt/user-data/outputs/report.pdf"])
|
||||
|
||||
assert len(result) == 1
|
||||
@@ -126,7 +126,7 @@ class TestResolveAttachments:
|
||||
|
||||
def test_resolves_image_file(self, tmp_path):
|
||||
"""Images are detected by MIME type."""
|
||||
from src.channels.manager import _resolve_attachments
|
||||
from app.channels.manager import _resolve_attachments
|
||||
|
||||
thread_id = "test-thread"
|
||||
outputs_dir = tmp_path / "threads" / thread_id / "user-data" / "outputs"
|
||||
@@ -138,7 +138,7 @@ class TestResolveAttachments:
|
||||
mock_paths.resolve_virtual_path.return_value = img
|
||||
mock_paths.sandbox_outputs_dir.return_value = outputs_dir
|
||||
|
||||
with patch("src.config.paths.get_paths", return_value=mock_paths):
|
||||
with patch("deerflow.config.paths.get_paths", return_value=mock_paths):
|
||||
result = _resolve_attachments(thread_id, ["/mnt/user-data/outputs/chart.png"])
|
||||
|
||||
assert len(result) == 1
|
||||
@@ -147,7 +147,7 @@ class TestResolveAttachments:
|
||||
|
||||
def test_skips_missing_file(self, tmp_path):
|
||||
"""Missing files are skipped with a warning."""
|
||||
from src.channels.manager import _resolve_attachments
|
||||
from app.channels.manager import _resolve_attachments
|
||||
|
||||
outputs_dir = tmp_path / "outputs"
|
||||
outputs_dir.mkdir()
|
||||
@@ -156,30 +156,30 @@ class TestResolveAttachments:
|
||||
mock_paths.resolve_virtual_path.return_value = outputs_dir / "nonexistent.txt"
|
||||
mock_paths.sandbox_outputs_dir.return_value = outputs_dir
|
||||
|
||||
with patch("src.config.paths.get_paths", return_value=mock_paths):
|
||||
with patch("deerflow.config.paths.get_paths", return_value=mock_paths):
|
||||
result = _resolve_attachments("t1", ["/mnt/user-data/outputs/nonexistent.txt"])
|
||||
|
||||
assert result == []
|
||||
|
||||
def test_skips_invalid_path(self):
|
||||
"""Invalid paths (ValueError from resolve) are skipped."""
|
||||
from src.channels.manager import _resolve_attachments
|
||||
from app.channels.manager import _resolve_attachments
|
||||
|
||||
mock_paths = MagicMock()
|
||||
mock_paths.resolve_virtual_path.side_effect = ValueError("bad path")
|
||||
|
||||
with patch("src.config.paths.get_paths", return_value=mock_paths):
|
||||
with patch("deerflow.config.paths.get_paths", return_value=mock_paths):
|
||||
result = _resolve_attachments("t1", ["/invalid/path"])
|
||||
|
||||
assert result == []
|
||||
|
||||
def test_rejects_uploads_path(self):
|
||||
"""Paths under /mnt/user-data/uploads/ are rejected (security)."""
|
||||
from src.channels.manager import _resolve_attachments
|
||||
from app.channels.manager import _resolve_attachments
|
||||
|
||||
mock_paths = MagicMock()
|
||||
|
||||
with patch("src.config.paths.get_paths", return_value=mock_paths):
|
||||
with patch("deerflow.config.paths.get_paths", return_value=mock_paths):
|
||||
result = _resolve_attachments("t1", ["/mnt/user-data/uploads/secret.pdf"])
|
||||
|
||||
assert result == []
|
||||
@@ -187,11 +187,11 @@ class TestResolveAttachments:
|
||||
|
||||
def test_rejects_workspace_path(self):
|
||||
"""Paths under /mnt/user-data/workspace/ are rejected (security)."""
|
||||
from src.channels.manager import _resolve_attachments
|
||||
from app.channels.manager import _resolve_attachments
|
||||
|
||||
mock_paths = MagicMock()
|
||||
|
||||
with patch("src.config.paths.get_paths", return_value=mock_paths):
|
||||
with patch("deerflow.config.paths.get_paths", return_value=mock_paths):
|
||||
result = _resolve_attachments("t1", ["/mnt/user-data/workspace/config.py"])
|
||||
|
||||
assert result == []
|
||||
@@ -199,7 +199,7 @@ class TestResolveAttachments:
|
||||
|
||||
def test_rejects_path_traversal_escape(self, tmp_path):
|
||||
"""Paths that escape the outputs directory after resolution are rejected."""
|
||||
from src.channels.manager import _resolve_attachments
|
||||
from app.channels.manager import _resolve_attachments
|
||||
|
||||
thread_id = "t1"
|
||||
outputs_dir = tmp_path / "threads" / thread_id / "user-data" / "outputs"
|
||||
@@ -213,14 +213,14 @@ class TestResolveAttachments:
|
||||
mock_paths.resolve_virtual_path.return_value = escaped_file
|
||||
mock_paths.sandbox_outputs_dir.return_value = outputs_dir
|
||||
|
||||
with patch("src.config.paths.get_paths", return_value=mock_paths):
|
||||
with patch("deerflow.config.paths.get_paths", return_value=mock_paths):
|
||||
result = _resolve_attachments(thread_id, ["/mnt/user-data/outputs/../uploads/stolen.txt"])
|
||||
|
||||
assert result == []
|
||||
|
||||
def test_multiple_artifacts_partial_resolution(self, tmp_path):
|
||||
"""Mixed valid/invalid artifacts: only valid ones are returned."""
|
||||
from src.channels.manager import _resolve_attachments
|
||||
from app.channels.manager import _resolve_attachments
|
||||
|
||||
thread_id = "t1"
|
||||
outputs_dir = tmp_path / "outputs"
|
||||
@@ -238,7 +238,7 @@ class TestResolveAttachments:
|
||||
|
||||
mock_paths.resolve_virtual_path.side_effect = resolve_side_effect
|
||||
|
||||
with patch("src.config.paths.get_paths", return_value=mock_paths):
|
||||
with patch("deerflow.config.paths.get_paths", return_value=mock_paths):
|
||||
result = _resolve_attachments(
|
||||
thread_id,
|
||||
["/mnt/user-data/outputs/data.csv", "/mnt/user-data/outputs/missing.txt"],
|
||||
@@ -417,17 +417,17 @@ class TestBaseChannelOnOutbound:
|
||||
class TestManagerArtifactResolution:
|
||||
def test_handle_chat_populates_attachments(self):
|
||||
"""Verify _resolve_attachments is importable and works with the manager module."""
|
||||
from src.channels.manager import _resolve_attachments
|
||||
from app.channels.manager import _resolve_attachments
|
||||
|
||||
# Basic smoke test: empty artifacts returns empty list
|
||||
mock_paths = MagicMock()
|
||||
with patch("src.config.paths.get_paths", return_value=mock_paths):
|
||||
with patch("deerflow.config.paths.get_paths", return_value=mock_paths):
|
||||
result = _resolve_attachments("t1", [])
|
||||
assert result == []
|
||||
|
||||
def test_format_artifact_text_for_unresolved(self):
|
||||
"""_format_artifact_text produces expected output."""
|
||||
from src.channels.manager import _format_artifact_text
|
||||
from app.channels.manager import _format_artifact_text
|
||||
|
||||
assert "report.pdf" in _format_artifact_text(["/mnt/user-data/outputs/report.pdf"])
|
||||
result = _format_artifact_text(["/mnt/user-data/outputs/a.txt", "/mnt/user-data/outputs/b.txt"])
|
||||
|
||||
Reference in New Issue
Block a user