mirror of
https://github.com/HKUDS/nanobot.git
synced 2026-05-04 00:35:58 +00:00
Add an `extra_body` field to `ProviderConfig` that merges arbitrary key-value pairs into every OpenAI-compatible request body. This is the escape hatch for provider-specific features that nanobot does not have first-class fields for. Real-world use cases this unblocks via config alone (no code changes): - vLLM/TGI `chat_template_kwargs` (e.g. `enable_thinking: false`) - vLLM guided decoding (`guided_json`, `guided_regex`) - Local model sampling params (`repetition_penalty`, `top_k`, `min_p`) - Any future provider-specific param without a new PR each time The config extra_body is applied last via recursive deep-merge, so it can extend or override provider-specific defaults (e.g. thinking params) without clobbering sibling keys set by internal logic. Changes: - Add `extra_body: dict[str, Any] | None` to `ProviderConfig` - Pass it through `factory.py` to `OpenAICompatProvider.__init__` - Deep-merge into `_build_kwargs` after all internal extra_body entries - Add `_deep_merge` helper (recursive dict merge, does not mutate inputs) - 21 tests: deep-merge semantics, provider init, _build_kwargs integration, thinking coexistence, real-world patterns (guided_json, repetition_penalty), and schema validation
215 lines
7.9 KiB
Python
215 lines
7.9 KiB
Python
"""Tests for provider extra_body config injection into request payloads."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import Any
|
|
from unittest.mock import MagicMock
|
|
|
|
from nanobot.providers.openai_compat_provider import (
|
|
OpenAICompatProvider,
|
|
_deep_merge,
|
|
)
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# _deep_merge unit tests
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
class TestDeepMerge:
|
|
"""Verify recursive dict merge semantics."""
|
|
|
|
def test_flat_merge(self) -> None:
|
|
assert _deep_merge({"a": 1}, {"b": 2}) == {"a": 1, "b": 2}
|
|
|
|
def test_override_scalar(self) -> None:
|
|
assert _deep_merge({"a": 1}, {"a": 2}) == {"a": 2}
|
|
|
|
def test_nested_merge(self) -> None:
|
|
base = {"outer": {"a": 1, "b": 2}}
|
|
override = {"outer": {"b": 3, "c": 4}}
|
|
assert _deep_merge(base, override) == {"outer": {"a": 1, "b": 3, "c": 4}}
|
|
|
|
def test_deeply_nested(self) -> None:
|
|
base = {"l1": {"l2": {"a": 1}}}
|
|
override = {"l1": {"l2": {"b": 2}}}
|
|
assert _deep_merge(base, override) == {"l1": {"l2": {"a": 1, "b": 2}}}
|
|
|
|
def test_override_replaces_non_dict_with_dict(self) -> None:
|
|
assert _deep_merge({"a": 1}, {"a": {"nested": True}}) == {"a": {"nested": True}}
|
|
|
|
def test_override_replaces_dict_with_scalar(self) -> None:
|
|
assert _deep_merge({"a": {"nested": True}}, {"a": "flat"}) == {"a": "flat"}
|
|
|
|
def test_empty_base(self) -> None:
|
|
assert _deep_merge({}, {"a": 1}) == {"a": 1}
|
|
|
|
def test_empty_override(self) -> None:
|
|
assert _deep_merge({"a": 1}, {}) == {"a": 1}
|
|
|
|
def test_does_not_mutate_inputs(self) -> None:
|
|
base = {"a": {"x": 1}}
|
|
override = {"a": {"y": 2}}
|
|
_deep_merge(base, override)
|
|
assert base == {"a": {"x": 1}}
|
|
assert override == {"a": {"y": 2}}
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Provider construction
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
class TestExtraBodyInit:
|
|
"""Verify the provider stores extra_body from config."""
|
|
|
|
def test_default_is_empty(self) -> None:
|
|
provider = OpenAICompatProvider(api_key="test")
|
|
assert provider._extra_body == {}
|
|
|
|
def test_none_becomes_empty(self) -> None:
|
|
provider = OpenAICompatProvider(api_key="test", extra_body=None)
|
|
assert provider._extra_body == {}
|
|
|
|
def test_dict_stored(self) -> None:
|
|
body = {"chat_template_kwargs": {"enable_thinking": False}}
|
|
provider = OpenAICompatProvider(api_key="test", extra_body=body)
|
|
assert provider._extra_body == body
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# _build_kwargs integration
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def _make_provider(extra_body: dict[str, Any] | None = None) -> OpenAICompatProvider:
|
|
return OpenAICompatProvider(
|
|
api_key="test-key",
|
|
default_model="test-model",
|
|
extra_body=extra_body,
|
|
)
|
|
|
|
|
|
def _simple_messages() -> list[dict[str, Any]]:
|
|
return [{"role": "user", "content": "hello"}]
|
|
|
|
|
|
class TestBuildKwargsExtraBody:
|
|
"""Verify extra_body flows into _build_kwargs output."""
|
|
|
|
def test_no_extra_body_no_key(self) -> None:
|
|
provider = _make_provider()
|
|
kwargs = provider._build_kwargs(
|
|
messages=_simple_messages(),
|
|
tools=None, model=None, max_tokens=100,
|
|
temperature=0.1, reasoning_effort=None, tool_choice=None,
|
|
)
|
|
assert "extra_body" not in kwargs
|
|
|
|
def test_extra_body_injected(self) -> None:
|
|
provider = _make_provider({"chat_template_kwargs": {"enable_thinking": False}})
|
|
kwargs = provider._build_kwargs(
|
|
messages=_simple_messages(),
|
|
tools=None, model=None, max_tokens=100,
|
|
temperature=0.1, reasoning_effort=None, tool_choice=None,
|
|
)
|
|
assert kwargs["extra_body"] == {
|
|
"chat_template_kwargs": {"enable_thinking": False},
|
|
}
|
|
|
|
def test_extra_body_merges_with_thinking(self) -> None:
|
|
"""Config extra_body should merge with (and override) thinking params."""
|
|
from nanobot.providers.registry import ProviderSpec
|
|
|
|
spec = MagicMock(spec=ProviderSpec)
|
|
spec.thinking_style = "deepseek"
|
|
spec.supports_prompt_caching = False
|
|
spec.strip_model_prefix = False
|
|
spec.model_overrides = []
|
|
spec.name = "custom"
|
|
spec.supports_max_completion_tokens = False
|
|
spec.env_key = None
|
|
spec.default_api_base = None
|
|
spec.is_local = True
|
|
spec.detect_by_base_keyword = None
|
|
|
|
provider = OpenAICompatProvider(
|
|
api_key="test",
|
|
default_model="deepseek-v3",
|
|
spec=spec,
|
|
extra_body={"custom_param": "value"},
|
|
)
|
|
kwargs = provider._build_kwargs(
|
|
messages=_simple_messages(),
|
|
tools=None, model=None, max_tokens=100,
|
|
temperature=0.1, reasoning_effort="high", tool_choice=None,
|
|
)
|
|
body = kwargs.get("extra_body", {})
|
|
# Config param should be present
|
|
assert body.get("custom_param") == "value"
|
|
|
|
def test_nested_extra_body_does_not_clobber_siblings(self) -> None:
|
|
"""Nested dict merge should preserve sibling keys."""
|
|
provider = _make_provider({
|
|
"chat_template_kwargs": {"enable_thinking": False},
|
|
})
|
|
# Simulate internal code having set a sibling key
|
|
# by manually calling _build_kwargs — the internal logic
|
|
# doesn't set chat_template_kwargs, so we test the merge path
|
|
# by having extra_body itself contain nested keys
|
|
kwargs = provider._build_kwargs(
|
|
messages=_simple_messages(),
|
|
tools=None, model=None, max_tokens=100,
|
|
temperature=0.1, reasoning_effort=None, tool_choice=None,
|
|
)
|
|
assert kwargs["extra_body"]["chat_template_kwargs"]["enable_thinking"] is False
|
|
|
|
def test_guided_json_injection(self) -> None:
|
|
"""Real-world use case: vLLM guided decoding."""
|
|
schema = {"type": "object", "properties": {"name": {"type": "string"}}}
|
|
provider = _make_provider({"guided_json": schema})
|
|
kwargs = provider._build_kwargs(
|
|
messages=_simple_messages(),
|
|
tools=None, model=None, max_tokens=100,
|
|
temperature=0.1, reasoning_effort=None, tool_choice=None,
|
|
)
|
|
assert kwargs["extra_body"]["guided_json"] == schema
|
|
|
|
def test_repetition_penalty_injection(self) -> None:
|
|
"""Real-world use case: local model sampling param."""
|
|
provider = _make_provider({"repetition_penalty": 1.15})
|
|
kwargs = provider._build_kwargs(
|
|
messages=_simple_messages(),
|
|
tools=None, model=None, max_tokens=100,
|
|
temperature=0.1, reasoning_effort=None, tool_choice=None,
|
|
)
|
|
assert kwargs["extra_body"]["repetition_penalty"] == 1.15
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Schema validation
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
class TestSchemaConfig:
|
|
"""Verify ProviderConfig accepts extra_body."""
|
|
|
|
def test_default_is_none(self) -> None:
|
|
from nanobot.config.schema import ProviderConfig
|
|
|
|
config = ProviderConfig()
|
|
assert config.extra_body is None
|
|
|
|
def test_accepts_dict(self) -> None:
|
|
from nanobot.config.schema import ProviderConfig
|
|
|
|
config = ProviderConfig(extra_body={"guided_json": {"type": "object"}})
|
|
assert config.extra_body == {"guided_json": {"type": "object"}}
|
|
|
|
def test_nested_dict(self) -> None:
|
|
from nanobot.config.schema import ProviderConfig
|
|
|
|
config = ProviderConfig(
|
|
extra_body={"chat_template_kwargs": {"enable_thinking": False}}
|
|
)
|
|
assert config.extra_body["chat_template_kwargs"]["enable_thinking"] is False
|