Repository navigation
WebUI
WebUI 是 weflow serve 的网页界面(#130),本页说明它的托管和版本管理。各页面的功能和用法见 WebUI 使用,内部结构见 WebUI 实现。
serve 在 /ui/ 下提供网页。使用哪个网页由以下规则依次决定:
- 加
--api-only时不提供网页。 -
--ui-dir指定的目录,只对本次运行有效;目录中没有index.html时启动报错。 -
--web-version指定的版本,只对本次运行有效,需要时先下载。 -
weflow web use选定的版本;没有选定时,使用这个weflow的默认版本,即构建时web/package.json中的版本。二进制中只记录版本号,不含网页本身。
第 4 种情况下版本还没下载时,服务立刻启动,先用本机已有的、适用的最新版本,没有就只提供 API,同时在后台下载。下载完成后发出事件 webui_ready,失败时发出 webui_unavailable,已有的版本保持不变。
本机已有但不适用于这个 weflow 的版本(例如由更新的 weflow 下载的)不会显示。选定的版本不适用时,服务端给出警告并改用本机其他适用的版本;本机没有其他适用版本时,下载这个 weflow 的默认版本,与没有选定过时相同(#635)。
有网页时,启动提示给出带令牌的地址 http://127.0.0.1:18108/ui/?token=…(带 --json 时为 uiUrl),令牌经过百分号编码。stderr 是终端时,服务端会打开浏览器,--no-browser 可以关闭。
网页把令牌存在当前标签页的 sessionStorage 中,并从地址栏去掉。令牌不写入 localStorage,也不进入构建产物。收到 HTTP 401 时提示重新输入。
| 路径 | 行为 |
|---|---|
/ui |
308 跳转到 /ui/
|
/ |
有网页时 302 跳转到 /ui/,查询参数保留 |
/ui/chat 等无扩展名路径 |
不是文件时返回 index.html,由网页处理 |
带扩展名的文件或 /ui/assets/ 下的文件不存在 |
404 |
/ui/ 以外的未知路径 |
JSON 格式的 404
|
.. 和指向目录外的链接 |
404 |
网页的文件不需要令牌,但 Host 检查照样进行,只响应 GET 和 HEAD。
构建出的资源(/ui/assets/,文件名随内容变化)长期缓存。index.html 等文件带 Cache-Control: no-cache,所以新版本立刻生效。所有文件带 X-Content-Type-Options: nosniff,网页还带 Referrer-Policy: no-referrer。
网页和 weflow 分开发布(#148),作为 OCI artifact 发布在 ghcr.io/334456777/weflow-web:<版本>,由 weflow 自己下载,不需要 Docker、ORAS、Bun 或 Node.js。没有网页时 CLI 和 API 照常使用。发布流程见发布与 CI。
| 命令 | 作用 |
|---|---|
web info |
正在使用的版本、选定的版本、默认版本、本机已有的版本 |
web list [--remote] |
本机已有的版本;--remote 列出已发布的版本及其是否适用 |
web install <版本> |
下载并校验 |
web use <版本> |
选定 serve 显示的版本 |
web update |
下载并选定适用的最新版本,正式版优先于预发布版 |
web prune |
删除既没有选定、也不是默认版本的版本;正在显示的版本保留 |
适用条件。 版本需要的 API 正是这个 weflow 提供的(/health 的 apiVersion),并且它要求的最低 weflow 版本不高于这个 weflow,开发构建的 git describe 版本按它所在的 tag 计算。manifest 中写有这两项,不适用的版本在下载前就被拒绝;下载后、每次安装、选定或显示时都会再次检查。
切换。 网页跟随选定的版本时,通过服务端自己的 API 发出的 web use 或 web update 立刻生效,不用重启,刷新网页后就是新版本。在终端里运行的,下次启动才生效。
校验(webui.rs)。
- 下载内容必须与 manifest 给出的大小和 SHA-256 一致。
- 在限制下解压到单独的目录:压缩包最大 64 MB,解压后最多 256 MB、10,000 个文件,不允许指向目录外的路径和链接。
- 检查
index.html、元数据和版本之后,用一次重命名放到正式位置。 - 下载失败、损坏或中断时,已有的版本保持不变;同时下载同一版本时只保留一份。
存放。 版本保存在 <home>/cache/web/<版本>/,选定的版本记在 <home>/cache/web/current。正在运行的 serve 对显示的版本持有 .lock-<版本> 的共享锁,web prune 删除前检查这个锁,服务无论以什么方式结束,锁都会释放。
访问仓库的方式遵循 OCI Distribution API,WEFLOW_WEB_REGISTRY 可以指定其他仓库。