Skip to content

增加向github issue报告渠道,在github web中 #3299

Closed

Description

@ranxianglei

增加向github issue报告渠道,在github web中

用户会遇到很多问题,每次都是找人沟通,成本很高.

现在需要web上向用户报告反馈的专栏,或者弹窗,浮窗等 现在应该有一点基础设施但是不全

需要补全

Activity

  1. ranxianglei commented on Oct 15, 2026

    @ranxianglei
    OwnerAuthor

    🤖 Powered by ework · qwen3.8-27b

    (ai: vllm-qwen/qwen3.8-27b)

    查重: 不重复。 按「github issue 报告 / 反馈 / web 弹窗 / diagnostics 上报」等多组关键词检索了 open+closed issue,没有同类需求。最接近的 #3040 / #3057 / #3235 都是本 issue 要补全的底层设施(见下),不是重复提报。

    审核结论(功能类): 合理且与现有架构契合——#3040 建 buildDiagnostics 时的设计目标原文就是「让任何未来的警告都能挂『复制诊断/在 GitHub 报告』按钮,不用各自发明管道」。这个 issue 正是把这条管道补成用户可达的完整渠道。已核实现状:

    现有基础设施(不全的部分):

    1. src/web/diagnostics.ts — 生成环境诊断 blob + 预填好 title/body 的 GitHub issues/new 链接;目前只注册了 2 个 topic(storage-legacy-only、conflict-banner)
    2. /__bili/diagnostics?topic= 端点(loopback 限制,与其它 /__bili/* 一致)
    3. Web UI 里只有两个警告横幅(存储降级、压缩冲突)带「复制诊断 + 在 GitHub 反馈」按钮

    缺口(即本 issue 要补的):

    • 没有任何常驻入口:没触发横幅的问题(用户遇到的大多数情况)在 web 上无处报告,只能找人沟通——正是 issue 说的痛点
    • 诊断 blob 里带不上用户自己的问题描述
    • 会话详情页的报告只能下载 MD/PNG(支持下载缓存会话报告 #3057),不能直接带着会话信息去 GitHub 开 issue

    实现方案(扩展 #3040 设施,不另起炉灶):

    1. 顶栏加常驻「反馈」入口 → 弹窗:问题描述输入框 + 「附带最近错误日志」开关(默认开)+ 「复制诊断」「在 GitHub 提交」两个动作
    2. diagnostics.ts 注册 general topic(环境事实 + 最近 N 行 error 级日志,日志本身已脱敏,不含会话内容/API key);端点支持 desc= 参数把用户描述拼进 body
    3. 会话详情页导出区加「报告此会话」→ 同一弹窗,描述框预填该会话指纹(id/协议/upstream/请求数/命中率)
    4. i18n zh/en + 单测(diagnostics 新 topic、弹窗 HTML、端点参数)

    无新增配置项/env(不动配置面)。开始实现,完成后回 PR 链接。

  2. ranxianglei commented on Oct 15, 2026

    @ranxianglei
    OwnerAuthor

    🤖 Powered by ework · qwen3.8-27b

    (ai: vllm-qwen/qwen3.8-27b)

    已完成,PR: #3310 (Closes #3299)

    做了什么:把 #3040 的 diagnostics 设施从「横幅专用」补全为常驻反馈渠道——

    • 顶栏新增常驻「反馈 / Report」按钮 → 弹窗:写问题描述(可选)+「附带最近错误日志」复选框(默认开,附公开可见性提示)→ 一键复制诊断文本或打开预填了完整诊断 + 你描述的 GitHub issue(issues/new?title=&body=);
    • topic=general:环境事实 + 磁盘会话数 + 最近 15 行 [error] 日志;?desc= 带用户描述、?errors=0 可关日志尾;
    • 会话详情导出行新增「报告此会话」:用紧凑指纹(会话尾号/协议/upstream/请求数/缓存命中率)预填,免去手动复制会话信息;
    • zh/en 文案对称(web-i18n 测试自动校验),README en+zh FAQ 同步;新测试 tests/web-report-channel.test.ts 钉住端点参数、错误行过滤、URL round-trip、弹窗与接线。

    结构化八问:

    1. 是什么问题:用户在 web UI 遇到不触发告警横幅的问题时没有自助报告渠道,只能找人沟通。
    2. 什么原因导致的:Surface a web warning (copyable diagnostics + GitHub prefilled issue link) when SQLite storage degrades to legacy-only — before the unified default flip #3040 设施按「横幅伴随物」设计,只有两个 topic 且仅横幅出现时可达,缺通用 topic 和常驻入口。
    3. 影响范围与严重程度:所有 web UI 用户;排障成本/体验问题,不影响功能可用性。
    4. 怎么修复的:同一设施覆盖面扩展——通用 topic + desc/errors 参数 + 顶栏按钮弹窗 + 会话预填入口,全部复用既有 loopback-only 端点与 i18n/样式体系。
    5. 是否有回归问题:无。sendDiagnostics 既有路径(topic 解析、未知 topic 降级、loopback 门禁)行为保持,新参数缺省时响应与旧版一致(既有 storage-banner 测试全绿);wire/请求管线未触碰,两种压缩模式不受影响。
    6. 是否破坏缓存:不涉及(弹窗刻意不走 60s 诊断缓存——描述是实时输入;横幅缓存未动)。
    7. 是否改了设计方向:不涉及。
    8. 是否引入新配置:无配置键/env/CLI flag;仅 /__bili/diagnostics 增加两个查询参数(desc/errors)。

    隐私边界:错误日志默认附带但可勾选关闭,弹窗明示内容公开且可能含本地路径;logger 已对密钥脱敏,对话内容永不进入报告。

    状态:rebase 到当前 master 后本地 typecheck + 定向测试(16/16)通过,等 CI 全局把关。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions