Skip to content

feat: support both tmux and screen as multiplexer backend #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maxamillion wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: support both tmux and screen as multiplexer backend #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 40 additions & 13 deletions dashboard
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# dashboard — Launch goosetown dashboard. Idempotent. Port on stdout, noise on stderr.
#
# Multi-instance safe: each goose instance (identified by GOOSE_GTWALL_FILE)
# gets its own dashboard. Instances never interfere with each other — no shared screen
# names, no global pkill, no "stale session" replacement.
# gets its own dashboard. Instances never interfere with each other — no shared
# session names, no global pkill, no "stale session" replacement.
set -euo pipefail

SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
Expand All @@ -18,15 +18,25 @@ info() { echo "$*" >&2; }

command -v uv &>/dev/null || die "uv not found. Install: curl -LsSf https://astral.sh/uv/install.sh | sh"

# ── Multiplexer detection ──────────────────────────────────────────────────
# Prefer tmux, fall back to screen.
if command -v tmux &>/dev/null; then
MUX=tmux
elif command -v screen &>/dev/null; then
MUX=screen
else
die "tmux or screen required but neither found"
fi

# ── Instance identity ───────────────────────────────────────────────────────
# GOOSE_GTWALL_FILE points to the wall file for this goose instance. Extract the
# WALL_ID from the filename to scope screen sessions and portfiles so multiple
# WALL_ID from the filename to scope session names and portfiles so multiple
# dashboards can coexist.
[[ -n "${GOOSE_GTWALL_FILE:-}" ]] || die2 "GOOSE_GTWALL_FILE not set"
# Sanitize to safe chars for screen session names and portfiles (must match gtwall's rules)
# Sanitize to safe chars for session names and portfiles (must match gtwall's rules)
WALL_ID=$(basename "$GOOSE_GTWALL_FILE" .log | sed 's/^wall-//' | tr -cd 'A-Za-z0-9_-')
[[ -n "$WALL_ID" ]] || die2 "Could not derive WALL_ID from GOOSE_GTWALL_FILE"
SCREEN_NAME="goosetown-ui-${WALL_ID}"
SESSION_NAME="goosetown-ui-${WALL_ID}"
PORTFILE="${WALLS_DIR}/dashboard-${WALL_ID}.port"

# ── Session resolution ──────────────────────────────────────────────────────
Expand Down Expand Up @@ -98,13 +108,30 @@ find_mine() {
# Uses -sTCP:LISTEN to avoid killing clients (browsers) with connections to the port.
kill_mine() {
local port="${1:-}"
screen -S "$SCREEN_NAME" -X quit 2>/dev/null || true
mux_kill
if [[ -n "$port" ]]; then
lsof -ti :"$port" -sTCP:LISTEN 2>/dev/null | xargs kill 2>/dev/null || true
fi
rm -f "$PORTFILE"
}

# ── Multiplexer helpers ─────────────────────────────────────────────────────
mux_start() {
local cmd="$1"
if [[ "$MUX" == tmux ]]; then
tmux new-session -d -s "$SESSION_NAME" "$cmd"
else
screen -dmS "$SESSION_NAME" bash -c "$cmd"
fi
}
mux_kill() {
if [[ "$MUX" == tmux ]]; then
tmux kill-session -t "$SESSION_NAME" 2>/dev/null || true
else
screen -X -S "$SESSION_NAME" quit 2>/dev/null || true
fi
}

# ── Commands ────────────────────────────────────────────────────────────────
cmd_status() {
local port
Expand All @@ -125,8 +152,8 @@ cmd_stop() {
kill_mine "$port"
info "Stopped."
else
# No live dashboard, but clean up any orphaned screen session
screen -S "$SCREEN_NAME" -X quit 2>/dev/null || true
# No live dashboard, but clean up any orphaned session
mux_kill
rm -f "$PORTFILE"
info "No running dashboard found (instance $WALL_ID)."
fi
Expand All @@ -146,15 +173,15 @@ cmd_launch() {
return 0
fi

# Clean up any orphaned screen session for this instance (no global pkill)
screen -S "$SCREEN_NAME" -X quit 2>/dev/null || true
# Clean up any orphaned session for this instance (no global pkill)
mux_kill
sleep 0.3

# Find open port
port=$(find_free_port) || { echo "ERROR: All ports $PORT_MIN-$PORT_MAX busy" >&2; exit 3; }

info "Launching dashboard on port $port (instance $WALL_ID, session ${session_id:0:12}...)"
screen -dmS "$SCREEN_NAME" bash -c "cd '$SCRIPT_DIR' && uv run scripts/goosetown-ui --session '$session_id' --wall '$wall_file' --port '$port'"
mux_start "cd '$SCRIPT_DIR' && uv run scripts/goosetown-ui --session '$session_id' --wall '$wall_file' --port '$port'"

# Wait for server readiness, then write portfile. Writing after readiness avoids a
# race where a concurrent call sees the portfile, fails the curl check, and deletes
Expand All @@ -169,8 +196,8 @@ cmd_launch() {
fi
done

# Failed — kill the orphaned screen session so it doesn't leak
screen -S "$SCREEN_NAME" -X quit 2>/dev/null || true
# Failed — kill the orphaned session so it doesn't leak
mux_kill
echo "ERROR: Dashboard failed to start within 5s. Check logs." >&2
exit 4
}
Expand Down
4 changes: 2 additions & 2 deletions tests/test_dashboard.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ test_status_no_server() {
test_start_requires_deps() {
echo "test_start_requires_deps"
# Check if required commands exist
if ! command -v screen &>/dev/null; then
skip "start test" "screen not installed"
if ! command -v tmux &>/dev/null && ! command -v screen &>/dev/null; then
skip "start test" "neither tmux nor screen installed"
return
fi
if ! command -v lsof &>/dev/null; then
Expand Down