Compare commits

...
Author SHA1 Message Date
poli0981andClaude Opus 5.5 4bf511a378 docs: two descriptions of the artwork the code outgrew before it merged - a link is never followed, the band's colour is the cover's or else the banner's, and the checks for an image that draws nothing (beta.23 PR-4)
08_UI's note on the header's cover and 06_DATA_MODEL's cover_path comment said a chosen image's path is followed only when it is one of FrameLedger's names; since the last change to PR-3 it is also never followed through a junction or a symbolic link. 08_UI also named the band's colour the cover's (it is the banner's when there is no cover) and its test list lacked PagesLoadTests.TheGamePagesArtworkIsDrawn and AccessibilityTests.NoStyleOfAWpfUiControlLeavesOutItsTemplate.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-15 00:09:11 +07:00
poli0981andClaude Opus 5.5 a6c012ee09 docs: the first real Vulkan game in the tested list, and four places that described what was never built or a count gone stale (beta.23 PR-4)
The owner asked for the documents to be brought up to date (2026-10-14) and approved,
under D35, a row from the ledger for the Vulkan game the agent's log showed on 2026-10-13.

- LIST_GAME_TESTED: Everhex Demo (Steam 5128880) - Presented 239.7 FPS, 1 % low 213.5,
  14,955 frames in 69 s through FrameLedger's Vulkan layer, started by Play set to
  Start directly; the figures re-read from a copy of the database made with SQLite's
  online backup (12_BUILD section Debugging). Its "no real Vulkan or OpenGL game has
  been measured" is struck and corrected, and LIMITATIONS says the same in a user's words.
- 15_ROADMAP P5: "eleven pre-releases through 0.1.0-beta.11" went stale at the next
  release; it points at the CHANGELOG now instead of holding a count.
- 08_UI, Settings as specified: "Privacy: online-metadata opt-in" is struck - the card
  has not been shown since 2026-09-16 and the built section below says so.
- 05_DETECTION: the "(opt-in) Steam appdetails lookup, cached 7 days" was never built;
  FrameLedger makes no store request, and beta.23's artwork (D60) is read from disk.
- CLAUDE.md, the solution layout: FrameLedger.Injector/ also builds
  FrameLedger.Guard.dll, the guard's C ABI the Agent loads.

CHANGELOG [Unreleased] has one Changed entry.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-15 00:09:11 +07:00
poli0981andClaude Opus 5.5 fb0ee60fa0 feat(app): a game's page shows its artwork - your own image, else what the Steam or GOG GALAXY app keeps on this PC - in a band coloured from it (beta.23 PR-3) (#310)
The owner asked for a game's cover and hero art on its page, its colour optionally
carried into the page (2026-10-14), and chose: images already on the PC only, a banner
with a portrait cover, the colour on by default.

D60 - where the artwork comes from:
- The image the user chooses in Edit... > Choose image..., copied only once the dialog
  closed with Save (Cancel leaves nothing) as a PNG no larger than 1200 px a side, to
  the data folder's covers\game-<id>-<unix ms>.png - a new name for each choice, so a
  shown file is never written over - and named in games.cover_path relative to the data
  folder. A cover_path is followed only when it is one of those names, in that folder
  and never through a junction or a symbolic link: a viewer's copy of a ledger may come
  from anywhere, and a rooted, share (\\host\...) or .. path is never opened. "Use the
  store's image" deletes the copy, as removing a game with its sessions does; at start
  the App deletes the copies no row names (its own folder only, never a viewer's).
- Else what the store's app keeps: Steam's appcache\librarycache\<appid>\ (flat, or in
  hash-named folders - library_600x900[_2x], library_capsule, library_hero, header,
  library_header; the newest copy wins) and GOG GALAXY's webcache\<user>\gog\<id>\
  (WebP). Which store installed the game is asked of the stores' own records as Play
  asks (StoreRecords.Owning over Steam's and GOG's, kept two minutes), never of the
  row's platform alone; store ids are digits only. Epic's and itch's apps keep no image
  files.
- Found, decoded (no larger than the page needs, frozen, the twelve latest kept) and
  coloured on the thread pool: the page's text is there first. Nothing is downloaded; privacy.online_metadata
  stays reserved.

D61 - the band's colour: the artwork's dominant colour (a hue histogram of a 48 px copy,
greys and near-black or near-white skipped) over the card's fill, at the strongest
opacity - at most 30 % on the dark theme, 22 % on the light - at which every text the
header shows still reads: primary and secondary 4.5:1, tertiary 3:1, the pills' and the
warning's text 4.5:1 on their fills. Controls/ArtTint follows a theme switch through a
resource reference on the band (ApplicationThemeManager.Changed is raised by Apply
alone); no tint in high contrast; no text is ever drawn on a picture.

Settings > Games: "Show game artwork" (ui.game_art) and "Colour the game page from its
artwork" (ui.game_art_tint), both on. Strings in en, vi and ja (ja marked for review).

Caught in a render of the page before this commit: the cover's own Style was not based
on WPF UI's DefaultImageStyle, so the ui:Image had no template and drew nothing beside a
banner that drew. PagesLoadTests.TheGamePagesArtworkIsDrawn and
AccessibilityTests.NoStyleOfAWpfUiControlLeavesOutItsTemplate both ran red first;
16_WPFUI_SYNTAX's Gotchas list has it.

Docs: Privacy Policy 2.11 (section 1: the images you choose; section 4: the store apps'
images, and their records read when a game's page opens) with legal-drift-history,
TRADEMARKS, THIRD_PARTY_NOTICES, LIMITATIONS (Game artwork), 08_UI, 16_WPFUI_SYNTAX,
06_DATA_MODEL, 01_ARCHITECTURE, 02_SPEC FR-1.3, 05_DETECTION, 12_BUILD,
20_OPEN_QUESTIONS (Cover art closed), guide 05/07/08, wiki App-UI-development, CHANGELOG.

Tests: StoreArtCachesTests (both Steam layouts, the better cover and the newest copy,
ids of another shape, nothing there, several GOG users), ColorMathTests (agrees with the
tests' own WCAG; the hardest colours keep every pair readable in both themes),
GameArtTests (source order, a missing own image, the D59 owning rule, off in Settings
reads nothing, a cover_path not ours, a damaged file, records read once),
CoverStoreTests (a new name each choice, a non-image leaves nothing, tidying keeps a
removed row's image, deleting follows our names only, a covers junction is never
followed), EditGameViewModelTests, GameDetailViewModelTests, PagesLoadTests (the band
readable in both themes and through a switch; the edit dialog's image row; the artwork
drawn).
Local gate: ALL GATES PASSED in 282 s; the artwork classes 20 times green.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-15 00:08:58 +07:00
poli0981andClaude Opus 5.5 fb313ebca6 perf(app): a game's page opens and changes session without freezing the window; a Dashboard or Logs visit no longer stays in memory (beta.23 PR-2) (#309)
The owner asked whether switching pages and tabs is slow (2026-10-14). Measured before
changing anything, with a pre-committed bar - fix what keeps the UI thread busy 50 ms or
more, can block on I/O, or grows with each visit - over the App's own pages in a real
window, Release, a ledger shaped like the owner's (docs/spike-notes.md section 21):

- Open a game with 100 sessions: 1,175-1,507 ms -> 369 ms. The Sessions grid sat in the
  page's own scroller with no height limit and built every row (17 columns each); it is
  bounded now (MaxHeight 520, as Compare's list is), builds the rows on screen, scrolls
  itself and hands the wheel to the page at its ends.
- Choose a 2,000,000-frame session: 843-1,016 ms freeze -> 17 ms. Microsoft.Data.Sqlite
  completes its async calls synchronously, so the blob read, the decode and the stutter
  detection ran on the UI thread whatever ConfigureAwait said; then the Distribution tab
  sorted every frame three times. SessionSeriesLoader reads and decodes on the thread
  pool, and Charts.SeriesDigest works out once, there, what the charts need from the
  whole session (one sort shared by the histogram, the percentile curve and its lows;
  the gap count; the presents line). The charts' public entry points are unchanged and
  compute for themselves on a series without a digest.
- A session ends after 20 Dashboard visits: 20 notices and 20 reloads -> one of each.
  DashboardViewModel and LogsViewModel were IDisposable transients the root container
  kept until exit; every Dashboard stayed subscribed. The Dashboard attaches on Loaded
  and detaches on Unloaded; neither is IDisposable; FR-3.8's in-App notice moves to
  Services.SessionNotices, one subscription for the App's life (it reached other pages
  only through the leak), kept by AgentConnectionHostedService like LiveSessions.

Also: the game page asks whether the .exe is on disk off the UI thread and no longer
reads a drive from a property getter; GameLibrary.LoadAsync stops summarising every
game's sessions for a field nothing read (GameDetail.Summary removed); the Logs tick
reads nothing when the newest file is unchanged and filters off the UI thread; Play
reads the stores' records on the thread pool (Services.StoreRecordsReader, which PR-3's
artwork reuses); at Debug the App logs how long each page took to appear.

Recorded, not fixed (spike-notes section 21): page builds of 600-2,500 visuals still cost
85-370 ms, and the library grid (275 ms at 48 games) is non-virtualizing by the beta.11
decision - a virtualizing one changes the page's look, the owner's call.

Docs: 08_UI (the game page's costs; FR-3.8's snackbar corrected in place), 16_WPFUI_SYNTAX
Gotchas (synchronous SQLite; no IDisposable transient view models), wiki
App-UI-development, spike-notes section 21, CHANGELOG.

Tests: SeriesDigestTests (sorted forms equal the charts' own; the digest of a decoded
series; the read happens off the caller's thread), DashboardViewModelTests (an
off-screen Dashboard hears nothing, one notice per session, a hidden window leaves the
notice to the tray), GameDetailViewModelTests (the executable is looked for off the
opener's thread), LogsViewModelTests (a tick re-reads only a changed file),
PagesLoadTests (the Sessions grid builds the rows on screen and hands the wheel on).
Local gate: ALL GATES PASSED in 355 s.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 23:24:36 +07:00
poli0981andClaude Opus 5.5 2982679fc1 test(native): the ring's concurrency cases guard on drains that overlapped the writer, repeated until one attempt did - not on a share of the stream (beta.23 PR-1) (#308)
The owner (2026-10-13, after beta.22): "Tất cả các item đã đạt yêu cầu. Bạn
có thể xử lý chip, phiên bản mới (nếu cần), cập nhật, rồi đóng phiên nhé" -
every owner-only item passed; take the chip beta.22's local gate left.

The chip: ring_test.cpp's "SPSC under a hammering writer" made a full local
gate red on a tree that touched no native code. Its anti-vacuity guard,
CHECK(accepted > kTotal / 2), failed 5 of 40 runs and then 5 of 200 of
fl_ring_test.exe on the owner's hybrid i7-14700KF - accepted 1024, 6747,
21370, 45028, 61596 - with CHECK_FALSE(mixed) clean every time. A share of
the stream measures the scheduler: a reader on an efficiency core keeps less
than half, and one the OS does not run until the writer is done keeps one
lap. docs/HANDOFF.md's trap already said to read which assertion fired.

Measured on the way, which is why it is not one line:
- a start barrier alone (the writer starts once the reader is about to loop)
  left 1 of 200: a reader the OS did not run while the writer wrote - one
  overlapping drain, accepted 2048. No single run can rule that out.
- the tiny ring's guard, CHECK(dropped > 0), passed a reader made to wait for
  the writer to finish (1.6 million drops over eight attempts): it could not
  tell a run without overlap from one with it.

Both cases now: the start barrier; a count of the drains that copied records
while the writer was still writing; and the run repeated - every attempt
checked for its properties (mixed, poisonAccepted) - until one attempt made
100 such drains, at most 8 times; the guard is that count. The tiny ring also
keeps dropped > 0, for the attempt that overlapped (the last), no longer a sum
a vacuous attempt could fill. The property checks are unchanged.

Measured: 1,000 runs, no failure, at most 3 attempts, the best attempt at
least 122 overlapping drains (median 146,981); a reader made to wait for the
writer fails both guards in every run (most overlapped drains 0 after 8
attempts). clang-format clean.

Docs: HANDOFF's native-test trap amended (both guards, the rates, the fix);
owner-only items 16, 17 and 18 struck as passed; beta.22's section says what
followed the release. CHANGELOG [Unreleased], developers only. No release:
nothing a user runs changed.

Gate: ./build.ps1 ALL GATES PASSED (309 s). The owner's live rules files were
pre-seeded and restored byte for byte.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 23:36:42 +07:00
poli0981andClaude Opus 5.5 76e89b65de release: 0.1.0-beta.22 - the CHANGELOG section, release lines, HANDOFF's beta.22 section and owner-only item 18 (beta.22 PR-2) (#307)
VERSION stays 0.1.0: the tag's numeric core. The owner (2026-10-13, during
the beta.21 train): "Bạn xử lý chip thành 1 pr mới sau release và thành 1
phiên bản mới nhé" - the chip from beta.21's review of Play as its own PR
(#306) and its own pre-release.

- CHANGELOG: [Unreleased] becomes [0.1.0-beta.22] - 2026-10-13, with its
  summary and "Updating from 0.1.0-beta.21" (nothing to accept and no game
  read again: the legal documents and rules 2026.10.4 are beta.21's);
  tools/release-notes.ps1 -Version 0.1.0-beta.22 extracts it (1,161
  characters).
- The accuracy block's release line (legal/ACCURACY.md, embedded in README
  and the Disclaimer; its date stays 2026-10-13, nothing in it changed),
  README's release lines and count ("Twenty-two"), LIMITATIONS' version.
- HANDOFF: beta.21's START HERE struck; the beta.22 section - the owner's
  words, no new decision, the traps (VSTHRD003 and a Func<Task<T>>;
  ObjectDisposedException is an InvalidOperationException); owner-only item
  18 (the ja string; nothing else a person can run on purpose).

Gates run locally on this tree: accuracy-check, wiki-check (27 pages),
notice-check, release-notes. The code is #306's, whose tree passed
./build.ps1 (291 s) and CI.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 21:58:43 +07:00
poli0981andClaude Opus 5.5 712146685f fix(app): a request the capture agent never answered is said in words and the page reads what is stored - never a crash dialog or an exception's name (beta.22 PR-1) (#306)
The owner (2026-10-13, during beta.21): "make the chip a new PR after the
release, and a new version". The chip came from beta.21's review of Play
(#304): when the pipe closes, PipeClient fails a request in flight with what
ended its reader - an IOException, an IpcFramingException or an
ObjectDisposedException - and a client AgentConnection disposed between its
check and the write throws the last.

What each caller did, read in the code:
- SessionDeletion caught no IOException: deleting sessions while the agent
  stopped or restarted for an update ended in the App's crash dialog (an
  exception out of a command); a timeout showed its own message.
- HookingConsent and AntiCheatExceptions caught IOException and
  TimeoutException as Failed with the exception's type name as the detail:
  the game page's notice read "IOException".
- Every caller missed IpcFramingException and ObjectDisposedException.
- GamePlayer (beta.21) caught them all and said "the agent is not running",
  which is untrue when the launch may have run.

Changes:
- AgentConnection.RequestAsync answers through AnsweredAsync: an
  IpcFramingException or ObjectDisposedException becomes ONE IOException
  ("the connection to the Agent closed before it answered", the original as
  its inner exception). IAgentRequests names the four ways a request fails.
  RefreshStatusAsync also catches IpcFramingException.
- AgentAnswers.IsUnanswered (IOException or TimeoutException): whether the
  request was carried out is not known.
- SessionDeletion, HookingConsent, AntiCheatExceptions and GamePlayer tell
  the three apart: InvalidOperationException = not connected, nothing was
  sent (AgentUnavailable, in their existing words); unanswered = a new
  Unanswered outcome, said with one new string, Agent_Unanswered (en/vi/ja,
  ja marked review); IpcRequestException as before. An unanswered delete
  also lets go of what named a deleted session (it may have run), and an
  ack without its counts is unanswered too. The game page reads what is
  stored after an unanswered delete, and Settings re-reads its hooked games
  after an unanswered revoke; the consent and exception paths already
  re-read the page.
- 07_IPC section Client behavior; CHANGELOG.

Tests: AgentConnectionTests.EveryWayThePipeClosesUnderARequestIsOneIOException;
SessionDeletionAndOverviewTests.ADeleteTheAgentNeverAnsweredIsSaidAsNotKnownAndThePageReadsWhatIsStored
(a delete that ran and lost its answer: the page empties and the selection
lets go); HookingConsentTests.AnAskTheAgentNeverAnsweredIsNotKnownAndOneNeverSentIsNoAgent;
AntiCheatExceptionsTests.AnAskTheAgentNeverAnsweredIsNotKnownAndSaidInWords;
GamePlayerTests.AnAnswerThatNeverCameIsNotKnownAndARequestNeverSentIsNotRunning
(replaces beta.21's "not running").

Gate: ./build.ps1 ALL GATES PASSED (291 s); App 619. The owner's live rules
files were pre-seeded and restored byte for byte.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 21:43:02 +07:00
poli0981andClaude Opus 5.5 86dffa660f release: 0.1.0-beta.21 - the CHANGELOG section, release lines, HANDOFF's beta.21 section with D57-D59 and owner-only item 17, the Wuthering Waves row of LIST_GAME_TESTED (beta.21 PR-5) (#305)
VERSION stays 0.1.0: the tag's numeric core. The owner (2026-10-13), with the
plan: "Làm trọn mạch ngay" - commit, push, CI, auto-fix, merge, bump the
version and release in one go. The release carries #301 (check 4 also walks
the executable's folder; Wuthering Waves on the title list; rules 2026.10.4),
#302 (the four itch "launchers" are malware - the docs corrected, D57; the
Supports card), #303 (the documents' wheel; one render per page) and #304
(Play, D59; Privacy Policy 2.10).

- CHANGELOG: [Unreleased] becomes [0.1.0-beta.21] - 2026-10-13, with its
  summary and "Updating from 0.1.0-beta.20" (Privacy 2.10 shown once; every
  game read and checked for anti-cheat once more under rules 2026.10.4, and
  Wuthering Waves and any game with an anti-cheat beside its executable turned
  off; the four itch downloads pointed at Security); the subsections in Keep a
  Changelog's order (Added, Changed, Fixed, Security); #302's Supports card
  fix, which had no entry, added under Fixed. tools/release-notes.ps1 -Version
  0.1.0-beta.21 extracts it (5,147 characters).
- The accuracy block (legal/ACCURACY.md, embedded in README and the
  Disclaimer): its date moves to 2026-10-13 - #304 changed its Vulkan
  sentence, and the block asks to be dated when it changes - and its release
  line; README's release lines and count ("Twenty-one"); LIMITATIONS' version.
- HANDOFF: beta.20's START HERE struck; the beta.21 section - the owner's
  list, D57-D59, the train, the traps (the pre-scan's depth limit is a reach
  and not a refusal; a long rules note fails rules-validate with a message
  about something else; the owner's older live rules make parallel test hosts
  race; WPF's fixed 48 DIP wheel step; the review of Play after green gates
  that found four defects, fixed in #304, and SessionDeletion's same gap,
  which the owner asked for as its own PR and beta.22; the analyzers met); owner-only item 17
  (Wuthering Waves blocked before any session, NTE and GF2's exception
  unchanged; Play in both modes with a Steam, an Epic, a GOG and an itch game,
  never elevated; the wheel and a touchpad; Privacy 2.10 once; the ja strings).
- docs/LIST_GAME_TESTED.md: the Wuthering Waves row in the anti-cheat table -
  hooked 37 s on 2026-10-12 before the 30 s re-check met ACE's driver, refused
  before any injection since beta.21 - marked as added 2026-10-13 from the
  agent's log (approved with the plan, D35).

Gates run locally on this tree: accuracy-check (self-test and live),
notice-check, wiki-check (self-test and 27 pages), changelog-check and
release-notes (self-tests), release-notes -Version 0.1.0-beta.21. The code is
#304's, whose tree passed ./build.ps1 (292 s) and CI.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 21:24:12 +07:00
108 changed files with 4279 additions and 344 deletions

No files matched your search

+85 -11
View File
@@ -30,6 +30,77 @@ numeric core and does not move; the heading is the full version — corrected 20
### Added
- **A game's page shows its artwork** (owner request 2026-10-14, decisions D60/D61). At the top of the page: the
banner and the cover the Steam or GOG GALAXY app already keeps on your PC for the game it installed — read where that
app keeps them, never downloaded and never copied — or an image you choose yourself in **Edit… ▸ Choose image…** (a
copy is kept in the data folder's `covers` folder; **Use the store's image** goes back). The band they sit in takes the
picture's main colour, never so strongly that a text on it gets hard to read (primary and secondary text keep 4.5:1,
the faintest 3:1, in both themes), and follows a theme switch. A game from itch, the Epic Games Launcher or another
store has a picture only once you choose one, because those apps keep no image files. **Settings ▸ Games** has *Show
game artwork* and *Colour the game page from its artwork*, both on. **Privacy Policy 2.11** names the images read and
the copies kept; FrameLedger still makes no request to any store.
### Changed
- **The list of tested games has its first Vulkan game**: Everhex Demo, measured through FrameLedger's Vulkan layer on
2026-10-13 when Play started it directly (`docs/LIST_GAME_TESTED.md`, `LIMITATIONS.md`). Four places in the developer
documents that described something never built, or kept a count that went stale, are corrected in place.
### Fixed
- **A game's page opens and changes session without freezing the window** (owner request 2026-10-14). Measured on the
dev PC over a ledger shaped like the owner's (`docs/spike-notes.md` §21): a game with 100 sessions took 1.2–1.5 s to
open — its Sessions list built every row, now only the rows on screen (it scrolls itself and hands the wheel to the
page at its ends) — 0.37 s now; choosing a two-million-frame session froze the window 0.8–1.0 s — the session was read
and decoded on the UI thread, then sorted three times for the Distribution tab — 17 ms now: it is read on the thread
pool and what the charts need from all of it is worked out there once. The page also asks whether the game's `.exe` is
on disk off the UI thread (a USB drive that sleeps answered on it), and no longer summarises every game to show one.
- **Each visit to the Dashboard or Logs no longer stays in memory.** Every Dashboard ever opened stayed alive and kept
listening to the capture agent, so at each session's end each one reloaded its lists and raised its own "Session
saved" notice — twenty visits, twenty notices, the last one shown. The Dashboard listens only while it is on screen,
and the notice has one home for the App's life, shown once whichever page is open; each Logs page kept its tail of up
to 2 MB, twice.
- **The Logs page reads its file only when it changed**, not every two seconds, and filters it off the UI thread; **Play**
reads the stores' lists of installed games off the UI thread (Steam's manifests sit on whatever drive its libraries
are on). At Debug level the App now logs how long each page took to appear (`ui: page … shown … ms`).
- **The native ring-buffer tests no longer pass or fail by the scheduler's luck** (developers only). The
hammering-writer test required the reader to keep more than half of the stream, which measured how the operating
system scheduled two threads: on a hybrid Intel processor it failed 5 of 200 runs with the ring correct every time.
Both concurrency tests now start the writer only once the reader is running, repeat until the reader really read
the ring while the writer wrote it, and require that; the small-ring test's old check also passed a reader that
started after the writer had finished (`src/native/tests/ring_test.cpp`).
## [0.1.0-beta.22] - 2026-10-13
**The twenty-second pre-release: a request the capture agent never answered is said as such, never as a crash.** The
same unsigned installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
**Updating from `0.1.0-beta.21`:** Help ▸ Check for updates, then *Restart to update* with no game running. Nothing is
shown to accept and no game is read again: the legal documents and the detection rules (`2026.10.4`) are beta.21's.
### Fixed
- **A request the capture agent never answered is said as such, never as a crash.** When the agent stopped, or restarted
for an update, while FrameLedger was asking it something, deleting sessions ended in the crash dialog, and turning a
game's hooking on or off or making or withdrawing an anti-cheat exception showed *IOException* or *TimeoutException* as
its notice. Each now says that the agent did not answer and that whether it was done is not known, and the page shows
what is stored; Play says the same (it said the agent was not running). A request that could not be sent because the
agent was already gone still says that nothing was changed (`docs/07_IPC.md` §Client behavior).
## [0.1.0-beta.21] - 2026-10-13
**The twenty-first pre-release: an anti-cheat kept beside a game's executable found before anything is injected, four
itch.io downloads that carry malware, documents that scroll further and smoothly, and Play.** The same unsigned
installer: verify its hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
**Updating from `0.1.0-beta.20`:** Help ▸ Check for updates, then *Restart to update* with no game running. The Privacy
Policy (2.10) is shown once for you to accept. Every game is read and checked for anti-cheat once more (detection rules
`2026.10.4`): Wuthering Waves, and any game that keeps an anti-cheat beside its executable, has its hooking turned off.
If you installed HELLO, HELLO WORLD!, A Doll's Locket - Remake, City of Bones or Träumerei Chapter 2 from itch.io, read
*Security* below first.
### Added
- **Play, on a game's page and on each game in the library.** Through the store that installed the game — Steam or the
Epic Games Launcher starts it, GOG GALAXY runs it, the itch app asks which copy to launch — or started directly by
FrameLedger, recorded from its first frame: **Settings ▸ Games ▸ Play button** switches between the two. A game no
@@ -52,17 +123,6 @@ numeric core and does not move; the heading is the full version — corrected 20
notes the wheel scrolls the window instead; Ctrl+wheel still zooms. A page is drawn once when it is opened, not two or
three times, and going back to a page you have read in the same window is immediate.
### Security
- **Four itch.io downloads this project's documentation used as examples carry malware.** HELLO, HELLO WORLD!, A Doll's
Locket - Remake, City of Bones and Träumerei Chapter 2 put the same 213 MB program in front of their RPG Maker game.
Read without running it, it ships a registry file that switches off Windows' script scanning (AMSI) and adds
Microsoft Defender exclusions, carries an encrypted payload, and checks for virtual machines and debuggers before it
starts the game. The documentation called it a launcher and, for A Doll's Locket, said to measure it with the agent
running as administrator: that advice is withdrawn. If you installed one of them, remove it and scan your PC.
FrameLedger itself does not change: it reads a game's files to find its engine and anti-cheat, and does not judge
whether a game is safe (`docs/spike-notes.md` §20).
### Fixed
- **An anti-cheat kept beside a game's executable is found before anything is injected.** The safety check looked three folder
@@ -74,6 +134,20 @@ numeric core and does not move; the heading is the full version — corrected 20
Steam id (owner decision D58), and ACE's files, its second driver, its driver's service and its module are named (detection
rules `2026.10.4`). Every game is checked for anti-cheat once more after the update; one found this way has its hooking
turned off, as any finding does (`docs/19_SAFETY_AND_ANTICHEAT.md` §Pre-injection checks, item 4).
- **A game's Supports card said *Not scanned yet* for a game the agent had read** whenever the game ships none of the
upscaler, frame-generation or Vulkan files the rules name — beside a Details card the same read had filled. It says
so now only until the agent has read the game, then *None found*.
### Security
- **Four itch.io downloads this project's documentation used as examples carry malware.** HELLO, HELLO WORLD!, A Doll's
Locket - Remake, City of Bones and Träumerei Chapter 2 put the same 213 MB program in front of their RPG Maker game.
Read without running it, it ships a registry file that switches off Windows' script scanning (AMSI) and adds
Microsoft Defender exclusions, carries an encrypted payload, and checks for virtual machines and debuggers before it
starts the game. The documentation called it a launcher and, for A Doll's Locket, said to measure it with the agent
running as administrator: that advice is withdrawn. If you installed one of them, remove it and scan your PC.
FrameLedger itself does not change: it reads a game's files to find its engine and anti-cheat, and does not judge
whether a game is safe (`docs/spike-notes.md` §20).
## [0.1.0-beta.20] - 2026-10-12
+2 -1
View File
@@ -70,7 +70,8 @@ build.ps1 # the quality gate; CI runs this identical script
src/
native/
FrameLedger.Overlay/ # C++20 DLL injected into the game (hooks + ring writer + optional overlay)
FrameLedger.Injector/ # C++20 static lib: launch/attach injection, AC guard probe
FrameLedger.Injector/ # C++20 static lib: launch/attach injection, AC guard probe; also builds
# FrameLedger.Guard.dll, the guard's C ABI the Agent loads (line added 2026-10-14)
FrameLedger.VkLayer/ # C++20 Vulkan implicit layer DLL + manifest JSON
FrameLedger.Shm/ # header-only: ring buffer + record layout, shared by native & C# (mirrored)
FrameLedger.NvapiBridge/ # C++ DLL loaded by the Agent (never a game): NVAPI telemetry, NGX state (P2 PR-E2)
+12 -2
View File
@@ -5,7 +5,7 @@ hooking on for — and reading the graphics calls the game makes. That is why it
resolution, the upscaler, frame generation and ray tracing apart. It is also where its limits come from. This
page lists them in plain words; each item links to the document that has the details.
*Beta software: this page describes version 0.1.0-beta.20.*
*Beta software: this page describes version 0.1.0-beta.22.*
## Games it will not measure
@@ -162,7 +162,8 @@ you accept the prompt. Turn it on only if you trust everything that runs under y
- The games FrameLedger has actually been run with, and what was measured on each, are listed in
[LIST_GAME_TESTED.md](docs/LIST_GAME_TESTED.md). Everything was measured on one machine (an NVIDIA
GeForce RTX 5080 with an Intel Core i7-14700KF on Windows 11); other hardware is untested.
- **No real Vulkan or OpenGL game has been measured yet** — only FrameLedger's own test program.
- **One real Vulkan game has been measured** (Everhex Demo, 2026-10-13) **and no OpenGL game**, beyond FrameLedger's
own test program.
- There is **no in-game overlay**; everything is shown in the FrameLedger window.
- **FrameLedger does not tell whether a game is safe to run.** It reads a game's files to find its engine and its
anti-cheat, never to judge it, and recording or measuring a game vouches for nothing. Four itch.io downloads this
@@ -177,6 +178,15 @@ you accept the prompt. Turn it on only if you trust everything that runs under y
that one from its store or its own shortcut — nor a game whose recording is off: FrameLedger starts only what it
records. While FrameLedger itself runs as administrator, Play starts every game directly, with your standard rights.
## Game artwork
- **Only the Steam and GOG GALAXY apps keep pictures FrameLedger can show** (since 0.1.0-beta.23). A game's page shows
the cover and banner those apps keep on your PC for a game they installed, read where they keep them — nothing is
downloaded or copied. A game from itch, the Epic Games Launcher or another store, or one whose `.exe` is outside a
store's own folder, shows a picture only once you choose one (**Edit… ▸ Choose image…**). A GOG picture needs Windows'
WebP support, which Windows 11 and most Windows 10 installs have. ([Game page](docs/08_UI.md))
- The pictures belong to the games' owners; FrameLedger ships none ([names and trademarks](legal/TRADEMARKS.md)).
## Your data
- Everything stays on your computer (`%LOCALAPPDATA%\FrameLedger`). FrameLedger sends no telemetry; its only
+4 -4
View File
@@ -11,8 +11,8 @@ guide, Help ▸ Limitations), and on the project's [wiki](https://github.com/pol
pages.
<!-- accuracy-block:begin -->
> ⚠ **What FrameLedger actually measures today — 2026-10-06.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.20`** (2026-10-12), an unsigned installer built from that tag with its
> ⚠ **What FrameLedger actually measures today — 2026-10-13.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.22`** (2026-10-13), an unsigned installer built from that tag with its
> checksums published beside it. The source holds the desktop app
> (library, store import, charts, settings) and the background Agent, which records a session when a
> game in the library runs (unless you switched its recording off), injects only into games you enabled
@@ -167,7 +167,7 @@ Elevation is **optional — for everything.** Hooked capture is the normal path
## Install
> **The latest pre-release is `v0.1.0-beta.20` (2026-10-12); before it `v0.1.0-beta.19` (2026-10-12), `v0.1.0-beta.18` (2026-10-07), `v0.1.0-beta.17` (2026-10-07), `v0.1.0-beta.16` (2026-10-06), `v0.1.0-beta.15` (2026-10-06), `v0.1.0-beta.14` (2026-10-06), `v0.1.0-beta.13` (2026-10-04), `v0.1.0-beta.12` (2026-10-04), `v0.1.0-beta.11` (2026-10-03), `v0.1.0-beta.10` (2026-09-28), `v0.1.0-beta.9` (2026-09-26), `v0.1.0-beta.8` (2026-09-25), `v0.1.0-beta.7` (2026-09-23), `v0.1.0-beta.6` (2026-09-23), `v0.1.0-beta.5` (2026-09-22), `v0.1.0-beta.4` (2026-09-21), `v0.1.0-beta.3` (2026-09-21), `v0.1.0-beta.2` (2026-09-17) and `v0.1.0-beta.1` (2026-09-16).** They are pre-releases: read `CHANGELOG.md`'s section for the one you install — what it measures, what it does not yet, and how to update — before installing. A source build is `docs/12_BUILD.md`.
> **The latest pre-release is `v0.1.0-beta.22` (2026-10-13); before it `v0.1.0-beta.21` (2026-10-13), `v0.1.0-beta.20` (2026-10-12), `v0.1.0-beta.19` (2026-10-12), `v0.1.0-beta.18` (2026-10-07), `v0.1.0-beta.17` (2026-10-07), `v0.1.0-beta.16` (2026-10-06), `v0.1.0-beta.15` (2026-10-06), `v0.1.0-beta.14` (2026-10-06), `v0.1.0-beta.13` (2026-10-04), `v0.1.0-beta.12` (2026-10-04), `v0.1.0-beta.11` (2026-10-03), `v0.1.0-beta.10` (2026-09-28), `v0.1.0-beta.9` (2026-09-26), `v0.1.0-beta.8` (2026-09-25), `v0.1.0-beta.7` (2026-09-23), `v0.1.0-beta.6` (2026-09-23), `v0.1.0-beta.5` (2026-09-22), `v0.1.0-beta.4` (2026-09-21), `v0.1.0-beta.3` (2026-09-21), `v0.1.0-beta.2` (2026-09-17) and `v0.1.0-beta.1` (2026-09-16).** They are pre-releases: read `CHANGELOG.md`'s section for the one you install — what it measures, what it does not yet, and how to update — before installing. A source build is `docs/12_BUILD.md`.
1. Download the latest `FrameLedger.App-win-Setup.exe` from [Releases](https://github.com/poli0981/frameledger/releases). It installs into `%LOCALAPPDATA%\FrameLedger.App`; your data stays in `%LOCALAPPDATA%\FrameLedger`, and uninstalling asks before touching it.
2. SmartScreen may warn — releases are not code-signed (free, open-source project). Verify the SHA-256 checksum published with each release, then **More info → Run anyway**.
@@ -216,4 +216,4 @@ GPU telemetry is layered so the project never depends on a proprietary vendor li
---
**Status:** pre-release (beta). Twenty tagged pre-releases so far; see `CHANGELOG.md` for what each one changed and the accuracy block at the top of this file for what is and is not measured. It is not feature-complete, it certainly still has bugs, and `legal/DISCLAIMER.md` §0 says what that means for you.
**Status:** pre-release (beta). Twenty-two tagged pre-releases so far; see `CHANGELOG.md` for what each one changed and the accuracy block at the top of this file for what is and is not measured. It is not feature-complete, it certainly still has bugs, and `legal/DISCLAIMER.md` §0 says what that means for you.
+2 -1
View File
@@ -135,7 +135,8 @@ logs\ui-*.log, agent-*.log, overlay-<pid>-*.log (native log flushed at session
crashdumps\*.dmp
breadcrumbs\<pid>.json (corrected 2026-10-04: never created — the breadcrumb is the .partial file's header and notes)
tmp\<sessionGuid>.partial crash-safety flush of raw buffers, every 60 s (04_CAPTURE §Ring draining)
covers\*.jpg (corrected 2026-10-04: never created — nothing writes games.cover_path)
covers\game-<id>-<ms>.png the images users chose for their games (beta.23, D60) — ~~covers\*.jpg, never created~~;
a store app's own artwork is shown from where that app keeps it, never copied here
```
*(beta.15, D52: `FrameLedger.exe --data-dir <folder>` reads a COPY of this folder instead — a viewer that starts and
+1 -1
View File
@@ -7,7 +7,7 @@ Requirement IDs (`FR-x`, `NFR-x`) are referenced by other docs, commits, and tes
### FR-1 Game library
- FR-1.1 Add game by picking an `.exe`, or drag-dropping an exe/shortcut.
- FR-1.2 Auto-import from Steam, GOG Galaxy, Epic, itch.io with a review checklist. **Import never enables hooking for anything.**
- FR-1.3 Editable metadata (name, cover, publisher, version, notes); auto-detected fields badged and overridable.
- FR-1.3 Editable metadata (name, cover, publisher, version, notes); auto-detected fields badged and overridable. *(The cover is built since beta.23, D60: the user's own image, else the Steam or GOG GALAXY app's artwork on this PC — `08_UI` §Games.)*
- FR-1.4 Remove game (asks whether to keep or delete its sessions).
- FR-1.5 "Supports" row shows shipped-capability hints (DLSS/FSR/XeSS/FG) — visually distinct from measured per-session values (`05_DETECTION` §Capability hints).
- FR-1.7 Delete all sessions (beta.11, owner decision D40): of one game from its page, or of every game from Settings ▸ Data, after a confirmation that says how many — with their frame and sensor series and notes; the library, the settings and every consent stay. The Agent deletes them (the rows are its, `06_DATA_MODEL` §Writer ownership) and refuses while a session it would delete under is being recorded.
+9 -1
View File
@@ -318,6 +318,14 @@ engine compiled only, reads as not found. One Ren'Py install was measured.
| itch.io | `.itch\receipt.json.gz` | **`%APPDATA%\itch\db\butler.db`** (`install_locations` + `caves`, butler's `verdict` names the executable) since 2026-09-16, then the receipt JSON: title, id |
| None/Manual | fallback | PE VersionInfo |
> **The stores' artwork on this PC (beta.23, owner decision D60).** A game's page shows the cover and banner the Steam and
> GOG GALAXY apps already keep — Steam's `appcache\librarycache\<appid>\` (files flat or in hash-named folders), GOG
> GALAXY's `webcache\<user>\gog\<productId>\` — found for the store whose own records own the game's folder
> (`StoreRecords.Owning`, as Play finds it). `Infrastructure.Art.SteamArtCache` and `GogArtCache` read them; nothing is
> downloaded, so the *(opt-in)* online lookup in the publisher/version order below still does not exist. Epic, itch and
> other stores keep no image files: their games show the image the user chooses, or none. The detail: `08_UI` §Games ›
> Game detail, *The header's cover*.
**Auto-import (FR-1.2):** Steam via `libraryfolders.vdf` → all `appmanifest_*.acf` except `SteamLibrarySource.KnownTools` (2026-09-22: Steamworks Common Redistributables, Borderless Gaming, Wallpaper Engine, SteamVR, the Proton and Steam Linux Runtime entries, Blender — tools Steam's manifests do not distinguish from games, and which became library rows the watcher recorded); GOG via `HKLM\SOFTWARE\WOW6432Node\GOG.com\Games\*`; Epic via `Manifests\*.item`; itch by receipt scan. Import presents a review checklist; nothing is launched, nothing is hooked on import.
> **Built 2026-09-14 (P4 PR-4).** `Application.Import.LibraryImporter` over four `IStoreLibrarySource` adapters in
@@ -384,7 +392,7 @@ engine compiled only, reads as not found. One Ren'Py install was measured.
> `StoreLibrarySourcesTests.ItchSkipsAVerdictCandidateThatIsARuntimeHelper` (the verdict as stored),
> `LibraryImporterTests.AStoreTitleAlreadyInTheLibraryAtAnotherExecutableIsNotOfferedAgain`.
**Publisher/version order:** store manifest → PE `CompanyName`/`ProductVersion` → *(opt-in)* Steam `appdetails` lookup, cached 7 days. *(Since beta.8 the PE versions are stored beside the store's rather than instead of it — §What the files say about themselves; the page labels a store's value with its store, "Steam build 20374416".)*
**Publisher/version order:** store manifest → PE `CompanyName`/`ProductVersion` ~~→ *(opt-in)* Steam `appdetails` lookup, cached 7 days~~ *(never built — FrameLedger makes no request to a store, `privacy.online_metadata` is reserved, and a game's artwork (beta.23, D60) is read from the store app's own files on the disk; struck 2026-10-14)*. *(Since beta.8 the PE versions are stored beside the store's rather than instead of it — §What the files say about themselves; the page labels a store's value with its store, "Steam build 20374416".)*
## Capability hints (explicitly labelled as such)
+7 -1
View File
@@ -53,7 +53,11 @@ CREATE TABLE games (
-- beta.20 renpy_vc_version; or the
-- rule's extractor type); NULL for a version the user typed. Written with the version only (05_DETECTION §Engine version)
publisher TEXT, game_version TEXT,
cover_path TEXT, notes TEXT,
cover_path TEXT, notes TEXT, -- cover_path: written since beta.23 (D60) — the image the user chose, as
-- covers\game-<id>-<unix ms>.png relative to the data folder (a PNG copy
-- <= 1200 px); followed only when it is one of those names under covers\
-- and never through a junction or a symbolic link (a viewer's copy could
-- name a share); NULL = the store app's own artwork
removed_at INTEGER, -- schema 0002 (P3 PR-3): FR-1.4 "remove, keep sessions" — the row stays
-- (sessions.game_id is NOT NULL, ON DELETE CASCADE) but leaves the
-- library; a later launch of the same exe restores it (removed_at = NULL)
@@ -436,6 +440,8 @@ switch's rule); integers are invariant-culture within an inclusive range; choice
| `ui.fps_decimals` | bool | `0` | | UI (beta.8, 2026-09-25): every FPS figure with two decimals ("62.40") instead of a whole number |
| `ui.hide_scrollbars` | bool | `0` | | UI (beta.14, 2026-10-05): no scroll bar drawn anywhere; every scroller still scrolls with the wheel, the keyboard and touch (`App.Services.ScrollBarHiding`, `08_UI` §Settings) |
| `ui.library_view` | choice `grid`\|`list` | `grid` | | UI (beta.11, 2026-10-03): the Games library as a grid of cards that fills the width, or as a list; written by the page's own switch, no Settings row (`08_UI` §Games) |
| `ui.game_art` | bool | `1` | | UI (beta.23, owner decision D60): a game's page shows its artwork — the image the user chose, else what the Steam or GOG GALAXY app keeps on this PC; nothing is downloaded. Settings ▸ Games (`08_UI` §Games) |
| `ui.game_art_tint` | bool | `1` | | UI (beta.23, owner decision D61): the page's header band takes the artwork's colour, at the strongest opacity that keeps its text readable. Settings ▸ Games |
| `ui.play_mode` | choice `store`\|`direct` | `store` | | UI (beta.21, owner decision D59): what Play does — `store` hands the game to the app of the store whose own records name its folder, and the agent starts it where none does; `direct` has the agent start it (`LaunchGame`, launch mode). Settings ▸ Games (`08_UI` §Games) |
| `capture.background` | bool | `1` | | ~~Agent~~ nobody *(corrected 2026-10-04: no Agent code ever read it, so the watcher recorded every tracked game whatever it said; beta.12 removed its switch from Settings and reserved the key — `SettingsRegistry.CaptureBackground`. Since beta.21 the App can start a game (Play), and the key stays reserved: a game Play starts is recorded as any other start)* |
| `hooking.kill_switch` | bool | `0` | | Agent (FR-2.4, since P2 PR-F) |
+9
View File
@@ -482,6 +482,15 @@ message, and that message always re-scans.
and SYSTEM) each carry an explicit descriptor. The instance lock and the elevation marker are only ever probed, and a
probe that is refused reads as "held".
- Treat the pipe as unreliable: library, history and charts must all work with the Agent offline. Only live status degrades.
- **A request the Agent never answered is neither a failure nor a refusal (beta.22).** `IAgentRequests.RequestAsync` fails
in one of four ways: `InvalidOperationException` — not connected, nothing was sent; `IpcRequestException` — the Agent
answered `Error`; `TimeoutException`; and `IOException` — the connection closed before the answer, whatever closed it
(`AgentConnection.AnsweredAsync` turns the `IpcFramingException` and `ObjectDisposedException` that `PipeClient` can fail a
request in flight with into it, so a caller handles one). The last two mean *whether it was carried out is not known*
(`AgentAnswers.IsUnanswered`): the caller says so in words (`Agent_Unanswered`) and reads what is stored again — deleting
sessions, the hooking switch, the anti-cheat exception and Play alike. Until beta.22 deleting sessions caught no
`IOException` (the App's crash dialog) and showed a timeout's own message, and the hooking switch and the exception
showed `IOException` or `TimeoutException` as their notice.
- SQLite is the source of truth for anything persisted; pipe events are refresh signals (except `SessionProgress`, which is live-only by design).
- `CaptureRefused`, `SafetyUnhook` and (since 2026-09-25) `HookingTurnedOff` are **never** collapsed into a generic error toast — they get dedicated, explanatory UI (`08_UI` §Notifications).
+55 -6
View File
@@ -128,8 +128,12 @@ The Menu sits in its own row **below** the TitleBar (never inside the drag regio
> Dashboard), Exit (a real exit through `ShellHost.Quit`, whatever minimize-to-tray says); a left click opens the
> window. **Minimize to tray on close** hides the live window when `ui.minimize_to_tray` is on and a tray icon
> exists (`WindowClosePolicy`); a language rebuild's old window is unaffected. **FR-3.8's balloon** — "Session
> saved — <game> — click to view" — is raised only while the window is off screen; on screen, the Dashboard's
> snackbar carries the same event (one event, exactly one channel), and its click opens the summary window.
> saved — <game> — click to view" — is raised only while the window is off screen; on screen, ~~the Dashboard's~~ the
> App's snackbar carries the same event (one event, exactly one channel), and its click opens the summary window.
> *(Corrected 2026-10-14, beta.23: the snackbar's notice was raised by the Dashboard's view model, and it reached the
> other pages only because no Dashboard ever went away — each visit made one, the root container kept every one, each
> subscribed, so twenty visits were twenty notices for one session. It is `Services.SessionNotices` now, one
> subscription for the App's life; the Dashboard listens only while it is on screen.)*
> A safety event is never a balloon (`TrayViewModelTests` asserts it). Tools ▸ Agent status… and Tools ▸ Vulkan
> layer registration… now navigate (Dashboard, Settings) instead of saying "not yet".
@@ -299,12 +303,48 @@ All screens are `Page`s registered with the navigation page provider and navigat
> `…TheImportChecklistRendersWithTheExistingRowsShown`.
>
- **Game detail:**
- Header: cover, name, publisher, version, platform, engine+version, API + Present Mode of last session, `FpsReadout` (lifetime avg), TriState chips, Edit button.
- Header: cover *(built in beta.23, the note below)*, name, publisher, version, platform, engine+version, API + Present Mode of last session, `FpsReadout` (lifetime avg), TriState chips, Edit button.
- **Two clearly separated rows** (`05_DETECTION` §Capability hints — conflating these was the old design's core mistake):
- **Supports** — greyed capability chips from files on disk ("Supports DLSS-G", "Supports XeSS"). Static inference. With none: *not scanned yet* until the Agent's sweep has read the executable, then *none found* (beta.21 — it read "not scanned yet" for every game that ships none of the files).
- **Last session measured** — accent chips with real values ("DLSS Quality · 1440p → 2160p", "Frame Generation DLSS-G ×1.9", "Ray Tracing: Yes"). Measured.
- **Hooking control** (`ui:CardControl` with `ToggleSwitch`): off by default. Turning it on opens the consent dialog (FR-2.1). When the static anti-cheat pre-scan blocked it, the switch is **disabled** with the reason shown inline and no way to force it. When auto-disabled after crashes, an `InfoBar` explains and offers manual re-enable.
> **What opening the page and choosing a session cost, beta.23 (owner request 2026-10-14; `spike-notes` §21).** The
> Sessions grid is bounded (`MaxHeight` 520, as Compare's list is): inside the page's own scroller it was measured with no
> height limit and built every row — 100 sessions were 100 rows of 17 columns, 1.2–1.5 s to open the page; it builds the
> rows on screen now, scrolls itself, and hands the wheel to the page at its ends
> (`PagesLoadTests.TheSessionsGridBuildsTheRowsOnScreenAndHandsTheWheelOnAtItsEnd`). A session's series is read and
> decoded on the thread pool — Microsoft.Data.Sqlite completes its asynchronous calls synchronously, so the decode of a
> two-million-frame session ran on the UI thread whatever `ConfigureAwait` said — and what the charts derive from the whole
> session (one sort of its frames where the Distribution tab did three, the histogram, the percentile curve, the presents
> line) is worked out there once (`Charts.SeriesDigest`): choosing such a session froze the window 0.8–1.0 s, 17 ms now.
> Whether the executable is on disk is asked off the UI thread, as the library page has asked since beta.19.
> **The header's cover, built in beta.23 (owner decisions D60/D61, request 2026-10-14) — never before: the line above said
> "cover" from the first draft and nothing drew one.** The image the user chose (Edit… ▸ *Choose image…*, a PNG copy ≤ 1200 px
> in the data folder's `covers\game-<id>-<unix ms>.png`, `games.cover_path` relative to the data folder; *Use the store's
> image* drops it), else what the app of the store that installed the game keeps on this PC — Steam's
> `appcache\librarycache\<appid>\` (its files flat or in hash-named folders: `library_600x900.jpg` / `library_capsule.jpg`,
> `library_hero.jpg`, `header.jpg` / `library_header.jpg`) and GOG GALAXY's `webcache\<user>\gog\<productId>\`
> (`*_glx_vertical_cover.webp`, `*_glx_bg_top_padding_*.webp`). Which store installed the game is asked of the stores' own
> records, as Play asks (`StoreRecords.Owning`, D59) — Steam's and GOG's only, cached two minutes; nothing is downloaded
> (`privacy.online_metadata` stays reserved). The page: a band (`ArtBand`, rounded) holding the banner (`ui:Image`, as tall
> as its proportions make it, ≤ 240, fading into the band through an alpha mask set in code) above the usual header with the
> cover beside the name (120×180, or 230×107 for a landscape header); a game with no artwork shows no band. No text is
> drawn on a picture. **The band's colour** (`Controls.ArtTint`, D61): the cover's — else the banner's — dominant colour (`Services.ColorMath`: a
> hue histogram of a 48-px copy, vivid pixels weighted, a grey picture none) over the card's fill at the strongest opacity
> — ≤ 30 % on a dark theme, ≤ 22 % on a light one — at which primary and secondary text keep 4.5:1, tertiary 3:1, and the
> pills' and the warning's text 4.5:1 on their fills; recomputed through a resource reference when the theme changes;
> untinted with the option off, a grey picture or high contrast. Everything is read and decoded on the thread pool
> (`Services.GameArt`; the twelve newest images kept); the text shows first and the picture when ready. A chosen image's
> path is followed only when it is one of these names in the data folder's `covers`, and never through a junction or a
> symbolic link — a viewer's copy (D52) could name a share, or hold a link to one. Settings ▸ Games: *Show game artwork* (`ui.game_art`) and *Colour the game page from its artwork*
> (`ui.game_art_tint`), both on. Tests: `GameArtTests`, `CoverStoreTests`, `ColorMathTests` (the hardest colours in both
> themes against the tests' own WCAG), `EditGameViewModelTests`, `PagesLoadTests.EveryTextIsReadableInBothThemes` (the
> surfaces' game page has artwork), `…TheArtworkBandFollowsAThemeSwitch` and `…TheGamePagesArtworkIsDrawn` with
> `AccessibilityTests.NoStyleOfAWpfUiControlLeavesOutItsTemplate` (the cover once took its place and drew nothing, a
> `ui:Image` style not based on WPF UI's; caught in a render before it shipped). The library's cards still have no image.
> **Built 2026-09-14 (P3 PR-5): the grid, the detail page's header, the two rows, the hooking control and
> the Sessions tab.** Grid: `ui:CardAction` cards with platform / engine / hooking badges, sessions, playtime,
> last played (~~the sparkline is PR-6's~~ no sparkline was built — corrected 2026-10-04); search and sort in memory; FR-1.1 by File ▸ Add game…, the page's
@@ -672,6 +712,11 @@ Tail view of `ui-*.log` / `agent-*.log` (toggle), level filter, search (`ui:Auto
> `PagesLoadTests`.
### Settings
> **beta.23 (owner decisions D60/D61).** The Games section has, under the Play button, **Show game artwork**
> (`ui.game_art`, on) and **Colour the game page from its artwork** (`ui.game_art_tint`, on; disabled while the first is
> off) — the game page's artwork and its band's colour (§Games › Game detail, *The header's cover*). Neither downloads
> anything; the App reads both at each page load, the Agent neither.
>
> **beta.14 (owner request 2026-10-05: "an option to hide the scroll bars but still scroll").** The Window section has
> **Hide scroll bars** (`ui.hide_scrollbars`, off by default). A bar's visibility is bound inside its scroller's template,
> which no style reaches, so `Services.ScrollBarHiding` sets the scrollers themselves: ~~one class handler on
@@ -703,7 +748,7 @@ Sections per FR-10 using the WPF UI settings idiom: `ui:CardControl`/`ui:CardExp
**System (2026-09-21, FR "show the user's hardware"):** a card above Legal stating this PC as a session's hardware snapshot would record it right now — processor, graphics card, graphics driver, memory, Windows build, primary display — through the same `IHardwareSnapshotSource` the Agent stamps sessions with, read on the thread pool when the page opens, a field that could not be read as N/A, with **Copy** (the same lines as text) and a note that nothing is sent anywhere and what CPU temperature needs. Its own `SystemInfoViewModel`, not `SettingsViewModel`'s. The same snapshot is one tertiary line under the session summary's header (it was loaded for the export and shown nowhere), and `--diag` prints it; the bug bundle's `sysinfo.json` is deliberately NOT given it — its keys are the issue link's prefill.
Agent section: elevation state with a plain explanation of what elevation *optionally* unlocks (CPU temperature, elevated-game attach — ~~ETW fallback~~, which no longer exists) and that it is **not required by any capture tier**; task state, Register/Repair/Remove task, "Start agent at logon", ~~background capture toggle~~ *(removed in beta.12 — nothing read it; corrected 2026-10-04)*. Privacy: online-metadata opt-in with plain-language explanation. Legal: reopen documents.
Agent section: elevation state with a plain explanation of what elevation *optionally* unlocks (CPU temperature, elevated-game attach — ~~ETW fallback~~, which no longer exists) and that it is **not required by any capture tier**; task state, Register/Repair/Remove task, "Start agent at logon", ~~background capture toggle~~ *(removed in beta.12 — nothing read it; corrected 2026-10-04)*. ~~Privacy: online-metadata opt-in with plain-language explanation.~~ *(Not shown since 2026-09-16: no code makes the request and `privacy.online_metadata` stays reserved — the built Settings below; struck 2026-10-14.)* Legal: reopen documents.
> **The admin mode, beta.10 (owner decision D34; `01_ARCHITECTURE` ADR-9).** The Agent section has a switch, *Run the agent
> as administrator* (`capture.run_elevated`, off by default). Turning it on opens a `ContentDialog`
@@ -862,8 +907,12 @@ which is why the handler is ours.
Colours come from the WPF UI theme dictionaries and nothing else, so contrast is the Fluent themes' — both of which
meet it — and cannot be broken locally: `AccessibilityTests.NoXamlHardCodesAColour` fails on any `#RRGGBB` or named
colour in the App's XAML. The chart palette is the one deliberate exception (`16_WPFUI_SYNTAX` §ScottPlot: one
palette per theme, chosen with the theme).
colour in the App's XAML. The chart palette is ~~the one~~ a deliberate exception (`16_WPFUI_SYNTAX` §ScottPlot: one
palette per theme, chosen with the theme). *(Corrected 2026-10-14, beta.23: the game page's artwork band is the second —
a colour worked out at run time from the artwork and the theme's own text and fill colours, at the strongest opacity at
which every text on it keeps 4.5:1 (tertiary 3:1), so it is held by construction rather than by the theme;
`ColorMathTests` checks the hardest colours in both themes against the tests' own WCAG, and `PagesLoadTests` measures the
rendered band. Its banner's fade is an alpha mask set in code, no colour at all.)*
> **"Cannot be broken locally" had a hole, closed 2026-09-16.** `ui:Badge Appearance="Info"` — the Games card's
> "Hooking on/off" and the edit dialog's "Detected" — paints its background with WPF UI's `PaletteLightBlueBrush`, a
+2 -1
View File
@@ -79,7 +79,8 @@ harness, run `hook-harness.exe --real --hold-presenting N`, then the Agent's `--
SQLite's online backup, which is consistent while the Agent writes — in Python,
`sqlite3.connect("file:C:/Users/<you>/AppData/Local/FrameLedger/ledger.db?mode=ro", uri=True).backup(sqlite3.connect(r"<copy>\ledger.db"))`
— or copy the whole folder with every FrameLedger process stopped
(closing the App does not stop the Agent). The App opens the copy, migrating it if your build is newer, which is exactly
(closing the App does not stop the Agent). A copy of the database alone has no `covers\`: the games whose image the user
chose show the store's artwork instead (beta.23), and choosing one in the viewer writes into the copy's own `covers\`. The App opens the copy, migrating it if your build is newer, which is exactly
why it must be a copy, and writes its log and crash dumps beside it. It is a viewer: no Agent is started or contacted and
nothing on the PC is changed (`08_UI` §Shell). It refuses the profile's own folder however it is spelled, and a folder
that does not exist.
+1 -1
View File
@@ -328,7 +328,7 @@ WPF UI shell (`16_WPFUI_SYNTAX`), library, per-game hooking consent flow, Dashbo
~~Static rules engine + `detection-rules.json` (engines, platforms, capabilities, **anticheat blocklist**) + validator + fixtures~~ **landed 2026-09-14 (P4 PR-1: the engine existed since P0; the Agent's `DetectionSweep` is its first caller, `ApplyDetectionAsync` its first writer — HANDOFF §P4)**; ~~store auto-import~~ **landed 2026-09-14 (P4 PR-4)**; ~~capability-vs-measured UI separation~~ **(PR-1: the Supports row reads the sweep's flags)**; ~~i18n en/vi/ja; Legal Gate;~~ ~~Velopack + updater (with the hooked-session deferral)~~ **landed 2026-09-14 (P4 PR-5 — the deferral is `UpdateService`'s shape, not a flag)**; ~~bug bundle incl. overlay logs~~ **landed (overlay logs since P3 PR-8a; 2026-09-15, P4 PR-9: the crash dialog, the minidump in both processes and the dump as the bundle's opt-in — `10_LOGGING` built notes)**; ~~tray + toasts; Settings;~~ ~~DB maintenance~~ **landed 2026-09-15 (P4 PR-7: the sweep is the Agent's over `SweepRetention`; integrity, backup and compaction in the App)**; ~~accessibility pass~~ **landed 2026-09-15 (P4 PR-8: `08_UI` §Accessibility written first — Ctrl+1…5, Esc on every dialog, an automation name on every textless input, theme colours only — each held by `AccessibilityTests`)**; ~~the scheduled task (`--install-task`)~~ (P3 PR-8b) and ~~the Velopack install hooks~~ **(PR-5: the uninstall hook; install registers nothing, by design — `12_BUILD` §The Vulkan layer is not registered at install time)**. *(The struck items moved to P3 on 2026-09-13 — see §P3.)*
## P5 — Ship (3–4 days)
CI/CD with the native build (`release.yml` exists since P4 PR-5, 2026-09-14 — ~~untested by a tag yet~~ **ran on the first tag 2026-09-16** (`13_CI_CD` §release.yml: cancelled by a test hang once, green on the re-run); **rehearsable without one since 2026-09-16**, `13_CI_CD` §release.yml's dry run); CodeQL (C# + C++); Dependabot; CHANGELOG; README with the P0 accuracy comparison — **which is not a percentage, and this line used to send its author looking for one**. The decision is recorded under item 3 and in `spike-notes.md` §8: the baseline can answer **none** of item 4's four runtime questions, so the defensible claim is *"the baseline cannot answer four of these five questions at all"*, not *"N% more accurate"*. Overhead + tier cross-validation measurements; release smoke on clean VMs; ~~`v0.1.0-beta.1`~~ **tagged and published 2026-09-16** — eleven pre-releases through `0.1.0-beta.11` (2026-10-03), added 2026-10-04 — (pre-release, unsigned, `SHA256SUMS.txt` beside the assets). What P5 still owes: the clean-VM smoke (`14_TESTING` §Release smoke — Win 10 22H2 is unmeasured), the overhead run (`spike-notes` §14.3), and the README's accuracy comparison sentence.
CI/CD with the native build (`release.yml` exists since P4 PR-5, 2026-09-14 — ~~untested by a tag yet~~ **ran on the first tag 2026-09-16** (`13_CI_CD` §release.yml: cancelled by a test hang once, green on the re-run); **rehearsable without one since 2026-09-16**, `13_CI_CD` §release.yml's dry run); CodeQL (C# + C++); Dependabot; CHANGELOG; README with the P0 accuracy comparison — **which is not a percentage, and this line used to send its author looking for one**. The decision is recorded under item 3 and in `spike-notes.md` §8: the baseline can answer **none** of item 4's four runtime questions, so the defensible claim is *"the baseline cannot answer four of these five questions at all"*, not *"N% more accurate"*. Overhead + tier cross-validation measurements; release smoke on clean VMs; ~~`v0.1.0-beta.1`~~ **tagged and published 2026-09-16** — ~~eleven pre-releases through `0.1.0-beta.11` (2026-10-03), added 2026-10-04~~ a pre-release at each step since, listed in the CHANGELOG *(corrected 2026-10-14: the count went stale at the next release)* — (pre-release, unsigned, `SHA256SUMS.txt` beside the assets). What P5 still owes: the clean-VM smoke (`14_TESTING` §Release smoke — Win 10 22H2 is unmeasured), the overhead run (`spike-notes` §14.3), and the README's accuracy comparison sentence.
**Total ≈ 5.5–6.5 weeks full-time** — roughly 1.5–2 weeks more than the ETW design, which is the honest price of the accuracy.
+20
View File
@@ -155,6 +155,11 @@ Native `Menu`, `TabControl`, `ComboBox`, `Slider`~~, `ListView`~~ are fine — t
- **Every `Page` root sets `Foreground="{DynamicResource TextFillColorPrimaryBrush}"`** (2026-10-07): the navigation's
Frame passes no text colour into a page, and a text with none is black (§Gotchas).
- Exception to the no-hex rule: the chart palette — defined once per theme in ~~`Styles/ChartPalette.xaml` (two dictionaries)~~ `Styles/ChartPalette.Dark.xaml` and `ChartPalette.Light.xaml` (corrected 2026-10-04), never inline.
- Second exception (beta.23, D61): the game page's artwork band, `Controls/ArtTint` — a colour worked out in code from the
artwork and the theme's own text and fill colours, the strongest tint at which every text on it still reads (4.5:1,
tertiary 3:1). It follows a theme switch through a **resource reference on the band** (`SetResourceReference` on a
private attached property bound to `ApplicationBackgroundColor`), not through `ApplicationThemeManager.Changed`, which
only `ApplicationThemeManager.Apply` raises — a page made and switched in the tests' harness would never hear it.
## FlowDocument (rendered documents, beta.12)
@@ -236,6 +241,12 @@ On startup and on `ApplicationThemeManager.Changed`: for every live plot set fig
reaches: the import list was white text on white in the dark theme (owner's screenshot, beta.14). Base it on
`DefaultDataGridRowStyle`. `AccessibilityTests.NoStyleIsBasedOnAnImplicitStyleTheThemeDoesNotDefine` refuses any
`BasedOn` a type the App's dictionaries hold no style for, and `ImportReviewRenderTests` measures the rendered rows.
- [ ] **A style of the App's for a WPF UI control replaces the style that holds its template** (beta.23). WPF UI 4.3.0 gives
its controls their templates in its own styles (`DefaultImageStyle`, …), applied only to a control with no style of its
own: a local `<Style TargetType="ui:Image">` with no `BasedOn` leaves the control with no template, and it takes its
place and draws nothing — the game page's cover was an empty space beside the name while the banner above it, with no
style, drew (caught in a render before it shipped). Base it on WPF UI's (`BasedOn="{StaticResource DefaultImageStyle}"`).
`AccessibilityTests.NoStyleOfAWpfUiControlLeavesOutItsTemplate`, `PagesLoadTests.TheGamePagesArtworkIsDrawn`.
- [ ] **WPF UI's `CheckBox` is `MinWidth` 120 with an 11 px padding**: in a narrow grid column it draws a sliver of the box.
`MinWidth="0" Padding="0"` there. A `DataGridCheckBoxColumn` uses WPF's own element style, an Aero2 box — use a template
column (`AccessibilityTests.NoDataGridCheckBoxColumn`).
@@ -255,6 +266,15 @@ On startup and on `ApplicationThemeManager.Changed`: for every live plot set fig
ignores Windows' *lines to scroll*, and a precision touchpad's small deltas each jump the whole step — a long document
read as slow and jerky while its layout cost about a millisecond a step. `Controls/MarkdownView` handles
`PreviewMouseWheel` itself (beta.21): the delta in proportion at Windows' lines, eased, unhandled at its ends.
- [ ] **Microsoft.Data.Sqlite completes its "async" calls synchronously** (measured 2026-10-14, beta.23): a
`ConfigureAwait(false)` after a ledger read does not leave the thread that asked, so a view model's load, a session's
decode, a sort over its frames all ran on the UI thread. Work that must not run there goes in `Task.Run` —
`Charts.SessionSeriesLoader`, the game page's executable check (`spike-notes` §21).
- [ ] **A transient page's view model is never `IDisposable`** (beta.23). Pages and their view models are transient, and
the root container keeps every transient disposable it makes until the App exits: every Dashboard and Logs page ever
opened stayed in memory, and each Dashboard stayed subscribed to the Agent — at a session's end every one reloaded its
lists on the UI thread and raised its own notice. Listen on Loaded and stop on Unloaded (`Attach`/`Detach`, as Games,
the game page and the Dashboard do); `DashboardViewModelTests.ADashboardOffScreenHearsNothing…`.
- [ ] **ScottPlot 5 zooms on every wheel and never marks it handled.** Without `Charts/ChartWheel` a wheel over a chart
zoomed it and scrolled the page at once; a plain wheel is the page's, Ctrl+wheel the chart's, for every plot that
`ChartTheme.Attach` registers.
+1 -1
View File
@@ -4374,7 +4374,7 @@ Each of these is referenced by an existing doc but specified nowhere.
| ~~**Legal doc versioning**~~ | ~~FR-11 re-shows documents "when a document version increments". Nothing says where the current version lives, who writes `legal_acceptance.version`, or how the markdown is rendered in-app~~ **Answered 2026-09-14 (P3 PR-9):** the version is the document's own `**Version:**` line, read from the copy embedded in the App at build (`App.Services.LegalDocuments`); the App writes `legal_acceptance.version` on the one Accept and re-shows any document whose embedded version differs from its row; ~~the markdown is shown as text with authoring comments stripped, not rendered~~ the markdown is shown with authoring comments stripped and, since beta.12, rendered (`08_UI` §Menu, *Documents are rendered*; §First-run flow built note) | FR-11, `06_DATA_MODEL` |
| **Accessibility / DPI** | NFR-9 states requirements; no design anywhere | NFR-9, `08_UI` |
| **Uninstall / data deletion** | One Velopack clause. No in-app "delete all my data", despite the privacy position | `12_BUILD`, `legal/PRIVACY_POLICY.md` |
| **Cover art** | Appears in the schema, the data directory and the UI; nothing says where it comes from or the licence position on downloaded store art | `06_DATA_MODEL`, `05_DETECTION` |
| ~~**Cover art**~~ | ~~Appears in the schema, the data directory and the UI; nothing says where it comes from or the licence position on downloaded store art~~ **Answered 2026-10-14 (beta.23, owner decisions D60/D61):** from the user's own image (a copy in `covers\`) or what the Steam and GOG GALAXY apps already keep on this PC — nothing is downloaded, so no store art is redistributed or fetched; the art stays its owners' (`legal/TRADEMARKS.md`), the Privacy Policy 2.11 names the files read. `08_UI` §Games › Game detail. **Row closed** | `06_DATA_MODEL`, `05_DETECTION` |
| **Tier-2 mechanism** *(was: PresentMon distribution)* | **By what mechanism does a shipped build reach a no-injection MEASUREMENT?** Nothing names one. Since 2026-08-28 the ladder is two rungs and Tier 2 is explicitly not a measurement — duration, sensors and the reason — so this row is no longer about degraded fidelity but about whether that capability returns at all. **It now owns TWO casualties, not one:** the frame-generation oracle §S31 spent four attempts looking for, and `14_TESTING`'s Tier-1 accuracy cross-check, struck the same day because it required a second instrument measuring the same frames. **One mechanism would restore both**, which is the strongest argument for costing it. Constraints on any answer: `README`'s capture-tier table and its **safety** row *"always a way out"*, `legal/DISCLAIMER.md` §73 and `legal/EULA.md` §33; ETW needs elevation whatever the tool; and `15_ROADMAP` has no v2 fallback either | `README`, `legal/DISCLAIMER.md`, `legal/EULA.md`, `04_CAPTURE`, `14_TESTING`, `15_ROADMAP` |
---
+117 -5
View File
@@ -2198,7 +2198,7 @@ a Ren'Py game's engine version from `renpy/vc_version.py` (rules `2026.10.3`, Pr
once at the next update; `05_DETECTION` §Engine version — Ren'Py) and strikes item 15. Merged for the next pre-release;
no release was asked for.
## **START HERE** — 2026-10-12, 0.1.0-beta.20: the engine version of Ren'Py games
## ~~**START HERE**~~ — 2026-10-12, 0.1.0-beta.20: the engine version of Ren'Py games *(struck 2026-10-13: the head is §beta.21 below)*
*Status is `CHANGELOG.md` `[0.1.0-beta.20]`; this is what no other file carries.* The owner, the same evening as beta.19 and
after confirming it on real hardware: "tiếp tục với 1 pr kèm với detect version game dùng ren'py", then "tung bản beta20
@@ -2218,6 +2218,93 @@ game's engine" — was shown to the owner with #299 and released on their word.
**Owner-only, added to the list below:** item 16.
## ~~**START HERE**~~ — 2026-10-13, 0.1.0-beta.21: an anti-cheat beside the executable, four itch downloads that are malware, documents that scroll, Play *(struck 2026-10-13: the head is §beta.22 below)*
*Status is `CHANGELOG.md` `[0.1.0-beta.21]`; this is what no other file carries. The owner's list (2026-10-13, four items,
with screenshots of two game pages): HELLO, HELLO WORLD!'s RPG Maker path is wrong; no anti-cheat is found for Wuthering
Waves; the documents in the app scroll slowly; and, if possible, a Play button on a game's page or in the library that
points to the platform. Then: once the plan is approved, commit → push → CI → auto-fix → merge → bump the version →
release, in one go. Four stacked PRs — #301 check 4 also walks the executable's folder (rules `2026.10.4`), #302 the four
itch "launchers" are malware and the Supports card, #303 the documents' wheel and one render per page, #304 Play and the
Privacy Policy 2.10 — then the release.*
**Decisions (owner, 2026-10-13, asked with the plan — do not re-ask):**
- **D57 — the four itch "launchers" are malware: the documentation is corrected, the import is not changed.** The
"wrong path" of HELLO, HELLO WORLD! is itch's own pick: the 213 MB .NET program in front of the RPG Maker runtime,
which is not a helper, so the import takes it (D56). Read without running it, that program — the same in A Doll's
Locket - Remake, City of Bones and Träumerei Chapter 2 — is malware (`spike-notes.md` §20). D28, D56, item 15(a), the
beta.19 entry and `05_DETECTION` are corrected in place, and no document advises running one. The repository records
what the files are, never the state of a PC that ran one.
- **D58 — Wuthering Waves is on the title list** (Steam `3513350`, Anti-Cheat Expert), beside the fix that finds ACE's
folder beside the game's executable.
- **D59 — Play, in two modes switched in Settings:** "1: press Play → the platform opens → it runs; 3: it runs at once;
let me switch between the two". `ui.play_mode` is `store` (the default) or `direct`; the store is the one whose own
records name the game's folder, never the row's `platform`; an App running as administrator never starts a store's
app (`08_UI` §Games).
- **The train (owner, with the plan):** "Làm trọn mạch ngay" — each PR squash-merged as its CI went green, then the
signed tag and the release, without asking again. The Privacy Policy 2.10 wording and the Wuthering Waves row of
`LIST_GAME_TESTED.md` (D35) were approved with the plan.
**Traps met on the way:**
- **The pre-scan's depth limit is a reach, not a refusal.** A folder at the third level is named and never opened, and
the walk reports a complete, clean tree; only the 4096-entry budget refuses. An anti-cheat deeper than three levels
under both the install root and the executable's folder is still invisible to check 4 — the 30 s re-check meets it
only once its driver is loaded, and a driver is a machine-wide finding that turns nothing off (`spike-notes.md` §19).
- **A rules note over 300 characters fails `rules-validate` with a message about something else** ("Value is null …
`/engines/4/version`"): `Test-Json` names a branch of the schema, not the long `notes` (`freeText`, maxLength 300).
Bisect the edit, not the message.
- **The owner's live rules, older than the repository's, make parallel test hosts race**: each reseeds
`%LOCALAPPDATA%\FrameLedger\rules`, and `ReplaceFileW` fails one of them ("could not write the rules file"). Before
the gate, seed the repository's rules and its `.seeded` marker (the uppercase SHA-256 hex) yourself; after it, put the
owner's files back byte for byte.
- **WPF's `ScrollViewer` moves 48 DIP per wheel message whatever its delta** (`16_WPFUI_SYNTAX`), so a touchpad's small
deltas each jump the whole step; `MarkdownView` handles the wheel itself.
- **A review of Play after its gates and its first CI run were green found four defects no gate could** (§beta.19's
lesson, again). The pipe fails a request in flight with an `IOException` when the agent stops (`PipeClient` fails every
pending request so), nothing on the Play path caught it, and a command's unhandled exception is the App's crash dialog —
so pressing Play while the agent restarted for an update would have ended there. A store record whose id builds no
link read "GOG GALAXY is not installed"; the agent's `UnknownGame` reached a notice as that token; two notices advised
what their own path could not do. All four fixed in #304 before it merged. **Not fixed here:** `SessionDeletion` has the
same gap (it catches no `IOException`), and every other caller of the pipe misses the `ObjectDisposedException` and
`IpcFramingException` the same failure can raise — the owner asked for it as its own PR after this release, and
its own pre-release (beta.22).
- **Analyzers met:** MA0048 (one type per file), MA0099 (compare a flags enum with its `None`, not `0`), CS1573 (a
`<param>` on some of a record's parameters needs one on all — `<remarks>` instead), IDE1006 (a `private const` takes
the `_` prefix). **Mechanical, again:** a Bash heredoc halves `\\`; the Write tool writes LF and `sed -i` turns CRLF
into LF.
**Owner-only, added to the list below:** item 17.
## **START HERE** — 2026-10-13, 0.1.0-beta.22: a request the capture agent never answered
*Status is `CHANGELOG.md` `[0.1.0-beta.22]`; this is what no other file carries.* The owner, during the beta.21
train: "Bạn xử lý chip thành 1 pr mới sau release và thành 1 phiên bản mới nhé" — the chip beta.21's review of Play
left (§beta.21's traps): every caller of the pipe, not only Play, as its own PR and its own pre-release. One PR — #306,
`AgentConnection.AnsweredAsync` and `AgentAnswers.IsUnanswered`, with deleting sessions, the hooking switch, the anti-cheat
exception and Play telling *not sent* from *not answered* — then the release.
**Decisions:** none new. *Not answered* is said as not known (`Agent_Unanswered`) and never as the old words for *not
sent* ("nothing was deleted", "nothing changed"): a request the connection closed under may have been carried out.
**Traps met on the way:**
- **VSTHRD003 rejects awaiting a `Task` a method was handed** ("work that was not started within your context"): a helper
that wraps a request's exceptions takes a `Func<Task<T>>` and starts it itself — which also catches what the request
throws before it returns a task.
- **`ObjectDisposedException` derives from `InvalidOperationException`**: a `catch (InvalidOperationException)` for "not
connected" would read a disposed pipe as "nothing was sent". `AgentConnection` turns it into the `IOException` first,
so the callers' split holds.
**Owner-only, added to the list below:** item 18 — **passed 2026-10-13**.
**After the release (owner, 2026-10-13):** "Tất cả các item đã đạt yêu cầu. Bạn có thể xử lý chip, phiên bản mới (nếu
cần), cập nhật, rồi đóng phiên nhé" — items 16, 17 and 18 passed; the chip beta.22's local gate left (`fl_ring`'s
hammering-writer guard, red on a correct ring) became beta.23 PR-1, #308: both concurrency cases guard on drains that
overlapped the writer (§Traps, the native-test entry). Merged for the next pre-release; no release, since nothing a
user runs changed.
## Owner-only — no PR can close these
1. **§S23-2 — branch protection.** `Rules / validate` is not a required status check on
@@ -2335,10 +2422,24 @@ game's engine" — was shown to the owner with #299 and released on their word.
together are said in one notice that names both; with the USB drive unplugged nothing is removed; *Remove uninstalled
games* off keeps it. (e) The Legal Gate shows the Privacy Policy 2.8
once. (f) The `ja` strings marked `review`.
16. **beta.20 on real hardware.** (a) **Bound Between Desks:** its page reads *Ren'Py 8.5.0*, and its *Engine version*
line says it was read from the engine's version file (`renpy/vc_version.py`); the first sweep after the update reads
every game once more (rules `2026.10.3`). (b) The Legal Gate shows the Privacy Policy 2.9 once. (c) The `ja` string
marked `review` (`GameDetail_EngineVersion_RenPyVcVersion`).
16. ~~**beta.20 on real hardware.**~~ **Passed 2026-10-13** — the owner: "Tất cả các item đã đạt yêu cầu" (every item
met its requirement). *(The item as written:)* (a) **Bound Between Desks:** its page reads *Ren'Py 8.5.0*, and its
*Engine version* line says it was read from the engine's version file (`renpy/vc_version.py`); the first sweep after
the update reads every game once more (rules `2026.10.3`). (b) The Legal Gate shows the Privacy Policy 2.9 once. (c)
The `ja` string marked `review` (`GameDetail_EngineVersion_RenPyVcVersion`).
17. ~~**beta.21 on real hardware.**~~ **Passed 2026-10-13** — the same answer. *(The item as written:)* (a) **Wuthering
Waves:** after the update, before any session, its page says hooking is off — Anti-Cheat Expert beside its
executable, and its Steam id on the title list; Neverness To Everness stays blocked, and GIRLS' FRONTLINE 2's
exception stays in force. (b) **Play**, in both modes of Settings ▸ Games ▸ *Play button*, with a Steam game, Alan
Wake 2 from the Epic Games Launcher (its link has not been tried on a real game), a GOG game and an itch game — and
in Task Manager's Details tab the game's *Elevated* column reads *No*. (c) **The wheel and a touchpad** in Help ▸
User guide, the licence in Help ▸ About and the Legal Gate: about three lines a notch, gliding; at the end of the
update notes the window scrolls instead. (d) The Legal Gate shows the Privacy Policy 2.10 once. (e) The `ja` strings
marked `review` (Play, Settings ▸ Games, `GameDetail_Supports_None`).
18. ~~**beta.22 on real hardware.**~~ **Passed 2026-10-13** — the same answer. *(The item as written:)* (a) The `ja`
string marked `review` (`Agent_Unanswered`). (b) Nothing else to run: the change answers a request the agent drops
mid-way, which the tests make happen and a person can only meet by chance — if a notice ever says the capture agent
did not answer, the page beside it shows what was stored.
**Answered 2026-08-05, do not re-ask:** remove `gameguard` and keep `guard` (approved
over a red `Rules` gate, with the reasoning recorded in the merge commit); vendor NVAPI
@@ -2581,6 +2682,17 @@ diagnosis*.
nothing, and `ring_test.cpp`'s own header already records that two of its four properties
have never been shown red.
> **Amended 2026-10-13 (beta.23 PR-1, #308): both guards now measure overlap.** The hammering case's own guard,
> `accepted > kTotal / 2`, failed 5 of 40 runs and then 5 of 200 on the owner's hybrid i7-14700KF — `mixed` clean every
> time — and once made a full local gate red. A share of the stream measured the scheduler: a reader on an efficiency
> core keeps less than half, and one the OS does not run until the writer is done keeps one lap (accepted 1024). The
> tiny ring's `dropped > 0` was weaker the other way: a reader made to wait for the writer to finish drops nearly
> everything (1.6 million over eight attempts) and passed it. Both cases now start the writer only once the reader
> is about to loop, count the drains that copied records while the writer was still writing, and repeat — every
> attempt checked for its properties — until one attempt made 100 such drains, at most eight times; the tiny ring
> also holds that attempt's own `dropped > 0`. A start barrier alone left 1 of 200 (one overlapping drain). Measured:
> 1,000 runs, no failure, at most 3 attempts; with the waiting reader, both guards fail in every run.
- **A self-test's cases can all pass while testing nothing, and their NAMES will not tell
you.** Found 2026-08-27 in a PowerShell gate's `-SelfTest`: removing the fail-closed guard
from a hash comparison left **all ten cases green**. `[string]::Equals` already refuses
+5 -2
View File
@@ -9,8 +9,9 @@ the owner's review; sessions since 2026-09-27, and the game-memory figures beta.
**The machine.** Every row below was run on one PC: an NVIDIA GeForce RTX 5080 (the only graphics card), an Intel Core
i7-14700KF, 32 GB of DDR5, Windows 11 (Insider builds 26300 → 29648) and a 2560×1440, 240 Hz monitor. **No AMD or Intel
graphics card and no second machine has been tested**, and **no real Vulkan or OpenGL game has been measured** — every
measurement below is Direct3D 11 or 12. What the tiers mean and what FrameLedger cannot do: [LIMITATIONS.md](../LIMITATIONS.md).
graphics card and no second machine has been tested**, and ~~**no real Vulkan or OpenGL game has been measured** — every
measurement below is Direct3D 11 or 12~~ **one real Vulkan game has been measured (Everhex Demo, 2026-10-13) and no
OpenGL game** — every other measurement below is Direct3D 11 or 12 *(corrected 2026-10-14)*. What the tiers mean and what FrameLedger cannot do: [LIMITATIONS.md](../LIMITATIONS.md).
**Two periods.** From 2026-08-03 to 2026-09-06 the games were measured with the developer's capture tool, one run at a
time against the game's own settings menu (reports in [spike-notes.md](spike-notes.md)). From 2026-09-16 the shipped
@@ -43,6 +44,7 @@ with the 2026-09-16 recovery and with library entries removed since.
| 恋しかるべき (KOISHIKARUBEKI) | Unity 6000.3 | D3D11 | Presented 59.6 FPS | 2026-09-03 | [spike-notes §9](spike-notes.md) |
| Flower in Us | RPG Maker MV/MZ (NW.js) | D3D11 | Presented 59.8 FPS over three swap chains, after two refusals that found the game's browser process ambiguous (fixed) | 2026-09-03 → 09-04 | [spike-notes §9](spike-notes.md) |
| UMIGARI | Unreal Engine 5.5.4 | D3D12 | Presented 95–97 FPS, frame generation *none*, ray tracing *No* | 2026-09-05 → 09-06 | run reports only |
| Everhex Demo | — | Vulkan | Presented 239.7 FPS (1 % low 213.5), 14,955 frames in 69 s, through FrameLedger's Vulkan layer — the first real Vulkan game measured; started by Play set to *Start directly* | 2026-10-13 | database *(row added 2026-10-14 from a copy of the database)* |
## Recorded without measurement (Tier 2)
@@ -62,6 +64,7 @@ with the 2026-09-16 recovery and with library entries removed since.
| Aniimo | NetEase Yidun with a kernel driver (`NEPKernel.sys`) in the game's folder — never eligible for an exception | 2026-09-25 | [19_SAFETY](19_SAFETY_AND_ANTICHEAT.md) |
| Goose Goose Duck | Easy Anti-Cheat's service running, and its folder | 2026-08-04 | [spike-notes §13](spike-notes.md) |
| Neverness To Everness | Anti-Cheat Expert's kernel driver in the game's folder | 2026-08-04 | [spike-notes §13](spike-notes.md) |
| Wuthering Waves | Anti-Cheat Expert, kept beside the game's executable four folder levels in, where the check did not look before beta.21: a session with hooking on was injected and unhooked 37 seconds later, when the 30-second re-check met ACE's driver (`ACE-BASE.sys`); nothing was measured. Since beta.21 its folder and its Steam id refuse it before any injection *(row added 2026-10-13 from the agent's log)* | 2026-10-12 | [spike-notes §19](spike-notes.md) |
| Counter-Strike 2 | Valve Anti-Cheat — refused by FrameLedger's title list since beta.8. On 2026-08-04 the checks alone allowed it (VAC is invisible to them); nothing was injected | 2026-08-04, beta.8 | [spike-notes §13](spike-notes.md), [19_SAFETY](19_SAFETY_AND_ANTICHEAT.md) |
Also refused before any injection: **Deadly Heart Gambit** — a 32-bit game (2026-08-03).
+9
View File
@@ -63,6 +63,15 @@ are kept because they record what each version changed and why (owner decision D
>
> Version 2.5 (2026-09-27, 0.1.0-beta.10) adds how a tracked game's window is shown — read from Windows — and the engine build name read from an Unreal Engine game's executable. It is also the first version to say two things the software already did: it reads the **content** of a library game's executable (markers in its first 8 MB and its import table, since the detection of engines and features; and, when a session starts, the graphics-library markers in the whole file), and it reads the processor load and the memory in use (since 0.1.0-beta.3). Nothing here leaves your device, as before.
### What version 2.11 of the Privacy Policy changed (0.1.0-beta.23)
A game's page shows its artwork (beta.23 PR-3, owner decisions D60/D61; the wording approved with the plan). §1 adds the
images a user chooses for a game, kept as a copy in the data folder's `covers` folder and deleted when the store's image
is chosen again or the game is removed with its sessions. §4 adds the cover and banner images the Steam and GOG GALAXY apps
keep on the disk for a library game, read to show them on its page and never copied or sent, and says that Steam's and
GOG GALAXY's lists of installed games are now also read when a game's page opens, to find that artwork. §2 is unchanged:
nothing is downloaded, and the software still looks nothing up on any store. Nothing here leaves your device, as before.
### What version 2.10 of the Privacy Policy changed (0.1.0-beta.21)
§4 names the lists of installed games the Steam, GOG GALAXY, Epic Games and itch apps keep on the disk, and where GOG
+41
View File
@@ -2772,3 +2772,44 @@ entry, and the HELLO, HELLO WORLD! row of `LIST_GAME_TESTED.md`; `LIMITATIONS.md
game from an unsafe one.
- **Not measured, and not to be:** what the payload does. Nothing here was run, decrypted or uploaded anywhere.
## 21 · Opening pages and switching tabs in the App *(2026-10-14, beta.23)*
The owner asked whether switching pages and tabs is slow. Measured with a harness over the App's own pages and view
models — not committed: it times, and a timing assertion in CI is a flake — on the dev PC (i7-14700KF, RTX 5080, Windows
11 29648), Release build, each page shown in WPF UI's `NavigationViewContentPresenter` in a real, off-screen window. The
ledger is a scratch one shaped like the owner's (its counts read from the owner's ledger without writing to it): 48 games, one with 100 sessions (NFR-4's
"opening a game with 100 sessions ≤ 500 ms"), one with a 2,000,000-frame session (the owner's longest: WALTO, 2,057,022
frames, with noisy frame times so a sort is a real sort). **Freeze** is the longest stretch the UI thread did not answer
(a probe re-posted at idle priority); median of 10 runs, 5 for the selection; *before* is two runs of `main` (2982679).
**The decision table, written before the first run:** fix what keeps the UI thread busy 50 ms or more, what can block
on I/O, and what grows with each visit; record the rest.
| What | Freeze before | Freeze after | Why it was slow |
|---|---|---|---|
| Open a game with 100 sessions | 1,175–1,507 ms | 369 ms | the Sessions grid inside the page's scroller had no height limit and built every row: 100 rows of 17 columns |
| Choose the 2,000,000-frame session | 843–1,016 ms | 17 ms | the blob read, its decode and the stutter detection ran on the UI thread (Microsoft.Data.Sqlite's async is synchronous), then three sorts of every frame for the Distribution tab (its histogram, its percentile curve, the curve's lows) and two walks for the Frametime chart — for tabs not even shown. The series is ready 0.85 s after the click either way; the window answers meanwhile now |
| A session ends after 20 visits to the Dashboard | 46–60 ms, **20 notices** | 18 ms, 1 notice | every Dashboard ever opened stayed alive (a transient `IDisposable` the root container keeps) and subscribed: each reloaded its lists and raised FR-3.8's notice |
| Open the library (48 games) | 265–404 ms | 275 ms | not fixed — below |
| Open a game with 9 sessions | 148–203 ms | 210 ms | building ≈ 1,750 visuals, the grid's 9 rows ≈ 130 each |
| Open Compare | 66–82 ms | 87 ms | building its visuals |
| Open Settings | 75–99 ms | 85 ms | building its visuals |
| Open the Dashboard | 48–61 ms | 46 ms | — |
| Open Logs | 16–23 ms | 23 ms | — |
| Switch a game page's tab (Frametime, Distribution, Trend, Sensors, Latency, back) | 1–25 ms | 1–24 ms | already cheap: a hidden tab is not in the visual tree, and its plot renders once when shown |
Also changed, and held by tests rather than by these numbers: the game page asks whether its executable is on disk off
the UI thread (a USB drive that sleeps answered on it — 39 of the owner's 41 Steam games are on one); the Logs page's
two-second tick reads nothing when the newest file has not changed (it re-read up to 2 MB and replaced the whole text);
Play reads the stores' records on the thread pool (every press listed Steam's manifests and copied itch's database on
the UI thread); the game page no longer summarises every game's sessions to show one.
**Above the bar, and not fixed.** A page that builds 600–2,500 visuals costs 85–370 ms whatever it reads — about 0.1 ms a
visual on this PC — and the remaining cost of the game page is its grid's rows (≈ 130 visuals each). The library is the
one that grows with the data: 275 ms at 48 games, about 5.7 ms a card, so about 0.6 s at 100. Its grid is a
non-virtualizing panel by decision (beta.11, `Controls/UniformWrapPanel`: cards an equal share of the width, each row as
tall as its tallest card); a virtualizing one builds only the cards on screen but makes every card one height and the
grid scroll under a fixed header — a change to how the page looks, offered to the owner instead of made here. Nor was a
schema migration added for an index on `sessions.started_at` (the Dashboard sorts the table): at the owner's 41 sessions
it costs nothing measurable, and a new schema version locks the ledger out of every earlier build.
+5 -2
View File
@@ -11,7 +11,9 @@ nothing is uploaded. The only network requests are the update check and the upda
Your game library; your sessions — frame times when a game was measured, the statistics, your PC's sensors, the game's
own memory use, how the game's window was shown; a short description of your hardware for each session; your tags and
notes; your settings. The [Privacy Policy](../legal/PRIVACY_POLICY.md) lists all of it.
notes; your settings; and, in the `covers` folder, a copy of each picture you chose for a game. The pictures the Steam and
GOG GALAXY apps keep for your games are shown from where those apps keep them, never copied. The
[Privacy Policy](../legal/PRIVACY_POLICY.md) lists all of it.
## How much is kept
@@ -21,7 +23,8 @@ in **Settings ▸ Recording ▸ Raw series kept per game** (0 keeps everything).
## Back it up
**Tools ▸ Database maintenance… ▸ Back up…** writes a consistent copy of the database to a file you choose, even while
a game is being recorded. Backing up is up to you — FrameLedger does not do it by itself.
a game is being recorded. The pictures you chose for games are not in it: copy the data folder's `covers` folder too.
Backing up is up to you — FrameLedger does not do it by itself.
## Delete it
+6 -3
View File
@@ -70,9 +70,12 @@ stopped, hooking turned off — each with one button that only says you have rea
## A game's page
- **At the top:** the name, publisher, version, store and engine, the `.exe` path, the last session, the last measured
session's frame rate and its ray-tracing chips. **Play** starts the game: through the store that installed it, or
directly — **Settings ▸ Games ▸ Play button** chooses. **Edit…** changes the name, publisher, version and notes. **Change
- **At the top:** the game's picture — a banner and its cover, from the Steam or GOG GALAXY app on your PC or the image
you chose — in a band that takes the picture's colour; then the name, publisher, version, store and engine, the `.exe`
path, the last session, the last measured session's frame rate and its ray-tracing chips. A game with no picture shows
none (**Settings ▸ Games** turns the picture and its colour off). **Play** starts the game: through the store that
installed it, or directly — **Settings ▸ Games ▸ Play button** chooses. **Edit…** changes the name, publisher, version
and notes, and the picture: **Choose image…** (kept as a copy once you save) or **Use the store's image**. **Change
executable…** points the entry at another `.exe` and turns hooking back off; its file dialog opens in the game's own
folder. **Remove…** asks whether to keep the game's sessions.
- **Recording** — off, FrameLedger ignores the program completely: for a launcher or a tool that is not a game.
+2
View File
@@ -48,6 +48,8 @@ The link under them, *Read what the hook does and does not do*, opens the safety
| Setting | What it does | Default |
|---|---|---|
| **Show game artwork** | A game's page shows a picture of the game: the image you chose for it (**Edit…**), or else the cover and banner the Steam or GOG GALAXY app already keeps on your PC. Nothing is downloaded; a game from another store shows a picture only once you choose one. | On |
| **Colour the game page from its artwork** | The band at the top of a game's page takes the picture's main colour — never so strongly that a text on it gets hard to read. Off, the band keeps the plain card colour. | On |
| **Play button** | What **Play** does, on a game's page and on each game in the library. *Through the store*: Steam or the Epic Games Launcher starts the game, GOG GALAXY runs it, and the itch app asks which copy to launch — each store's app does what it does when you start a game from it. A game no store installed, and a GOG game without GOG GALAXY, is started by FrameLedger instead; so is every game while FrameLedger itself runs as administrator, so that the game does not. *Start directly*: FrameLedger's agent starts the game, recorded from its first frame, with your standard rights; it does not start a game whose recording is off, or one that asks to run as administrator. | Through the store |
## Window
+2 -2
View File
@@ -11,8 +11,8 @@
that changes what FrameLedger.Overlay or the capture host does; date the change.
HTML comments are not part of the block.
-->
> ⚠ **What FrameLedger actually measures today — 2026-10-06.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.20`** (2026-10-12), an unsigned installer built from that tag with its
> ⚠ **What FrameLedger actually measures today — 2026-10-13.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.22`** (2026-10-13), an unsigned installer built from that tag with its
> checksums published beside it. The source holds the desktop app
> (library, store import, charts, settings) and the background Agent, which records a session when a
> game in the library runs (unless you switched its recording off), injects only into games you enabled
+2 -2
View File
@@ -113,8 +113,8 @@ Software running inside another process can, in principle, destabilize it. Frame
Frame timing is derived from high-resolution timestamps taken at the moment the game presents each frame; upscaling, frame-generation and ray-tracing state are read from the parameters the game passes to those APIs. This is substantially more accurate than inferring settings from files on disk, but **no measurement is guaranteed to be exact**:
<!-- accuracy-block:begin -->
> ⚠ **What FrameLedger actually measures today — 2026-10-06.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.20`** (2026-10-12), an unsigned installer built from that tag with its
> ⚠ **What FrameLedger actually measures today — 2026-10-13.** The software is a beta; its latest
> **pre-release is `0.1.0-beta.22`** (2026-10-13), an unsigned installer built from that tag with its
> checksums published beside it. The source holds the desktop app
> (library, store import, charts, settings) and the background Agent, which records a session when a
> game in the library runs (unless you switched its recording off), injects only into games you enabled
+3 -2
View File
@@ -1,6 +1,6 @@
# FrameLedger — Privacy Policy
**Version:** 2.10 · **Effective:** {{RELEASE_DATE}}
**Version:** 2.11 · **Effective:** {{RELEASE_DATE}}
**Short version: everything stays on your PC. FrameLedger has no accounts, no telemetry, no analytics, and never uploads your data anywhere.**
@@ -9,6 +9,7 @@
Stored in `%LOCALAPPDATA%\FrameLedger` on your device:
- Your game library entries (names, executable paths, metadata you or the app filled in, and whether each one is recorded).
- Images you choose for a game (Edit…), copied into the `covers` folder; choosing the store's image again, or removing the game together with its sessions, deletes the copy. Artwork a store's app keeps on your PC is shown from where it is and not copied.
- Performance sessions: frame timing series, computed statistics, hardware sensor series (temperatures, load, power, memory usage, and the graphics card's clock speeds, fan speed, memory temperature and whether its power limit or heat held it back), the game's own memory use (its dedicated and shared video memory, private working set, working set and commit, once a second), session duration, crash flags, the graphics driver's settings the game ran under (NVIDIA only), how the game's window was shown (full-screen, borderless or windowed, for how long, its size and the monitor's), tags and notes you write.
- A hardware snapshot per session (CPU/GPU model, driver version, RAM size, OS build, display mode) used for the "what changed between sessions" feature.
- App settings, logs (rotated daily — the app keeps 7 days, the capture agent 14 — including the logs written by the component loaded into games), and, after a crash of the app itself, crash dump files.
@@ -41,7 +42,7 @@ An exported session (CSV or JSON) and a bug report can contain your games' names
## 4. What the app can technically observe
To do its job, FrameLedger observes: which of *your tracked* executables — the entries in your library whose recording is on — are running, and their process trees; the parameters your games pass to the graphics APIs it intercepts (presentation, upscaling, ray tracing, pipeline creation); the memory use of a tracked game's process — its dedicated and shared video memory, from Windows' GPU performance counters, and its working sets and commit, from Windows' process-memory information, for which a game it does not inject into is opened with the least access Windows offers and closed again (never its memory's content); loaded module names of a game being captured (for detection and for the anti-cheat safety check); the names of the files in each library game's install folder, the version information of its executable and of the upscaling libraries it ships, the content of its executable file (the markers of the engine and of the graphics libraries it carries, the libraries it imports, and the engine build name an Unreal Engine game carries), the version marks an engine keeps in its own files (Unity's player library and the header of its data file, the header of a Godot data pack, an RPG Maker game's title, core script and Game.ini, the library Game.ini names, and the version file of a Ren'Py game's engine), and the store files that name it (Steam's and GOG's, on your disk) — to detect its engine, its engine version and its features and to check it for anti-cheat before any injection is possible; the lists of installed games that the Steam, GOG GALAXY, Epic Games and itch apps keep on your disk, and where GOG GALAXY is installed — read when you import your library and when you press Play, to find the store that installed a game and hand the game to that store's app; the size, position and state of a tracked game's window and the monitor it is on, read from Windows and not from the game, and — for a game FrameLedger injects into — whether the game asked for exclusive full-screen; the NVIDIA driver's settings for your tracked executables (read only: the DLSS and frame-generation overrides the NVIDIA App set); hardware sensor values from your graphics driver's own libraries; how busy the processor is and how much memory is in use, from Windows' own counters; the crash reports Windows keeps in its Application log about a tracked game's executable while it ran (to tell a crash from an ordinary exit — the reports are read, never sent anywhere); and the names of the programs a tracked game starts, so that a game's own crash reporter is recognised.
To do its job, FrameLedger observes: which of *your tracked* executables — the entries in your library whose recording is on — are running, and their process trees; the parameters your games pass to the graphics APIs it intercepts (presentation, upscaling, ray tracing, pipeline creation); the memory use of a tracked game's process — its dedicated and shared video memory, from Windows' GPU performance counters, and its working sets and commit, from Windows' process-memory information, for which a game it does not inject into is opened with the least access Windows offers and closed again (never its memory's content); loaded module names of a game being captured (for detection and for the anti-cheat safety check); the names of the files in each library game's install folder, the version information of its executable and of the upscaling libraries it ships, the content of its executable file (the markers of the engine and of the graphics libraries it carries, the libraries it imports, and the engine build name an Unreal Engine game carries), the version marks an engine keeps in its own files (Unity's player library and the header of its data file, the header of a Godot data pack, an RPG Maker game's title, core script and Game.ini, the library Game.ini names, and the version file of a Ren'Py game's engine), and the store files that name it (Steam's and GOG's, on your disk) — to detect its engine, its engine version and its features and to check it for anti-cheat before any injection is possible; the lists of installed games that the Steam, GOG GALAXY, Epic Games and itch apps keep on your disk, and where GOG GALAXY is installed — read when you import your library and when you press Play, to find the store that installed a game and hand the game to that store's app — Steam's and GOG GALAXY's also when you open a game's page, to find the artwork their apps keep for it; the cover and banner images that the Steam and GOG GALAXY apps keep on your disk for a game in your library — read to show them on its page, never copied or sent anywhere; the size, position and state of a tracked game's window and the monitor it is on, read from Windows and not from the game, and — for a game FrameLedger injects into — whether the game asked for exclusive full-screen; the NVIDIA driver's settings for your tracked executables (read only: the DLSS and frame-generation overrides the NVIDIA App set); hardware sensor values from your graphics driver's own libraries; how busy the processor is and how much memory is in use, from Windows' own counters; the crash reports Windows keeps in its Application log about a tracked game's executable while it ran (to tell a crash from an ordinary exit — the reports are read, never sent anywhere); and the names of the programs a tracked game starts, so that a game's own crash reporter is recognised.
It does **not** read game memory outside those API parameters, and does not read game saves, chat, input content, network traffic, or anything unrelated to performance measurement. It records only for programs you added to your library and did not switch recording off for — a program whose recording is off is not watched at all — and injects only into games you individually enabled.
+1 -1
View File
@@ -92,7 +92,7 @@ Any proposal to add a vendor SDK must first pass the checklist in `docs/18_GPU_V
|---|---|---|
| **PawnIO** | Optional kernel driver required by LibreHardwareMonitor for CPU/motherboard sensors; installed separately by the user from <https://pawnio.eu/> | Its own license and signing; not distributed by FrameLedger |
| Windows ETW, DXGI, Event Log | OS facilities | Microsoft Windows license |
| Steam / GOG Galaxy / Epic Games Launcher / itch.io | Local manifest files read for library import | Respective platform terms; read-only local access |
| Steam / GOG Galaxy / Epic Games Launcher / itch.io | Local manifest files read for library import and Play; the artwork the Steam and GOG Galaxy apps keep on disk, shown on a game's page (beta.23) | Respective platform terms; read-only local access, nothing copied or downloaded |
## Trademarks
+3
View File
@@ -27,6 +27,9 @@ companies, by any game's developer or publisher, or by any anti-cheat vendor, an
into a game protected by them; the list says nothing else about them.
- The games named in `docs/LIST_GAME_TESTED.md` are games the developer ran FrameLedger with, on one machine; the list is
not a benchmark claim and not a recommendation.
- **A game's artwork belongs to its owners.** FrameLedger ships none and downloads none: a game's page shows the image you
chose for it, or the cover and banner the Steam or GOG GALAXY app already keeps on your PC, read from where that app
keeps it and never copied (since 0.1.0-beta.23).
## The name FrameLedger
+50 -4
View File
@@ -13,6 +13,7 @@ using FrameLedger.Application.Import;
using FrameLedger.Application.Persistence;
using FrameLedger.Application.Settings;
using FrameLedger.Application.Watch;
using FrameLedger.Infrastructure.Art;
using FrameLedger.Infrastructure.Diagnostics;
using FrameLedger.Infrastructure.Import;
using FrameLedger.Infrastructure.Persistence;
@@ -112,10 +113,7 @@ public partial class App : System.Windows.Application
Log.Information("ui: started ({Version}), ledger {Ledger}", UiIdentity.Version, UiPaths.Database);
// beta.21: tier 0 is software rendering (a VM without a GPU, Remote Desktop) - every scroll drawn on the CPU.
Log.Information("ui: render tier {Tier} (2 = the GPU draws; 0 = software)", System.Windows.Media.RenderCapability.Tier >> 16);
if (UiPaths.IsViewer)
{
Log.Warning("ui: a VIEWER over {Folder} (--data-dir, D52): no Agent is started or contacted, nothing on this PC is changed", UiPaths.DataDirectory);
}
NoteTheFolder(_host);
// A second start of the App hands over to this one: bring the window forward, from the tray too.
if (Instance is not null)
@@ -209,6 +207,41 @@ public partial class App : System.Windows.Application
Shutdown(exitCode);
}
/// <summary>
/// A viewer says what it is (D52); the App over its own folder tidies its covers (beta.23, D60) — the images no row names
/// any more, a game deleted or removed by the agent (D55) — in the background.
/// </summary>
private static void NoteTheFolder(IHost host)
{
if (UiPaths.IsViewer)
{
Log.Warning("ui: a VIEWER over {Folder} (--data-dir, D52): no Agent is started or contacted, nothing on this PC is changed", UiPaths.DataDirectory);
return;
}
_ = PruneCoversAsync(host.Services.GetRequiredService<CoverStore>());
}
/// <summary>
/// beta.23 (D60): deletes the chosen images no row names any more, on the thread pool; a failure is logged and nothing
/// else — the images are a convenience, never a reason for the App to stop.
/// </summary>
private static async Task PruneCoversAsync(CoverStore covers)
{
try
{
int deleted = await Task.Run(() => covers.PruneAsync()).ConfigureAwait(false);
if (deleted > 0)
{
Log.Information("art: {Count} image(s) no game names any more deleted from {Folder}", deleted, covers.Folder);
}
}
catch (Exception ex) when (ex is not OutOfMemoryException)
{
Log.Warning(ex, "art: the covers folder could not be tidied");
}
}
/// <summary>
/// Waits for a stop request ON the dispatcher, and stops nothing: <see cref="TearDownAsync"/> stops the host once,
/// from the UI thread. <c>WaitForShutdownAsync</c> resumed on the thread pool (it awaits with
@@ -440,6 +473,19 @@ public partial class App : System.Windows.Application
// beta.11: the Games page on screen reloads when an import adds games (navigating to itself does nothing).
services.AddSingleton<LibraryChanges>();
services.AddSingleton<ImportLibraryFlow>();
// beta.23 (owner decisions D60/D61): a game's artwork — the image the user chose (kept in the data folder's covers),
// else what the Steam and GOG GALAXY apps keep on this PC, found through the same store records Play reads.
services.AddSingleton<Application.Art.IStoreArtCache>(static _ => new SteamArtCache());
services.AddSingleton<Application.Art.IStoreArtCache>(static _ => new GogArtCache());
services.AddSingleton(static sp => new StoreRecordsReader(sp.GetServices<IStoreLibrarySource>()));
services.AddSingleton(static sp => new GameArt(
sp.GetRequiredService<Application.Settings.RegisteredSettings>(),
sp.GetRequiredService<StoreRecordsReader>(),
sp.GetServices<Application.Art.IStoreArtCache>(),
sp.GetRequiredService<UiMode>()));
services.AddSingleton(static sp => new CoverStore(sp.GetRequiredService<UiMode>(), sp.GetRequiredService<IGameRepository>()));
services.AddSingleton<IImagePicker, ImagePicker>();
}
/// <summary><c>10_LOGGING</c> §Serilog configuration: <c>logs/ui-.log</c>, daily, 7 kept, 10 MB, the one template; the level follows <c>log.debug</c> at runtime.</summary>
@@ -18,7 +18,6 @@ namespace FrameLedger.App.Charts;
[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1863:Use 'CompositeFormat'", Justification = "the format strings are resources that follow the UI culture, which changes at runtime")]
public partial class DistributionChart : UserControl
{
private const int _bins = 60;
public DistributionChart()
{
@@ -51,7 +50,8 @@ public partial class DistributionChart : UserControl
int outside = 0;
if (series is { AppFrameTimesMs.Length: > 1 })
{
FpsHistogram histogram = FpsHistogram.Of(series.AppFrameTimesMs, _bins);
// beta.23: the decoded series carries it, worked out off the UI thread (SeriesDigest).
FpsHistogram histogram = series.Digest?.Histogram ?? FpsHistogram.OfSorted(SeriesDigest.SortedOf(series), SeriesDigest.HistogramBins);
if (histogram.Centers.Length > 0)
{
BarPlot bars = plot.Add.Bars(histogram.Centers, histogram.Counts);
@@ -80,7 +80,8 @@ public partial class DistributionChart : UserControl
plot.YLabel(Strings.Chart_Axis_Fps);
if (series is { AppFrameTimesMs.Length: > 1 })
{
(double[] xs, double[] ys) = PercentileCurve.Of(series.AppFrameTimesMs);
IReadOnlyList<double>? sorted = series.Digest is null ? SeriesDigest.SortedOf(series) : null;
(double[] xs, double[] ys) = series.Digest?.Percentiles ?? PercentileCurve.OfSorted(sorted!);
if (xs.Length > 0)
{
Scatter line = plot.Add.ScatterLine(xs, ys, ChartTheme.Current.Percentile);
@@ -88,7 +89,7 @@ public partial class DistributionChart : UserControl
line.LegendText = Strings.Chart_Series_Percentile;
}
foreach ((double x, double fps, bool pointOne) in PercentileCurve.Lows(series.AppFrameTimesMs))
foreach ((double x, double fps, bool pointOne) in series.Digest?.Lows ?? PercentileCurve.LowsOfSorted(sorted!))
{
Scatter low = plot.Add.ScatterPoints(new[] { x }, new[] { fps }, ChartTheme.Current.Stutter);
low.MarkerSize = 7;
+32 -4
View File
@@ -23,24 +23,52 @@ public sealed record FpsHistogram(double[] Centers, double[] Counts, double BinW
ArgumentNullException.ThrowIfNull(appFrameTimesMs);
ArgumentOutOfRangeException.ThrowIfNegativeOrZero(bins);
double[] fps = [.. appFrameTimesMs.Where(static f => f > 0).Select(static f => 1000.0 / f)];
if (fps.Length == 0)
return FromSortedRates(Percentile.Sorted(fps), bins);
}
/// <summary>
/// <see cref="Of"/> over frame times already sorted ascending (beta.23, <see cref="SeriesDigest"/>): the positive ones are
/// the tail, and their rates read backwards ascend — the same rates <see cref="Of"/> sorts, without a sort of its own.
/// </summary>
public static FpsHistogram OfSorted(IReadOnlyList<double> sortedAppFrameTimesMs, int bins = 60)
{
ArgumentNullException.ThrowIfNull(sortedAppFrameTimesMs);
ArgumentOutOfRangeException.ThrowIfNegativeOrZero(bins);
int count = sortedAppFrameTimesMs.Count;
int first = 0;
while (first < count && !(sortedAppFrameTimesMs[first] > 0))
{
first++;
}
var fps = new double[count - first];
for (int i = 0; i < fps.Length; i++)
{
fps[i] = 1000.0 / sortedAppFrameTimesMs[count - 1 - i];
}
return FromSortedRates(fps, bins);
}
private static FpsHistogram FromSortedRates(IReadOnlyList<double> sorted, int bins)
{
if (sorted.Count == 0)
{
return new FpsHistogram([], [], 0, 0);
}
IReadOnlyList<double> sorted = Percentile.Sorted(fps);
double lo = Percentile.Linear(sorted, TailFraction) ?? sorted[0];
double hi = Percentile.Linear(sorted, 1 - TailFraction) ?? sorted[^1];
if (hi - lo < 1e-9)
{
// Every frame at one rate: one bar, a frame per second wide, centred on it.
return new FpsHistogram([lo], [fps.Length], 1, 0);
return new FpsHistogram([lo], [sorted.Count], 1, 0);
}
double width = (hi - lo) / bins;
var counts = new double[bins];
int outside = 0;
foreach (double v in fps)
foreach (double v in sorted)
{
if (v < lo || v > hi)
{
@@ -82,7 +82,7 @@ public partial class FrametimeChart : UserControl
lines.Add(Strings.Chart_Note_PresentsTiming);
}
int gaps = series.Gap.Skip(1).Count(static g => g);
int gaps = series.Digest?.GapsAfterFirst ?? series.Gap.Skip(1).Count(static g => g);
if (sensors && series.SensorsAligned && gaps > 0)
{
lines.Add(string.Format(CultureInfo.CurrentCulture, Strings.Chart_Note_GapsClosed_Format, gaps));
@@ -128,9 +128,9 @@ public partial class FrametimeChart : UserControl
Plot.Refresh();
}
private void DrawSeries(ScottPlot.Plot plot, IReadOnlyList<double> xs, IReadOnlyList<double> ys, Color color, string label)
private void DrawSeries(ScottPlot.Plot plot, double[] xs, double[] ys, Color color, string label)
{
if (xs.Count == 0)
if (xs.Length == 0)
{
return;
}
@@ -145,17 +145,8 @@ public partial class FrametimeChart : UserControl
/// <summary>Every present but those after a gap, whose stored interval is 0 — not a frame, and it was drawn as a 0 ms one.</summary>
private void DrawPresents(ScottPlot.Plot plot, ChartPalette p)
{
var xs = new List<double>(_series!.Presents);
var ys = new List<double>(_series.Presents);
for (int i = 0; i < _series.Presents; i++)
{
if (!_series.Gap[i])
{
xs.Add(_series.TimesS[i]);
ys.Add(_series.FrameTimesMs[i]);
}
}
// beta.23: the decoded series carries the line (SeriesDigest), so the Displayed toggle no longer walks every present.
(double[] xs, double[] ys) = _series!.Digest?.Presents ?? SeriesDigest.PresentsWithoutGaps(_series.TimesS, _series.FrameTimesMs, _series.Gap);
DrawSeries(plot, xs, ys, p.Displayed, Strings.Chart_Series_Displayed);
}
+15 -3
View File
@@ -24,12 +24,18 @@ public static class PercentileCurve
public static (double[] Xs, double[] Ys) Of(IReadOnlyList<double> appFrameTimesMs)
{
ArgumentNullException.ThrowIfNull(appFrameTimesMs);
if (appFrameTimesMs.Count < 2)
return appFrameTimesMs.Count < 2 ? ([], []) : OfSorted(Percentile.Sorted(appFrameTimesMs));
}
/// <summary><see cref="Of"/> over frame times already sorted ascending (beta.23, <see cref="SeriesDigest"/>).</summary>
public static (double[] Xs, double[] Ys) OfSorted(IReadOnlyList<double> sorted)
{
ArgumentNullException.ThrowIfNull(sorted);
if (sorted.Count < 2)
{
return ([], []);
}
IReadOnlyList<double> sorted = Percentile.Sorted(appFrameTimesMs);
var xs = new List<double>(103);
var ys = new List<double>(103);
foreach (double p in Percents())
@@ -48,7 +54,13 @@ public static class PercentileCurve
public static IReadOnlyList<(double X, double Fps, bool PointOne)> Lows(IReadOnlyList<double> appFrameTimesMs)
{
ArgumentNullException.ThrowIfNull(appFrameTimesMs);
IReadOnlyList<double> sorted = Percentile.Sorted(appFrameTimesMs);
return LowsOfSorted(Percentile.Sorted(appFrameTimesMs));
}
/// <summary><see cref="Lows"/> over frame times already sorted ascending (beta.23, <see cref="SeriesDigest"/>).</summary>
public static IReadOnlyList<(double X, double Fps, bool PointOne)> LowsOfSorted(IReadOnlyList<double> sorted)
{
ArgumentNullException.ThrowIfNull(sorted);
var lows = new List<(double, double, bool)>(2);
if (Supported(sorted.Count, 99) && Fps(sorted, 99) is double p1)
{
+107
View File
@@ -0,0 +1,107 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using FrameLedger.Domain.Metrics;
namespace FrameLedger.App.Charts;
/// <summary>
/// What the charts derive from a whole session, worked out ONCE where the series is decoded — off the UI thread since
/// beta.23 (<see cref="SessionSeriesLoader.LoadAsync"/>) — instead of on every draw. Measured on 2026-10-14 over a
/// two-million-frame session: selecting it froze the window for 0.8–1.0 s, most of it the Distribution tab sorting every
/// application frame three times (its histogram, its percentile curve and the curve's lows each sorted their own copy) and
/// the Frametime chart counting gaps and copying the presents line, all on the UI thread and for tabs not even shown
/// (<c>spike-notes</c> §21). A series a test builds by hand has none: each chart then computes what it needs itself.
/// </summary>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1819:Properties should not return arrays", Justification = "a data carrier for ScottPlot, which draws double[]")]
public sealed record SeriesDigest
{
/// <summary>The bins of <see cref="Histogram"/> — the Distribution tab's.</summary>
public const int HistogramBins = 60;
/// <summary>The application frames' times, ms, ascending.</summary>
public required double[] SortedAppFrameTimesMs { get; init; }
/// <summary><see cref="FpsHistogram.Of"/> over the application frames, at <see cref="HistogramBins"/>.</summary>
public required FpsHistogram Histogram { get; init; }
/// <summary><see cref="PercentileCurve.Of"/> over the application frames.</summary>
public required (double[] Xs, double[] Ys) Percentiles { get; init; }
/// <summary><see cref="PercentileCurve.Lows"/> over the application frames.</summary>
public required IReadOnlyList<(double X, double Fps, bool PointOne)> Lows { get; init; }
/// <summary>How many presents after the first follow a gap.</summary>
public required int GapsAfterFirst { get; init; }
/// <summary>How many presents were generated.</summary>
public required int GeneratedCount { get; init; }
/// <summary>Every present's time and interval but those after a gap — the Frametime chart's presents line; null when nothing was generated, where it is never drawn.</summary>
public (double[] TimesS, double[] FrameTimesMs)? Presents { get; init; }
/// <summary>The digest of a decoded series' arrays.</summary>
public static SeriesDigest Of(double[] appFrameTimesMs, double[] timesS, float[] frameTimesMs, bool[] generated, bool[] gap, bool noApplicationFrames)
{
ArgumentNullException.ThrowIfNull(appFrameTimesMs);
ArgumentNullException.ThrowIfNull(timesS);
ArgumentNullException.ThrowIfNull(frameTimesMs);
ArgumentNullException.ThrowIfNull(generated);
ArgumentNullException.ThrowIfNull(gap);
double[] sorted = (double[])appFrameTimesMs.Clone();
Array.Sort(sorted);
int gaps = 0;
int generatedCount = 0;
for (int i = 0; i < gap.Length; i++)
{
if (i > 0 && gap[i])
{
gaps++;
}
if (i < generated.Length && generated[i])
{
generatedCount++;
}
}
return new SeriesDigest
{
SortedAppFrameTimesMs = sorted,
Histogram = FpsHistogram.OfSorted(sorted, HistogramBins),
Percentiles = PercentileCurve.OfSorted(sorted),
Lows = PercentileCurve.LowsOfSorted(sorted),
GapsAfterFirst = gaps,
GeneratedCount = generatedCount,
Presents = generatedCount > 0 && !noApplicationFrames ? PresentsWithoutGaps(timesS, frameTimesMs, gap) : null,
};
}
/// <summary>Every present but those after a gap, whose stored interval is 0 — not a frame.</summary>
internal static (double[] TimesS, double[] FrameTimesMs) PresentsWithoutGaps(double[] timesS, float[] frameTimesMs, bool[] gap)
{
ArgumentNullException.ThrowIfNull(timesS);
ArgumentNullException.ThrowIfNull(frameTimesMs);
ArgumentNullException.ThrowIfNull(gap);
int n = Math.Min(timesS.Length, Math.Min(frameTimesMs.Length, gap.Length));
var xs = new List<double>(n);
var ys = new List<double>(n);
for (int i = 0; i < n; i++)
{
if (!gap[i])
{
xs.Add(timesS[i]);
ys.Add(frameTimesMs[i]);
}
}
return ([.. xs], [.. ys]);
}
/// <summary>The ascending application frame times of <paramref name="series"/>: its digest's, or sorted now for a series without one.</summary>
internal static IReadOnlyList<double> SortedOf(SessionSeries series)
{
ArgumentNullException.ThrowIfNull(series);
return series.Digest?.SortedAppFrameTimesMs ?? Percentile.Sorted(series.AppFrameTimesMs);
}
}
+7 -1
View File
@@ -81,9 +81,15 @@ public sealed record SessionSeries
/// </summary>
public bool SensorsAligned { get; init; }
/// <summary>
/// What the charts derive from the whole session, worked out where it was decoded (beta.23); null on a series built by
/// hand, whose charts compute it themselves.
/// </summary>
public SeriesDigest? Digest { get; init; }
public int Presents => TimesS.Length;
public bool HasGenerated => Generated.Any(static g => g);
public bool HasGenerated => Digest is { } digest ? digest.GeneratedCount > 0 : Generated.Any(static g => g);
public double DurationS => TimesS.Length == 0 ? 0 : TimesS[^1];
@@ -21,7 +21,23 @@ public sealed class SessionSeriesLoader
public SessionSeriesLoader(ISessionRepository sessions) => _sessions = sessions ?? throw new ArgumentNullException(nameof(sessions));
public async Task<SessionSeries?> LoadAsync(long sessionId, CancellationToken ct = default)
/// <summary>
/// The session's series, read and decoded on the thread pool (beta.23). Microsoft.Data.Sqlite runs its asynchronous
/// methods synchronously, so before this the blob read, the decode and the stutter detection of a two-million-frame
/// session all ran on the UI thread of whoever asked — the game page, a session's summary, Compare, an export — whatever
/// <c>ConfigureAwait</c> said (<c>spike-notes</c> §21).
/// </summary>
public Task<SessionSeries?> LoadAsync(long sessionId, CancellationToken ct = default) => Task.Run(() => ReadAndDecodeAsync(sessionId, ct), ct);
/// <summary>
/// The sensor series alone, timed from the session's start — what a session that was not hooked has to chart (beta.8: the
/// Tier-2 row has kept its sensors since 2026-09-22, and no chart read them). Empty when none were recorded. On the
/// thread pool, as <see cref="LoadAsync"/>.
/// </summary>
public Task<IReadOnlyList<SensorSeries>> LoadSensorsAsync(long sessionId, CancellationToken ct = default) =>
Task.Run(async () => (IReadOnlyList<SensorSeries>)DecodeSensors(await _sessions.FindSensorsAsync(sessionId, ct).ConfigureAwait(false), offsetS: 0), ct);
private async Task<SessionSeries?> ReadAndDecodeAsync(long sessionId, CancellationToken ct)
{
FrameBlobs? frames = await _sessions.FindFramesAsync(sessionId, ct).ConfigureAwait(false);
if (frames is null || !string.Equals(frames.Codec, SeriesCodec.Tag, StringComparison.Ordinal))
@@ -34,13 +50,6 @@ public sealed class SessionSeriesLoader
return Decode(frames, segments, sensors);
}
/// <summary>
/// The sensor series alone, timed from the session's start — what a session that was not hooked has to chart (beta.8: the
/// Tier-2 row has kept its sensors since 2026-09-22, and no chart read them). Empty when none were recorded.
/// </summary>
public async Task<IReadOnlyList<SensorSeries>> LoadSensorsAsync(long sessionId, CancellationToken ct = default) =>
DecodeSensors(await _sessions.FindSensorsAsync(sessionId, ct).ConfigureAwait(false), offsetS: 0);
public static SessionSeries Decode(FrameBlobs frames, IReadOnlyList<SegmentRow> segments, IReadOnlyList<SensorBlob> sensors)
{
ArgumentNullException.ThrowIfNull(frames);
@@ -71,6 +80,7 @@ public sealed class SessionSeriesLoader
StutterResult? stutter = StutterDetector.Detect(appFrametimes);
uint[]? frameIndex = frames.FrameIndex is { } fi ? PickOptional(SeriesCodec.DecodeUInt32(fi.ToArray()), keep) : null;
double? offsetS = frames.FirstPresentMs / 1000.0;
double[] appFrameTimesMs = [.. appFrametimes];
return new SessionSeries
{
TimesS = times,
@@ -85,13 +95,14 @@ public sealed class SessionSeriesLoader
LatencyUs = frames.LatencyUs is { } lat ? PickOptional(SeriesCodec.DecodeUInt32(lat.ToArray()), keep) : null,
RenderRes = frames.RenderRes is { } rr ? PickQuads(SeriesCodec.DecodeUInt16(rr.ToArray()), keep) : null,
AppTimesS = [.. appIndex.Select(i => times[i])],
AppFrameTimesMs = [.. appFrametimes],
AppFrameTimesMs = appFrameTimesMs,
AppPresentIndex = [.. appIndex],
NoApplicationFrames = noApplicationFrames,
Stutter = stutter is null ? null : [.. stutter.IsStutter],
Segments = MapSegments([.. segments.Where(s => swapchain is null || s.SwapchainId == swapchain.Value)], times, frameIndex),
Sensors = DecodeSensors(sensors, offsetS ?? 0),
SensorsAligned = offsetS is not null,
Digest = SeriesDigest.Of(appFrameTimesMs, times, frametimes, generated, gap, noApplicationFrames),
};
}
+126
View File
@@ -0,0 +1,126 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using FrameLedger.App.Services;
namespace FrameLedger.App.Controls;
/// <summary>
/// The colour of the game page's artwork band (beta.23, owner decision D61), set on its <see cref="Border"/>: nothing at all
/// while the game shows no artwork — the page is as it was —, the card's own fill when it shows some untinted (the option is
/// off, the picture has no colour, the system's high-contrast mode is on), and otherwise the picture's dominant colour over
/// that fill at the strongest opacity (at most 30 % on a dark theme, 22 % on a light one) at which every text the header
/// shows still reads — primary and secondary text 4.5:1, tertiary 3:1, the pills' and the warning's text 4.5:1 on their
/// fills (<see cref="ColorMath.Tint"/>).
/// </summary>
/// <remarks>
/// The second colour the App works out rather than takes from the theme, after the chart palettes (<c>08_UI</c> §Contrast).
/// It follows a theme switch through a resource reference on the band itself — a private attached property bound to
/// <c>ApplicationBackgroundColor</c>, whose change recomputes it — never through <c>ApplicationThemeManager.Changed</c>:
/// only <c>ApplicationThemeManager.Apply</c> raises that, and the tests switch themes by replacing the theme dictionary.
/// </remarks>
public static class ArtTint
{
public static readonly DependencyProperty ShowsArtProperty = DependencyProperty.RegisterAttached(
"ShowsArt", typeof(bool), typeof(ArtTint), new PropertyMetadata(false, OnChanged));
public static readonly DependencyProperty ColorProperty = DependencyProperty.RegisterAttached(
"Color", typeof(Color?), typeof(ArtTint), new PropertyMetadata(null, OnChanged));
// The theme, heard through a resource reference on the band (set the first time either property above changes).
private static readonly DependencyProperty _themeProperty = DependencyProperty.RegisterAttached(
"Theme", typeof(object), typeof(ArtTint), new PropertyMetadata(null, OnChanged));
private static readonly string[] _keys = ["ApplicationBackgroundColor", "CardBackgroundFillColorDefault", "TextFillColorPrimary",
"TextFillColorSecondary", "TextFillColorTertiary", "ControlFillColorDefault", "SystemFillColorCautionBackground"];
/// <summary>The banner's fade into the band: opaque for its upper half, transparent at its foot — alpha only.</summary>
public static Brush Fade { get; } = CreateFade();
public static bool GetShowsArt(DependencyObject element) => (bool)(element ?? throw new ArgumentNullException(nameof(element))).GetValue(ShowsArtProperty);
public static void SetShowsArt(DependencyObject element, bool value) => (element ?? throw new ArgumentNullException(nameof(element))).SetValue(ShowsArtProperty, value);
public static Color? GetColor(DependencyObject element) => (Color?)(element ?? throw new ArgumentNullException(nameof(element))).GetValue(ColorProperty);
public static void SetColor(DependencyObject element, Color? value) => (element ?? throw new ArgumentNullException(nameof(element))).SetValue(ColorProperty, value);
/// <summary>The band's colour for the theme its resources hold now, or null for the card's own fill.</summary>
internal static Color? BandColour(FrameworkElement element, Color dominant)
{
ArgumentNullException.ThrowIfNull(element);
Color?[] c = [.. _keys.Select(k => ColourOf(element.TryFindResource(k)))];
if (c.Any(static x => x is null))
{
return null;
}
Color background = ColorMath.Over(c[1]!.Value, c[0]!.Value);
ColorMath.Pair[] pairs =
[
new(c[2]!.Value, null, 4.5),
new(c[3]!.Value, null, 4.5),
new(c[4]!.Value, null, 3.0),
new(c[3]!.Value, c[5], 4.5),
new(c[2]!.Value, c[6], 4.5),
];
// A dark theme's text is light: the band may take more colour before the light text stops reading.
bool dark = ColorMath.Luminance(background) < 0.18;
return ColorMath.Tint(background, dominant, pairs, dark ? 0.30 : 0.22);
}
private static void OnChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
if (d is not Border band)
{
return;
}
if (e.Property != _themeProperty && band.ReadLocalValue(_themeProperty) == DependencyProperty.UnsetValue)
{
band.SetResourceReference(_themeProperty, "ApplicationBackgroundColor");
}
Apply(band);
}
private static void Apply(Border band)
{
if (!GetShowsArt(band))
{
band.ClearValue(Border.BackgroundProperty);
return;
}
if (GetColor(band) is { } dominant && !SystemParameters.HighContrast && BandColour(band, dominant) is { } colour)
{
var brush = new SolidColorBrush(colour);
brush.Freeze();
band.Background = brush;
return;
}
band.SetResourceReference(Border.BackgroundProperty, "CardBackgroundFillColorDefaultBrush");
}
private static LinearGradientBrush CreateFade()
{
var fade = new LinearGradientBrush { StartPoint = new Point(0, 0), EndPoint = new Point(0, 1) };
fade.GradientStops.Add(new GradientStop(Color.FromArgb(255, 0, 0, 0), 0));
fade.GradientStops.Add(new GradientStop(Color.FromArgb(255, 0, 0, 0), 0.55));
fade.GradientStops.Add(new GradientStop(Color.FromArgb(0, 0, 0, 0), 1));
fade.Freeze();
return fade;
}
private static Color? ColourOf(object? resource) => resource switch
{
Color colour => colour,
SolidColorBrush brush => brush.Color,
_ => null,
};
}
@@ -46,5 +46,36 @@
<ui:TextBlock Style="{StaticResource SecondaryText}" Text="{x:Static vm:EditGameViewModel.NotesLabel}" />
<ui:TextBox Margin="0,4,0,0" MinHeight="72" AutomationProperties.Name="{x:Static vm:EditGameViewModel.NotesLabel}" AcceptsReturn="True" TextWrapping="Wrap" Text="{Binding Notes, UpdateSourceTrigger=PropertyChanged}" />
<!-- beta.23 (D60): the game's image — the user's own, copied on Save, or the store's; a preview here, nothing written before Save. -->
<StackPanel Margin="0,12,0,0" Visibility="{Binding ImageEditable, Converter={StaticResource BoolToVis}}">
<ui:TextBlock Style="{StaticResource SecondaryText}" Text="{x:Static vm:EditGameViewModel.ImageLabel}" />
<Grid Margin="0,4,0,0">
<Grid.ColumnDefinitions>
<ColumnDefinition Width="Auto" />
<ColumnDefinition Width="*" />
</Grid.ColumnDefinitions>
<Border Grid.Column="0" Width="64" Height="96" CornerRadius="4" Background="{DynamicResource ControlFillColorDefaultBrush}">
<Grid>
<ui:TextBlock HorizontalAlignment="Center" VerticalAlignment="Center" Style="{StaticResource TertiaryText}" FontTypography="Caption" TextAlignment="Center" TextWrapping="Wrap"
Text="{x:Static vm:EditGameViewModel.ImageNoneText}"
Visibility="{Binding HasImagePreview, Converter={StaticResource InverseBoolToVis}}" />
<ui:Image CornerRadius="4" Stretch="UniformToFill" Source="{Binding ImagePreview}" RenderOptions.BitmapScalingMode="HighQuality"
AutomationProperties.Name="{x:Static vm:EditGameViewModel.CoverName}"
Visibility="{Binding HasImagePreview, Converter={StaticResource BoolToVis}}" />
</Grid>
</Border>
<StackPanel Grid.Column="1" Margin="12,0,0,0" VerticalAlignment="Center">
<StackPanel Orientation="Horizontal">
<ui:Button Command="{Binding ChooseImageCommand}" Content="{x:Static vm:EditGameViewModel.ChooseImageText}" Icon="{ui:SymbolIcon Image24}" />
<ui:Button Margin="8,0,0,0" Appearance="Secondary" Command="{Binding UseStoreImageCommand}" Content="{x:Static vm:EditGameViewModel.UseStoreImageText}"
Visibility="{Binding CanUseStoreImage, Converter={StaticResource BoolToVis}}" />
</StackPanel>
<ui:TextBlock Margin="0,6,0,0" MaxWidth="300" HorizontalAlignment="Left" Style="{StaticResource TertiaryText}" TextWrapping="Wrap" Text="{x:Static vm:EditGameViewModel.ImageNote}" />
<ui:TextBlock Margin="0,4,0,0" MaxWidth="300" HorizontalAlignment="Left" Style="{StaticResource SecondaryText}" TextWrapping="Wrap" Text="{Binding ImageError}"
Visibility="{Binding ImageError, Converter={StaticResource NullToCollapsed}}" />
</StackPanel>
</Grid>
</StackPanel>
</StackPanel>
</UserControl>
+24
View File
@@ -1,8 +1,11 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.Diagnostics;
using System.Windows.Threading;
using FrameLedger.App.Services;
using FrameLedger.App.ViewModels;
using Serilog;
using Wpf.Ui;
using Wpf.Ui.Abstractions;
using Wpf.Ui.Controls;
@@ -48,6 +51,27 @@ public partial class MainWindow : FluentWindow
dialogs.SetDialogHost(DialogHost);
Loaded += (_, _) => theme.Apply(appearance.Theme, this);
TimeNavigations();
}
/// <summary>
/// beta.23 (<c>spike-notes</c> §21): how long each page takes to be on screen once WPF UI navigates to it — its layout,
/// its templates, its first render — logged at Debug (Settings ▸ Logging), so a slow page on a real PC says which it is.
/// </summary>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD001:Avoid legacy thread switching APIs", Justification = "a WPF application has no JoinableTaskFactory; this posts to the window's own dispatcher from its own thread, at the priority after rendering, and never waits (ScrollBarHiding does the same)")]
private void TimeNavigations()
{
long navigating = 0;
RootNavigation.Navigating += (_, _) => navigating = Stopwatch.GetTimestamp();
RootNavigation.Navigated += (_, e) =>
{
long from = navigating;
string page = e.Page?.GetType().Name ?? "?";
DispatcherOperation logged = Dispatcher.InvokeAsync(
() => Log.Debug("ui: page {Page} shown {Ms:0} ms after its navigation", page, Stopwatch.GetElapsedTime(from).TotalMilliseconds),
DispatcherPriority.ContextIdle);
GC.KeepAlive(logged);
};
}
public MainWindowViewModel ViewModel { get; }
@@ -13,6 +13,10 @@ public partial class DashboardPage : INavigableView<DashboardViewModel>
ViewModel = viewModel ?? throw new ArgumentNullException(nameof(viewModel));
DataContext = this;
InitializeComponent();
// beta.23: the view model hears the Agent while this page is on screen, never after (each visit makes a new one).
Loaded += (_, _) => ViewModel.Attach();
Unloaded += (_, _) => ViewModel.Detach();
}
public DashboardViewModel ViewModel { get; }
+66 -5
View File
@@ -25,13 +25,67 @@
Text="{x:Static vm:GameDetailViewModel.NotFoundText}"
Visibility="{Binding ViewModel.NotFound, Converter={StaticResource BoolToVis}}" />
<!-- header -->
<Grid Margin="0,8,0,0">
<!--
header. beta.23 (owner decisions D60/D61): the game's artwork — the image the user chose, else what Steam's or GOG
GALAXY's app keeps on this PC — as a banner above and a cover beside the name, in a band that takes the
artwork's colour as far as every text on it stays readable (Controls/ArtTint). No text is ever drawn on a
picture. A game with no artwork shows no band, and the header is as it was.
-->
<Border x:Name="ArtBand" Margin="0,8,0,0" CornerRadius="8"
controls:ArtTint.ShowsArt="{Binding ViewModel.HasArt}"
controls:ArtTint.Color="{Binding ViewModel.ArtTint}">
<Border.Style>
<Style TargetType="Border">
<Setter Property="Padding" Value="0" />
<Style.Triggers>
<DataTrigger Binding="{Binding ViewModel.HasArt}" Value="True">
<Setter Property="Padding" Value="0,0,0,16" />
</DataTrigger>
</Style.Triggers>
</Style>
</Border.Style>
<StackPanel>
<!-- The banner: as tall as its proportions make it at this width, no taller than 240, fading into the band (its mask is set in code). -->
<ui:Image x:Name="Hero" MaxHeight="240" CornerRadius="8,8,0,0" Stretch="UniformToFill" Source="{Binding ViewModel.ArtHero}" RenderOptions.BitmapScalingMode="HighQuality"
AutomationProperties.Name="{x:Static res:Strings.Art_Banner_Name}" ToolTip="{Binding ViewModel.ArtSource}"
Visibility="{Binding ViewModel.ArtHero, Converter={StaticResource NullToCollapsed}}" />
<Grid>
<Grid.Style>
<Style TargetType="Grid">
<Setter Property="Margin" Value="0" />
<Style.Triggers>
<DataTrigger Binding="{Binding ViewModel.HasArt}" Value="True">
<Setter Property="Margin" Value="16,16,16,0" />
</DataTrigger>
</Style.Triggers>
</Style>
</Grid.Style>
<Grid.ColumnDefinitions>
<ColumnDefinition Width="Auto" />
<ColumnDefinition Width="*" />
<ColumnDefinition Width="Auto" />
</Grid.ColumnDefinitions>
<StackPanel Grid.Column="0">
<!--
The cover: portrait, or the store's landscape header when it keeps no portrait. Its style is based on WPF UI's
DefaultImageStyle, which holds the template: a ui:Image with a Style of its own and no template draws nothing.
-->
<ui:Image Grid.Column="0" Margin="0,0,16,0" VerticalAlignment="Top" CornerRadius="6" Stretch="UniformToFill" Source="{Binding ViewModel.ArtCover}" RenderOptions.BitmapScalingMode="HighQuality"
AutomationProperties.Name="{x:Static res:Strings.Art_Cover_Name}" ToolTip="{Binding ViewModel.ArtSource}"
Visibility="{Binding ViewModel.ArtCover, Converter={StaticResource NullToCollapsed}}">
<ui:Image.Style>
<Style TargetType="ui:Image" BasedOn="{StaticResource DefaultImageStyle}">
<Setter Property="Width" Value="120" />
<Setter Property="Height" Value="180" />
<Style.Triggers>
<DataTrigger Binding="{Binding ViewModel.ArtCoverIsLandscape}" Value="True">
<Setter Property="Width" Value="230" />
<Setter Property="Height" Value="107" />
</DataTrigger>
</Style.Triggers>
</Style>
</ui:Image.Style>
</ui:Image>
<StackPanel Grid.Column="1">
<ui:TextBlock FontTypography="Title" Text="{Binding ViewModel.Name}" />
<ui:TextBlock Style="{StaticResource SecondaryText}" Text="{Binding ViewModel.Subtitle}" />
<ui:TextBlock Style="{StaticResource TertiaryText}" TextTrimming="CharacterEllipsis" Text="{Binding ViewModel.ExecutableText}" ToolTip="{Binding ViewModel.ExecutableText}" />
@@ -56,7 +110,7 @@
</ItemsControl.ItemTemplate>
</ItemsControl>
</StackPanel>
<StackPanel Grid.Column="1" Orientation="Horizontal" VerticalAlignment="Top">
<StackPanel Grid.Column="2" Orientation="Horizontal" VerticalAlignment="Top">
<!-- beta.21 (D59): Play, through the store that installed the game or started directly (Settings ▸ Games). -->
<ui:Button Margin="0,0,8,0" Appearance="Primary" Command="{Binding ViewModel.PlayCommand}" Content="{x:Static vm:GameDetailViewModel.PlayText}"
Icon="{ui:SymbolIcon Play24}" IsEnabled="{Binding ViewModel.ActsOnThisPc}" ToolTip="{Binding ViewModel.PlayToolTip}" />
@@ -65,6 +119,8 @@
<ui:Button Appearance="Danger" Command="{Binding ViewModel.RemoveCommand}" Content="{x:Static vm:GameDetailViewModel.RemoveText}" Icon="{ui:SymbolIcon Delete24}" />
</StackPanel>
</Grid>
</StackPanel>
</Border>
<!-- the two rows, clearly separated (05_DETECTION §Capability hints) -->
<Grid Margin="0,20,0,0">
@@ -239,7 +295,12 @@
Content="{x:Static vm:GameDetailViewModel.DeleteAllSessionsText}" Icon="{ui:SymbolIcon Delete24}"
IsEnabled="{Binding ViewModel.ActsOnThisPc}" />
</StackPanel>
<DataGrid x:Name="SessionsGrid" AutoGenerateColumns="False" CanUserAddRows="False" IsReadOnly="True" HeadersVisibility="Column"
<!--
beta.23: bounded, as Compare's list is, so the grid scrolls itself and builds only the rows on screen. Inside
the page's own scroller it was measured with no height limit and built every row — up to 500 rows of 17
columns; 1.2 s to open a game with 100 sessions (spike-notes §21).
-->
<DataGrid x:Name="SessionsGrid" MaxHeight="520" AutoGenerateColumns="False" CanUserAddRows="False" IsReadOnly="True" HeadersVisibility="Column"
ItemsSource="{Binding ViewModel.Sessions}" SelectionMode="Extended" MouseDoubleClick="OnSessionDoubleClick"
SelectedItem="{Binding ViewModel.SelectedSession, Mode=TwoWay}">
<DataGrid.Columns>
@@ -15,6 +15,9 @@ public partial class GameDetailPage : INavigableView<GameDetailViewModel>
ViewModel = viewModel ?? throw new ArgumentNullException(nameof(viewModel));
DataContext = this;
InitializeComponent();
// beta.23 (D60): the banner fades into the band below it — an alpha mask, set here because it is no theme colour.
Hero.OpacityMask = Controls.ArtTint.Fade;
ViewModel.SelectionPresented += OnSelectionPresented;
ViewModel.TrendPresented += OnTrendPresented;
Overview.SessionClicked += OnOverviewClicked;
@@ -316,6 +316,27 @@
SelectedValue="{Binding ViewModel.PlayMode, Mode=TwoWay}"
SelectedValuePath="Value" />
</ui:CardControl>
<!-- beta.23 (owner decisions D60/D61): a game page's artwork — local files only, nothing downloaded — and its colour. -->
<ui:CardControl Margin="0,8,0,0" Icon="{ui:SymbolIcon Image24}">
<ui:CardControl.Header>
<StackPanel>
<ui:TextBlock FontTypography="BodyStrong" Text="{x:Static res:Strings.Settings_GameArt_Label}" />
<ui:TextBlock MaxWidth="520" HorizontalAlignment="Left" Style="{StaticResource SecondaryText}" TextWrapping="Wrap"
Text="{x:Static res:Strings.Settings_GameArt_Body}" />
</StackPanel>
</ui:CardControl.Header>
<ui:ToggleSwitch AutomationProperties.Name="{x:Static res:Strings.Settings_GameArt_Label}" IsChecked="{Binding ViewModel.GameArt, Mode=TwoWay}" />
</ui:CardControl>
<ui:CardControl Margin="0,8,0,0" Icon="{ui:SymbolIcon ColorBackground24}" IsEnabled="{Binding ViewModel.GameArt}">
<ui:CardControl.Header>
<StackPanel>
<ui:TextBlock FontTypography="BodyStrong" Text="{x:Static res:Strings.Settings_GameArtTint_Label}" />
<ui:TextBlock MaxWidth="520" HorizontalAlignment="Left" Style="{StaticResource SecondaryText}" TextWrapping="Wrap"
Text="{x:Static res:Strings.Settings_GameArtTint_Body}" />
</StackPanel>
</ui:CardControl.Header>
<ui:ToggleSwitch AutomationProperties.Name="{x:Static res:Strings.Settings_GameArtTint_Label}" IsChecked="{Binding ViewModel.GameArtTint, Mode=TwoWay}" />
</ui:CardControl>
<ui:TextBlock FontTypography="Subtitle" Margin="0,20,0,8" Text="{x:Static res:Strings.Settings_Window_Header}" />
<ui:CardControl Margin="0,4,0,0" Icon="{ui:SymbolIcon Power24}">
@@ -0,0 +1,18 @@
// 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.Services;
/// <summary>
/// beta.22: a request the capture agent never answered, told apart from one it refused and from one never sent. The
/// connection closed under it (<see cref="IOException"/>, <see cref="AgentConnection.AnsweredAsync"/>) or no answer came in
/// time (<see cref="TimeoutException"/>): whether it was carried out is not known, so a caller says so
/// (<c>Agent_Unanswered</c>) and reads what is stored again rather than assuming either way (<c>07_IPC</c> §Client behavior).
/// An <see cref="InvalidOperationException"/> from the request is the connection gone before it was sent: nothing was asked.
/// </summary>
public static class AgentAnswers
{
public static bool IsUnanswered(Exception ex) => ex is IOException or TimeoutException;
}
@@ -108,7 +108,27 @@ public sealed class AgentConnection : IAgentLink, IAsyncDisposable
throw new InvalidOperationException("the Agent is not connected");
}
return client.RequestEnvelopeAsync(type, payload, _options.RequestTimeout, ct);
return AnsweredAsync(() => client.RequestEnvelopeAsync(type, payload, _options.RequestTimeout, ct));
}
/// <summary>
/// beta.22: a request's answer, with every way the pipe can close under it said as ONE <see cref="IOException"/>.
/// <see cref="PipeClient"/> fails a request in flight with what ended its reader — an <see cref="IOException"/>, an
/// <see cref="IpcFramingException"/> or an <see cref="ObjectDisposedException"/> — and a client this connection disposed
/// between the check above and the write throws the last; a caller that knew only the first ended in the App's crash
/// dialog (beta.21's review of Play). <see cref="IAgentRequests.RequestAsync{TRequest}"/> names what is left.
/// </summary>
internal static async Task<IpcEnvelope> AnsweredAsync(Func<Task<IpcEnvelope>> request)
{
ArgumentNullException.ThrowIfNull(request);
try
{
return await request().ConfigureAwait(false);
}
catch (Exception ex) when (ex is ObjectDisposedException or IpcFramingException)
{
throw new IOException("the connection to the Agent closed before it answered", ex);
}
}
/// <summary>Ask the Agent for its status now; null when not connected or when the request failed.</summary>
@@ -126,7 +146,7 @@ public sealed class AgentConnection : IAgentLink, IAsyncDisposable
Set(AgentConnectionState.Connected, Hello, status);
return status;
}
catch (Exception ex) when (ex is IOException or TimeoutException or IpcRequestException or ObjectDisposedException)
catch (Exception ex) when (ex is IOException or TimeoutException or IpcRequestException or ObjectDisposedException or IpcFramingException)
{
return null;
}
@@ -6,13 +6,14 @@ using Microsoft.Extensions.Hosting;
namespace FrameLedger.App.Services;
/// <summary>Runs <see cref="AgentConnection"/> for the life of the host.</summary>
internal sealed class AgentConnectionHostedService(AgentConnection connection, LiveSessions sessions) : BackgroundService
internal sealed class AgentConnectionHostedService(AgentConnection connection, LiveSessions sessions, SessionNotices notices) : BackgroundService
{
// The running-session view is built with this service, before the first round, so the first connect's status seeds
// it and no event after it is missed (2026-09-23).
// it and no event after it is missed (2026-09-23); so is FR-3.8's notice (beta.23), on the UI thread the host starts on.
protected override Task ExecuteAsync(CancellationToken stoppingToken)
{
GC.KeepAlive(sessions);
GC.KeepAlive(notices);
return connection.RunAsync(stoppingToken);
}
@@ -27,6 +27,9 @@ public enum AntiCheatExceptionOutcome
/// <summary>No connected Agent; nothing was sent.</summary>
AgentUnavailable,
/// <summary>The Agent answered and did not grant (a store outcome, an <c>Error</c>, a timeout); <c>Detail</c> says which.</summary>
/// <summary>The Agent answered and did not grant (a store outcome, an <c>Error</c>); <c>Detail</c> says which.</summary>
Failed,
/// <summary>beta.22: the Agent did not answer (<see cref="AgentAnswers.IsUnanswered"/>): whether it granted or withdrew is not known.</summary>
Unanswered,
}
@@ -27,6 +27,7 @@ public sealed record AntiCheatExceptionResult(AntiCheatExceptionOutcome Outcome,
// A grant and a withdrawal alike (beta.18): "Nothing was enabled." was the hooking consent's words, untrue for a withdrawal.
AntiCheatExceptionOutcome.AgentUnavailable => Strings.Agent_NotConnected_NothingChanged,
AntiCheatExceptionOutcome.Failed => Detail ?? Strings.Common_NotAvailable,
AntiCheatExceptionOutcome.Unanswered => Strings.Agent_Unanswered,
_ => null,
};
@@ -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 FrameLedger.Infrastructure.Ipc;
using FrameLedger.Shared.Ipc;
using FrameLedger.Shared.Safety;
@@ -66,17 +65,28 @@ public sealed class AntiCheatExceptions
IpcEnvelope ack = await _agent.RequestAsync(IpcMessageType.SetAntiCheatException, request, ct).ConfigureAwait(true);
return Interpret(ack, request.Enabled);
}
catch (Exception ex) when (ex is IpcRequestException or TimeoutException or IOException or InvalidOperationException)
catch (IpcRequestException ex)
{
Log.Warning(ex, "exception: SetAntiCheatException(game {GameId}, {Enabled}) did not complete", request.GameId, request.Enabled);
string? code = (ex as IpcRequestException)?.Code;
AntiCheatExceptionOutcome outcome = code switch
AntiCheatExceptionOutcome outcome = ex.Code switch
{
IpcErrorCode.DisclosureVersionMismatch => AntiCheatExceptionOutcome.VersionMismatch,
IpcErrorCode.ExceptionsOff => AntiCheatExceptionOutcome.OptionOff,
_ => AntiCheatExceptionOutcome.Failed,
};
return new AntiCheatExceptionResult(outcome, code ?? ex.GetType().Name);
return new AntiCheatExceptionResult(outcome, ex.Code ?? IpcMessageType.Error);
}
catch (InvalidOperationException ex)
{
// The connection went between the caller's check and the request: nothing was sent.
Log.Warning("exception: SetAntiCheatException(game {GameId}, {Enabled}) was not sent ({Message})", request.GameId, request.Enabled, ex.Message);
return AntiCheatExceptionResult.Of(AntiCheatExceptionOutcome.AgentUnavailable);
}
catch (Exception ex) when (AgentAnswers.IsUnanswered(ex))
{
// beta.22: whether the exception was made or withdrawn is not known — never the exception's type name as the notice.
Log.Warning(ex, "exception: SetAntiCheatException(game {GameId}, {Enabled}) had no answer", request.GameId, request.Enabled);
return AntiCheatExceptionResult.Of(AntiCheatExceptionOutcome.Unanswered);
}
}
+175
View File
@@ -0,0 +1,175 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.Runtime.InteropServices;
using System.Windows.Media;
namespace FrameLedger.App.Services;
/// <summary>
/// The arithmetic of the game page's artwork tint (beta.23, owner decision D61): WCAG 2.1's relative luminance and contrast
/// ratio, source-over compositing, an artwork's dominant colour, and the strongest tint that keeps every text pair the
/// header shows readable. The tests check it with their own, separate copy of the WCAG formulas (<c>Wcag</c>), so a mistake
/// here cannot also be the check's.
/// </summary>
internal static class ColorMath
{
/// <summary>A text pair the tint must keep readable: the text's colour, an optional fill under it (a pill), and the ratio it needs.</summary>
[StructLayout(LayoutKind.Auto)]
internal readonly record struct Pair(Color Text, Color? Fill, double Minimum);
/// <summary>WCAG 2.1 relative luminance of an opaque colour.</summary>
public static double Luminance(Color c)
{
static double Channel(byte v)
{
double s = v / 255.0;
return s <= 0.03928 ? s / 12.92 : Math.Pow((s + 0.055) / 1.055, 2.4);
}
return (0.2126 * Channel(c.R)) + (0.7152 * Channel(c.G)) + (0.0722 * Channel(c.B));
}
/// <summary>WCAG 2.1 contrast ratio between two opaque colours.</summary>
public static double Contrast(Color a, Color b)
{
double la = Luminance(a);
double lb = Luminance(b);
return (Math.Max(la, lb) + 0.05) / (Math.Min(la, lb) + 0.05);
}
/// <summary>Source-over: <paramref name="top"/>, with its own alpha, on an opaque <paramref name="under"/>.</summary>
public static Color Over(Color top, Color under)
{
double a = top.A / 255.0;
return Color.FromRgb(
(byte)Math.Round((top.R * a) + (under.R * (1 - a))),
(byte)Math.Round((top.G * a) + (under.G * (1 - a))),
(byte)Math.Round((top.B * a) + (under.B * (1 - a))));
}
/// <summary><paramref name="colour"/> laid over <paramref name="under"/> at <paramref name="alpha"/> (0–1), opaque.</summary>
public static Color Mix(Color under, Color colour, double alpha) =>
Over(Color.FromArgb((byte)Math.Round(Math.Clamp(alpha, 0, 1) * 255), colour.R, colour.G, colour.B), under);
/// <summary>
/// The colour an artwork reads as, from its pixels (BGRA, 8 bits each): the hue that carries the most of its vivid pixels —
/// each weighted by its saturation and brightness, near-black and near-white ones not counted — averaged over the pixels of
/// that hue and its two neighbours. Null for an image with nothing vivid in it (grey, black and white, a dark poster):
/// such an image tints nothing.
/// </summary>
public static Color? Dominant(ReadOnlySpan<byte> bgra)
{
const int hues = 36;
Span<double> weight = stackalloc double[hues];
Span<double> r = stackalloc double[hues];
Span<double> g = stackalloc double[hues];
Span<double> b = stackalloc double[hues];
double total = 0;
int pixels = 0;
for (int i = 0; i + 3 < bgra.Length; i += 4)
{
if (bgra[i + 3] < 128)
{
continue; // transparent: not part of the picture
}
pixels++;
(double h, double s, double v) = Hsv(bgra[i + 2], bgra[i + 1], bgra[i]);
if (v < 0.15 || s < 0.15)
{
continue; // near-black, or grey and near-white: no colour to give
}
double w = s * v;
int bin = Math.Min(hues - 1, (int)(h / 360.0 * hues));
weight[bin] += w;
r[bin] += bgra[i + 2] * w;
g[bin] += bgra[i + 1] * w;
b[bin] += bgra[i] * w;
total += w;
}
// Fewer than a twentieth of the picture's pixels' worth of colour: it is a grey picture with a few coloured specks.
return pixels == 0 || total < pixels * 0.05 ? null : AverageAroundHeaviest(weight, r, g, b);
}
/// <summary>The weighted average colour of the heaviest hue and its two neighbours.</summary>
private static Color AverageAroundHeaviest(ReadOnlySpan<double> weight, ReadOnlySpan<double> r, ReadOnlySpan<double> g, ReadOnlySpan<double> b)
{
int hues = weight.Length;
int best = 0;
double bestWeight = -1;
for (int bin = 0; bin < hues; bin++)
{
double around = weight[bin] + weight[(bin + 1) % hues] + weight[(bin + hues - 1) % hues];
if (around > bestWeight)
{
bestWeight = around;
best = bin;
}
}
double sw = 0;
double sr = 0;
double sg = 0;
double sb = 0;
foreach (int bin in new[] { (best + hues - 1) % hues, best, (best + 1) % hues })
{
sw += weight[bin];
sr += r[bin];
sg += g[bin];
sb += b[bin];
}
return Color.FromRgb((byte)Math.Round(sr / sw), (byte)Math.Round(sg / sw), (byte)Math.Round(sb / sw));
}
/// <summary>
/// The band's colour: <paramref name="dominant"/> over <paramref name="background"/> at the largest opacity, at most
/// <paramref name="maxAlpha"/>, at which every pair in <paramref name="pairs"/> still reads at its minimum — tried from
/// <paramref name="maxAlpha"/> down in steps of one hundredth, because the luminance of a mix need not move one way as it
/// deepens. The background itself when even the faintest tint would cost a pair its contrast.
/// </summary>
public static Color Tint(Color background, Color dominant, IReadOnlyList<Pair> pairs, double maxAlpha)
{
ArgumentNullException.ThrowIfNull(pairs);
for (int step = (int)Math.Round(Math.Clamp(maxAlpha, 0, 1) * 100); step > 0; step--)
{
Color band = Mix(background, dominant, step / 100.0);
if (pairs.All(p => Reads(p, band)))
{
return band;
}
}
return background;
}
/// <summary>Whether <paramref name="pair"/> reads at its minimum on <paramref name="band"/>.</summary>
public static bool Reads(Pair pair, Color band)
{
Color under = pair.Fill is { } fill ? Over(fill, band) : band;
return Contrast(Over(pair.Text, under), under) >= pair.Minimum;
}
private static (double H, double S, double V) Hsv(byte red, byte green, byte blue)
{
double r = red / 255.0;
double g = green / 255.0;
double b = blue / 255.0;
double max = Math.Max(r, Math.Max(g, b));
double min = Math.Min(r, Math.Min(g, b));
double delta = max - min;
double h = delta == 0 ? 0
: max == r ? 60 * (((g - b) / delta) % 6)
: max == g ? 60 * (((b - r) / delta) + 2)
: 60 * (((r - g) / delta) + 4);
if (h < 0)
{
h += 360;
}
return (h, max == 0 ? 0 : delta / max, max);
}
}
+214
View File
@@ -0,0 +1,214 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.Globalization;
using System.IO;
using System.Runtime.InteropServices;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using FrameLedger.Application.Persistence;
using Serilog;
namespace FrameLedger.App.Services;
/// <summary>
/// The images users choose for their games (beta.23, owner decision D60), kept in the data folder's <c>covers</c> folder as
/// <c>game-&lt;id&gt;-&lt;unix ms&gt;.png</c> — a copy, re-encoded and no larger than 1200 pixels a side, so the user's own
/// file can move or go — and named in <c>games.cover_path</c> relative to the data folder (<c>covers\…</c>), so a copied data
/// folder still finds them. Each choice is a new name: a replaced image is never written over while it is shown, and the old
/// file goes once the row names the new one.
/// </summary>
/// <remarks>
/// <b>A row's <c>cover_path</c> is followed only when it is one of these names</b>, in the folder itself and never through a
/// junction or a symbolic link. A viewer (D52) opens a copy of a ledger that may have come from anywhere, and a path read
/// from it — rooted, a share (<c>\\host\…</c>, which would make Windows offer this user's credentials to that host), or
/// <c>..</c> out of the folder — is never opened.
/// </remarks>
public sealed class CoverStore
{
public const string FolderName = "covers";
private const int _largestSide = 1200;
private static readonly TimeSpan _leftoverAfter = TimeSpan.FromHours(1);
private readonly string _dataDirectory;
private readonly IGameRepository _games;
private readonly TimeProvider _clock;
public CoverStore(UiMode mode, IGameRepository games, TimeProvider? clock = null)
{
ArgumentNullException.ThrowIfNull(mode);
_dataDirectory = mode.DataDirectory;
_games = games ?? throw new ArgumentNullException(nameof(games));
_clock = clock ?? TimeProvider.System;
}
public string Folder => Path.Combine(_dataDirectory, FolderName);
/// <summary>The full path of the image <paramref name="coverPath"/> names, when it is one of ours and is there; null otherwise.</summary>
public static string? Resolve(string dataDirectory, string? coverPath)
{
ArgumentException.ThrowIfNullOrWhiteSpace(dataDirectory);
if (string.IsNullOrWhiteSpace(coverPath) || Path.IsPathRooted(coverPath))
{
return null;
}
string[] parts = coverPath.Split('\\', '/');
if (parts.Length != 2 || !string.Equals(parts[0], FolderName, StringComparison.OrdinalIgnoreCase) || ParseName(parts[1]) is null)
{
return null;
}
// Nor through a link, the folder's or the file's: the folder is looked at before anything under it is touched.
var folder = new DirectoryInfo(Path.GetFullPath(Path.Combine(dataDirectory, FolderName)));
var file = new FileInfo(Path.GetFullPath(Path.Combine(folder.FullName, parts[1])));
return string.Equals(file.DirectoryName, folder.FullName, StringComparison.OrdinalIgnoreCase)
&& folder.Exists && !IsLink(folder) && file.Exists && !IsLink(file)
? file.FullName
: null;
}
/// <summary>
/// Whether <paramref name="entry"/> is a link to another place — a junction or a symbolic link, which could lead anywhere,
/// a share included. Other reparse points (a OneDrive file, a deduplicated one) are the entry itself.
/// </summary>
private static bool IsLink(FileSystemInfo entry)
{
try
{
return entry.LinkTarget is not null;
}
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException)
{
return true;
}
}
/// <summary>The game id an image's file name carries — <c>game-&lt;id&gt;-&lt;unix ms&gt;.png</c> — or null for any other name.</summary>
internal static long? ParseName(string name)
{
if (!name.StartsWith("game-", StringComparison.Ordinal) || !name.EndsWith(".png", StringComparison.Ordinal))
{
return null;
}
string[] middle = name["game-".Length..^".png".Length].Split('-');
return middle.Length == 2 && middle.All(static p => p.Length is > 0 and <= 19 && p.All(char.IsAsciiDigit))
&& long.TryParse(middle[0], NumberStyles.None, CultureInfo.InvariantCulture, out long id) && long.TryParse(middle[1], NumberStyles.None, CultureInfo.InvariantCulture, out _)
? id
: null;
}
/// <summary>
/// The picked file, copied as a PNG for <paramref name="gameId"/>; the <c>cover_path</c> that names it, or null when the file
/// is not an image Windows can read, or the folder cannot be written (it is a link to elsewhere, the disk refused).
/// </summary>
public Task<string?> ImportAsync(long gameId, string source, CancellationToken ct = default)
{
ArgumentException.ThrowIfNullOrWhiteSpace(source);
return Task.Run(() => Import(gameId, source), ct);
}
/// <summary>Deletes the image <paramref name="coverPath"/> names, when it is one of ours.</summary>
public void Delete(string? coverPath)
{
if (Resolve(_dataDirectory, coverPath) is not { } full)
{
return;
}
try
{
File.Delete(full);
}
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException)
{
Log.Information("art: {File} could not be deleted ({Message}); it goes at the next start", Path.GetFileName(full), ex.Message);
}
}
/// <summary>
/// The images no row names any more — a game deleted with its sessions, removed by the agent (D55), an image replaced
/// while a delete failed — and a half-written copy older than an hour, deleted; the count. Only files of our own name in
/// the folder are touched, and a row removed with its sessions kept still owns its image (adding the game back restores
/// it). Run on the App's own data folder, never a viewer's.
/// </summary>
public async Task<int> PruneAsync(CancellationToken ct = default)
{
var folder = new DirectoryInfo(Folder);
if (!folder.Exists || IsLink(folder))
{
return 0;
}
int deleted = 0;
foreach (FileInfo file in folder.EnumerateFiles().ToList())
{
ct.ThrowIfCancellationRequested();
bool leftover = file.Name.EndsWith(".png.tmp", StringComparison.Ordinal) && ParseName(file.Name[..^".tmp".Length]) is not null
&& _clock.GetUtcNow() - new DateTimeOffset(file.LastWriteTimeUtc, TimeSpan.Zero) > _leftoverAfter;
bool orphan = false;
if (ParseName(file.Name) is long id)
{
GameRow? row = await _games.FindByIdAsync(id, ct).ConfigureAwait(false);
orphan = row is null || !string.Equals(row.CoverPath, FolderName + "\\" + file.Name, StringComparison.OrdinalIgnoreCase);
}
if (leftover || orphan)
{
try
{
file.Delete();
deleted++;
}
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException)
{
Log.Information("art: {File} could not be deleted ({Message})", file.Name, ex.Message);
}
}
}
return deleted;
}
private string? Import(long gameId, string source)
{
try
{
byte[] png = Reencode(File.ReadAllBytes(source));
var folder = new DirectoryInfo(Folder);
folder.Create();
if (IsLink(folder))
{
Log.Warning("art: {Folder} is a link to another place; no image is written there", folder.FullName);
return null;
}
string name = string.Create(CultureInfo.InvariantCulture, $"game-{gameId}-{_clock.GetUtcNow().ToUnixTimeMilliseconds()}.png");
string target = Path.Combine(folder.FullName, name);
string temporary = target + ".tmp";
File.WriteAllBytes(temporary, png);
File.Move(temporary, target, overwrite: false);
return FolderName + "\\" + name;
}
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException or NotSupportedException or FileFormatException
or COMException or ArgumentException or InvalidOperationException or OverflowException)
{
Log.Information("art: the chosen image could not be used ({Message})", ex.Message);
return null;
}
}
/// <summary>The image as a PNG no larger than 1200 pixels a side.</summary>
internal static byte[] Reencode(byte[] bytes)
{
BitmapSource image = GameArt.DecodeFile(bytes, 0, 0);
double scale = Math.Min(1, _largestSide / (double)Math.Max(image.PixelWidth, image.PixelHeight));
BitmapSource sized = scale < 1 ? new TransformedBitmap(image, new ScaleTransform(scale, scale)) : image;
var encoder = new PngBitmapEncoder();
encoder.Frames.Add(BitmapFrame.Create(sized));
using var output = new MemoryStream();
encoder.Save(output);
return output.ToArray();
}
}
@@ -17,9 +17,9 @@ public sealed class EditGamePrompt : IEditGamePrompt
public EditGamePrompt(IContentDialogService dialogs) => _dialogs = dialogs ?? throw new ArgumentNullException(nameof(dialogs));
public async Task<GameMetadata?> EditAsync(GameMetadata current, string? provenanceJson, CancellationToken ct = default)
public async Task<GameEdit?> EditAsync(GameMetadata current, string? provenanceJson, EditImage? image = null, CancellationToken ct = default)
{
var viewModel = new EditGameViewModel(current, provenanceJson);
var viewModel = new EditGameViewModel(current, provenanceJson, image);
var dialog = new ContentDialog
{
Title = EditGameViewModel.Title,
@@ -31,6 +31,6 @@ public sealed class EditGamePrompt : IEditGamePrompt
_ = dialog.SetBinding(ContentDialog.IsPrimaryButtonEnabledProperty, new Binding(nameof(EditGameViewModel.CanSave)) { Source = viewModel, Mode = BindingMode.OneWay });
ContentDialogResult result = await _dialogs.ShowAsync(dialog, ct).ConfigureAwait(true);
return result == ContentDialogResult.Primary && viewModel.CanSave ? viewModel.Result() : null;
return result == ContentDialogResult.Primary && viewModel.CanSave ? viewModel.Edit() : null;
}
}
+12
View File
@@ -0,0 +1,12 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.Windows.Media;
namespace FrameLedger.App.Services;
/// <summary>
/// The game's image for the edit dialog (beta.23, D60): what the page shows now and whether it is the user's own, the store's
/// own cover for "Use the store's image", the picker, and how a picked file is previewed.
/// </summary>
public sealed record EditImage(ImageSource? Current, bool CurrentIsOwn, ImageSource? Store, IImagePicker Picker, Func<string, Task<ImageSource?>> Preview);
+239
View File
@@ -0,0 +1,239 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.IO;
using System.Runtime.InteropServices;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using FrameLedger.Application.Art;
using FrameLedger.Application.Import;
using FrameLedger.Application.Persistence;
using FrameLedger.Application.Play;
using FrameLedger.Application.Settings;
using Serilog;
namespace FrameLedger.App.Services;
/// <summary>
/// A game's artwork for its page (beta.23, owner decision D60): the image the user chose for it (Edit…), else what the app of
/// the store that installed it keeps on this PC — Steam's and GOG GALAXY's (<see cref="IStoreArtCache"/>) — and the colour
/// the page's band takes from it (D61). Which store installed the game is asked of the stores' own records, as Play asks
/// (<see cref="StoreRecords.Owning"/>), and only of those two: an itch or Epic game, whose apps keep no image files, has its
/// own image or none. Nothing is downloaded and nothing of a store's is copied.
/// </summary>
/// <remarks>
/// Everything here runs on the thread pool — the records, the files, the decoding, the colour — and the decoded images are
/// frozen, so the page only binds them. The stores' records are read the first time a page asks and kept two minutes (a
/// Steam library is files on whatever drive it is on); decoded images are kept for the twelve most recent files.
/// </remarks>
public sealed class GameArt
{
private const int _keep = 12;
private const long _largestFile = 32L * 1024 * 1024;
private static readonly TimeSpan _recordsFor = TimeSpan.FromMinutes(2);
private readonly RegisteredSettings _settings;
private readonly StoreRecordsReader _stores;
private readonly Dictionary<string, IStoreArtCache> _caches;
private readonly string _dataDirectory;
private readonly TimeProvider _clock;
private readonly Lock _lock = new();
private readonly LinkedList<(string Key, BitmapSource Image)> _decoded = new();
private readonly HashSet<string> _unreadable = new(StringComparer.OrdinalIgnoreCase);
private (DateTimeOffset At, IReadOnlyList<StoreGame> Records)? _records;
public GameArt(RegisteredSettings settings, StoreRecordsReader stores, IEnumerable<IStoreArtCache> caches, UiMode mode, TimeProvider? clock = null)
{
_settings = settings ?? throw new ArgumentNullException(nameof(settings));
_stores = stores ?? throw new ArgumentNullException(nameof(stores));
ArgumentNullException.ThrowIfNull(caches);
ArgumentNullException.ThrowIfNull(mode);
_caches = caches.ToDictionary(static c => c.Platform, StringComparer.Ordinal);
_dataDirectory = mode.DataDirectory;
_clock = clock ?? TimeProvider.System;
}
/// <summary>The game's artwork, or null when there is none to show or Settings ▸ Games turned it off.</summary>
public Task<GameArtView?> ForAsync(GameRow game, CancellationToken ct = default)
{
ArgumentNullException.ThrowIfNull(game);
return Task.Run(async () =>
{
if (!await _settings.GetBooleanAsync(SettingsRegistry.UiGameArt, ct).ConfigureAwait(false))
{
return null;
}
bool tint = await _settings.GetBooleanAsync(SettingsRegistry.UiGameArtTint, ct).ConfigureAwait(false);
IReadOnlyList<StoreGame> records = await RecordsAsync().ConfigureAwait(false);
return Resolve(game, records, tint);
}, ct);
}
/// <summary>The image at <paramref name="path"/>, decoded no larger than <paramref name="maxHeight"/> — the edit dialog's preview of a picked file.</summary>
public Task<BitmapSource?> PreviewAsync(string path, int maxHeight, CancellationToken ct = default) =>
Task.Run(() => Decode(path, maxWidth: 0, maxHeight), ct);
private GameArtView? Resolve(GameRow game, IReadOnlyList<StoreGame> records, bool tint)
{
GameArtFiles files = GameArtFiles.None;
string? platform = null;
if (StoreRecords.Owning(game.Fingerprint.ExePath, game.StoreId, records) is { } record && _caches.TryGetValue(record.Platform, out IStoreArtCache? cache))
{
files = cache.Find(record.StoreId);
platform = record.Platform;
}
// The cover slot: the user's image, else the store's portrait cover, else its landscape header.
BitmapSource? storeCover = Decode(files.Cover, 0, 450);
bool landscape = false;
if (storeCover is null && Decode(files.Header, 460, 0) is { } header)
{
storeCover = header;
landscape = true;
}
BitmapSource? own = CoverStore.Resolve(_dataDirectory, game.CoverPath) is { } mine ? Decode(mine, 0, 900) : null;
BitmapSource? hero = Decode(files.Hero, 1920, 0);
BitmapSource? cover = own ?? storeCover;
if (cover is null && hero is null)
{
return null;
}
Color? colour = tint ? DominantOf(cover ?? hero!) : null;
string source = own is not null ? Strings.Art_Source_Yours
: string.Equals(platform, "gog", StringComparison.Ordinal) ? Strings.Art_Source_Gog
: Strings.Art_Source_Steam;
return new GameArtView(cover, own is not null, own is null && landscape, storeCover, hero, colour, source);
}
private async Task<IReadOnlyList<StoreGame>> RecordsAsync()
{
lock (_lock)
{
if (_records is { } cached && _clock.GetUtcNow() - cached.At < _recordsFor)
{
return cached.Records;
}
}
// Two pages opening at once may both read; the second answer simply replaces the first.
IReadOnlyList<StoreGame> read = await _stores.ReadAsync("art", _caches.Keys).ConfigureAwait(false);
lock (_lock)
{
_records = (_clock.GetUtcNow(), read);
}
return read;
}
/// <summary>
/// The file decoded and frozen — no wider than <paramref name="maxWidth"/> nor taller than <paramref name="maxHeight"/>
/// (0: no limit), never enlarged — or null: no file, an empty or outsized one, or one Windows' codecs cannot read (a WebP
/// without the WebP codec, a damaged file). A file that would not decode is said in the log once.
/// </summary>
private BitmapSource? Decode(string? path, int maxWidth, int maxHeight)
{
if (path is null)
{
return null;
}
try
{
var info = new FileInfo(path);
if (!info.Exists || info.Length == 0 || info.Length > _largestFile)
{
return null;
}
string key = string.Join('|', info.FullName, info.Length, info.LastWriteTimeUtc.Ticks, maxWidth, maxHeight);
lock (_lock)
{
for (LinkedListNode<(string Key, BitmapSource Image)>? node = _decoded.First; node is not null; node = node.Next)
{
if (string.Equals(node.Value.Key, key, StringComparison.Ordinal))
{
_decoded.Remove(node);
_decoded.AddFirst(node);
return node.Value.Image;
}
}
}
BitmapSource image = DecodeFile(File.ReadAllBytes(info.FullName), maxWidth, maxHeight);
lock (_lock)
{
_decoded.AddFirst((key, image));
while (_decoded.Count > _keep)
{
_decoded.RemoveLast();
}
}
return image;
}
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException or NotSupportedException or FileFormatException
or COMException or ArgumentException or InvalidOperationException or OverflowException)
{
bool first;
lock (_lock)
{
first = _unreadable.Add(path);
}
if (first)
{
Log.Information("art: {Path} could not be read as an image ({Message})", path, ex.Message);
}
return null;
}
}
/// <summary>Decodes bytes into a frozen image no larger than the limits; read whole first, so no file stays open.</summary>
internal static BitmapSource DecodeFile(byte[] bytes, int maxWidth, int maxHeight)
{
ArgumentNullException.ThrowIfNull(bytes);
int width;
int height;
using (var probe = new MemoryStream(bytes, writable: false))
{
BitmapFrame frame = BitmapDecoder.Create(probe, BitmapCreateOptions.DelayCreation, BitmapCacheOption.None).Frames[0];
width = frame.PixelWidth;
height = frame.PixelHeight;
}
using var stream = new MemoryStream(bytes, writable: false);
var image = new BitmapImage();
image.BeginInit();
image.CacheOption = BitmapCacheOption.OnLoad;
image.StreamSource = stream;
if (maxWidth > 0 && width > maxWidth && (maxHeight <= 0 || (double)width / maxWidth >= (double)height / maxHeight))
{
image.DecodePixelWidth = maxWidth;
}
else if (maxHeight > 0 && height > maxHeight)
{
image.DecodePixelHeight = maxHeight;
}
image.EndInit();
image.Freeze();
return image;
}
/// <summary>The image's dominant colour (<see cref="ColorMath.Dominant"/>), read from a 48-pixel-wide copy.</summary>
internal static Color? DominantOf(BitmapSource image)
{
ArgumentNullException.ThrowIfNull(image);
double scale = Math.Min(1, 48.0 / Math.Max(1, image.PixelWidth));
BitmapSource small = scale < 1 ? new TransformedBitmap(image, new ScaleTransform(scale, scale)) : image;
var bgra = new FormatConvertedBitmap(small, PixelFormats.Bgra32, null, 0);
int stride = bgra.PixelWidth * 4;
byte[] pixels = new byte[stride * bgra.PixelHeight];
bgra.CopyPixels(pixels, stride, 0);
return ColorMath.Dominant(pixels);
}
}
@@ -0,0 +1,13 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.Windows.Media;
namespace FrameLedger.App.Services;
/// <summary>
/// A game's artwork as its page shows it (beta.23, D60): the cover slot's image (the user's own, or the store's portrait
/// cover, or its landscape header), the store's own cover for the edit dialog's "use the store's image", the banner, the
/// band's colour (null: untinted), and where the images came from, for the tooltip.
/// </summary>
public sealed record GameArtView(ImageSource? Cover, bool CoverIsOwn, bool CoverIsLandscape, ImageSource? StoreCover, ImageSource? Hero, Color? Tint, string Source);
+6 -3
View File
@@ -5,9 +5,12 @@ using FrameLedger.Application.Persistence;
namespace FrameLedger.App.Services;
/// <summary>Everything the detail page shows for one game, loaded in one pass: the row, its sessions newest first, their annotations, the aggregate.</summary>
/// <summary>
/// Everything the detail page shows for one game, loaded in one pass: the row, its sessions newest first, their annotations.
/// (It carried the library's aggregate too, read by summarising EVERY game's sessions to keep one, and read by nothing — gone
/// in beta.23.)
/// </summary>
public sealed record GameDetail(
GameRow Row,
IReadOnlyList<SessionRow> Sessions,
IReadOnlyDictionary<long, SessionAnnotation> Annotations,
GameSessionSummary? Summary);
IReadOnlyDictionary<long, SessionAnnotation> Annotations);
+12
View File
@@ -0,0 +1,12 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using FrameLedger.Application.Persistence;
namespace FrameLedger.App.Services;
/// <summary>
/// What the edit dialog answered: the metadata to store — its <c>CoverPath</c> null when the user went back to the store's
/// image — and the image file the user picked, which is copied only once the dialog closed with Save (beta.23).
/// </summary>
public sealed record GameEdit(GameMetadata Metadata, string? PickedImage);
+1 -2
View File
@@ -50,8 +50,7 @@ public sealed class GameLibrary
IReadOnlyList<SessionRow> sessions = await _sessions.ListByGameAsync(gameId, sessionLimit, ct).ConfigureAwait(false);
IReadOnlyList<SessionAnnotation> annotations = await _annotations.ListByGameAsync(gameId, ct).ConfigureAwait(false);
GameSessionSummary? summary = (await _sessions.SummariseByGameAsync(ct).ConfigureAwait(false)).FirstOrDefault(s => s.GameId == gameId);
return new GameDetail(row, sessions, annotations.ToDictionary(static a => a.SessionId), summary);
return new GameDetail(row, sessions, annotations.ToDictionary(static a => a.SessionId));
}
/// <summary>FR-1.1: the executable becomes a <c>games</c> row, hooking off; null when the file cannot be read.</summary>
+14 -27
View File
@@ -2,7 +2,6 @@
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.Globalization;
using System.IO;
using System.Text.Json;
using FrameLedger.Application.Import;
using FrameLedger.Application.Persistence;
@@ -28,7 +27,7 @@ namespace FrameLedger.App.Services;
public sealed class GamePlayer
{
private readonly RegisteredSettings _settings;
private readonly IReadOnlyList<IStoreLibrarySource> _stores;
private readonly StoreRecordsReader _stores;
private readonly IGogGalaxyLocator _galaxy;
private readonly IShellStarter _shell;
private readonly IAgentRequests _agent;
@@ -39,7 +38,7 @@ public sealed class GamePlayer
{
_settings = settings ?? throw new ArgumentNullException(nameof(settings));
ArgumentNullException.ThrowIfNull(stores);
_stores = [.. stores];
_stores = new StoreRecordsReader(stores);
_galaxy = galaxy ?? throw new ArgumentNullException(nameof(galaxy));
_shell = shell ?? throw new ArgumentNullException(nameof(shell));
_agent = agent ?? throw new ArgumentNullException(nameof(agent));
@@ -62,7 +61,7 @@ public sealed class GamePlayer
}
else
{
StoreGame? record = StoreRecords.Owning(game.Fingerprint.ExePath, game.StoreId, await RecordsAsync(ct).ConfigureAwait(false));
StoreGame? record = StoreRecords.Owning(game.Fingerprint.ExePath, game.StoreId, await _stores.ReadAsync("play", ct: ct).ConfigureAwait(false));
if (record is null)
{
fallback = PlayFallback.NoStore;
@@ -104,6 +103,7 @@ public sealed class GamePlayer
_ => string.Format(CultureInfo.CurrentCulture, Strings.Play_Started_Format, gameName),
}, false),
PlayOutcome.AgentUnavailable => (string.Format(CultureInfo.CurrentCulture, Strings.Play_AgentUnavailable_Format, gameName), true),
PlayOutcome.Unanswered => (Strings.Agent_Unanswered, true),
// "Set Play to go through the store" only where Play was not already going through it.
PlayOutcome.RecordingOff => (string.Format(CultureInfo.CurrentCulture,
result.Fallback == PlayFallback.None ? Strings.Play_RecordingOff_Format : Strings.Play_RecordingOff_Fallback_Format, gameName), true),
@@ -139,25 +139,6 @@ public sealed class GamePlayer
return PlayFallback.NoLink;
}
private async Task<IReadOnlyList<StoreGame>> RecordsAsync(CancellationToken ct)
{
List<StoreGame> all = [];
foreach (IStoreLibrarySource store in _stores)
{
try
{
all.AddRange(await store.ListAsync(ct).ConfigureAwait(false));
}
catch (Exception ex) when (ex is not OperationCanceledException and not OutOfMemoryException)
{
// One store's records that cannot be read are that store's, never the press's.
Log.Warning("play: {Store}'s records could not be read ({Message})", store.Platform, ex.Message);
}
}
return all;
}
private async Task<PlayResult> StartDirectlyAsync(GameRow game, PlayFallback fallback, CancellationToken ct)
{
if (!_agent.IsConnected)
@@ -171,13 +152,19 @@ public sealed class GamePlayer
IpcEnvelope envelope = await _agent.RequestAsync(IpcMessageType.LaunchGame, new LaunchGameRequest(game.Id, null), ct).ConfigureAwait(false);
ack = IpcCodec.Payload<LaunchAck>(envelope);
}
catch (Exception ex) when (ex is InvalidOperationException or TimeoutException or IOException or ObjectDisposedException or IpcFramingException)
catch (InvalidOperationException ex)
{
// The connection went between the check above and the answer — the agent stopping, or restarting for an update:
// the pipe fails a request in flight with these (PipeClient), and a press never ends in an unhandled exception.
Log.Warning("play: LaunchGame for {Game} (id {Id}) had no answer ({Kind}: {Message})", game.Name, game.Id, ex.GetType().Name, ex.Message);
// The connection went between the check above and the request: nothing was sent.
Log.Warning("play: LaunchGame for {Game} (id {Id}) was not sent ({Message})", game.Name, game.Id, ex.Message);
return new PlayResult(PlayOutcome.AgentUnavailable, Fallback: fallback);
}
catch (Exception ex) when (AgentAnswers.IsUnanswered(ex))
{
// The agent stopping or restarting under the request, or no answer in time (beta.22): whether the game is starting
// is not known — and a press never ends in an unhandled exception (beta.21's review).
Log.Warning("play: LaunchGame for {Game} (id {Id}) had no answer ({Kind}: {Message})", game.Name, game.Id, ex.GetType().Name, ex.Message);
return new PlayResult(PlayOutcome.Unanswered, Fallback: fallback);
}
catch (Exception ex) when (ex is IpcRequestException or JsonException)
{
Log.Warning("play: LaunchGame for {Game} (id {Id}) failed ({Kind}: {Message})", game.Name, game.Id, ex.GetType().Name, ex.Message);
+14 -3
View File
@@ -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 FrameLedger.Infrastructure.Ipc;
using FrameLedger.Shared.Ipc;
using FrameLedger.Shared.Safety;
@@ -65,14 +64,26 @@ public sealed class HookingConsent
IpcEnvelope ack = await _agent.RequestAsync(IpcMessageType.SetHookEnabled, request, ct).ConfigureAwait(true);
return Interpret(ack, request.Enabled, onWritten);
}
catch (Exception ex) when (ex is IpcRequestException or TimeoutException or IOException or InvalidOperationException)
catch (IpcRequestException ex)
{
Log.Warning(ex, "consent: SetHookEnabled(game {GameId}, {Enabled}) did not complete", request.GameId, request.Enabled);
string detail = ex is IpcRequestException ipc ? ipc.Code ?? IpcMessageType.Error : ex.GetType().Name;
string detail = ex.Code ?? IpcMessageType.Error;
return new HookingConsentResult(
string.Equals(detail, IpcErrorCode.DisclosureVersionMismatch, StringComparison.Ordinal) ? HookingConsentOutcome.VersionMismatch : HookingConsentOutcome.Failed,
detail);
}
catch (InvalidOperationException ex)
{
// The connection went between the caller's check and the request: nothing was sent.
Log.Warning("consent: SetHookEnabled(game {GameId}, {Enabled}) was not sent ({Message})", request.GameId, request.Enabled, ex.Message);
return HookingConsentResult.Of(HookingConsentOutcome.AgentUnavailable);
}
catch (Exception ex) when (AgentAnswers.IsUnanswered(ex))
{
// beta.22: whether the Agent stamped or revoked is not known — never the exception's type name as the notice.
Log.Warning(ex, "consent: SetHookEnabled(game {GameId}, {Enabled}) had no answer", request.GameId, request.Enabled);
return HookingConsentResult.Of(HookingConsentOutcome.Unanswered);
}
}
private static HookingConsentResult Interpret(IpcEnvelope ack, bool enabling, HookingConsentOutcome onWritten)
@@ -24,6 +24,9 @@ public enum HookingConsentOutcome
/// <summary>No connected Agent; nothing was sent.</summary>
AgentUnavailable,
/// <summary>The Agent answered but did not stamp (a store outcome other than <c>Written</c>, an <c>Error</c>, a timeout); <c>Detail</c> says which.</summary>
/// <summary>The Agent answered but did not stamp (a store outcome other than <c>Written</c>, an <c>Error</c>); <c>Detail</c> says which.</summary>
Failed,
/// <summary>beta.22: the Agent did not answer (<see cref="AgentAnswers.IsUnanswered"/>): whether it stamped or revoked is not known.</summary>
Unanswered,
}
@@ -21,9 +21,14 @@ public interface IAgentRequests
/// Sends <paramref name="payload"/> as <paramref name="type"/> and returns whatever non-<c>Error</c> envelope
/// answers it — the caller distinguishes the acks (a <c>HookEnabledAck</c> from a <c>Refused</c>).
/// </summary>
/// <exception cref="InvalidOperationException">Not connected.</exception>
/// <exception cref="InvalidOperationException">Not connected: nothing was sent.</exception>
/// <exception cref="Infrastructure.Ipc.IpcRequestException">The Agent answered <c>Error</c>.</exception>
/// <exception cref="TimeoutException">No answer within the request timeout.</exception>
/// <exception cref="TimeoutException">No answer within the request timeout: whether it was carried out is not known.</exception>
/// <exception cref="System.IO.IOException">
/// The connection closed before the Agent answered — it stopped, or restarted for an update (beta.22: every way the pipe
/// closes is this one exception, <see cref="AgentConnection.AnsweredAsync"/>): whether it was carried out is not known.
/// <see cref="AgentAnswers.IsUnanswered"/> names this and the timeout.
/// </exception>
Task<IpcEnvelope> RequestAsync<TRequest>(string type, TRequest payload, CancellationToken ct = default)
where TRequest : class;
}
@@ -5,8 +5,13 @@ using FrameLedger.Application.Persistence;
namespace FrameLedger.App.Services;
/// <summary>FR-1.3's edit dialog as a question: the current metadata in, the edited metadata out, or null when cancelled.</summary>
/// <summary>FR-1.3's edit dialog as a question: the current metadata in, the edit out, or null when cancelled.</summary>
public interface IEditGamePrompt
{
Task<GameMetadata?> EditAsync(GameMetadata current, string? provenanceJson, CancellationToken ct = default);
/// <summary>Shows the dialog; the edit, or null when the user cancelled.</summary>
/// <param name="current">What the row holds.</param>
/// <param name="provenanceJson">Which of its fields detection filled in (badged in the dialog).</param>
/// <param name="image">The game's image as its page shows it (beta.23, D60); null leaves the dialog without an image row.</param>
/// <param name="ct">Cancels the dialog.</param>
Task<GameEdit?> EditAsync(GameMetadata current, string? provenanceJson, EditImage? image = null, CancellationToken ct = default);
}
@@ -0,0 +1,11 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
namespace FrameLedger.App.Services;
/// <summary>The edit dialog's "Choose image…" (beta.23, D60), behind an interface so a test can answer it without a dialog.</summary>
public interface IImagePicker
{
/// <summary>The chosen image's full path, or null when the user cancelled.</summary>
string? PickImage();
}
@@ -0,0 +1,23 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using Microsoft.Win32;
namespace FrameLedger.App.Services;
/// <summary>The WPF <see cref="OpenFileDialog"/> for a game's image (beta.23, D60): the formats Windows' own codecs read.</summary>
public sealed class ImagePicker : IImagePicker
{
public string? PickImage()
{
var dialog = new OpenFileDialog
{
Title = Strings.ImagePicker_Title,
Filter = Strings.ImagePicker_Filter,
CheckFileExists = true,
Multiselect = false,
};
return dialog.ShowDialog() == true ? dialog.FileName : null;
}
}
@@ -50,6 +50,9 @@ internal static class MachineFacingServices
services.AddSingleton<IAgentRequests>(static sp => sp.GetRequiredService<AgentConnection>());
services.AddSingleton<IAgentLink>(static sp => sp.GetRequiredService<AgentConnection>());
// FR-3.8's post-session notice (beta.23): one subscription for the App's life, built with the connection's service.
services.AddSingleton(static sp => new SessionNotices(sp.GetRequiredService<IAgentLink>(), sp.GetRequiredService<IMessageStrip>(), sp.GetService<IShellPresence>()));
services.AddSingleton<IRunAtLogon, RunAtLogonRegistry>();
services.AddSingleton<IAgentTool, AgentTool>();
// beta.21 (D59): Play hands a game to its store's app.
+4 -1
View File
@@ -15,9 +15,12 @@ public enum PlayOutcome
/// <summary>The capture agent accepted the launch (<c>LaunchGame</c>).</summary>
StartedByAgent,
/// <summary>Direct, and no capture agent is connected.</summary>
/// <summary>Direct, and no capture agent is connected: nothing was sent.</summary>
AgentUnavailable,
/// <summary>beta.22: the agent did not answer (<see cref="AgentAnswers.IsUnanswered"/>): whether the game is starting is not known.</summary>
Unanswered,
/// <summary>Direct, and the entry's recording is off: FrameLedger starts only what it records (schema 0009).</summary>
RecordingOff,
@@ -39,13 +39,10 @@ public sealed class SessionDeletion
return new(SessionDeletionOutcome.AgentUnavailable);
}
IpcEnvelope envelope;
try
{
IpcEnvelope envelope = await _agent.RequestAsync(IpcMessageType.DeleteSessions, new DeleteSessionsRequest(gameId), ct).ConfigureAwait(true);
DeleteSessionsAck ack = IpcCodec.Payload<DeleteSessionsAck>(envelope) ?? throw new InvalidOperationException("DeleteSessions answered without a payload");
Log.Information("sessions: deleted {Sessions} session(s) of {Games} game(s) ({Scope})", ack.Sessions, ack.Games, gameId is null ? "every game" : "game " + gameId);
await ForgetDeletedAsync(ct).ConfigureAwait(true);
return new(SessionDeletionOutcome.Deleted, ack.Games, ack.Sessions);
envelope = await _agent.RequestAsync(IpcMessageType.DeleteSessions, new DeleteSessionsRequest(gameId), ct).ConfigureAwait(true);
}
catch (IpcRequestException ex) when (string.Equals(ex.Code, IpcErrorCode.SessionRunning, StringComparison.Ordinal))
{
@@ -56,14 +53,39 @@ public sealed class SessionDeletion
Log.Warning("sessions: the Agent does not know DeleteSessions ({Message})", ex.Message);
return new(SessionDeletionOutcome.AgentTooOld);
}
catch (Exception ex) when (ex is IpcRequestException or InvalidOperationException or TimeoutException)
catch (IpcRequestException ex)
{
Log.Warning("sessions: DeleteSessions failed ({Message})", ex.Message);
Log.Warning("sessions: DeleteSessions failed ({Code}: {Message})", ex.Code, ex.Message);
return new(SessionDeletionOutcome.Failed, Detail: ex.Message);
}
catch (InvalidOperationException ex)
{
// The connection went between the check above and the request: nothing was sent.
Log.Warning("sessions: DeleteSessions was not sent ({Message})", ex.Message);
return new(SessionDeletionOutcome.AgentUnavailable);
}
catch (Exception ex) when (AgentAnswers.IsUnanswered(ex))
{
// beta.22: the delete may have run before the connection went — it caught no IOException before, and its exception
// was the App's crash dialog. What named a deleted session lets go of it, and the page reads what is stored.
Log.Warning("sessions: DeleteSessions had no answer ({Kind}: {Message})", ex.GetType().Name, ex.Message);
await ForgetDeletedAsync(ct).ConfigureAwait(true);
return new(SessionDeletionOutcome.Unanswered);
}
if (IpcCodec.Payload<DeleteSessionsAck>(envelope) is not { } ack)
{
Log.Warning("sessions: DeleteSessions was answered without a payload");
await ForgetDeletedAsync(ct).ConfigureAwait(true);
return new(SessionDeletionOutcome.Unanswered);
}
Log.Information("sessions: deleted {Sessions} session(s) of {Games} game(s) ({Scope})", ack.Sessions, ack.Games, gameId is null ? "every game" : "game " + gameId);
await ForgetDeletedAsync(ct).ConfigureAwait(true);
return new(SessionDeletionOutcome.Deleted, ack.Games, ack.Sessions);
}
/// <summary>The delete happened: what still names a deleted session lets go of it. A failure here is logged, not the delete's.</summary>
/// <summary>The delete happened, or may have (beta.22): what still names a deleted session lets go of it. A failure here is logged, not the delete's.</summary>
private async Task ForgetDeletedAsync(CancellationToken ct)
{
try
@@ -20,4 +20,10 @@ public enum SessionDeletionOutcome
/// <summary>Anything else; the detail says what.</summary>
Failed,
/// <summary>
/// beta.22: the capture agent did not answer (<see cref="AgentAnswers.IsUnanswered"/>), or answered without saying what it
/// did: whether anything was deleted is not known, and the page reads what is stored.
/// </summary>
Unanswered,
}
@@ -17,6 +17,7 @@ public sealed record SessionDeletionResult(SessionDeletionOutcome Outcome, int G
SessionDeletionOutcome.SessionRunning => Strings.DeleteSessions_Running,
SessionDeletionOutcome.AgentUnavailable => Strings.DeleteSessions_NoAgent,
SessionDeletionOutcome.AgentTooOld => Strings.DeleteSessions_AgentTooOld,
SessionDeletionOutcome.Unanswered => Strings.Agent_Unanswered,
_ => Detail ?? Strings.Common_NotAvailable,
};
}
@@ -0,0 +1,87 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.Globalization;
using FrameLedger.Shared.Ipc;
namespace FrameLedger.App.Services;
/// <summary>
/// FR-3.8's post-session notice inside the App: "saved" or "discarded" in the snackbar while the window is on screen — the
/// tray's balloon carries it otherwise (P3 PR-8b, one event → one channel), and a safety stop is never a toast (08_UI
/// §Notifications policy). One subscription for the App's life (beta.23).
/// </summary>
/// <remarks>
/// It lived in the Dashboard's view model, and it reached every page only because no Dashboard ever went away: each visit
/// made a new one, the root container kept every one of them (a transient <see cref="IDisposable"/>), and each stayed
/// subscribed — twenty visits were twenty notices for one session, of which WPF UI's snackbar showed the last, and twenty
/// reloads of the Dashboard's lists on the UI thread (<c>spike-notes</c> §21). The Dashboard now listens only while it is on
/// screen, so the notice has its own home.
/// </remarks>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1863:Use 'CompositeFormat'", Justification = "the format strings are resources that follow the UI culture, which changes at runtime")]
public sealed class SessionNotices : IDisposable
{
private readonly IAgentLink _agent;
private readonly IMessageStrip _strip;
private readonly IShellPresence? _presence;
private readonly UiThread _ui = new();
private readonly Lock _lock = new();
// The names the start events gave, for a completion that carries none (an Agent before 2026-09-23 sent none).
private readonly Dictionary<Guid, string> _names = [];
public SessionNotices(IAgentLink agent, IMessageStrip strip, IShellPresence? presence = null)
{
_agent = agent ?? throw new ArgumentNullException(nameof(agent));
_strip = strip ?? throw new ArgumentNullException(nameof(strip));
_presence = presence;
_agent.EventReceived += OnAgentEvent;
}
public void Dispose() => _agent.EventReceived -= OnAgentEvent;
private void OnAgentEvent(object? sender, AgentEventArgs e)
{
IpcEnvelope envelope = e.Envelope;
if (string.Equals(envelope.Type, IpcMessageType.SessionStarted, StringComparison.Ordinal)
&& IpcCodec.Payload<SessionStartedEvent>(envelope) is { GameName: { Length: > 0 } started } start)
{
lock (_lock)
{
_names[start.SessionGuid] = started;
}
}
else if (string.Equals(envelope.Type, IpcMessageType.SessionCompleted, StringComparison.Ordinal)
&& IpcCodec.Payload<SessionCompletedEvent>(envelope) is { } completed)
{
string? known;
lock (_lock)
{
_ = _names.Remove(completed.SessionGuid, out known);
}
// The session's own name (2026-09-23): the Dashboard's card may show another session, and a Tier-2 one had none.
string? name = completed.GameName is { Length: > 0 } given ? given : known;
_ui.Post(() => Notice(completed, name));
}
}
private void Notice(SessionCompletedEvent completed, string? name)
{
// A faulted session is the strip's CaptureError already; "discarded" would say something that did not happen.
if (_presence is { IsShown: false } || string.Equals(completed.Finalize, "faulted", StringComparison.Ordinal))
{
return;
}
string game = name is { Length: > 0 } ? name : Strings.Common_NotAvailable;
if (completed.SessionId is not null)
{
_strip.Success(Strings.Dashboard_Live_Header, string.Format(CultureInfo.CurrentCulture, Strings.Dashboard_SessionSaved_Format, game));
}
else
{
_strip.Info(Strings.Dashboard_Live_Header, string.Format(CultureInfo.CurrentCulture, Strings.Dashboard_SessionDiscarded_Format, game));
}
}
}
@@ -0,0 +1,51 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using FrameLedger.Application.Import;
using Serilog;
namespace FrameLedger.App.Services;
/// <summary>
/// The stores' own records of what they installed (beta.23), the lists Play reads to find the store that installed a game
/// (<c>StoreRecords.Owning</c>): read on the thread pool. Every store's reader is synchronous work — Steam's manifests are
/// files on whatever drive its libraries are on (the owner's: a USB drive), itch's database is copied before it is read —
/// and Play ran all of it on the UI thread at every press.
/// </summary>
public sealed class StoreRecordsReader
{
private readonly IReadOnlyList<IStoreLibrarySource> _stores;
public StoreRecordsReader(IEnumerable<IStoreLibrarySource> stores)
{
ArgumentNullException.ThrowIfNull(stores);
_stores = [.. stores];
}
/// <summary>
/// Every record of the stores named in <paramref name="platforms"/> (every store when null), read now. One store whose
/// records cannot be read is that store's, logged under <paramref name="purpose"/>, never the caller's.
/// </summary>
public Task<IReadOnlyList<StoreGame>> ReadAsync(string purpose, IReadOnlyCollection<string>? platforms = null, CancellationToken ct = default)
{
ArgumentException.ThrowIfNullOrWhiteSpace(purpose);
IStoreLibrarySource[] stores = [.. _stores.Where(s => platforms is null || platforms.Contains(s.Platform, StringComparer.Ordinal))];
return Task.Run(async () =>
{
List<StoreGame> all = [];
foreach (IStoreLibrarySource store in stores)
{
try
{
all.AddRange(await store.ListAsync(ct).ConfigureAwait(false));
}
catch (Exception ex) when (ex is not OperationCanceledException and not OutOfMemoryException)
{
Log.Warning("{Purpose}: {Store}'s records could not be read ({Message})", purpose, store.Platform, ex.Message);
}
}
return (IReadOnlyList<StoreGame>)all;
}, ct);
}
}
+54
View File
@@ -70,6 +70,7 @@ public static class Strings
nameof(Agent_State_Offline),
nameof(Agent_State_Starting),
nameof(Agent_State_Viewer),
nameof(Agent_Unanswered),
nameof(App_Title),
nameof(Arch_AnyCpu),
nameof(Arch_AnyCpu32),
@@ -79,6 +80,12 @@ public static class Strings
nameof(Arch_Unknown),
nameof(Arch_X64),
nameof(Arch_X86),
nameof(Art_Banner_Name),
nameof(Art_Cover_Name),
nameof(Art_ImportFailed),
nameof(Art_Source_Gog),
nameof(Art_Source_Steam),
nameof(Art_Source_Yours),
nameof(Blocked_Directory_Format),
nameof(Blocked_Executable_Format),
nameof(Blocked_File_Format),
@@ -259,13 +266,18 @@ public static class Strings
nameof(Display_WindowOnMonitorHz_Format),
nameof(Document_OnGitHub),
nameof(Document_Pages),
nameof(EditGame_ChooseImage),
nameof(EditGame_Detected),
nameof(EditGame_Image),
nameof(EditGame_ImageNone),
nameof(EditGame_ImageNote),
nameof(EditGame_Name),
nameof(EditGame_Notes),
nameof(EditGame_Publisher),
nameof(EditGame_Save),
nameof(EditGame_Saved),
nameof(EditGame_Title),
nameof(EditGame_UseStoreImage),
nameof(EditGame_Version),
nameof(End_AttachRefused),
nameof(End_ExecutableUnreadable),
@@ -555,6 +567,8 @@ public static class Strings
nameof(Guard_TargetIsWow64),
nameof(Guide_Title),
nameof(Hooking_NotX64_Format),
nameof(ImagePicker_Filter),
nameof(ImagePicker_Title),
nameof(Import_Add),
nameof(Import_Column_Exe),
nameof(Import_Column_Name),
@@ -835,6 +849,10 @@ public static class Strings
nameof(Settings_Exceptions_Withdraw),
nameof(Settings_FpsDecimals_Body),
nameof(Settings_FpsDecimals_Label),
nameof(Settings_GameArt_Body),
nameof(Settings_GameArt_Label),
nameof(Settings_GameArtTint_Body),
nameof(Settings_GameArtTint_Label),
nameof(Settings_Games_Header),
nameof(Settings_Header),
nameof(Settings_HideAntiCheatHooking_Body),
@@ -1184,6 +1202,8 @@ public static class Strings
public static string Agent_State_Viewer => ResourceManager.GetString(nameof(Agent_State_Viewer), Culture) ?? nameof(Agent_State_Viewer);
public static string Agent_Unanswered => ResourceManager.GetString(nameof(Agent_Unanswered), Culture) ?? nameof(Agent_Unanswered);
public static string App_Title => ResourceManager.GetString(nameof(App_Title), Culture) ?? nameof(App_Title);
public static string Arch_AnyCpu => ResourceManager.GetString(nameof(Arch_AnyCpu), Culture) ?? nameof(Arch_AnyCpu);
@@ -1202,6 +1222,18 @@ public static class Strings
public static string Arch_X86 => ResourceManager.GetString(nameof(Arch_X86), Culture) ?? nameof(Arch_X86);
public static string Art_Banner_Name => ResourceManager.GetString(nameof(Art_Banner_Name), Culture) ?? nameof(Art_Banner_Name);
public static string Art_Cover_Name => ResourceManager.GetString(nameof(Art_Cover_Name), Culture) ?? nameof(Art_Cover_Name);
public static string Art_ImportFailed => ResourceManager.GetString(nameof(Art_ImportFailed), Culture) ?? nameof(Art_ImportFailed);
public static string Art_Source_Gog => ResourceManager.GetString(nameof(Art_Source_Gog), Culture) ?? nameof(Art_Source_Gog);
public static string Art_Source_Steam => ResourceManager.GetString(nameof(Art_Source_Steam), Culture) ?? nameof(Art_Source_Steam);
public static string Art_Source_Yours => ResourceManager.GetString(nameof(Art_Source_Yours), Culture) ?? nameof(Art_Source_Yours);
public static string Blocked_Directory_Format => ResourceManager.GetString(nameof(Blocked_Directory_Format), Culture) ?? nameof(Blocked_Directory_Format);
public static string Blocked_Executable_Format => ResourceManager.GetString(nameof(Blocked_Executable_Format), Culture) ?? nameof(Blocked_Executable_Format);
@@ -1562,8 +1594,16 @@ public static class Strings
public static string Document_Pages => ResourceManager.GetString(nameof(Document_Pages), Culture) ?? nameof(Document_Pages);
public static string EditGame_ChooseImage => ResourceManager.GetString(nameof(EditGame_ChooseImage), Culture) ?? nameof(EditGame_ChooseImage);
public static string EditGame_Detected => ResourceManager.GetString(nameof(EditGame_Detected), Culture) ?? nameof(EditGame_Detected);
public static string EditGame_Image => ResourceManager.GetString(nameof(EditGame_Image), Culture) ?? nameof(EditGame_Image);
public static string EditGame_ImageNone => ResourceManager.GetString(nameof(EditGame_ImageNone), Culture) ?? nameof(EditGame_ImageNone);
public static string EditGame_ImageNote => ResourceManager.GetString(nameof(EditGame_ImageNote), Culture) ?? nameof(EditGame_ImageNote);
public static string EditGame_Name => ResourceManager.GetString(nameof(EditGame_Name), Culture) ?? nameof(EditGame_Name);
public static string EditGame_Notes => ResourceManager.GetString(nameof(EditGame_Notes), Culture) ?? nameof(EditGame_Notes);
@@ -1576,6 +1616,8 @@ public static class Strings
public static string EditGame_Title => ResourceManager.GetString(nameof(EditGame_Title), Culture) ?? nameof(EditGame_Title);
public static string EditGame_UseStoreImage => ResourceManager.GetString(nameof(EditGame_UseStoreImage), Culture) ?? nameof(EditGame_UseStoreImage);
public static string EditGame_Version => ResourceManager.GetString(nameof(EditGame_Version), Culture) ?? nameof(EditGame_Version);
public static string End_AttachRefused => ResourceManager.GetString(nameof(End_AttachRefused), Culture) ?? nameof(End_AttachRefused);
@@ -2154,6 +2196,10 @@ public static class Strings
public static string Hooking_NotX64_Format => ResourceManager.GetString(nameof(Hooking_NotX64_Format), Culture) ?? nameof(Hooking_NotX64_Format);
public static string ImagePicker_Filter => ResourceManager.GetString(nameof(ImagePicker_Filter), Culture) ?? nameof(ImagePicker_Filter);
public static string ImagePicker_Title => ResourceManager.GetString(nameof(ImagePicker_Title), Culture) ?? nameof(ImagePicker_Title);
public static string Import_Add => ResourceManager.GetString(nameof(Import_Add), Culture) ?? nameof(Import_Add);
public static string Import_Column_Exe => ResourceManager.GetString(nameof(Import_Column_Exe), Culture) ?? nameof(Import_Column_Exe);
@@ -2714,6 +2760,14 @@ public static class Strings
public static string Settings_FpsDecimals_Label => ResourceManager.GetString(nameof(Settings_FpsDecimals_Label), Culture) ?? nameof(Settings_FpsDecimals_Label);
public static string Settings_GameArt_Body => ResourceManager.GetString(nameof(Settings_GameArt_Body), Culture) ?? nameof(Settings_GameArt_Body);
public static string Settings_GameArt_Label => ResourceManager.GetString(nameof(Settings_GameArt_Label), Culture) ?? nameof(Settings_GameArt_Label);
public static string Settings_GameArtTint_Body => ResourceManager.GetString(nameof(Settings_GameArtTint_Body), Culture) ?? nameof(Settings_GameArtTint_Body);
public static string Settings_GameArtTint_Label => ResourceManager.GetString(nameof(Settings_GameArtTint_Label), Culture) ?? nameof(Settings_GameArtTint_Label);
public static string Settings_Games_Header => ResourceManager.GetString(nameof(Settings_Games_Header), Culture) ?? nameof(Settings_Games_Header);
public static string Settings_Header => ResourceManager.GetString(nameof(Settings_Header), Culture) ?? nameof(Settings_Header);
+72
View File
@@ -4317,4 +4317,76 @@
<value>{0} はもうライブラリにないため、起動しませんでした。</value>
<comment>review</comment>
</data>
<data name="Agent_Unanswered" xml:space="preserve">
<value>キャプチャ エージェントが応答しなかったため、この操作が行われたかどうかは分かりません。エージェントが接続してから、もう一度確認してください。</value>
<comment>review</comment>
</data>
<data name="Settings_GameArt_Label" xml:space="preserve">
<value>ゲームのアートワークを表示</value>
<comment>review</comment>
</data>
<data name="Settings_GameArt_Body" xml:space="preserve">
<value>ゲームのページに、そのゲームに選んだ画像、なければ Steam または GOG GALAXY のアプリがこの PC に保存しているカバーとバナーを表示します。何もダウンロードしません。</value>
<comment>review</comment>
</data>
<data name="Settings_GameArtTint_Label" xml:space="preserve">
<value>アートワークの色でゲームのページを彩る</value>
<comment>review</comment>
</data>
<data name="Settings_GameArtTint_Body" xml:space="preserve">
<value>ページ上部の帯がアートワークの主な色になります。その上の文字が読みにくくなるほど濃くはしません。</value>
<comment>review</comment>
</data>
<data name="Art_Source_Steam" xml:space="preserve">
<value>この PC の Steam アプリのアートワーク</value>
<comment>review</comment>
</data>
<data name="Art_Source_Gog" xml:space="preserve">
<value>この PC の GOG GALAXY アプリのアートワーク</value>
<comment>review</comment>
</data>
<data name="Art_Source_Yours" xml:space="preserve">
<value>このゲームに選んだ画像</value>
<comment>review</comment>
</data>
<data name="Art_Cover_Name" xml:space="preserve">
<value>カバーアート</value>
<comment>review</comment>
</data>
<data name="Art_Banner_Name" xml:space="preserve">
<value>バナーアート</value>
<comment>review</comment>
</data>
<data name="Art_ImportFailed" xml:space="preserve">
<value>この画像は使えません。Windows で読み込めません。ゲームの画像はそのままです。</value>
<comment>review</comment>
</data>
<data name="EditGame_Image" xml:space="preserve">
<value>画像</value>
<comment>review</comment>
</data>
<data name="EditGame_ChooseImage" xml:space="preserve">
<value>画像を選ぶ…</value>
<comment>review</comment>
</data>
<data name="EditGame_UseStoreImage" xml:space="preserve">
<value>ストアの画像を使う</value>
<comment>review</comment>
</data>
<data name="EditGame_ImageNone" xml:space="preserve">
<value>画像なし</value>
<comment>review</comment>
</data>
<data name="EditGame_ImageNote" xml:space="preserve">
<value>コピーが FrameLedger のデータ フォルダーに保存されるので、選んだファイルは移動や削除をしても構いません。</value>
<comment>review</comment>
</data>
<data name="ImagePicker_Title" xml:space="preserve">
<value>ゲームの画像を選択</value>
<comment>review</comment>
</data>
<data name="ImagePicker_Filter" xml:space="preserve">
<value>画像 (*.png;*.jpg;*.jpeg;*.bmp;*.webp)|*.png;*.jpg;*.jpeg;*.bmp;*.webp</value>
<comment>review</comment>
</data>
</root>
+54
View File
@@ -3248,4 +3248,58 @@ The documents below are the full terms; this summary does not replace them.</val
<data name="Play_NotInLibrary_Format" xml:space="preserve">
<value>{0} is no longer in the library, so it was not started.</value>
</data>
<data name="Agent_Unanswered" xml:space="preserve">
<value>The capture agent did not answer, so whether this was done is not known. Check again once it is connected.</value>
</data>
<data name="Settings_GameArt_Label" xml:space="preserve">
<value>Show game artwork</value>
</data>
<data name="Settings_GameArt_Body" xml:space="preserve">
<value>A game's page shows the image you chose for it, or else the cover and banner the Steam or GOG GALAXY app keeps on this PC. Nothing is downloaded.</value>
</data>
<data name="Settings_GameArtTint_Label" xml:space="preserve">
<value>Colour the game page from its artwork</value>
</data>
<data name="Settings_GameArtTint_Body" xml:space="preserve">
<value>The band at the top of the page takes the artwork's main colour, never so strongly that a text on it stops being easy to read.</value>
</data>
<data name="Art_Source_Steam" xml:space="preserve">
<value>Artwork from the Steam app on this PC</value>
</data>
<data name="Art_Source_Gog" xml:space="preserve">
<value>Artwork from the GOG GALAXY app on this PC</value>
</data>
<data name="Art_Source_Yours" xml:space="preserve">
<value>The image you chose for this game</value>
</data>
<data name="Art_Cover_Name" xml:space="preserve">
<value>Cover art</value>
</data>
<data name="Art_Banner_Name" xml:space="preserve">
<value>Banner art</value>
</data>
<data name="Art_ImportFailed" xml:space="preserve">
<value>The image could not be used: Windows cannot read it. The game keeps the image it had.</value>
</data>
<data name="EditGame_Image" xml:space="preserve">
<value>Image</value>
</data>
<data name="EditGame_ChooseImage" xml:space="preserve">
<value>Choose image…</value>
</data>
<data name="EditGame_UseStoreImage" xml:space="preserve">
<value>Use the store's image</value>
</data>
<data name="EditGame_ImageNone" xml:space="preserve">
<value>No image</value>
</data>
<data name="EditGame_ImageNote" xml:space="preserve">
<value>A copy is kept in FrameLedger's data folder, so the file you pick can move or go.</value>
</data>
<data name="ImagePicker_Title" xml:space="preserve">
<value>Choose an image for the game</value>
</data>
<data name="ImagePicker_Filter" xml:space="preserve">
<value>Images (*.png;*.jpg;*.jpeg;*.bmp;*.webp)|*.png;*.jpg;*.jpeg;*.bmp;*.webp</value>
</data>
</root>
+54
View File
@@ -3243,4 +3243,58 @@ Các văn bản bên dưới là điều khoản đầy đủ; bản tóm tắt
<data name="Play_NotInLibrary_Format" xml:space="preserve">
<value>{0} không còn trong thư viện, nên không được chạy.</value>
</data>
<data name="Agent_Unanswered" xml:space="preserve">
<value>Capture agent không trả lời, nên không biết việc này đã được thực hiện hay chưa. Hãy kiểm tra lại khi agent đã kết nối.</value>
</data>
<data name="Settings_GameArt_Label" xml:space="preserve">
<value>Hiện ảnh của game</value>
</data>
<data name="Settings_GameArt_Body" xml:space="preserve">
<value>Trang của game hiện ảnh bạn đã chọn cho nó, nếu không có thì ảnh bìa và banner mà ứng dụng Steam hoặc GOG GALAXY lưu sẵn trên máy này. Không tải gì về.</value>
</data>
<data name="Settings_GameArtTint_Label" xml:space="preserve">
<value>Tô màu trang game theo ảnh</value>
</data>
<data name="Settings_GameArtTint_Body" xml:space="preserve">
<value>Dải đầu trang lấy màu chủ đạo của ảnh, không bao giờ đậm tới mức chữ trên đó khó đọc.</value>
</data>
<data name="Art_Source_Steam" xml:space="preserve">
<value>Ảnh từ ứng dụng Steam trên máy này</value>
</data>
<data name="Art_Source_Gog" xml:space="preserve">
<value>Ảnh từ ứng dụng GOG GALAXY trên máy này</value>
</data>
<data name="Art_Source_Yours" xml:space="preserve">
<value>Ảnh bạn đã chọn cho game này</value>
</data>
<data name="Art_Cover_Name" xml:space="preserve">
<value>Ảnh bìa</value>
</data>
<data name="Art_Banner_Name" xml:space="preserve">
<value>Ảnh banner</value>
</data>
<data name="Art_ImportFailed" xml:space="preserve">
<value>Không dùng được ảnh này: Windows không đọc được nó. Game giữ ảnh cũ.</value>
</data>
<data name="EditGame_Image" xml:space="preserve">
<value>Ảnh</value>
</data>
<data name="EditGame_ChooseImage" xml:space="preserve">
<value>Chọn ảnh…</value>
</data>
<data name="EditGame_UseStoreImage" xml:space="preserve">
<value>Dùng ảnh của store</value>
</data>
<data name="EditGame_ImageNone" xml:space="preserve">
<value>Không có ảnh</value>
</data>
<data name="EditGame_ImageNote" xml:space="preserve">
<value>Một bản sao được giữ trong thư mục dữ liệu của FrameLedger, nên tệp bạn chọn có thể dời đi hoặc xoá.</value>
</data>
<data name="ImagePicker_Title" xml:space="preserve">
<value>Chọn ảnh cho game</value>
</data>
<data name="ImagePicker_Filter" xml:space="preserve">
<value>Ảnh (*.png;*.jpg;*.jpeg;*.bmp;*.webp)|*.png;*.jpg;*.jpeg;*.bmp;*.webp</value>
</data>
</root>
@@ -159,7 +159,7 @@ public sealed partial class CompareViewModel : ObservableObject
SessionSeries? series = await _loader.LoadAsync(c.Id).ConfigureAwait(true);
if (series is not null)
{
(double[] xs, double[] ys) = PercentileCurve.Of(series.AppFrameTimesMs);
(double[] xs, double[] ys) = series.Digest?.Percentiles ?? PercentileCurve.Of(series.AppFrameTimesMs);
curves.Add(new CompareCurve(c.Label, xs, ys));
}
}
@@ -16,15 +16,21 @@ namespace FrameLedger.App.ViewModels;
/// value <c>N/A</c> until the Agent answered — never a placeholder that reads as a measurement), the live capture
/// card fed by the pipe's events, the recent sessions, and the totals strip.
/// </summary>
public sealed partial class DashboardViewModel : ObservableObject, IDisposable
/// <remarks>
/// <b>It listens only while its page is on screen (beta.23):</b> <see cref="Attach"/> on Loaded, <see cref="Detach"/> on
/// Unloaded, as the Games and game pages do. It subscribed in its constructor and unsubscribed in a Dispose nothing called —
/// the root container kept every Dashboard ever opened, each answering every event and reloading its lists on the UI thread
/// at every session's end. FR-3.8's notice, which it raised, is <see cref="SessionNotices"/>'s.
/// </remarks>
public sealed partial class DashboardViewModel : ObservableObject
{
private readonly IAgentLink _agent;
private readonly GameLibrary _library;
private readonly GameSelection _selection;
private readonly IPageNavigator _navigator;
private readonly ISessionSummaryOpener _summaries;
private readonly IMessageStrip _strip;
private readonly UiThread _ui = new();
private bool _attached;
[ObservableProperty]
private string _agentState = Strings.Agent_State_Connecting;
@@ -56,27 +62,17 @@ public sealed partial class DashboardViewModel : ObservableObject, IDisposable
[ObservableProperty]
private bool _recentEmpty = true;
private readonly IShellPresence? _presence;
private readonly LiveSessions? _sessions;
public DashboardViewModel(IAgentLink agent, GameLibrary library, GameSelection selection, IPageNavigator navigator, ISessionSummaryOpener summaries, IMessageStrip strip, IShellPresence? presence = null,
public DashboardViewModel(IAgentLink agent, GameLibrary library, GameSelection selection, IPageNavigator navigator, ISessionSummaryOpener summaries,
LiveSessions? sessions = null)
{
_presence = presence;
_sessions = sessions;
_agent = agent ?? throw new ArgumentNullException(nameof(agent));
_library = library ?? throw new ArgumentNullException(nameof(library));
_selection = selection ?? throw new ArgumentNullException(nameof(selection));
_navigator = navigator ?? throw new ArgumentNullException(nameof(navigator));
_summaries = summaries ?? throw new ArgumentNullException(nameof(summaries));
_strip = strip ?? throw new ArgumentNullException(nameof(strip));
_agent.Changed += OnAgentChanged;
_agent.EventReceived += OnAgentEvent;
if (_sessions is not null)
{
_sessions.Changed += OnSessionsChanged;
}
Refresh();
SeedLive();
Pending = LoadAsync();
@@ -103,14 +99,44 @@ public sealed partial class DashboardViewModel : ObservableObject, IDisposable
/// <summary>The load in flight, for a test to await.</summary>
public Task Pending { get; private set; }
public void Dispose()
/// <summary>
/// Listens to the Agent and to the running sessions while the page is on screen (beta.23): the page calls it on Loaded
/// and <see cref="Detach"/> on Unloaded. What changed before it listened is read again here.
/// </summary>
public void Attach()
{
if (_attached)
{
return;
}
_agent.Changed += OnAgentChanged;
_agent.EventReceived += OnAgentEvent;
if (_sessions is not null)
{
_sessions.Changed += OnSessionsChanged;
}
_attached = true;
Refresh();
SeedLive();
}
public void Detach()
{
if (!_attached)
{
return;
}
_agent.Changed -= OnAgentChanged;
_agent.EventReceived -= OnAgentEvent;
if (_sessions is not null)
{
_sessions.Changed -= OnSessionsChanged;
}
_attached = false;
}
public async Task LoadAsync(CancellationToken ct = default)
@@ -191,10 +217,8 @@ public sealed partial class DashboardViewModel : ObservableObject, IDisposable
Live.Hold(held);
break;
case IpcMessageType.SessionCompleted when IpcCodec.Payload<SessionCompletedEvent>(envelope) is { } completed:
// The session's own name (2026-09-23): the card may show another session, and a Tier-2 one had none here.
string? name = completed.GameName ?? (Live.SessionGuid == completed.SessionGuid ? Live.GameName : null);
// FR-3.8's notice is SessionNotices' (beta.23); the card and the lists are this page's.
Live.Stop(completed);
Notice(completed, name);
SeedLive();
Pending = LoadAsync();
break;
@@ -203,27 +227,6 @@ public sealed partial class DashboardViewModel : ObservableObject, IDisposable
}
}
/// <summary>FR-3.8's post-session notice, in-app while the window is on screen; the tray's balloon carries it otherwise (P3 PR-8b, one event → one channel). A safety stop is never a toast (08_UI §Notifications policy) — the shell's notices carry those.</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")]
private void Notice(SessionCompletedEvent completed, string? name)
{
// A faulted session is the strip's CaptureError already; "discarded" would say something that did not happen.
if (_presence is { IsShown: false } || string.Equals(completed.Finalize, "faulted", StringComparison.Ordinal))
{
return;
}
string game = name is { Length: > 0 } ? name : Strings.Common_NotAvailable;
if (completed.SessionId is not null)
{
_strip.Success(Strings.Dashboard_Live_Header, string.Format(CultureInfo.CurrentCulture, Strings.Dashboard_SessionSaved_Format, game));
}
else
{
_strip.Info(Strings.Dashboard_Live_Header, string.Format(CultureInfo.CurrentCulture, Strings.Dashboard_SessionDiscarded_Format, game));
}
}
private void Refresh()
{
AgentState = AgentStatusPresentation.Pill(_agent.State).Text;
@@ -2,20 +2,47 @@
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.Text.Json;
using System.Windows.Media;
using CommunityToolkit.Mvvm.ComponentModel;
using CommunityToolkit.Mvvm.Input;
using FrameLedger.App.Services;
using FrameLedger.Application.Persistence;
namespace FrameLedger.App.ViewModels;
/// <summary>
/// FR-1.3: the four fields a user edits most (name, publisher, version, notes); the rest of <see cref="GameMetadata"/>
/// passes through unchanged. A field detection filled in (<c>field_provenance</c> = <c>detected</c>) is badged so the
/// user knows what they are overriding.
/// FR-1.3: the four fields a user edits most (name, publisher, version, notes) and, since beta.23 (D60), the game's image;
/// the rest of <see cref="GameMetadata"/> passes through unchanged. A field detection filled in (<c>field_provenance</c> =
/// <c>detected</c>) is badged so the user knows what they are overriding.
/// </summary>
/// <remarks>
/// A picked image is only previewed here: it is copied into the data folder once the dialog closed with Save
/// (<see cref="GameEdit.PickedImage"/>), so Cancel leaves nothing behind.
/// </remarks>
public sealed partial class EditGameViewModel : ObservableObject
{
private readonly GameMetadata _original;
private readonly EditImage? _image;
// The user went back to the store's image: the row's own image is dropped on Save.
private bool _dropOwn;
[ObservableProperty]
[NotifyPropertyChangedFor(nameof(HasImagePreview))]
private ImageSource? _imagePreview;
/// <summary>The image file picked in this dialog, copied on Save; null when none was picked.</summary>
[ObservableProperty]
[NotifyPropertyChangedFor(nameof(CanUseStoreImage))]
private string? _pickedImage;
/// <summary>The last pick could not be read as an image (shown under the buttons); null otherwise.</summary>
[ObservableProperty]
private string? _imageError;
[ObservableProperty]
[NotifyPropertyChangedFor(nameof(CanUseStoreImage))]
private bool _showsOwnImage;
[ObservableProperty]
private string _name;
@@ -29,9 +56,12 @@ public sealed partial class EditGameViewModel : ObservableObject
[ObservableProperty]
private string _notes;
public EditGameViewModel(GameMetadata current, string? provenanceJson)
public EditGameViewModel(GameMetadata current, string? provenanceJson, EditImage? image = null)
{
_original = current ?? throw new ArgumentNullException(nameof(current));
_image = image;
_imagePreview = image?.Current;
_showsOwnImage = image is { CurrentIsOwn: true };
_name = current.Name;
_publisher = current.Publisher ?? string.Empty;
_version = current.GameVersion ?? string.Empty;
@@ -60,17 +90,76 @@ public sealed partial class EditGameViewModel : ObservableObject
public static string DetectedBadge => Strings.EditGame_Detected;
public static string ImageLabel => Strings.EditGame_Image;
public static string ChooseImageText => Strings.EditGame_ChooseImage;
public static string UseStoreImageText => Strings.EditGame_UseStoreImage;
public static string ImageNoneText => Strings.EditGame_ImageNone;
public static string ImageNote => Strings.EditGame_ImageNote;
public static string CoverName => Strings.Art_Cover_Name;
/// <summary>Whether the dialog has an image row: the game page passed what it shows.</summary>
public bool ImageEditable => _image is not null;
public bool HasImagePreview => ImagePreview is not null;
/// <summary>The image shown is the user's own (kept or just picked), so going back to the store's means something.</summary>
public bool CanUseStoreImage => PickedImage is not null || ShowsOwnImage;
public bool CanSave => !string.IsNullOrWhiteSpace(Name);
/// <summary>The metadata to store: the four fields as typed (blank → null), everything else as it was.</summary>
/// <summary>
/// The metadata to store: the four fields as typed (blank → null), the row's own image dropped when the user went back to
/// the store's, everything else as it was.
/// </summary>
public GameMetadata Result() => _original with
{
Name = Name.Trim(),
Publisher = Blank(Publisher),
GameVersion = Blank(Version),
Notes = Blank(Notes),
CoverPath = _dropOwn ? null : _original.CoverPath,
};
/// <summary>What Save answers: <see cref="Result"/> and the image picked in this dialog.</summary>
public GameEdit Edit() => new(Result(), PickedImage);
/// <summary>"Choose image…": the picked file previewed; it is copied only on Save, and one that cannot be read is said here.</summary>
[RelayCommand]
private async Task ChooseImageAsync()
{
if (_image?.Picker.PickImage() is not { } path)
{
return;
}
if (await _image.Preview(path).ConfigureAwait(true) is { } preview)
{
PickedImage = path;
ImagePreview = preview;
ImageError = null;
}
else
{
ImageError = Strings.Art_ImportFailed;
}
}
/// <summary>"Use the store's image": the pick and the row's own image dropped; the page shows the store's again.</summary>
[RelayCommand]
private void UseStoreImage()
{
PickedImage = null;
_dropOwn = _original.CoverPath is not null;
ShowsOwnImage = false;
ImagePreview = _image?.Store;
ImageError = null;
}
partial void OnNameChanged(string value) => OnPropertyChanged(nameof(CanSave));
private static string? Blank(string value) => string.IsNullOrWhiteSpace(value) ? null : value.Trim();
@@ -6,6 +6,7 @@ using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.IO;
using System.Text.Json;
using System.Windows.Media;
using CommunityToolkit.Mvvm.ComponentModel;
using CommunityToolkit.Mvvm.Input;
using FrameLedger.App.Charts;
@@ -49,6 +50,10 @@ public sealed partial class GameDetailViewModel : ObservableObject
private readonly RegisteredSettings? _settings;
private readonly AntiCheatExceptions? _exceptions;
private readonly SessionDeletion? _deletion;
private readonly Func<string, bool> _exists;
private readonly GameArt? _art;
private readonly CoverStore? _covers;
private readonly IImagePicker? _images;
private readonly long? _gameId;
// ui.hide_anticheat_hooking (2026-09-25), read at each load; on until the settings say otherwise, as its default is.
@@ -76,6 +81,48 @@ public sealed partial class GameDetailViewModel : ObservableObject
[NotifyCanExecuteChangedFor(nameof(PlayCommand))]
private bool _executableMissing;
/// <summary>
/// The missing executable's bar (beta.8): the page's sentence, then whether the DRIVE is not connected or the file is gone
/// from its path — the two need different things of the user. Worked out with the check, off the UI thread (beta.23): it
/// asked the drive from this property's getter, on the UI thread, at every read.
/// </summary>
[ObservableProperty]
private string _executableMissingMessage = ExecutableMissingText;
// Why the executable is missing, from the last load's check (beta.23); null while it was found.
private string? _executableMissingWhy;
/// <summary>
/// beta.23 (D60): the game's artwork — the image the user chose, else the store's own cover, else its landscape header;
/// null with none. Shown in the header band beside the name.
/// </summary>
[ObservableProperty]
private ImageSource? _artCover;
/// <summary>The cover slot holds the store's landscape header (no portrait cover): drawn wider and shorter.</summary>
[ObservableProperty]
private bool _artCoverIsLandscape;
/// <summary>The store's wide banner, above the header band; null without one.</summary>
[ObservableProperty]
private ImageSource? _artHero;
/// <summary>D61: the colour the header band takes from the artwork; null leaves it the card's own fill.</summary>
[ObservableProperty]
private Color? _artTint;
/// <summary>The page shows artwork: the band, the cover, the banner.</summary>
[ObservableProperty]
private bool _hasArt;
/// <summary>Where the artwork came from, for its tooltip.</summary>
[ObservableProperty]
private string? _artSource;
// What the edit dialog needs: whether the cover is the user's own, and the store's own cover to go back to.
private bool _artCoverIsOwn;
private ImageSource? _artStoreCover;
/// <summary>What Play will do, in the mode Settings ▸ Games has now (beta.21, D59).</summary>
[ObservableProperty]
private string _playToolTip = Strings.Play_ToolTip_Store;
@@ -233,8 +280,15 @@ public sealed partial class GameDetailViewModel : ObservableObject
IConfirmations confirmations, IEditGamePrompt edit, IMessageStrip strip, ISessionSummaryOpener summaries,
SessionSeriesLoader loader, IHardwareSnapshotRepository hardware, SessionSelection sessionSelection, IGamePicker picker,
RegisteredSettings? settings = null, IAgentLink? agent = null, AntiCheatExceptions? exceptions = null, SessionDeletion? deletion = null,
UiMode? mode = null, GamePlayer? player = null)
UiMode? mode = null, GamePlayer? player = null, Func<string, bool>? executableExists = null, GameArt? art = null, CoverStore? covers = null,
IImagePicker? images = null)
{
_art = art;
_covers = covers;
_images = images;
// beta.23: whether the executable is on disk is a question for its drive, which can take seconds to answer (the
// owner's games are on a USB drive), so it is asked off the UI thread, as the library page has asked since beta.19.
_exists = executableExists ?? GameLibrary.ExecutableExists;
// beta.15 (D52): a viewer over a copy has no Agent to ask; a composition without a mode (a test) is the profile's App.
_player = player;
_mode = mode ?? UiMode.Profile;
@@ -282,14 +336,6 @@ public sealed partial class GameDetailViewModel : ObservableObject
public static string ExecutableMissingText => Strings.GameDetail_ExeMissing;
/// <summary>
/// The missing executable's bar (beta.8): the page's sentence, then whether the DRIVE is not connected or the file is gone
/// from its path — the two need different things of the user.
/// </summary>
public string ExecutableMissingMessage => Game is null
? ExecutableMissingText
: ExecutableMissingText + " " + Formats.ExecutableMissingText(Game.Fingerprint.ExePath);
public static string LifetimeLabel => Strings.GameDetail_LifetimeAvg;
public static string SupportsHeader => Strings.GameDetail_Supports_Header;
@@ -455,6 +501,10 @@ public sealed partial class GameDetailViewModel : ObservableObject
return;
}
string exePath = detail.Row.Fingerprint.ExePath;
Func<string, bool> exists = _exists;
_executableMissingWhy = await Task.Run(() => exists(exePath) ? null : Formats.ExecutableMissingText(exePath), ct).ConfigureAwait(true);
Game = detail.Row;
_detail = detail;
NotFound = false;
@@ -472,7 +522,24 @@ public sealed partial class GameDetailViewModel : ObservableObject
Present(detail);
AnyLatency = detail.Sessions.Any(static s => s.ReflexActive == true);
ChooseDefaultMetric(detail);
// beta.23 (D60): the artwork is looked for and decoded on the thread pool while the trend is drawn; the page's text is
// already there, and a reload keeps the picture it has until the new one is ready.
Task<GameArtView?> art = _art?.ForAsync(detail.Row, ct) ?? Task.FromResult<GameArtView?>(null);
await RebuildTrendAsync(ct).ConfigureAwait(true);
PresentArt(await art.ConfigureAwait(true));
}
private void PresentArt(GameArtView? view)
{
ArtCover = view?.Cover;
ArtCoverIsLandscape = view?.CoverIsLandscape ?? false;
ArtHero = view?.Hero;
ArtTint = view?.Tint;
ArtSource = view?.Source;
_artCoverIsOwn = view?.CoverIsOwn ?? false;
_artStoreCover = view?.StoreCover;
HasArt = view is not null;
}
partial void OnSelectedSessionChanged(SessionItemViewModel? value)
@@ -842,13 +909,39 @@ public sealed partial class GameDetailViewModel : ObservableObject
return;
}
GameMetadata? edited = await _edit.EditAsync(GameMetadata.Of(Game), Game.FieldProvenanceJson).ConfigureAwait(true);
if (edited is null)
// beta.23 (D60): the dialog's image row, when this page has artwork to show and somewhere to keep a chosen image.
GameArt? art = _art;
EditImage? image = art is not null && _covers is not null && _images is not null
? new EditImage(ArtCover, _artCoverIsOwn, _artStoreCover, _images, async path => await art.PreviewAsync(path, 192).ConfigureAwait(true))
: null;
GameEdit? edit = await _edit.EditAsync(GameMetadata.Of(Game), Game.FieldProvenanceJson, image).ConfigureAwait(true);
if (edit is null)
{
return;
}
GameMetadata edited = edit.Metadata;
string? before = Game.CoverPath;
if (edit.PickedImage is { } picked && _covers is not null)
{
// Copied only now that the dialog closed with Save; a file that cannot be used leaves the image the game had.
if (await _covers.ImportAsync(Game.Id, picked).ConfigureAwait(true) is { } copied)
{
edited = edited with { CoverPath = copied };
}
else
{
edited = edited with { CoverPath = before };
_strip.Warn(Strings.EditGame_Title, Strings.Art_ImportFailed);
}
}
await _library.UpdateMetadataAsync(Game.Id, edited).ConfigureAwait(true);
if (before is not null && !string.Equals(before, edited.CoverPath, StringComparison.OrdinalIgnoreCase))
{
_covers?.Delete(before);
}
_strip.Success(Strings.EditGame_Title, Strings.EditGame_Saved);
await LoadAsync().ConfigureAwait(true);
}
@@ -910,6 +1003,12 @@ public sealed partial class GameDetailViewModel : ObservableObject
if (!result.Succeeded)
{
_strip.Warn(Game.Name, result.Message);
if (result.Outcome == SessionDeletionOutcome.Unanswered)
{
// beta.22: the delete may have run — the page shows what is stored, not what it held before the ask.
await LoadAsync().ConfigureAwait(true);
}
return;
}
@@ -938,7 +1037,17 @@ public sealed partial class GameDetailViewModel : ObservableObject
}
string name = Game.Name;
await _library.RemoveAsync(Game.Id, keepSessions: choice == RemoveGameChoice.KeepSessions).ConfigureAwait(true);
string? cover = Game.CoverPath;
bool keepSessions = choice == RemoveGameChoice.KeepSessions;
bool removed = await _library.RemoveAsync(Game.Id, keepSessions).ConfigureAwait(true);
// beta.23 (D60): a game removed with its sessions is gone, and its own image with it; one removed with its sessions
// kept comes back with them when it is added again, and keeps its image.
if (removed && !keepSessions)
{
_covers?.Delete(cover);
}
_strip.Info(Strings.Games_Header, string.Format(CultureInfo.CurrentCulture, Strings.RemoveGame_Removed_Format, name));
_navigator.Navigate<GamesPage>();
}
@@ -1009,9 +1118,11 @@ public sealed partial class GameDetailViewModel : ObservableObject
HookingConsentOutcome.Refused => (result.RefusalText(), InfoBarSeverity.Error),
HookingConsentOutcome.VersionMismatch => (Shared.Strings.Safety_Consent_VersionMismatch, InfoBarSeverity.Warning),
HookingConsentOutcome.AgentUnavailable => (turningOff ? Strings.Agent_NotConnected_NothingChanged : Shared.Strings.Safety_Consent_AgentUnavailable, InfoBarSeverity.Warning),
// beta.22: the page reads what is stored after every ask, so whether hooking changed is shown beside this.
HookingConsentOutcome.Unanswered => (Strings.Agent_Unanswered, InfoBarSeverity.Warning),
// The Agent could not read the executable (beta.8): say whether its drive or the file is missing, not the IPC code.
HookingConsentOutcome.Failed when string.Equals(result.Detail, Shared.Ipc.IpcErrorCode.ExecutableUnreadable, StringComparison.Ordinal) && Game is not null
=> (Formats.ExecutableMissingText(Game.Fingerprint.ExePath), InfoBarSeverity.Warning),
=> (_executableMissingWhy ?? Formats.ExecutableMissingText(Game.Fingerprint.ExePath), InfoBarSeverity.Warning),
HookingConsentOutcome.Failed => (result.Detail ?? Strings.Common_NotAvailable, InfoBarSeverity.Warning),
_ => (null, InfoBarSeverity.Informational),
};
@@ -1029,8 +1140,8 @@ public sealed partial class GameDetailViewModel : ObservableObject
: [row.Publisher, row.GameVersion, Formats.Platform(row.Platform), EngineText(row)];
Subtitle = string.Join(" · ", subtitle.Where(static s => !string.IsNullOrWhiteSpace(s)));
ExecutableText = row.Fingerprint.ExePath;
ExecutableMissing = !GameLibrary.ExecutableExists(row.Fingerprint.ExePath);
OnPropertyChanged(nameof(ExecutableMissingMessage));
ExecutableMissing = _executableMissingWhy is not null;
ExecutableMissingMessage = _executableMissingWhy is { } why ? ExecutableMissingText + " " + why : ExecutableMissingText;
SessionRow? last = detail.Sessions.Count > 0 ? detail.Sessions[0] : null;
SessionRow? lastHooked = detail.Sessions.FirstOrDefault(static s => s.Tier == CaptureTier.Hooked && s.FrameCount > 0);
+71 -11
View File
@@ -19,7 +19,7 @@ namespace FrameLedger.App.ViewModels;
/// Loaded/Unloaded) and never while paused; the read runs off the UI thread and the result lands on it.
/// </summary>
[SuppressMessage("Performance", "CA1863:Use 'CompositeFormat'", Justification = "the format strings are resources that follow the UI culture, which changes at runtime")]
public sealed partial class LogsViewModel : ObservableObject, IDisposable
public sealed partial class LogsViewModel : ObservableObject
{
public static readonly TimeSpan RefreshPeriod = TimeSpan.FromSeconds(2);
@@ -31,6 +31,9 @@ public sealed partial class LogsViewModel : ObservableObject, IDisposable
private IReadOnlyList<string> _lines = [];
private ITimer? _timer;
// What the last read read (beta.23): a tick that finds the newest file unchanged reads nothing and redraws nothing.
private (string? File, long Length, DateTime WrittenUtc) _read;
[ObservableProperty]
private LogSource _source = LogSource.Ui;
@@ -93,15 +96,17 @@ public sealed partial class LogsViewModel : ObservableObject, IDisposable
_timer = _clock.CreateTimer(_ => _ui.Post(Tick), null, RefreshPeriod, RefreshPeriod);
}
/// <summary>Stops it (the page's Unloaded) — a page that is not shown reads nothing.</summary>
/// <summary>
/// Stops it (the page's Unloaded) — a page that is not shown reads nothing. Not <see cref="IDisposable"/> (beta.23): the
/// root container kept every transient disposable it made, so every Logs page ever opened stayed in memory with its
/// up-to-2-MB tail, twice (the lines and the text).
/// </summary>
public void Stop()
{
_timer?.Dispose();
_timer = null;
}
public void Dispose() => Stop();
public Task RefreshAsync() => Pending = RefreshCoreAsync();
partial void OnSourceChanged(LogSource value) => Pending = RefreshCoreAsync();
@@ -131,28 +136,83 @@ public sealed partial class LogsViewModel : ObservableObject, IDisposable
{
if (!IsPaused)
{
Pending = RefreshCoreAsync();
Pending = RefreshIfChangedAsync();
}
}
private async Task RefreshCoreAsync()
/// <summary>What a tick does: the tail again only when the newest file changed since the last read.</summary>
internal Task RefreshIfChangedAsync() => RefreshCoreAsync(unlessUnchanged: true);
/// <summary>
/// Reads the newest file's tail and shows it through the filters. A tick (<paramref name="unlessUnchanged"/>) whose file
/// has the length and the write time of the last read stops there (beta.23): it re-read up to 2 MB and replaced the whole
/// text every two seconds while nothing had been written. The filtering and the joining happen off the UI thread too.
/// </summary>
private async Task RefreshCoreAsync(bool unlessUnchanged = false)
{
LogSource source = Source;
(string? file, IReadOnlyList<string> lines) = await Task.Run(() =>
LogLevelFilter level = Level;
string search = Search;
(string? File, long Length, DateTime WrittenUtc) last = _read;
(bool unchanged, (string? File, long Length, DateTime WrittenUtc) read, IReadOnlyList<string> lines, IReadOnlyList<string> shown, string text) = await Task.Run(() =>
{
string? newest = _tail.NewestFile(source);
return (newest, newest is null ? [] : LogTail.ReadLines(newest));
(string? File, long Length, DateTime WrittenUtc) stamp = Stamp(newest);
if (unlessUnchanged && stamp.File is not null && stamp == last)
{
return (true, stamp, (IReadOnlyList<string>)[], (IReadOnlyList<string>)[], string.Empty);
}
IReadOnlyList<string> all = newest is null ? [] : LogTail.ReadLines(newest);
IReadOnlyList<string> filtered = LogTail.Filter(all, level, search);
return (false, stamp, all, filtered, string.Join(Environment.NewLine, filtered));
}).ConfigureAwait(true);
CurrentFile = file;
if (unchanged)
{
return;
}
_read = read;
CurrentFile = read.File;
_lines = lines;
Apply();
if (level == Level && string.Equals(search, Search, StringComparison.Ordinal))
{
Show(shown, text);
}
else
{
Apply(); // the filters changed while the file was read
}
}
private static (string? File, long Length, DateTime WrittenUtc) Stamp(string? file)
{
if (file is null)
{
return (null, 0, default);
}
try
{
var info = new FileInfo(file);
return info.Exists ? (file, info.Length, info.LastWriteTimeUtc) : (file, -1, default);
}
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException)
{
return (file, -1, default);
}
}
private void Apply()
{
IReadOnlyList<string> shown = LogTail.Filter(_lines, Level, Search);
Show(shown, string.Join(Environment.NewLine, shown));
}
private void Show(IReadOnlyList<string> shown, string text)
{
ShownCount = shown.Count;
Text = string.Join(Environment.NewLine, shown);
Text = text;
Status = CurrentFile is null
? Strings.Logs_Empty
: string.Format(CultureInfo.CurrentCulture, Strings.Logs_Showing_Format, ShownCount, TotalCount, Path.GetFileName(CurrentFile));
@@ -120,6 +120,14 @@ public sealed partial class SettingsViewModel : ObservableObject
[ObservableProperty]
private bool _onlineMetadata;
/// <summary><c>ui.game_art</c> (beta.23, D60): a game's page shows its artwork — the user's image, else the store app's own.</summary>
[ObservableProperty]
private bool _gameArt = true;
/// <summary><c>ui.game_art_tint</c> (beta.23, D61): the page's header band takes the artwork's colour, as far as its text stays readable.</summary>
[ObservableProperty]
private bool _gameArtTint = true;
[ObservableProperty]
private string _updateChannel = "stable";
@@ -491,6 +499,10 @@ public sealed partial class SettingsViewModel : ObservableObject
partial void OnOnlineMetadataChanged(bool value) => Persist(SettingsRegistry.PrivacyOnlineMetadata, value);
partial void OnGameArtChanged(bool value) => Persist(SettingsRegistry.UiGameArt, value);
partial void OnGameArtTintChanged(bool value) => Persist(SettingsRegistry.UiGameArtTint, value);
partial void OnUpdateChannelChanged(string value) => Persist(SettingsRegistry.UpdateChannel, value);
partial void OnPlayModeChanged(string value) => Persist(SettingsRegistry.UiPlayMode, value);
@@ -562,6 +574,8 @@ public sealed partial class SettingsViewModel : ObservableObject
FpsTwoDecimals = await _settings.GetBooleanAsync(SettingsRegistry.UiFpsDecimals).ConfigureAwait(true);
HideScrollBars = await _settings.GetBooleanAsync(SettingsRegistry.UiHideScrollBars).ConfigureAwait(true);
OnlineMetadata = await _settings.GetBooleanAsync(SettingsRegistry.PrivacyOnlineMetadata).ConfigureAwait(true);
GameArt = await _settings.GetBooleanAsync(SettingsRegistry.UiGameArt).ConfigureAwait(true);
GameArtTint = await _settings.GetBooleanAsync(SettingsRegistry.UiGameArtTint).ConfigureAwait(true);
UpdateChannel = await _settings.GetAsync(SettingsRegistry.UpdateChannel).ConfigureAwait(true);
PlayMode = await _settings.GetAsync(SettingsRegistry.UiPlayMode).ConfigureAwait(true);
AutoCheckUpdates = await _settings.GetBooleanAsync(SettingsRegistry.UpdateAutoCheck).ConfigureAwait(true);
@@ -736,6 +750,14 @@ public sealed partial class SettingsViewModel : ObservableObject
return;
}
if (result.Outcome == HookingConsentOutcome.Unanswered)
{
// beta.22: whether hooking was turned off is not known — the list is read again from what is stored.
_strip.Warn(game.Name, Strings.Agent_Unanswered);
await RefreshCoreAsync().ConfigureAwait(true);
return;
}
// Turning off with no Agent changed nothing (beta.18): it said the enable path's "Nothing was enabled."
string body = result.Outcome == HookingConsentOutcome.AgentUnavailable ? Strings.Agent_NotConnected_NothingChanged : result.Detail ?? Strings.Common_NotAvailable;
_strip.Warn(game.Name, body);
@@ -0,0 +1,17 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
namespace FrameLedger.Application.Art;
/// <summary>
/// The artwork a store's own app keeps on this PC for one game (beta.23, owner decision D60): the full paths of its portrait
/// cover, its wide banner and its landscape header, each null when that app keeps none. FrameLedger downloads none of it and
/// copies none of it; it shows these files from where the store's app put them.
/// </summary>
public sealed record GameArtFiles(string? Cover, string? Hero, string? Header)
{
/// <summary>No artwork: the store keeps none, is not installed, or the id is not one of its own.</summary>
public static GameArtFiles None { get; } = new(null, null, null);
public bool IsEmpty => Cover is null && Hero is null && Header is null;
}
@@ -0,0 +1,18 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
namespace FrameLedger.Application.Art;
/// <summary>
/// One store app's own artwork folder on this PC (beta.23, owner decision D60): Steam's <c>appcache\librarycache</c>, GOG
/// GALAXY's <c>webcache</c>. Read-only. A store that is not installed, an id that is not of the store's own shape, or a
/// folder with nothing in it answers <see cref="GameArtFiles.None"/>, never an error. Which store installed a game is
/// asked of the stores' own records, as Play asks (<c>Play.StoreRecords.Owning</c>) — never of the row's platform alone.
/// </summary>
public interface IStoreArtCache
{
/// <summary><c>steam</c> · <c>gog</c> — <c>games.platform</c>'s vocabulary.</summary>
string Platform { get; }
GameArtFiles Find(string storeId);
}
@@ -103,6 +103,29 @@ public static class SettingsRegistry
Choices = ["store", "direct"],
};
/// <summary>
/// Whether a game's page shows its artwork (beta.23, owner decision D60): the image the user chose for it, else the one
/// the app of the store that installed it keeps on this PC — Steam's and GOG GALAXY's; nothing is downloaded. On by
/// default. Settings ▸ Games; the Agent never reads it.
/// </summary>
public static readonly SettingDefinition UiGameArt = new()
{
Key = "ui.game_art",
Kind = SettingKind.Boolean,
Default = "1",
};
/// <summary>
/// Whether the band at the top of a game's page takes the colour of its artwork (beta.23, owner decision D61), at the
/// strongest opacity that keeps every text on it readable. On by default (owner's choice). Settings ▸ Games.
/// </summary>
public static readonly SettingDefinition UiGameArtTint = new()
{
Key = "ui.game_art_tint",
Kind = SettingKind.Boolean,
Default = "1",
};
/// <summary>
/// Whether the Agent's watcher records tracked games that the App did not launch (FR-3.1/FR-3.3). <b>Reserved since
/// beta.12:</b> the App showed a switch for it ("Record games launched outside FrameLedger") and no Agent code ever read
@@ -245,7 +268,7 @@ public static class SettingsRegistry
public static IReadOnlyList<SettingDefinition> All { get; } =
[
UiLanguage, UiTheme, UiStartWithWindows, UiMinimizeToTray, UiHideAntiCheatHooking, UiFpsDecimals, UiHideScrollBars, UiLibraryView, UiPlayMode,
CaptureBackground, HookingKillSwitch, HookingUserModeExceptions, CaptureRunElevated, CaptureMinSessionSeconds, TelemetryIntervalMs, RetentionRawSessionsPerGame,
UiGameArt, UiGameArtTint, CaptureBackground, HookingKillSwitch, HookingUserModeExceptions, CaptureRunElevated, CaptureMinSessionSeconds, TelemetryIntervalMs, RetentionRawSessionsPerGame,
RetentionRemoveUninstalledGames, UpdateChannel, UpdateAutoCheck, PrivacyOnlineMetadata, LogDebug,
];
@@ -0,0 +1,58 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using FrameLedger.Application.Art;
namespace FrameLedger.Infrastructure.Art;
/// <summary>
/// The artwork GOG GALAXY keeps for each game in its library (beta.23, owner decision D60), under
/// <c>%ProgramData%\GOG.com\Galaxy\webcache\&lt;user&gt;\gog\&lt;productId&gt;\</c> — read on the owner's PC on 2026-10-14 (80
/// products): <c>&lt;sha256&gt;_glx_vertical_cover.webp</c> (the cover), <c>&lt;sha256&gt;_glx_bg_top_padding_7.webp</c> (the
/// banner) and a square icon, WebP that Windows' own WebP codec decodes (an optional Store component: without it the
/// game simply has no image). Every Galaxy user's folder is looked in, the newest copy wins. GOG keeps no header.
/// </summary>
public sealed class GogArtCache(string? webcacheRoot = null) : IStoreArtCache
{
public static string DefaultRoot => Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData), "GOG.com", "Galaxy", "webcache");
public string Platform => "gog";
public GameArtFiles Find(string storeId)
{
if (!SteamArtCache.IsNumericId(storeId))
{
return GameArtFiles.None;
}
try
{
var root = new DirectoryInfo(webcacheRoot ?? DefaultRoot);
if (!root.Exists)
{
return GameArtFiles.None;
}
List<FileInfo> files = [];
foreach (DirectoryInfo user in root.EnumerateDirectories().Where(static d => !d.Attributes.HasFlag(FileAttributes.ReparsePoint)))
{
var product = new DirectoryInfo(Path.Combine(user.FullName, "gog", storeId));
if (product.Exists && !product.Attributes.HasFlag(FileAttributes.ReparsePoint))
{
files.AddRange(product.EnumerateFiles());
}
}
return new GameArtFiles(Newest(files, "_glx_vertical_cover."), Newest(files, "_glx_bg_top_padding_") ?? Newest(files, "_glx_background"), null);
}
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException or System.Security.SecurityException)
{
return GameArtFiles.None;
}
}
private static string? Newest(IEnumerable<FileInfo> files, string marker) => files
.Where(f => f.Name.Contains(marker, StringComparison.OrdinalIgnoreCase) && f.Length > 0)
.OrderByDescending(static f => f.LastWriteTimeUtc)
.FirstOrDefault()?.FullName;
}
@@ -0,0 +1,79 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using FrameLedger.Application.Art;
using FrameLedger.Infrastructure.Import;
namespace FrameLedger.Infrastructure.Art;
/// <summary>
/// The artwork the Steam app keeps for each game it shows (beta.23, owner decision D60), under
/// <c>&lt;Steam&gt;\appcache\librarycache\&lt;appid&gt;\</c> — read on the owner's PC on 2026-10-14 (3,082 app folders) in two
/// layouts, sometimes both in one folder: the files directly in the app's folder (<c>library_600x900.jpg</c>,
/// <c>library_hero.jpg</c>, <c>header.jpg</c>), or each in a folder named by a hash (<c>library_capsule.jpg</c>,
/// <c>library_hero.jpg</c>, <c>library_header.jpg</c>). The cover is 300×450, the banner 1920×620, the header 460×215 as Steam
/// keeps them. The folder's own index (<c>assetcache.vdf</c>) is binary and not read: the names say what each file is, and
/// where an asset was replaced its newest copy wins. The Steam root is <c>HKCU\Software\Valve\Steam\SteamPath</c>, as the
/// import reads it, unless a test hands one in.
/// </summary>
public sealed class SteamArtCache(string? steamRoot = null) : IStoreArtCache
{
private static readonly string[] _covers = ["library_600x900_2x.jpg", "library_600x900.jpg", "library_capsule.jpg"];
private static readonly string[] _heroes = ["library_hero.jpg"];
private static readonly string[] _headers = ["header.jpg", "library_header.jpg"];
public string Platform => "steam";
public GameArtFiles Find(string storeId)
{
if (!IsNumericId(storeId) || (steamRoot ?? SteamLibrarySource.InstalledRoot()) is not { } root)
{
return GameArtFiles.None;
}
try
{
var folder = new DirectoryInfo(Path.Combine(root, "appcache", "librarycache", storeId));
if (!folder.Exists)
{
return GameArtFiles.None;
}
List<FileInfo> files = [.. folder.EnumerateFiles()];
foreach (DirectoryInfo hashed in folder.EnumerateDirectories().Where(static d => !d.Attributes.HasFlag(FileAttributes.ReparsePoint)))
{
files.AddRange(hashed.EnumerateFiles());
}
return new GameArtFiles(Newest(files, _covers), Newest(files, _heroes), Newest(files, _headers));
}
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException or System.Security.SecurityException)
{
return GameArtFiles.None;
}
}
/// <summary>
/// A store id that is digits only — Steam's app ids and GOG's product ids are — so a row's id can name no other folder
/// (<c>..\</c>, a rooted path) when it is joined to the store's own.
/// </summary>
internal static bool IsNumericId(string? id) => id is { Length: > 0 and <= 12 } && id.All(char.IsAsciiDigit);
/// <summary>The first of <paramref name="names"/>, in order of preference, that is there and not empty; the newest copy of it.</summary>
internal static string? Newest(IReadOnlyList<FileInfo> files, IReadOnlyList<string> names)
{
foreach (string name in names)
{
FileInfo? newest = files
.Where(f => string.Equals(f.Name, name, StringComparison.OrdinalIgnoreCase) && f.Length > 0)
.OrderByDescending(static f => f.LastWriteTimeUtc)
.FirstOrDefault();
if (newest is not null)
{
return newest.FullName;
}
}
return null;
}
}
@@ -107,7 +107,8 @@ public sealed class SteamLibrarySource(string? steamRoot = null) : IStoreLibrary
return new StoreGame("steam", appId, name, Path.Combine(steamapps, "common", installDir), ExePath: null, state.Value("buildid"));
}
private static string? InstalledRoot()
/// <summary>Steam's folder as its own registry value names it (<c>HKCU\Software\Valve\Steam\SteamPath</c>), or null; the artwork reads it too (beta.23).</summary>
internal static string? InstalledRoot()
{
try
{
+124 -70
View File
@@ -33,6 +33,7 @@
// added trying to close it and did not; they are kept because they are the right
// shape and would catch a wider window.
#include <algorithm>
#include <atomic>
#include <catch2/catch_test_macros.hpp>
#include <cstring>
@@ -246,6 +247,18 @@ TEST_CASE("a reader stalled exactly ONE FULL LAP does not accept a stale frame",
CHECK(out[0].frameIndex == kCap); // the SECOND occupant, not the first
}
// What makes the two concurrency cases below prove anything is that the reader drained the ring WHILE the writer
// wrote it (2026-10-13). The hammering case's guard was `accepted > kTotal / 2`, a share of the stream, and that
// measured the scheduler rather than the run: on the owner's hybrid i7-14700KF it failed 5 of 40 runs, then 5 of 200,
// with `mixed` clean every time. A start barrier (the writer begins only once the reader is about to loop) left 1 of
// 200 — a reader the OS did not run while the writer wrote: one drain beside it, accepted 2048. No single run can rule
// that out, so each case repeats its run, every attempt checked for its properties, until one attempt made enough
// drains that copied records while the writer was still writing. Measured over 1,000 runs: no failure, at most 3
// attempts, at least 122 such drains in the best attempt (median 146,981). A reader made to wait for the writer to
// finish makes none in all 8 attempts and fails here, where the tiny ring's old `dropped > 0` still passed.
constexpr std::uint64_t kMinOverlappedDrains = 100;
constexpr int kMaxAttempts = 8;
TEST_CASE("SPSC under a hammering writer: every accepted record is internally consistent", "[ring]") {
// The real concurrency case. The reader may legitimately miss records
// (overwrite-oldest) and may see torn ones; what it must NEVER do is accept a
@@ -254,44 +267,63 @@ TEST_CASE("SPSC under a hammering writer: every accepted record is internally co
constexpr std::uint32_t kBigCap = 1024;
constexpr std::uint32_t kTotal = 200000;
Mapping m{kBigCap};
RingWriter w;
RingReader rd;
REQUIRE(w.Init(m.base(), kBigCap));
REQUIRE(rd.Init(m.base(), kBigCap));
std::uint64_t mostOverlapped = 0;
int attempts = 0;
while (mostOverlapped < kMinOverlappedDrains && attempts < kMaxAttempts) {
++attempts;
Mapping m{kBigCap};
RingWriter w;
RingReader rd;
REQUIRE(w.Init(m.base(), kBigCap));
REQUIRE(rd.Init(m.base(), kBigCap));
std::atomic<bool> done{false};
std::thread producer([&] {
for (std::uint32_t i = 0; i < kTotal; ++i) {
w.Publish(MakeRecord(i));
}
done.store(true, std::memory_order_release);
});
std::vector<FlFrameRecord> buf(kBigCap);
std::uint64_t accepted = 0;
std::uint64_t torn = 0;
bool mixed = false;
while (!done.load(std::memory_order_acquire) || rd.ReadIndex() < m.writer()->writeIndex) {
const DrainResult r = rd.Drain(buf.data(), kBigCap);
for (std::uint32_t i = 0; i < r.copied; ++i) {
if (buf[i].qpc != 1000ULL + buf[i].frameIndex) {
mixed = true;
std::atomic<bool> go{false};
std::atomic<bool> done{false};
std::thread producer([&] {
while (!go.load(std::memory_order_acquire)) {
std::this_thread::yield();
}
if (buf[i].swapchainId != (0xABCD0000u | (buf[i].frameIndex & 0xFFFFu))) {
mixed = true; // the tail span belongs to the same frame as the head
for (std::uint32_t i = 0; i < kTotal; ++i) {
w.Publish(MakeRecord(i));
}
done.store(true, std::memory_order_release);
});
std::vector<FlFrameRecord> buf(kBigCap);
std::uint64_t accepted = 0;
std::uint64_t torn = 0;
std::uint64_t overlapped = 0; // drains that copied records while the writer was writing
bool mixed = false;
go.store(true, std::memory_order_release);
while (!done.load(std::memory_order_acquire) || rd.ReadIndex() < m.writer()->writeIndex) {
const bool writing = !done.load(std::memory_order_acquire);
const DrainResult r = rd.Drain(buf.data(), kBigCap);
for (std::uint32_t i = 0; i < r.copied; ++i) {
if (buf[i].qpc != 1000ULL + buf[i].frameIndex) {
mixed = true;
}
if (buf[i].swapchainId != (0xABCD0000u | (buf[i].frameIndex & 0xFFFFu))) {
mixed = true; // the tail span belongs to the same frame as the head
}
}
if (writing && r.copied > 0) {
++overlapped;
}
accepted += r.copied;
torn += r.gaps;
}
accepted += r.copied;
torn += r.gaps;
producer.join();
INFO("attempt " << attempts << ": accepted " << accepted << ", torn " << torn << ", overlapped drains "
<< overlapped << " of " << kTotal);
CHECK_FALSE(mixed);
mostOverlapped = std::max(mostOverlapped, overlapped);
}
producer.join();
INFO("accepted " << accepted << ", torn " << torn << " of " << kTotal);
CHECK_FALSE(mixed);
// Not a vacuous run: the reader must actually have seen most of the stream.
CHECK(accepted > kTotal / 2);
INFO("attempts " << attempts << ", most overlapped drains " << mostOverlapped);
// Not a vacuous run: in one attempt at least, the reader read the ring while the writer was writing it.
CHECK(mostOverlapped >= kMinOverlappedDrains);
}
TEST_CASE("a tiny ring, so the writer laps the reader constantly", "[ring]") {
@@ -307,50 +339,72 @@ TEST_CASE("a tiny ring, so the writer laps the reader constantly", "[ring]") {
constexpr std::uint32_t kTiny = 8;
constexpr std::uint32_t kTotal = 200000;
Mapping m{kTiny};
RingWriter w;
RingReader rd;
REQUIRE(w.Init(m.base(), kTiny));
REQUIRE(rd.Init(m.base(), kTiny));
std::uint64_t mostOverlapped = 0;
std::uint64_t dropped = 0; // the last attempt's: the one that overlapped, when one did
int attempts = 0;
while (mostOverlapped < kMinOverlappedDrains && attempts < kMaxAttempts) {
++attempts;
Mapping m{kTiny};
RingWriter w;
RingReader rd;
REQUIRE(w.Init(m.base(), kTiny));
REQUIRE(rd.Init(m.base(), kTiny));
std::atomic<bool> done{false};
std::thread producer([&] {
for (std::uint32_t i = 0; i < kTotal; ++i) {
w.Publish(MakeRecord(i));
}
done.store(true, std::memory_order_release);
});
FlFrameRecord buf[kTiny]{};
std::uint64_t accepted = 0;
std::uint64_t dropped = 0;
bool mixed = false;
bool poisonAccepted = false;
while (!done.load(std::memory_order_acquire) || rd.ReadIndex() < m.writer()->writeIndex) {
const DrainResult r = rd.Drain(buf, kTiny);
for (std::uint32_t i = 0; i < r.copied; ++i) {
if (buf[i].qpc != 1000ULL + buf[i].frameIndex ||
buf[i].swapchainId != (0xABCD0000u | (buf[i].frameIndex & 0xFFFFu))) {
mixed = true;
std::atomic<bool> go{false};
std::atomic<bool> done{false};
std::thread producer([&] {
while (!go.load(std::memory_order_acquire)) {
std::this_thread::yield();
}
// An accepted record's seq is the seqlock counter and must be even.
// kPoisonSeq here means the payload write reached the guard field.
if (buf[i].seq == kPoisonSeq || (buf[i].seq & 1u) != 0u) {
poisonAccepted = true;
for (std::uint32_t i = 0; i < kTotal; ++i) {
w.Publish(MakeRecord(i));
}
done.store(true, std::memory_order_release);
});
FlFrameRecord buf[kTiny]{};
std::uint64_t accepted = 0;
std::uint64_t lost = 0;
std::uint64_t overlapped = 0; // drains that copied records while the writer was writing
bool mixed = false;
bool poisonAccepted = false;
go.store(true, std::memory_order_release);
while (!done.load(std::memory_order_acquire) || rd.ReadIndex() < m.writer()->writeIndex) {
const bool writing = !done.load(std::memory_order_acquire);
const DrainResult r = rd.Drain(buf, kTiny);
for (std::uint32_t i = 0; i < r.copied; ++i) {
if (buf[i].qpc != 1000ULL + buf[i].frameIndex ||
buf[i].swapchainId != (0xABCD0000u | (buf[i].frameIndex & 0xFFFFu))) {
mixed = true;
}
// An accepted record's seq is the seqlock counter and must be even.
// kPoisonSeq here means the payload write reached the guard field.
if (buf[i].seq == kPoisonSeq || (buf[i].seq & 1u) != 0u) {
poisonAccepted = true;
}
}
if (writing && r.copied > 0) {
++overlapped;
}
accepted += r.copied;
lost += r.dropped;
}
accepted += r.copied;
dropped += r.dropped;
producer.join();
dropped = lost;
INFO("attempt " << attempts << ": accepted " << accepted << ", overlapped drains " << overlapped << " of "
<< kTotal);
CHECK_FALSE(mixed);
CHECK_FALSE(poisonAccepted);
mostOverlapped = std::max(mostOverlapped, overlapped);
}
producer.join();
INFO("accepted " << accepted << ", dropped " << dropped << " of " << kTotal);
CHECK_FALSE(mixed);
CHECK_FALSE(poisonAccepted);
// Not vacuous in the other direction either: with 8 slots the writer MUST
// have lapped us, so a run reporting no drops means the threads never
// actually overlapped and the case proved nothing.
INFO("attempts " << attempts << ", most overlapped drains " << mostOverlapped << ", dropped " << dropped);
// Not vacuous: the reader read the ring while the writer was writing it. `dropped > 0` alone could not say so — a
// reader that started after the writer had finished drops nearly everything — and with eight slots the attempt
// that overlapped (the last one) is lapped, which the second check holds it to.
CHECK(mostOverlapped >= kMinOverlappedDrains);
CHECK(dropped > 0);
}
@@ -160,6 +160,41 @@ public sealed class AccessibilityTests
return names;
}
/// <summary>
/// A WPF UI control's template is in WPF UI's own style for it (<c>DefaultImageStyle</c>, …), applied only when the
/// control has no style of its own. A style of the App's that targets the control without being based on WPF UI's leaves
/// it with no template: it takes its place and draws nothing — the game page's cover was an empty space beside the
/// name (beta.23), which no colour or text check can see. Every such style is based on WPF UI's or brings a template.
/// </summary>
[Fact]
public void NoStyleOfAWpfUiControlLeavesOutItsTemplate()
{
XNamespace wpfUi = "http://schemas.lepo.co/wpfui/2022/xaml";
var targetType = new Regex(@"^(?:\{x:Type\s+)?(?<prefix>\w+):(?<type>\w+)\}?$", RegexOptions.ExplicitCapture | RegexOptions.CultureInvariant, TimeSpan.FromSeconds(1));
var found = new List<string>();
foreach ((string file, XDocument xaml) in AppXaml())
{
foreach (XElement style in xaml.Descendants().Where(static e => string.Equals(e.Name.LocalName, "Style", StringComparison.Ordinal)))
{
Match match = targetType.Match(style.Attribute("TargetType")?.Value.Trim() ?? string.Empty);
if (style.Attribute("BasedOn") is not null || !match.Success || style.GetNamespaceOfPrefix(match.Groups["prefix"].Value) != wpfUi)
{
continue;
}
Type? control = typeof(Wpf.Ui.Controls.Image).Assembly.GetType("Wpf.Ui.Controls." + match.Groups["type"].Value);
bool templated = control is not null && typeof(System.Windows.Controls.Control).IsAssignableFrom(control);
bool bringsTemplate = style.Elements().Any(static s => string.Equals((string?)s.Attribute("Property"), "Template", StringComparison.Ordinal));
if (templated && !bringsTemplate)
{
found.Add($"{file}: a Style for ui:{match.Groups["type"].Value} with no BasedOn");
}
}
}
found.Should().BeEmpty("WPF UI's template is in its own style; base the App's on it (BasedOn=\"{StaticResource DefaultImageStyle}\", …)");
}
/// <summary>A <c>DataGridCheckBoxColumn</c>'s box is WPF's own element style — an Aero2 box on the Fluent grid (beta.14).</summary>
[Fact]
public void NoDataGridCheckBoxColumn()
@@ -316,6 +316,33 @@ public sealed class AgentConnectionTests : IAsyncDisposable
}
/// <summary>beta.10 (the admin mode): a start that asks Windows for administrator rights says so on the pill while it waits.</summary>
/// <summary>
/// beta.22: every way the pipe can close under a request reaches a caller as ONE exception, an IOException. PipeClient fails a
/// request in flight with what ended its reader — an IpcFramingException or an ObjectDisposedException among them — and a
/// caller that knew only IOException ended in the App's crash dialog (beta.21's review of Play). What is not a closed pipe
/// passes through as it was, and an answer is the answer.
/// </summary>
[Fact]
public async Task EveryWayThePipeClosesUnderARequestIsOneIOException()
{
foreach (Exception closed in new Exception[] { new ObjectDisposedException("pipe"), new IpcFramingException("the frame ended early") })
{
Func<Task> request = () => AgentConnection.AnsweredAsync(() => Task.FromException<IpcEnvelope>(closed));
IOException said = (await request.Should().ThrowAsync<IOException>()).Which;
said.InnerException.Should().BeSameAs(closed, closed.GetType().Name);
}
Exception[] kept = [new IOException("the pipe closed before the Agent answered"), new TimeoutException(), new IpcRequestException(IpcErrorCode.SessionRunning, "running")];
foreach (Exception ex in kept)
{
Func<Task> request = () => AgentConnection.AnsweredAsync(() => Task.FromException<IpcEnvelope>(ex));
(await request.Should().ThrowAsync<Exception>()).Which.Should().BeSameAs(ex, ex.GetType().Name);
}
IpcEnvelope answer = IpcCodec.Decode(IpcCodec.Encode(IpcMessageType.DeleteSessionsAck, "1", new DeleteSessionsAck(null, 0, 0)));
(await AgentConnection.AnsweredAsync(() => Task.FromResult(answer))).Should().BeSameAs(answer);
}
[Fact]
public async Task AStartThatAsksForAdministratorRightsSaysSoOnThePill()
{
@@ -1,6 +1,7 @@
// 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.Services;
using FrameLedger.App.ViewModels;
@@ -121,6 +122,31 @@ public sealed class AntiCheatExceptionsTests
(await exceptions.GrantAsync(56, _gf2, Ct)).Outcome.Should().Be(AntiCheatExceptionOutcome.VersionMismatch);
}
/// <summary>
/// beta.22: an ask the Agent never answered is not known, and its notice says so in words — it read "IOException"; one the
/// connection was gone before is "no agent", which changed nothing.
/// </summary>
[Fact]
public async Task AnAskTheAgentNeverAnsweredIsNotKnownAndSaidInWords()
{
var agent = new FakeAgent
{
Hello = Hello(AntiCheatExceptionDisclosure.Version),
Answer = static _ => throw new IOException("the connection to the Agent closed before it answered"),
};
var exceptions = new AntiCheatExceptions(agent, new FakePrompt { Accepts = true });
AntiCheatExceptionResult closed = await exceptions.GrantAsync(56, _gf2, Ct);
closed.Outcome.Should().Be(AntiCheatExceptionOutcome.Unanswered);
closed.MessageFor("GIRLS' FRONTLINE 2").Should().Be(Strings.Agent_Unanswered);
agent.Answer = static _ => throw new TimeoutException();
(await exceptions.WithdrawAsync(56, Ct)).Outcome.Should().Be(AntiCheatExceptionOutcome.Unanswered);
agent.Answer = static _ => throw new InvalidOperationException("the Agent is not connected");
(await exceptions.WithdrawAsync(56, Ct)).Outcome.Should().Be(AntiCheatExceptionOutcome.AgentUnavailable, "nothing was sent");
}
[Fact]
public async Task AWithdrawalNeedsNoDialog()
{
@@ -0,0 +1,125 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using FluentAssertions;
using FrameLedger.App.Controls;
using FrameLedger.App.Services;
using Wpf.Ui.Appearance;
using Wpf.Ui.Markup;
namespace FrameLedger.App.Tests;
/// <summary>
/// beta.23 (owner decision D61): an artwork's dominant colour and the band's tint, checked against the tests' own copy of
/// the WCAG formulas (<see cref="Wcag"/>) — for the colours that are hardest on each theme's text — so the tint can never
/// cost a text its contrast.
/// </summary>
public sealed class ColorMathTests
{
private static byte[] Pixels(params (Color Colour, int Count)[] runs)
{
var bytes = new List<byte>();
foreach ((Color c, int count) in runs)
{
for (int i = 0; i < count; i++)
{
bytes.AddRange([c.B, c.G, c.R, c.A]);
}
}
return [.. bytes];
}
[Fact]
public void TheArithmeticAgreesWithTheTestsOwnWcag()
{
Color[] samples = [Colors.White, Colors.Black, Color.FromRgb(0x20, 0x20, 0x20), Color.FromRgb(0xF3, 0xF3, 0xF3), Color.FromRgb(0xC8, 0x28, 0x28), Color.FromRgb(0x28, 0xC8, 0x64)];
foreach (Color a in samples)
{
foreach (Color b in samples)
{
ColorMath.Contrast(a, b).Should().BeApproximately(Wcag.Ratio(a, b), 1e-9);
}
}
ColorMath.Over(Color.FromArgb(0x80, 0xFF, 0x00, 0x00), Colors.Black).Should().Be(Wcag.Over(Color.FromArgb(0x80, 0xFF, 0x00, 0x00), Colors.Black));
}
[Fact]
public void TheDominantColourIsTheVividHueTheGreyAndBlackAroundItGiveNothing()
{
Color red = Color.FromRgb(200, 30, 40);
Color blue = Color.FromRgb(30, 60, 210);
ColorMath.Dominant(Pixels((red, 100))).Should().Be(red);
ColorMath.Dominant(Pixels((Colors.White, 60), (Colors.Black, 20), (blue, 20)))!.Value.Should().Be(blue, "white and black carry no colour");
ColorMath.Dominant(Pixels((Color.FromRgb(120, 120, 120), 99), (red, 1))).Should().BeNull("a grey picture with a speck of colour tints nothing");
ColorMath.Dominant(Pixels((Color.FromArgb(0, 255, 0, 0), 50))).Should().BeNull("transparent pixels are not the picture");
}
/// <summary>
/// The hardest colours for each theme: saturated yellow and white lift the dark theme's background toward its light text;
/// black, deep blue and red pull the light theme's toward its dark text. Every text pair the header shows keeps its floor.
/// </summary>
[Theory]
[InlineData(ApplicationTheme.Dark)]
[InlineData(ApplicationTheme.Light)]
public async Task TheTintKeepsEveryTextOnTheBandReadableForTheHardestColours(ApplicationTheme theme)
{
Color[] hardest = [Colors.White, Colors.Black, Color.FromRgb(255, 230, 0), Color.FromRgb(0, 30, 200), Color.FromRgb(220, 0, 0), Color.FromRgb(0, 200, 120), Color.FromRgb(128, 128, 128)];
List<string> faint = await PagesLoadTests.OnStaAsync(() =>
{
var themed = new ThemesDictionary { Theme = theme };
var band = new Border();
band.Resources.MergedDictionaries.Add(themed);
Color window = Wcag.Resolve(themed, "ApplicationBackgroundColor");
Color card = Wcag.Over(Wcag.Resolve(themed, "CardBackgroundFillColorDefault"), window);
var found = new List<string>();
foreach (Color dominant in hardest)
{
Color tinted = ArtTint.BandColour(band, dominant)!.Value;
foreach ((string text, string? fill, double floor) in new[]
{
("TextFillColorPrimary", (string?)null, 4.5), ("TextFillColorSecondary", null, 4.5), ("TextFillColorTertiary", null, 3.0),
("TextFillColorSecondary", "ControlFillColorDefault", 4.5), ("TextFillColorPrimary", "SystemFillColorCautionBackground", 4.5),
})
{
Color under = fill is null ? tinted : Wcag.Over(Wcag.Resolve(themed, fill), tinted);
double ratio = Wcag.Ratio(Wcag.Over(Wcag.Resolve(themed, text), under), under);
if (ratio < floor)
{
found.Add($"{dominant} {text}/{fill}: {ratio:0.00} < {floor}");
}
}
// The tint never goes past its cap: at most 30 % (dark) or 22 % (light) of the colour over the card.
double mix = Math.Max(Math.Abs(tinted.R - card.R), Math.Max(Math.Abs(tinted.G - card.G), Math.Abs(tinted.B - card.B)));
double reach = Math.Max(Math.Abs(dominant.R - card.R), Math.Max(Math.Abs(dominant.G - card.G), Math.Abs(dominant.B - card.B)));
if (reach > 0 && mix / reach > (theme == ApplicationTheme.Dark ? 0.30 : 0.22) + 0.01)
{
found.Add($"{dominant}: {mix / reach:0.00} of the colour");
}
}
return found;
});
faint.Should().BeEmpty($"every text on the tinted band keeps its floor in the {theme} theme");
}
[Fact]
public async Task ATintIsColourWhereTheThemeLeavesRoomForIt()
{
Color tinted = await PagesLoadTests.OnStaAsync(() =>
{
var band = new Border();
band.Resources.MergedDictionaries.Add(new ThemesDictionary { Theme = ApplicationTheme.Dark });
return ArtTint.BandColour(band, Color.FromRgb(200, 30, 40))!.Value;
});
tinted.R.Should().BeGreaterThan((byte)(tinted.G + 20), "a red cover reddens the dark band — it is a tint, not the card's fill");
}
}
@@ -0,0 +1,149 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.Diagnostics;
using System.IO;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using FluentAssertions;
using FrameLedger.App.Services;
using FrameLedger.Application.Persistence;
namespace FrameLedger.App.Tests;
/// <summary>
/// beta.23 (owner decision D60): the images users choose for their games — a re-encoded copy in the data folder's
/// <c>covers</c>, a new name for each choice — and the tidying that deletes the ones no row names any more.
/// </summary>
public sealed class CoverStoreTests : IDisposable
{
private readonly string _dir = Path.Combine(Path.GetTempPath(), "fl-covers-" + Guid.NewGuid().ToString("N"));
public CoverStoreTests() => Directory.CreateDirectory(_dir);
public void Dispose()
{
// A junction a test made goes on its own first: met inside a recursive delete, it is unmounted as a volume would be,
// which Windows refuses without elevation (UnauthorizedAccessException) — though the link itself is then removed.
var covers = new DirectoryInfo(Path.Combine(Data, "covers"));
if (covers.Exists && covers.LinkTarget is not null)
{
covers.Delete();
}
Directory.Delete(_dir, recursive: true);
}
private static CancellationToken Ct => TestContext.Current.CancellationToken;
private string Data => Path.Combine(_dir, "data");
[Fact]
public async Task APickedImageIsCopiedAsAPngNoLargerThan1200PixelsUnderANewName()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
var store = new CoverStore(new UiMode(false, Data), s.Games);
string picked = TestImages.Write(Path.Combine(_dir, "mine.png"), TestImages.Png(1600, 2400, Color.FromRgb(10, 120, 200)));
string first = (await store.ImportAsync(7, picked, Ct))!;
string second = (await store.ImportAsync(7, picked, Ct))!;
first.Should().MatchRegex(@"^covers\\game-7-\d+\.png$");
second.Should().NotBe(first, "each choice is a new file, so a shown image is never written over");
string full = CoverStore.Resolve(Data, first)!;
BitmapFrame copy = BitmapDecoder.Create(new Uri(full), BitmapCreateOptions.None, BitmapCacheOption.OnLoad).Frames[0];
copy.PixelHeight.Should().Be(1200);
copy.PixelWidth.Should().Be(800);
Directory.EnumerateFiles(Path.Combine(Data, "covers"), "*.tmp").Should().BeEmpty();
File.Exists(picked).Should().BeTrue("the user's own file is read, never moved");
}
[Fact]
public async Task AFileThatIsNotAnImageIsRefusedAndLeavesNothing()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
var store = new CoverStore(new UiMode(false, Data), s.Games);
string notAnImage = TestImages.Write(Path.Combine(_dir, "notes.png"), "not an image"u8.ToArray());
(await store.ImportAsync(7, notAnImage, Ct)).Should().BeNull();
(Directory.Exists(Path.Combine(Data, "covers")) ? Directory.EnumerateFiles(Path.Combine(Data, "covers")) : []).Should().BeEmpty();
}
[Fact]
public async Task TidyingDeletesWhatNoRowNamesAndKeepsWhatARemovedRowStillOwns()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
GameRow kept = await s.GameAsync("Kept");
GameRow removed = await s.GameAsync("Removed");
string covers = Path.Combine(Data, "covers");
string keptFile = "game-" + kept.Id + "-100.png";
string removedFile = "game-" + removed.Id + "-100.png";
foreach (string name in new[] { keptFile, removedFile, "game-" + kept.Id + "-99.png", "game-999999-1.png", "readme.txt" })
{
_ = TestImages.Write(Path.Combine(covers, name), [1]);
}
string stale = TestImages.Write(Path.Combine(covers, "game-" + kept.Id + "-98.png.tmp"), [1]);
File.SetLastWriteTimeUtc(stale, DateTime.UtcNow.AddHours(-2));
string fresh = TestImages.Write(Path.Combine(covers, "game-" + kept.Id + "-101.png.tmp"), [1]);
await s.Games.UpdateMetadataAsync(kept.Id, GameMetadata.Of(kept) with { CoverPath = "covers\\" + keptFile }, Ct);
await s.Games.UpdateMetadataAsync(removed.Id, GameMetadata.Of(removed) with { CoverPath = "covers\\" + removedFile }, Ct);
(await s.Games.RemoveAsync(removed.Id, keepSessions: true, Ct)).Should().BeTrue();
int deleted = await new CoverStore(new UiMode(false, Data), s.Games).PruneAsync(Ct);
deleted.Should().Be(3, "the replaced image, the deleted game's, and the copy half-written two hours ago");
Directory.EnumerateFiles(covers).Select(Path.GetFileName).Should().BeEquivalentTo([keptFile, removedFile, "readme.txt", Path.GetFileName(fresh)],
"a row removed with its sessions kept comes back with its image; another file's name is not ours to touch");
}
[Fact]
public async Task DeletingFollowsOnlyOurOwnNames()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
var store = new CoverStore(new UiMode(false, Data), s.Games);
string outside = TestImages.Write(Path.Combine(_dir, "precious.png"), [1]);
string ours = TestImages.Write(Path.Combine(Data, "covers", "game-3-4.png"), [1]);
store.Delete("covers\\..\\..\\precious.png");
store.Delete(outside);
store.Delete("covers\\game-3-4.png");
File.Exists(outside).Should().BeTrue();
File.Exists(ours).Should().BeFalse();
}
/// <summary>A <c>covers</c> folder that is a junction leads to another place: nothing behind it is shown, deleted, written or tidied.</summary>
[Fact]
public async Task ACoversFolderThatIsALinkIsNeverFollowed()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
GameRow game = await s.GameAsync("Alpha");
string elsewhere = Path.Combine(_dir, "elsewhere");
string there = TestImages.Write(Path.Combine(elsewhere, "game-" + game.Id + "-1.png"), TestImages.Png(4, 4, Color.FromRgb(200, 30, 30)));
_ = Directory.CreateDirectory(Data);
Junction(Path.Combine(Data, "covers"), elsewhere);
var store = new CoverStore(new UiMode(false, Data), s.Games);
string picked = TestImages.Write(Path.Combine(_dir, "mine.png"), TestImages.Png(4, 4, Color.FromRgb(10, 120, 200)));
CoverStore.Resolve(Data, "covers\\" + Path.GetFileName(there)).Should().BeNull("the folder is a link");
store.Delete("covers\\" + Path.GetFileName(there));
(await store.ImportAsync(game.Id, picked, Ct)).Should().BeNull("no image is written through a link");
(await store.PruneAsync(Ct)).Should().Be(0);
Directory.EnumerateFiles(elsewhere).Should().BeEquivalentTo([there], "nothing behind the link was deleted or written");
}
private static void Junction(string link, string target)
{
var start = new ProcessStartInfo("cmd.exe") { CreateNoWindow = true, UseShellExecute = false };
foreach (string arg in new[] { "/c", "mklink", "/J", link, target })
{
start.ArgumentList.Add(arg);
}
using Process mklink = Process.Start(start)!;
mklink.WaitForExit();
mklink.ExitCode.Should().Be(0, "a junction needs no privilege");
}
}
@@ -47,21 +47,6 @@ public sealed class DashboardViewModelTests
public void Open(long sessionId) => Opened.Add(sessionId);
}
private sealed class NoStrip : IMessageStrip
{
public void Info(string title, string body)
{
}
public void Success(string title, string body)
{
}
public void Warn(string title, string body)
{
}
}
private sealed class FakeNavigator : IPageNavigator
{
public List<string> Pages { get; } = [];
@@ -83,7 +68,8 @@ public sealed class DashboardViewModelTests
var nav = new FakeNavigator();
var summaries = new NoSummaries();
using var vm = new DashboardViewModel(link, s.Library, selection, nav, summaries, new NoStrip());
var vm = new DashboardViewModel(link, s.Library, selection, nav, summaries);
vm.Attach();
Task pending1 = vm.Pending;
await pending1;
@@ -111,7 +97,8 @@ public sealed class DashboardViewModelTests
await using ScratchLedger s = await ScratchLedger.OpenAsync();
GameRow game = await s.GameAsync("Alpha");
var link = new FakeLink();
using var vm = new DashboardViewModel(link, s.Library, new GameSelection(), new FakeNavigator(), new NoSummaries(), new NoStrip());
var vm = new DashboardViewModel(link, s.Library, new GameSelection(), new FakeNavigator(), new NoSummaries());
vm.Attach();
Task pending2 = vm.Pending;
await pending2;
vm.Live.IsActive.Should().BeFalse();
@@ -178,7 +165,9 @@ public sealed class DashboardViewModelTests
};
using var sessions = new LiveSessions(link);
var strip = new RecordingStrip();
using var vm = new DashboardViewModel(link, s.Library, new GameSelection(), new FakeNavigator(), new NoSummaries(), strip, sessions: sessions);
using var notices = new SessionNotices(link, strip);
var vm = new DashboardViewModel(link, s.Library, new GameSelection(), new FakeNavigator(), new NoSummaries(), sessions: sessions);
vm.Attach();
Task loaded = vm.Pending;
await loaded;
@@ -207,7 +196,9 @@ public sealed class DashboardViewModelTests
var link = new FakeLink();
using var sessions = new LiveSessions(link);
var strip = new RecordingStrip();
using var vm = new DashboardViewModel(link, s.Library, new GameSelection(), new FakeNavigator(), new NoSummaries(), strip, sessions: sessions);
using var notices = new SessionNotices(link, strip);
var vm = new DashboardViewModel(link, s.Library, new GameSelection(), new FakeNavigator(), new NoSummaries(), sessions: sessions);
vm.Attach();
Task loaded = vm.Pending;
await loaded;
var hooked = Guid.NewGuid();
@@ -228,4 +219,74 @@ public sealed class DashboardViewModelTests
strip.Shown.Should().ContainSingle("a faulted session is the strip's CaptureError already; \"discarded\" would say what did not happen");
vm.Live.IsActive.Should().BeFalse();
}
/// <summary>
/// beta.23: a Dashboard hears the Agent only while its page is on screen. Every visit made a new one and none went
/// away — the root container kept them all, each subscribed — so each session's end reloaded every Dashboard ever
/// opened, on the UI thread, and raised one notice apiece.
/// </summary>
[Fact]
public async Task ADashboardOffScreenHearsNothingAndASessionHasOneNoticeHoweverManyWereOpened()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
GameRow game = await s.GameAsync("Alpha");
var link = new FakeLink();
var strip = new RecordingStrip();
using var notices = new SessionNotices(link, strip);
var visits = new List<DashboardViewModel>();
for (int i = 0; i < 5; i++)
{
// What navigating does: the page on screen is attached, the one it replaced detached.
visits.LastOrDefault()?.Detach();
var vm = new DashboardViewModel(link, s.Library, new GameSelection(), new FakeNavigator(), new NoSummaries());
vm.Attach();
visits.Add(vm);
Task pending = vm.Pending;
await pending;
}
var guid = Guid.NewGuid();
link.Raise(IpcMessageType.SessionStarted, new SessionStartedEvent(guid, game.Id, "Alpha", 4242, 1, DateTimeOffset.UtcNow));
visits[^1].Live.IsActive.Should().BeTrue("the Dashboard on screen follows the session");
visits.Take(4).Should().OnlyContain(static v => !v.Live.IsActive, "a Dashboard that was navigated away from hears nothing");
long id = await s.SessionAsync(game.Id, DateTimeOffset.UtcNow.AddMinutes(-2), seconds: 65);
link.Raise(IpcMessageType.SessionCompleted, new SessionCompletedEvent(guid, id, "normal", 1, "saved", "TargetExited"));
Task reloaded = visits[^1].Pending;
await reloaded;
strip.Shown.Should().ContainSingle("one session, one notice — it was one per Dashboard ever opened")
.Which.Body.Should().Contain("Alpha", "the name the start gave, for a completion that carries none");
visits[^1].Recent.Should().ContainSingle();
visits.Take(4).Should().OnlyContain(static v => v.Recent.Count == 0, "only the Dashboard on screen reloads its lists");
}
/// <summary>FR-3.8 (beta.23): the notice is the window's while it is shown; a hidden window leaves it to the tray's balloon.</summary>
[Fact]
public void ANoticeWaitsForTheWindowAndATrayBalloonCarriesItWhenHidden()
{
var link = new FakeLink();
var strip = new RecordingStrip();
var presence = new Presence { IsShown = false };
using var notices = new SessionNotices(link, strip, presence);
link.Raise(IpcMessageType.SessionCompleted, new SessionCompletedEvent(Guid.NewGuid(), 7, "normal", 1, "saved", "TargetExited", 1, "Alpha"));
strip.Shown.Should().BeEmpty("the window is hidden: TrayViewModel's balloon says it");
presence.IsShown = true;
link.Raise(IpcMessageType.SessionCompleted, new SessionCompletedEvent(Guid.NewGuid(), 8, "normal", 1, "saved", "TargetExited", 1, "Alpha"));
strip.Shown.Should().ContainSingle().Which.Kind.Should().Be("success");
}
private sealed class Presence : IShellPresence
{
public bool IsShown { get; set; }
public void Reveal()
{
}
public void Quit()
{
}
}
}
@@ -0,0 +1,103 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.Windows.Media;
using System.Windows.Media.Imaging;
using FluentAssertions;
using FrameLedger.App.Services;
using FrameLedger.App.ViewModels;
using FrameLedger.Application.Persistence;
namespace FrameLedger.App.Tests;
/// <summary>
/// beta.23 (owner decision D60): the edit dialog's image row. A picked image is previewed and copied only on Save; going
/// back to the store's image drops the row's own; a file that is no image is said, and nothing is kept of it.
/// </summary>
public sealed class EditGameViewModelTests
{
private static readonly ImageSource _store = Frozen();
private static readonly ImageSource _own = Frozen();
private static readonly ImageSource _picked = Frozen();
private static BitmapSource Frozen()
{
BitmapSource image = BitmapSource.Create(2, 3, 96, 96, PixelFormats.Bgra32, null, new byte[24], 8);
image.Freeze();
return image;
}
private sealed class Picker(string? path) : IImagePicker
{
public int Asked { get; private set; }
public string? PickImage()
{
Asked++;
return path;
}
}
private static EditImage Image(Picker picker, bool own, bool readable = true) =>
new(own ? _own : _store, own, _store, picker, _ => Task.FromResult(readable ? _picked : null));
[Fact]
public void WithoutAnImageRowTheDialogIsAsItWas()
{
var vm = new EditGameViewModel(new GameMetadata { Name = "Alpha", CoverPath = "covers\\game-1-2.png" }, provenanceJson: null);
vm.ImageEditable.Should().BeFalse();
GameEdit edit = vm.Edit();
edit.PickedImage.Should().BeNull();
edit.Metadata.CoverPath.Should().Be("covers\\game-1-2.png", "an edit that did not touch the image keeps the row's");
}
[Fact]
public async Task APickedImageIsPreviewedAndHandedOnOnlyWithTheSave()
{
var picker = new Picker(@"C:\Pictures\alpha.png");
var vm = new EditGameViewModel(new GameMetadata { Name = "Alpha" }, null, Image(picker, own: false));
vm.ImagePreview.Should().BeSameAs(_store);
vm.CanUseStoreImage.Should().BeFalse("the store's image is the one shown");
await vm.ChooseImageCommand.ExecuteAsync(null);
vm.ImagePreview.Should().BeSameAs(_picked);
vm.PickedImage.Should().Be(@"C:\Pictures\alpha.png");
vm.CanUseStoreImage.Should().BeTrue();
vm.Edit().PickedImage.Should().Be(@"C:\Pictures\alpha.png", "Save hands the file on to be copied");
vm.UseStoreImageCommand.Execute(null);
vm.ImagePreview.Should().BeSameAs(_store);
vm.Edit().PickedImage.Should().BeNull("going back to the store's image drops the pick");
}
[Fact]
public async Task AFileThatIsNoImageIsSaidAndNotKept()
{
var vm = new EditGameViewModel(new GameMetadata { Name = "Alpha" }, null, Image(new Picker(@"C:\notes.txt"), own: false, readable: false));
await vm.ChooseImageCommand.ExecuteAsync(null);
vm.ImageError.Should().Be(Strings.Art_ImportFailed);
vm.PickedImage.Should().BeNull();
vm.ImagePreview.Should().BeSameAs(_store);
}
[Fact]
public async Task UsingTheStoresImageDropsTheRowsOwnAndACancelledPickChangesNothing()
{
var picker = new Picker(null);
var vm = new EditGameViewModel(new GameMetadata { Name = "Alpha", CoverPath = "covers\\game-1-2.png" }, null, Image(picker, own: true));
vm.CanUseStoreImage.Should().BeTrue("the user's own image is the one shown");
await vm.ChooseImageCommand.ExecuteAsync(null);
picker.Asked.Should().Be(1);
vm.ImagePreview.Should().BeSameAs(_own, "a cancelled pick changes nothing");
vm.UseStoreImageCommand.Execute(null);
vm.Edit().Metadata.CoverPath.Should().BeNull("Save drops the row's own image");
vm.ImagePreview.Should().BeSameAs(_store);
vm.CanUseStoreImage.Should().BeFalse();
}
}
+158
View File
@@ -0,0 +1,158 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.IO;
using System.Windows.Media;
using FluentAssertions;
using FrameLedger.App.Services;
using FrameLedger.Application.Art;
using FrameLedger.Application.Import;
using FrameLedger.Application.Persistence;
using FrameLedger.Application.Settings;
namespace FrameLedger.App.Tests;
/// <summary>
/// beta.23 (owner decisions D60/D61): a game's artwork — the user's own image first, else what the app of the store that
/// installed it keeps on this PC, found through that store's own records as Play finds it — and the colour it gives the band.
/// </summary>
[Collection(StringsCultureCollection.Name)]
public sealed class GameArtTests : IDisposable
{
private readonly string _dir = Path.Combine(Path.GetTempPath(), "fl-gameart-" + Guid.NewGuid().ToString("N"));
public GameArtTests() => Directory.CreateDirectory(_dir);
public void Dispose() => Directory.Delete(_dir, recursive: true);
private static CancellationToken Ct => TestContext.Current.CancellationToken;
private string Install => Path.Combine(_dir, "Steam", "steamapps", "common", "Alpha");
private GameArt Art(MemorySettings settings, IStoreLibrarySource store, IStoreArtCache cache) =>
new(new RegisteredSettings(settings), new StoreRecordsReader([store]), [cache], new UiMode(false, Path.Combine(_dir, "data")));
private (IStoreLibrarySource Store, TestImages.ArtCache Cache) SteamWith(bool cover = true, bool hero = true)
{
string? c = cover ? TestImages.Write(Path.Combine(_dir, "cache", "library_600x900.jpg"), TestImages.Png(30, 45, Color.FromRgb(200, 40, 40))) : null;
string? h = hero ? TestImages.Write(Path.Combine(_dir, "cache", "library_hero.jpg"), TestImages.Png(96, 31, Color.FromRgb(40, 40, 200))) : null;
var store = new TestImages.Store("steam", new StoreGame("steam", "374320", "Alpha", Install, null, null));
return (store, new TestImages.ArtCache("steam", "374320", new GameArtFiles(c, h, null)));
}
[Fact]
public async Task TheStoresCoverAndBannerShowWithTheColourOfTheCover()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
GameRow game = await s.GameAsync("Alpha", Path.Combine(Install, "Alpha.exe"));
(IStoreLibrarySource store, TestImages.ArtCache cache) = SteamWith();
GameArtView view = (await Art(new MemorySettings(), store, cache).ForAsync(game, Ct))!;
view.Cover.Should().NotBeNull();
view.Hero.Should().NotBeNull();
view.CoverIsOwn.Should().BeFalse();
view.Source.Should().Be(Strings.Art_Source_Steam);
view.Tint.Should().NotBeNull("the cover is red; the band takes it");
view.Tint!.Value.R.Should().BeGreaterThan(view.Tint.Value.B, "the cover's colour, not the banner's");
view.Cover!.IsFrozen.Should().BeTrue("decoded off the UI thread, so frozen to be bound on it");
cache.Asked.Should().Equal("374320");
}
[Fact]
public async Task TheUsersOwnImageComesBeforeTheStoresAndAMissingOneFallsBackToIt()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
GameRow game = await s.GameAsync("Alpha", Path.Combine(Install, "Alpha.exe"));
(IStoreLibrarySource store, TestImages.ArtCache cache) = SteamWith();
_ = TestImages.Write(Path.Combine(_dir, "data", "covers", "game-" + game.Id + "-5.png"), TestImages.Png(20, 30, Color.FromRgb(20, 160, 60)));
GameRow own = game with { CoverPath = "covers\\game-" + game.Id + "-5.png" };
GameArt art = Art(new MemorySettings(), store, cache);
GameArtView mine = (await art.ForAsync(own, Ct))!;
mine.CoverIsOwn.Should().BeTrue();
mine.Source.Should().Be(Strings.Art_Source_Yours);
mine.StoreCover.Should().NotBeNull("the edit dialog's \"use the store's image\" needs it");
mine.Tint!.Value.G.Should().BeGreaterThan(mine.Tint.Value.R, "the band takes the user's image's colour");
GameArtView gone = (await art.ForAsync(game with { CoverPath = "covers\\game-" + game.Id + "-6.png" }, Ct))!;
gone.CoverIsOwn.Should().BeFalse("a chosen image whose file is gone is the store's again");
gone.Source.Should().Be(Strings.Art_Source_Steam);
}
[Theory]
[InlineData("C:\\Windows\\Web\\Wallpaper\\img0.jpg")]
[InlineData("\\\\server\\share\\x.png")]
[InlineData("covers\\..\\..\\x.png")]
[InlineData("covers\\anything.png")]
[InlineData("other\\game-1-5.png")]
public void ACoverPathThatIsNotOneOfOursIsNeverFollowed(string coverPath)
{
// A viewer opens a copy of a ledger that may come from anywhere: a share would have Windows offer this user's credentials.
_ = TestImages.Write(Path.Combine(_dir, "data", "covers", "anything.png"), TestImages.Png(4, 4, Colors.Gray));
CoverStore.Resolve(Path.Combine(_dir, "data"), coverPath).Should().BeNull();
}
[Fact]
public async Task AGameNoArtStoreInstalledHasNoneWhateverItsPlatformSays()
{
// D59: detection rewrites platform (an itch build that ships Steam's API reads as Steam) while the id stays the
// importer's; the store is asked of the records, and no Steam folder holds an itch install.
await using ScratchLedger s = await ScratchLedger.OpenAsync();
GameRow game = await s.GameAsync("Alpha", Path.Combine(_dir, "itch", "apps", "alpha", "Alpha.exe"));
GameRow claimsSteam = game with { Platform = "steam", StoreId = "374320" };
(IStoreLibrarySource store, TestImages.ArtCache cache) = SteamWith();
(await Art(new MemorySettings(), store, cache).ForAsync(claimsSteam, Ct)).Should().BeNull();
cache.Asked.Should().BeEmpty("no Steam record owns the folder, so Steam's artwork is never asked");
}
[Fact]
public async Task OffInSettingsNothingIsReadAndUntintedTheBandKeepsTheCardsFill()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
GameRow game = await s.GameAsync("Alpha", Path.Combine(Install, "Alpha.exe"));
(IStoreLibrarySource store, TestImages.ArtCache cache) = SteamWith();
var off = new MemorySettings();
off.Rows[SettingsRegistry.UiGameArt.Key] = "0";
var noTint = new MemorySettings();
noTint.Rows[SettingsRegistry.UiGameArtTint.Key] = "0";
(await Art(off, store, cache).ForAsync(game, Ct)).Should().BeNull();
((TestImages.Store)store).Reads.Should().Be(0, "with the artwork off no store's records are read");
GameArtView untinted = (await Art(noTint, store, cache).ForAsync(game, Ct))!;
untinted.Cover.Should().NotBeNull();
untinted.Tint.Should().BeNull();
}
[Fact]
public async Task ADamagedFileIsNoImageAndAGreyPictureTintsNothing()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
GameRow game = await s.GameAsync("Alpha", Path.Combine(Install, "Alpha.exe"));
string damaged = TestImages.Write(Path.Combine(_dir, "cache", "library_600x900.jpg"), [0x42, 0x41, 0x44]);
string grey = TestImages.Write(Path.Combine(_dir, "cache", "library_hero.jpg"), TestImages.Png(64, 20, Color.FromRgb(128, 128, 128)));
var store = new TestImages.Store("steam", new StoreGame("steam", "374320", "Alpha", Install, null, null));
var cache = new TestImages.ArtCache("steam", "374320", new GameArtFiles(damaged, grey, null));
GameArtView view = (await Art(new MemorySettings(), store, cache).ForAsync(game, Ct))!;
view.Cover.Should().BeNull("a file Windows cannot read as an image is no image, never an error");
view.Hero.Should().NotBeNull();
view.Tint.Should().BeNull("a grey picture has no colour to give");
}
[Fact]
public async Task TheStoresRecordsAreReadOnceForPagesOpenedTogether()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
GameRow game = await s.GameAsync("Alpha", Path.Combine(Install, "Alpha.exe"));
(IStoreLibrarySource store, TestImages.ArtCache cache) = SteamWith();
GameArt art = Art(new MemorySettings(), store, cache);
_ = await art.ForAsync(game, Ct);
_ = await art.ForAsync(game, Ct);
((TestImages.Store)store).Reads.Should().Be(1, "Steam's records are kept two minutes, not read at every page");
}
}
@@ -82,9 +82,16 @@ public sealed class GameDetailViewModelTests
}
}
private sealed class FakeEdit(GameMetadata? answer) : IEditGamePrompt
private sealed class FakeEdit(GameMetadata? answer, string? picked = null) : IEditGamePrompt
{
public Task<GameMetadata?> EditAsync(GameMetadata current, string? provenanceJson, CancellationToken ct = default) => Task.FromResult(answer);
/// <summary>The image the page handed the dialog (beta.23), for a test to look at.</summary>
public EditImage? Image { get; private set; }
public Task<GameEdit?> EditAsync(GameMetadata current, string? provenanceJson, EditImage? image = null, CancellationToken ct = default)
{
Image = image;
return Task.FromResult(answer is null ? null : new GameEdit(answer, picked));
}
}
private sealed class NoSummaries : ISessionSummaryOpener
@@ -1032,6 +1039,108 @@ public sealed class GameDetailViewModelTests
vm.Sessions.Should().HaveCount(2, "the page left: nothing listens");
}
/// <summary>
/// beta.23: whether the executable is on disk is asked off the UI thread — a USB drive that sleeps, or one that fails,
/// answered on the UI thread while the page opened (the library page has asked off it since beta.19) — and the bar says
/// why from that one answer, with no drive asked again by a property getter.
/// </summary>
[Fact]
public async Task TheExecutableIsLookedForOffTheThreadThatOpensThePage()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
GameRow game = await s.GameAsync("Alpha");
var asked = new List<int>();
bool Exists(string path)
{
lock (asked)
{
asked.Add(Environment.CurrentManagedThreadId);
}
return false;
}
int opener = 0;
GameDetailViewModel? vm = null;
var thread = new Thread(() =>
{
opener = Environment.CurrentManagedThreadId;
vm = new GameDetailViewModel(s.Library, new GameSelection { GameId = game.Id }, new HookingConsent(new FakeAgent(), new FakePrompt()), new FakeNavigator(),
new FakeConfirmations(RemoveGameChoice.Cancel), new FakeEdit(null), new FakeStrip(), new NoSummaries(),
new Charts.SessionSeriesLoader(s.Sessions), new Infrastructure.Persistence.SqliteHardwareSnapshotRepository(s.Db), new SessionSelection(),
new FakePicker(null), executableExists: Exists);
});
thread.Start();
thread.Join();
Task loaded = vm!.Pending;
await loaded;
asked.Should().ContainSingle().Which.Should().NotBe(opener, "the drive is asked on the thread pool, never on the thread that opens the page");
vm.ExecutableMissing.Should().BeTrue();
vm.ExecutableMissingMessage.Should().StartWith(GameDetailViewModel.ExecutableMissingText).And.Contain(Path.GetFileName(game.Fingerprint.ExePath));
}
/// <summary>An image picker the page hands the edit dialog; the fake dialog answers the pick itself.</summary>
private sealed class NoImagePicker : IImagePicker
{
public string? PickImage() => null;
}
/// <summary>
/// beta.23 (D60): the page shows the store's artwork; an image picked in Edit is copied on Save and becomes the page's,
/// the one it replaced is deleted, and removing the game with its sessions deletes the last.
/// </summary>
[Fact]
public async Task ThePagesArtworkFollowsTheImageChosenInEditAndGoesWithTheGame()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
string dir = Path.Combine(Path.GetTempPath(), "fl-detail-art-" + Guid.NewGuid().ToString("N"));
try
{
string install = Path.Combine(dir, "Steam", "steamapps", "common", "Alpha");
GameRow game = await s.GameAsync("Alpha", Path.Combine(install, "Alpha.exe"));
string storeCover = TestImages.Write(Path.Combine(dir, "cache", "library_600x900.jpg"), TestImages.Png(30, 45, System.Windows.Media.Color.FromRgb(200, 40, 40)));
var store = new TestImages.Store("steam", new Application.Import.StoreGame("steam", "374320", "Alpha", install, null, null));
var cache = new TestImages.ArtCache("steam", "374320", new Application.Art.GameArtFiles(storeCover, null, null));
var mode = new UiMode(false, Path.Combine(dir, "data"));
var art = new GameArt(new RegisteredSettings(new MemorySettings()), new StoreRecordsReader([store]), [cache], mode);
var covers = new CoverStore(mode, s.Games);
string first = TestImages.Write(Path.Combine(dir, "first.png"), TestImages.Png(40, 60, System.Windows.Media.Color.FromRgb(20, 160, 60)));
string second = TestImages.Write(Path.Combine(dir, "second.png"), TestImages.Png(40, 60, System.Windows.Media.Color.FromRgb(20, 60, 160)));
GameDetailViewModel Page(string? picked, RemoveGameChoice remove = RemoveGameChoice.Cancel) => new(s.Library, new GameSelection { GameId = game.Id },
new HookingConsent(new FakeAgent(), new FakePrompt()), new FakeNavigator(), new FakeConfirmations(remove), new FakeEdit(GameMetadata.Of(game), picked),
new FakeStrip(), new NoSummaries(), new Charts.SessionSeriesLoader(s.Sessions), new Infrastructure.Persistence.SqliteHardwareSnapshotRepository(s.Db),
new SessionSelection(), new FakePicker(null), art: art, covers: covers, images: new NoImagePicker());
GameDetailViewModel vm = Page(first);
await vm.Pending;
vm.HasArt.Should().BeTrue();
vm.ArtSource.Should().Be(Strings.Art_Source_Steam);
vm.ArtTint.Should().NotBeNull();
await vm.EditCommand.ExecuteAsync(null);
string? firstCopy = vm.Game!.CoverPath;
firstCopy.Should().StartWith(@"covers\game-" + game.Id + "-");
vm.ArtSource.Should().Be(Strings.Art_Source_Yours, "the page reloads with the image just chosen");
File.Exists(CoverStore.Resolve(mode.DataDirectory, firstCopy)).Should().BeTrue();
GameDetailViewModel again = Page(second, RemoveGameChoice.DeleteSessions);
await again.Pending;
await again.EditCommand.ExecuteAsync(null);
string? secondCopy = again.Game!.CoverPath;
secondCopy.Should().NotBe(firstCopy);
Directory.EnumerateFiles(Path.Combine(mode.DataDirectory, "covers")).Should().ContainSingle("the image it replaced is deleted once the row names the new one");
await again.RemoveCommand.ExecuteAsync(null);
Directory.EnumerateFiles(Path.Combine(mode.DataDirectory, "covers")).Should().BeEmpty("a game removed with its sessions takes its image with it");
}
finally
{
Directory.Delete(dir, recursive: true);
}
}
/// <summary>beta.8: a session that was not hooked has its sensors, and the Sensors tab draws them instead of saying "not hooked".</summary>
[Fact]
public async Task ATierTwoSessionsSensorsAreTheSensorsTabs()
+10 -10
View File
@@ -179,26 +179,26 @@ public sealed class GamePlayerTests
}
/// <summary>
/// From the review before the merge: the pipe fails a request in flight with an IOException when the agent stops (PipeClient),
/// and a command's unhandled exception is the App's crash dialog. Each way the connection can go mid-request is "not running".
/// The pipe fails a request in flight when the agent stops, and a command's unhandled exception is the App's crash dialog
/// (beta.21's review). Since beta.22 an answer that never came — the connection closed (one IOException, AgentConnection) or no
/// answer in time — is "not known": the game may be starting. The connection gone before the request is "not running".
/// </summary>
[Fact]
public async Task AConnectionThatGoesMidRequestIsTheAgentNotRunningNeverAnException()
public async Task AnAnswerThatNeverCameIsNotKnownAndARequestNeverSentIsNotRunning()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
await new RegisteredSettings(new SqliteSettingsStore(s.Db)).SetAsync(SettingsRegistry.UiPlayMode, PlayMode.Direct, Ct);
GameRow game = Game(@"D:\Games\Loose\game.exe", null);
Exception[] gone =
[
new IOException("the pipe closed before the Agent answered"), new ObjectDisposedException("pipe"), new TimeoutException(),
new InvalidOperationException("the Agent is not connected"), new IpcFramingException("truncated frame"),
];
foreach (Exception ex in gone)
foreach (Exception ex in new Exception[] { new IOException("the connection to the Agent closed before it answered"), new TimeoutException() })
{
PlayResult result = await Player(s, new Shell(), new Agent(fails: ex), new Stores()).PlayAsync(game, Ct);
result.Should().Be(new PlayResult(PlayOutcome.AgentUnavailable), ex.GetType().Name);
result.Should().Be(new PlayResult(PlayOutcome.Unanswered), ex.GetType().Name);
GamePlayer.Describe(result, "W").Should().Be((Strings.Agent_Unanswered, true));
}
(await Player(s, new Shell(), new Agent(fails: new InvalidOperationException("the Agent is not connected")), new Stores()).PlayAsync(game, Ct))
.Should().Be(new PlayResult(PlayOutcome.AgentUnavailable), "nothing was sent");
PlayResult refused = await Player(s, new Shell(), new Agent(fails: new IpcRequestException("UnknownType", "no such command")), new Stores())
.PlayAsync(game, Ct);
refused.Should().Be(new PlayResult(PlayOutcome.Failed, Detail: "UnknownType"));
@@ -1,6 +1,7 @@
// 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.Services;
using FrameLedger.App.ViewModels;
@@ -148,6 +149,28 @@ public sealed class HookingConsentTests
agent.Sent.Last().Payload.Should().Be(new SetHookEnabledRequest(7, false, null), "a revoke names no disclosure");
}
/// <summary>
/// beta.22: an ask the Agent never answered — the connection closed under it, or no answer in time — is not known, never the
/// exception's type name as the notice (it read "IOException"); one the connection was gone before is "no agent".
/// </summary>
[Fact]
public async Task AnAskTheAgentNeverAnsweredIsNotKnownAndOneNeverSentIsNoAgent()
{
var agent = new FakeAgent { Hello = Hello(SafetyDisclosure.Version) };
var consent = new HookingConsent(agent, new FakePrompt { Accepts = true });
agent.Answer = static _ => throw new IOException("the connection to the Agent closed before it answered");
HookingConsentResult closed = await consent.EnableAsync(7, "Title", Ct);
closed.Outcome.Should().Be(HookingConsentOutcome.Unanswered);
closed.Detail.Should().BeNull("no exception's name is a notice");
agent.Answer = static _ => throw new TimeoutException();
(await consent.DisableAsync(7, Ct)).Outcome.Should().Be(HookingConsentOutcome.Unanswered);
agent.Answer = static _ => throw new InvalidOperationException("the Agent is not connected");
(await consent.DisableAsync(7, Ct)).Outcome.Should().Be(HookingConsentOutcome.AgentUnavailable, "nothing was sent");
}
[Theory]
[InlineData("I ACCEPT THE INJECTION RISK", true)]
[InlineData(" I ACCEPT THE INJECTION RISK ", true)]
@@ -46,7 +46,7 @@ public sealed class LogsViewModelTests : IDisposable
Write("ui-20260914.log", "[12:00:00.000 INF] hello\n[12:00:00.001 WRN] careful\n");
Write("agent-20260914.log", "[12:00:00.000 INF] agent here\n");
var strip = new RecordingStrip();
using var vm = new LogsViewModel(new LogTail(_dir), new BugReportFlow(new BugBundleBuilder(_dir, new RegisteredSettings(new SqliteSettingsStore(s.Db))), new PathSaver(null), new FakeAgentLink(), new ClosePreview(), new NoUrlOpener(), new NoClipboard(), strip), strip);
var vm = new LogsViewModel(new LogTail(_dir), new BugReportFlow(new BugBundleBuilder(_dir, new RegisteredSettings(new SqliteSettingsStore(s.Db))), new PathSaver(null), new FakeAgentLink(), new ClosePreview(), new NoUrlOpener(), new NoClipboard(), strip), strip);
Task pending1 = vm.Pending;
await pending1;
@@ -69,11 +69,36 @@ public sealed class LogsViewModelTests : IDisposable
vm.Text.Should().Contain("agent here");
}
/// <summary>
/// beta.23: the tail's two-second tick re-read up to 2 MB and replaced the whole text while nothing had been written; it
/// reads again only when the newest file's length or write time changed.
/// </summary>
[Fact]
public async Task ATickReadsTheTailAgainOnlyWhenTheFileChanged()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
Write("ui-20260914.log", "[12:00:00.000 INF] one\n");
var strip = new RecordingStrip();
var vm = new LogsViewModel(new LogTail(_dir), new BugReportFlow(new BugBundleBuilder(_dir, new RegisteredSettings(new SqliteSettingsStore(s.Db))), new PathSaver(null), new FakeAgentLink(), new ClosePreview(), new NoUrlOpener(), new NoClipboard(), strip), strip);
Task first = vm.Pending;
await first;
vm.Text.Should().Be("[12:00:00.000 INF] one");
vm.Text = "drawn";
await vm.RefreshIfChangedAsync();
vm.Text.Should().Be("drawn", "nothing was written since the last read: a tick reads nothing and redraws nothing");
await File.AppendAllTextAsync(Path.Combine(_dir, "ui-20260914.log"), "[12:00:01.000 INF] two\n", TestContext.Current.CancellationToken);
await vm.RefreshIfChangedAsync();
vm.Text.Should().Contain("two").And.Contain("one");
vm.TotalCount.Should().Be(2);
}
[Fact]
public async Task WithoutAFileTheStatusSaysSo()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
using var vm = new LogsViewModel(new LogTail(_dir), new BugReportFlow(new BugBundleBuilder(_dir, new RegisteredSettings(new SqliteSettingsStore(s.Db))), new PathSaver(null), new FakeAgentLink(), new ClosePreview(), new NoUrlOpener(), new NoClipboard(), new RecordingStrip()), new RecordingStrip());
var vm = new LogsViewModel(new LogTail(_dir), new BugReportFlow(new BugBundleBuilder(_dir, new RegisteredSettings(new SqliteSettingsStore(s.Db))), new PathSaver(null), new FakeAgentLink(), new ClosePreview(), new NoUrlOpener(), new NoClipboard(), new RecordingStrip()), new RecordingStrip());
Task pending = vm.Pending;
await pending;
@@ -91,7 +116,7 @@ public sealed class LogsViewModelTests : IDisposable
Directory.CreateDirectory(Path.GetDirectoryName(zip)!);
var saver = new PathSaver(zip);
var strip = new RecordingStrip();
using var vm = new LogsViewModel(new LogTail(_dir), new BugReportFlow(new BugBundleBuilder(_dir, new RegisteredSettings(new SqliteSettingsStore(s.Db))), saver, new FakeAgentLink(), new ClosePreview(), new NoUrlOpener(), new NoClipboard(), strip), strip);
var vm = new LogsViewModel(new LogTail(_dir), new BugReportFlow(new BugBundleBuilder(_dir, new RegisteredSettings(new SqliteSettingsStore(s.Db))), saver, new FakeAgentLink(), new ClosePreview(), new NoUrlOpener(), new NoClipboard(), strip), strip);
Task pending1 = vm.Pending;
await pending1;
@@ -109,7 +134,7 @@ public sealed class LogsViewModelTests : IDisposable
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
var strip = new RecordingStrip();
using var vm = new LogsViewModel(new LogTail(_dir), new BugReportFlow(new BugBundleBuilder(_dir, new RegisteredSettings(new SqliteSettingsStore(s.Db))), new PathSaver(null), new FakeAgentLink(), new ClosePreview(), new NoUrlOpener(), new NoClipboard(), strip), strip);
var vm = new LogsViewModel(new LogTail(_dir), new BugReportFlow(new BugBundleBuilder(_dir, new RegisteredSettings(new SqliteSettingsStore(s.Db))), new PathSaver(null), new FakeAgentLink(), new ClosePreview(), new NoUrlOpener(), new NoClipboard(), strip), strip);
await vm.ExportBundleCommand.ExecuteAsync(null);
@@ -5,9 +5,11 @@ using System.Windows;
using System.Windows.Controls;
using System.Windows.Input;
using FluentAssertions;
using FrameLedger.App.Charts;
using FrameLedger.App.Pages;
using FrameLedger.App.Services;
using FrameLedger.App.ViewModels;
using FrameLedger.Application.Persistence;
using FrameLedger.Infrastructure.Persistence;
using Wpf.Ui.Controls;
@@ -49,7 +51,6 @@ public sealed partial class PagesLoadTests
await using ScratchLedger s = await ScratchLedger.OpenAsync();
var consent = new HookingConsent(new NoAgent(), new NoPrompt());
(SettingsViewModel settings, LogsViewModel logs) = await SettingsAndLogsAsync(s, consent, new NoStrip());
using LogsViewModel ownedLogs = logs;
(bool Wrapped, double Offset) result = await OnStaAsync(() =>
{
@@ -71,7 +72,6 @@ public sealed partial class PagesLoadTests
await using ScratchLedger s = await ScratchLedger.OpenAsync();
var consent = new HookingConsent(new NoAgent(), new NoPrompt());
(_, LogsViewModel logs) = await SettingsAndLogsAsync(s, consent, new NoStrip());
using LogsViewModel ownedLogs = logs;
(double Height, double Offset) tail = await OnStaAsync(() =>
{
@@ -87,4 +87,46 @@ public sealed partial class PagesLoadTests
tail.Height.Should().BeLessThan(500, "the tail has the height the page leaves it, not one tall enough for every line");
tail.Offset.Should().BeGreaterThan(0, "so it scrolls, and ScrollToEnd (autoscroll) shows the newest line");
}
/// <summary>
/// beta.23: the game page's Sessions grid is bounded, so it builds the rows on screen and scrolls itself. Inside the page's
/// own scroller it was measured with no height limit and built every row - 100 sessions were 100 rows of 17 columns at
/// every open, 1.2 s (spike-notes 21). The wheel over it still reaches the page once the grid can scroll no further.
/// </summary>
[Fact]
public async Task TheSessionsGridBuildsTheRowsOnScreenAndHandsTheWheelOnAtItsEnd()
{
await using ScratchLedger s = await ScratchLedger.OpenAsync();
GameRow game = await s.GameAsync("Alpha");
for (int i = 0; i < 100; i++)
{
await s.SessionAsync(game.Id, DateTimeOffset.UtcNow.AddHours(-i - 1));
}
var detail = new GameDetailViewModel(s.Library, new GameSelection { GameId = game.Id }, new HookingConsent(new NoAgent(), new NoPrompt()), new NoNavigation(),
new NoConfirm(), new NoEdit(), new NoStrip(), new NoSummaries(), new SessionSeriesLoader(s.Sessions),
new SqliteHardwareSnapshotRepository(s.Db), new SessionSelection(), new NoPicker());
Task pending = detail.Pending;
await pending;
(int Rows, double PageBefore, double PageAfter, double GridOffset) result = await OnStaAsync(() =>
{
var page = new GameDetailPage(detail);
NavigationViewContentPresenter presenter = Navigated(page, 900);
int rows = Visuals.FindAll<DataGridRow>(page).Count();
System.Windows.Controls.DataGrid grid = Visuals.Find<System.Windows.Controls.DataGrid>(page)!;
System.Windows.Controls.ScrollViewer gridScroller = Visuals.Find<System.Windows.Controls.ScrollViewer>(grid)!;
System.Windows.Controls.ScrollViewer root = Visuals.Find<System.Windows.Controls.ScrollViewer>(page)!;
gridScroller.ScrollToEnd();
presenter.UpdateLayout();
double before = root.VerticalOffset;
Wheel(Visuals.Leaf(Visuals.FindAll<DataGridRow>(grid).Last()), -120);
presenter.UpdateLayout();
return (rows, before, root.VerticalOffset, gridScroller.VerticalOffset);
});
detail.Sessions.Should().HaveCount(100);
result.Rows.Should().BeInRange(1, 40, "only the rows the bounded grid shows are built");
result.GridOffset.Should().BeGreaterThan(0, "the grid scrolls its own rows");
result.PageAfter.Should().BeGreaterThan(result.PageBefore, "at the grid's end the wheel scrolls the page");
}
}
Loaded 100 of 108 files, more files were not shown because too many files have changed in this diff. Show more