One `/model --global` produced four config.yaml shapes. CLI wrote
default/provider/base_url/api_mode and cleared the context pin on a route
change; the gateway rewrote the whole `model:` block (whole-file save_config)
and only set api_mode for `custom`; the TUI wrote three keys and never
touched api_mode, so a switch off an Anthropic-wire endpoint left a stale
`api_mode: anthropic_messages` in config; the dashboard main slot had its own
switched-provider logic, wrote `base_url: ""` and always dropped
context_length. ACP `session/set_model` and `POST /api/model/set` accepted
any model string (parse_model_input + detect_provider_for_model) so a model
no catalog knows, or a provider with no credentials, was handed to the
session / persisted and only failed at inference time.
Canonical: `hermes_cli.model_switch.model_selection_config_updates` (the
shape) + `persist_model_selection(result, config_path=None)` (targeted
per-key `atomic_roundtrip_yaml_update` writes, so sibling
`model_slots`/`model_fallback` keys survive; explicit path for the
multiplexed gateway's profile config) + `apply_model_selection` (same shape
applied to an in-memory `model:` dict for callers that save a whole
document). `atomic_roundtrip_yaml_update(value=None)` now REMOVES the key
instead of writing `key: null`, so per-key and whole-document writers land
the same file. Shape = CLI/gateway semantics: default, provider, base_url
(cleared when the target has none), api_mode (cleared when unresolved),
context_length cleared only when `should_clear_context_pin` says the route
identity changed, inline api_key/api cleared for non-custom targets.
Sites -> canonical:
hermes_cli/cli_model_switch_mixin.py::_persist_global_switch -> deleted; _commit_model_switch calls persist_model_selection
hermes_cli/cli_model_switch_mixin.py::_clear_persisted_context_for_model_switch -> deleted (folded into the shape)
gateway/slash_commands_model.py::_persist_model_switch_to_config -> to_thread forwarder: persist_model_selection(result, ctx.config_path)
tui_gateway/model_switch.py::_persist_model_switch -> deleted; _apply_model_switch calls persist_model_selection
hermes_cli/web_server_config.py::_apply_main_model_assignment -> apply_model_selection(result) (+ explicit custom api_key)
hermes_cli/web_server_config.py::_validated_main_model_selection -> NEW: switch_model(--provider) gate; rejection -> HTTP 400
hermes_cli/web_routers/{models,profiles,config_env}.py main-slot paths -> through _validated_main_model_selection
acp_adapter/server.py::_resolve_model_selection -> deleted; _switch_model calls switch_model (provider:model -> --provider), rejection -> ValueError
Behavior changes: TUI --global now writes/clears model.api_mode and clears a
route-changed context pin; gateway --global no longer rewrites the whole
model block (sibling keys survive) and clears api_mode for every target;
dashboard main slot / profile-create model / custom-endpoint activate now
reject unknown/uncredentialed/unlisted models (HTTP 400) and persist the
resolved base_url/api_mode instead of `base_url: ""`; ACP rejects the same
(ValueError surfaced by the command/protocol handler). Gateway persist runs
on a worker thread against the routed profile's config_path (multiplex-safe).
Cleared keys are removed from config.yaml rather than left as `null`. ACP
still never persists.
Kept `_normalize_main_model_assignment`: switch_model rejects a vendor name
posing as a provider (`moonshotai` -> "Unknown provider"), so the
vendor->aggregator repair is not a duplicate; E2E verified both branches.
No config migration: readers already coalesce `base_url: ""` to absent
(`_config_base_url_for_provider`) and gate api_mode on provider match
(`_provider_supports_explicit_api_mode`), so no stale-shape reader bug.
Tests: tests/hermes_cli/test_model_persist_one_shape.py (four surfaces land
one block; same-route re-pick keeps the pin), tests/acp_adapter/
test_acp_dashboard_model_switch_validation.py (rejection + explicit
provider prefix). Replaces test_acp_set_model_explicit_provider.py and the
two TUI-only persist tests; tests that intercepted the old per-surface seams
(`cli.save_config_value`, `load_config_readonly`, `tui_gateway.server.
_persist_model_switch`) now intercept the canonical seam. Each fix
sabotage-verified red.
141 lines
5.2 KiB
Python
141 lines
5.2 KiB
Python
"""Regression tests for gateway /model --global persistence when config.yaml
|
|
has a flat-string ``model:`` value instead of a nested dict.
|
|
|
|
Before fix: ``cfg.setdefault("model", {})`` returned the existing string and
|
|
the next assignment raised ``TypeError: 'str' object does not support item
|
|
assignment``, so every ``/model X --global`` from Telegram/Discord crashed
|
|
silently and the user-visible result was "switch failed" with no persist.
|
|
|
|
After fix: the persist block coerces a scalar ``model:`` into a nested dict
|
|
before mutation, so ``--global`` succeeds and the config is rewritten in
|
|
the proper ``model: {default: ..., provider: ...}`` form.
|
|
"""
|
|
|
|
import yaml
|
|
import pytest
|
|
|
|
from gateway.config import Platform
|
|
from gateway.platforms.event import MessageEvent, MessageType
|
|
from gateway.run import GatewayRunner
|
|
from gateway.session import SessionSource
|
|
|
|
|
|
def _make_runner():
|
|
runner = object.__new__(GatewayRunner)
|
|
runner.adapters = {}
|
|
runner._voice_mode = {}
|
|
runner._session_model_overrides = {}
|
|
runner._running_agents = {}
|
|
return runner
|
|
|
|
|
|
def _make_event(text):
|
|
return MessageEvent(
|
|
text=text,
|
|
message_type=MessageType.TEXT,
|
|
source=SessionSource(platform=Platform.TELEGRAM, chat_id="12345", chat_type="dm"),
|
|
)
|
|
|
|
|
|
def _fake_switch_result():
|
|
"""Build a successful ModelSwitchResult that bypasses real provider resolution."""
|
|
from hermes_cli.model_switch import ModelSwitchResult
|
|
|
|
return ModelSwitchResult(
|
|
success=True,
|
|
new_model="gpt-5.5",
|
|
target_provider="openrouter",
|
|
provider_changed=True,
|
|
api_key="sk-test",
|
|
base_url="https://openrouter.ai/api/v1",
|
|
api_mode="chat_completions",
|
|
provider_label="OpenRouter",
|
|
is_global=True,
|
|
)
|
|
|
|
|
|
def _setup_isolated_home(tmp_path, monkeypatch, model_yaml_value):
|
|
"""Write a config.yaml with the given ``model:`` value and stub the heavy bits."""
|
|
import gateway.run as gateway_run
|
|
|
|
hermes_home = tmp_path / ".hermes"
|
|
hermes_home.mkdir()
|
|
cfg_path = hermes_home / "config.yaml"
|
|
cfg_path.write_text(
|
|
yaml.safe_dump({"model": model_yaml_value, "providers": {}}),
|
|
encoding="utf-8",
|
|
)
|
|
|
|
monkeypatch.setattr(gateway_run, "_hermes_home", hermes_home)
|
|
monkeypatch.setattr("agent.models_dev.fetch_models_dev", lambda: {})
|
|
monkeypatch.setattr(
|
|
"hermes_cli.model_switch.switch_model",
|
|
lambda **kw: _fake_switch_result(),
|
|
)
|
|
# save_config writes to ``get_hermes_home() / config.yaml`` — point it here.
|
|
monkeypatch.setattr("hermes_constants.get_hermes_home", lambda: hermes_home)
|
|
monkeypatch.setattr("hermes_cli.config.get_hermes_home", lambda: hermes_home)
|
|
return cfg_path
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_model_global_persists_when_config_has_flat_string_model(tmp_path, monkeypatch):
|
|
"""Regression: ``model: deepseek-v4-flash`` (flat string) used to crash
|
|
the gateway ``/model X --global`` persist branch with TypeError. After
|
|
the fix, the flat string is coerced to ``{"default": ...}`` and the new
|
|
model+provider are persisted on top.
|
|
"""
|
|
cfg_path = _setup_isolated_home(tmp_path, monkeypatch, "deepseek-v4-flash")
|
|
|
|
result = await _make_runner()._handle_model_command(
|
|
_make_event("/model gpt-5.5 --global")
|
|
)
|
|
|
|
# Sanity: the handler returned a success-looking message (not a crash log).
|
|
assert result is not None
|
|
assert "gpt-5.5" in result
|
|
|
|
# The persist block must have rewritten config.yaml as a nested dict.
|
|
written = yaml.safe_load(cfg_path.read_text(encoding="utf-8"))
|
|
assert isinstance(written["model"], dict), (
|
|
"model: should be coerced to a dict, got %r" % (written["model"],)
|
|
)
|
|
assert written["model"]["default"] == "gpt-5.5"
|
|
assert written["model"]["provider"] == "openrouter"
|
|
# The resolved aggregator endpoint is persisted (same shape as CLI/TUI --global, #25106).
|
|
assert written["model"]["base_url"] == "https://openrouter.ai/api/v1"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_model_global_persists_when_config_has_missing_model(tmp_path, monkeypatch):
|
|
"""Companion case: ``model:`` key absent entirely. setdefault would have
|
|
worked here, but the coercion branch also has to handle this cleanly.
|
|
"""
|
|
import gateway.run as gateway_run
|
|
|
|
hermes_home = tmp_path / ".hermes"
|
|
hermes_home.mkdir()
|
|
cfg_path = hermes_home / "config.yaml"
|
|
cfg_path.write_text(yaml.safe_dump({"providers": {}}), encoding="utf-8")
|
|
|
|
monkeypatch.setattr(gateway_run, "_hermes_home", hermes_home)
|
|
monkeypatch.setattr("agent.models_dev.fetch_models_dev", lambda: {})
|
|
monkeypatch.setattr(
|
|
"hermes_cli.model_switch.switch_model",
|
|
lambda **kw: _fake_switch_result(),
|
|
)
|
|
monkeypatch.setattr("hermes_constants.get_hermes_home", lambda: hermes_home)
|
|
monkeypatch.setattr("hermes_cli.config.get_hermes_home", lambda: hermes_home)
|
|
|
|
result = await _make_runner()._handle_model_command(
|
|
_make_event("/model gpt-5.5 --global")
|
|
)
|
|
|
|
assert result is not None
|
|
written = yaml.safe_load(cfg_path.read_text(encoding="utf-8"))
|
|
assert isinstance(written["model"], dict)
|
|
assert written["model"]["default"] == "gpt-5.5"
|
|
assert written["model"]["provider"] == "openrouter"
|
|
|
|
|