deer-flow/backend/tests/test_converters.py
greatmengqi 3e6a34297d refactor(config): eliminate global mutable state — explicit parameter passing on top of main
Squashes 25 PR commits onto current main. AppConfig becomes a pure value
object with no ambient lookup. Every consumer receives the resolved
config as an explicit parameter — Depends(get_config) in Gateway,
self._app_config in DeerFlowClient, runtime.context.app_config in agent
runs, AppConfig.from_file() at the LangGraph Server registration
boundary.

Phase 1 — frozen data + typed context

- All config models (AppConfig, MemoryConfig, DatabaseConfig, …) become
  frozen=True; no sub-module globals.
- AppConfig.from_file() is pure (no side-effect singleton loaders).
- Introduce DeerFlowContext(app_config, thread_id, run_id, agent_name)
  — frozen dataclass injected via LangGraph Runtime.
- Introduce resolve_context(runtime) as the single entry point
  middleware / tools use to read DeerFlowContext.

Phase 2 — pure explicit parameter passing

- Gateway: app.state.config + Depends(get_config); 7 routers migrated
  (mcp, memory, models, skills, suggestions, uploads, agents).
- DeerFlowClient: __init__(config=...) captures config locally.
- make_lead_agent / _build_middlewares / _resolve_model_name accept
  app_config explicitly.
- RunContext.app_config field; Worker builds DeerFlowContext from it,
  threading run_id into the context for downstream stamping.
- Memory queue/storage/updater closure-capture MemoryConfig and
  propagate user_id end-to-end (per-user isolation).
- Sandbox/skills/community/factories/tools thread app_config.
- resolve_context() rejects non-typed runtime.context.
- Test suite migrated off AppConfig.current() monkey-patches.
- AppConfig.current() classmethod deleted.

Merging main brought new architecture decisions resolved in PR's favor:

- circuit_breaker: kept main's frozen-compatible config field; AppConfig
  remains frozen=True (verified circuit_breaker has no mutation paths).
- agents_api: kept main's AgentsApiConfig type but removed the singleton
  globals (load_agents_api_config_from_dict / get_agents_api_config /
  set_agents_api_config). 8 routes in agents.py now read via
  Depends(get_config).
- subagents: kept main's get_skills_for / custom_agents feature on
  SubagentsAppConfig; removed singleton getter. registry.py now reads
  app_config.subagents directly.
- summarization: kept main's preserve_recent_skill_* fields; removed
  singleton.
- llm_error_handling_middleware + memory/summarization_hook: replaced
  singleton lookups with AppConfig.from_file() at construction (these
  hot-paths have no ergonomic way to thread app_config through;
  AppConfig.from_file is a pure load).
- worker.py + thread_data_middleware.py: DeerFlowContext.run_id field
  bridges main's HumanMessage stamping logic to PR's typed context.

Trade-offs (follow-up work):

- main's #2138 (async memory updater) reverted to PR's sync
  implementation. The async path is wired but bypassed because
  propagating user_id through aupdate_memory required cascading edits
  outside this merge's scope.
- tests/test_subagent_skills_config.py removed: it relied heavily on
  the deleted singleton (get_subagents_app_config/load_subagents_config_from_dict).
  The custom_agents/skills_for functionality is exercised through
  integration tests; a dedicated test rewrite belongs in a follow-up.

Verification: backend test suite — 2560 passed, 4 skipped, 84 failures.
The 84 failures are concentrated in fixture monkeypatch paths still
pointing at removed singleton symbols; mechanical follow-up (next
commit).
2026-04-26 21:45:02 +08:00

189 lines
6.8 KiB
Python

"""Tests for LangChain-to-OpenAI message format converters."""
from __future__ import annotations
import json
from unittest.mock import MagicMock
from deerflow.runtime.converters import (
langchain_messages_to_openai,
langchain_to_openai_completion,
langchain_to_openai_message,
)
def _make_ai_message(content="", tool_calls=None, id="msg-123", usage_metadata=None, response_metadata=None):
msg = MagicMock()
msg.type = "ai"
msg.content = content
msg.tool_calls = tool_calls or []
msg.id = id
msg.usage_metadata = usage_metadata
msg.response_metadata = response_metadata or {}
return msg
def _make_human_message(content="Hello"):
msg = MagicMock()
msg.type = "human"
msg.content = content
return msg
def _make_system_message(content="You are an assistant."):
msg = MagicMock()
msg.type = "system"
msg.content = content
return msg
def _make_tool_message(content="result", tool_call_id="call-abc"):
msg = MagicMock()
msg.type = "tool"
msg.content = content
msg.tool_call_id = tool_call_id
return msg
class TestLangchainToOpenaiMessage:
def test_ai_message_text_only(self):
msg = _make_ai_message(content="Hello world")
result = langchain_to_openai_message(msg)
assert result["role"] == "assistant"
assert result["content"] == "Hello world"
assert "tool_calls" not in result
def test_ai_message_with_tool_calls(self):
tool_calls = [
{"id": "call-1", "name": "bash", "args": {"command": "ls"}},
]
msg = _make_ai_message(content="", tool_calls=tool_calls)
result = langchain_to_openai_message(msg)
assert result["role"] == "assistant"
assert result["content"] is None
assert len(result["tool_calls"]) == 1
tc = result["tool_calls"][0]
assert tc["id"] == "call-1"
assert tc["type"] == "function"
assert tc["function"]["name"] == "bash"
# arguments must be a JSON string
args = json.loads(tc["function"]["arguments"])
assert args == {"command": "ls"}
def test_ai_message_text_and_tool_calls(self):
tool_calls = [
{"id": "call-2", "name": "read_file", "args": {"path": "/tmp/x"}},
]
msg = _make_ai_message(content="Reading the file", tool_calls=tool_calls)
result = langchain_to_openai_message(msg)
assert result["role"] == "assistant"
assert result["content"] == "Reading the file"
assert len(result["tool_calls"]) == 1
def test_ai_message_empty_content_no_tools(self):
msg = _make_ai_message(content="")
result = langchain_to_openai_message(msg)
assert result["role"] == "assistant"
assert result["content"] == ""
assert "tool_calls" not in result
def test_ai_message_list_content(self):
# Multimodal content is preserved as-is
list_content = [
{"type": "text", "text": "Here is an image"},
{"type": "image_url", "image_url": {"url": "data:image/png;base64,abc"}},
]
msg = _make_ai_message(content=list_content)
result = langchain_to_openai_message(msg)
assert result["role"] == "assistant"
assert result["content"] == list_content
def test_human_message(self):
msg = _make_human_message("Tell me a joke")
result = langchain_to_openai_message(msg)
assert result["role"] == "user"
assert result["content"] == "Tell me a joke"
def test_tool_message(self):
msg = _make_tool_message(content="file contents here", tool_call_id="call-xyz")
result = langchain_to_openai_message(msg)
assert result["role"] == "tool"
assert result["tool_call_id"] == "call-xyz"
assert result["content"] == "file contents here"
def test_system_message(self):
msg = _make_system_message("You are a helpful assistant.")
result = langchain_to_openai_message(msg)
assert result["role"] == "system"
assert result["content"] == "You are a helpful assistant."
class TestLangchainToOpenaiCompletion:
def test_basic_completion(self):
usage_metadata = {"input_tokens": 10, "output_tokens": 20}
msg = _make_ai_message(
content="Hello",
id="msg-abc",
usage_metadata=usage_metadata,
response_metadata={"model_name": "gpt-4o", "finish_reason": "stop"},
)
result = langchain_to_openai_completion(msg)
assert result["id"] == "msg-abc"
assert result["model"] == "gpt-4o"
assert len(result["choices"]) == 1
choice = result["choices"][0]
assert choice["index"] == 0
assert choice["finish_reason"] == "stop"
assert choice["message"]["role"] == "assistant"
assert choice["message"]["content"] == "Hello"
assert result["usage"] is not None
assert result["usage"]["prompt_tokens"] == 10
assert result["usage"]["completion_tokens"] == 20
assert result["usage"]["total_tokens"] == 30
def test_completion_with_tool_calls(self):
tool_calls = [{"id": "call-1", "name": "bash", "args": {}}]
msg = _make_ai_message(
content="",
tool_calls=tool_calls,
id="msg-tc",
response_metadata={"model_name": "gpt-4o"},
)
result = langchain_to_openai_completion(msg)
assert result["choices"][0]["finish_reason"] == "tool_calls"
def test_completion_no_usage(self):
msg = _make_ai_message(content="Hi", id="msg-nousage", usage_metadata=None)
result = langchain_to_openai_completion(msg)
assert result["usage"] is None
def test_finish_reason_from_response_metadata(self):
msg = _make_ai_message(
content="Done",
id="msg-fr",
response_metadata={"model_name": "claude-3", "finish_reason": "end_turn"},
)
result = langchain_to_openai_completion(msg)
assert result["choices"][0]["finish_reason"] == "end_turn"
def test_finish_reason_default_stop(self):
msg = _make_ai_message(content="Done", id="msg-defstop", response_metadata={})
result = langchain_to_openai_completion(msg)
assert result["choices"][0]["finish_reason"] == "stop"
class TestMessagesToOpenai:
def test_convert_message_list(self):
human = _make_human_message("Hi")
ai = _make_ai_message(content="Hello!")
tool_msg = _make_tool_message("result", "call-1")
messages = [human, ai, tool_msg]
result = langchain_messages_to_openai(messages)
assert len(result) == 3
assert result[0]["role"] == "user"
assert result[1]["role"] == "assistant"
assert result[2]["role"] == "tool"
def test_empty_list(self):
assert langchain_messages_to_openai([]) == []