mix
98c820e3bd
History was appended to on every recorded run and never trimmed, and every event re-sorted the whole slice and re-measured the Job, Detail and Log columns across every row. The per-run cost therefore grew with the number of rows, in exactly the mode the app is designed for: left in the tray for days. The session History now keeps the newest maxHistoryRows (1000) records, the way maxJobLogs caps a job's own activity list, and drops the oldest from the front, zeroing the tail so a dropped record's full captured output is not kept alive by the backing array. Column widths move into a historyLog value that folds each new record into the current maxima instead of rescanning. Widths only grow within a theme, so a column never narrows when a record ages out; a theme change is the one case that still rescans, because every stored width was measured at the old text size. Measured with a throwaway benchmark over 5000 accumulated records: one refresh went from 15.8 ms to 0.9 ms. At the new cap the full width rescan alone costs 1.5 ms, so both halves of the fix carry weight. Plan item 6 of docs/PROJECT_REVIEW_PLAN.md (finding 3.1). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
105 lines
6.4 KiB
Markdown
105 lines
6.4 KiB
Markdown
# GoSentry — Standards
|
|
|
|
Quality rules and intentional behavior for contributors. Package contracts live
|
|
in [ARCHITECTURE.md](ARCHITECTURE.md); test conventions in [TESTS.md](TESTS.md).
|
|
|
|
## Code quality
|
|
|
|
- Follow package contracts in [ARCHITECTURE.md](ARCHITECTURE.md).
|
|
- User-facing errors → `dialog.ShowError` or a History event, never a silent `return`.
|
|
- Pure helpers → unit test in the same package.
|
|
- Fixes with severity ≥ medium → regression test.
|
|
- Documented intentional behavior → section below, not a backlog bug.
|
|
- UI view constructors accept `*app.Service`; call `app.Open()` only from `run.go`.
|
|
- A size that must follow the theme is **measured at build time, not written as
|
|
a pixel constant.** `theme.Padding()` and text metrics depend on the running
|
|
app's theme, text size, and DPI, so a hand-tuned number is only correct for
|
|
the one theme it was tuned against and clips under any other. Measure the real
|
|
widget, or derive the value from the theme, in a named helper: `rowOverlap`
|
|
(theme padding), `captionColumnWidth` and `textColumnWidth` (the widest of the
|
|
actual strings), `activityRowsHeight` (the list's own row template). The same
|
|
applies to a ratio computed from an absolute width — see `initialSplitOffset`.
|
|
A raw pixel literal is left only where nothing about it tracks the theme, and
|
|
says so in a comment.
|
|
|
|
## Config file compatibility
|
|
|
|
There is no migration step: `gosentry.json` and `jobs.json` are read as-is, are
|
|
meant to be hand-editable, and may have been written by an older version. A
|
|
change to their shape has to stay compatible on its own.
|
|
|
|
- A new `Config` field is tagged `omitempty`, and its zero value must mean the
|
|
behavior that existed before the field was added — a file written without it
|
|
keeps working unchanged. `DefaultConfig()` still sets the value explicitly.
|
|
- A zero that carries meaning is not a missing field and must not be backfilled
|
|
on load. See `DefaultTimeoutSeconds` in `storage.loadOrCreateConfig` and
|
|
`Job.TimeoutSeconds *int`, where unset and `0` are different answers.
|
|
- An unrecognised enum value reads as the default rather than an error, through
|
|
one helper that every consumer shares (`JobListView.IsCompact`, `ui.themeFor`),
|
|
and is normalized before being written back, so the file never gains a value
|
|
no reader understands.
|
|
- A renamed key keeps the old field on `Config` (tagged `omitempty`) purely so
|
|
it can still be read. `storage.loadOrCreateConfig` converts it to the new
|
|
field and clears it, so the retired key disappears on the next save. See
|
|
`Config.JobsDir` → `Config.JobsFile`. Where the new field has a non-empty
|
|
default, clear that default before unmarshalling, or "the file omits it" and
|
|
"the file sets it" become indistinguishable and the conversion never runs.
|
|
- Each of the three gets a test: the default in `storage`, the normalization in
|
|
`domain`, and a round-trip through the real config file in `app`.
|
|
|
|
## Intentional behavior (not bugs)
|
|
|
|
- `RunNow` is allowed during global pause and for disabled jobs.
|
|
- Selecting a jobs file that already exists **loads** it: its jobs replace the
|
|
in-memory list, which is the only way the user can switch between job lists. A
|
|
path with no file behind it receives the current jobs (rename/relocate). The
|
|
switch is refused while a job is running, because adoption drops every runtime
|
|
and a finishing run would then write its result onto whichever job inherited
|
|
its ID.
|
|
- Sequential mode runs jobs FIFO by order in `jobs.json`.
|
|
- Scheduler tick is 1s — sub-second `@every` intervals are not supported.
|
|
- Command timeout defaults to no timeout globally (`Config.DefaultTimeoutSeconds`
|
|
= 0) and is overridable per job (`Job.TimeoutSeconds *int`: unset = inherit the
|
|
global default, 0 = no timeout, positive = seconds). Neither zero may be
|
|
normalized away on load — 0 is a value, not a missing field.
|
|
- **History tab is session-only.** `JobRuntime.Logs` exists only in memory for the
|
|
current process. Log files on disk feed aggregate statistics via `SeedStats`
|
|
only. See [ARCHITECTURE.md](ARCHITECTURE.md).
|
|
- **History is capped and its columns only widen.** The tab keeps the newest
|
|
`maxHistoryRows` records and drops the oldest, the way `maxJobLogs` caps a
|
|
job's own activity list — an app left in the tray records thousands of runs a
|
|
day, each carrying the run's full captured output. Column widths are folded in
|
|
one record at a time instead of rescanned from every row, so a column never
|
|
narrows when a record ages out: the rows on screen were laid out against the
|
|
wider value. A theme change is the one case that rescans, because every stored
|
|
width was measured at the old text size.
|
|
- Several tests share a coverage profile with another test on purpose, and a few
|
|
functions sit at 0% on purpose. Both lists live in
|
|
[TESTS.md](TESTS.md) — check them before reporting a test as redundant or a
|
|
coverage gap as an oversight.
|
|
- **`KeepRunningInTray` controls tray and close behavior.** When enabled (the
|
|
default), the app registers a system tray icon at launch, closing the window
|
|
hides it, and autostart passes `--start-in-tray`. When disabled, no tray icon
|
|
is registered at launch, closing the window quits the app, and autostart opens
|
|
the main window. Toggling the setting in Settings updates close behavior and
|
|
rewrites the autostart entry immediately; the tray icon itself follows the
|
|
saved value only after a restart because Fyne has no API to add or remove it
|
|
mid-session (see [ROADMAP.md](ROADMAP.md)).
|
|
- **`--start-in-tray` defers to config.** A stale autostart shortcut that still
|
|
passes the flag does not hide the window when `KeepRunningInTray` is off.
|
|
- **`JobRuntime.PendingRuns` (the "queue" overlap policy's backlog) is capped at
|
|
`maxPendingRuns` (10) and cleared on pause or disable.** A job whose runs take
|
|
longer than its interval stops accumulating backlog once the cap is hit —
|
|
further overlaps are dropped like the "skip" policy until the backlog drains
|
|
below the cap. `SetGlobalPause(true)` and `SetEnabled(id, false)` both zero
|
|
the counter, so resuming or re-enabling a job never replays a deferred run for
|
|
an occurrence that fired before the pause/disable. The details pane appends
|
|
", N queued" to the statistics line via `DisplayStats` whenever the count is
|
|
non-zero.
|
|
|
|
## Out of scope
|
|
|
|
Larger or blocked work is tracked in [ROADMAP.md](ROADMAP.md) (update check from
|
|
GitHub releases, cron-table import/export, window size persistence, History
|
|
column filters).
|