补齐三个成功响应缺失的 meta 信封;信封实现抽为公共(docs/05 §3.3)

"缺 meta"很容易被误判成"有":X-Trace-ID 是**响应头**(中间件加),和 body 里的
meta.trace_id 是两件事;错误响应一直有 meta(异常处理器统一加),漏的只有成功路径。

核到三个端点在把 service 的内部结构直接当响应体返回:

- GET /conversations/{session_id}/messages → 裸 {"data": [...]},meta 整个缺失,
  游标也没地方放(§3.3 要求列表的 data 为纯数组、next_cursor/has_more 进 meta)
- POST /conversation-messages/{id}/feedback → 同样没有 meta
- GET /knowledge-references/{token} → 直接返回资源对象

改动:

- 新增 app/api/views/envelope.py,把 envelope / list_envelope 抽成一份公共实现,
  风控链路改为复用它 —— 同一份契约写两遍的结果就是其中一处漏了 meta。
- ConversationService.messages 改为返回内部结构 {items, next_cursor, has_more},
  用 limit + 1 判断 has_more:只看"取满没取满"会把恰好等于 limit 的最后一页说成
  还有下一页。next_cursor 取本页最后一条的 message_id —— 游标语义是"取更旧的一页",
  天然可续,集成测试本来就是这么翻页的。
- Controller 统一套信封,data 仍是数组、字段名不变,前端不需要改。

测试:新增 tests/unit/api/test_response_envelope.py,断言 set(body) == {"data","meta"}
(多或少一个顶层字段都会红),并覆盖 has_more / next_cursor / trace_id;
另更新两处既有断言(limit 20→21、feedback 返回裸对象)。

门禁:ruff 干净 / mypy 138 文件 / 696 unit+contract / 33 integration。
This commit is contained in:
2026-09-11 15:21:36 +08:00
parent 575b4c2baa
commit 8d79bd9767
7 changed files with 212 additions and 36 deletions
+6 -2
View File
@@ -5,6 +5,7 @@ from app.api.dependencies.auth import build_request_context
from app.api.dependencies.database import get_session
from app.api.dependencies.rate_limit import enforce_rate_limit
from app.api.schemas.conversations import FeedbackRequest
from app.api.views.envelope import envelope, list_envelope
from app.core.contracts import RequestContext
from app.core.cursor import parse_cursor
from app.service.conversation_service import ConversationService
@@ -28,9 +29,10 @@ async def list_messages(
`400 INVALID_CURSOR`,而不是被静默忽略后返回第一页。
"""
before = parse_cursor(cursor)
return await ConversationService(session).messages(
page = await ConversationService(session).messages(
session_id, context, limit, before=before
)
return list_envelope(page, context)
@router.post("/conversation-messages/{message_id}/feedback", status_code=status.HTTP_201_CREATED)
@@ -40,5 +42,7 @@ async def create_feedback(
context: RequestContext = Depends(build_request_context), # noqa: B008
session: AsyncSession = Depends(get_session), # noqa: B008
) -> dict[str, object]:
return await ConversationService(session).feedback(
# 与消息列表同理:§3.3 的信封由 Controller 统一套,service 只负责业务数据。
data = await ConversationService(session).feedback(
message_id, context, payload.rating, payload.feedback_type, payload.feedback_content)
return envelope(data, context)
+5 -1
View File
@@ -2,6 +2,7 @@ from fastapi import APIRouter, Depends, Path
from app.api.dependencies.auth import build_request_context
from app.api.dependencies.rate_limit import enforce_rate_limit
from app.api.views.envelope import envelope
from app.core.contracts import RequestContext
from app.service.knowledge_service import KnowledgeReferenceService
@@ -14,4 +15,7 @@ async def resolve_reference(
reference_token: str = Path(min_length=20, max_length=300),
context: RequestContext = Depends(build_request_context), # noqa: B008
) -> dict[str, object]:
return await KnowledgeReferenceService().resolve(context, reference_token)
# §3.3:成功响应也要有 `meta.trace_id`。此前这里直接返回资源对象,客户端拿不到
# 本次请求的追踪标识,出问题时无法与服务端日志对上。
data = await KnowledgeReferenceService().resolve(context, reference_token)
return envelope(data, context)
+4 -25
View File
@@ -24,6 +24,8 @@ from app.api.schemas.risk import (
RiskEvidenceSource,
RiskNotificationPageQuery,
)
from app.api.views.envelope import envelope as _envelope
from app.api.views.envelope import list_envelope as _list_envelope
from app.core.contracts import RequestContext
from app.core.errors import SseNotAcceptableError
from app.infrastructure.db import mysql_scan_lock
@@ -304,28 +306,5 @@ async def send_risk_daily_report_mail(
return _envelope(data, context)
def _envelope(data: object, context: RequestContext) -> dict[str, object]:
return {
"data": data,
"meta": {"trace_id": context.trace_id},
}
def _list_envelope(page: dict[str, Any], context: RequestContext) -> dict[str, object]:
"""列表资源的信封(docs/05 §3.3)。
§3.3 的列表样例是 `data` 为**纯数组**、游标与 `has_more` 放在 `meta` 里,并且明确
「业务接口不得增加其他顶层字段」。而 `RiskQueryService._page` 返回的是
`{items, next_cursor, has_more}` —— 整体塞进 `data` 后,游标跑进了**业务数据**里、
`meta` 只剩 trace_id,两处都不符合契约。
这里统一拆包;service 侧不必改(它继续返回那个内部结构,只是不再直接当 `data` 用)。
"""
return {
"data": page.get("items") or [],
"meta": {
"trace_id": context.trace_id,
"next_cursor": page.get("next_cursor"),
"has_more": bool(page.get("has_more")),
},
}
# `_envelope` / `_list_envelope` 已抽到 `app/api/views/envelope.py`,与客服链路共用同一份
# §3.3 实现 —— 两处各写一份的结果就是其中一处漏了 `meta`。