JiuwenSwarm is an intelligent AI Agent built on openJiuwen. It extends the powerful capabilities of large language models directly to your fingertips through various communication apps you use daily.
Python
# Copyright (c) Huawei Technologies Co., Ltd. 2026. All rights reserved.
"""LLM 客户端补丁粒度拆分与渠道门控的回归测试。
背景(code review P0 / P1):
* P0 —— ``apply_openai_sse_invoke_patch`` 原先把 4 个互相独立的补丁捆绑成一个整体,
并被 ``channels.xiaoyi.mode == "xiaoyi_claw"`` 整体门控。OfficeClaw + Huawei MaaS
生产链路只依赖其中与渠道无关的 3 个(GLM XML 清洗 / Authorization 保留 /
MaaS x-span-id 注入),门控为 False 时 Authorization 补丁随之失效,网关报
APIG.0303。本文件第一条用例即为该回归的防护点。
* P1 —— 门控读取的是会被 Web UI 保存流程清理掉的顶层 ``channels.xiaoyi.mode``,
而 ``mode`` 的规范位置是 ``channels.xiaoyi.apps[].mode``。
"""
from __future__ import annotations
import asyncio
import logging
from types import SimpleNamespace
from typing import Any
import pytest
import jiuwenswarm.llm_sse_patch as patch_mod
from jiuwenswarm.server import app_agentserver
from openjiuwen.core.foundation.llm import headers_helper
from openjiuwen.core.foundation.llm.model_clients import openai_model_client as oai_mod
_MODULE_PATCH_FLAGS = (
"_PATCH_APPLIED",
"_AUTH_HEADER_PATCH_APPLIED",
"_RESPONSE_ASSEMBLY_PATCH_APPLIED",
"_GLM_XML_SANITIZE_PATCH_APPLIED",
"_MAAS_SPAN_ID_PATCH_APPLIED",
"_MAAS_PROFILE_SPAN_PATCH_APPLIED",
)
_CLIENT_PATCH_FLAGS = (
"_response_assembly_patch_applied",
"_glm_xml_sanitize_patch_applied",
"_maas_span_id_patch_applied",
"_auth_default_headers_patch_applied",
)
@pytest.fixture()
def fresh_patch_state(monkeypatch: pytest.MonkeyPatch) -> None:
"""清空所有补丁幂等标志,模拟「服务启动早期尚未打补丁」的进程状态。"""
for name in _MODULE_PATCH_FLAGS:
monkeypatch.setattr(patch_mod, name, False, raising=False)
for name in _CLIENT_PATCH_FLAGS:
monkeypatch.setattr(oai_mod.OpenAIModelClient, name, False, raising=False)
monkeypatch.delattr(
oai_mod.OpenAIModelClient,
"_response_assembly_original_parse_response",
raising=False,
)
monkeypatch.setattr(headers_helper, "_auth_header_patch_applied", False, raising=False)
# 新核心 maas profile 的 x-span-id transform 也可能已被替换;还原为原生实现,
# 让「未打补丁」状态完整(旧核心无该模块,直接跳过)。
try:
from openjiuwen.core.foundation.llm.utils import endpoint_profiles
except ImportError:
pass
else:
native_transform = getattr(endpoint_profiles, "_inject_x_span_id", None)
if callable(native_transform):
monkeypatch.setitem(
endpoint_profiles.REQUEST_HEADER_TRANSFORMS,
"inject_x_span_id",
native_transform,
)
# ── P0:补丁粒度与幂等 ────────────────────────────────────────────────
def test_channel_independent_patches_apply_without_sse_assembly(
fresh_patch_state: None,
) -> None:
"""P0 回归:即使不启用 SSE 响应组装补丁,其余 3 个补丁仍必须全部生效。
这正是 OfficeClaw 部署下的场景——配置中没有 xiaoyi_claw 渠道,
但 Authorization 保留 / GLM 清洗 / MaaS x-span-id 一个都不能少。
"""
patch_mod.apply_openai_auth_header_patch()
patch_mod.apply_glm_tool_xml_sanitize_patch()
patch_mod.apply_huawei_maas_span_id_patch()
# ③ Authorization 保留必须生效
assert headers_helper._auth_header_patch_applied is True # pylint: disable=protected-access
headers = headers_helper.build_base_headers(
custom_headers={"Authorization": "Basic dGVzdA=="}
)
assert headers.get("Authorization") == "Basic dGVzdA=="
# ② GLM XML 清洗 与 ④ MaaS x-span-id 注入必须生效
assert oai_mod.OpenAIModelClient._glm_xml_sanitize_patch_applied is True # pylint: disable=protected-access
assert oai_mod.OpenAIModelClient._maas_span_id_patch_applied is True # pylint: disable=protected-access
# ① SSE 响应组装补丁必须保持未启用(它才需要按渠道门控)
assert (
getattr(oai_mod.OpenAIModelClient, "_response_assembly_patch_applied", False) is False
)
assert patch_mod._RESPONSE_ASSEMBLY_PATCH_APPLIED is False # pylint: disable=protected-access
def test_granular_patches_are_individually_idempotent(fresh_patch_state: None) -> None:
"""P0 回归:每个补丁拥有独立幂等标志,重复调用不得二次包装。"""
patch_mod.apply_openai_auth_header_patch()
patch_mod.apply_glm_tool_xml_sanitize_patch()
wrapped_stream_chunk = oai_mod.OpenAIModelClient._parse_stream_chunk # pylint: disable=protected-access
patch_mod.apply_glm_tool_xml_sanitize_patch()
assert oai_mod.OpenAIModelClient._parse_stream_chunk is wrapped_stream_chunk # pylint: disable=protected-access
patch_mod.apply_huawei_maas_span_id_patch()
wrapped_invoke = oai_mod.OpenAIModelClient.invoke
patch_mod.apply_huawei_maas_span_id_patch()
assert oai_mod.OpenAIModelClient.invoke is wrapped_invoke
patch_mod.apply_openai_response_assembly_patch()
wrapped_parse_response = oai_mod.OpenAIModelClient._parse_response # pylint: disable=protected-access
patch_mod.apply_openai_response_assembly_patch()
assert oai_mod.OpenAIModelClient._parse_response is wrapped_parse_response # pylint: disable=protected-access
def test_aggregate_entry_still_applies_all_patches(fresh_patch_state: None) -> None:
"""兼容入口 ``apply_openai_sse_invoke_patch`` 仍应一次性应用全部 4 个补丁。"""
patch_mod.apply_openai_sse_invoke_patch()
assert headers_helper._auth_header_patch_applied is True # pylint: disable=protected-access
assert oai_mod.OpenAIModelClient._glm_xml_sanitize_patch_applied is True # pylint: disable=protected-access
assert oai_mod.OpenAIModelClient._maas_span_id_patch_applied is True # pylint: disable=protected-access
assert oai_mod.OpenAIModelClient._response_assembly_patch_applied is True # pylint: disable=protected-access
# ── MaaS x-span-id 注入与既有值 ──────────────────────────────────────
def test_maas_span_id_keeps_existing_value(
monkeypatch: pytest.MonkeyPatch, fresh_patch_state: None
) -> None:
"""调用方 / 扩展已给出 x-span-id 时保留原值,MaaS 自动注入只做兜底。"""
recorded: list[dict[str, Any]] = []
async def _fake_invoke(self: Any, *args: Any, **kwargs: Any):
recorded.append(kwargs)
return "ok"
monkeypatch.setattr(oai_mod.OpenAIModelClient, "invoke", _fake_invoke)
patch_mod.apply_huawei_maas_span_id_patch()
client = SimpleNamespace(
model_client_config=SimpleNamespace(api_base="https://modelarts-maas.cn/v1"),
)
asyncio.run(
oai_mod.OpenAIModelClient.invoke(
client, custom_headers={"X-SPAN-ID": "ext-span-1"}
)
)
# 大小写不同也视为已提供,不再生成第二份
assert recorded[0]["custom_headers"] == {"X-SPAN-ID": "ext-span-1"}
asyncio.run(oai_mod.OpenAIModelClient.invoke(client))
injected = recorded[1]["custom_headers"]["x-span-id"]
assert len(injected) == 32 and all(c in "0123456789abcdef" for c in injected)
def test_inject_span_id_keeps_existing_value() -> None:
"""MaaS profile 的注入实现:已有非空值时保留,空值则兜底并清掉空键。"""
headers = patch_mod._ensure_span_id( # pylint: disable=protected-access
{"X-SPAN-ID": "ext-span-1"}
)
assert headers == {"X-SPAN-ID": "ext-span-1"}
auto = patch_mod._ensure_span_id( # pylint: disable=protected-access
{"x-span-id": " "}
)
assert [k for k in auto if k.lower() == "x-span-id"] == ["x-span-id"]
assert len(auto["x-span-id"]) == 32
def test_maas_profile_transform_is_patched() -> None:
"""新核心的 maas profile transform 必须被替换为「已有非空值则保留」。"""
endpoint_profiles = pytest.importorskip(
"openjiuwen.core.foundation.llm.utils.endpoint_profiles"
)
patch_mod.apply_huawei_maas_span_id_patch()
transform = endpoint_profiles.REQUEST_HEADER_TRANSFORMS["inject_x_span_id"]
headers = transform({"X-SPAN-ID": "ext-span-1"})
assert headers == {"X-SPAN-ID": "ext-span-1"}
auto = transform({"x-span-id": ""})
assert [k for k in auto if k.lower() == "x-span-id"] == ["x-span-id"]
assert len(auto["x-span-id"]) == 32
def test_maas_profile_build_headers_end_to_end() -> None:
"""端到端:custom_headers 经 _build_request_headers 后只含一个 span id。"""
pytest.importorskip("openjiuwen.core.foundation.llm.utils.endpoint_profiles")
patch_mod.apply_huawei_maas_span_id_patch()
client = SimpleNamespace(
model_client_config=SimpleNamespace(endpoint_profile="maas"),
_endpoint_profile_name=lambda: "maas",
)
headers = oai_mod.OpenAIModelClient._build_request_headers( # pylint: disable=protected-access
client, {}, {"X-SPAN-ID": "ext-span-1"}
)
assert [k for k in headers if k.lower() == "x-span-id"] == ["X-SPAN-ID"]
assert headers["X-SPAN-ID"] == "ext-span-1"
def test_maas_span_id_replaces_blank_value(
monkeypatch: pytest.MonkeyPatch, fresh_patch_state: None
) -> None:
"""空/纯空白 x-span-id 视为未提供:清掉空键并注入 uuid,避免下游收到空值。"""
recorded: list[dict[str, Any]] = []
async def _fake_invoke(self: Any, *args: Any, **kwargs: Any):
recorded.append(kwargs)
return "ok"
monkeypatch.setattr(oai_mod.OpenAIModelClient, "invoke", _fake_invoke)
patch_mod.apply_huawei_maas_span_id_patch()
client = SimpleNamespace(
model_client_config=SimpleNamespace(api_base="https://modelarts-maas.cn/v1"),
)
asyncio.run(
oai_mod.OpenAIModelClient.invoke(
client, custom_headers={"X-SPAN-ID": " "}
)
)
headers = recorded[0]["custom_headers"]
assert [k for k in headers if k.lower() == "x-span-id"] == ["x-span-id"]
assert len(headers["x-span-id"]) == 32
# ── 流式请求发送前日志 ───────────────────────────────────────────────
def test_stream_logs_request_before_send(
monkeypatch: pytest.MonkeyPatch, fresh_patch_state: None, caplog: pytest.LogCaptureFixture
) -> None:
"""无论后续是否超时,发请求前都必须先落一行(带 span/模型/超时参数)。"""
async def _fake_stream(self: Any, *args: Any, **kwargs: Any):
yield "chunk-1"
raise asyncio.CancelledError()
monkeypatch.setattr(oai_mod.OpenAIModelClient, "stream", _fake_stream)
patch_mod.apply_huawei_maas_span_id_patch()
client = SimpleNamespace(
model_client_config=SimpleNamespace(
api_base="https://modelarts-maas.cn/v1",
stream_idle_timeout=60,
),
model_config=SimpleNamespace(model_name="glm-5.3"),
)
caplog.set_level(logging.INFO, logger="jiuwenswarm.llm_sse_patch")
async def _run() -> None:
async for _chunk in oai_mod.OpenAIModelClient.stream(
client, messages=[{"role": "user", "content": "hi"}], model="glm-5.3"
):
pass
with pytest.raises(asyncio.CancelledError):
asyncio.run(_run())
line = next(
r.getMessage() for r in caplog.records if "[MODEL_HTTP] begin" in r.getMessage()
)
assert "span=" in line
assert "model=glm-5.3" in line
assert "host=modelarts-maas.cn" in line
assert "idle_timeout=60" in line
# 失败也必须留下 end 汇总,不能只在正常结束时打
end = next(
r.getMessage() for r in caplog.records if "[MODEL_HTTP] end" in r.getMessage()
)
assert "status=error" in end
assert "chunks=1" in end
assert "exc=CancelledError" in end
# end 必须带上本次尝试的 span,失败行才能直接拿去 MaaS 侧对账
assert f"span={line.split('span=', 1)[1].split(' ', 1)[0]}" in end
# ── P1:渠道门控读取路径 ──────────────────────────────────────────────
def _stub_config(monkeypatch: pytest.MonkeyPatch, config: dict[str, Any]) -> None:
monkeypatch.setattr("jiuwenswarm.common.config.get_config", lambda: config)
def test_gate_matches_mode_inside_xiaoyi_apps(monkeypatch: pytest.MonkeyPatch) -> None:
"""规范路径 ``channels.xiaoyi.apps[].mode`` 必须能命中 xiaoyi_claw。"""
_stub_config(
monkeypatch,
{
"channels": {
"xiaoyi": {
"apps": [{"mode": "chat"}, {"mode": "xiaoyi_claw"}],
"send_file_allowed": True,
}
}
},
)
assert app_agentserver._should_apply_sse_invoke_patch() is True # pylint: disable=protected-access
def test_gate_returns_false_for_officeclaw_only_deployment(
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""OfficeClaw 部署(无 xiaoyi_claw)下门控应为 False,且不影响其他补丁。"""
_stub_config(
monkeypatch,
{
"channels": {
"officeclaw": {"send_file_allowed": True},
"xiaoyi": {"apps": [{"mode": "chat"}], "send_file_allowed": True},
}
},
)
assert app_agentserver._should_apply_sse_invoke_patch() is False # pylint: disable=protected-access
def test_gate_supports_legacy_flat_mode(monkeypatch: pytest.MonkeyPatch) -> None:
"""旧平铺格式 ``channels.xiaoyi.mode`` 仍应被兼容。"""
_stub_config(monkeypatch, {"channels": {"xiaoyi": {"mode": "xiaoyi_claw"}}})
assert app_agentserver._should_apply_sse_invoke_patch() is True # pylint: disable=protected-access
def test_gate_defaults_to_true_when_config_unavailable(
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""启动早期读配置失败时保守兜底为 True(保持原有行为)。"""
def _raise() -> dict[str, Any]:
raise RuntimeError("config not ready")
monkeypatch.setattr("jiuwenswarm.common.config.get_config", _raise)
assert app_agentserver._should_apply_sse_invoke_patch() is True # pylint: disable=protected-access
def test_runtime_refresh_applies_patch_after_xiaoyi_claw_is_enabled(
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""运行时启用 xiaoyi_claw 后无需重启即可补打 SSE 响应组装补丁。"""
config = {"channels": {"xiaoyi": {"apps": [{"mode": "xiaoyi_channel"}]}}}
calls: list[bool] = []
_stub_config(monkeypatch, config)
monkeypatch.setattr(
app_agentserver,
"apply_openai_response_assembly_patch",
lambda: calls.append(True),
)
assert app_agentserver.refresh_openai_response_assembly_patch() is False
config["channels"]["xiaoyi"]["apps"][0]["mode"] = "xiaoyi_claw"
assert app_agentserver.refresh_openai_response_assembly_patch() is True
assert calls == [True]
def test_runtime_refresh_removes_patch_after_xiaoyi_claw_is_disabled(
monkeypatch: pytest.MonkeyPatch,
fresh_patch_state: None,
) -> None:
"""运行时禁用 xiaoyi_claw 后应恢复原方法,避免影响其他渠道。"""
config = {"channels": {"xiaoyi": {"apps": [{"mode": "xiaoyi_claw"}]}}}
_stub_config(monkeypatch, config)
original = oai_mod.OpenAIModelClient._parse_response # pylint: disable=protected-access
assert app_agentserver.refresh_openai_response_assembly_patch() is True
assert oai_mod.OpenAIModelClient._parse_response is not original # pylint: disable=protected-access
config["channels"]["xiaoyi"]["apps"][0]["mode"] = "chat"
assert app_agentserver.refresh_openai_response_assembly_patch() is False
assert oai_mod.OpenAIModelClient._parse_response is original # pylint: disable=protected-access
assert (
oai_mod.OpenAIModelClient._response_assembly_patch_applied # pylint: disable=protected-access
is False
)