muxplex-deck 0.5.1__tar.gz → 0.5.2__tar.gz

{muxplex_deck-0.5.1 → muxplex_deck-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: muxplex-deck
-Version: 0.5.1
+Version: 0.5.2
 Summary: Hardware probe/diagnostic app for the Elgato Stream Deck+ (seed of the muxplex sidecar)
 Author: Amplifier
 Author-email: Amplifier <240397093+microsoft-amplifier@users.noreply.github.com>

{muxplex_deck-0.5.1 → muxplex_deck-0.5.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "muxplex-deck"
-version = "0.5.1"
+version = "0.5.2"
 description = "Hardware probe/diagnostic app for the Elgato Stream Deck+ (seed of the muxplex sidecar)"
 readme = "README.md"
 authors = [

{muxplex_deck-0.5.1 → muxplex_deck-0.5.2}/src/muxplex_deck/cli.py

@@ -16,6 +16,7 @@ import argparse
 import contextlib
 import json
 import platform
+import shutil
 import subprocess
 import sys
 import time
@@ -593,38 +594,35 @@ def check_server_reachable(server_url: str, ca_file: Path | None) -> tuple[str,
 
 
 def check_service_status() -> tuple[str, str]:
-    """Best-effort service-installed/running check (systemd or launchd)."""
+    """Service-state check: not installed / installed but not running / running.
+
+    Three distinct states, not two -- `service_is_installed()` (unit/plist
+    file exists) and `service_is_active()` (currently running) are checked
+    independently, so an installed-but-crash-looping service is reported
+    honestly instead of as "not installed" (which used to tell the user to
+    re-run `service install` for a service that was already installed and
+    failing -- see AGENTS.md for the incident this fixes).
+    """
+    from .service import service_is_active, service_is_installed
+
     if sys.platform == "darwin":
-        import os as _os
+        manager, tool = "launchd", "launchctl"
+    else:
+        manager, tool = "systemd", "systemctl"
 
-        uid = _os.getuid()
-        try:
-            result = subprocess.run(
-                ["launchctl", "print", f"gui/{uid}/com.muxplex-deck"],
-                capture_output=True,
-                text=True,
-                timeout=5,
-                check=False,
-            )
-        except FileNotFoundError:
-            return "warn", "Service: launchctl not found"
-        if result.returncode == 0:
-            return "ok", "Service: installed (launchd)"
+    if shutil.which(tool) is None:
+        return "warn", f"Service: {tool} not found -- run muxplex-deck directly"
+
+    if not service_is_installed():
         return "warn", "Service: not installed -- run: muxplex-deck service install"
 
-    try:
-        result = subprocess.run(
-            ["systemctl", "--user", "is-active", "muxplex-deck"],
-            capture_output=True,
-            text=True,
-            timeout=5,
-            check=False,
-        )
-    except FileNotFoundError:
-        return "warn", "Service: systemctl not found -- run muxplex-deck directly"
-    if result.returncode == 0:
-        return "ok", f"Service: {result.stdout.strip()} (systemd)"
-    return "warn", "Service: not installed -- run: muxplex-deck service install"
+    if service_is_active():
+        return "ok", f"Service: installed and running ({manager})"
+
+    return "warn", (
+        f"Service: installed ({manager}) but not running -- check: "
+        "muxplex-deck service logs"
+    )
 
 
 _CHECK_MARKS: dict[str, str] = {

{muxplex_deck-0.5.1 → muxplex_deck-0.5.2}/src/muxplex_deck/config.py

@@ -145,9 +145,9 @@ def load_config(config_path: str | None = None) -> Config:
     if not path.exists():
         raise ConfigError(
             f"Config file not found: {path}\n"
-            "Create it with at least a 'server_url' field, e.g.:\n"
-            '  {"server_url": "https://<your-server>:8088"}\n'
-            "See README.md for the full example."
+            "Run: muxplex-deck init\n"
+            "(or create it by hand with at least a 'server_url' field, e.g.:\n"
+            '  {"server_url": "https://<your-server>:8088"})'
         )
 
     try:

{muxplex_deck-0.5.1 → muxplex_deck-0.5.2}/src/muxplex_deck/service.py

@@ -44,6 +44,8 @@ import sys
 import time
 from pathlib import Path
 
+from . import config as config_mod
+
 # ---------------------------------------------------------------------------
 # Constants
 # ---------------------------------------------------------------------------
@@ -307,6 +309,22 @@ def service_is_active() -> bool:
     return result.returncode == 0
 
 
+def service_is_installed() -> bool:
+    """Is the muxplex-deck unit/plist file present on disk?
+
+    Independent of `service_is_active()` -- a service that is installed but
+    crash-looping (or simply stopped) is still installed. `doctor`'s
+    `check_service_status` used to conflate "not active" with "not
+    installed" and recommend `service install` for a service that was
+    already installed and failing; this is the file-existence half of the
+    fix (see AGENTS.md for the incident: 1113 restarts, then told to
+    "install" a service that was already there).
+    """
+    if _is_darwin():
+        return _LAUNCHD_PLIST_PATH.exists()
+    return _SYSTEMD_UNIT_PATH.exists()
+
+
 def _enable_linger() -> None:
     """Best-effort `loginctl enable-linger` so the service survives logout.
 
@@ -346,6 +364,37 @@ def _print_next_steps() -> None:
     print()
 
 
+def _config_ready() -> tuple[bool, str | None]:
+    """Return (True, None) if config is loadable, else (False, ConfigError message).
+
+    Calls the exact same `config.load_config()` the installed unit's own
+    `ExecStart` (`... run`, no `--config` flag) will call at startup, so
+    "ready to install" and "ready to run" can never diverge. A config that
+    fails this check would make the service crash immediately once
+    started, and `Restart=always` (`KeepAlive` on launchd) would then
+    restart it every few seconds forever -- see the `service install`
+    crash-loop incident in AGENTS.md (1113 restarts on a fresh machine
+    with no config yet).
+    """
+    try:
+        config_mod.load_config(None)
+    except config_mod.ConfigError as exc:
+        return False, str(exc)
+    return True, None
+
+
+def _print_config_not_ready(config_error: str | None) -> None:
+    """Explain why install is stopping short of enabling/starting the service."""
+    _print_guidance_block(
+        "Not enabling or starting yet -- configuration is incomplete:\n"
+        + (config_error or "unknown configuration error")
+    )
+    print()
+    print("  Run muxplex-deck init to create it, then run this command again:")
+    print("    muxplex-deck service install")
+    print()
+
+
 def _systemd_install() -> None:
     print("\nmuxplex-deck service install (systemd --user)\n")
 
@@ -362,6 +411,15 @@ def _systemd_install() -> None:
     subprocess.run(["systemctl", "--user", "daemon-reload"], check=True)
     _step_ok("Reloaded the systemd user daemon")
 
+    # Never enable/start a unit whose config we already know will make it
+    # crash on launch -- see `_config_ready()`. The unit file above is
+    # harmless to have on disk either way; only the "make it run" steps are
+    # gated.
+    config_ready, config_error = _config_ready()
+    if not config_ready:
+        _print_config_not_ready(config_error)
+        return
+
     subprocess.run(
         ["systemctl", "--user", "enable", "--now", "muxplex-deck"], check=True
     )
@@ -567,6 +625,15 @@ def _launchd_install() -> None:
     _LAUNCHD_PLIST_PATH.write_text(plist_content)
     _step_ok(f"Wrote plist: {_LAUNCHD_PLIST_PATH}")
 
+    # Never bootstrap (load + start) a job whose config we already know will
+    # make it crash on launch -- see `_config_ready()`. `KeepAlive` would
+    # then have launchd relaunch it forever. The plist above is harmless to
+    # have on disk either way; only the "make it run" step is gated.
+    config_ready, config_error = _config_ready()
+    if not config_ready:
+        _print_config_not_ready(config_error)
+        return
+
     result = _launchd_bootstrap()
     if result.returncode == 0:
         _step_ok("Loaded + started the service (launchctl bootstrap)")