Files
yellowjacket/scripts/dev-headless.sh
T
yonluandClaude Opus 5 deb3f3da7e feat(wails): move the e2e harness and headless launch onto v3
make e2e is green on chromium: 92 passed. The harness is rebuilt on
what v3 actually offers, and three of the four things it replaced turn
out to be better than what they replaced.

The headless launch is v3's own server mode. scripts/dev-headless.sh
ran a `-tags dev` binary whose app_dev.go parsed -devserver/-assetdir
out of os.Args; that file went with v2, so the harness had no server at
all. `-tags dev,server` is a first-class mode and needs no display, so
Xvfb is gone from the script and from CI.

The bridge hooks two places, neither of them EventsOn. Inbound is
window._wails.dispatchWailsEvent, wrapped by pre-creating the object
the runtime keeps and putting an accessor on the one property.
Outbound is fetch: v3 routes every runtime call through one POST, so
the bridge sees binding calls and event emits from any module, needs no
walk of an object graph, and cannot miss a call made before it looked.

__yjEvents.call posts to that endpoint by method name, so it depends on
nothing in the app's bundle and works on a page with no init script.
That is what lets seed-sandbox.sh drop playwright-cli entirely — it
drove AddLibrary through a browser only because window.go was v2's one
way in — and with it a global npm install and a second Chromium in CI.

measure.mjs and one spec lose their window.go walks and read the
bridge's log instead; e2e/support/method-ids.mjs derives id -> name
from frontend/bindings/ (phase 6b option 1, so it cannot go stale
silently). Plain .mjs because measure.mjs runs under bare node and one
derivation beats two that can disagree.

Four bugs surfaced, and the migration is how.

The cross-service wiring never ran headless. It hung off
Common.ApplicationStarted, which server mode never emits —
setupCommonEvents is an explicit no-op there — so the queue had no
TrackLoader and playing a track changed the queue and then silently did
nothing. It is a service registered last now (backend/startup.go):
services start in registration order, which is the ordering the wiring
needs, in every mode.

Six specs called SetQueue with 3 of its 4 arguments. v2 accepted that
and filled the gap; v3 answers "expects 4 arguments, got 3".

requested-badge's cleanup read window.go and returned early on
`if (!svc)` — the silent cleanup its own comment was written to
prevent, one migration later. It posts to the runtime endpoint now,
which any page can do.

SearchIndex.Search trusted a startup latch, so rows a spec staged
afterwards were unsearchable and three specs passed only when an
earlier one happened to flip it. shelves.go fixed exactly this and left
hasCatalogRows behind; the search path now uses it as the fallback,
with the latch still the fast path.

Two spec edits are deletions of assertions about v2. harness.spec
checked Object.keys(window.go) and that a bad call *hung*; it now
checks the real runtime is loaded and that the backend rejects with a
TypeError naming the argument. album-actions asserted a tracklist
legend that dcc40b1 deleted on main — that spec has been failing since,
and what replaced it is covered in frontend/test/components.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UDCbcCZQepnpSQYJ6SxxZm
2026-08-14 20:58:20 -04:00

205 lines
6.6 KiB
Bash
Executable File

#!/usr/bin/env bash
#
# Start YellowJacket headless, in the background, and return.
#
# Wails v3's server mode binds an HTTP server on :34115 that serves the
# real frontend with the real generated bindings and bridges every call
# and every event to the *same* Go backend a desktop window would use.
# A browser pointed at it is not a mock. That is what makes this app
# drivable by a coding agent.
#
# Three details are load-bearing:
#
# * We build with `-tags dev,server` and run the binary. This is a
# first-class Wails mode ("a pure HTTP server without native GUI
# dependencies"), not something hand-rolled: v2 had no such thing,
# so this script used to run a dev binary whose app_dev.go parsed
# -devserver / -assetdir out of os.Args. That file is gone with v2.
# The port comes from WAILS_SERVER_PORT.
#
# * Xvfb is gone, and that is the point of server mode. v2's
# devserver.Run ended in Frontend.Run(ctx), which opened the GTK
# window and blocked with no flag to suppress it; server mode opens
# no window, so there is no display to fake.
#
# * dbus-run-session is not incidental. A private session bus makes
# backend/mediacontrols register MPRIS for real, so it becomes
# assertable with busctl. It replaces the bus, not /run/user, so
# PulseAudio still works and InitSpeaker succeeds.
#
# * The frontend is *embedded*, not served from disk. main.go has
# //go:embed all:frontend/dist, so a frontend change needs the
# rebuild this script does anyway; there is no -assetdir to point
# at a live directory.
#
# Usage:
# scripts/dev-headless.sh [--seed NAME|--fresh] [--port N] [--no-build]
#
set -euo pipefail
cd "$(dirname "$0")/.."
REPO_ROOT="$PWD"
RUN_DIR="$REPO_ROOT/.dev"
PID_FILE="$RUN_DIR/app.pid"
LOG_FILE="$RUN_DIR/app.log"
HOME_FILE="$RUN_DIR/app.home"
SEED_DIR="$RUN_DIR/seeds"
BIN="$REPO_ROOT/build/bin/yj-dev"
PORT=34115
SEED=""
FRESH=0
BUILD=1
LOG_LEVEL="${YJ_LOG_LEVEL:-debug}"
STARTUP_TIMEOUT=60
usage() {
sed -n '3,38p' "$0" | sed 's/^# \{0,1\}//'
exit "${1:-0}"
}
while [ $# -gt 0 ]; do
case "$1" in
--seed)
SEED="${2:?--seed needs a name}"
shift 2
;;
--fresh)
FRESH=1
shift
;;
--port)
PORT="${2:?--port needs a number}"
shift 2
;;
--no-build)
BUILD=0
shift
;;
-h | --help) usage 0 ;;
*)
echo "dev-headless: unknown argument: $1" >&2
usage 2
;;
esac
done
mkdir -p "$RUN_DIR"
# ── Refuse to stack instances ────────────────────────────────────────
# Two backends on one port fails obscurely; two backends on one YJ_HOME
# corrupts a SQLite database. Check the saved PID, not the port.
if [ -f "$PID_FILE" ] && kill -0 "$(cat "$PID_FILE")" 2>/dev/null; then
echo "dev-headless: already running (pid $(cat "$PID_FILE")); " \
"run 'make dev-stop' first" >&2
exit 1
fi
rm -f "$PID_FILE"
# ── Choose the YJ_HOME ───────────────────────────────────────────────
# A seed is a YJ_HOME that a previous run of the app produced, tarred
# up (see scripts/seed-sandbox.sh). Restoring it means starting *in*
# the app instead of on the first-run wizard, which intercepts every
# pointer event until a library exists.
if [ -n "$SEED" ] && [ "$FRESH" = 1 ]; then
echo "dev-headless: --seed and --fresh are mutually exclusive" >&2
exit 2
fi
if [ -n "$SEED" ]; then
SEED_TAR="$SEED_DIR/$SEED.tar"
if [ ! -f "$SEED_TAR" ]; then
echo "dev-headless: no seed '$SEED' at $SEED_TAR" >&2
echo " build one with: make sandbox-seed NAME=$SEED" >&2
exit 1
fi
YJ_HOME="$RUN_DIR/home-$SEED"
rm -rf "$YJ_HOME"
mkdir -p "$YJ_HOME"
tar -xf "$SEED_TAR" -C "$YJ_HOME"
echo "dev-headless: restored seed '$SEED'"
elif [ "$FRESH" = 1 ]; then
# Deliberately empty: the first-run wizard is itself a surface
# that needs testing.
YJ_HOME="$RUN_DIR/home-fresh"
rm -rf "$YJ_HOME"
mkdir -p "$YJ_HOME"
echo "dev-headless: fresh YJ_HOME (expect the first-run wizard)"
else
YJ_HOME="${YJ_HOME:-$RUN_DIR/home}"
mkdir -p "$YJ_HOME"
fi
export YJ_HOME
echo "$YJ_HOME" >"$HOME_FILE"
# ── Build ────────────────────────────────────────────────────────────
if [ "$BUILD" = 1 ]; then
echo "dev-headless: building frontend + dev server binary..."
(cd frontend && pnpm install --silent && pnpm build >/dev/null)
go build -tags "dev,server" -o "$BIN" .
fi
if [ ! -x "$BIN" ]; then
echo "dev-headless: $BIN missing; drop --no-build" >&2
exit 1
fi
# ── Launch ───────────────────────────────────────────────────────────
# setsid puts the app in its own process group so dev-stop can kill the
# whole tree (dbus-daemon, the app) by group id. Never
# `pkill -f`: the pattern matches the invoking shell's own command line
# and silently drops the rest of the chain.
: >"$LOG_FILE"
# YJ_TESTCTL mounts backend/testctl's /__test/ endpoints. It is opt-in
# rather than implied by the dev build so that a human's `make dev` does
# not carry an arbitrary-SQL endpoint on a listening port.
YJ_TESTCTL=1 \
WAILS_SERVER_PORT="$PORT" \
YJ_LOG_LEVEL="$LOG_LEVEL" setsid dbus-run-session -- \
"$BIN" \
>>"$LOG_FILE" 2>&1 &
APP_PID=$!
echo "$APP_PID" >"$PID_FILE"
# ── Wait for the dev server ──────────────────────────────────────────
deadline=$((SECONDS + STARTUP_TIMEOUT))
until curl -sf -o /dev/null "http://localhost:$PORT/"; do
if ! kill -0 "$APP_PID" 2>/dev/null; then
echo "dev-headless: app exited during startup; last log lines:" >&2
tail -n 30 "$LOG_FILE" >&2
rm -f "$PID_FILE"
exit 1
fi
if [ "$SECONDS" -ge "$deadline" ]; then
echo "dev-headless: :$PORT did not answer within ${STARTUP_TIMEOUT}s" >&2
tail -n 30 "$LOG_FILE" >&2
exit 1
fi
sleep 0.25
done
cat <<EOF
dev-headless: up
url http://localhost:$PORT
pid $APP_PID
YJ_HOME $YJ_HOME
log ${LOG_FILE#"$REPO_ROOT"/} (make dev-logs)
Drive it with:
playwright-cli -s=yj open http://localhost:$PORT
playwright-cli -s=yj snapshot
playwright-cli -s=yj eval "() => window.__yjEvents.call('queue.Queue.GetState', [], 5000)"
A bad binding call now rejects rather than hanging: v3 answers wrong
argument types with a TypeError naming the argument and an unknown
method with a ReferenceError. The timeout in __yjEvents.call is a
backstop for a hung request, not how a mistake becomes visible.
EOF