Skip to content

[PR] feat: persistent feedback entry in web UI — one-click generation of pre-filled diagnostic GitHub issue (#3299) | [PR] feat: web UI 常驻反馈入口——一键生成预填诊断的 GitHub issue (#3299) - #3310

Closed
ranxianglei wants to merge 3 commits into
masterfrom
wt-3299-ework-daemon

Conversation

@ranxianglei

Copy link
Copy Markdown
Owner

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

Closes #3299

背景

#3040 的 diagnostics 设施只服务两条告警横幅(存储降级、会话冲突)。用户遇到的大多数问题从不触发横幅——没有可用的报告路径,只能找人沟通。本 PR 把该设施补全为常驻反馈渠道。

改动

  1. topic=general(src/web/diagnostics.ts):环境事实 + 磁盘会话数 + 最近 15 行 [error] 日志;?desc= 把用户自己的问题描述带进 blob 和 issues/new?body= URL(body 可精确解码回 blob);?errors=0 可关闭日志尾巴(诚实输出「无近期错误」)。
  2. 常驻入口(src/web/page.ts + styles.ts):顶栏「反馈 / Report」按钮 → 弹窗:描述输入框、「附带最近错误日志」复选框(默认开,附公开可见性提示)、复制诊断 / 打开预填 GitHub issue / 取消,Esc/点遮罩关闭。z-index 90 介于 tooltip(60)与 toast(100)之间。
  3. 客户端接线(src/web/client.ts):弹窗每次动作现取 /__bili/diagnostics?topic=general(不缓存——desc 是实时输入);会话详情导出行新增「报告此会话」,用紧凑本地化指纹(会话尾号/协议/upstream host/请求数/缓存命中率)预填,不放完整 MD(超出 issues/new URL 容量)。
  4. i18n:zh/en 对称新增 nav.report、rpt.*、det.report_issue_session,web-i18n.test 自动校验键对称与占位符一致。
  5. 测试:tests/web-report-channel.test.ts 钉住端点参数、错误行过滤(info/warn 排除)、URL round-trip、弹窗骨架、客户端接线。
  6. 文档:README en+zh FAQ 同步提及反馈入口。

Config surface

未新增任何配置键 / env / CLI flag。仅新增 /__bili/diagnostics 的两个查询参数(desc、errors)和页面静态元素——该端点本就是 loopback-only 的诊断面(#3040),参数语义在端点 docstring 中记录。

Behavior changes(旧→新)

纯增量:既有横幅行为、端点对既有 topic 的响应、wire、请求管线均未变。唯一可感知变化:顶栏多一个按钮、会话详情多一个按钮、topic=general 成为新 topic(此前返回 base blob,现在返回完整 section——未知 topic 的降级行为不变,已有测试钉住)。

结构化八问

  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 的 diagnostics 设施按「横幅伴随物」设计,只有两个 topic 且只在横幅出现时可达;缺少一个不依赖告警状态的通用 topic 和常驻入口。
  3. 影响范围与严重程度:所有用 web UI 的用户;体验/成本瑕疵(每次排障都要人工介入),不影响功能可用性。
  4. 怎么修复的:把既有设施从「横幅专用」升级为「通用」——新增 general topic(环境+会话数+错误日志尾)、desc/errors 参数、顶栏常驻按钮+弹窗、会话详情预填入口,全部复用既有端点与 i18n/样式体系。
  5. 是否有回归问题:审过 sendDiagnostics 既有路径(topic 解析、未知 topic 降级、loopback 门禁)——行为保持,新参数缺省时与旧行为逐字节一致(web-storage-banner.test.ts 16/16 绿);wire/请求管线未触碰,两种压缩模式均不受影响。
  6. 是否破坏缓存:不涉及(弹窗刻意不走 60s 诊断缓存——desc 是实时输入;横幅缓存逻辑未动)。
  7. 是否改了设计方向:不涉及——同一设施的覆盖面扩展,架构/边界不变。
  8. 是否引入了新的配置:无(见 Config surface)。

隐私边界:错误日志尾默认附带(最有诊断价值),复选框可关;弹窗明示内容将公开可见、可能含本地路径;logger 已对密钥值脱敏;对话内容永不进入 blob。

本地:typecheck 干净 + 定向测试 16/16(新测试 + storage-banner + i18n parity),rebase 到当前 master(bce26b6)后验证;全量回归以 CI 为准。

@github-actions

github-actions Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

📦 Built Package Artifact

Branch: wt-3299-ework-daemon (a63e0cd)

Option A — Install this exact build (recommended)

npm install -g billion-context@0.0.3872-pr.3310.dfb40d2

This exact version is immutable and reproducible. The rolling pr tag tracks the newest test build across all PRs.

Option B — Download artifact

  1. Download the artifact from the Actions run
  2. Extract the tarball and install:
tar xzf billion-context-pr3310.tgz
npm install -g package

Install instructions are refreshed on each push.

@ranxianglei

Copy link
Copy Markdown
Owner Author

🤖 Powered by ework · qwen3.8-27b

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

查重结论:不重复。 本 PR 实现 #3299(web UI 常驻反馈入口)。已检索 open+closed issue/PR:无与「常驻反馈渠道」重叠的工作;相关项 #3040/#3057/#3235 是本 PR 所补全的底层设施(diagnostics 端点/横幅),不是并行修复;已关闭的 PR #3291 是冲突横幅专用的一次性报告入口,范围不同(横幅伴随 vs 常驻渠道),不构成重复。

开始对 PR #3310 做独立代码核验(全部 diff 已通读)+ 定向测试 + CI 跟踪,完成后按八问给完整审查结论。

@ranxianglei

Copy link
Copy Markdown
Owner Author

🤖 Powered by ework · qwen3.8-27b

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

PR #3310 审查结论(独立核验)

方向关:#3299 要的是「web 上向用户开放的反馈渠道」。本 PR 修的是根因——#3040 的 diagnostics 设施按「横幅伴随物」设计(只有两个横幅专用 topic、只在横幅出现时可达),缺通用 topic 与常驻入口。方案是同一设施的覆盖面扩展而非另起炉灶,方向正确。

回归审查(逐项既有行为清点):

  • 既有 topic(storage-legacy-only、conflict-banner)输出:TopicContext.errorLines 仅在 t==="general" 且 includeErrors!==false 时填充,desc 可选——新参数缺省时逐字节一致 ✅(本地 web-storage-banner + web-conflict-banner 套件全绿)
  • 未知 topic 降级行为:不变,测试钉住 ✅
  • loopback 门禁(tunnel header / 非回环地址 / trusted-origin 三道 403):未触碰,仍在路由分发前生效 ✅
  • 端点 never-throws 契约:参数解析在既有 try/catch 内,日志读取全部 fs 守卫 ✅
  • 横幅 60s 诊断缓存:未动(弹窗刻意不缓存,desc 是实时输入)✅
  • wire / 请求管线:零触碰,两种压缩模式均不受影响 ✅
  • i18n:8 个键 zh/en 对称、占位符一致,web-i18n 测试自动校验 ✅;data-i18n-ph 由既有引擎处理(client.ts:333)
  • z-index 分层:qtip 60 < modal-backdrop 90 < toast-host 100,styles.ts 实测核对 ✅
  • 会话详情预填字段(id/protocol/upstreamOrigin/requests/cachedTokens)在 sessions-data.ts 载荷中确实存在,不会静默显示「?」✅

测试有效性:tests/web-report-channel.test.ts 用真实 startServer(loopback + 隔离 env)断言:错误行过滤(info/warn 排除)、issues/new?body= URL 精确 round-trip(含 CJK)、errors=0 诚实空态、未知 topic 降级、弹窗骨架 id、客户端接线标记——断言有牙,非恒真 ✅

代码质量:命名达意、无死代码、错误路径带上下文 toast、魔法数已具名(ERROR_LOG_TAIL_LINES=15、DESC_MAX_CHARS=4000)、风格与文件一致、无新依赖。发现 1 处小缺陷并直接修复:busy() 用 .disabled 对 <a> 元素无效,「打开预填 issue」链接在 fetch 期间双击会开两个标签页——已加 busy-class 守卫,独立标注 commit d32e9f23c 推至 PR 分支(CI 随新 head 重跑)。

diff 整洁度:9 文件 +373/-16,每行都与反馈渠道目的相关;README en+zh 对称;无跑题改动 ✅

结构化八问

  1. 是什么问题:用户在 web UI 遇到不触发告警横幅的问题时没有自助报告渠道,每次排障都要人工介入。
  2. 什么原因导致的:diagnostics 设施按横幅伴随物设计——仅两个横幅专用 topic 且只在横幅出现时可达,缺通用 topic 与常驻入口。
  3. 影响范围与严重程度:所有 web UI 用户;体验/成本瑕疵,不影响功能可用性。
  4. 怎么修复的:同一设施从「横幅专用」升级为「通用」——general topic(环境事实+磁盘会话数+最近 15 行 [error] 日志,诚实空态)、desc/errors 查询参数(desc 可精确解码回 blob)、顶栏常驻按钮+弹窗(Esc/遮罩关闭)、会话详情紧凑指纹预填(不放完整 MD,超 URL 容量)。全部复用既有端点与 i18n/样式体系。
  5. 是否有回归问题:无(见上方逐项清单)。唯一发现的小缺陷(anchor 双击)已当场修复 d32e9f23c。
  6. 是否破坏缓存:不涉及;横幅缓存未动,弹窗刻意不走缓存。
  7. 是否改了设计方向:不涉及,同一设施覆盖面扩展,边界不变。
  8. 是否引入了新的配置:无——不加 env/config/CLI flag;仅既有 loopback-only 诊断端点新增两个查询参数(docstring 记录)+ 页面静态元素。

行为变更披露(旧→新):纯增量——顶栏多一个按钮、会话详情多一个按钮、topic=general 成为新 topic(此前该值走未知 topic 降级返回 base blob,现在返回完整 section;真正未知 topic 的降级不变且有测试钉住)。隐私边界:错误日志尾默认附带(复选框可关),弹窗明示内容公开可见、可能含本地路径;logger 已脱敏密钥;对话内容永不进入 blob。

验证证据:全量 diff 通读;本地 typecheck 干净;定向套件 45/45(web-report-channel + web-storage-banner + web-conflict-banner + web-i18n);修复 commit 后重跑 report-channel + typecheck 干净。CI:新 head d32e9f23c 上 25 条 lane 排队中(三层调度),跟踪到出结果。

判定:可合(待 CI 绿;feat 类本就人工合并)。

awork added 3 commits October 16, 2026 01:39
Complete the #3040 diagnostics facility into an always-reachable report path for users who hit problems that never raise a warning banner:

- diagnostics: new topic=general (env facts + sessions-on-disk count + last 15 [error] log lines), ?desc= carries the user's own description into blob and prefilled issues/new URL body, ?errors=0 opts out of the log tail
- page/styles: topbar '反馈/Report' button + modal (description textarea, include-errors checkbox default on with public-visibility note, copy diagnostics / open prefilled GitHub issue / cancel, Esc/backdrop close)
- client: modal wired to /__bili/diagnostics?topic=general (fresh fetch per action, no cache); session-detail export row gains 'report this session' with a compact localized fingerprint prefill
- i18n: symmetric zh/en keys (nav.report, rpt.*, det.report_issue_session), parity covered by web-i18n.test
- tests: tests/web-report-channel.test.ts pins endpoint params, error-tail filtering, url round-trip, modal skeleton, client wiring
- docs: README en+zh FAQ mention of the feedback entry

No new config keys/env vars/CLI flags; no wire or request-pipeline changes.
…ching (#3299)

busy() sets .disabled which has no effect on <a> elements; a double-click
during the diagnostics fetch could open two prefilled issue tabs. Guard
on the busy class instead.
…ate)

CI text-safe family gate flagged String(d.id).slice(-12) in the new session
prefill (raw negative slice on a string). Inline the shared clamp into the
self-contained WEB_CLIENT IIFE via function-source interpolation (the IIFE
has no module access), so the tail can never cut a surrogate pair.

Verified: text-safe gate green, targeted web suites 63/63, typecheck clean,
built dist WEB_CLIENT evaluates to valid JS with the clamp embedded.
@ranxianglei

Copy link
Copy Markdown
Owner Author

🤖 Powered by ework · qwen3.8-27b

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

CI 后续:修掉本 PR 引入的 1 个真缺陷;其余红确认与本 PR 无关(已立 #3315)

CI 发现(上一轮 head d32e9f2,两条 lane 共 7 个失败)

1. text-safe family gate——本 PR 引入的真缺陷,已修。
会话预填行 String(d.id).slice(-12) 是字符串上的裸负 slice,触发全仓静态门禁(tests/text-safe.test.ts:#816/#1615 单代理对家族,字符串尾部截取必须走 safeSuffix)。本地没暴露的原因:我只跑了 web 相关定向套件,没跑 text-safe——静态扫描门覆盖整棵树,新增 src 行都可能踩到。
修法(commit a63e0cd):把 src/text-safe.ts 的共享 safeSuffix 以函数源码插值内联进自包含的 WEB_CLIENT IIFE(IIFE 内无模块访问权),而不是加 allowlist 豁免——豁免只给数组接收者,给字符串开洞等于废掉这个门。已验证构建产物里 WEB_CLIENT 求值后是合法 JS、clamp 正确嵌入、预填走 safeSuffix(String(d.id), 12)。

2. 其余 6 个失败与本 PR 无关(master 上预先存在):

三项按同一问题清单化管理,已立 #3315(带来源标记与查重声明),不塞进本 PR。

当前状态

修订判定

前一轮审查结论对本 PR 自身 diff 仍然成立,family-gate 缺陷已修复并验证。建议:等本轮 CI 回来,若剩余红恰好就是 #3315 那 6 个既有失败,即可合并——golden 漂移让 master 12 条 test lane 中 8 条变红,属 master 侧问题,由 #3315 单独跟进,不应阻塞本 PR。

@ranxianglei

Copy link
Copy Markdown
Owner Author

🤖 Powered by ework · qwen3.8-27b

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

进度汇报(会话曾卡住被重启,补报当前状态):

已完成:

  1. 修掉本 PR 引入的 1 个真缺陷:会话预填行 String(d.id).slice(-12) 触发 text-safe family gate(字符串裸负 slice,compactEntry summary clamp (slice(0,199)+'…') can strand a lone high surrogate → same deterministic UTF-8 gateway 500 family #816/[bug] summaryFingerprintLine 的 head/tail 裸码元切片产生孤立代理项 → 上游 JSON 400、会话永久卡死(#816/#828 同族第三站点;0.1.169 仍未修) #1615 单代理对家族)。已改为内联共享 safeSuffix(commit a63e0cd),构建产物验证通过。
  2. 确认其余 6 个 CI 失败与本 PR 无关:master 最新 CI(6ee4a2a)以逐字节相同的 digest 挂同一组测试(storage-render golden ×4、[Bug] 链检测把 bili 自己注入的 ACP 产物判成 bili→bili 链 —— 压缩内核永久跳过,长会话撞 1,048,576 上限 400(v0.1.133 回归) #1086 T5 liveness)+ AC12 一次性时序 flake。已立 CI 测试 lane 出现与代码改动无关的失败:存储渲染快照漂移 + 两个偶发用例 #3315 清单化管理。
  3. 分支已 rebase 到当前 master(6ee4a2a,与 Add single-codepoint repetition lane to the output-side runaway guard (Closes #3260) #3289 零文件重叠),本地 typecheck + 定向套件 63/63 绿,新 head a63e0cd05 已推送,CI 重跑中(run 38779318925)。

进行中:等待本轮 CI 结果——刚才的长轮询把会话拖挂了,改为短轮询继续盯。若剩余红恰好就是 #3315 那 6 个既有失败,判定维持:本 PR 可合。

@ranxianglei

Copy link
Copy Markdown
Owner Author

🤖 Powered by ework · qwen3.8-27b

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

CI 终局判定(head a63e0cd,已 rebase 到当前 master 6ee4a2a):36/41 绿,5 条失败全部是 #3315 的既有问题——本 PR 可合

本轮 CI 分解

Lane 结果
36 条 ✅(全部 web-* 套件、text-safe 门、typecheck/build、e2e、docs/config-surface/kernel-guard 等)
shard-2 全部 4 条(u24/u22/w24/w22) ❌ storage-render golden ×4 + #1086 T5 liveness——四条平台/node lane 挂完全相同的测试号与名字(496-499 / 566),确定性失败
u22-3 ❌ AC12 时序断言(flaky,本轮在 ubuntu,上轮在 windows)

关键点:

结构化八问(最终版)

  1. 是什么问题:web UI 用户遇到不触发告警横幅的问题时没有自助报告渠道;审查中另发现本 PR 引入一处违反 text-safe 门的字符串裸负 slice。
  2. 什么原因导致的:diagnostics 设施按「横幅伴随物」设计(仅两个 topic、仅横幅出现时可达),缺通用 topic 与常驻入口;slice 缺陷是新代码手写 slice(-12) 未复用共享 clamp。
  3. 影响范围与严重程度:所有 web UI 用户,体验/成本级别,不影响功能可用性;slice 缺陷最坏情形是会话 id 含 emoji 时预填指纹里出现替换字符,被门禁拦下未上线。
  4. 怎么修复的:既有设施从「横幅专用」扩展为「通用」(general topic + desc/errors 参数 + 顶栏弹窗 + 会话详情预填入口),全部复用既有端点/i18n/样式体系;slice 缺陷改为函数源码插值内联共享 safeSuffix。
  5. 是否有回归问题:无。既有 topic 输出逐字节不变、未知 topic 降级、loopback 门禁、横幅缓存、wire/请求管线均未动;本 PR 自身引入的 CI 失败已全部修复,剩余失败均为 master 侧既有问题(CI 测试 lane 出现与代码改动无关的失败:存储渲染快照漂移 + 两个偶发用例 #3315,相同 digest 证明)。
  6. 是否破坏缓存:不涉及(弹窗刻意不走 60s 诊断缓存;横幅缓存逻辑未动)。
  7. 是否改了设计方向:不涉及——同一设施的覆盖面扩展。
  8. 是否引入新配置:无。

合并判定:本 PR 代码干净,自引入缺陷已修复并验证,剩余红全部为 master 侧既有问题(#3315,其中 golden 漂移让 master 8/12 test lane 变红,建议优先处理那个)。 我无权合并(human-only),请 @ranxianglei 合并:#3310

@ranxianglei ranxianglei changed the title feat: web UI 常驻反馈入口——一键生成预填诊断的 GitHub issue (#3299) [PR] feat: persistent feedback entry in web UI — one-click generation of pre-filled diagnostic GitHub issue (#3299) | [PR] feat: web UI 常驻反馈入口——一键生成预填诊断的 GitHub issue (#3299) Oct 16, 2026
@ranxianglei

Copy link
Copy Markdown
Owner Author

(ai: zhipuai-lb/glm-5.3)

陈旧票清理(第三批动作①):目标 issue #3299 已关。为避免重复劳动关闭本 PR;如判断有误请直接 reopen 并留言。

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

1 participant