From 42dd8a993f71f40b997a883a03dcd683bbe6296c Mon Sep 17 00:00:00 2001 From: chengma Date: Mon, 6 Jul 2026 09:58:49 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20diagnose=20cmhub=20=E5=88=B7=E6=96=B0?= =?UTF-8?q?=E5=88=AB=E5=90=8D=20notfound=20and=20add=20T-530?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - troubleshooting.md: 新增「⑤ cmhub 刷新别名/测试连接 notfound(404)」排障节，确认请求达标，给 curl 隔离法（models vs balance） - cmhub-integration-design.md: §4.1 补 Base URL 必须为网关根约束 + v3.4 核对记录 - 06-tasks.md: 新增 T-530（Base URL 规整 + 404 明确提示） Co-Authored-By: Claude Opus 4.8 --- docs/06-tasks.md | 1 + docs/cmhub-integration-design.md | 2 ++ docs/troubleshooting.md | 32 +++++++++++++++++++++++++++++++- 3 files changed, 34 insertions(+), 1 deletion(-) diff --git a/docs/06-tasks.md b/docs/06-tasks.md index e2fc502..8d90e96 100644 --- a/docs/06-tasks.md +++ b/docs/06-tasks.md @@ -128,6 +128,7 @@ | T-527 | ⑤设置 cmhub 网关面板 | T-526, T-517 | 依据 `docs/cmhub-integration-design.md` v3.2。⑤ AI 设置按 `backend` 切换：cmhub 模式显示「网关 Base URL + API Key（打码，提示从网页端复制、仅显示一次）+ 生文别名 + 生图别名 + 测试连接/查余额」；**别名从 `GET /api/v1/models`（T-526 的 `fetch_cmhub_models`）动态拉取渲染下拉**，按 `operation_type` 分生文/生图，过滤 `pricing_status="unpriced"` 的别名，可展示单价与 `requires_image` 提示，选中值持久化到 `ai.cmhub.title_alias/image_alias`（网关临时不可达时回退已存值）；不写死别名。direct 模式保留现有 AI 模型 master-detail。保存写 `config.json` 的 `ai` 段与 `config/cmhub.json`；切换 backend 时不删除 legacy `config/ai_models.json`。测试连接/查余额经后台 worker 调 cmhub（复用 `AIModelTestWorker` 思路或新增 worker），错误必须脱敏并给用户可读提示。同步 GUI 设置测试；不改 Shopee/CDP 流程 | DONE | | T-528 | ② 计费错误提示 + 余额展示 | T-526, T-527, T-303 | 依据 `docs/cmhub-integration-design.md` v3.2。② AI生成页把 cmhub 计费失败态显式化：通过 `CMHubError.code` 识别 `insufficient_points`，弹明确提示「点数不足，请先充值」并引导去网页端充值，本轮未开始任务可提前中止，不靠中文字符串匹配、不淹没在失败计数里；用 T-526 成功响应事件里的 `points_balance` 刷新②页剩余点数显示，`/balance` 仅作手动刷新/可选批量前预检；`points_cost`/`call_id` 记入脱敏 run_logs。只改② UI、`GenerateWorker` 事件处理/文案及 GUI 单测；不改 AI HTTP 协议、DB schema、Excel、Shopee/CDP 流程 | DONE | | T-529 | 默认 cmhub 网关并隐藏 AI 后端选择 | T-528, T-527 | 产品收口：后续普通用户只使用 cmhub 网关，不再在⑤设置页暴露「AI 后端」label 与 direct/cmhub 下拉框。方案：`DEFAULT_CONFIG.ai.backend` 改为 `cmhub`；⑤设置页默认直接展示 cmhub 网关配置（Base URL、API Key、生文/生图别名、刷新别名、测试连接/查余额），隐藏 direct 模型选择、模型详情、标题/图片模型角色下拉和「AI 后端」下拉；保存设置固定写 `ai.backend=cmhub`，允许先保存不完整 cmhub 配置，②生成时仍由 `app/ai.py` 对缺 Base URL/Key/别名给出「请去⑤配置 cmhub」错误。direct 代码、`config/ai_models.json` helper 与 direct 单测保留为内部兼容/手工回滚路径，但普通 UI 不提供切换入口。同步 `appconfig`、⑤设置页、②余额默认显示和 GUI/appconfig 单测；不改 AI HTTP 协议、DB schema、Excel、Shopee/CDP 流程 | DONE | +| T-530 | cmhub Base URL 规整 + 404 明确提示 | T-526, T-527 | 现象：手动填入 Base URL 后点「刷新别名」提示 notfound（HTTP 404）。核对确认 cmshopee 请求已达标（`GET /api/v1/models` + Bearer，对齐对接文档 §4.4 与 cmhub `ModelsView` 路由，见 `docs/troubleshooting.md`「cmhub 刷新别名 notfound」与 `docs/cmhub-integration-design.md` v3.4）；404 根因是 Base URL 带多余 `/api(/v1)` 路径导致双拼、或所连实例未部署 `/api/v1/models`。方案：保存/请求前规整 Base URL——去掉结尾的 `/`、`/api`、`/api/v1` 等多余路径段，只保留 scheme+host(+port)（`appconfig.cmhub_request_url()` 或保存时统一处理），并在⑤输入框旁给出「只填网关根，如 https://host」提示；`_cmhub_code_for_status` 给 404 一个明确码/中文提示（如「cmhub 接口不存在，请检查 Base URL 或该实例是否已部署 /api/v1/models」），不再透传生涩英文原文。补 `test_appconfig`（Base URL 规整：带 `/api/v1`、带尾斜杠、带路径均归一到根）与 `test_ai`（404 → 明确提示）单测；不改 AI HTTP 协议、DB schema、Excel、Shopee/CDP 流程 | TODO | ## Phase 8 · 工程基础设施后续（`docs/engineering-review.md`） diff --git a/docs/cmhub-integration-design.md b/docs/cmhub-integration-design.md index 9f72374..9243370 100644 --- a/docs/cmhub-integration-design.md +++ b/docs/cmhub-integration-design.md @@ -9,6 +9,7 @@ > **v3.1 修订（2026-07-04，实现前澄清）**：当时为保护既有直连流程，要求全新配置默认 backend 为 `direct`（cmhub 显式 opt-in），且 `backend=cmhub` 但未配置时须抛清晰"去⑤配置"错误而非崩溃（见 §4.1）；② 明确"返回值不变"≠"回调不变"——计费元数据须给 `gen_title`/`gen_cover` **新增可选事件回调参数**承载，是向后兼容加参（见 §4.2）。默认策略已被 v3.3/T-529 覆盖为普通产品默认 cmhub。 > **v3.2 修订（2026-07-04，同步对接文档新增）**：cmhub 新增第 4 个接口 `GET /api/v1/models`（别名自助发现，见 §4.6），⑤设置别名由手填改为**动态下拉**（按 `operation_type` 分生文/生图、过滤 `unpriced`、展示单价、`requires_image` 提示），关闭原待确认 #1；仅 Base URL 仍待部署方提供。 > **v3.3 修订（2026-07-04，产品收口）**：普通用户后续默认使用 `cmhub` 网关；⑤设置页去掉「AI 后端」label 和 direct/cmhub 下拉，直接展示 cmhub 网关配置。`direct` 代码和 `config/ai_models.json` 保留为内部兼容/手工回滚路径，但普通 UI 不提供切换入口；保存设置固定写 `ai.backend=cmhub`，允许先保存不完整 cmhub 配置，②生成时再提示去⑤补齐 Base URL/API Key/别名。已同步 T-529。 +> **v3.4 核对（2026-07-06，刷新别名 notfound）**：核对对接文档 §4.4 与 cmhub `ModelsView` 路由，确认 cmshopee `GET /api/v1/models` + Bearer 请求**已达标**；「notfound」为 404，根因是 Base URL 带多余 `/api(/v1)` 路径（双拼）或所连实例未部署 `/api/v1/models`（见 `docs/troubleshooting.md`）。健壮性改进（Base URL 规整 + 404 明确提示）落 **T-530**。 ## 1. 背景与目标 @@ -66,6 +67,7 @@ - **cmhub API Key 不进 `config.json`**（避免与其它设置混放、避免误提交）。固定存到 `config/cmhub.json`，文件 schema 第一版为 `{ "api_key": "sk_cmhub_xxx" }`；新增 `CMHUB_CONFIG_PATH`、`load_cmhub_config()`、`save_cmhub_config()`、`get_cmhub_api_key(masked=False)` 等 helper；`config/cmhub.json` 必须加入 `.gitignore`。沿用现有"本地明文保存但 gitignore + UI 打码 + 日志脱敏"纪律（T-503）。 - **`ai_models.json` 去留**：`direct` 模式继续用；`cmhub` 模式不读它。文件保留但标记 legacy。 - **默认 backend 与配置不完整处理（T-529 后）**：`DEFAULT_CONFIG` / `default_config()` 造全新配置时写 `backend=cmhub`；⑤设置页隐藏 direct/cmhub 下拉并固定保存 `backend=cmhub`。允许先保存不完整 cmhub 配置，便于用户先保存其它路径/安全设置；②生成真正调用时如果 `base_url`/Key/别名缺失，必须抛**清晰的"请去⑤配置 cmhub"错误**（`CMHubError`/`AIError`），不得崩溃或静默回退 direct。显式手工配置 `backend=direct` 仍作为内部回滚路径保留，但普通 UI 不提供入口。 +- **Base URL 必须是网关根**：只填 `https://`，**不带** `/api`、`/api/v1` 或任何路径。`cmhub_request_url()` 会自行拼 `/api/v1/...`；若 Base URL 已含 `/api/v1`，会双拼成 `.../api/v1/api/v1/...` → 404（正是「刷新别名 notfound」现象，见 `docs/troubleshooting.md`）。**当前请求本身已达标**（`GET /api/v1/models` + `Authorization: Bearer `，对齐对接文档 §4.4 与 cmhub `ModelsView` 路由）；404 的根因是 Base URL 带多余路径或所连实例未部署 `/api/v1/models`。**T-530** 将在保存/请求前规整 Base URL 去掉多余 `/api(/v1)` 尾部，并给 404 明确中文提示。 ### 4.2 `gen_title` 改造（cmhub 分支） diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 75ae2ce..d883bb3 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -134,6 +134,36 @@ https://api.vectorengine.ai/v1/chat/completions ```powershell python -c "import json; from urllib.parse import urlsplit,urlunsplit; p='config/ai_models.json'; data=json.load(open(p,encoding='utf-8')); [print({'name':m.get('name'),'category':m.get('category'),'api_type':m.get('api_type'),'url_without_query':urlunsplit((urlsplit(m.get('url','')).scheme,urlsplit(m.get('url','')).netloc,urlsplit(m.get('url','')).path,'','')),'has_api_key':bool(m.get('api_key'))}) for m in data.get('models', [])]" ``` +## ⑤ cmhub「刷新别名 / 测试连接」提示 notfound / 404 + +### 现象 + +在⑤设置切到 cmhub 后端，手动填入 Base URL、API Key，点「刷新别名」或「测试连接」，提示 `notfound`（即 HTTP 404）。 + +### 原因 + +先明确：**cmshopee 的请求本身是达标的**——`GET {Base URL}/api/v1/models`，头 `Authorization: Bearer `，与对接文档《cmhub-接口对接文档-桌面端生文生图》§4.4 和 cmhub 服务端路由 `path("v1/models", ModelsView)` 完全一致。404 表示服务端已响应但该路径不存在，原因在请求之外，通常是两类： + +1. **Base URL 填了多余路径（手动填入最常见）**：Base URL 只能填**网关根**，例如 `https://cmhub.example.com`。当前 `appconfig.cmhub_request_url()` 是 `base_url.rstrip("/") + "/api/v1/models"`，**不会**替你去掉结尾的 `/api` 或 `/api/v1`；若你填成 `https://host/api/v1`，会拼成 `.../api/v1/api/v1/models` → 404。 +2. **连的那台 cmhub 实例没有该路由**：`ModelsView` 在 cmhub 仓库代码里有，但**运行中的实例**若未重新部署/重启，`/api/v1/models`（较新接口）会 404，而 `/api/v1/balance`（较老接口）可能正常。 + +### 隔离方法（一条 curl 定位） + +```bash +curl -i "https://<你的BaseURL>/api/v1/models" -H "Authorization: Bearer sk_cmhub_xxx" +curl -i "https://<你的BaseURL>/api/v1/balance" -H "Authorization: Bearer sk_cmhub_xxx" +``` + +- 两个都 404 → **Base URL 填错**，改成网关根（不带 `/api`、`/api/v1`）。 +- balance 通、models 404 → **cmhub 实例未更新**，让部署方重启/重部署带上 `ModelsView`。 +- models 通 → cmshopee 侧别的问题，回代码排查。 + +> 不要把 API Key 贴进日志、文档或聊天；curl 里的 `sk_cmhub_xxx` 是占位。 + +### 待改进（T-530） + +`cmhub_request_url()` 目前不规整带 `/api`/`/api/v1` 的 Base URL，且 404 落到 `unknown` 后透传生涩英文原文。跟进任务 T-530 将：保存/请求前规整 Base URL 去掉多余 `/api(/v1)` 尾部；给 404 一个明确中文提示（“cmhub 接口不存在，检查 Base URL 或该实例是否已部署 /api/v1/models”）。 + ## AI生成：标题成功但图片生成失败，且看不到原因 当前代码会为 ② AI生成写两层日志： @@ -141,4 +171,4 @@ python -c "import json; from urllib.parse import urlsplit,urlunsplit; p='config/ - 页面右下「AI生成运行日志」显示最近一次 `run_type=generate` 的逐条事件，例如 `phase=cover step=cover_request result=failed detail=...`。 - 本地 `logs/cmshopee.log` 保存脱敏后的 traceback、任务 id、alias、item_id、phase 和 step，用于判断卡在模型配置、封面请求、图片解析、保存文件还是写库。 -排查顺序：先看 ② 页面运行日志里的 `phase` / `step` / `detail`；如果只看到简短错误，再查看本地 `logs/cmshopee.log`。不要把 `config/ai_models.json` 或 API Key 发到聊天、文档或提交里。 +排查顺序：先看 ② 页面运行日志里的 `phase` / `step` / `detail`；如果只看到简短错误，再查看本地 `logs/cmshopee.log`。不要把 `config/ai_models.json` 或 API Key 发到聊天、文档或提交里。