Files
Piik/docs/research/diagnostic-feedback.md
AAA cdd503a98d feat: improve feedback and App lifecycle reliability (#404)
Waiting feedback and tooltips now share consistent presentation lifecycles, while App shutdown and native-media operation failures stay within their owning session or output. This phase also consolidates the project standards and publishes searchable English/Chinese reader documentation alongside the homepage.

Validation: repository hygiene and Markdown links; TypeScript, 971 Web tests and production build; website/documentation build; Go tests, vet and Windows/Linux builds with Windows capture checks; desktop/mobile UI and documentation review. Linux race, container and three-platform packaging checks run in the release pipeline. Physical macOS/Linux capture and broader network coverage remain outside this acceptance.

The owner approved v1.4.0 publication. Existing empty-source, Windows URL-handler and public-invitation timeout reports remain tracked; this release makes no claim to resolve those device/network reports. The Windows capture-border request is next-phase work.

## Release notes

### 中文

这是一次以稳定性和交互一致性为重点的功能更新。等待与提示更有反馈,App 启动、原生分享和连接恢复的边界处理得到改善,使用与部署指南也有了统一的文档中心。

#### 新增与改进

- 欢迎语、等待短句和六类可轮换的标签页标题共用一致的显示规则。等待短句从一开始就出现,并在停留时轮换;明确的错误与操作提示保持固定。
- 房间准入等漫画采用更克制的小人物与循环动效。改进 tooltip 的定位与指向,减少对播放器的遮挡;状态、图标和文案保持相同含义。
- 新增中英文文档中心,提供搜索、手机目录、使用教程、问题排查与自部署指南。官网 FAQ 聚焦开始使用前的问题,详细排查统一进入文档中心。

#### 修复

- 使用 `--local` 启动不再清空已保存的 Piik 站点地址。
- 打开系统浏览器不再阻塞 App 的退出流程;改进临时公网邀请、终端和诊断导出在关闭时的清理及错误反馈。
- 单条原生媒体连接的操作失败不再被误判为整个会话的协议错误;重复停止分享保持幂等。
- 修复连接替换、转发停止和异常退出时的部分资源清理问题,避免迟到结果影响当前连接。
- Windows 原生采集中,单个输出的编码错误只结束对应输出;共享采集源本身的错误仍会结束分享。

#### 升级与已知边界

本次保持现有协议版本与配置格式。更新 App 或自托管 Server 后,重新打开页面即可使用对应的新界面。

个别设备的空窗口列表、Windows 浏览器启动异常,以及 Linux 编码输出的故障隔离仍在跟进。macOS/Linux 的物理采集和更广泛的公网网络场景仍需实机验证;本次不宣称这些问题已经解决,也不承诺所有网络都能直连。

### English

This feature update focuses on stability and consistent feedback. Waiting states are easier to follow, App startup and native sharing handle several failure cases more reliably, and the new documentation center brings usage and deployment guides together.

#### New and improved

- Welcome lines, waiting captions and six groups of rotating tab titles follow one presentation lifecycle. Waiting captions appear immediately and rotate while visible; actionable errors and instructions remain fixed.
- Room-admission comics use restrained characters and looping motion. Tooltips point more accurately to their controls and interfere less with the player, with consistent meanings across illustrations, icons and copy.
- A new English/Chinese documentation center includes search, mobile navigation, usage guides, troubleshooting and self-hosting. The homepage FAQ covers questions before getting started and links to the documentation for detailed help.

#### Fixes

- Starting with `--local` no longer clears a saved Piik site address.
- Opening the system browser no longer blocks App shutdown. Temporary public invitations, the terminal and diagnostic exports handle cleanup and exit errors more consistently.
- An operation failure on one native media connection no longer becomes a protocol failure for the entire session. Repeated stop-sharing requests are safe.
- Fixed cleanup cases during connection replacement, relay shutdown and unexpected exits, preventing late results from affecting the current connection.
- On Windows, an encoder failure for one native output stops that output only. A failure of the shared capture source still ends sharing.

#### Updating and known limits

Protocol versions and configuration formats are unchanged. After updating the App or your self-hosted Server, reopen the page to use its updated interface.

Empty source lists on some devices, Windows browser-launch failures and Linux output-failure isolation remain under investigation. Physical macOS/Linux capture and broader public-network coverage still need device testing; this update does not claim to resolve those cases or guarantee a direct connection on every network.
2026-09-16 13:13:06 +08:00

3.9 KiB

Diagnostic Feedback

Reviewed 2026-09-09. Configuration owns current activation, contents, bounds and disclosure. This note records the references and integration decisions; it is not another logging API contract.

Mature References

Reference Verified practice Applied here
OBS application logging Session logs and separate crash/profiler reports retain diagnostic context; repetition and retention are managed. Preserve selected startup facts, bounded history and related report files. OBS implementation is study-only; no GPL code is copied.
Chromium WebRTC internals and dump export Connection/capture API events and RTCStats are kept together with timestamps and Browser context. Raw dumps can contain sensitive URLs/configuration. Observe existing connection owners and stats samples; include requested versus applied settings and errors. Do not copy raw dumps as a redaction policy.
Tailscale bug reports A timestamped marker associates the report with health/network context; record mode can bracket reproduction. Put a marker and current runtime metadata into a local bundle. No cloud collector, device account or support backend is needed.

Smallest Coherent Integration

The existing Go recorder, rotating file, ZIP writer, runtime memory statistics and pprof snapshots remain. Existing Browser diagnostic recording and Native request IDs remain the owning surfaces. Complete the missing evidence at those boundaries instead of constructing a second application event bus.

Native async request completion is recorded by the existing completion owner. Capture subprocess stderr is a bounded line stream alongside its existing media pipe, with no media/wire format change. Windows reads its existing VSE observer on input processing cadence; no diagnostic callback chooses bitrate or routes. Browser state listeners attach at current PeerConnection creation sites and consume existing stats calls; no global prototype replacement or new poller is introduced. Export-time platform metadata has a bounded wait and can fail without deleting the event history.

Pion's existing logger factory and LiveKit's LogR adapter feed the same slog handler. Existing Zap object/array marshalers retain RTP/BWE fields that plain JSON would otherwise silently encode as empty objects. Critical credential filtering precedes persistence. Pinned Pion formats include named ICE secrets, space-separated ufrag extensions, hexadecimal username comparisons and an opaque remote-track dump; those forms need explicit handling, not just URL filtering. Other technical identities and network/system details are disclosed as residual information rather than promised to be fully anonymous.

Optional profile failures produce a partial report with a file/error manifest. The ZIP still fails if its destination cannot be written. Whole-process memory, screen/audio recording, remote collection and a crash-uploader service add cost and disclosure beyond the diagnostic result; none is required by this design.

Verification Boundary

Focused checks exercise split stderr chunks, actual Pion secret formats, structured media statistics, log rotation/reopen and partial export. Existing Native/Browser owner checks retain asynchronous setting and media behavior. Physical acceptance must inspect an exported bundle from the running code, not only assert that instrumentation methods were called. A report is not guaranteed to reconstruct events that occurred before Debug was enabled or outside its explicit retained history.