2026-02-28 14:38:15 +08:00
|
|
|
"""DeerFlowClient — Embedded Python client for DeerFlow agent system.
|
|
|
|
|
|
|
|
|
|
Provides direct programmatic access to DeerFlow's agent capabilities
|
|
|
|
|
without requiring LangGraph Server or Gateway API processes.
|
|
|
|
|
|
|
|
|
|
Usage:
|
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>
2026-03-14 22:55:52 +08:00
|
|
|
from deerflow.client import DeerFlowClient
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
client = DeerFlowClient()
|
|
|
|
|
response = client.chat("Analyze this paper for me", thread_id="my-thread")
|
|
|
|
|
print(response)
|
|
|
|
|
|
|
|
|
|
# Streaming
|
|
|
|
|
for event in client.stream("hello"):
|
|
|
|
|
print(event)
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
import asyncio
|
|
|
|
|
import json
|
|
|
|
|
import logging
|
|
|
|
|
import mimetypes
|
2026-03-11 15:17:31 +08:00
|
|
|
import os
|
2026-02-28 14:38:15 +08:00
|
|
|
import re
|
|
|
|
|
import shutil
|
|
|
|
|
import tempfile
|
|
|
|
|
import uuid
|
|
|
|
|
import zipfile
|
|
|
|
|
from collections.abc import Generator
|
|
|
|
|
from dataclasses import dataclass, field
|
|
|
|
|
from pathlib import Path
|
|
|
|
|
from typing import Any
|
|
|
|
|
|
|
|
|
|
from langchain.agents import create_agent
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
from langchain_core.messages import AIMessage, HumanMessage, SystemMessage, ToolMessage
|
2026-02-28 14:38:15 +08:00
|
|
|
from langchain_core.runnables import RunnableConfig
|
|
|
|
|
|
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>
2026-03-14 22:55:52 +08:00
|
|
|
from deerflow.agents.lead_agent.agent import _build_middlewares
|
|
|
|
|
from deerflow.agents.lead_agent.prompt import apply_prompt_template
|
|
|
|
|
from deerflow.agents.thread_state import ThreadState
|
2026-03-23 17:44:21 +08:00
|
|
|
from deerflow.config.agents_config import AGENT_NAME_PATTERN
|
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>
2026-03-14 22:55:52 +08:00
|
|
|
from deerflow.config.app_config import get_app_config, reload_app_config
|
|
|
|
|
from deerflow.config.extensions_config import ExtensionsConfig, SkillStateConfig, get_extensions_config, reload_extensions_config
|
|
|
|
|
from deerflow.config.paths import get_paths
|
|
|
|
|
from deerflow.models import create_chat_model
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@dataclass
|
|
|
|
|
class StreamEvent:
|
|
|
|
|
"""A single event from the streaming agent response.
|
|
|
|
|
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
Event types align with the LangGraph SSE protocol:
|
|
|
|
|
- ``"values"``: Full state snapshot (title, messages, artifacts).
|
|
|
|
|
- ``"messages-tuple"``: Per-message update (AI text, tool calls, tool results).
|
|
|
|
|
- ``"end"``: Stream finished.
|
|
|
|
|
|
2026-02-28 14:38:15 +08:00
|
|
|
Attributes:
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
type: Event type.
|
2026-02-28 14:38:15 +08:00
|
|
|
data: Event payload. Contents vary by type.
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
type: str
|
|
|
|
|
data: dict[str, Any] = field(default_factory=dict)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class DeerFlowClient:
|
|
|
|
|
"""Embedded Python client for DeerFlow agent system.
|
|
|
|
|
|
|
|
|
|
Provides direct programmatic access to DeerFlow's agent capabilities
|
|
|
|
|
without requiring LangGraph Server or Gateway API processes.
|
|
|
|
|
|
|
|
|
|
Note:
|
|
|
|
|
Multi-turn conversations require a ``checkpointer``. Without one,
|
|
|
|
|
each ``stream()`` / ``chat()`` call is stateless — ``thread_id``
|
|
|
|
|
is only used for file isolation (uploads / artifacts).
|
|
|
|
|
|
|
|
|
|
The system prompt (including date, memory, and skills context) is
|
|
|
|
|
generated when the internal agent is first created and cached until
|
|
|
|
|
the configuration key changes. Call :meth:`reset_agent` to force
|
|
|
|
|
a refresh in long-running processes.
|
|
|
|
|
|
|
|
|
|
Example::
|
|
|
|
|
|
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>
2026-03-14 22:55:52 +08:00
|
|
|
from deerflow.client import DeerFlowClient
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
client = DeerFlowClient()
|
|
|
|
|
|
|
|
|
|
# Simple one-shot
|
|
|
|
|
print(client.chat("hello"))
|
|
|
|
|
|
|
|
|
|
# Streaming
|
|
|
|
|
for event in client.stream("hello"):
|
|
|
|
|
print(event.type, event.data)
|
|
|
|
|
|
|
|
|
|
# Configuration queries
|
|
|
|
|
print(client.list_models())
|
|
|
|
|
print(client.list_skills())
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
def __init__(
|
|
|
|
|
self,
|
|
|
|
|
config_path: str | None = None,
|
|
|
|
|
checkpointer=None,
|
|
|
|
|
*,
|
|
|
|
|
model_name: str | None = None,
|
|
|
|
|
thinking_enabled: bool = True,
|
|
|
|
|
subagent_enabled: bool = False,
|
|
|
|
|
plan_mode: bool = False,
|
2026-03-23 17:44:21 +08:00
|
|
|
agent_name: str | None = None,
|
2026-02-28 14:38:15 +08:00
|
|
|
):
|
|
|
|
|
"""Initialize the client.
|
|
|
|
|
|
|
|
|
|
Loads configuration but defers agent creation to first use.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
config_path: Path to config.yaml. Uses default resolution if None.
|
|
|
|
|
checkpointer: LangGraph checkpointer instance for state persistence.
|
|
|
|
|
Required for multi-turn conversations on the same thread_id.
|
|
|
|
|
Without a checkpointer, each call is stateless.
|
|
|
|
|
model_name: Override the default model name from config.
|
|
|
|
|
thinking_enabled: Enable model's extended thinking.
|
|
|
|
|
subagent_enabled: Enable subagent delegation.
|
|
|
|
|
plan_mode: Enable TodoList middleware for plan mode.
|
2026-03-23 17:44:21 +08:00
|
|
|
agent_name: Name of the agent to use.
|
2026-02-28 14:38:15 +08:00
|
|
|
"""
|
|
|
|
|
if config_path is not None:
|
|
|
|
|
reload_app_config(config_path)
|
|
|
|
|
self._app_config = get_app_config()
|
|
|
|
|
|
2026-03-23 17:44:21 +08:00
|
|
|
if agent_name is not None and not AGENT_NAME_PATTERN.match(agent_name):
|
|
|
|
|
raise ValueError(f"Invalid agent name '{agent_name}'. Must match pattern: {AGENT_NAME_PATTERN.pattern}")
|
|
|
|
|
|
2026-02-28 14:38:15 +08:00
|
|
|
self._checkpointer = checkpointer
|
|
|
|
|
self._model_name = model_name
|
|
|
|
|
self._thinking_enabled = thinking_enabled
|
|
|
|
|
self._subagent_enabled = subagent_enabled
|
|
|
|
|
self._plan_mode = plan_mode
|
2026-03-23 17:44:21 +08:00
|
|
|
self._agent_name = agent_name
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
# Lazy agent — created on first call, recreated when config changes.
|
|
|
|
|
self._agent = None
|
|
|
|
|
self._agent_config_key: tuple | None = None
|
|
|
|
|
|
|
|
|
|
def reset_agent(self) -> None:
|
|
|
|
|
"""Force the internal agent to be recreated on the next call.
|
|
|
|
|
|
|
|
|
|
Use this after external changes (e.g. memory updates, skill
|
|
|
|
|
installations) that should be reflected in the system prompt
|
|
|
|
|
or tool set.
|
|
|
|
|
"""
|
|
|
|
|
self._agent = None
|
|
|
|
|
self._agent_config_key = None
|
|
|
|
|
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
# Internal helpers
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
|
def _atomic_write_json(path: Path, data: dict) -> None:
|
|
|
|
|
"""Write JSON to *path* atomically (temp file + replace)."""
|
|
|
|
|
fd = tempfile.NamedTemporaryFile(
|
2026-03-07 21:07:21 +08:00
|
|
|
mode="w",
|
|
|
|
|
dir=path.parent,
|
|
|
|
|
suffix=".tmp",
|
|
|
|
|
delete=False,
|
2026-02-28 14:38:15 +08:00
|
|
|
)
|
|
|
|
|
try:
|
|
|
|
|
json.dump(data, fd, indent=2)
|
|
|
|
|
fd.close()
|
|
|
|
|
Path(fd.name).replace(path)
|
|
|
|
|
except BaseException:
|
|
|
|
|
fd.close()
|
|
|
|
|
Path(fd.name).unlink(missing_ok=True)
|
|
|
|
|
raise
|
|
|
|
|
|
|
|
|
|
def _get_runnable_config(self, thread_id: str, **overrides) -> RunnableConfig:
|
|
|
|
|
"""Build a RunnableConfig for agent invocation."""
|
|
|
|
|
configurable = {
|
|
|
|
|
"thread_id": thread_id,
|
|
|
|
|
"model_name": overrides.get("model_name", self._model_name),
|
|
|
|
|
"thinking_enabled": overrides.get("thinking_enabled", self._thinking_enabled),
|
|
|
|
|
"is_plan_mode": overrides.get("plan_mode", self._plan_mode),
|
|
|
|
|
"subagent_enabled": overrides.get("subagent_enabled", self._subagent_enabled),
|
|
|
|
|
}
|
|
|
|
|
return RunnableConfig(
|
|
|
|
|
configurable=configurable,
|
|
|
|
|
recursion_limit=overrides.get("recursion_limit", 100),
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
def _ensure_agent(self, config: RunnableConfig):
|
|
|
|
|
"""Create (or recreate) the agent when config-dependent params change."""
|
|
|
|
|
cfg = config.get("configurable", {})
|
|
|
|
|
key = (
|
|
|
|
|
cfg.get("model_name"),
|
|
|
|
|
cfg.get("thinking_enabled"),
|
|
|
|
|
cfg.get("is_plan_mode"),
|
|
|
|
|
cfg.get("subagent_enabled"),
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
if self._agent is not None and self._agent_config_key == key:
|
|
|
|
|
return
|
|
|
|
|
|
|
|
|
|
thinking_enabled = cfg.get("thinking_enabled", True)
|
|
|
|
|
model_name = cfg.get("model_name")
|
|
|
|
|
subagent_enabled = cfg.get("subagent_enabled", False)
|
|
|
|
|
max_concurrent_subagents = cfg.get("max_concurrent_subagents", 3)
|
|
|
|
|
|
|
|
|
|
kwargs: dict[str, Any] = {
|
|
|
|
|
"model": create_chat_model(name=model_name, thinking_enabled=thinking_enabled),
|
|
|
|
|
"tools": self._get_tools(model_name=model_name, subagent_enabled=subagent_enabled),
|
2026-03-23 17:44:21 +08:00
|
|
|
"middleware": _build_middlewares(config, model_name=model_name, agent_name=self._agent_name),
|
2026-02-28 14:38:15 +08:00
|
|
|
"system_prompt": apply_prompt_template(
|
|
|
|
|
subagent_enabled=subagent_enabled,
|
|
|
|
|
max_concurrent_subagents=max_concurrent_subagents,
|
2026-03-23 17:44:21 +08:00
|
|
|
agent_name=self._agent_name,
|
2026-02-28 14:38:15 +08:00
|
|
|
),
|
|
|
|
|
"state_schema": ThreadState,
|
|
|
|
|
}
|
2026-03-07 21:07:21 +08:00
|
|
|
checkpointer = self._checkpointer
|
|
|
|
|
if checkpointer is None:
|
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>
2026-03-14 22:55:52 +08:00
|
|
|
from deerflow.agents.checkpointer import get_checkpointer
|
2026-03-07 21:07:21 +08:00
|
|
|
|
|
|
|
|
checkpointer = get_checkpointer()
|
|
|
|
|
if checkpointer is not None:
|
|
|
|
|
kwargs["checkpointer"] = checkpointer
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
self._agent = create_agent(**kwargs)
|
|
|
|
|
self._agent_config_key = key
|
2026-03-23 17:44:21 +08:00
|
|
|
logger.info("Agent created: agent_name=%s, model=%s, thinking=%s", self._agent_name, model_name, thinking_enabled)
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
|
def _get_tools(*, model_name: str | None, subagent_enabled: bool):
|
|
|
|
|
"""Lazy import to avoid circular dependency at module level."""
|
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>
2026-03-14 22:55:52 +08:00
|
|
|
from deerflow.tools import get_available_tools
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
return get_available_tools(model_name=model_name, subagent_enabled=subagent_enabled)
|
|
|
|
|
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
@staticmethod
|
|
|
|
|
def _serialize_message(msg) -> dict:
|
|
|
|
|
"""Serialize a LangChain message to a plain dict for values events."""
|
|
|
|
|
if isinstance(msg, AIMessage):
|
|
|
|
|
d: dict[str, Any] = {"type": "ai", "content": msg.content, "id": getattr(msg, "id", None)}
|
|
|
|
|
if msg.tool_calls:
|
|
|
|
|
d["tool_calls"] = [{"name": tc["name"], "args": tc["args"], "id": tc.get("id")} for tc in msg.tool_calls]
|
2026-03-21 10:29:52 +08:00
|
|
|
if getattr(msg, "usage_metadata", None):
|
|
|
|
|
d["usage_metadata"] = msg.usage_metadata
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
return d
|
|
|
|
|
if isinstance(msg, ToolMessage):
|
|
|
|
|
return {
|
|
|
|
|
"type": "tool",
|
fix: normalize structured LLM content in serialization and memory updater (#1215)
* fix: normalize ToolMessage structured content in serialization
When models return ToolMessage content as a list of content blocks
(e.g. [{"type": "text", "text": "..."}]), the UI previously displayed
the raw Python repr string instead of the extracted text.
Replace str(msg.content) with the existing _extract_text() helper in
both _serialize_message() and stream() to properly normalize
list-of-blocks content to plain text.
Fixes #1149
Also fixes the same root cause as #1188 (characters displayed one per
line when tool response content is returned as structured blocks).
Added 11 regression tests covering string, list-of-blocks, mixed,
empty, and fallback content types.
* fix(memory): extract text from structured LLM responses in memory updater
When LLMs return response content as list of content blocks
(e.g. [{"type": "text", "text": "..."}]) instead of plain strings,
str() produces Python repr which breaks JSON parsing in the memory
updater. This caused memory updates to silently fail.
Changes:
- Add _extract_text() helper in updater.py for safe content normalization
- Use _extract_text() instead of str(response.content) in update_memory()
- Fix format_conversation_for_update() to handle plain strings in list content
- Fix subagent executor fallback path to extract text from list content
- Replace print() with structured logging (logger.info/warning/error)
- Add 13 regression tests covering _extract_text, format_conversation,
and update_memory with structured LLM responses
* fix: address Copilot review - defensive text extraction + logger.exception
- client.py _extract_text: use block.get('text') + isinstance check (prevent KeyError/TypeError)
- prompt.py format_conversation_for_update: same defensive check for dict text blocks
- executor.py: type-safe text extraction in both code paths, fallback to placeholder instead of str(raw_content)
- updater.py: use logger.exception() instead of logger.error() for traceback preservation
* Apply suggestions from code review
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* fix: preserve chunked structured content without spurious newlines
* fix: restore backend unit test compatibility
---------
Co-authored-by: Exploreunive <Exploreunive@users.noreply.github.com>
Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-03-22 17:29:29 +08:00
|
|
|
"content": DeerFlowClient._extract_text(msg.content),
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
"name": getattr(msg, "name", None),
|
|
|
|
|
"tool_call_id": getattr(msg, "tool_call_id", None),
|
|
|
|
|
"id": getattr(msg, "id", None),
|
|
|
|
|
}
|
|
|
|
|
if isinstance(msg, HumanMessage):
|
|
|
|
|
return {"type": "human", "content": msg.content, "id": getattr(msg, "id", None)}
|
|
|
|
|
if isinstance(msg, SystemMessage):
|
|
|
|
|
return {"type": "system", "content": msg.content, "id": getattr(msg, "id", None)}
|
|
|
|
|
return {"type": "unknown", "content": str(msg), "id": getattr(msg, "id", None)}
|
|
|
|
|
|
2026-02-28 14:38:15 +08:00
|
|
|
@staticmethod
|
|
|
|
|
def _extract_text(content) -> str:
|
fix: normalize structured LLM content in serialization and memory updater (#1215)
* fix: normalize ToolMessage structured content in serialization
When models return ToolMessage content as a list of content blocks
(e.g. [{"type": "text", "text": "..."}]), the UI previously displayed
the raw Python repr string instead of the extracted text.
Replace str(msg.content) with the existing _extract_text() helper in
both _serialize_message() and stream() to properly normalize
list-of-blocks content to plain text.
Fixes #1149
Also fixes the same root cause as #1188 (characters displayed one per
line when tool response content is returned as structured blocks).
Added 11 regression tests covering string, list-of-blocks, mixed,
empty, and fallback content types.
* fix(memory): extract text from structured LLM responses in memory updater
When LLMs return response content as list of content blocks
(e.g. [{"type": "text", "text": "..."}]) instead of plain strings,
str() produces Python repr which breaks JSON parsing in the memory
updater. This caused memory updates to silently fail.
Changes:
- Add _extract_text() helper in updater.py for safe content normalization
- Use _extract_text() instead of str(response.content) in update_memory()
- Fix format_conversation_for_update() to handle plain strings in list content
- Fix subagent executor fallback path to extract text from list content
- Replace print() with structured logging (logger.info/warning/error)
- Add 13 regression tests covering _extract_text, format_conversation,
and update_memory with structured LLM responses
* fix: address Copilot review - defensive text extraction + logger.exception
- client.py _extract_text: use block.get('text') + isinstance check (prevent KeyError/TypeError)
- prompt.py format_conversation_for_update: same defensive check for dict text blocks
- executor.py: type-safe text extraction in both code paths, fallback to placeholder instead of str(raw_content)
- updater.py: use logger.exception() instead of logger.error() for traceback preservation
* Apply suggestions from code review
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* fix: preserve chunked structured content without spurious newlines
* fix: restore backend unit test compatibility
---------
Co-authored-by: Exploreunive <Exploreunive@users.noreply.github.com>
Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-03-22 17:29:29 +08:00
|
|
|
"""Extract plain text from AIMessage content (str or list of blocks).
|
|
|
|
|
|
|
|
|
|
String chunks are concatenated without separators to avoid corrupting
|
|
|
|
|
token/character deltas or chunked JSON payloads. Dict-based text blocks
|
|
|
|
|
are treated as full text blocks and joined with newlines to preserve
|
|
|
|
|
readability.
|
|
|
|
|
"""
|
2026-02-28 14:38:15 +08:00
|
|
|
if isinstance(content, str):
|
|
|
|
|
return content
|
|
|
|
|
if isinstance(content, list):
|
fix: normalize structured LLM content in serialization and memory updater (#1215)
* fix: normalize ToolMessage structured content in serialization
When models return ToolMessage content as a list of content blocks
(e.g. [{"type": "text", "text": "..."}]), the UI previously displayed
the raw Python repr string instead of the extracted text.
Replace str(msg.content) with the existing _extract_text() helper in
both _serialize_message() and stream() to properly normalize
list-of-blocks content to plain text.
Fixes #1149
Also fixes the same root cause as #1188 (characters displayed one per
line when tool response content is returned as structured blocks).
Added 11 regression tests covering string, list-of-blocks, mixed,
empty, and fallback content types.
* fix(memory): extract text from structured LLM responses in memory updater
When LLMs return response content as list of content blocks
(e.g. [{"type": "text", "text": "..."}]) instead of plain strings,
str() produces Python repr which breaks JSON parsing in the memory
updater. This caused memory updates to silently fail.
Changes:
- Add _extract_text() helper in updater.py for safe content normalization
- Use _extract_text() instead of str(response.content) in update_memory()
- Fix format_conversation_for_update() to handle plain strings in list content
- Fix subagent executor fallback path to extract text from list content
- Replace print() with structured logging (logger.info/warning/error)
- Add 13 regression tests covering _extract_text, format_conversation,
and update_memory with structured LLM responses
* fix: address Copilot review - defensive text extraction + logger.exception
- client.py _extract_text: use block.get('text') + isinstance check (prevent KeyError/TypeError)
- prompt.py format_conversation_for_update: same defensive check for dict text blocks
- executor.py: type-safe text extraction in both code paths, fallback to placeholder instead of str(raw_content)
- updater.py: use logger.exception() instead of logger.error() for traceback preservation
* Apply suggestions from code review
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* fix: preserve chunked structured content without spurious newlines
* fix: restore backend unit test compatibility
---------
Co-authored-by: Exploreunive <Exploreunive@users.noreply.github.com>
Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-03-22 17:29:29 +08:00
|
|
|
if content and all(isinstance(block, str) for block in content):
|
|
|
|
|
chunk_like = len(content) > 1 and all(
|
|
|
|
|
isinstance(block, str)
|
|
|
|
|
and len(block) <= 20
|
|
|
|
|
and any(ch in block for ch in '{}[]":,')
|
|
|
|
|
for block in content
|
|
|
|
|
)
|
|
|
|
|
return "".join(content) if chunk_like else "\n".join(content)
|
|
|
|
|
|
|
|
|
|
pieces: list[str] = []
|
|
|
|
|
pending_str_parts: list[str] = []
|
|
|
|
|
|
|
|
|
|
def flush_pending_str_parts() -> None:
|
|
|
|
|
if pending_str_parts:
|
|
|
|
|
pieces.append("".join(pending_str_parts))
|
|
|
|
|
pending_str_parts.clear()
|
|
|
|
|
|
2026-02-28 14:38:15 +08:00
|
|
|
for block in content:
|
|
|
|
|
if isinstance(block, str):
|
fix: normalize structured LLM content in serialization and memory updater (#1215)
* fix: normalize ToolMessage structured content in serialization
When models return ToolMessage content as a list of content blocks
(e.g. [{"type": "text", "text": "..."}]), the UI previously displayed
the raw Python repr string instead of the extracted text.
Replace str(msg.content) with the existing _extract_text() helper in
both _serialize_message() and stream() to properly normalize
list-of-blocks content to plain text.
Fixes #1149
Also fixes the same root cause as #1188 (characters displayed one per
line when tool response content is returned as structured blocks).
Added 11 regression tests covering string, list-of-blocks, mixed,
empty, and fallback content types.
* fix(memory): extract text from structured LLM responses in memory updater
When LLMs return response content as list of content blocks
(e.g. [{"type": "text", "text": "..."}]) instead of plain strings,
str() produces Python repr which breaks JSON parsing in the memory
updater. This caused memory updates to silently fail.
Changes:
- Add _extract_text() helper in updater.py for safe content normalization
- Use _extract_text() instead of str(response.content) in update_memory()
- Fix format_conversation_for_update() to handle plain strings in list content
- Fix subagent executor fallback path to extract text from list content
- Replace print() with structured logging (logger.info/warning/error)
- Add 13 regression tests covering _extract_text, format_conversation,
and update_memory with structured LLM responses
* fix: address Copilot review - defensive text extraction + logger.exception
- client.py _extract_text: use block.get('text') + isinstance check (prevent KeyError/TypeError)
- prompt.py format_conversation_for_update: same defensive check for dict text blocks
- executor.py: type-safe text extraction in both code paths, fallback to placeholder instead of str(raw_content)
- updater.py: use logger.exception() instead of logger.error() for traceback preservation
* Apply suggestions from code review
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* fix: preserve chunked structured content without spurious newlines
* fix: restore backend unit test compatibility
---------
Co-authored-by: Exploreunive <Exploreunive@users.noreply.github.com>
Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-03-22 17:29:29 +08:00
|
|
|
pending_str_parts.append(block)
|
|
|
|
|
elif isinstance(block, dict):
|
|
|
|
|
flush_pending_str_parts()
|
|
|
|
|
text_val = block.get("text")
|
|
|
|
|
if isinstance(text_val, str):
|
|
|
|
|
pieces.append(text_val)
|
|
|
|
|
|
|
|
|
|
flush_pending_str_parts()
|
|
|
|
|
return "\n".join(pieces) if pieces else ""
|
2026-02-28 14:38:15 +08:00
|
|
|
return str(content)
|
|
|
|
|
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
# Public API — conversation
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
def stream(
|
|
|
|
|
self,
|
|
|
|
|
message: str,
|
|
|
|
|
*,
|
|
|
|
|
thread_id: str | None = None,
|
|
|
|
|
**kwargs,
|
|
|
|
|
) -> Generator[StreamEvent, None, None]:
|
|
|
|
|
"""Stream a conversation turn, yielding events incrementally.
|
|
|
|
|
|
|
|
|
|
Each call sends one user message and yields events until the agent
|
|
|
|
|
finishes its turn. A ``checkpointer`` must be provided at init time
|
|
|
|
|
for multi-turn context to be preserved across calls.
|
|
|
|
|
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
Event types align with the LangGraph SSE protocol so that
|
|
|
|
|
consumers can switch between HTTP streaming and embedded mode
|
|
|
|
|
without changing their event-handling logic.
|
|
|
|
|
|
2026-02-28 14:38:15 +08:00
|
|
|
Args:
|
|
|
|
|
message: User message text.
|
|
|
|
|
thread_id: Thread ID for conversation context. Auto-generated if None.
|
|
|
|
|
**kwargs: Override client defaults (model_name, thinking_enabled,
|
|
|
|
|
plan_mode, subagent_enabled, recursion_limit).
|
|
|
|
|
|
|
|
|
|
Yields:
|
|
|
|
|
StreamEvent with one of:
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
- type="values" data={"title": str|None, "messages": [...], "artifacts": [...]}
|
|
|
|
|
- type="messages-tuple" data={"type": "ai", "content": str, "id": str}
|
2026-03-21 10:29:52 +08:00
|
|
|
- type="messages-tuple" data={"type": "ai", "content": str, "id": str, "usage_metadata": {...}}
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
- type="messages-tuple" data={"type": "ai", "content": "", "id": str, "tool_calls": [...]}
|
|
|
|
|
- type="messages-tuple" data={"type": "tool", "content": str, "name": str, "tool_call_id": str, "id": str}
|
2026-03-21 10:29:52 +08:00
|
|
|
- type="end" data={"usage": {"input_tokens": int, "output_tokens": int, "total_tokens": int}}
|
2026-02-28 14:38:15 +08:00
|
|
|
"""
|
|
|
|
|
if thread_id is None:
|
|
|
|
|
thread_id = str(uuid.uuid4())
|
|
|
|
|
|
|
|
|
|
config = self._get_runnable_config(thread_id, **kwargs)
|
|
|
|
|
self._ensure_agent(config)
|
|
|
|
|
|
|
|
|
|
state: dict[str, Any] = {"messages": [HumanMessage(content=message)]}
|
|
|
|
|
context = {"thread_id": thread_id}
|
2026-03-23 17:44:21 +08:00
|
|
|
if self._agent_name:
|
|
|
|
|
context["agent_name"] = self._agent_name
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
seen_ids: set[str] = set()
|
2026-03-21 10:29:52 +08:00
|
|
|
cumulative_usage: dict[str, int] = {"input_tokens": 0, "output_tokens": 0, "total_tokens": 0}
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
for chunk in self._agent.stream(state, config=config, context=context, stream_mode="values"):
|
|
|
|
|
messages = chunk.get("messages", [])
|
|
|
|
|
|
|
|
|
|
for msg in messages:
|
|
|
|
|
msg_id = getattr(msg, "id", None)
|
|
|
|
|
if msg_id and msg_id in seen_ids:
|
|
|
|
|
continue
|
|
|
|
|
if msg_id:
|
|
|
|
|
seen_ids.add(msg_id)
|
|
|
|
|
|
|
|
|
|
if isinstance(msg, AIMessage):
|
2026-03-21 10:29:52 +08:00
|
|
|
# Track token usage from AI messages
|
|
|
|
|
usage = getattr(msg, "usage_metadata", None)
|
|
|
|
|
if usage:
|
|
|
|
|
cumulative_usage["input_tokens"] += usage.get("input_tokens", 0) or 0
|
|
|
|
|
cumulative_usage["output_tokens"] += usage.get("output_tokens", 0) or 0
|
|
|
|
|
cumulative_usage["total_tokens"] += usage.get("total_tokens", 0) or 0
|
|
|
|
|
|
2026-02-28 14:38:15 +08:00
|
|
|
if msg.tool_calls:
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
yield StreamEvent(
|
|
|
|
|
type="messages-tuple",
|
|
|
|
|
data={
|
|
|
|
|
"type": "ai",
|
|
|
|
|
"content": "",
|
|
|
|
|
"id": msg_id,
|
2026-03-07 21:07:21 +08:00
|
|
|
"tool_calls": [{"name": tc["name"], "args": tc["args"], "id": tc.get("id")} for tc in msg.tool_calls],
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
},
|
|
|
|
|
)
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
text = self._extract_text(msg.content)
|
|
|
|
|
if text:
|
2026-03-21 10:29:52 +08:00
|
|
|
event_data: dict[str, Any] = {"type": "ai", "content": text, "id": msg_id}
|
|
|
|
|
if usage:
|
|
|
|
|
event_data["usage_metadata"] = {
|
|
|
|
|
"input_tokens": usage.get("input_tokens", 0) or 0,
|
|
|
|
|
"output_tokens": usage.get("output_tokens", 0) or 0,
|
|
|
|
|
"total_tokens": usage.get("total_tokens", 0) or 0,
|
|
|
|
|
}
|
|
|
|
|
yield StreamEvent(type="messages-tuple", data=event_data)
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
elif isinstance(msg, ToolMessage):
|
|
|
|
|
yield StreamEvent(
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
type="messages-tuple",
|
2026-02-28 14:38:15 +08:00
|
|
|
data={
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
"type": "tool",
|
fix: normalize structured LLM content in serialization and memory updater (#1215)
* fix: normalize ToolMessage structured content in serialization
When models return ToolMessage content as a list of content blocks
(e.g. [{"type": "text", "text": "..."}]), the UI previously displayed
the raw Python repr string instead of the extracted text.
Replace str(msg.content) with the existing _extract_text() helper in
both _serialize_message() and stream() to properly normalize
list-of-blocks content to plain text.
Fixes #1149
Also fixes the same root cause as #1188 (characters displayed one per
line when tool response content is returned as structured blocks).
Added 11 regression tests covering string, list-of-blocks, mixed,
empty, and fallback content types.
* fix(memory): extract text from structured LLM responses in memory updater
When LLMs return response content as list of content blocks
(e.g. [{"type": "text", "text": "..."}]) instead of plain strings,
str() produces Python repr which breaks JSON parsing in the memory
updater. This caused memory updates to silently fail.
Changes:
- Add _extract_text() helper in updater.py for safe content normalization
- Use _extract_text() instead of str(response.content) in update_memory()
- Fix format_conversation_for_update() to handle plain strings in list content
- Fix subagent executor fallback path to extract text from list content
- Replace print() with structured logging (logger.info/warning/error)
- Add 13 regression tests covering _extract_text, format_conversation,
and update_memory with structured LLM responses
* fix: address Copilot review - defensive text extraction + logger.exception
- client.py _extract_text: use block.get('text') + isinstance check (prevent KeyError/TypeError)
- prompt.py format_conversation_for_update: same defensive check for dict text blocks
- executor.py: type-safe text extraction in both code paths, fallback to placeholder instead of str(raw_content)
- updater.py: use logger.exception() instead of logger.error() for traceback preservation
* Apply suggestions from code review
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* fix: preserve chunked structured content without spurious newlines
* fix: restore backend unit test compatibility
---------
Co-authored-by: Exploreunive <Exploreunive@users.noreply.github.com>
Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-03-22 17:29:29 +08:00
|
|
|
"content": self._extract_text(msg.content),
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
"name": getattr(msg, "name", None),
|
2026-02-28 14:38:15 +08:00
|
|
|
"tool_call_id": getattr(msg, "tool_call_id", None),
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
"id": msg_id,
|
2026-02-28 14:38:15 +08:00
|
|
|
},
|
|
|
|
|
)
|
|
|
|
|
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
# Emit a values event for each state snapshot
|
|
|
|
|
yield StreamEvent(
|
|
|
|
|
type="values",
|
|
|
|
|
data={
|
|
|
|
|
"title": chunk.get("title"),
|
|
|
|
|
"messages": [self._serialize_message(m) for m in messages],
|
|
|
|
|
"artifacts": chunk.get("artifacts", []),
|
|
|
|
|
},
|
|
|
|
|
)
|
2026-02-28 14:38:15 +08:00
|
|
|
|
2026-03-21 10:29:52 +08:00
|
|
|
yield StreamEvent(type="end", data={"usage": cumulative_usage})
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
def chat(self, message: str, *, thread_id: str | None = None, **kwargs) -> str:
|
|
|
|
|
"""Send a message and return the final text response.
|
|
|
|
|
|
|
|
|
|
Convenience wrapper around :meth:`stream` that returns only the
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
**last** AI text from ``messages-tuple`` events. If the agent emits
|
|
|
|
|
multiple text segments in one turn, intermediate segments are
|
|
|
|
|
discarded. Use :meth:`stream` directly to capture all events.
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
message: User message text.
|
|
|
|
|
thread_id: Thread ID for conversation context. Auto-generated if None.
|
|
|
|
|
**kwargs: Override client defaults (same as stream()).
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
The last AI message text, or empty string if no response.
|
|
|
|
|
"""
|
|
|
|
|
last_text = ""
|
|
|
|
|
for event in self.stream(message, thread_id=thread_id, **kwargs):
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
if event.type == "messages-tuple" and event.data.get("type") == "ai":
|
|
|
|
|
content = event.data.get("content", "")
|
|
|
|
|
if content:
|
|
|
|
|
last_text = content
|
2026-02-28 14:38:15 +08:00
|
|
|
return last_text
|
|
|
|
|
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
# Public API — configuration queries
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
def list_models(self) -> dict:
|
2026-02-28 14:38:15 +08:00
|
|
|
"""List available models from configuration.
|
|
|
|
|
|
|
|
|
|
Returns:
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
Dict with "models" key containing list of model info dicts,
|
|
|
|
|
matching the Gateway API ``ModelsListResponse`` schema.
|
2026-02-28 14:38:15 +08:00
|
|
|
"""
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
return {
|
|
|
|
|
"models": [
|
|
|
|
|
{
|
|
|
|
|
"name": model.name,
|
2026-03-20 17:18:59 +08:00
|
|
|
"model": getattr(model, "model", None),
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
"display_name": getattr(model, "display_name", None),
|
|
|
|
|
"description": getattr(model, "description", None),
|
|
|
|
|
"supports_thinking": getattr(model, "supports_thinking", False),
|
2026-03-02 20:49:41 +08:00
|
|
|
"supports_reasoning_effort": getattr(model, "supports_reasoning_effort", False),
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
}
|
|
|
|
|
for model in self._app_config.models
|
|
|
|
|
]
|
|
|
|
|
}
|
2026-02-28 14:38:15 +08:00
|
|
|
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
def list_skills(self, enabled_only: bool = False) -> dict:
|
2026-02-28 14:38:15 +08:00
|
|
|
"""List available skills.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
enabled_only: If True, only return enabled skills.
|
|
|
|
|
|
|
|
|
|
Returns:
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
Dict with "skills" key containing list of skill info dicts,
|
|
|
|
|
matching the Gateway API ``SkillsListResponse`` schema.
|
2026-02-28 14:38:15 +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>
2026-03-14 22:55:52 +08:00
|
|
|
from deerflow.skills.loader import load_skills
|
2026-02-28 14:38:15 +08:00
|
|
|
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
return {
|
|
|
|
|
"skills": [
|
|
|
|
|
{
|
|
|
|
|
"name": s.name,
|
|
|
|
|
"description": s.description,
|
|
|
|
|
"license": s.license,
|
|
|
|
|
"category": s.category,
|
|
|
|
|
"enabled": s.enabled,
|
|
|
|
|
}
|
|
|
|
|
for s in load_skills(enabled_only=enabled_only)
|
|
|
|
|
]
|
|
|
|
|
}
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
def get_memory(self) -> dict:
|
|
|
|
|
"""Get current memory data.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
Memory data dict (see src/agents/memory/updater.py for structure).
|
|
|
|
|
"""
|
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>
2026-03-14 22:55:52 +08:00
|
|
|
from deerflow.agents.memory.updater import get_memory_data
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
return get_memory_data()
|
|
|
|
|
|
|
|
|
|
def get_model(self, name: str) -> dict | None:
|
|
|
|
|
"""Get a specific model's configuration by name.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
name: Model name.
|
|
|
|
|
|
|
|
|
|
Returns:
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
Model info dict matching the Gateway API ``ModelResponse``
|
|
|
|
|
schema, or None if not found.
|
2026-02-28 14:38:15 +08:00
|
|
|
"""
|
|
|
|
|
model = self._app_config.get_model_config(name)
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
if model is None:
|
|
|
|
|
return None
|
|
|
|
|
return {
|
|
|
|
|
"name": model.name,
|
2026-03-20 17:18:59 +08:00
|
|
|
"model": getattr(model, "model", None),
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
"display_name": getattr(model, "display_name", None),
|
|
|
|
|
"description": getattr(model, "description", None),
|
|
|
|
|
"supports_thinking": getattr(model, "supports_thinking", False),
|
2026-03-02 20:49:41 +08:00
|
|
|
"supports_reasoning_effort": getattr(model, "supports_reasoning_effort", False),
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
}
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
# Public API — MCP configuration
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
def get_mcp_config(self) -> dict:
|
2026-02-28 14:38:15 +08:00
|
|
|
"""Get MCP server configurations.
|
|
|
|
|
|
|
|
|
|
Returns:
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
Dict with "mcp_servers" key mapping server name to config,
|
|
|
|
|
matching the Gateway API ``McpConfigResponse`` schema.
|
2026-02-28 14:38:15 +08:00
|
|
|
"""
|
|
|
|
|
config = get_extensions_config()
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
return {"mcp_servers": {name: server.model_dump() for name, server in config.mcp_servers.items()}}
|
2026-02-28 14:38:15 +08:00
|
|
|
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
def update_mcp_config(self, mcp_servers: dict[str, dict]) -> dict:
|
2026-02-28 14:38:15 +08:00
|
|
|
"""Update MCP server configurations.
|
|
|
|
|
|
|
|
|
|
Writes to extensions_config.json and reloads the cache.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
mcp_servers: Dict mapping server name to config dict.
|
|
|
|
|
Each value should contain keys like enabled, type, command, args, env, url, etc.
|
|
|
|
|
|
|
|
|
|
Returns:
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
Dict with "mcp_servers" key, matching the Gateway API
|
|
|
|
|
``McpConfigResponse`` schema.
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
Raises:
|
|
|
|
|
OSError: If the config file cannot be written.
|
|
|
|
|
"""
|
|
|
|
|
config_path = ExtensionsConfig.resolve_config_path()
|
|
|
|
|
if config_path is None:
|
2026-03-07 21:07:21 +08:00
|
|
|
raise FileNotFoundError("Cannot locate extensions_config.json. Set DEER_FLOW_EXTENSIONS_CONFIG_PATH or ensure it exists in the project root.")
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
current_config = get_extensions_config()
|
|
|
|
|
|
|
|
|
|
config_data = {
|
|
|
|
|
"mcpServers": mcp_servers,
|
|
|
|
|
"skills": {name: {"enabled": skill.enabled} for name, skill in current_config.skills.items()},
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
self._atomic_write_json(config_path, config_data)
|
|
|
|
|
|
|
|
|
|
self._agent = None
|
|
|
|
|
reloaded = reload_extensions_config()
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
return {"mcp_servers": {name: server.model_dump() for name, server in reloaded.mcp_servers.items()}}
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
# Public API — skills management
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
def get_skill(self, name: str) -> dict | None:
|
|
|
|
|
"""Get a specific skill by name.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
name: Skill name.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
Skill info dict, or None if not found.
|
|
|
|
|
"""
|
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>
2026-03-14 22:55:52 +08:00
|
|
|
from deerflow.skills.loader import load_skills
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
skill = next((s for s in load_skills(enabled_only=False) if s.name == name), None)
|
|
|
|
|
if skill is None:
|
|
|
|
|
return None
|
|
|
|
|
return {
|
|
|
|
|
"name": skill.name,
|
|
|
|
|
"description": skill.description,
|
|
|
|
|
"license": skill.license,
|
|
|
|
|
"category": skill.category,
|
|
|
|
|
"enabled": skill.enabled,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
def update_skill(self, name: str, *, enabled: bool) -> dict:
|
|
|
|
|
"""Update a skill's enabled status.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
name: Skill name.
|
|
|
|
|
enabled: New enabled status.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
Updated skill info dict.
|
|
|
|
|
|
|
|
|
|
Raises:
|
|
|
|
|
ValueError: If the skill is not found.
|
|
|
|
|
OSError: If the config file cannot be written.
|
|
|
|
|
"""
|
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>
2026-03-14 22:55:52 +08:00
|
|
|
from deerflow.skills.loader import load_skills
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
skills = load_skills(enabled_only=False)
|
|
|
|
|
skill = next((s for s in skills if s.name == name), None)
|
|
|
|
|
if skill is None:
|
|
|
|
|
raise ValueError(f"Skill '{name}' not found")
|
|
|
|
|
|
|
|
|
|
config_path = ExtensionsConfig.resolve_config_path()
|
|
|
|
|
if config_path is None:
|
2026-03-07 21:07:21 +08:00
|
|
|
raise FileNotFoundError("Cannot locate extensions_config.json. Set DEER_FLOW_EXTENSIONS_CONFIG_PATH or ensure it exists in the project root.")
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
extensions_config = get_extensions_config()
|
|
|
|
|
extensions_config.skills[name] = SkillStateConfig(enabled=enabled)
|
|
|
|
|
|
|
|
|
|
config_data = {
|
|
|
|
|
"mcpServers": {n: s.model_dump() for n, s in extensions_config.mcp_servers.items()},
|
|
|
|
|
"skills": {n: {"enabled": sc.enabled} for n, sc in extensions_config.skills.items()},
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
self._atomic_write_json(config_path, config_data)
|
|
|
|
|
|
|
|
|
|
self._agent = None
|
|
|
|
|
reload_extensions_config()
|
|
|
|
|
|
|
|
|
|
updated = next((s for s in load_skills(enabled_only=False) if s.name == name), None)
|
|
|
|
|
if updated is None:
|
|
|
|
|
raise RuntimeError(f"Skill '{name}' disappeared after update")
|
|
|
|
|
return {
|
|
|
|
|
"name": updated.name,
|
|
|
|
|
"description": updated.description,
|
|
|
|
|
"license": updated.license,
|
|
|
|
|
"category": updated.category,
|
|
|
|
|
"enabled": updated.enabled,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
def install_skill(self, skill_path: str | Path) -> dict:
|
|
|
|
|
"""Install a skill from a .skill archive (ZIP).
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
skill_path: Path to the .skill file.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
Dict with success, skill_name, message.
|
|
|
|
|
|
|
|
|
|
Raises:
|
|
|
|
|
FileNotFoundError: If the file does not exist.
|
|
|
|
|
ValueError: If the file is invalid.
|
|
|
|
|
"""
|
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>
2026-03-14 22:55:52 +08:00
|
|
|
from deerflow.skills.loader import get_skills_root_path
|
|
|
|
|
from deerflow.skills.validation import _validate_skill_frontmatter
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
path = Path(skill_path)
|
|
|
|
|
if not path.exists():
|
|
|
|
|
raise FileNotFoundError(f"Skill file not found: {skill_path}")
|
|
|
|
|
if not path.is_file():
|
|
|
|
|
raise ValueError(f"Path is not a file: {skill_path}")
|
|
|
|
|
if path.suffix != ".skill":
|
|
|
|
|
raise ValueError("File must have .skill extension")
|
|
|
|
|
if not zipfile.is_zipfile(path):
|
|
|
|
|
raise ValueError("File is not a valid ZIP archive")
|
|
|
|
|
|
|
|
|
|
skills_root = get_skills_root_path()
|
|
|
|
|
custom_dir = skills_root / "custom"
|
|
|
|
|
custom_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
|
|
|
|
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
|
|
|
tmp_path = Path(tmp)
|
|
|
|
|
with zipfile.ZipFile(path, "r") as zf:
|
|
|
|
|
total_size = sum(info.file_size for info in zf.infolist())
|
|
|
|
|
if total_size > 100 * 1024 * 1024:
|
|
|
|
|
raise ValueError("Skill archive too large when extracted (>100MB)")
|
|
|
|
|
for info in zf.infolist():
|
|
|
|
|
if Path(info.filename).is_absolute() or ".." in Path(info.filename).parts:
|
|
|
|
|
raise ValueError(f"Unsafe path in archive: {info.filename}")
|
|
|
|
|
zf.extractall(tmp_path)
|
|
|
|
|
for p in tmp_path.rglob("*"):
|
|
|
|
|
if p.is_symlink():
|
|
|
|
|
p.unlink()
|
|
|
|
|
|
|
|
|
|
items = list(tmp_path.iterdir())
|
|
|
|
|
if not items:
|
|
|
|
|
raise ValueError("Skill archive is empty")
|
|
|
|
|
|
|
|
|
|
skill_dir = items[0] if len(items) == 1 and items[0].is_dir() else tmp_path
|
|
|
|
|
|
|
|
|
|
is_valid, message, skill_name = _validate_skill_frontmatter(skill_dir)
|
|
|
|
|
if not is_valid:
|
|
|
|
|
raise ValueError(f"Invalid skill: {message}")
|
|
|
|
|
if not re.fullmatch(r"[a-zA-Z0-9_-]+", skill_name):
|
|
|
|
|
raise ValueError(f"Invalid skill name: {skill_name}")
|
|
|
|
|
|
|
|
|
|
target = custom_dir / skill_name
|
|
|
|
|
if target.exists():
|
|
|
|
|
raise ValueError(f"Skill '{skill_name}' already exists")
|
|
|
|
|
|
|
|
|
|
shutil.copytree(skill_dir, target)
|
|
|
|
|
|
|
|
|
|
return {"success": True, "skill_name": skill_name, "message": f"Skill '{skill_name}' installed successfully"}
|
|
|
|
|
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
# Public API — memory management
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
def reload_memory(self) -> dict:
|
|
|
|
|
"""Reload memory data from file, forcing cache invalidation.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
The reloaded memory data dict.
|
|
|
|
|
"""
|
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>
2026-03-14 22:55:52 +08:00
|
|
|
from deerflow.agents.memory.updater import reload_memory_data
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
return reload_memory_data()
|
|
|
|
|
|
|
|
|
|
def get_memory_config(self) -> dict:
|
|
|
|
|
"""Get memory system configuration.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
Memory config dict.
|
|
|
|
|
"""
|
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>
2026-03-14 22:55:52 +08:00
|
|
|
from deerflow.config.memory_config import get_memory_config
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
config = get_memory_config()
|
|
|
|
|
return {
|
|
|
|
|
"enabled": config.enabled,
|
|
|
|
|
"storage_path": config.storage_path,
|
|
|
|
|
"debounce_seconds": config.debounce_seconds,
|
|
|
|
|
"max_facts": config.max_facts,
|
|
|
|
|
"fact_confidence_threshold": config.fact_confidence_threshold,
|
|
|
|
|
"injection_enabled": config.injection_enabled,
|
|
|
|
|
"max_injection_tokens": config.max_injection_tokens,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
def get_memory_status(self) -> dict:
|
|
|
|
|
"""Get memory status: config + current data.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
Dict with "config" and "data" keys.
|
|
|
|
|
"""
|
|
|
|
|
return {
|
|
|
|
|
"config": self.get_memory_config(),
|
|
|
|
|
"data": self.get_memory(),
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
# Public API — file uploads
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
|
def _get_uploads_dir(thread_id: str) -> Path:
|
|
|
|
|
"""Get (and create) the uploads directory for a thread."""
|
|
|
|
|
base = get_paths().sandbox_uploads_dir(thread_id)
|
|
|
|
|
base.mkdir(parents=True, exist_ok=True)
|
|
|
|
|
return base
|
|
|
|
|
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
def upload_files(self, thread_id: str, files: list[str | Path]) -> dict:
|
2026-02-28 14:38:15 +08:00
|
|
|
"""Upload local files into a thread's uploads directory.
|
|
|
|
|
|
|
|
|
|
For PDF, PPT, Excel, and Word files, they are also converted to Markdown.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
thread_id: Target thread ID.
|
|
|
|
|
files: List of local file paths to upload.
|
|
|
|
|
|
|
|
|
|
Returns:
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
Dict with success, files, message — matching the Gateway API
|
|
|
|
|
``UploadResponse`` schema.
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
Raises:
|
|
|
|
|
FileNotFoundError: If any file does not exist.
|
2026-03-11 15:17:31 +08:00
|
|
|
ValueError: If any supplied path exists but is not a regular file.
|
2026-02-28 14:38:15 +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>
2026-03-14 22:55:52 +08:00
|
|
|
from deerflow.utils.file_conversion import CONVERTIBLE_EXTENSIONS, convert_file_to_markdown
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
# Validate all files upfront to avoid partial uploads.
|
|
|
|
|
resolved_files = []
|
2026-03-11 15:17:31 +08:00
|
|
|
convertible_extensions = {ext.lower() for ext in CONVERTIBLE_EXTENSIONS}
|
|
|
|
|
has_convertible_file = False
|
2026-02-28 14:38:15 +08:00
|
|
|
for f in files:
|
|
|
|
|
p = Path(f)
|
|
|
|
|
if not p.exists():
|
|
|
|
|
raise FileNotFoundError(f"File not found: {f}")
|
2026-03-11 15:17:31 +08:00
|
|
|
if not p.is_file():
|
|
|
|
|
raise ValueError(f"Path is not a file: {f}")
|
2026-02-28 14:38:15 +08:00
|
|
|
resolved_files.append(p)
|
2026-03-11 15:17:31 +08:00
|
|
|
if not has_convertible_file and p.suffix.lower() in convertible_extensions:
|
|
|
|
|
has_convertible_file = True
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
uploads_dir = self._get_uploads_dir(thread_id)
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
uploaded_files: list[dict] = []
|
2026-02-28 14:38:15 +08:00
|
|
|
|
2026-03-11 15:17:31 +08:00
|
|
|
conversion_pool = None
|
|
|
|
|
if has_convertible_file:
|
|
|
|
|
try:
|
|
|
|
|
asyncio.get_running_loop()
|
|
|
|
|
except RuntimeError:
|
|
|
|
|
conversion_pool = None
|
|
|
|
|
else:
|
|
|
|
|
import concurrent.futures
|
2026-02-28 14:38:15 +08:00
|
|
|
|
2026-03-11 15:17:31 +08:00
|
|
|
# Reuse one worker when already inside an event loop to avoid
|
|
|
|
|
# creating a new ThreadPoolExecutor per converted file.
|
|
|
|
|
conversion_pool = concurrent.futures.ThreadPoolExecutor(max_workers=1)
|
2026-02-28 14:38:15 +08:00
|
|
|
|
2026-03-11 15:17:31 +08:00
|
|
|
def _convert_in_thread(path: Path):
|
|
|
|
|
return asyncio.run(convert_file_to_markdown(path))
|
2026-03-07 21:07:21 +08:00
|
|
|
|
2026-03-11 15:17:31 +08:00
|
|
|
try:
|
|
|
|
|
for src_path in resolved_files:
|
|
|
|
|
dest = uploads_dir / src_path.name
|
|
|
|
|
shutil.copy2(src_path, dest)
|
|
|
|
|
|
|
|
|
|
info: dict[str, Any] = {
|
|
|
|
|
"filename": src_path.name,
|
|
|
|
|
"size": str(dest.stat().st_size),
|
|
|
|
|
"path": str(dest),
|
|
|
|
|
"virtual_path": f"/mnt/user-data/uploads/{src_path.name}",
|
|
|
|
|
"artifact_url": f"/api/threads/{thread_id}/artifacts/mnt/user-data/uploads/{src_path.name}",
|
|
|
|
|
}
|
2026-02-28 14:38:15 +08:00
|
|
|
|
2026-03-11 15:17:31 +08:00
|
|
|
if src_path.suffix.lower() in convertible_extensions:
|
|
|
|
|
try:
|
|
|
|
|
if conversion_pool is not None:
|
|
|
|
|
md_path = conversion_pool.submit(_convert_in_thread, dest).result()
|
|
|
|
|
else:
|
|
|
|
|
md_path = asyncio.run(convert_file_to_markdown(dest))
|
|
|
|
|
except Exception:
|
|
|
|
|
logger.warning(
|
|
|
|
|
"Failed to convert %s to markdown",
|
|
|
|
|
src_path.name,
|
|
|
|
|
exc_info=True,
|
|
|
|
|
)
|
|
|
|
|
md_path = None
|
2026-02-28 14:38:15 +08:00
|
|
|
|
2026-03-11 15:17:31 +08:00
|
|
|
if md_path is not None:
|
|
|
|
|
info["markdown_file"] = md_path.name
|
|
|
|
|
info["markdown_virtual_path"] = f"/mnt/user-data/uploads/{md_path.name}"
|
|
|
|
|
info["markdown_artifact_url"] = f"/api/threads/{thread_id}/artifacts/mnt/user-data/uploads/{md_path.name}"
|
|
|
|
|
|
|
|
|
|
uploaded_files.append(info)
|
|
|
|
|
finally:
|
|
|
|
|
if conversion_pool is not None:
|
|
|
|
|
conversion_pool.shutdown(wait=True)
|
2026-02-28 14:38:15 +08:00
|
|
|
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
return {
|
|
|
|
|
"success": True,
|
|
|
|
|
"files": uploaded_files,
|
|
|
|
|
"message": f"Successfully uploaded {len(uploaded_files)} file(s)",
|
|
|
|
|
}
|
2026-02-28 14:38:15 +08:00
|
|
|
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
def list_uploads(self, thread_id: str) -> dict:
|
2026-02-28 14:38:15 +08:00
|
|
|
"""List files in a thread's uploads directory.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
thread_id: Thread ID.
|
|
|
|
|
|
|
|
|
|
Returns:
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
Dict with "files" and "count" keys, matching the Gateway API
|
|
|
|
|
``list_uploaded_files`` response.
|
2026-02-28 14:38:15 +08:00
|
|
|
"""
|
|
|
|
|
uploads_dir = self._get_uploads_dir(thread_id)
|
|
|
|
|
if not uploads_dir.exists():
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
return {"files": [], "count": 0}
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
files = []
|
2026-03-11 15:17:31 +08:00
|
|
|
with os.scandir(uploads_dir) as entries:
|
|
|
|
|
file_entries = [entry for entry in entries if entry.is_file()]
|
|
|
|
|
|
|
|
|
|
for entry in sorted(file_entries, key=lambda item: item.name):
|
|
|
|
|
stat = entry.stat()
|
|
|
|
|
filename = entry.name
|
|
|
|
|
files.append(
|
|
|
|
|
{
|
|
|
|
|
"filename": filename,
|
|
|
|
|
"size": str(stat.st_size),
|
|
|
|
|
"path": str(Path(entry.path)),
|
|
|
|
|
"virtual_path": f"/mnt/user-data/uploads/{filename}",
|
|
|
|
|
"artifact_url": f"/api/threads/{thread_id}/artifacts/mnt/user-data/uploads/{filename}",
|
|
|
|
|
"extension": Path(filename).suffix,
|
|
|
|
|
"modified": stat.st_mtime,
|
|
|
|
|
}
|
|
|
|
|
)
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
return {"files": files, "count": len(files)}
|
2026-02-28 14:38:15 +08:00
|
|
|
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
def delete_upload(self, thread_id: str, filename: str) -> dict:
|
2026-02-28 14:38:15 +08:00
|
|
|
"""Delete a file from a thread's uploads directory.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
thread_id: Thread ID.
|
|
|
|
|
filename: Filename to delete.
|
|
|
|
|
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
Returns:
|
|
|
|
|
Dict with success and message, matching the Gateway API
|
|
|
|
|
``delete_uploaded_file`` response.
|
|
|
|
|
|
2026-02-28 14:38:15 +08:00
|
|
|
Raises:
|
|
|
|
|
FileNotFoundError: If the file does not exist.
|
|
|
|
|
PermissionError: If path traversal is detected.
|
|
|
|
|
"""
|
|
|
|
|
uploads_dir = self._get_uploads_dir(thread_id)
|
|
|
|
|
file_path = (uploads_dir / filename).resolve()
|
|
|
|
|
|
|
|
|
|
try:
|
|
|
|
|
file_path.relative_to(uploads_dir.resolve())
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
except ValueError as exc:
|
|
|
|
|
raise PermissionError("Access denied: path traversal detected") from exc
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
if not file_path.is_file():
|
|
|
|
|
raise FileNotFoundError(f"File not found: {filename}")
|
|
|
|
|
|
|
|
|
|
file_path.unlink()
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
return {"success": True, "message": f"Deleted {filename}"}
|
2026-02-28 14:38:15 +08:00
|
|
|
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
# Public API — artifacts
|
|
|
|
|
# ------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
def get_artifact(self, thread_id: str, path: str) -> tuple[bytes, str]:
|
|
|
|
|
"""Read an artifact file produced by the agent.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
thread_id: Thread ID.
|
|
|
|
|
path: Virtual path (e.g. "mnt/user-data/outputs/file.txt").
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
Tuple of (file_bytes, mime_type).
|
|
|
|
|
|
|
|
|
|
Raises:
|
|
|
|
|
FileNotFoundError: If the artifact does not exist.
|
|
|
|
|
ValueError: If the path is invalid.
|
|
|
|
|
"""
|
|
|
|
|
virtual_prefix = "mnt/user-data"
|
|
|
|
|
clean_path = path.lstrip("/")
|
|
|
|
|
if not clean_path.startswith(virtual_prefix):
|
|
|
|
|
raise ValueError(f"Path must start with /{virtual_prefix}")
|
|
|
|
|
|
2026-03-07 21:07:21 +08:00
|
|
|
relative = clean_path[len(virtual_prefix) :].lstrip("/")
|
2026-02-28 14:38:15 +08:00
|
|
|
base_dir = get_paths().sandbox_user_data_dir(thread_id)
|
|
|
|
|
actual = (base_dir / relative).resolve()
|
|
|
|
|
|
|
|
|
|
try:
|
|
|
|
|
actual.relative_to(base_dir.resolve())
|
test: add Gateway conformance tests for DeerFlowClient (#931)
Validate that all dict-returning client methods conform to Gateway
Pydantic response models (ModelsListResponse, ModelResponse,
SkillsListResponse, SkillResponse, SkillInstallResponse,
McpConfigResponse, UploadResponse, MemoryConfigResponse,
MemoryStatusResponse). Pydantic ValidationError in CI catches
schema drift between client and Gateway with zero production coupling.
Also includes prior review fixes: enhanced client methods, expanded
unit tests (67→77), live integration test improvements, and updated
documentation.
Co-authored-by: greatmengqi <chenmengqi.0376@bytedance.com>
2026-02-28 16:08:04 +08:00
|
|
|
except ValueError as exc:
|
|
|
|
|
raise PermissionError("Access denied: path traversal detected") from exc
|
2026-02-28 14:38:15 +08:00
|
|
|
if not actual.exists():
|
|
|
|
|
raise FileNotFoundError(f"Artifact not found: {path}")
|
|
|
|
|
if not actual.is_file():
|
|
|
|
|
raise ValueError(f"Path is not a file: {path}")
|
|
|
|
|
|
|
|
|
|
mime_type, _ = mimetypes.guess_type(actual)
|
|
|
|
|
return actual.read_bytes(), mime_type or "application/octet-stream"
|