From 231fa317cb5e81586e53a8e092a49215a88cb397 Mon Sep 17 00:00:00 2001 From: Hermenix Date: Mon, 28 Sep 2026 21:24:27 +0000 Subject: [PATCH] module: discover the Wayland socket instead of assuming wayland-0 --- nix/module.nix | 88 ++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 63 insertions(+), 25 deletions(-) diff --git a/nix/module.nix b/nix/module.nix index ffb6296..32406cc 100644 --- a/nix/module.nix +++ b/nix/module.nix @@ -20,32 +20,67 @@ let socketDir = builtins.dirOf cfg.socketPath; # Hyprland refuses `--socket` unless it is paired with `--wayland-fd` (that - # pair is the socket-handover path), so the name is not ours to choose: the - # compositor calls wl_display_add_socket_auto, which takes the first free - # `wayland-N` starting at 0. The runtime directory is private to this - # session, so that is always `wayland-0`. - waylandDisplay = "wayland-0"; + # pair is the socket-handover path), so the socket name is not ours to choose: + # the compositor calls wl_display_add_socket_auto, which takes the first free + # `wayland-N` starting at 0. + # + # N is therefore not fixed. The runtime directory is preserved across restarts + # (`RuntimeDirectoryPreserve=yes`), so a crashed compositor leaves its + # `wayland-0` behind and the next start binds `wayland-1` — measured in the VM + # test, where the frame server then waited forever for a socket that would + # never exist. Neither unit may hardcode the name: + # + # * the compositor clears leftover sockets first (the directory is private to + # this session, so nothing else can own them) — that alone makes it + # `wayland-0` again, but the units below do not depend on that; + # * the server discovers whichever socket is actually there. + clearStaleSockets = pkgs.writeShellScript "hhstream-clear-stale-sockets" '' + for stale in "$XDG_RUNTIME_DIR"/wayland-* "$XDG_RUNTIME_DIR"/wayland-*.lock; do + if [ -e "$stale" ]; then + ${lib.getExe' pkgs.coreutils "rm"} -f "$stale" + fi + done + ''; + # Exit 0 once *any* Wayland socket is bound, and print its name so callers that + # want it do not have to glob again. + findSession = pkgs.writeShellScript "hhstream-find-session" '' + for _ in $(${lib.getExe' pkgs.coreutils "seq"} 1 300); do + for candidate in "$XDG_RUNTIME_DIR"/wayland-*; do + if [ -S "$candidate" ]; then + echo "''${candidate##*/}" + exit 0 + fi + done + ${lib.getExe' pkgs.coreutils "sleep"} 0.1 + done + echo "no Wayland socket in $XDG_RUNTIME_DIR after 30s; is the compositor up?" >&2 + exit 1 + ''; + + # The server needs WAYLAND_DISPLAY pointing at the socket the compositor + # actually bound. This cannot be an `Environment=` line, because the name is + # only known once the compositor is up — systemd's ExecStartPre cannot export + # into the main process. + execServer = pkgs.writeShellScript "hhstream-exec-server" '' + for candidate in "$XDG_RUNTIME_DIR"/wayland-*; do + if [ -S "$candidate" ]; then + export WAYLAND_DISPLAY="''${candidate##*/}" + break + fi + done + exec ${lib.getExe' cfg.package "hhstream-server"} "$@" + ''; hyprlandConf = pkgs.writeText "hyprland.conf" (import ./hyprland-conf.nix { inherit lib; inherit (cfg) outputs extraConfig; }); - # `BindsTo=` already stops the frame server when the compositor goes away, - # but the compositor is only *ready* once its Wayland socket is bound. The - # compositor unit is `Type=notify`, so this is a second line of defence for - # compositor builds that do not sd_notify. - waitForSession = pkgs.writeShellScript "hhstream-wait-for-session" '' - socket="$XDG_RUNTIME_DIR/$WAYLAND_DISPLAY" - for _ in $(${lib.getExe' pkgs.coreutils "seq"} 1 300); do - if [ -S "$socket" ]; then - exit 0 - fi - ${lib.getExe' pkgs.coreutils "sleep"} 0.1 - done - echo "no Wayland socket at $socket after 30s; is the compositor up?" >&2 - exit 1 - ''; + # `BindsTo=` already stops the frame server when the compositor goes away, but + # the compositor is only *ready* once its Wayland socket is bound. The + # compositor unit is `Type=notify`, so `findSession` above is a second line of + # defence for compositor builds that do not sd_notify, and it is why this is + # not a plain `After=` ordering. serverArgs = [ @@ -260,6 +295,10 @@ in { Type = "notify"; NotifyAccess = "all"; TimeoutStartSec = 60; + # A preserved runtime directory can still hold the previous run's + # sockets, and that would push the new session to `wayland-1` (and + # leave the server waiting on a dead one). + ExecStartPre = "${clearStaleSockets}"; ExecStart = lib.escapeShellArgs [ (lib.getExe cfg.hyprlandPackage) "--config" @@ -280,7 +319,8 @@ in { environment = sessionEnvironment // { - WAYLAND_DISPLAY = waylandDisplay; + # WAYLAND_DISPLAY is set by `execServer` at start, because the socket + # name is only known once the compositor has bound it. PYTHONUNBUFFERED = "1"; }; @@ -288,10 +328,8 @@ in { commonServiceConfig // { Type = "simple"; - ExecStartPre = "${waitForSession}"; - ExecStart = lib.escapeShellArgs ( - [(lib.getExe' cfg.package "hhstream-server")] ++ serverArgs - ); + ExecStartPre = "${findSession} >/dev/null"; + ExecStart = lib.escapeShellArgs ([execServer] ++ serverArgs); }; }; };