Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
82b4e02ffe |
No files matched your search
@@ -36,6 +36,19 @@ numeric core and does not move; the heading is the full version — corrected 20
|
||||
|
||||
### Fixed
|
||||
|
||||
- **An installed copy never found an update unless you had changed its channel.** The update channel was *Stable* by
|
||||
default and every FrameLedger release so far is a pre-release, so the check found nothing. The channel is now
|
||||
*Automatic*: a pre-release looks for pre-releases and a release for releases; choosing *Stable* or *Beta* still decides.
|
||||
- **A downloaded update was applied the next time FrameLedger started, before anything could check for a running game.**
|
||||
The update library applies a waiting package at start unless told not to, and nothing told it: it stopped the capture
|
||||
agent mid-session instead of letting it finish. The App now offers such a package as *Restart to update*, which waits
|
||||
for the session to end and stops the agent properly, as it always did for a download in the same run.
|
||||
- **The update dialog said ~102 MB when the download was the 1.6 MB delta.** It now says the delta's size and names the
|
||||
full package as the fallback; the updater's own lines are in the App's log, so a full download shows there.
|
||||
- **Restart to update could fail half way** when a game FrameLedger had measured was still running — its loaded overlay
|
||||
cannot be replaced — or when an agent was still waiting on the administrator prompt, and it gave the agent 10 s to stop
|
||||
where the agent takes up to 15. It waits for all three now and says why. A full disk no longer reads as "offline",
|
||||
and uninstalling removes the *Start FrameLedger with Windows* entry.
|
||||
- **The import list was unreadable in the dark theme.** File ▸ Import library (and Games ▸ Refresh) drew every row white
|
||||
with white text, and each tick box as a sliver at the row's edge: a row style added in beta.11 to dim the games already
|
||||
in the library fell through to Windows' own row, which is white in every theme, and WPF UI's check box is too wide for
|
||||
|
||||
@@ -146,3 +146,8 @@ you accept the prompt. Turn it on only if you trust everything that runs under y
|
||||
|
||||
FrameLedger's programs are **not code-signed**: Windows SmartScreen may warn when you install it, and the
|
||||
administrator prompt names an unknown publisher. Each release publishes SHA-256 checksums you can compare.
|
||||
|
||||
**An update waits while a game FrameLedger measured is still running.** The part of FrameLedger loaded into a game stays
|
||||
loaded until the game exits, and Windows will not let the update replace it; *Restart to update* says which file is held
|
||||
until you close that game ([details](docs/11_UPDATER.md)). Copies older than 0.1.0-beta.14 look only for stable
|
||||
releases unless you choose *Beta* in Settings ▸ Updates, and apply a downloaded update the next time they start.
|
||||
@@ -424,7 +424,7 @@ switch's rule); integers are invariant-culture within an inclusive range; choice
|
||||
| `capture.min_session_s` | int | `30` | 5–600 | Agent, per session (FR-3.6) |
|
||||
| `telemetry.interval_ms` | int | `1000` | 500–2000 | Agent, per session (FR-3.5) |
|
||||
| `retention.raw_sessions_per_game` | int | `20` | 0–10000; **0 = unlimited** | Agent, per session (§Retention) |
|
||||
| `update.channel` | choice | `stable` | `stable` · `beta` | UI (P4 PR-5 reads it: `beta` = GitHub pre-releases too) |
|
||||
| `update.channel` | choice | ~~`stable`~~ `auto` (beta.14, D47) | `auto` · `stable` · `beta` | UI (P4 PR-5 reads it: `beta` = GitHub pre-releases too; `auto` follows the running copy, a pre-release asking for pre-releases — `11_UPDATER` §The update audit) |
|
||||
| `update.auto_check` | bool | `1` | | UI (P4 PR-5: the startup silent check, `11_UPDATER` §Flow "if enabled") |
|
||||
| `privacy.online_metadata` | bool | `0` | | *reserved* — no consumer and, since 2026-09-16, no toggle on Settings either: the store request it would enable has no code (CLAUDE.md rule 8), and PRIVACY_POLICY 2.2 removed the row that described it |
|
||||
| `log.debug` | bool | `0` | | UI |
|
||||
|
||||
+1
-1
@@ -609,7 +609,7 @@ Agent section: elevation state with a plain explanation of what elevation *optio
|
||||
> `Infrastructure.Startup.RunAtLogon` — this user's `HKCU\…\Run` value, quoted executable path, never HKLM —
|
||||
> and the Run entry is the truth the toggle loads from; "Minimize to tray on close" is stored now and honoured
|
||||
> when the tray exists. **Privacy:** ~~`privacy.online_metadata`, off by default, with the network sentence~~ — the card is not shown since 2026-09-16 (no code makes the request; the setting stays reserved).
|
||||
> **Updates:** `update.channel` is read by PR-5's updater (beta = GitHub pre-releases), and `update.auto_check` — the startup check, on by default — sits beside it. **Logging:** `log.debug` moves this app's `LoggingLevelSwitch` at
|
||||
> **Updates:** `update.channel` is read by PR-5's updater (beta = GitHub pre-releases; since beta.14 *Automatic (Beta)* or *(Stable)* first, the default, following the running copy — D47), and `update.auto_check` — the startup check, on by default — sits beside it. **Logging:** `log.debug` moves this app's `LoggingLevelSwitch` at
|
||||
> once; the Agent has no reader for the key yet, and the row says so. **Legal:** reopen is a "not yet" line
|
||||
> until PR-9's gate exists. ~~Register/Unregister the layer, Register/Repair/Remove the task~~ — PR-8b, with the
|
||||
> Agent flags they need. Tests: `SettingsViewModelTests` (seven cases), `RunAtLogonTests` (Infrastructure, under
|
||||
|
||||
+45
-1
@@ -1,6 +1,6 @@
|
||||
# 11 — Updater
|
||||
|
||||
Velopack, feeding from GitHub Releases of `https://github.com/poli0981/frameledger`. ~~Stable channel only in v1.~~ *(Corrected 2026-10-04: two channels since P4 PR-5 — `update.channel`, stable by default or beta, which adds pre-releases. Every release so far is a pre-release; see §Built, Channels.)*
|
||||
Velopack, feeding from GitHub Releases of `https://github.com/poli0981/frameledger`. ~~Stable channel only in v1.~~ *(Corrected 2026-10-04: two channels since P4 PR-5 — `update.channel`, ~~stable by default~~ or beta, which adds pre-releases. Every release so far is a pre-release; see §Built, Channels.)* *(Corrected 2026-10-05: the default is `auto` since beta.14, which follows the running copy — §The update audit, beta.14.)*
|
||||
|
||||
## Flow
|
||||
|
||||
@@ -111,6 +111,50 @@ flow, and the tests run the flow over a fake client because nothing here may tou
|
||||
longer claims the updater provides one.
|
||||
- ~~Release notes are rendered as plain text, not Markdown.~~ Corrected 2026-10-03: rendered since beta.12 (Markdig; HTML off, no image fetched).
|
||||
|
||||
## The update audit, beta.14 (owner request 2026-10-05: "check the update logic")
|
||||
|
||||
No failure had been reported; the audit read the flow above against Velopack 1.2.0 and the owner's own updater log
|
||||
(`%LOCALAPPDATA%\velopack\velopack_FrameLedger.App.log`, read-only) and found two defects that made the flow above
|
||||
partly fiction, and six smaller ones. Each is fixed in place:
|
||||
|
||||
- **A copy left on its defaults never found an update.** `update.channel` defaulted to `stable` while every release is a
|
||||
GitHub pre-release; the owner's log reads "No releases found" from the day their ledger (and its settings row) was reset.
|
||||
**Owner decision D47:** the default is `auto`, which follows the running copy — a pre-release asks for pre-releases, a
|
||||
release for releases (`Update/UpdateChannelPolicy`, SemVer's `-` before any `+`) — and a stored `stable` or `beta` is the
|
||||
user's choice and wins. Settings shows *Automatic (Beta)* or *(Stable)* first. Only an explicit selection ever wrote the
|
||||
row (`SettingsViewModel.Persist` is guarded while loading), so existing copies with no row move to `auto`.
|
||||
- **Velopack applied a downloaded update at the next start, behind FR-12.** `VelopackApp` applies a package waiting in
|
||||
the install folder on startup unless told not to (`SetAutoApplyOnStartup`, ON by default), and the startup check
|
||||
downloads in the background — so the next start of `FrameLedger.exe` (the Start menu, the logon Run value, a second
|
||||
click, `--diag`) applied it inside `VelopackApp.Run()`, before the single-instance claim, before FR-12 could ask
|
||||
whether a session runs, and before the Agent was asked to stop; its updater killed the Agent instead (the owner's log:
|
||||
"Auto apply is true, so restarting to apply update…", then "Killing process: …FrameLedger.Agent.exe"). Off now
|
||||
(`VelopackHooks`, pinned by `VelopackHooksTests` through the builder's private fields); a package an earlier run left
|
||||
is adopted at start — `UpdateService.AdoptPending`, from `UpdateManager.UpdatePendingRestart`, no feed request — and is
|
||||
Ready or Deferred like any other.
|
||||
- **An update Velopack starts itself** (the installer run over an installed copy) asks the Agent to stop first, as the
|
||||
uninstaller does (`OnBeforeUpdateFastCallback`, 15 s budget, a line in `logs\update.log`). The hook runs in the
|
||||
version being replaced, so it first works for the update after beta.14.
|
||||
- **The apply waits while a game still has the Overlay loaded** from the install folder (`Update/PayloadInUse`: a mapped
|
||||
image refuses an exclusive write — a file-system question, no process opened). The Overlay is never unloaded from a
|
||||
live game (`17_HOOK_ENGINE`), so after a mid-game stop the swap would fail half way after the App had quit. Asked before
|
||||
the Agent is stopped; the strip names the file.
|
||||
- **An Agent waiting on the administrator prompt** (the logon task's, the admin mode) holds only its elevation marker, not
|
||||
the instance lock; the apply now waits for either (`UpdateService.AgentHolds`).
|
||||
- **The stop budget is the Agent's own shutdown grace and five seconds** (`IpcProtocol.AgentShutdownGrace`, 15 s, which
|
||||
the Agent's host now reads too): the App waited 10 s for an Agent that took up to 15 to finalize its sessions.
|
||||
- **The offer says the download Velopack will make:** the deltas from the installed version when the feed has them
|
||||
(`UpdateInfo.DeltasToTarget`; 1.6 MB for beta.12 → beta.13) and the full package as the fallback — it said ~102 MB.
|
||||
Velopack's own lines are in the App's log since beta.14 (`velopack: …`, `VelopackSerilogLogger`), so whether a delta
|
||||
or the full package came is in the bug report too.
|
||||
- **Smaller:** an `IOException` is "offline" only from the network (`HttpIOException`, a socket error) — a full disk
|
||||
read as offline; the uninstaller removes the "Start FrameLedger with Windows" Run value, which named an executable it
|
||||
deletes.
|
||||
|
||||
**What none of this reaches:** a copy still on 0.1.0-beta.13 or older runs its own code for the update to beta.14 —
|
||||
stable by default, apply-at-start on. Its user chooses *Beta* in Settings ▸ Updates and updates with no game running
|
||||
(the beta.14 release notes say so); everything above holds from beta.14 on.
|
||||
|
||||
`UpdateServiceTests` (App.Tests/Update) cover the two skips, the channels, Deferred ↔ Ready, each error row, and
|
||||
the apply's three endings; `UpdateFailureMapperTests` the table; `UninstallHookTests` the hook; ~~a real feed has
|
||||
not been exercised — the first tag is the measurement~~ *(corrected 2026-10-04: the feed has existed since
|
||||
|
||||
+1
-1
@@ -224,7 +224,7 @@ vpk pack --packId FrameLedger.App --packVersion {ver} --packDir out/app --mainEx
|
||||
|
||||
- No trimming (WPF + reflection), no NativeAOT (WPF unsupported), **no obfuscation** (GPLv3 policy, and `19_SAFETY` forbids making our binaries harder to identify).
|
||||
- `SatelliteResourceLanguages=en;vi;ja`. ~~Expected package ≈ 95–130 MB self-contained.~~ **Measured 2026-09-14 (P4 PR-5): the published tree is 250 MB in 362 files** (App + Agent, self-contained, ReadyToRun roughly doubles the IL). `vpk pack` 1.2.0 over that tree, run by hand the same day with the workflow's arguments: `FrameLedger.App-win-Setup.exe` **104 MB**, the full `.nupkg` and the portable zip 100 MB each, plus `releases.win.json` / `RELEASES` / `assets.win.json`; vpk's own pre-process step verified `VelopackApp.Run()` in `FrameLedger.App.Program::Main()`. **From the hosted runner on the first tag (2026-09-16, `v0.1.0-beta.1`):** the tree 252 MB, `Setup.exe` 110 MB, the nupkg and the zip 105 MB — the same shape, a few MB heavier for two more days of code.
|
||||
- Velopack hooks (**built 2026-09-14, P4 PR-5**: `App/Update/VelopackHooks`, wired in the hand-written `Program.Main` before any window). **Install registers nothing** — the first-run flow is the offer (Agent setup), and the layer follows the ledger (§The Vulkan layer is not registered at install time); this line used to say "offer Agent setup + Vulkan layer registration", and the second half was the thing the section below forbids. Uninstall runs `UninstallHook`: `Shutdown` to a running Agent over the pipe (best effort, it holds the install directory), unregister the layer (HKCU), remove the logon task, then **ask** about the data folder — deleted on Yes only, never when it and the install overlap (`AreSeparate`), and a question unanswered inside Velopack's 30 s callback budget keeps it.
|
||||
- Velopack hooks (**built 2026-09-14, P4 PR-5**: `App/Update/VelopackHooks`, wired in the hand-written `Program.Main` before any window; since beta.14 Velopack's apply-at-start is off and an update it starts itself stops the Agent first — `11_UPDATER` §The update audit). **Install registers nothing** — the first-run flow is the offer (Agent setup), and the layer follows the ledger (§The Vulkan layer is not registered at install time); this line used to say "offer Agent setup + Vulkan layer registration", and the second half was the thing the section below forbids. Uninstall runs `UninstallHook`: `Shutdown` to a running Agent over the pipe (best effort, it holds the install directory), unregister the layer (HKCU), remove the logon task, remove the *Start FrameLedger with Windows* Run value (beta.14 — it named the executable being deleted), then **ask** about the data folder — deleted on Yes only, never when it and the install overlap (`AreSeparate`), and a question unanswered inside Velopack's 30 s callback budget keeps it.
|
||||
|
||||
## Release-time token substitution
|
||||
|
||||
|
||||
+7
-3
@@ -36,9 +36,13 @@ The first window walks you through four short steps:
|
||||
## Updates
|
||||
|
||||
A few seconds after it starts, FrameLedger asks GitHub whether a newer version exists. A new version downloads in the
|
||||
background and is installed only when you restart FrameLedger — never while a game is being measured. You can switch
|
||||
the check off in **Settings ▸ Updates ▸ Check for updates at startup**, and check by hand with Help ▸ Check for
|
||||
updates.
|
||||
background and is installed only when you restart FrameLedger — never while a game is being measured, and not while a
|
||||
game it measured earlier is still running. You can switch the check off in **Settings ▸ Updates ▸ Check for updates at
|
||||
startup**, and check by hand with Help ▸ Check for updates.
|
||||
|
||||
**Settings ▸ Updates ▸ Channel** is *Automatic* unless you choose: a test version (a pre-release, like every version so
|
||||
far) looks for test versions, a release looks for releases. Choose *Stable* or *Beta* to decide yourself. Before
|
||||
0.1.0-beta.14 the channel was *Stable* by default and found no version at all — on an older copy, choose *Beta* to update.
|
||||
|
||||
## Uninstall
|
||||
|
||||
|
||||
@@ -353,7 +353,7 @@ internal static class Program
|
||||
builder.Services.AddHostedService<PipeServerHostedService>();
|
||||
// Finalize's grace on shutdown (04_CAPTURE §Threading model): a session that does not make it leaves
|
||||
// its .partial for the next start's recovery.
|
||||
builder.Services.Configure<HostOptions>(static o => o.ShutdownTimeout = TimeSpan.FromSeconds(15));
|
||||
builder.Services.Configure<HostOptions>(static o => o.ShutdownTimeout = Shared.Ipc.IpcProtocol.AgentShutdownGrace);
|
||||
|
||||
using IHost host = builder.Build();
|
||||
AgentConsole.Line($@"serve: ledger {paths.Database}; logs {paths.Logs}; pipe \.\pipe\{Shared.Ipc.IpcProtocol.PipeName}; Ctrl+C stops");
|
||||
|
||||
Generated
+9
@@ -749,6 +749,7 @@ public static class Strings
|
||||
nameof(Settings_AutoCheck_Body),
|
||||
nameof(Settings_AutoCheck_Label),
|
||||
nameof(Settings_Capture_Header),
|
||||
nameof(Settings_Channel_Auto_Format),
|
||||
nameof(Settings_Channel_Beta),
|
||||
nameof(Settings_Channel_Stable),
|
||||
nameof(Settings_Data_Header),
|
||||
@@ -955,6 +956,7 @@ public static class Strings
|
||||
nameof(Uninstall_DataFolder_Body),
|
||||
nameof(Uninstall_DataFolder_Title),
|
||||
nameof(Update_AgentStillRunning),
|
||||
nameof(Update_Available_Body_Delta_Format),
|
||||
nameof(Update_Available_Body_Format),
|
||||
nameof(Update_Available_Title_Format),
|
||||
nameof(Update_Banner_Applying_Format),
|
||||
@@ -976,6 +978,7 @@ public static class Strings
|
||||
nameof(Update_Notes_Header),
|
||||
nameof(Update_NotInstalled),
|
||||
nameof(Update_OpenReleases),
|
||||
nameof(Update_PayloadInUse_Format),
|
||||
nameof(Update_Toast_Body_Format),
|
||||
nameof(Update_Toast_Title),
|
||||
nameof(Update_Unsigned_Footer),
|
||||
@@ -2425,6 +2428,8 @@ public static class Strings
|
||||
|
||||
public static string Settings_Capture_Header => ResourceManager.GetString(nameof(Settings_Capture_Header), Culture) ?? nameof(Settings_Capture_Header);
|
||||
|
||||
public static string Settings_Channel_Auto_Format => ResourceManager.GetString(nameof(Settings_Channel_Auto_Format), Culture) ?? nameof(Settings_Channel_Auto_Format);
|
||||
|
||||
public static string Settings_Channel_Beta => ResourceManager.GetString(nameof(Settings_Channel_Beta), Culture) ?? nameof(Settings_Channel_Beta);
|
||||
|
||||
public static string Settings_Channel_Stable => ResourceManager.GetString(nameof(Settings_Channel_Stable), Culture) ?? nameof(Settings_Channel_Stable);
|
||||
@@ -2837,6 +2842,8 @@ public static class Strings
|
||||
|
||||
public static string Update_AgentStillRunning => ResourceManager.GetString(nameof(Update_AgentStillRunning), Culture) ?? nameof(Update_AgentStillRunning);
|
||||
|
||||
public static string Update_Available_Body_Delta_Format => ResourceManager.GetString(nameof(Update_Available_Body_Delta_Format), Culture) ?? nameof(Update_Available_Body_Delta_Format);
|
||||
|
||||
public static string Update_Available_Body_Format => ResourceManager.GetString(nameof(Update_Available_Body_Format), Culture) ?? nameof(Update_Available_Body_Format);
|
||||
|
||||
public static string Update_Available_Title_Format => ResourceManager.GetString(nameof(Update_Available_Title_Format), Culture) ?? nameof(Update_Available_Title_Format);
|
||||
@@ -2879,6 +2886,8 @@ public static class Strings
|
||||
|
||||
public static string Update_OpenReleases => ResourceManager.GetString(nameof(Update_OpenReleases), Culture) ?? nameof(Update_OpenReleases);
|
||||
|
||||
public static string Update_PayloadInUse_Format => ResourceManager.GetString(nameof(Update_PayloadInUse_Format), Culture) ?? nameof(Update_PayloadInUse_Format);
|
||||
|
||||
public static string Update_Toast_Body_Format => ResourceManager.GetString(nameof(Update_Toast_Body_Format), Culture) ?? nameof(Update_Toast_Body_Format);
|
||||
|
||||
public static string Update_Toast_Title => ResourceManager.GetString(nameof(Update_Toast_Title), Culture) ?? nameof(Update_Toast_Title);
|
||||
|
||||
@@ -2050,7 +2050,7 @@
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Settings_UpdateChannel_Body" xml:space="preserve">
|
||||
<value>安定版のみ、または安定版とプレリリース。見つかった更新はバックグラウンドでダウンロードされ、再起動時にのみ適用されます。ゲームがフックされている間は適用されません。</value>
|
||||
<value>自動は、このコピーに合わせます。プレリリース版はプレリリースを、正式版は正式リリースを探します。安定版、またはベータ(安定版とプレリリース)を選ぶこともできます。見つかった更新はバックグラウンドでダウンロードされ、再起動時にのみ適用されます。ゲームがフックされている間は適用されません。</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Settings_UpdateChannel_Label" xml:space="preserve">
|
||||
@@ -3849,4 +3849,16 @@
|
||||
<value>アプリ内のどこにもスクロール バーを表示しません。マウス ホイール、キーボード、タッチでのスクロールは引き続き使えます。</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Settings_Channel_Auto_Format" xml:space="preserve">
|
||||
<value>自動({0})</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Update_Available_Body_Delta_Format" xml:space="preserve">
|
||||
<value>バージョン {0} を今すぐダウンロードできます:約 {1} MB(お使いのバージョンからの変更分のみ。適用できない場合は {2} MB の完全なパッケージ)。適用は FrameLedger の再起動時のみで、ゲームがフックされている間は行われません。</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Update_PayloadInUse_Format" xml:space="preserve">
|
||||
<value>{0} は FrameLedger が計測したゲームにまだ読み込まれているため、更新は途中で失敗します。そのゲームを終了してから、再起動して更新してください。</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
</root>
|
||||
@@ -1543,7 +1543,7 @@
|
||||
<value>Start FrameLedger with Windows</value>
|
||||
</data>
|
||||
<data name="Settings_UpdateChannel_Body" xml:space="preserve">
|
||||
<value>Stable, or stable plus pre-releases. A found update downloads in the background and is applied only when you restart — never while a game is hooked.</value>
|
||||
<value>Automatic follows this copy: a pre-release looks for pre-releases, a release for releases. Or choose Stable, or Beta (stable plus pre-releases). A found update downloads in the background and is applied only when you restart — never while a game is hooked.</value>
|
||||
</data>
|
||||
<data name="Settings_UpdateChannel_Label" xml:space="preserve">
|
||||
<value>Channel</value>
|
||||
@@ -2897,4 +2897,13 @@ The documents below are the full terms; this summary does not replace them.</val
|
||||
<data name="Settings_HideScrollBars_Body" xml:space="preserve">
|
||||
<value>No scroll bars are drawn anywhere in the app. Everything still scrolls with the mouse wheel, the keyboard and touch.</value>
|
||||
</data>
|
||||
<data name="Settings_Channel_Auto_Format" xml:space="preserve">
|
||||
<value>Automatic ({0})</value>
|
||||
</data>
|
||||
<data name="Update_Available_Body_Delta_Format" xml:space="preserve">
|
||||
<value>Version {0} can be downloaded now: about {1} MB — only what changed since your version, or the full {2} MB package if that cannot be applied. It is applied only when you restart FrameLedger, and never while a game is hooked.</value>
|
||||
</data>
|
||||
<data name="Update_PayloadInUse_Format" xml:space="preserve">
|
||||
<value>{0} is still loaded in a game FrameLedger measured, and the update would fail half way. Close that game, then restart to update.</value>
|
||||
</data>
|
||||
</root>
|
||||
@@ -1538,7 +1538,7 @@
|
||||
<value>Khởi động FrameLedger cùng Windows</value>
|
||||
</data>
|
||||
<data name="Settings_UpdateChannel_Body" xml:space="preserve">
|
||||
<value>Ổn định, hoặc ổn định kèm bản tiền phát hành. Bản cập nhật tìm thấy sẽ tải ở nền và chỉ được áp dụng khi bạn khởi động lại — không bao giờ khi game đang được hook.</value>
|
||||
<value>Tự động theo bản đang dùng: bản tiền phát hành tìm bản tiền phát hành, bản chính thức tìm bản chính thức. Hoặc chọn Ổn định, hay Beta (ổn định kèm bản tiền phát hành). Bản cập nhật tìm thấy sẽ tải ở nền và chỉ được áp dụng khi bạn khởi động lại — không bao giờ khi game đang được hook.</value>
|
||||
</data>
|
||||
<data name="Settings_UpdateChannel_Label" xml:space="preserve">
|
||||
<value>Kênh</value>
|
||||
@@ -2892,4 +2892,13 @@ Các văn bản bên dưới là điều khoản đầy đủ; bản tóm tắt
|
||||
<data name="Settings_HideScrollBars_Body" xml:space="preserve">
|
||||
<value>Không vẽ thanh cuộn ở bất kỳ đâu trong ứng dụng. Mọi thứ vẫn cuộn được bằng con lăn chuột, bàn phím và cảm ứng.</value>
|
||||
</data>
|
||||
<data name="Settings_Channel_Auto_Format" xml:space="preserve">
|
||||
<value>Tự động ({0})</value>
|
||||
</data>
|
||||
<data name="Update_Available_Body_Delta_Format" xml:space="preserve">
|
||||
<value>Có thể tải phiên bản {0} ngay bây giờ: khoảng {1} MB — chỉ phần thay đổi so với phiên bản của bạn, hoặc gói đầy đủ {2} MB nếu phần đó không áp dụng được. Bản cập nhật chỉ được áp dụng khi bạn khởi động lại FrameLedger, và không bao giờ khi game đang được hook.</value>
|
||||
</data>
|
||||
<data name="Update_PayloadInUse_Format" xml:space="preserve">
|
||||
<value>{0} vẫn đang được nạp trong một game mà FrameLedger đã đo, và bản cập nhật sẽ thất bại giữa chừng. Hãy đóng game đó, rồi khởi động lại để cập nhật.</value>
|
||||
</data>
|
||||
</root>
|
||||
@@ -16,6 +16,12 @@ public interface IUpdateClient
|
||||
/// <summary>The installed version as the package manifest states it, or null when not installed.</summary>
|
||||
string? CurrentVersion { get; }
|
||||
|
||||
/// <summary>
|
||||
/// A package an earlier run downloaded and nobody applied, or null — read from the install folder, no feed request
|
||||
/// (beta.14: with Velopack's own apply-at-start switched off, the App offers it as any other).
|
||||
/// </summary>
|
||||
UpdateCandidate? FindPendingRestart();
|
||||
|
||||
/// <summary>One feed request; null when the installed version is current.</summary>
|
||||
/// <exception cref="UpdateException">The feed could not be read.</exception>
|
||||
Task<UpdateCandidate?> CheckAsync(bool includePrereleases, CancellationToken ct = default);
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.IO;
|
||||
|
||||
namespace FrameLedger.App.Update;
|
||||
|
||||
/// <summary>
|
||||
/// Whether a library FrameLedger loads into games is still loaded in one (beta.14). The Overlay is never unloaded from a live
|
||||
/// game (<c>17_HOOK_ENGINE</c>), so after a capture is stopped mid-game, or an Agent is restarted, the game keeps
|
||||
/// <c>current\FrameLedger.Overlay.dll</c> mapped until it exits — and Velopack, which swaps the whole install folder, then
|
||||
/// fails half way, after the App has already quit. A mapped image cannot be opened for writing (Windows answers with a
|
||||
/// sharing violation), so the check asks the file system and opens no process: nothing about the game is read.
|
||||
/// </summary>
|
||||
public static class PayloadInUse
|
||||
{
|
||||
/// <summary>The libraries a game can hold: the Overlay FrameLedger injects, and the Vulkan layer a Vulkan game loads.</summary>
|
||||
public static IReadOnlyList<string> Files { get; } = ["FrameLedger.Overlay.dll", "FrameLedger.VkLayer.dll"];
|
||||
|
||||
private const int _sharingViolation = unchecked((int)0x80070020);
|
||||
private const int _lockViolation = unchecked((int)0x80070021);
|
||||
private const int _userMappedFile = unchecked((int)0x800704C8);
|
||||
|
||||
/// <summary>The first of <see cref="Files"/> under <paramref name="directory"/> that something still holds, or null.</summary>
|
||||
public static string? Find(string directory)
|
||||
{
|
||||
ArgumentException.ThrowIfNullOrWhiteSpace(directory);
|
||||
foreach (string name in Files)
|
||||
{
|
||||
string path = Path.Combine(directory, name);
|
||||
if (File.Exists(path) && IsHeld(path))
|
||||
{
|
||||
return name;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private static bool IsHeld(string path)
|
||||
{
|
||||
try
|
||||
{
|
||||
using (new FileStream(path, FileMode.Open, FileAccess.ReadWrite, FileShare.None))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
catch (IOException ex) when (ex.HResult is _sharingViolation or _lockViolation or _userMappedFile)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
catch (UnauthorizedAccessException)
|
||||
{
|
||||
// Not writable to this user: the updater could not replace it either.
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -5,7 +5,8 @@ namespace FrameLedger.App.Update;
|
||||
|
||||
/// <summary>
|
||||
/// The uninstall hook's decisions (<c>12_BUILD</c> §Publish & package: "uninstalled → unregister the layer, remove
|
||||
/// the scheduled task, ask about the data folder"), over delegates so a test runs it without a pipe, a registry, a
|
||||
/// the scheduled task, ask about the data folder" — and since beta.14 remove "Start FrameLedger with Windows", which named an
|
||||
/// executable the uninstaller deletes), over delegates so a test runs it without a pipe, a registry, a
|
||||
/// Task Scheduler or a data folder. Every step is independent: a failure in one is logged and the next still
|
||||
/// runs, and the data folder is deleted only on an explicit yes — a question that goes unanswered inside
|
||||
/// Velopack's 30 s budget leaves the folder where it is.
|
||||
@@ -14,6 +15,7 @@ public sealed class UninstallHook(
|
||||
Func<bool> stopAgent,
|
||||
Func<bool> unregisterLayer,
|
||||
Func<bool> removeTask,
|
||||
Func<bool> removeRunValue,
|
||||
Func<bool> askDeleteData,
|
||||
Action deleteData,
|
||||
Action<string> log)
|
||||
@@ -23,6 +25,7 @@ public sealed class UninstallHook(
|
||||
bool agent = Step("agent shutdown", stopAgent);
|
||||
bool layer = Step("vulkan layer unregister", unregisterLayer);
|
||||
bool task = Step("logon task remove", removeTask);
|
||||
bool run = Step("start with windows remove", removeRunValue);
|
||||
bool asked = false;
|
||||
bool deleted = false;
|
||||
if (Step("data folder question", () =>
|
||||
@@ -38,7 +41,7 @@ public sealed class UninstallHook(
|
||||
});
|
||||
}
|
||||
|
||||
var outcome = new UninstallOutcome(agent, layer, task, asked, deleted);
|
||||
var outcome = new UninstallOutcome(agent, layer, task, run, asked, deleted);
|
||||
log("uninstall: " + outcome);
|
||||
return outcome;
|
||||
}
|
||||
|
||||
@@ -4,4 +4,4 @@
|
||||
namespace FrameLedger.App.Update;
|
||||
|
||||
/// <summary>What the uninstall hook did, for its log line and its test.</summary>
|
||||
public sealed record UninstallOutcome(bool AgentAsked, bool LayerUnregistered, bool TaskRemoved, bool DataAsked, bool DataDeleted);
|
||||
public sealed record UninstallOutcome(bool AgentAsked, bool LayerUnregistered, bool TaskRemoved, bool RunValueRemoved, bool DataAsked, bool DataDeleted);
|
||||
@@ -3,5 +3,13 @@
|
||||
|
||||
namespace FrameLedger.App.Update;
|
||||
|
||||
/// <summary>A release newer than the installed one, as the feed describes it: the version, its notes (the GitHub release body, Markdown), the full package's size.</summary>
|
||||
public sealed record UpdateCandidate(string Version, string? NotesMarkdown, long SizeBytes);
|
||||
/// <summary>
|
||||
/// A release newer than the installed one, as the feed describes it: the version, its notes (the GitHub release body,
|
||||
/// Markdown), the full package's size, and — since beta.14 — the size of the delta packages from the installed version
|
||||
/// when the feed has them (<see cref="DeltaBytes"/>), which is what Velopack downloads unless they fail to apply.
|
||||
/// </summary>
|
||||
public sealed record UpdateCandidate(string Version, string? NotesMarkdown, long SizeBytes)
|
||||
{
|
||||
/// <summary>The deltas' size together, or null when there is none and the full package is the download.</summary>
|
||||
public long? DeltaBytes { get; init; }
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.App.Update;
|
||||
|
||||
/// <summary>
|
||||
/// Which releases a check asks for (beta.14, owner decision D47). <c>update.channel</c> is <c>auto</c> unless the user chose:
|
||||
/// a copy that is itself a pre-release looks for pre-releases and a release looks for releases. Until beta.14 the default was
|
||||
/// <c>stable</c> while every release so far is a GitHub pre-release, so a copy left on its defaults never found an update —
|
||||
/// the owner's own updater log read "No releases found" from the day the ledger was reset. A stored <c>stable</c> or
|
||||
/// <c>beta</c> is a choice the user made, and it wins.
|
||||
/// </summary>
|
||||
public static class UpdateChannelPolicy
|
||||
{
|
||||
public const string Automatic = "auto";
|
||||
|
||||
public const string Stable = "stable";
|
||||
|
||||
public const string Beta = "beta";
|
||||
|
||||
/// <summary>Whether a version is a pre-release in SemVer's sense: a <c>-</c> before any build metadata (<c>0.1.0-beta.14</c>).</summary>
|
||||
public static bool IsPrerelease(string? version)
|
||||
{
|
||||
if (string.IsNullOrWhiteSpace(version))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
int build = version.IndexOf('+', StringComparison.Ordinal);
|
||||
int dash = version.IndexOf('-', StringComparison.Ordinal);
|
||||
return dash > 0 && (build < 0 || dash < build);
|
||||
}
|
||||
|
||||
/// <summary>Whether a check on <paramref name="channel"/> asks for pre-releases, for a copy running <paramref name="runningVersion"/>.</summary>
|
||||
public static bool IncludesPrereleases(string? channel, string? runningVersion) => channel switch
|
||||
{
|
||||
Beta => true,
|
||||
Stable => false,
|
||||
_ => IsPrerelease(runningVersion),
|
||||
};
|
||||
}
|
||||
@@ -1,7 +1,6 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.IO;
|
||||
using System.Net;
|
||||
using System.Net.Http;
|
||||
using System.Net.Sockets;
|
||||
@@ -12,7 +11,7 @@ namespace FrameLedger.App.Update;
|
||||
/// <summary>
|
||||
/// <c>11_UPDATER</c> §Error mapping as a function of the exception Velopack's client threw: the HTTP status when
|
||||
/// there is one (404 → <see cref="UpdateFailure.NotFound"/>, 403/429 → <see cref="UpdateFailure.RateLimited"/>,
|
||||
/// 5xx → <see cref="UpdateFailure.Server"/>), the transport failures → <see cref="UpdateFailure.Offline"/>, a
|
||||
/// 5xx → <see cref="UpdateFailure.Server"/>), the transport failures (never a local disk's) → <see cref="UpdateFailure.Offline"/>, a
|
||||
/// checksum → <see cref="UpdateFailure.Corrupt"/>, the rest → <see cref="UpdateFailure.Unknown"/>. Walks the inner
|
||||
/// chain, because the source wraps what its downloader threw.
|
||||
/// </summary>
|
||||
@@ -40,7 +39,9 @@ public static class UpdateFailureMapper
|
||||
HttpRequestException { StatusCode: { } status } when (int)status >= 500 => UpdateFailure.Server,
|
||||
HttpRequestException { StatusCode: null } => UpdateFailure.Offline,
|
||||
HttpRequestException => UpdateFailure.Unknown,
|
||||
TaskCanceledException or TimeoutException or SocketException or IOException => UpdateFailure.Offline,
|
||||
// An I/O error is "offline" only from the network (beta.14): a full disk or a locked file is not, and an IOException
|
||||
// that wraps a socket error is classified at the socket, one step down the chain.
|
||||
TaskCanceledException or TimeoutException or SocketException or HttpIOException => UpdateFailure.Offline,
|
||||
_ => null,
|
||||
};
|
||||
}
|
||||
@@ -9,7 +9,7 @@ using Serilog;
|
||||
namespace FrameLedger.App.Update;
|
||||
|
||||
/// <summary>
|
||||
/// The startup leg of <c>11_UPDATER</c> §Flow: the silent check 5 s after the host is up (the spec's "5 s after UI
|
||||
/// The startup leg of <c>11_UPDATER</c> §Flow: a package an earlier run left downloaded offered at once (beta.14), the silent check 5 s after the host is up (the spec's "5 s after UI
|
||||
/// idle", measured from start because the shell shows synchronously inside it), and — on the first run after an
|
||||
/// update — the logon task's action path re-validated, because the updater rewrote the install directory
|
||||
/// (<c>LogonTaskState.Stale</c> is the signal; <c>--install-task</c> the repair, this user's own task).
|
||||
@@ -27,6 +27,8 @@ internal sealed class UpdateHostedService(UpdateService updates, IMaintenanceSta
|
||||
await RepairTaskAsync(stoppingToken).ConfigureAwait(false);
|
||||
}
|
||||
|
||||
// A package an earlier run downloaded is offered first, from the install folder; the check then has nothing to do.
|
||||
updates.AdoptPending();
|
||||
await Task.Delay(_startupDelay, stoppingToken).ConfigureAwait(false);
|
||||
await updates.CheckSilentlyAsync(stoppingToken).ConfigureAwait(false);
|
||||
}
|
||||
|
||||
@@ -24,7 +24,7 @@ public sealed class UpdatePrompts(IUrlOpener urls, BugReportFlow bugReports) : I
|
||||
var body = new StackPanel();
|
||||
body.Children.Add(new System.Windows.Controls.TextBlock
|
||||
{
|
||||
Text = string.Format(CultureInfo.CurrentCulture, Strings.Update_Available_Body_Format, candidate.Version, candidate.SizeBytes / (1024 * 1024)),
|
||||
Text = OfferText(candidate),
|
||||
TextWrapping = TextWrapping.Wrap,
|
||||
});
|
||||
if (!string.IsNullOrWhiteSpace(candidate.NotesMarkdown))
|
||||
@@ -50,6 +50,27 @@ public sealed class UpdatePrompts(IUrlOpener urls, BugReportFlow bugReports) : I
|
||||
return result == MessageBoxResult.Primary;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The offer's first line. Since beta.14 it says the download Velopack will make: the deltas from the installed version
|
||||
/// when the feed has them — 1.6 MB for beta.12 → beta.13 — with the full package named as the fallback; it said the full
|
||||
/// package's ~102 MB even when the delta was what came.
|
||||
/// </summary>
|
||||
public static string OfferText(UpdateCandidate candidate)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(candidate);
|
||||
string full = Megabytes(candidate.SizeBytes);
|
||||
return candidate.DeltaBytes is { } delta && delta < candidate.SizeBytes
|
||||
? string.Format(CultureInfo.CurrentCulture, Strings.Update_Available_Body_Delta_Format, candidate.Version, Megabytes(delta), full)
|
||||
: string.Format(CultureInfo.CurrentCulture, Strings.Update_Available_Body_Format, candidate.Version, full);
|
||||
}
|
||||
|
||||
/// <summary>Whole megabytes, one decimal under ten ("1.5", "102").</summary>
|
||||
private static string Megabytes(long bytes)
|
||||
{
|
||||
double mb = bytes / (1024.0 * 1024.0);
|
||||
return mb.ToString(mb < 10 ? "0.#" : "0", CultureInfo.CurrentCulture);
|
||||
}
|
||||
|
||||
public Task UpToDateAsync(string version, CancellationToken ct = default) =>
|
||||
ShowAsync(Strings.Menu_Help_CheckUpdates, string.Format(CultureInfo.CurrentCulture, Strings.Update_UpToDate_Format, version), ct);
|
||||
|
||||
|
||||
@@ -20,12 +20,22 @@ namespace FrameLedger.App.Update;
|
||||
/// the host once the pipe has dropped; Velopack waits for the exit, applies, and restarts the App, which starts
|
||||
/// the Agent beside itself as it always does.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// beta.14 (the update audit): Velopack's own apply-at-start is off (<see cref="VelopackHooks"/>), so a package an earlier
|
||||
/// run downloaded is adopted here (<see cref="AdoptPending"/>) and goes through FR-12 and the Agent's stop like any other —
|
||||
/// until then the next start applied it inside <c>VelopackApp.Run</c>, killing the Agent, before any of this ran. The
|
||||
/// channel follows the running copy unless the user chose one (<see cref="UpdateChannelPolicy"/>, D47); an apply waits
|
||||
/// while a game still has the Overlay loaded (<see cref="PayloadInUse"/>) and while an Agent waits on the administrator
|
||||
/// prompt; the stop budget outlasts the Agent's own shutdown grace.
|
||||
/// </remarks>
|
||||
public sealed partial class UpdateService : ObservableObject, IDisposable
|
||||
{
|
||||
private static readonly TimeSpan _defaultAgentStopTimeout = TimeSpan.FromSeconds(10);
|
||||
/// <summary>The Agent's own shutdown grace (it finalizes its sessions inside it), and five seconds to leave after it.</summary>
|
||||
internal static readonly TimeSpan DefaultAgentStopTimeout = IpcProtocol.AgentShutdownGrace + TimeSpan.FromSeconds(5);
|
||||
|
||||
private readonly TimeSpan _agentStopTimeout;
|
||||
private readonly Func<bool> _agentHeld;
|
||||
private readonly Func<string?> _payloadInUse;
|
||||
private readonly IUpdateClient _client;
|
||||
private readonly IAgentLink _agent;
|
||||
private readonly RegisteredSettings _settings;
|
||||
@@ -47,14 +57,17 @@ public sealed partial class UpdateService : ObservableObject, IDisposable
|
||||
|
||||
/// <summary>
|
||||
/// The flow over its ports; subscribes to the Agent link for the session facts FR-12 needs. <paramref name="agentStopTimeout"/>
|
||||
/// is how long the apply waits for the Agent to stop after <c>Shutdown</c> (10 s), overridable as a test's clock;
|
||||
/// <paramref name="agentHeld"/> is whether an Agent process still holds the data folder (the instance lock), a test's own.
|
||||
/// is how long the apply waits for the Agent to stop after <c>Shutdown</c> (<see cref="DefaultAgentStopTimeout"/>), overridable
|
||||
/// as a test's clock; <paramref name="agentHeld"/> is whether an Agent process still holds the data folder — its instance
|
||||
/// lock, or the marker of one waiting on the administrator prompt — and <paramref name="payloadInUse"/> which library a game
|
||||
/// still has loaded from the install folder, both a test's own.
|
||||
/// </summary>
|
||||
public UpdateService(IUpdateClient client, IAgentLink agent, RegisteredSettings settings, IUpdatePrompts prompts, IShellPresence shell, IMessageStrip strip,
|
||||
TimeSpan? agentStopTimeout = null, Func<bool>? agentHeld = null)
|
||||
TimeSpan? agentStopTimeout = null, Func<bool>? agentHeld = null, Func<string?>? payloadInUse = null)
|
||||
{
|
||||
_agentStopTimeout = agentStopTimeout ?? _defaultAgentStopTimeout;
|
||||
_agentHeld = agentHeld ?? (static () => Infrastructure.Startup.AgentInstanceLock.IsHeld(Services.UiPaths.DataDirectory));
|
||||
_agentStopTimeout = agentStopTimeout ?? DefaultAgentStopTimeout;
|
||||
_agentHeld = agentHeld ?? (static () => AgentHolds(Services.UiPaths.DataDirectory));
|
||||
_payloadInUse = payloadInUse ?? (static () => PayloadInUse.Find(AppContext.BaseDirectory));
|
||||
_client = client ?? throw new ArgumentNullException(nameof(client));
|
||||
_agent = agent ?? throw new ArgumentNullException(nameof(agent));
|
||||
_settings = settings ?? throw new ArgumentNullException(nameof(settings));
|
||||
@@ -82,6 +95,34 @@ public sealed partial class UpdateService : ObservableObject, IDisposable
|
||||
_agent.EventReceived -= OnAgentEvent;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Whether an Agent holds <paramref name="dataDirectory"/>: its instance lock, or — since beta.14 — the marker of one waiting on
|
||||
/// the administrator prompt, which holds no lock yet and was stopped by nothing (Velopack's updater killed it).
|
||||
/// </summary>
|
||||
internal static bool AgentHolds(string dataDirectory) =>
|
||||
Infrastructure.Startup.AgentInstanceLock.IsHeld(dataDirectory) || Infrastructure.Startup.ElevationMarker.IsHeld(dataDirectory);
|
||||
|
||||
/// <summary>
|
||||
/// A package an earlier run downloaded and nobody applied (beta.14): Ready, or Deferred while a session runs — no feed request.
|
||||
/// Velopack applied it at the next start until then, before FR-12 or the Agent's stop could run. Called before the startup check.
|
||||
/// </summary>
|
||||
public void AdoptPending()
|
||||
{
|
||||
if (!_client.IsInstalled || Stage != UpdateStage.Idle || _client.FindPendingRestart() is not { } pending)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
Log.Information("update: {Version} was downloaded by an earlier run and is waiting for a restart", pending.Version);
|
||||
_pending = pending;
|
||||
Post(() =>
|
||||
{
|
||||
Version = pending.Version;
|
||||
Percent = 100;
|
||||
Settle();
|
||||
});
|
||||
}
|
||||
|
||||
/// <summary>The startup check: skipped for an uninstalled copy and when the setting is off; every failure is a log line, never a dialog (NFR-10).</summary>
|
||||
public async Task CheckSilentlyAsync(CancellationToken ct = default)
|
||||
{
|
||||
@@ -172,6 +213,7 @@ public sealed partial class UpdateService : ObservableObject, IDisposable
|
||||
/// Then <c>Shutdown</c> to the Agent, the relaunch held, the pipe watched until it drops, the updater told to
|
||||
/// wait for this process, and the host ended. An Agent that does not stop in time leaves everything as it was.
|
||||
/// </summary>
|
||||
[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1863:Use 'CompositeFormat'", Justification = "the format string is a resource that follows the UI culture, which changes at runtime")]
|
||||
public async Task RestartToUpdateAsync(CancellationToken ct = default)
|
||||
{
|
||||
UpdateCandidate? pending = _pending;
|
||||
@@ -187,6 +229,16 @@ public sealed partial class UpdateService : ObservableObject, IDisposable
|
||||
return;
|
||||
}
|
||||
|
||||
// A game FrameLedger measured earlier can still have the Overlay loaded from the install folder; the swap would fail
|
||||
// half way after this App had quit. Asked before the Agent is stopped, so a refusal leaves it running.
|
||||
if (_payloadInUse() is { } held)
|
||||
{
|
||||
Log.Information("update: {File} is still loaded by a running game; the apply waits", held);
|
||||
Stage = UpdateStage.Ready;
|
||||
_strip.Warn(Strings.Update_Banner_Title, string.Format(System.Globalization.CultureInfo.CurrentCulture, Strings.Update_PayloadInUse_Format, held));
|
||||
return;
|
||||
}
|
||||
|
||||
Stage = UpdateStage.Applying;
|
||||
_agent.SetLaunchHold(true);
|
||||
if (!await StopAgentAsync(ct).ConfigureAwait(true))
|
||||
@@ -217,7 +269,9 @@ public sealed partial class UpdateService : ObservableObject, IDisposable
|
||||
private async Task<UpdateCandidate?> CheckCoreAsync(CancellationToken ct)
|
||||
{
|
||||
Post(() => Stage = UpdateStage.Checking);
|
||||
bool prereleases = string.Equals(await _settings.GetAsync(SettingsRegistry.UpdateChannel, ct).ConfigureAwait(false), "beta", StringComparison.Ordinal);
|
||||
// D47 (beta.14): `auto` follows this copy; a stored `stable` or `beta` is the user's choice.
|
||||
string channel = await _settings.GetAsync(SettingsRegistry.UpdateChannel, ct).ConfigureAwait(false);
|
||||
bool prereleases = UpdateChannelPolicy.IncludesPrereleases(channel, _client.CurrentVersion ?? UiIdentity.Version);
|
||||
UpdateCandidate? candidate = await _client.CheckAsync(prereleases, ct).ConfigureAwait(false);
|
||||
if (candidate is null)
|
||||
{
|
||||
|
||||
@@ -21,6 +21,15 @@ namespace FrameLedger.App.Update;
|
||||
/// is <see cref="UninstallHook"/> over the real pieces. A restart after an update sets <see cref="UpdateRestart"/>
|
||||
/// so the host re-validates the logon task's action path.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// beta.14 (the update audit). <b>Velopack's apply-at-start is off</b>: it is on by default, and a package the startup check
|
||||
/// downloaded was applied by the next start of this executable inside <see cref="VelopackApp.Run"/> — before FR-12 could
|
||||
/// ask whether a session runs and before the Agent could be stopped; its updater killed the Agent instead ("Killing
|
||||
/// process: …FrameLedger.Agent.exe", the owner's own log). <c>UpdateService.AdoptPending</c> offers such a package now.
|
||||
/// Velopack's own diagnostics go to this App's log (<see cref="VelopackSerilogLogger"/>). An update Velopack starts itself — the
|
||||
/// installer run over an installed copy — asks the Agent to stop first, as the uninstaller does; that hook runs in the
|
||||
/// version being replaced, so it first works for the update after beta.14.
|
||||
/// </remarks>
|
||||
internal static class VelopackHooks
|
||||
{
|
||||
/// <summary>
|
||||
@@ -34,9 +43,19 @@ internal static class VelopackHooks
|
||||
private static readonly TimeSpan _exitTimeout = TimeSpan.FromSeconds(5);
|
||||
|
||||
public static VelopackApp Configure(VelopackApp app) => app
|
||||
.SetAutoApplyOnStartup(false)
|
||||
.SetLogger(new VelopackSerilogLogger())
|
||||
.OnRestarted(static _ => UpdateRestart.Detected = true)
|
||||
.OnBeforeUpdateFastCallback(static _ => BeforeUpdate())
|
||||
.OnBeforeUninstallFastCallback(static _ => BeforeUninstall());
|
||||
|
||||
/// <summary>Velopack is about to replace this version: the Agent finalizes its sessions and leaves, rather than being killed.</summary>
|
||||
private static void BeforeUpdate()
|
||||
{
|
||||
bool asked = StopAgent();
|
||||
Log("update.log", "before update: " + (asked ? "the Agent was asked to stop" : "no Agent answered; nothing to stop"));
|
||||
}
|
||||
|
||||
private static void BeforeUninstall()
|
||||
{
|
||||
string manifest = Path.Combine(VkLayerLaunchEnvironment.DefaultDirectory, VkLayerLaunchEnvironment.ManifestFileName);
|
||||
@@ -44,11 +63,22 @@ internal static class VelopackHooks
|
||||
stopAgent: StopAgent,
|
||||
unregisterLayer: () => new VkLayerRegistration().Unregister(manifest),
|
||||
removeTask: static () => new LogonTask().Remove() is null,
|
||||
removeRunValue: static () =>
|
||||
{
|
||||
var run = new RunAtLogonRegistry();
|
||||
if (!run.IsSet)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
run.Apply(enabled: false);
|
||||
return true;
|
||||
},
|
||||
askDeleteData: static () => UninstallHook.AreSeparate(UiPaths.DataDirectory, AppContext.BaseDirectory)
|
||||
? System.Windows.MessageBox.Show(Strings.Uninstall_DataFolder_Body, Strings.Uninstall_DataFolder_Title, MessageBoxButton.YesNo, MessageBoxImage.Question, MessageBoxResult.No) == MessageBoxResult.Yes
|
||||
: throw new InvalidOperationException($"the install ({AppContext.BaseDirectory}) and the data folder ({UiPaths.DataDirectory}) overlap; nothing is deleted"),
|
||||
deleteData: static () => Directory.Delete(UiPaths.DataDirectory, recursive: true),
|
||||
log: Log);
|
||||
log: static line => Log("uninstall.log", line));
|
||||
hook.Run();
|
||||
}
|
||||
|
||||
@@ -109,7 +139,7 @@ internal static class VelopackHooks
|
||||
}
|
||||
|
||||
/// <summary>Serilog is not configured this early; the hook's own file under <c>logs/</c>, appended, never thrown from.</summary>
|
||||
private static void Log(string line)
|
||||
private static void Log(string file, string line)
|
||||
{
|
||||
try
|
||||
{
|
||||
@@ -120,7 +150,7 @@ internal static class VelopackHooks
|
||||
}
|
||||
|
||||
Directory.CreateDirectory(UiPaths.Logs);
|
||||
File.AppendAllText(Path.Combine(UiPaths.Logs, "uninstall.log"), $"[{DateTimeOffset.UtcNow:O}] {line}{Environment.NewLine}");
|
||||
File.AppendAllText(Path.Combine(UiPaths.Logs, file), $"[{DateTimeOffset.UtcNow:O}] {line}{Environment.NewLine}");
|
||||
}
|
||||
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException)
|
||||
{
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using Serilog;
|
||||
using Serilog.Events;
|
||||
using Velopack.Logging;
|
||||
|
||||
namespace FrameLedger.App.Update;
|
||||
|
||||
/// <summary>
|
||||
/// Velopack's own diagnostics in the App's log (beta.14), each line prefixed <c>velopack:</c> — whether an update came as a
|
||||
/// delta or as the full package, which processes it stopped, why an apply failed. Until then they were only in Velopack's
|
||||
/// file under <c>%LOCALAPPDATA%\velopack</c>, which the bug report does not collect. Set in <c>Program.Main</c>, before Serilog
|
||||
/// is configured: each line reads <see cref="Log.Logger"/> when it is written, so the early ones go nowhere and the rest arrive.
|
||||
/// </summary>
|
||||
internal sealed class VelopackSerilogLogger : IVelopackLogger
|
||||
{
|
||||
public void Log(VelopackLogLevel logLevel, string? message, Exception? exception) =>
|
||||
Serilog.Log.Logger.Write(Level(logLevel), exception, "velopack: {Message}", message ?? string.Empty);
|
||||
|
||||
internal static LogEventLevel Level(VelopackLogLevel level) => level switch
|
||||
{
|
||||
VelopackLogLevel.Trace => LogEventLevel.Verbose,
|
||||
VelopackLogLevel.Debug => LogEventLevel.Debug,
|
||||
VelopackLogLevel.Information => LogEventLevel.Information,
|
||||
VelopackLogLevel.Warning => LogEventLevel.Warning,
|
||||
VelopackLogLevel.Error => LogEventLevel.Error,
|
||||
_ => LogEventLevel.Fatal,
|
||||
};
|
||||
}
|
||||
@@ -12,7 +12,8 @@ namespace FrameLedger.App.Update;
|
||||
/// (<c>11_UPDATER</c>): the stable channel is the releases GitHub does not mark pre-release, the beta channel adds the
|
||||
/// ones it does (<c>13_CI_CD</c> §Branch & release policy — <c>vX.Y.Z-beta.N</c>). One manager per check, because
|
||||
/// the channel is a constructor argument there; the <see cref="UpdateInfo"/> a check returned is held for the
|
||||
/// download and the apply that follow it.
|
||||
/// download and the apply that follow it — or, since beta.14, the package an earlier run left downloaded
|
||||
/// (<see cref="FindPendingRestart"/>), which is applied without a download.
|
||||
/// </summary>
|
||||
public sealed class VelopackUpdateClient : IUpdateClient
|
||||
{
|
||||
@@ -20,12 +21,37 @@ public sealed class VelopackUpdateClient : IUpdateClient
|
||||
public const string RepositoryUrl = "https://github.com/poli0981/frameledger";
|
||||
|
||||
private readonly Lock _lock = new();
|
||||
private (UpdateManager Manager, UpdateInfo Info, string Version)? _held;
|
||||
private (UpdateManager Manager, UpdateInfo? Info, VelopackAsset Asset, string Version)? _held;
|
||||
|
||||
public bool IsInstalled => Probe(static m => m.IsInstalled, false);
|
||||
|
||||
public string? CurrentVersion => Probe(static m => m.CurrentVersion?.ToString(), null);
|
||||
|
||||
public UpdateCandidate? FindPendingRestart()
|
||||
{
|
||||
try
|
||||
{
|
||||
UpdateManager manager = Create(false);
|
||||
if (manager.UpdatePendingRestart is not { } pending)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
string version = pending.Version.ToString();
|
||||
lock (_lock)
|
||||
{
|
||||
_held = (manager, null, pending, version);
|
||||
}
|
||||
|
||||
return new UpdateCandidate(version, pending.NotesMarkdown, pending.Size);
|
||||
}
|
||||
catch (Exception ex) when (ex is not OutOfMemoryException)
|
||||
{
|
||||
Serilog.Log.Debug(ex, "update: the install folder's pending package could not be read");
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
public async Task<UpdateCandidate?> CheckAsync(bool includePrereleases, CancellationToken ct = default)
|
||||
{
|
||||
ct.ThrowIfCancellationRequested();
|
||||
@@ -42,10 +68,13 @@ public sealed class VelopackUpdateClient : IUpdateClient
|
||||
string version = target.Version.ToString();
|
||||
lock (_lock)
|
||||
{
|
||||
_held = (manager, info, version);
|
||||
_held = (manager, info, target, version);
|
||||
}
|
||||
|
||||
return new UpdateCandidate(version, target.NotesMarkdown, target.Size);
|
||||
// Velopack downloads the deltas from the installed version when the feed has them (beta.13 on), the full
|
||||
// package when it has none or a delta fails to apply; the offer says the first and names the second.
|
||||
long? delta = info.DeltasToTarget is { Length: > 0 } deltas ? deltas.Sum(static d => d.Size) : null;
|
||||
return new UpdateCandidate(version, target.NotesMarkdown, target.Size) { DeltaBytes = delta };
|
||||
}
|
||||
catch (Exception ex) when (IsFailure(ex, ct))
|
||||
{
|
||||
@@ -55,7 +84,14 @@ public sealed class VelopackUpdateClient : IUpdateClient
|
||||
|
||||
public async Task DownloadAsync(UpdateCandidate candidate, IProgress<int>? progress, CancellationToken ct = default)
|
||||
{
|
||||
(UpdateManager manager, UpdateInfo info) = Held(candidate);
|
||||
(UpdateManager manager, UpdateInfo? info, _) = Held(candidate);
|
||||
if (info is null)
|
||||
{
|
||||
// The package an earlier run downloaded: already in place, verified when it was downloaded.
|
||||
progress?.Report(100);
|
||||
return;
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
await manager.DownloadUpdatesAsync(info, p => progress?.Report(p), ct).ConfigureAwait(false);
|
||||
@@ -69,8 +105,8 @@ public sealed class VelopackUpdateClient : IUpdateClient
|
||||
/// <summary>Velopack's updater waits up to 60 s for this process to exit; the caller ends the host right after.</summary>
|
||||
public void ApplyOnExit(UpdateCandidate candidate)
|
||||
{
|
||||
(UpdateManager manager, UpdateInfo info) = Held(candidate);
|
||||
manager.WaitExitThenApplyUpdates(info.TargetFullRelease, silent: false, restart: true);
|
||||
(UpdateManager manager, _, VelopackAsset asset) = Held(candidate);
|
||||
manager.WaitExitThenApplyUpdates(asset, silent: false, restart: true);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -99,14 +135,14 @@ public sealed class VelopackUpdateClient : IUpdateClient
|
||||
}
|
||||
}
|
||||
|
||||
private (UpdateManager Manager, UpdateInfo Info) Held(UpdateCandidate candidate)
|
||||
private (UpdateManager Manager, UpdateInfo? Info, VelopackAsset Asset) Held(UpdateCandidate candidate)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(candidate);
|
||||
lock (_lock)
|
||||
{
|
||||
if (_held is { } held && string.Equals(held.Version, candidate.Version, StringComparison.Ordinal))
|
||||
{
|
||||
return (held.Manager, held.Info);
|
||||
return (held.Manager, held.Info, held.Asset);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -210,10 +210,16 @@ public sealed partial class SettingsViewModel : ObservableObject
|
||||
new("ja", "日本語"),
|
||||
];
|
||||
|
||||
/// <summary>
|
||||
/// D47 (beta.14): Automatic first, its label saying what it resolves to for this copy — "Automatic (Beta)" on a
|
||||
/// pre-release — then the two explicit choices, either of which wins over the copy.
|
||||
/// </summary>
|
||||
public static IReadOnlyList<Choice<string>> UpdateChannels { get; } =
|
||||
[
|
||||
new("stable", Strings.Settings_Channel_Stable),
|
||||
new("beta", Strings.Settings_Channel_Beta),
|
||||
new(Update.UpdateChannelPolicy.Automatic, string.Format(CultureInfo.CurrentCulture, Strings.Settings_Channel_Auto_Format,
|
||||
Update.UpdateChannelPolicy.IsPrerelease(UiIdentity.Version) ? Strings.Settings_Channel_Beta : Strings.Settings_Channel_Stable)),
|
||||
new(Update.UpdateChannelPolicy.Stable, Strings.Settings_Channel_Stable),
|
||||
new(Update.UpdateChannelPolicy.Beta, Strings.Settings_Channel_Beta),
|
||||
];
|
||||
|
||||
public static double MinSessionMinimum => SettingsRegistry.CaptureMinSessionSeconds.Minimum;
|
||||
|
||||
@@ -174,13 +174,18 @@ public static class SettingsRegistry
|
||||
AgentReads = true,
|
||||
};
|
||||
|
||||
/// <summary><c>11_UPDATER</c>: the release feed's channel — <c>stable</c> is the releases GitHub does not mark pre-release, <c>beta</c> adds the ones it does (P4 PR-5 reads it).</summary>
|
||||
/// <summary>
|
||||
/// <c>11_UPDATER</c>: the release feed's channel — <c>stable</c> is the releases GitHub does not mark pre-release, <c>beta</c>
|
||||
/// adds the ones it does (P4 PR-5 reads it). <c>auto</c>, the default since beta.14 (owner decision D47), follows the
|
||||
/// running copy: a pre-release asks for pre-releases. The default was <c>stable</c> until then, while every release is a
|
||||
/// pre-release — a copy left on its defaults never found one.
|
||||
/// </summary>
|
||||
public static readonly SettingDefinition UpdateChannel = new()
|
||||
{
|
||||
Key = "update.channel",
|
||||
Kind = SettingKind.Choice,
|
||||
Default = "stable",
|
||||
Choices = ["stable", "beta"],
|
||||
Default = "auto",
|
||||
Choices = ["auto", "stable", "beta"],
|
||||
};
|
||||
|
||||
/// <summary><c>11_UPDATER</c> §Flow: the startup silent check, "if enabled" — on by default, one request to GitHub Releases after start (P4 PR-5).</summary>
|
||||
|
||||
@@ -31,4 +31,10 @@ public static class IpcProtocol
|
||||
|
||||
/// <summary>The client's keepalive cadence (<c>Ping</c> → <c>Pong</c>).</summary>
|
||||
public static readonly TimeSpan Keepalive = TimeSpan.FromSeconds(15);
|
||||
|
||||
/// <summary>
|
||||
/// How long the Agent's host gives its services to stop after <c>Shutdown</c> — a session's finalize included — before it
|
||||
/// exits anyway. One constant (beta.14): the App's update waited 10 s for an Agent that took up to 15.
|
||||
/// </summary>
|
||||
public static readonly TimeSpan AgentShutdownGrace = TimeSpan.FromSeconds(15);
|
||||
}
|
||||
@@ -222,7 +222,7 @@ public sealed class SettingsViewModelTests
|
||||
h.Vm.MinSessionSeconds.Should().Be(30);
|
||||
h.Vm.TelemetryIntervalMs.Should().Be(1000);
|
||||
h.Vm.RetentionRawSessions.Should().Be(20);
|
||||
h.Vm.UpdateChannel.Should().Be("stable");
|
||||
h.Vm.UpdateChannel.Should().Be("auto", "D47 (beta.14): the channel follows the running copy unless the user chose one");
|
||||
h.Vm.LogDebug.Should().BeFalse();
|
||||
h.Vm.KillSwitchState.Should().Be(Strings.Settings_KillSwitch_Off);
|
||||
h.Vm.VulkanLayerText.Should().Be(Strings.Settings_VkLayer_NotStaged, "no layer DLL in the fake");
|
||||
|
||||
@@ -12,6 +12,9 @@ internal sealed class FakeUpdateClient : IUpdateClient
|
||||
|
||||
public string? CurrentVersion { get; set; } = "0.1.0";
|
||||
|
||||
/// <summary>A package an earlier run left downloaded (beta.14), or null.</summary>
|
||||
public UpdateCandidate? Pending { get; set; }
|
||||
|
||||
/// <summary>What the next check returns; null is "current".</summary>
|
||||
public UpdateCandidate? Next { get; set; }
|
||||
|
||||
@@ -29,6 +32,8 @@ internal sealed class FakeUpdateClient : IUpdateClient
|
||||
|
||||
public List<string> Applied { get; } = [];
|
||||
|
||||
public UpdateCandidate? FindPendingRestart() => Pending;
|
||||
|
||||
public Task<UpdateCandidate?> CheckAsync(bool includePrereleases, CancellationToken ct = default)
|
||||
{
|
||||
Checks.Add(includePrereleases);
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.IO;
|
||||
using FluentAssertions;
|
||||
using FrameLedger.App.Update;
|
||||
|
||||
namespace FrameLedger.App.Tests.Update;
|
||||
|
||||
/// <summary>
|
||||
/// beta.14: an update waits while a game still holds a library FrameLedger loads into games. A file another process keeps
|
||||
/// open stands in for a mapped image here — both refuse the exclusive write the check asks for.
|
||||
/// </summary>
|
||||
public sealed class PayloadInUseTests : IDisposable
|
||||
{
|
||||
private readonly string _dir = Path.Combine(Path.GetTempPath(), "fl-payload-" + Guid.NewGuid().ToString("N"));
|
||||
|
||||
public PayloadInUseTests()
|
||||
{
|
||||
Directory.CreateDirectory(_dir);
|
||||
foreach (string name in PayloadInUse.Files)
|
||||
{
|
||||
File.WriteAllBytes(Path.Combine(_dir, name), [0x4D, 0x5A]);
|
||||
}
|
||||
}
|
||||
|
||||
public void Dispose() => Directory.Delete(_dir, recursive: true);
|
||||
|
||||
[Fact]
|
||||
public void NothingHoldsThePayloadAfterTheGamesHaveExited() => PayloadInUse.Find(_dir).Should().BeNull();
|
||||
|
||||
[Fact]
|
||||
public void AnOverlayAGameStillHoldsIsNamed()
|
||||
{
|
||||
using var game = new FileStream(Path.Combine(_dir, "FrameLedger.Overlay.dll"), FileMode.Open, FileAccess.Read, FileShare.Read | FileShare.Delete);
|
||||
|
||||
PayloadInUse.Find(_dir).Should().Be("FrameLedger.Overlay.dll");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AFolderWithoutThePayloadHoldsNothing() => PayloadInUse.Find(Path.GetTempPath()).Should().BeNull("a library that is not there is not in use");
|
||||
}
|
||||
@@ -17,6 +17,8 @@ public sealed class UninstallHookTests
|
||||
|
||||
public int Task { get; set; }
|
||||
|
||||
public int RunValue { get; set; }
|
||||
|
||||
public int Asked { get; set; }
|
||||
|
||||
public int Deleted { get; set; }
|
||||
@@ -43,6 +45,11 @@ public sealed class UninstallHookTests
|
||||
Task++;
|
||||
return true;
|
||||
},
|
||||
removeRunValue: () =>
|
||||
{
|
||||
RunValue++;
|
||||
return true;
|
||||
},
|
||||
askDeleteData: () =>
|
||||
{
|
||||
Asked++;
|
||||
@@ -68,8 +75,8 @@ public sealed class UninstallHookTests
|
||||
|
||||
UninstallOutcome outcome = p.Hook().Run();
|
||||
|
||||
outcome.Should().Be(new UninstallOutcome(true, true, true, true, true));
|
||||
(p.Agent, p.Layer, p.Task, p.Asked, p.Deleted).Should().Be((1, 1, 1, 1, 1));
|
||||
outcome.Should().Be(new UninstallOutcome(true, true, true, true, true, true));
|
||||
(p.Agent, p.Layer, p.Task, p.RunValue, p.Asked, p.Deleted).Should().Be((1, 1, 1, 1, 1, 1), "beta.14: the Run value named an executable the uninstaller deletes");
|
||||
p.Log.Should().Contain(static l => l.Contains("data folder delete: done", StringComparison.Ordinal));
|
||||
}
|
||||
|
||||
@@ -80,7 +87,7 @@ public sealed class UninstallHookTests
|
||||
|
||||
UninstallOutcome outcome = p.Hook().Run();
|
||||
|
||||
outcome.Should().Be(new UninstallOutcome(true, true, true, true, false));
|
||||
outcome.Should().Be(new UninstallOutcome(true, true, true, true, true, false));
|
||||
p.Deleted.Should().Be(0, "the folder is the user's; only a yes removes it");
|
||||
(p.Layer, p.Task).Should().Be((1, 1));
|
||||
}
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using FluentAssertions;
|
||||
using FrameLedger.App.Update;
|
||||
|
||||
namespace FrameLedger.App.Tests.Update;
|
||||
|
||||
/// <summary>
|
||||
/// D47 (beta.14): the update channel follows the running copy unless the user chose one. Every release so far is a GitHub
|
||||
/// pre-release, and the old default — stable — found none of them.
|
||||
/// </summary>
|
||||
public sealed class UpdateChannelPolicyTests
|
||||
{
|
||||
[Theory]
|
||||
[InlineData("0.1.0-beta.14", true)]
|
||||
[InlineData("0.1.0-beta.9", true)]
|
||||
[InlineData("1.0.0-rc.1+abc123", true)]
|
||||
[InlineData("0.1.0", false)]
|
||||
[InlineData("1.2.3+build-7", false)]
|
||||
[InlineData("", false)]
|
||||
[InlineData(null, false)]
|
||||
public void APrereleaseHasADashBeforeAnyBuildMetadata(string? version, bool prerelease) =>
|
||||
UpdateChannelPolicy.IsPrerelease(version).Should().Be(prerelease);
|
||||
|
||||
[Theory]
|
||||
[InlineData("auto", "0.1.0-beta.14", true)]
|
||||
[InlineData("auto", "0.1.0", false)]
|
||||
[InlineData("stable", "0.1.0-beta.14", false)]
|
||||
[InlineData("beta", "0.1.0", true)]
|
||||
[InlineData("auto", null, false)]
|
||||
public void AutomaticFollowsTheCopyAndAChoiceWins(string channel, string? running, bool prereleases) =>
|
||||
UpdateChannelPolicy.IncludesPrereleases(channel, running).Should().Be(prereleases);
|
||||
}
|
||||
@@ -24,6 +24,10 @@ public sealed class UpdateFailureMapperTests
|
||||
{ new TaskCanceledException("timeout"), UpdateFailure.Offline },
|
||||
{ new SocketException(10060), UpdateFailure.Offline },
|
||||
{ new TimeoutException(), UpdateFailure.Offline },
|
||||
{ new HttpIOException(HttpRequestError.ResponseEnded, "the response ended prematurely"), UpdateFailure.Offline },
|
||||
{ new System.IO.IOException("Unable to read data from the transport connection", new SocketException(10054)), UpdateFailure.Offline },
|
||||
// beta.14: an I/O error that is not the network's — a full disk, a file held by another process — is not "offline".
|
||||
{ new System.IO.IOException("There is not enough space on the disk."), UpdateFailure.Unknown },
|
||||
{ new InvalidOperationException("wrapped by the source", new HttpRequestException("gone", null, HttpStatusCode.NotFound)), UpdateFailure.NotFound },
|
||||
{ new HttpRequestException("odd", null, HttpStatusCode.Unauthorized), UpdateFailure.Unknown },
|
||||
{ new InvalidOperationException("no idea"), UpdateFailure.Unknown },
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Globalization;
|
||||
using FluentAssertions;
|
||||
using FrameLedger.App.Update;
|
||||
|
||||
namespace FrameLedger.App.Tests.Update;
|
||||
|
||||
/// <summary>
|
||||
/// beta.14: the offer says the download Velopack will make. With deltas in the feed (beta.13 on) that is a few megabytes,
|
||||
/// and the offer said the full package's ~102 MB.
|
||||
/// </summary>
|
||||
[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1863:Use 'CompositeFormat'", Justification = "the expected texts are resources that follow the UI culture")]
|
||||
public sealed class UpdatePromptsTests
|
||||
{
|
||||
[Fact]
|
||||
public void WithADeltaTheOfferSaysItsSizeAndNamesTheFullPackageAsTheFallback()
|
||||
{
|
||||
var candidate = new UpdateCandidate("0.1.0-beta.14", null, 107_131_729) { DeltaBytes = 1_599_033 };
|
||||
|
||||
UpdatePrompts.OfferText(candidate).Should().Be(string.Format(CultureInfo.CurrentCulture, Strings.Update_Available_Body_Delta_Format,
|
||||
"0.1.0-beta.14", 1.5.ToString("0.#", CultureInfo.CurrentCulture), "102"));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void WithoutADeltaTheOfferSaysTheFullPackage()
|
||||
{
|
||||
var candidate = new UpdateCandidate("0.1.0-beta.14", null, 107_131_729);
|
||||
|
||||
UpdatePrompts.OfferText(candidate).Should().Be(string.Format(CultureInfo.CurrentCulture, Strings.Update_Available_Body_Format, "0.1.0-beta.14", "102"));
|
||||
}
|
||||
}
|
||||
@@ -15,6 +15,7 @@ namespace FrameLedger.App.Tests.Update;
|
||||
/// and the apply — <c>Shutdown</c> to the Agent, the relaunch held, the updater told, the host ended — or refused
|
||||
/// with everything left as it was.
|
||||
/// </summary>
|
||||
[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1863:Use 'CompositeFormat'", Justification = "the expected texts are resources that follow the UI culture")]
|
||||
public sealed class UpdateServiceTests
|
||||
{
|
||||
private static CancellationToken Ct => TestContext.Current.CancellationToken;
|
||||
@@ -53,9 +54,12 @@ public sealed class UpdateServiceTests
|
||||
/// <summary>Whether an Agent process still holds the data folder (beta.10) — this test's, never the real folder's lock.</summary>
|
||||
public bool AgentHeld { get; set; }
|
||||
|
||||
/// <summary>A library a game still has loaded from the install folder (beta.14) — this test's, never the real folder's.</summary>
|
||||
public string? PayloadHeld { get; set; }
|
||||
|
||||
public Harness(TimeSpan? agentStop = null)
|
||||
{
|
||||
Service = new UpdateService(Client, Agent, new RegisteredSettings(Store), Prompts, Shell, Strip, agentStop, () => AgentHeld);
|
||||
Service = new UpdateService(Client, Agent, new RegisteredSettings(Store), Prompts, Shell, Strip, agentStop, () => AgentHeld, () => PayloadHeld);
|
||||
Service.Available += (_, e) => Available.Add(e.Version);
|
||||
}
|
||||
}
|
||||
@@ -97,7 +101,7 @@ public sealed class UpdateServiceTests
|
||||
|
||||
await h.Service.CheckSilentlyAsync(Ct);
|
||||
|
||||
h.Client.Checks.Should().ContainSingle().Which.Should().BeFalse("the stable channel asks for no pre-releases");
|
||||
h.Client.Checks.Should().ContainSingle().Which.Should().BeFalse("the automatic channel on a release copy (0.1.0) asks for no pre-releases");
|
||||
h.Service.Stage.Should().Be(UpdateStage.Idle);
|
||||
h.Prompts.Offered.Should().BeEmpty();
|
||||
h.Prompts.UpToDate.Should().BeEmpty("silent means silent");
|
||||
@@ -120,6 +124,106 @@ public sealed class UpdateServiceTests
|
||||
h.Prompts.Offered.Should().BeEmpty("the startup check never asks; the banner offers the restart");
|
||||
}
|
||||
|
||||
/// <summary>D47 (beta.14): with no choice stored, a pre-release copy asks for pre-releases — the stable default found none.</summary>
|
||||
[Fact]
|
||||
public async Task APrereleaseCopyWithNoChoiceAsksForPrereleases()
|
||||
{
|
||||
var h = new Harness();
|
||||
h.Client.CurrentVersion = "0.1.0-beta.13";
|
||||
|
||||
await h.Service.CheckSilentlyAsync(Ct);
|
||||
|
||||
h.Client.Checks.Should().ContainSingle().Which.Should().BeTrue("every release so far is a GitHub pre-release");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task AnExplicitStableChoiceWinsOnAPrereleaseCopy()
|
||||
{
|
||||
var h = new Harness();
|
||||
h.Client.CurrentVersion = "0.1.0-beta.13";
|
||||
h.Store.Rows[SettingsRegistry.UpdateChannel.Key] = "stable";
|
||||
|
||||
await h.Service.CheckSilentlyAsync(Ct);
|
||||
|
||||
h.Client.Checks.Should().ContainSingle().Which.Should().BeFalse("the user chose stable");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// beta.14: Velopack applied a package an earlier run had downloaded at the next start, before FR-12 or the Agent's stop.
|
||||
/// With that switched off the App offers it — Ready at once, no feed request — and applies it the usual way.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task APackageDownloadedBeforeARestartIsReadyWithoutAFeedRequest()
|
||||
{
|
||||
var h = new Harness();
|
||||
h.Agent.IsConnected = false;
|
||||
h.Client.Pending = Candidate();
|
||||
|
||||
h.Service.AdoptPending();
|
||||
await h.Service.CheckSilentlyAsync(Ct);
|
||||
|
||||
h.Service.Stage.Should().Be(UpdateStage.Ready);
|
||||
h.Service.Version.Should().Be("0.2.0");
|
||||
h.Client.Checks.Should().BeEmpty("the startup check has nothing to do while a package waits");
|
||||
|
||||
await h.Service.RestartToUpdateAsync(Ct);
|
||||
|
||||
h.Client.Applied.Should().Equal("0.2.0");
|
||||
h.Shell.Quits.Should().Be(1);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void APendingPackageWhileASessionRunsIsDeferred()
|
||||
{
|
||||
var h = new Harness();
|
||||
h.Agent.Status = Status("capturing", 1);
|
||||
h.Agent.RaiseChanged();
|
||||
h.Client.Pending = Candidate();
|
||||
|
||||
h.Service.AdoptPending();
|
||||
|
||||
h.Service.Stage.Should().Be(UpdateStage.Deferred, "FR-12 holds for a package an earlier run downloaded, as for any other");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// beta.14: a game measured earlier can still have the Overlay loaded from the install folder; the updater would fail half
|
||||
/// way after the App had quit. The apply waits, says why, and leaves the Agent running.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public async Task AGameThatStillHasTheOverlayMappedKeepsTheUpdateReadyAndSaysWhy()
|
||||
{
|
||||
var h = new Harness { PayloadHeld = "FrameLedger.Overlay.dll" };
|
||||
h.Client.Next = Candidate();
|
||||
await h.Service.CheckSilentlyAsync(Ct);
|
||||
|
||||
await h.Service.RestartToUpdateAsync(Ct);
|
||||
|
||||
h.Client.Applied.Should().BeEmpty();
|
||||
h.Agent.Sent.Should().BeEmpty("the Agent is not stopped for an update that cannot run");
|
||||
h.Agent.Holds.Should().BeEmpty();
|
||||
h.Shell.Quits.Should().Be(0);
|
||||
h.Service.Stage.Should().Be(UpdateStage.Ready);
|
||||
h.Strip.Shown.Should().ContainSingle().Which.Body.Should().Be(string.Format(System.Globalization.CultureInfo.CurrentCulture, Strings.Update_PayloadInUse_Format, "FrameLedger.Overlay.dll"));
|
||||
}
|
||||
|
||||
/// <summary>beta.14: an Agent started by the logon task waits on the administrator prompt holding only its marker — and is not updated under.</summary>
|
||||
[Fact]
|
||||
public void AnAgentWaitingOnTheAdministratorPromptHoldsTheFolder()
|
||||
{
|
||||
string folder = System.IO.Path.Combine(System.IO.Path.GetTempPath(), "fl-elevating-" + Guid.NewGuid().ToString("N"));
|
||||
UpdateService.AgentHolds(folder).Should().BeFalse();
|
||||
using (Infrastructure.Startup.ElevationMarker.TryAcquire(folder) ?? throw new InvalidOperationException("the marker could not be taken"))
|
||||
{
|
||||
UpdateService.AgentHolds(folder).Should().BeTrue("the marker is the Agent's until its lock exists");
|
||||
}
|
||||
|
||||
UpdateService.AgentHolds(folder).Should().BeFalse();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void TheStopBudgetOutlastsTheAgentsOwnShutdownGrace() =>
|
||||
UpdateService.DefaultAgentStopTimeout.Should().BeGreaterThan(IpcProtocol.AgentShutdownGrace, "the App waited 10 s for an Agent whose host gives its sessions 15 to finalize");
|
||||
|
||||
[Fact]
|
||||
public async Task TheBetaChannelAsksForPrereleases()
|
||||
{
|
||||
@@ -316,6 +420,8 @@ public sealed class UpdateServiceTests
|
||||
|
||||
public string? CurrentVersion => "0.1.0";
|
||||
|
||||
public UpdateCandidate? FindPendingRestart() => null;
|
||||
|
||||
public Task<UpdateCandidate?> CheckAsync(bool includePrereleases, CancellationToken ct = default) =>
|
||||
Task.FromException<UpdateCandidate?>(new InvalidOperationException("not wrapped"));
|
||||
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Reflection;
|
||||
using FluentAssertions;
|
||||
using FrameLedger.App.Update;
|
||||
using Velopack;
|
||||
|
||||
namespace FrameLedger.App.Tests.Update;
|
||||
|
||||
/// <summary>
|
||||
/// beta.14 (the update audit): what <see cref="VelopackHooks.Configure"/> hands Velopack. Read through Velopack 1.2.0's private
|
||||
/// fields, because the builder exposes no getters — pinned to that version (<c>Directory.Packages.props</c>): an upgrade that
|
||||
/// renames them turns this red rather than letting the apply-at-start come back unseen.
|
||||
/// </summary>
|
||||
public sealed class VelopackHooksTests
|
||||
{
|
||||
private static object? Field(VelopackApp app, string name) =>
|
||||
typeof(VelopackApp).GetField(name, BindingFlags.Instance | BindingFlags.NonPublic)?.GetValue(app)
|
||||
?? throw new InvalidOperationException($"VelopackApp.{name} is gone: re-read the pinned version's builder");
|
||||
|
||||
[Fact]
|
||||
public void ADownloadedUpdateIsNeverAppliedAtStartBehindTheAppsBack()
|
||||
{
|
||||
VelopackApp app = VelopackHooks.Configure(VelopackApp.Build());
|
||||
|
||||
Field(app, "_autoApply").Should().Be(false, "Velopack applied a downloaded package at the next start, before FR-12 or the Agent's stop could run");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void VelopacksDiagnosticsGoToTheAppsLogAndTheAgentIsAskedToStopBeforeAnUpdate()
|
||||
{
|
||||
VelopackApp app = VelopackHooks.Configure(VelopackApp.Build());
|
||||
|
||||
Field(app, "_customLogger").Should().BeOfType<VelopackSerilogLogger>();
|
||||
Field(app, "_obsolete").Should().NotBeNull("OnBeforeUpdateFastCallback stops the Agent before Velopack replaces the version");
|
||||
Field(app, "_uninstall").Should().NotBeNull();
|
||||
Field(app, "_restarted").Should().NotBeNull();
|
||||
}
|
||||
}
|
||||
@@ -24,6 +24,17 @@ public sealed class SettingsRegistryTests
|
||||
}
|
||||
|
||||
/// <summary>D33: the exception option is off unless the user turns it on — and exactly "1" is on.</summary>
|
||||
[Fact]
|
||||
public void TheUpdateChannelFollowsTheRunningCopyUnlessTheUserChose()
|
||||
{
|
||||
// D47 (beta.14): stable by default found no release while every release is a pre-release.
|
||||
SettingDefinition d = SettingsRegistry.UpdateChannel;
|
||||
d.Default.Should().Be("auto");
|
||||
d.Choices.Should().Equal("auto", "stable", "beta");
|
||||
d.Validate("stable").Should().BeNull("a choice stored before beta.14 stays valid");
|
||||
d.AgentReads.Should().BeFalse();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void HidingScrollBarsIsOffByDefaultAndTheAgentNeverReadsIt()
|
||||
{
|
||||
|
||||
Reference in new issue
Block a user