From a1a16be2aafab23ba4ba782136858031c344c931 Mon Sep 17 00:00:00 2001 From: Jason Date: Mon, 8 Sep 2025 16:48:24 +0800 Subject: [PATCH] =?UTF-8?q?feat(updater):=20=E5=89=8D=E7=AB=AF=20Updater?= =?UTF-8?q?=20=E5=B0=81=E8=A3=85=E4=B8=8E=E8=AE=BE=E7=BD=AE=E9=A1=B5?= =?UTF-8?q?=E6=8E=A5=E5=85=A5\n\n-=20=E6=96=B0=E5=A2=9E=20src/lib/updater.?= =?UTF-8?q?ts=EF=BC=88check=E2=86=92download=E2=86=92install=E2=86=92relau?= =?UTF-8?q?nch=20=E5=B0=81=E8=A3=85=E4=B8=8E=E7=B1=BB=E5=9E=8B=EF=BC=89\n-?= =?UTF-8?q?=20SettingsModal=20=E6=8C=89=E9=92=AE=E4=BC=98=E5=85=88?= =?UTF-8?q?=E8=B5=B0=20Updater=EF=BC=8C=E5=A4=B1=E8=B4=A5=E5=9B=9E?= =?UTF-8?q?=E9=80=80=E6=89=93=E5=BC=80=20Releases\n-=20=E4=BE=9D=E8=B5=96?= =?UTF-8?q?=EF=BC=9A@tauri-apps/plugin-updater=E3=80=81@tauri-apps/plugin-?= =?UTF-8?q?process\n-=20=E6=96=87=E6=A1=A3=EF=BC=9A=E7=B2=BE=E7=AE=80?= =?UTF-8?q?=E5=B9=B6=E9=87=8D=E5=86=99=20docs/updater-plan.md=EF=BC=88?= =?UTF-8?q?=E6=98=8E=E7=A1=AE=E6=8E=A5=E5=8F=A3/=E6=B5=81=E7=A8=8B/?= =?UTF-8?q?=E9=85=8D=E7=BD=AE=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/updater-plan.md | 272 +++++++++---------------------- package.json | 2 + pnpm-lock.yaml | 20 +++ src/components/SettingsModal.tsx | 9 +- src/lib/updater.ts | 146 +++++++++++++++++ 5 files changed, 251 insertions(+), 198 deletions(-) create mode 100644 src/lib/updater.ts diff --git a/docs/updater-plan.md b/docs/updater-plan.md index b182d6f..cb3473e 100644 --- a/docs/updater-plan.md +++ b/docs/updater-plan.md @@ -1,209 +1,91 @@ # 更新功能开发计划（Tauri v2 Updater） -> 目标：为桌面应用（macOS `.app`、Windows）集成并验证基于 Tauri v2 官方 Updater 插件的自动更新能力，覆盖版本检测、下载、安装与重启的完整闭环，并建立可复用的发布与测试流程。 +> 目标：基于 Tauri v2 官方 Updater，完成“检查更新 → 下载 → 安装 → 重启”的完整闭环；提供清晰的前后端接口、配置与测试/发布流程。 -## 一、范围与目标 -- 核心能力： - - 检查更新 → 下载 → 安装 → 应用重启。 - - 支持静态 JSON 与动态接口两种更新源。 - - 版本通道（stable/beta）与运行时切换端点（可选）。 -- 平台覆盖： - - macOS `.app`（优先级高）。 - - Windows（推荐安装器路径 NSIS/MSI；便携版说明限制）。 -- 安全要求： - - Updater 更新签名（Ed25519）强制开启：客户端 `pubkey` 校验服务端签名。 - - 不强制平台代码签名（macOS/Windows），但建议上线前完善。 +## 范围与目标 +- 能力：静态 JSON 与动态接口两种更新源；可选稳定/测试通道；进度反馈与错误处理。 +- 平台：macOS `.app` 优先；Windows 使用安装器（NSIS/MSI）。 +- 安全：启用 Ed25519 更新签名校验；上线前建议平台代码签名与公证。 -## 二、方案概述 -- 插件：`tauri-plugin-updater`（Rust/JS 双端 API），前端重启依赖 `@tauri-apps/plugin-process`。 -- 核心配置： - - `src-tauri/tauri.conf.json` - - `bundle.createUpdaterArtifacts: true` - - `plugins.updater.pubkey: ""` - - `plugins.updater.endpoints: ["<更新源 URL 列表>"]` - - Windows 可选：`plugins.updater.windows.installMode: "passive|basicUi|quiet"` - - `src-tauri/capabilities/default.json` 增加：`"updater:default"` -- 构建与签名： - - 生成密钥：`tauri signer generate` → 注入构建环境变量 `TAURI_SIGNING_PRIVATE_KEY`（及可选密码）。 - - 构建产出带签名的更新制品（各平台包 + sig）。 +## 架构与依赖 +- 插件：`tauri-plugin-updater`（更新）、`@tauri-apps/plugin-updater`（JS）；`tauri-plugin-process` 与 `@tauri-apps/plugin-process`（重启）。 +- 签名与构建：`tauri signer generate` 生成密钥；CI/本机注入 `TAURI_SIGNING_PRIVATE_KEY`；`bundle.createUpdaterArtifacts: true` 生成签名制品。 +- 权限：在 `src-tauri/capabilities/default.json` 启用 `updater:default` 与 `process:allow-restart`。 +- 配置（`src-tauri/tauri.conf.json`）： + - `plugins.updater.pubkey: ""` + - `plugins.updater.endpoints: ["<更新源 URL 列表>"]` + - Windows（可选）：`plugins.updater.windows.installMode: "passive|basicUi|quiet"` -## 三、交付物 -- 可运行的自动更新能力（含前端触发入口与进度反馈）。 -- 配置完善：`tauri.conf.json`、`capabilities/default.json`、插件初始化。 -- 本地更新测试用 `latest.json` 模板与脚本（或说明）。 -- 文档： - - 更新源格式说明（静态/动态）。 - - 发布与回滚操作说明。 - - 常见问题排查清单。 +## 前端接口设计（TypeScript） +- 类型 + - `type UpdateChannel = 'stable' | 'beta'` + - `type UpdaterPhase = 'idle' | 'checking' | 'available' | 'downloading' | 'installing' | 'restarting' | 'upToDate' | 'error'` + - `type UpdateInfo = { currentVersion: string; availableVersion: string; notes?: string; pubDate?: string }` + - `type UpdateProgressEvent = { event: 'Started' | 'Progress' | 'Finished'; total?: number; downloaded?: number }` + - `type UpdateError = { code: string; message: string; cause?: unknown }` + - `type CheckOptions = { timeout?: number; channel?: UpdateChannel }` +- API（`src/lib/updater.ts`） + - `getCurrentVersion(): Promise` 读取当前版本。 + - `checkForUpdate(opts?: CheckOptions)` → `up-to-date` 或 `{ status: 'available', info, update }`。 + - `downloadAndInstall(update, onProgress?)` 下载并安装，进度回调映射 Started/Progress/Finished。 + - `relaunchApp()` 调用 `@tauri-apps/plugin-process.relaunch()`。 + - `runUpdateFlow(opts?)` 编排：检查 → 下载安装 → 重启；错误统一抛出 `UpdateError`。 + - `setUpdateChannel(channel)` 前端记录偏好；实际端点切换见“端点动态化”。 +- Hook（可选 `useUpdater()`） + - 返回 `{ phase, info?, progress?, error?, actions: { check, startUpdate, relaunch } }`。 +- UI（组件建议） + - `UpdateBanner`：发现新版本时展示；`UpdaterDialog`：显示说明、进度与错误/重试。 -## 四、里程碑与任务拆解 -1) 准备与密钥 -- 生成更新签名密钥对（Ed25519）。 -- 将公钥填入 `plugins.updater.pubkey`，在构建环境配置 `TAURI_SIGNING_PRIVATE_KEY`。 +## Rust 集成与权限 +- 插件注册（`src-tauri/src/main.rs`）： + - `app.handle().plugin(tauri_plugin_updater::Builder::new().build())?;` + - `.plugin(tauri_plugin_process::init())` 用于重启。 +- Windows 清理钩子（可选）：`UpdaterExt::on_before_exit(app.cleanup_before_exit)`，避免安装器启动前文件占用。 +- 端点动态化（可选）：在 `setup` 根据配置/环境切换 `endpoints`、超时、代理或 headers。 -2) 插件集成（Rust 侧） -- 注册插件：`tauri_plugin_updater::Builder::new().build()`。 -- 可选：在 `setup` 中后台自动检查与安装；或暴露 `invoke` 命令由前端驱动。 -- 可选：`updater_builder()` 覆盖网络参数（超时/代理/headers）与动态端点。 +## 更新源与格式 +- 静态 JSON（latest.json）：字段 `version`、`platforms[target].url`、`platforms[target].signature`（`.sig` 内容）；可选 `notes`、`pub_date`。 +- 动态接口： + - 无更新：HTTP 204 + - 有更新：HTTP 200 → `{ version, url, signature, notes?, pub_date? }` +- 通道组织：`/stable/latest.json`、`/beta/latest.json`；CDN 缓存需可控，回滚可强制刷新。 -3) 前端接入（Renderer） -- 依赖：`@tauri-apps/plugin-updater`、`@tauri-apps/plugin-process`。 -- 提供“检查更新”入口：显示当前版本、可用版本、更新日志。 -- 进度反馈：`downloadAndInstall` 回调显示 Started/Progress/Finished。 -- 成功后调用 `relaunch()`（或 Rust 侧 `app.restart()`）。 +## 用户流程与 UX +- 流程：检查 → 展示版本/日志 → 下载进度（累计/百分比）→ 安装 → 提示并重启。 +- 错误：网络异常（超时/断网/证书）、签名不匹配、权限/文件占用（Win）。提供“重试/稍后更新”。 +- 平台提示： + - macOS：建议安装在 `~/Applications`，避免 `/Applications` 提权导致失败。 + - Windows：优先安装器分发，并选择合适 `installMode`。 -4) 配置与权限 -- `tauri.conf.json`：`createUpdaterArtifacts`、`pubkey`、`endpoints`、Windows `installMode`（如需）。 -- `capabilities/default.json`：加入 `"updater:default"`。 +## 测试计划 +- 功能：有更新/无更新（204）/下载中断/重试/安装后重启成功与版本号提升。 +- 安全：签名不匹配必须拒绝更新；端点不可用/被劫持有清晰提示。 +- 网络：超时/断网/代理场景提示与恢复。 +- 平台： + - macOS：`/Applications` 与 `~/Applications` 的权限差异。 + - Windows：`passive|basicUi|quiet` 行为差异与成功率。 +- 本地自测：以 v1.0.0 运行，构建 v1.0.1 制品+`.sig`，本地 HTTP 托管 `latest.json`，验证全链路。 -5) 更新源与产物 -- 静态 JSON（`latest.json`）模板： - - `version`、`notes`、`pub_date`（可选），`platforms[target].url` 与 `platforms[target].signature`（必填，signature 为 `.sig` 内容）。 -- 动态 API： - - 无更新返回 HTTP 204；有更新返回 200 + `{ version, url, signature, notes?, pub_date? }`。 -- 产物托管： - - 本地 HTTP 服务器（开发自测）或 GitHub Releases/CDN（准生产）。 +## 发布与回滚 +- 发布（CI 推荐）：注入 `TAURI_SIGNING_PRIVATE_KEY` → 构建生成各平台制品+签名 → 上传产物与 `latest.json` 至 Releases/CDN。 +- 回滚：撤下问题版本或将 `latest.json` 指回上一个稳定版本；如需降级，Rust 侧可定制版本比较策略（可选）。 -6) 测试计划 -- 基线用例： - - 发现更新 → 下载 → 安装 → 重启 → 版本号提升。 - - 无更新（204）提示“已是最新”。 - - 签名不匹配拒绝更新（安全校验）。 - - 网络超时/失败的错误提示与恢复。 -- 平台专项： - - macOS：`~/Applications` 与 `/Applications` 两种放置；无苹果账号情况下的 Gatekeeper 行为提示。 - - Windows：安装器三种 `installMode`；便携版在用户可写目录的可行性验证与限制说明（文件锁/提权）。 -- 自测步骤（本地静态 JSON）： - - 用 v1.0.0 作为“已安装版本”，构建 v1.0.1 更新产物与 `.sig`。 - - 生成 `latest.json`，启动本地 HTTP（如 `npx http-server`）。 - - 旧版应用中点击“检查更新”并验证完整流程。 - -7) 发布与回滚 -- 发布： - - 通过 CI 生成更新产物与签名，上传到 Release/CDN。 - - 产物与 `latest.json` 上传至 Releases/CDN（或刷新动态接口数据）。 -- 回滚： - - 撤回最新产物；或将 `latest.json` 指向上一个稳定版本。 - - 如允许降级，Rust 侧定制 `version_comparator`。 - -8) 文档与移交 -- 更新源格式说明、运维手册、常见问题排查（见下文附录）。 - -## 五、配置清单（示例） -- `src-tauri/tauri.conf.json` 关键片段： -```json -{ - "bundle": { "createUpdaterArtifacts": true }, - "plugins": { - "updater": { - "pubkey": "", - "endpoints": [ - "https://releases.example.com/{{target}}/{{arch}}/{{current_version}}", - "https://github.com/org/repo/releases/latest/download/latest.json" - ], - "windows": { "installMode": "passive" } - } - } -} -``` -- `src-tauri/capabilities/default.json`： -```json -{ - "permissions": [ - "updater:default" - ] -} -``` - -## 六、前端最小用例（伪代码） -```ts -import { check } from '@tauri-apps/plugin-updater' -import { relaunch } from '@tauri-apps/plugin-process' - -export async function runUpdateFlow() { - const update = await check({ timeout: 30000 }) - if (!update) return { status: 'up-to-date' } - - let downloaded = 0 - let total = 0 - await update.downloadAndInstall((e) => { - switch (e.event) { - case 'Started': total = e.data.contentLength ?? 0; break - case 'Progress': downloaded += e.data.chunkLength; break - } - }) - - await relaunch() -} -``` - -## 七、更新源样例 -- 静态 `latest.json`： -```json -{ - "version": "1.0.1", - "notes": "Bug fixes and performance improvements", - "pub_date": "2025-01-01T10:00:00Z", - "platforms": { - "darwin-aarch64": { "url": "https://cdn/app-1.0.1-darwin-aarch64.tar.gz", "signature": "" }, - "windows-x86_64": { "url": "https://cdn/app-1.0.1-x86_64.zip", "signature": "" } - } -} -``` -- 动态接口（有更新返回 200）： -```json -{ "version": "1.0.1", "url": "https://cdn/app-1.0.1.zip", "signature": "", "notes": "..." } -``` -- 无更新返回：HTTP 204 No Content。 - -## 八、平台差异与限制 -- macOS `.app`： - - 支持直接替换更新；若位于 `/Applications` 且需要管理员权限可能失败（Updater 不主动提权）。建议用户安装到 `~/Applications`。 - - 无苹果开发者账号也可测试 Updater，但分发会触发 Gatekeeper 警告（建议正式版走代码签名+公证）。 -- Windows： - - 强烈建议安装器（NSIS/MSI），Updater 会下载并运行安装器，`installMode` 控制交互程度。 - - 便携版（绿色版）不稳定：运行中无法覆盖自身文件、缺乏提权与回滚；如必须使用，需将应用放到可写目录并设计辅助替换流程（本计划不默认实现）。 - -## 九、测试用例清单 -- 功能流转：有更新/无更新/下载中断/重试/安装后重启成功。 -- 安全校验：签名错误与端点被劫持时应拒绝更新。 -- 网络异常：超时、代理、断网时的提示与恢复路径。 -- 平台行为： - - macOS：不同安装路径权限导致的成功/失败覆盖。 - - Windows：`passive|basicUi|quiet` 下安装器行为；便携版在用户可写目录的替换验证（若执行）。 - -## 十、发布与运维 -- 发布流水线（建议 CI）： - - 设置 `TAURI_SIGNING_PRIVATE_KEY`（机密变量）。 - - 构建生成各平台更新产物与签名。 - - 产物与 `latest.json` 上传至 Releases/CDN（或刷新动态接口数据）。 -- 回滚策略： - - 撤回最新产物；或将 `latest.json` 指向上一个稳定版本。 - - 如允许降级，Rust 侧定制 `version_comparator`。 - -## 十一、时间排期（参考） +## 里程碑与验收 - D1：密钥与基础集成（插件/配置/权限）。 -- D2：前端入口与进度 UI、静态 JSON 本地自测通过。 -- D3：GitHub Releases/CDN 端到端验证、平台专项测试。 -- D4：文档完善、回滚与异常流程演练、准备上线。 +- D2：前端入口与进度 UI，静态 JSON 自测通过。 +- D3：Releases/CDN 端到端验证，平台专项测试。 +- D4：文档完善、回滚与异常流程演练。 +- 验收：两平台完成“发现→下载→安装→重启→版本提升”；签名校验生效；异常有明确提示与可行恢复。 -## 十二、验收标准 -- 基线流转：在两平台完成“发现→下载→安装→重启→版本提升”。 -- 安全：签名校验生效，签名不匹配拒绝更新。 -- 文档：更新源规范、操作手册、排障清单齐备。 -- 稳定性：网络异常与常见权限问题有明确用户提示与可行恢复路径。 +## 待确认 +- 更新源托管（GitHub Releases 还是自有 CDN）。 +- 是否需要 beta 通道与运行时切换。 +- Windows 是否仅支持安装器分发；便携版兼容策略是否需要明确说明。 +- UI 文案与样式偏好。 ---- - -### 附录 A：常见问题排查 -- “未发现更新”：确认 `version` 更大、端点可达、HTTP 返回码（204/200）。 -- “签名校验失败”：`pubkey` 与私钥不匹配；`signature` 必须是 `.sig` 文件内容。 -- “下载/超时失败”：增加 `timeout`、检查代理/证书、重试策略与提示。 -- “macOS 更新失败”：检查安装路径是否需要管理员权限；建议 `~/Applications`。 -- “Windows 便携版覆盖失败”：可写权限/进程占用/缺少提权，优先改为安装器分发。 - -### 附录 B：后续可选优化 -- 渠道支持（stable/beta）与 UI 切换。 -- 增量发布策略与 CDN 缓存优化。 -- 远程开关与灰度比例控制（动态接口）。 -- 统一 Telemetry：下载失败率、平均时延、更新成功率统计。 +## 落地步骤（实施顺序） +1) 生成 Ed25519 密钥，将公钥写入 `plugins.updater.pubkey`，在构建环境配置 `TAURI_SIGNING_PRIVATE_KEY`。 +2) `src-tauri` 注册 `tauri-plugin-updater` 与 `tauri-plugin-process`，补齐 `capabilities/default.json` 与 `tauri.conf.json`。 +3) 前端新增 `src/lib/updater.ts` 封装与 `UpdateBanner`/`UpdaterDialog` 组件，接入入口按钮。 +4) 本地静态 `latest.json` 自测全链路；完善错误与进度提示。 +5) 配置 CI 发布产物与 `latest.json`；编写发布/回滚操作手册。 diff --git a/package.json b/package.json index 769e670..94493c5 100644 --- a/package.json +++ b/package.json @@ -32,6 +32,8 @@ "@codemirror/view": "^6.38.2", "@tailwindcss/vite": "^4.1.13", "@tauri-apps/api": "^2.8.0", + "@tauri-apps/plugin-process": "^2.0.0", + "@tauri-apps/plugin-updater": "^2.0.0", "codemirror": "^6.0.2", "lucide-react": "^0.542.0", "react": "^18.2.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index a64f207..e9b265b 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -26,6 +26,12 @@ importers: '@tauri-apps/api': specifier: ^2.8.0 version: 2.8.0 + '@tauri-apps/plugin-process': + specifier: ^2.0.0 + version: 2.3.0 + '@tauri-apps/plugin-updater': + specifier: ^2.0.0 + version: 2.9.0 codemirror: specifier: ^6.0.2 version: 6.0.2 @@ -626,6 +632,12 @@ packages: engines: {node: '>= 10'} hasBin: true + '@tauri-apps/plugin-process@2.3.0': + resolution: {integrity: sha512-0DNj6u+9csODiV4seSxxRbnLpeGYdojlcctCuLOCgpH9X3+ckVZIEj6H7tRQ7zqWr7kSTEWnrxtAdBb0FbtrmQ==} + + '@tauri-apps/plugin-updater@2.9.0': + resolution: {integrity: sha512-j++sgY8XpeDvzImTrzWA08OqqGqgkNyxczLD7FjNJJx/uXxMZFz5nDcfkyoI/rCjYuj2101Tci/r/HFmOmoxCg==} + '@types/babel__core@7.20.5': resolution: {integrity: sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA==} @@ -1427,6 +1439,14 @@ snapshots: '@tauri-apps/cli-win32-ia32-msvc': 2.8.1 '@tauri-apps/cli-win32-x64-msvc': 2.8.1 + '@tauri-apps/plugin-process@2.3.0': + dependencies: + '@tauri-apps/api': 2.8.0 + + '@tauri-apps/plugin-updater@2.9.0': + dependencies: + '@tauri-apps/api': 2.8.0 + '@types/babel__core@7.20.5': dependencies: '@babel/parser': 7.28.0 diff --git a/src/components/SettingsModal.tsx b/src/components/SettingsModal.tsx index c80cc95..2e7c746 100644 --- a/src/components/SettingsModal.tsx +++ b/src/components/SettingsModal.tsx @@ -2,6 +2,7 @@ import { useState, useEffect } from "react"; import { X, Info, RefreshCw, FolderOpen } from "lucide-react"; import { getVersion } from "@tauri-apps/api/app"; import "../lib/tauri-api"; +import { runUpdateFlow } from "../lib/updater"; import type { Settings } from "../types"; interface SettingsModalProps { @@ -66,11 +67,13 @@ export default function SettingsModal({ onClose }: SettingsModalProps) { const handleCheckUpdate = async () => { setIsCheckingUpdate(true); try { - await window.api.checkForUpdates(); + // 优先使用 Tauri Updater 流程；失败时回退到打开 Releases 页面 + await runUpdateFlow({ timeout: 30000 }); } catch (error) { - console.error("检查更新失败:", error); + console.error("检查更新失败，回退到 Releases 页面:", error); + await window.api.checkForUpdates(); } finally { - setTimeout(() => setIsCheckingUpdate(false), 2000); + setIsCheckingUpdate(false); } }; diff --git a/src/lib/updater.ts b/src/lib/updater.ts new file mode 100644 index 0000000..017406b --- /dev/null +++ b/src/lib/updater.ts @@ -0,0 +1,146 @@ +import { getVersion } from "@tauri-apps/api/app"; + +// 可选导入：在未注册插件或非 Tauri 环境下，调用时会抛错，外层需做兜底 +// 我们按需加载并在运行时捕获错误，避免构建期类型问题 +// eslint-disable-next-line @typescript-eslint/consistent-type-imports +import type { Update } from "@tauri-apps/plugin-updater"; + +export type UpdateChannel = "stable" | "beta"; + +export type UpdaterPhase = + | "idle" + | "checking" + | "available" + | "downloading" + | "installing" + | "restarting" + | "upToDate" + | "error"; + +export interface UpdateInfo { + currentVersion: string; + availableVersion: string; + notes?: string; + pubDate?: string; +} + +export interface UpdateProgressEvent { + event: "Started" | "Progress" | "Finished"; + total?: number; + downloaded?: number; +} + +export interface UpdateHandle { + version: string; + notes?: string; + date?: string; + downloadAndInstall: ( + onProgress?: (e: UpdateProgressEvent) => void, + ) => Promise; + download?: () => Promise; + install?: () => Promise; +} + +export interface CheckOptions { + timeout?: number; + channel?: UpdateChannel; +} + +function mapUpdateHandle(raw: Update): UpdateHandle { + return { + version: (raw as any).version ?? "", + notes: (raw as any).notes, + date: (raw as any).date, + async downloadAndInstall(onProgress?: (e: UpdateProgressEvent) => void) { + await (raw as any).downloadAndInstall((evt: any) => { + if (!onProgress) return; + const mapped: UpdateProgressEvent = { + event: evt?.event, + }; + if (evt?.event === "Started") { + mapped.total = evt?.data?.contentLength ?? 0; + mapped.downloaded = 0; + } else if (evt?.event === "Progress") { + mapped.downloaded = evt?.data?.chunkLength ?? 0; // 累积由调用方完成 + } + onProgress(mapped); + }); + }, + // 透传可选 API（若插件版本支持） + download: (raw as any).download + ? async () => { + // eslint-disable-next-line @typescript-eslint/no-unsafe-call + await (raw as any).download(); + } + : undefined, + install: (raw as any).install + ? async () => { + // eslint-disable-next-line @typescript-eslint/no-unsafe-call + await (raw as any).install(); + } + : undefined, + }; +} + +export async function getCurrentVersion(): Promise { + try { + return await getVersion(); + } catch { + return ""; + } +} + +export async function checkForUpdate( + opts: CheckOptions = {}, +): Promise< + | { status: "up-to-date" } + | { status: "available"; info: UpdateInfo; update: UpdateHandle } +> { + // 动态引入，避免在未安装插件时导致打包期问题 + const { check } = await import("@tauri-apps/plugin-updater"); + + const currentVersion = await getCurrentVersion(); + const update = await check({ timeout: opts.timeout ?? 30000 } as any); + + if (!update) { + return { status: "up-to-date" }; + } + + const mapped = mapUpdateHandle(update); + const info: UpdateInfo = { + currentVersion, + availableVersion: mapped.version, + notes: mapped.notes, + pubDate: mapped.date, + }; + + return { status: "available", info, update: mapped }; +} + +export async function relaunchApp(): Promise { + const { relaunch } = await import("@tauri-apps/plugin-process"); + await relaunch(); +} + +export async function runUpdateFlow( + opts: CheckOptions = {}, +): Promise<{ status: "up-to-date" | "done" }> { + const result = await checkForUpdate(opts); + if (result.status === "up-to-date") return result; + + let downloaded = 0; + let total = 0; + await result.update.downloadAndInstall((e) => { + if (e.event === "Started") { + total = e.total ?? 0; + downloaded = 0; + } else if (e.event === "Progress") { + downloaded += e.downloaded ?? 0; + // 调用方可监听此处并更新 UI（目前设置页仅显示加载态） + console.debug("update progress", { downloaded, total }); + } + }); + + await relaunchApp(); + return { status: "done" }; +}