Files
komorebi/docs/usage/investigating-a-recording.md
T
LGUG2Z 7c692138c7 docs(usage): proposing a rule for a ghost tile
What the viewer offers under a bug region that was marked over a ghost tile, what
sending does and which credentials it uses, where the rule goes for each komorebi
(applications.json or applications.mac.json), how narrow it is, and what a
recording needs for there to be any ghost tile to propose on each host.
2026-10-28 16:24:29 -07:00

157 lines
11 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Investigating a Recording
A [recording](recording-a-bug-repro.md) answers "what was komorebi doing when this went wrong?" if you can read it.
`komorebi-recorder` has commands that do the reading, built so that a person or an agent can go from "the user says
this is broken" to "this is the line of komorebi that causes it" using what was recorded rather than guessing.
```
komorebi-recorder brief <session> # start here
komorebi-recorder guide # the playbook, for an agent
```
Every command takes `--json`, which prints an envelope `{ok, schema, data, warnings, truncated, next_cursor, error}`;
`komorebi-recorder schema` lists the schemas and `komorebi-recorder schema brief/1` prints one. Exit codes: 0 ok, 1
error, 2 usage, 3 not found, 4 the session cannot answer (still recording, or the recorder died: `reindex` it), 5 over
budget.
## The viewer
```
komorebi-recorder view <session>
```
opens the recording in its own window, for the person who made it (or anyone with the folder) to play, scrub and mark.
The recorder window has **Open session…** and **Open last** for the same thing.
- The **video** of every display, side by side. A display that was unplugged or asleep shows why it has nothing there,
and the others carry on. **State overlay** draws komorebi's idea of the layout over the picture: where each tiled
window was meant to be (dashed) and where it really was (solid, red if it looks wrong).
- The **timeline** under it has a lane for the **bug regions** you marked, komorebi's **events** (coloured by what kind,
with echoes faint), errors and warnings in komorebi's log, what happened to the **machine** (a display unplugged, a
sleep), the **findings** that look wrong, and the **video** each display has. Click anywhere to go there, drag to
scrub, pinch or ⌘-scroll to zoom, scroll to pan, Shift-drag to select a range.
- **Playing** goes forwards and backwards at 0.25× to 8×; J, K and L shuttle like a video editor; ← and → step one
frame; `,` and `.` jump between events. Press **?** in the window for every key.
- The **inspector** on the right: _Now_ is the state at the playhead and what has just happened; _Event_ is a selected
event traced end to end, as `trace` shows it, ending with what the OS trace recorded around it (komorebi's own calls
into the OS, the system, each application) as groups you can open; _Findings_ is what looks wrong, ranked; _Bugs_ is what was marked and
concluded; _Log_ is komorebi's own log, following the playhead.
### Marking the bug
Press **B** (or **Mark bug**) to describe the bug: the form takes the region from your selection (`[` and `]` mark its
ends, or Shift-drag on the timeline) or from the playhead, asks what goes wrong and what you expected, and saves it the
moment you press Save. Drag a region's edges on the timeline to adjust it. **Copy a prompt for an agent** in the _Bugs_
tab puts an instruction on the clipboard that starts an agent on `brief` with your description.
### Proposing a rule for a ghost tile
A _ghost tile_ is a tile of the layout that holds a window nobody can see: komorebi has the window in front on a
workspace that is showing, and it never was on screen. When a bug region you marked was made while one was there, the
_Bugs_ tab says so under the region, and **Propose a rule to komorebi-application-specific-configuration** opens a
form with the rule that would ignore that window: which window it was, what the recording showed of it, and the entry
that would go in the repository. Nothing is sent until you press **Send as a pull request**.
Sending clones the repository into a temporary folder, commits the rule on a new branch with a message that says what
was seen and why, and opens a pull request under your account with the credentials you already have set up for `git`
(and the GitHub CLI, `gh`, if you have it). With `gh` signed in, the branch goes to your fork of the repository, made
if you have none, unless you may push to the repository itself. Without `gh` the branch is pushed with `git` and you
are given the link that opens the pull request. If anything fails, the form says what, keeps the clone, and gives the
commands to push it and open the pull request yourself.
The rule goes in the file of the komorebi the recording is of, whatever you are looking at it on:
`applications.json` for komorebi for Windows and `applications.mac.json` for komorebi for Mac. It is always narrow
enough to leave the application's other windows alone:
| | komorebi for Windows | komorebi for Mac |
|---|---|---|
| matches | the program and the window class, as a composite rule | the application and the window title, as a composite rule |
| when the application's visible windows share that class | the title is added, if it tells them apart | (windows have no class) |
| when nothing tells the ghost from a visible window | no rule is written, and the form says why | no rule is written, and the form says why |
The entry is put where it sorts and the rest of the file is unchanged, line for line.
What counts as a ghost tile depends on what the recording can say. On Windows it needs `record --probe-windows` (see
[Probing windows on Windows](recording-a-bug-repro.md#probing-windows-on-windows)): Windows says whether each window is
on screen, and a ghost is one it said was cloaked or not visible on every read and never on screen. A Mac cannot be
asked, so there it is a window whose frame, as komorebi read it from the accessibility API, was never one a person
could see: zero-sized, or outside every display. That is weaker evidence, and the pull request says which it is. A
recording that has none of this has no ghost tiles to propose, which is not the same as having none.
Everything the viewer shows is also available from the command line, so an agent can investigate headlessly:
## What the user said
The first thing in a [brief](#brief) is the **bug region**: the stretch of the recording the user marked, with their
description of what is wrong and what they expected.
The user marks it in the viewer. To add one without a window, as a script or an agent would:
```
komorebi-recorder annotate <session> add --kind bug --start 12.5 --end 18 \
--text "the new window opens on the wrong monitor" --expected "it should open on the focused one"
komorebi-recorder annotations <session>
```
Times can be a video timecode (`12.5`, `1:02.5`), `wall:<RFC 3339>`, `event:<seq>`, `log:<line>`, `incident:<n>` or
`bug:<id>` (`.start` or `.end`), each with an offset such as `+3s`. `event:12` is when komorebi began handling event 12
and `event:12.end` when it finished.
## Commands
| Command | What it tells you |
| --- | --- |
| `brief` | The bug region(s) in the user's words, then what the recording shows around them: the events, what looked wrong, the state as it began and ended, what happened to the machine, and the events most worth tracing first, with why |
| `overview` | The whole recording at a glance: what stands out, ranked (states that are wrong and for how long, windows that flap, event storms, slow handlers, errors, a display unplugged), anything near a bug region first |
| `state --at T` | What komorebi believed at a moment, and anything inconsistent in it: a window parked off screen on a workspace that is showing, a window in two places, a layout that was not applied |
| `diff A B` | What changed between two moments in terms a person would use: a window appeared, moved, was really somewhere else; focus moved; a monitor came or went |
| `events` | komorebi's events, classified (command, focus, lifecycle, drag, monitor, lock, and `echo`: the OS reporting back a move komorebi made itself), with the handler that ran and whether the state changed |
| `trace event:N` | One event end to end: what its handler logged, with the source statement for each line, what other threads logged meanwhile, and every change with who made it (see below). `--os` adds the OS trace around it: komorebi's own calls into the OS, the system and each application, split into while the handler ran and after |
| `window ID\|TEXT` | One window's life: when it appeared, moved, was parked off screen, was really somewhere else, and which event did each |
| `code event:N`, `code log:N` | The line of komorebi's source that wrote a log line, with the code around it |
| `search TEXT` | Where a word appears: komorebi's log, events, incidents, annotations (and `--oslog` for the macOS trace) |
| `changes` | When and where on each display the picture changed, and which events fall inside |
| `sheet` | A contact sheet image of frames with times, events and the bug region marked |
| `annotate`, `annotations` | Add, change and list bug regions, notes and findings |
### Who changed it
komorebi sends the state _after_ each event, so what an event changed is the difference from the previous one. That
includes whatever background threads did since: the reaper (removes windows that no longer exist) and the workspace
reconciliator (moves windows between workspaces after a space change) change state **without sending a notification**.
`trace` therefore gives each change an _attribution_ with its evidence and how sure it is: `handler`, `reaper` (when its
log line names the window), `workspace-reconciliator`, or `unexplained`, which means state changed and nothing in the log
accounts for it. That is a finding in itself.
### From a log line to the source
komorebi's log says what happened but not where in its code. The recorder is built with an index of every `tracing`
statement in komorebi's source; `code` matches a recorded line to the statement that wrote it, says when several
statements read alike (`ambiguous`) or only print a value (`generic`), and flags the reaper and workspace reconciliator.
A mapping is only as good as the source it was made against, so every answer says whether the source the recorder was
built from is the komorebi that was recorded, by comparing the commit the recorded binary reports with the indexed
source and naming the files that differ. Lines in files that did not change are exactly as good as if the commits were
the same.
### What the data cannot tell you
- The event timestamp is when komorebi finished the handler. Time spent waiting for its lock or in accessibility calls
before the handler's first log line is invisible, so `handler_ms` is a lower bound.
- At the default `info` level there is no log line for the end of an event handler, and few for the decisions inside it.
Start komorebi with `--log-level trace` before recording a bug you intend to investigate.
- The `rect` of a window in the state is read live from the accessibility API when the state is serialized: it is where
the window really was, which is what makes comparing it with where komorebi's layout put it meaningful.
- An `AXError` in komorebi's log comes from the application or the OS, not from komorebi.
## Recording what you conclude
```
komorebi-recorder annotate <session> add --kind finding --about <bug id> \
--text "the Show handler tiles the window onto the display that is going away" \
--ref event:12 --ref log:340 --ref code:komorebi/src/process_event.rs:512
```
A finding with no evidence is refused, and every reference is checked to exist: the event, the log line, the video time,
the line of komorebi's source. Findings are stored in `annotations.jsonl` beside the bug region, so the person who
recorded the bug can see what was concluded and why.