Files
2026-07-13 11:59:58 +08:00

1349 lines
49 KiB
Python

"""Tests for deerflow.models.factory.create_chat_model."""
from __future__ import annotations
import pytest
from langchain.chat_models import BaseChatModel
from deerflow.config.app_config import AppConfig
from deerflow.config.model_config import ModelConfig
from deerflow.config.sandbox_config import SandboxConfig
from deerflow.models import factory as factory_module
from deerflow.models import openai_codex_provider as codex_provider_module
# ---------------------------------------------------------------------------
# Helpers
# ---------------------------------------------------------------------------
def _make_app_config(models: list[ModelConfig]) -> AppConfig:
return AppConfig(
models=models,
sandbox=SandboxConfig(use="deerflow.sandbox.local:LocalSandboxProvider"),
)
def _make_model(
name: str = "test-model",
*,
use: str = "langchain_openai:ChatOpenAI",
supports_thinking: bool = False,
supports_reasoning_effort: bool = False,
when_thinking_enabled: dict | None = None,
when_thinking_disabled: dict | None = None,
thinking: dict | None = None,
max_tokens: int | None = None,
) -> ModelConfig:
return ModelConfig(
name=name,
display_name=name,
description=None,
use=use,
model=name,
max_tokens=max_tokens,
supports_thinking=supports_thinking,
supports_reasoning_effort=supports_reasoning_effort,
when_thinking_enabled=when_thinking_enabled,
when_thinking_disabled=when_thinking_disabled,
thinking=thinking,
supports_vision=False,
)
class FakeChatModel(BaseChatModel):
"""Minimal BaseChatModel stub that records the kwargs it was called with."""
captured_kwargs: dict = {}
def __init__(self, **kwargs):
# Store kwargs before pydantic processes them
FakeChatModel.captured_kwargs = dict(kwargs)
super().__init__(**kwargs)
@property
def _llm_type(self) -> str:
return "fake"
def _generate(self, *args, **kwargs): # type: ignore[override]
raise NotImplementedError
def _stream(self, *args, **kwargs): # type: ignore[override]
raise NotImplementedError
def _patch_factory(monkeypatch, app_config: AppConfig, model_class=FakeChatModel):
"""Patch get_app_config, resolve_class, and tracing for isolated unit tests."""
monkeypatch.setattr(factory_module, "get_app_config", lambda: app_config)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: model_class)
monkeypatch.setattr(factory_module, "build_tracing_callbacks", lambda: [])
# ---------------------------------------------------------------------------
# Model selection
# ---------------------------------------------------------------------------
def test_uses_first_model_when_name_is_none(monkeypatch):
cfg = _make_app_config([_make_model("alpha"), _make_model("beta")])
_patch_factory(monkeypatch, cfg)
FakeChatModel.captured_kwargs = {}
factory_module.create_chat_model(name=None)
# resolve_class is called — if we reach here without ValueError, the correct model was used
assert FakeChatModel.captured_kwargs.get("model") == "alpha"
def test_raises_when_model_not_found(monkeypatch):
cfg = _make_app_config([_make_model("only-model")])
monkeypatch.setattr(factory_module, "get_app_config", lambda: cfg)
monkeypatch.setattr(factory_module, "build_tracing_callbacks", lambda: [])
with pytest.raises(ValueError, match="ghost-model"):
factory_module.create_chat_model(name="ghost-model")
def test_pricing_metadata_never_reaches_the_provider_client(monkeypatch):
"""`models[*].pricing` is console-only metadata (issue: ChatOpenAI forwards
unknown kwargs into the completion request payload, so an un-stripped
`pricing` block breaks every live LLM call with
``Completions.create() got an unexpected keyword argument 'pricing'``)."""
model = _make_model("priced")
# ModelConfig is extra="allow" — pricing rides along as an extra field.
model.pricing = {"currency": "CNY", "input_per_million": 8, "output_per_million": 32, "input_cache_hit_per_million": 0.8}
cfg = _make_app_config([model])
_patch_factory(monkeypatch, cfg)
FakeChatModel.captured_kwargs = {}
factory_module.create_chat_model(name="priced")
assert "pricing" not in FakeChatModel.captured_kwargs
def test_appends_all_tracing_callbacks(monkeypatch):
cfg = _make_app_config([_make_model("alpha")])
_patch_factory(monkeypatch, cfg)
monkeypatch.setattr(factory_module, "build_tracing_callbacks", lambda: ["smith-callback", "langfuse-callback"])
FakeChatModel.captured_kwargs = {}
model = factory_module.create_chat_model(name="alpha")
assert model.callbacks == ["smith-callback", "langfuse-callback"]
# ---------------------------------------------------------------------------
# thinking_enabled=True
# ---------------------------------------------------------------------------
def test_thinking_enabled_raises_when_not_supported_but_when_thinking_enabled_is_set(monkeypatch):
"""supports_thinking guard fires only when when_thinking_enabled is configured —
the factory uses that as the signal that the caller explicitly expects thinking to work."""
wte = {"thinking": {"type": "enabled", "budget_tokens": 5000}}
cfg = _make_app_config([_make_model("no-think", supports_thinking=False, when_thinking_enabled=wte)])
_patch_factory(monkeypatch, cfg)
with pytest.raises(ValueError, match="does not support thinking"):
factory_module.create_chat_model(name="no-think", thinking_enabled=True)
def test_thinking_enabled_raises_for_empty_when_thinking_enabled_explicitly_set(monkeypatch):
"""supports_thinking guard fires when when_thinking_enabled is set to an empty dict —
the user explicitly provided the section, so the guard must still fire even though
effective_wte would be falsy."""
cfg = _make_app_config([_make_model("no-think-empty", supports_thinking=False, when_thinking_enabled={})])
_patch_factory(monkeypatch, cfg)
with pytest.raises(ValueError, match="does not support thinking"):
factory_module.create_chat_model(name="no-think-empty", thinking_enabled=True)
def test_thinking_enabled_merges_when_thinking_enabled_settings(monkeypatch):
wte = {"temperature": 1.0, "max_tokens": 16000}
cfg = _make_app_config([_make_model("thinker", supports_thinking=True, when_thinking_enabled=wte)])
_patch_factory(monkeypatch, cfg)
FakeChatModel.captured_kwargs = {}
factory_module.create_chat_model(name="thinker", thinking_enabled=True)
assert FakeChatModel.captured_kwargs.get("temperature") == 1.0
assert FakeChatModel.captured_kwargs.get("max_tokens") == 16000
# ---------------------------------------------------------------------------
# thinking_enabled=False — disable logic
# ---------------------------------------------------------------------------
def test_thinking_disabled_openai_gateway_format(monkeypatch):
"""When thinking is configured via extra_body (OpenAI-compatible gateway),
disabling must inject extra_body.thinking.type=disabled and reasoning_effort=minimal."""
wte = {"extra_body": {"thinking": {"type": "enabled", "budget_tokens": 10000}}}
cfg = _make_app_config(
[
_make_model(
"openai-gw",
supports_thinking=True,
supports_reasoning_effort=True,
when_thinking_enabled=wte,
)
]
)
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="openai-gw", thinking_enabled=False)
assert captured.get("extra_body") == {"thinking": {"type": "disabled"}}
assert captured.get("reasoning_effort") == "minimal"
assert "thinking" not in captured # must NOT set the direct thinking param
def test_thinking_disabled_langchain_anthropic_format(monkeypatch):
"""When thinking is configured as a direct param (langchain_anthropic),
disabling must inject thinking.type=disabled WITHOUT touching extra_body or reasoning_effort."""
wte = {"thinking": {"type": "enabled", "budget_tokens": 8000}}
cfg = _make_app_config(
[
_make_model(
"anthropic-native",
use="langchain_anthropic:ChatAnthropic",
supports_thinking=True,
supports_reasoning_effort=False,
when_thinking_enabled=wte,
)
]
)
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="anthropic-native", thinking_enabled=False)
assert captured.get("thinking") == {"type": "disabled"}
assert "extra_body" not in captured
# reasoning_effort must be cleared (supports_reasoning_effort=False)
assert captured.get("reasoning_effort") is None
def test_thinking_disabled_no_when_thinking_enabled_does_nothing(monkeypatch):
"""If when_thinking_enabled is not set, disabling thinking must not inject any kwargs."""
cfg = _make_app_config([_make_model("plain", supports_thinking=True, when_thinking_enabled=None)])
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="plain", thinking_enabled=False)
assert "extra_body" not in captured
assert "thinking" not in captured
# reasoning_effort not forced (supports_reasoning_effort defaults to False → cleared)
assert captured.get("reasoning_effort") is None
# ---------------------------------------------------------------------------
# when_thinking_disabled config
# ---------------------------------------------------------------------------
def test_when_thinking_disabled_takes_precedence_over_hardcoded_disable(monkeypatch):
"""When when_thinking_disabled is set, it takes full precedence over the
hardcoded disable logic (extra_body.thinking.type=disabled etc.)."""
wte = {"extra_body": {"thinking": {"type": "enabled", "budget_tokens": 10000}}}
wtd = {"extra_body": {"thinking": {"type": "disabled"}}, "reasoning_effort": "low"}
cfg = _make_app_config(
[
_make_model(
"custom-disable",
supports_thinking=True,
supports_reasoning_effort=True,
when_thinking_enabled=wte,
when_thinking_disabled=wtd,
)
]
)
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="custom-disable", thinking_enabled=False)
assert captured.get("extra_body") == {"thinking": {"type": "disabled"}}
# User overrode the hardcoded "minimal" with "low"
assert captured.get("reasoning_effort") == "low"
def test_when_thinking_disabled_not_used_when_thinking_enabled(monkeypatch):
"""when_thinking_disabled must have no effect when thinking_enabled=True."""
wte = {"extra_body": {"thinking": {"type": "enabled"}}}
wtd = {"extra_body": {"thinking": {"type": "disabled"}}}
cfg = _make_app_config(
[
_make_model(
"wtd-ignored",
supports_thinking=True,
when_thinking_enabled=wte,
when_thinking_disabled=wtd,
)
]
)
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="wtd-ignored", thinking_enabled=True)
# when_thinking_enabled should apply, NOT when_thinking_disabled
assert captured.get("extra_body") == {"thinking": {"type": "enabled"}}
def test_when_thinking_disabled_without_when_thinking_enabled_still_applies(monkeypatch):
"""when_thinking_disabled alone (no when_thinking_enabled) should still apply its settings."""
cfg = _make_app_config(
[
_make_model(
"wtd-only",
supports_thinking=True,
supports_reasoning_effort=True,
when_thinking_disabled={"reasoning_effort": "low"},
)
]
)
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="wtd-only", thinking_enabled=False)
# when_thinking_disabled is now gated independently of has_thinking_settings
assert captured.get("reasoning_effort") == "low"
def test_when_thinking_disabled_excluded_from_model_dump(monkeypatch):
"""when_thinking_disabled must not leak into the model constructor kwargs."""
wte = {"extra_body": {"thinking": {"type": "enabled"}}}
wtd = {"extra_body": {"thinking": {"type": "disabled"}}}
cfg = _make_app_config(
[
_make_model(
"no-leak-wtd",
supports_thinking=True,
when_thinking_enabled=wte,
when_thinking_disabled=wtd,
)
]
)
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="no-leak-wtd", thinking_enabled=True)
# when_thinking_disabled value must NOT appear as a raw key
assert "when_thinking_disabled" not in captured
# ---------------------------------------------------------------------------
# reasoning_effort stripping
# ---------------------------------------------------------------------------
def test_reasoning_effort_cleared_when_not_supported(monkeypatch):
cfg = _make_app_config([_make_model("no-effort", supports_reasoning_effort=False)])
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="no-effort", thinking_enabled=False)
assert captured.get("reasoning_effort") is None
def test_reasoning_effort_preserved_when_supported(monkeypatch):
wte = {"extra_body": {"thinking": {"type": "enabled", "budget_tokens": 5000}}}
cfg = _make_app_config(
[
_make_model(
"effort-model",
supports_thinking=True,
supports_reasoning_effort=True,
when_thinking_enabled=wte,
)
]
)
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="effort-model", thinking_enabled=False)
# When supports_reasoning_effort=True, it should NOT be cleared to None
# The disable path sets it to "minimal"; supports_reasoning_effort=True keeps it
assert captured.get("reasoning_effort") == "minimal"
# ---------------------------------------------------------------------------
# thinking shortcut field
# ---------------------------------------------------------------------------
def test_thinking_shortcut_enables_thinking_when_thinking_enabled(monkeypatch):
"""thinking shortcut alone should act as when_thinking_enabled with a `thinking` key."""
thinking_settings = {"type": "enabled", "budget_tokens": 8000}
cfg = _make_app_config(
[
_make_model(
"shortcut-model",
use="langchain_anthropic:ChatAnthropic",
supports_thinking=True,
thinking=thinking_settings,
)
]
)
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="shortcut-model", thinking_enabled=True)
assert captured.get("thinking") == thinking_settings
def test_thinking_shortcut_disables_thinking_when_thinking_disabled(monkeypatch):
"""thinking shortcut should participate in the disable path (langchain_anthropic format)."""
thinking_settings = {"type": "enabled", "budget_tokens": 8000}
cfg = _make_app_config(
[
_make_model(
"shortcut-disable",
use="langchain_anthropic:ChatAnthropic",
supports_thinking=True,
supports_reasoning_effort=False,
thinking=thinking_settings,
)
]
)
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="shortcut-disable", thinking_enabled=False)
assert captured.get("thinking") == {"type": "disabled"}
assert "extra_body" not in captured
def test_thinking_shortcut_merges_with_when_thinking_enabled(monkeypatch):
"""thinking shortcut should be merged into when_thinking_enabled when both are provided."""
thinking_settings = {"type": "enabled", "budget_tokens": 8000}
wte = {"max_tokens": 16000}
cfg = _make_app_config(
[
_make_model(
"merge-model",
use="langchain_anthropic:ChatAnthropic",
supports_thinking=True,
thinking=thinking_settings,
when_thinking_enabled=wte,
)
]
)
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="merge-model", thinking_enabled=True)
# Both the thinking shortcut and when_thinking_enabled settings should be applied
assert captured.get("thinking") == thinking_settings
assert captured.get("max_tokens") == 16000
def test_thinking_shortcut_not_leaked_into_model_when_disabled(monkeypatch):
"""thinking shortcut must not be passed raw to the model constructor (excluded from model_dump)."""
thinking_settings = {"type": "enabled", "budget_tokens": 8000}
cfg = _make_app_config(
[
_make_model(
"no-leak",
use="langchain_anthropic:ChatAnthropic",
supports_thinking=True,
supports_reasoning_effort=False,
thinking=thinking_settings,
)
]
)
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="no-leak", thinking_enabled=False)
# The disable path should have set thinking to disabled (not the raw enabled shortcut)
assert captured.get("thinking") == {"type": "disabled"}
# ---------------------------------------------------------------------------
# OpenAI-compatible providers (MiniMax, Novita, etc.)
# ---------------------------------------------------------------------------
def test_openai_compatible_provider_passes_base_url(monkeypatch):
"""OpenAI-compatible providers like MiniMax should pass base_url through to the model."""
model = ModelConfig(
name="minimax-m3",
display_name="MiniMax M3",
description=None,
use="langchain_openai:ChatOpenAI",
model="MiniMax-M3",
base_url="https://api.minimax.io/v1",
api_key="test-key",
max_tokens=4096,
temperature=1.0,
supports_vision=True,
supports_thinking=False,
)
cfg = _make_app_config([model])
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="minimax-m3")
assert captured.get("model") == "MiniMax-M3"
assert captured.get("base_url") == "https://api.minimax.io/v1"
assert captured.get("api_key") == "test-key"
assert captured.get("temperature") == 1.0
assert captured.get("max_tokens") == 4096
assert captured.get("stream_usage") is True
def test_openai_compatible_provider_respects_explicit_stream_usage(monkeypatch):
"""Explicit stream_usage should not be overwritten by the factory default."""
model = ModelConfig(
name="minimax-m3",
display_name="MiniMax M3",
description=None,
use="langchain_openai:ChatOpenAI",
model="MiniMax-M3",
base_url="https://api.minimax.io/v1",
api_key="test-key",
stream_usage=False,
supports_vision=True,
supports_thinking=False,
)
cfg = _make_app_config([model])
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="minimax-m3")
assert captured.get("stream_usage") is False
def test_openai_compatible_provider_enables_stream_usage_for_openai_api_base(monkeypatch):
"""openai_api_base should trigger stream_usage default for ChatOpenAI."""
model = ModelConfig(
name="openai-compatible",
display_name="OpenAI-Compatible",
description=None,
use="langchain_openai:ChatOpenAI",
model="example-model",
openai_api_base="https://example.com/v1",
api_key="test-key",
supports_vision=False,
supports_thinking=False,
)
cfg = _make_app_config([model])
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="openai-compatible")
assert captured.get("openai_api_base") == "https://example.com/v1"
assert captured.get("stream_usage") is True
def test_non_openai_provider_does_not_receive_stream_usage_default(monkeypatch):
"""Non-OpenAI providers with base_url should not receive stream_usage by default."""
model = ModelConfig(
name="ollama-local",
display_name="Ollama Local",
description=None,
use="langchain_ollama:ChatOllama",
model="qwen2.5",
base_url="http://127.0.0.1:11434",
supports_vision=False,
supports_thinking=False,
)
cfg = _make_app_config([model])
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="ollama-local")
assert captured.get("base_url") == "http://127.0.0.1:11434"
assert "stream_usage" not in captured
def test_openai_compatible_provider_multiple_models(monkeypatch):
"""Multiple models from the same OpenAI-compatible provider should coexist."""
m1 = ModelConfig(
name="minimax-m3",
display_name="MiniMax M3",
description=None,
use="langchain_openai:ChatOpenAI",
model="MiniMax-M3",
base_url="https://api.minimax.io/v1",
api_key="test-key",
temperature=1.0,
supports_vision=True,
supports_thinking=False,
)
m2 = ModelConfig(
name="minimax-m2.7-highspeed",
display_name="MiniMax M2.7 Highspeed",
description=None,
use="langchain_openai:ChatOpenAI",
model="MiniMax-M2.7-highspeed",
base_url="https://api.minimax.io/v1",
api_key="test-key",
temperature=1.0,
supports_vision=False, # M2.7 is text-only; M3 supports vision
supports_thinking=False,
)
cfg = _make_app_config([m1, m2])
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
# Create first model
factory_module.create_chat_model(name="minimax-m3")
assert captured.get("model") == "MiniMax-M3"
# Create second model
factory_module.create_chat_model(name="minimax-m2.7-highspeed")
assert captured.get("model") == "MiniMax-M2.7-highspeed"
# ---------------------------------------------------------------------------
# Codex provider reasoning_effort mapping
# ---------------------------------------------------------------------------
class FakeCodexChatModel(FakeChatModel):
pass
def test_codex_provider_disables_reasoning_when_thinking_disabled(monkeypatch):
cfg = _make_app_config(
[
_make_model(
"codex",
use="deerflow.models.openai_codex_provider:CodexChatModel",
supports_thinking=True,
supports_reasoning_effort=True,
)
]
)
_patch_factory(monkeypatch, cfg, model_class=FakeCodexChatModel)
monkeypatch.setattr(codex_provider_module, "CodexChatModel", FakeCodexChatModel)
FakeChatModel.captured_kwargs = {}
factory_module.create_chat_model(name="codex", thinking_enabled=False)
assert FakeChatModel.captured_kwargs.get("reasoning_effort") == "none"
def test_codex_provider_preserves_explicit_reasoning_effort(monkeypatch):
cfg = _make_app_config(
[
_make_model(
"codex",
use="deerflow.models.openai_codex_provider:CodexChatModel",
supports_thinking=True,
supports_reasoning_effort=True,
)
]
)
_patch_factory(monkeypatch, cfg, model_class=FakeCodexChatModel)
monkeypatch.setattr(codex_provider_module, "CodexChatModel", FakeCodexChatModel)
FakeChatModel.captured_kwargs = {}
factory_module.create_chat_model(name="codex", thinking_enabled=True, reasoning_effort="high")
assert FakeChatModel.captured_kwargs.get("reasoning_effort") == "high"
def test_codex_provider_defaults_reasoning_effort_to_medium(monkeypatch):
cfg = _make_app_config(
[
_make_model(
"codex",
use="deerflow.models.openai_codex_provider:CodexChatModel",
supports_thinking=True,
supports_reasoning_effort=True,
)
]
)
_patch_factory(monkeypatch, cfg, model_class=FakeCodexChatModel)
monkeypatch.setattr(codex_provider_module, "CodexChatModel", FakeCodexChatModel)
FakeChatModel.captured_kwargs = {}
factory_module.create_chat_model(name="codex", thinking_enabled=True)
assert FakeChatModel.captured_kwargs.get("reasoning_effort") == "medium"
def test_codex_provider_strips_unsupported_max_tokens(monkeypatch):
cfg = _make_app_config(
[
_make_model(
"codex",
use="deerflow.models.openai_codex_provider:CodexChatModel",
supports_thinking=True,
supports_reasoning_effort=True,
max_tokens=4096,
)
]
)
_patch_factory(monkeypatch, cfg, model_class=FakeCodexChatModel)
monkeypatch.setattr(codex_provider_module, "CodexChatModel", FakeCodexChatModel)
FakeChatModel.captured_kwargs = {}
factory_module.create_chat_model(name="codex", thinking_enabled=True)
assert "max_tokens" not in FakeChatModel.captured_kwargs
def test_thinking_disabled_vllm_chat_template_format(monkeypatch):
wte = {"extra_body": {"chat_template_kwargs": {"thinking": True}}}
model = _make_model(
"vllm-qwen",
use="deerflow.models.vllm_provider:VllmChatModel",
supports_thinking=True,
when_thinking_enabled=wte,
)
model.extra_body = {"top_k": 20}
cfg = _make_app_config([model])
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="vllm-qwen", thinking_enabled=False)
assert captured.get("extra_body") == {"top_k": 20, "chat_template_kwargs": {"thinking": False}}
assert captured.get("reasoning_effort") is None
def test_thinking_disabled_vllm_enable_thinking_format(monkeypatch):
wte = {"extra_body": {"chat_template_kwargs": {"enable_thinking": True}}}
model = _make_model(
"vllm-qwen-enable",
use="deerflow.models.vllm_provider:VllmChatModel",
supports_thinking=True,
when_thinking_enabled=wte,
)
model.extra_body = {"top_k": 20}
cfg = _make_app_config([model])
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="vllm-qwen-enable", thinking_enabled=False)
assert captured.get("extra_body") == {
"top_k": 20,
"chat_template_kwargs": {"enable_thinking": False},
}
assert captured.get("reasoning_effort") is None
# ---------------------------------------------------------------------------
# stream_usage injection
# ---------------------------------------------------------------------------
class _FakeWithStreamUsage(FakeChatModel):
"""Fake model that declares stream_usage in model_fields (like BaseChatOpenAI)."""
stream_usage: bool | None = None
def test_stream_usage_injected_for_openai_compatible_model(monkeypatch):
"""Factory should set stream_usage=True for models with stream_usage field."""
cfg = _make_app_config([_make_model("deepseek", use="langchain_deepseek:ChatDeepSeek")])
_patch_factory(monkeypatch, cfg, model_class=_FakeWithStreamUsage)
captured: dict = {}
class CapturingModel(_FakeWithStreamUsage):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="deepseek")
assert captured.get("stream_usage") is True
def test_stream_usage_not_injected_for_non_openai_model(monkeypatch):
"""Factory should NOT inject stream_usage for models without the field."""
cfg = _make_app_config([_make_model("claude", use="langchain_anthropic:ChatAnthropic")])
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="claude")
assert "stream_usage" not in captured
def test_stream_usage_not_overridden_when_explicitly_set_in_config(monkeypatch):
"""If config dumps stream_usage=False, factory should respect it."""
cfg = _make_app_config([_make_model("deepseek", use="langchain_deepseek:ChatDeepSeek")])
_patch_factory(monkeypatch, cfg, model_class=_FakeWithStreamUsage)
captured: dict = {}
class CapturingModel(_FakeWithStreamUsage):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
# Simulate config having stream_usage explicitly set by patching model_dump
original_get_model_config = cfg.get_model_config
def patched_get_model_config(name):
mc = original_get_model_config(name)
mc.stream_usage = False # type: ignore[attr-defined]
return mc
monkeypatch.setattr(cfg, "get_model_config", patched_get_model_config)
factory_module.create_chat_model(name="deepseek")
assert captured.get("stream_usage") is False
def test_openai_responses_api_settings_are_passed_to_chatopenai(monkeypatch):
model = ModelConfig(
name="gpt-5-responses",
display_name="GPT-5 Responses",
description=None,
use="langchain_openai:ChatOpenAI",
model="gpt-5",
api_key="test-key",
use_responses_api=True,
output_version="responses/v1",
supports_thinking=False,
supports_vision=True,
)
cfg = _make_app_config([model])
_patch_factory(monkeypatch, cfg)
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
monkeypatch.setattr(factory_module, "resolve_class", lambda path, base: CapturingModel)
factory_module.create_chat_model(name="gpt-5-responses")
assert captured.get("use_responses_api") is True
assert captured.get("output_version") == "responses/v1"
# ---------------------------------------------------------------------------
# Provider class path resolution
# ---------------------------------------------------------------------------
@pytest.mark.parametrize("model_id", ["mimo-v2.5-pro", "mimo-v2.5", "mimo-v2-flash"])
def test_create_chat_model_resolves_patched_mimo_provider(model_id):
from deerflow.models.patched_mimo import PatchedChatMiMo
model = ModelConfig(
name=f"{model_id}-thinking",
display_name=f"{model_id} Thinking",
description=None,
use="deerflow.models.patched_mimo:PatchedChatMiMo",
model=model_id,
api_key="test-key",
base_url="https://api.xiaomimimo.com/v1",
supports_thinking=True,
when_thinking_enabled={"extra_body": {"thinking": {"type": "enabled"}}},
supports_vision=False,
)
cfg = _make_app_config([model])
chat_model = factory_module.create_chat_model(
name=f"{model_id}-thinking",
thinking_enabled=True,
app_config=cfg,
attach_tracing=False,
)
assert isinstance(chat_model, PatchedChatMiMo)
assert chat_model.model_name == model_id
assert chat_model.extra_body["thinking"]["type"] == "enabled"
# ---------------------------------------------------------------------------
# Duplicate keyword argument collision (issue #1977)
# ---------------------------------------------------------------------------
def test_no_duplicate_kwarg_when_reasoning_effort_in_config_and_thinking_disabled(monkeypatch):
"""When reasoning_effort is set in config.yaml (extra field) AND the thinking-disabled
path also injects reasoning_effort=minimal into kwargs, the factory must not raise
TypeError: got multiple values for keyword argument 'reasoning_effort'."""
wte = {"extra_body": {"thinking": {"type": "enabled", "budget_tokens": 5000}}}
# ModelConfig.extra="allow" means extra fields from config.yaml land in model_dump()
model = ModelConfig(
name="doubao-model",
display_name="Doubao 1.8",
description=None,
use="deerflow.models.patched_deepseek:PatchedChatDeepSeek",
model="doubao-seed-1-8-250315",
reasoning_effort="high", # user-set extra field in config.yaml
supports_thinking=True,
supports_reasoning_effort=True,
when_thinking_enabled=wte,
supports_vision=False,
)
cfg = _make_app_config([model])
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
_patch_factory(monkeypatch, cfg, model_class=CapturingModel)
# Must not raise TypeError
factory_module.create_chat_model(name="doubao-model", thinking_enabled=False)
# kwargs (runtime) takes precedence: thinking-disabled path sets reasoning_effort=minimal
assert captured.get("reasoning_effort") == "minimal"
# ---------------------------------------------------------------------------
# stream_chunk_timeout default injection (issue #3189)
# ---------------------------------------------------------------------------
def test_stream_chunk_timeout_defaults_to_240_for_openai_compatible_model(monkeypatch):
"""OpenAI-compatible clients must receive a generous 240s chunk-gap budget by
default, so reasoning models with long thinking pauses don't trip
langchain-openai's aggressive 60s built-in default.
"""
model = _make_model(use="langchain_openai:ChatOpenAI")
cfg = _make_app_config([model])
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
_patch_factory(monkeypatch, cfg, model_class=CapturingModel)
factory_module.create_chat_model(name="test-model")
assert captured.get("stream_chunk_timeout") == 240.0
def test_stream_chunk_timeout_user_value_not_overridden(monkeypatch):
"""If the user explicitly sets stream_chunk_timeout in config.yaml, the
factory must not overwrite it with the default — even if the value is
smaller (60s) or larger (600s) than the default.
"""
model = ModelConfig(
name="custom-timeout-model",
display_name="Custom Timeout",
description=None,
use="langchain_openai:ChatOpenAI",
model="gpt-4o-mini",
stream_chunk_timeout=60.0, # user-set explicit value
)
cfg = _make_app_config([model])
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
_patch_factory(monkeypatch, cfg, model_class=CapturingModel)
factory_module.create_chat_model(name="custom-timeout-model")
assert captured.get("stream_chunk_timeout") == 60.0
def test_stream_chunk_timeout_not_injected_for_non_openai_provider(monkeypatch):
"""Only langchain_openai:ChatOpenAI receives the default. Anthropic / Vertex /
other clients that don't understand this kwarg must not be polluted with it.
"""
model = _make_model(use="langchain_anthropic:ChatAnthropic")
cfg = _make_app_config([model])
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
_patch_factory(monkeypatch, cfg, model_class=CapturingModel)
factory_module.create_chat_model(name="test-model")
assert "stream_chunk_timeout" not in captured
def test_stream_chunk_timeout_default_constant_is_documented():
"""Lock the default value at 240s. If we ever want to change this, the
deliberate update here (and the docstring on _apply_stream_chunk_timeout_default)
forces a paired review of the rationale comment block above the constant.
"""
assert factory_module._DEFAULT_STREAM_CHUNK_TIMEOUT_SECONDS == 240.0
def test_stream_chunk_timeout_popped_for_non_openai_provider_when_user_set_it(monkeypatch):
"""Regression for CR feedback on issue #3189: if a user accidentally sets
``stream_chunk_timeout`` on a non-OpenAI provider, the factory must drop
the kwarg before forwarding it to the model constructor. Otherwise the
third-party client raises ``TypeError: unexpected keyword argument
'stream_chunk_timeout'`` because the parameter is specific to
``langchain_openai:ChatOpenAI``.
"""
model = ModelConfig(
name="anthropic-with-stray-timeout",
display_name="Anthropic With Stray Timeout",
description=None,
use="langchain_anthropic:ChatAnthropic",
model="claude-sonnet-4",
stream_chunk_timeout=60.0, # user-set on a non-OpenAI provider — must be dropped
)
cfg = _make_app_config([model])
captured: dict = {}
class CapturingModel(FakeChatModel):
def __init__(self, **kwargs):
captured.update(kwargs)
BaseChatModel.__init__(self, **kwargs)
_patch_factory(monkeypatch, cfg, model_class=CapturingModel)
factory_module.create_chat_model(name="anthropic-with-stray-timeout")
assert "stream_chunk_timeout" not in captured
# ---------------------------------------------------------------------------
# OpenAI base_url normalization + unknown-key warning
# (regression: api_base copied onto a ChatOpenAI model crashed at request time)
# ---------------------------------------------------------------------------
def _make_model_with_extras(name="extra-model", *, use="langchain_openai:ChatOpenAI", **extras):
"""Build a ModelConfig with arbitrary extra keys (ModelConfig is extra='allow')."""
return ModelConfig(
name=name,
display_name=name,
description=None,
use=use,
model=name,
supports_thinking=False,
supports_reasoning_effort=False,
supports_vision=False,
**extras,
)
def test_api_base_normalized_to_base_url_for_chatopenai(monkeypatch):
"""A config that sets api_base on a ChatOpenAI model should reach the constructor as base_url."""
cfg = _make_app_config([_make_model_with_extras("oai", api_base="http://localhost:4001/v1")])
_patch_factory(monkeypatch, cfg)
FakeChatModel.captured_kwargs = {}
factory_module.create_chat_model(name="oai")
assert FakeChatModel.captured_kwargs.get("base_url") == "http://localhost:4001/v1"
assert "api_base" not in FakeChatModel.captured_kwargs
def test_base_url_takes_precedence_when_both_set(monkeypatch):
"""When both base_url and api_base are present, base_url wins and api_base is dropped."""
cfg = _make_app_config([_make_model_with_extras("oai", base_url="http://canonical/v1", api_base="http://alias/v1")])
_patch_factory(monkeypatch, cfg)
FakeChatModel.captured_kwargs = {}
factory_module.create_chat_model(name="oai")
assert FakeChatModel.captured_kwargs.get("base_url") == "http://canonical/v1"
assert "api_base" not in FakeChatModel.captured_kwargs
def test_api_base_not_normalized_for_non_openai_class(monkeypatch):
"""api_base must be left untouched for model classes that are not the OpenAI-compatible family."""
cfg = _make_app_config([_make_model_with_extras("ds", use="deerflow.models.patched_deepseek:PatchedChatDeepSeek", api_base="http://ds/v3")])
_patch_factory(monkeypatch, cfg)
FakeChatModel.captured_kwargs = {}
factory_module.create_chat_model(name="ds")
# PatchedChatDeepSeek legitimately takes api_base — it must pass through unchanged.
assert FakeChatModel.captured_kwargs.get("api_base") == "http://ds/v3"
assert "base_url" not in FakeChatModel.captured_kwargs
def test_no_op_when_neither_base_url_nor_api_base(monkeypatch):
"""Normalization is a no-op when the model declares no endpoint override."""
cfg = _make_app_config([_make_model("plain")])
_patch_factory(monkeypatch, cfg)
FakeChatModel.captured_kwargs = {}
factory_module.create_chat_model(name="plain")
assert "base_url" not in FakeChatModel.captured_kwargs
assert "api_base" not in FakeChatModel.captured_kwargs
def test_unknown_config_key_emits_warning(monkeypatch, caplog):
"""A typo'd config key should produce a heads-up warning naming the offending key.
Uses the real ChatOpenAI class (not the stub) so the field/alias schema is realistic — the
warning's whole value is that it matches what LangChain will actually divert to model_kwargs.
"""
import logging
from langchain_openai import ChatOpenAI
cfg = _make_app_config([_make_model_with_extras("typo", api_key="sk-test", definitely_not_a_real_kwarg=True)])
_patch_factory(monkeypatch, cfg, model_class=ChatOpenAI)
with caplog.at_level(logging.WARNING, logger=factory_module.__name__):
factory_module.create_chat_model(name="typo")
assert any("definitely_not_a_real_kwarg" in rec.message for rec in caplog.records)
def test_known_config_keys_emit_no_warning(monkeypatch, caplog):
"""Recognized keys (model, base_url alias, max_tokens, factory-injected kwargs) must not warn."""
import logging
from langchain_openai import ChatOpenAI
cfg = _make_app_config([_make_model_with_extras("clean", api_key="sk-test", base_url="http://ok/v1", max_tokens=100)])
_patch_factory(monkeypatch, cfg, model_class=ChatOpenAI)
with caplog.at_level(logging.WARNING, logger=factory_module.__name__):
factory_module.create_chat_model(name="clean")
assert not any("not recognized parameters" in rec.message for rec in caplog.records)
def test_api_base_normalized_for_patched_chatopenai(monkeypatch):
"""The PatchedChatOpenAI subclass is in the OpenAI-compatible family and must normalize too."""
cfg = _make_app_config([_make_model_with_extras("patched", use="deerflow.models.patched_openai:PatchedChatOpenAI", api_base="http://localhost:4001/v1")])
_patch_factory(monkeypatch, cfg)
FakeChatModel.captured_kwargs = {}
factory_module.create_chat_model(name="patched")
assert FakeChatModel.captured_kwargs.get("base_url") == "http://localhost:4001/v1"
assert "api_base" not in FakeChatModel.captured_kwargs
def test_api_base_dropped_when_openai_api_base_field_name_set(monkeypatch):
"""If the field-name openai_api_base is set alongside api_base, the alias is dropped (no dup)."""
cfg = _make_app_config([_make_model_with_extras("oai", openai_api_base="http://canonical/v1", api_base="http://alias/v1")])
_patch_factory(monkeypatch, cfg)
FakeChatModel.captured_kwargs = {}
factory_module.create_chat_model(name="oai")
assert FakeChatModel.captured_kwargs.get("openai_api_base") == "http://canonical/v1"
assert "api_base" not in FakeChatModel.captured_kwargs
assert "base_url" not in FakeChatModel.captured_kwargs
def test_no_unknown_key_warning_for_non_openai_class(monkeypatch, caplog):
"""The unknown-key warning is scoped to the OpenAI family; other providers must not false-positive.
Regression: a ChatAnthropic model with a legit kwarg like frequency_penalty (which LangChain
routes into model_kwargs for that provider) previously tripped the 'not recognized' warning.
"""
import logging
cfg = _make_app_config([_make_model_with_extras("anthropic", use="langchain_anthropic:ChatAnthropic", frequency_penalty=0.5)])
_patch_factory(monkeypatch, cfg)
FakeChatModel.captured_kwargs = {}
with caplog.at_level(logging.WARNING, logger=factory_module.__name__):
factory_module.create_chat_model(name="anthropic")
assert not any("not recognized parameters" in rec.message for rec in caplog.records)