Files
yellowjacket/scripts/bindings-check.sh
T
logan 5ca6cad45a
Build & publish Arch package / arch-package (push) Successful in 2m8s
CI / check (push) Failing after 1m56s
CI / e2e (push) Skipped
Search index maintenance / maintain-index (push) Successful in 13s
feat(harness): agent-drivable dev harness and CI that gates
A coding agent could develop this repo's Go packages and could not
develop the application: every path to running YellowJacket ended in a
blocking GTK window, so 265 bound methods, 46 events, 33 component
directories and 13 stores had exactly one form of verification
available — `tsc --noEmit`.

The unlock is that `wails dev`'s dev server on :34115 serves the real
frontend with the real generated bindings against the same Go backend a
desktop window attaches to, so a plain Chromium under Xvfb gets a fully
functional app. Four test tiers now exist, cheapest first:

- `make ui-test` — 313 Vitest tests in a real browser in ~2 s, no app,
  no backend, no display. Works because `frontend/wailsjs/` is a pure
  passthrough to `window.go`/`window.runtime`, so faking just those two
  globals runs the real bindings and the real store code.
- `make test` — services in-process, asserting on the payload the
  frontend would receive, via a new `events.Emit` wrapper.
- `make dev-headless` + `playwright-cli` — the real app, driven
  interactively, with an event bridge on `window.__yjEvents` and a
  dev-only control surface at `/__test/`.
- `make e2e` — 19 of those flows frozen as Playwright specs.

`events.Emit(ctx, …)` replaces all 35 direct `runtime.EventsEmit` call
sites: wails' `getEvents` `log.Fatalf`s on any context without its
runtime, so those paths could not run under test and a background
worker could take the app down. Four packages had each hand-rolled the
same guard; nine more guarded on `ctx != nil`, which does not help.
`TestNoDirectRuntimeEmits` fails the build on a new one.

Fixtures are generated, not committed (`make testdata`), and seeds are
built by *running the app* — never by hand-writing config and DB rows,
which would be a second description of a valid YJ_HOME.

`.gitea/workflows/ci.yml` is the first workflow here that tests
anything; the other three only package, so `gitea_ci` reported only
packaging jobs and misled anyone asking whether a push was healthy.
Both jobs were prototyped to green in a bare ubuntu:24.04 container
before the YAML was written, which immediately caught `make lint`
linting three configurations that nothing builds: all three passes
omitted `webkit2_41`, so wails resolved webkit2gtk-4.0 — which Arch
still ships and Ubuntu 24.04 dropped.

Operational instructions live in `.pi/skills/yellowjacket-dev/`,
measured discoveries in `.planning/NOTES.md`, and architecture in
`CLAUDE.md` — split by tense, not by topic, because a topical split
gives every new fact two plausible homes. `make skill-check` fails a
commit if the skill cites a make target that does not exist.
2026-08-10 23:20:42 -04:00

44 lines
1.5 KiB
Bash
Executable File

#!/usr/bin/env bash
#
# Fails when frontend/wailsjs/ is stale against the bound Go structs.
#
# frontend/wailsjs/ is generated by `wails`, not by `go generate`, so the
# pre-commit codegen check does not cover it at all. Without this, a
# renamed Go struct field or a changed method signature first shows up at
# runtime, inside a window, as a binding that never settles.
#
# `wails generate module` builds the app with the `bindings` tag and runs
# it to dump the bindings — about three seconds, so it is cheap enough to
# gate a commit on.
set -euo pipefail
cd "$(dirname "$0")/.."
TARGET="frontend/wailsjs"
if [ -n "$(git status --porcelain -- "$TARGET")" ]; then
echo "bindings-check: $TARGET has uncommitted changes; stage or stash them first" >&2
git status --short -- "$TARGET" >&2
exit 1
fi
go tool wails generate module -tags webkit2_41 >/dev/null 2>&1
# `wails generate module` rewrites the three runtime files as 755 every
# time. That is not drift, so compare content only.
if ! git -c core.fileMode=false diff --quiet -- "$TARGET"; then
echo "bindings-check: $TARGET is out of date with the Go bindings." >&2
echo "Run 'make bindings' and stage the result." >&2
git -c core.fileMode=false diff --stat -- "$TARGET" >&2
exit 1
fi
# Restore the modes the generator churned, so the tree is left clean.
chmod 644 \
frontend/wailsjs/runtime/runtime.js \
frontend/wailsjs/runtime/runtime.d.ts \
frontend/wailsjs/runtime/package.json
echo "bindings-check: frontend/wailsjs is current"