shuttlecheck 0.4.1__tar.gz → 0.4.2__tar.gz

{shuttlecheck-0.4.1 → shuttlecheck-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shuttlecheck
-Version: 0.4.1
+Version: 0.4.2
 Summary: Check media filenames, folder structure and deliverables against a written convention. Read-only.
 Author-email: MVRK Systems <hello@mvrk.systems>
 License: Proprietary — free to use, no redistribution

{shuttlecheck-0.4.1 → shuttlecheck-0.4.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "shuttlecheck"
-version = "0.4.1"
+version = "0.4.2"
 description = "Check media filenames, folder structure and deliverables against a written convention. Read-only."
 readme = { file = "PYPI.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

{shuttlecheck-0.4.1 → shuttlecheck-0.4.2}/shuttlecheck/cli.py

@@ -69,11 +69,17 @@ def build_parser() -> argparse.ArgumentParser:
     b.add_argument("--yes", action="store_true",
                    help="write it without printing the contents first")
 
-    u = sub.add_parser("ui", help="open the local app in a browser")
+    u = sub.add_parser("ui", help="open the local app in a browser, or in its own window")
     u.add_argument("root", nargs="?", help="folder to open on (optional)")
     u.add_argument("--port", type=int, default=8765)
     u.add_argument("--no-browser", action="store_true",
                    help="print the URL instead of opening it")
+    # What the packaged app does, available from a checkout. Without it a
+    # checkout can only ever show the tool as a tab, and the window is the one
+    # part of the product nobody sees until a build ships.
+    u.add_argument("--window", action="store_true",
+                   help="open in its own window (needs the [app] extra); "
+                        "falls back to a browser where there is no webview")
 
     i = sub.add_parser("init", help="read a tree and write the spec it already follows")
     i.add_argument("root")
@@ -187,7 +193,8 @@ def _ui(args) -> int:
     if root and not root.is_dir():
         print(f"error: not a folder: {root}", file=sys.stderr)
         return 2
-    serve(root, port=args.port, open_browser=not args.no_browser)
+    serve(root, port=args.port, open_browser=not args.no_browser,
+          shell=args.window and not args.no_browser)
     return 0
 
 

{shuttlecheck-0.4.1 → shuttlecheck-0.4.2}/shuttlecheck/ui.py

@@ -35,6 +35,7 @@ import secrets
 import subprocess
 import sys
 import threading
+import time
 import webbrowser
 from dataclasses import asdict
 from datetime import datetime, timezone
@@ -2382,10 +2383,17 @@ ROUTES = build_routes()
 class Handler(BaseHTTPRequestHandler):
     server_version = f"ShuttleCheck/{__version__}"
     token = ""
+    # When the page last asked for anything. Only read when the app has fallen
+    # back to a browser, where it is the one sign that anybody is still there.
+    last_seen = 0.0
 
     def log_message(self, *args):            # keep the console for our own output
         pass
 
+    def parse_request(self):
+        Handler.last_seen = time.monotonic()
+        return super().parse_request()
+
     # -- helpers ----------------------------------------------------------
 
     def _send(self, status: int, body: bytes, mime: str):
@@ -2499,6 +2507,29 @@ class Handler(BaseHTTPRequestHandler):
             return self._json(500, {"error": f"{type(exc).__name__}: {exc}"})
 
 
+# How long a browser fallback may go unheard from before it counts as closed.
+# The page asks for /api/today every minute whatever screen is up, and a
+# background tab is throttled to about that, so ten quiet minutes is a tab that
+# was closed rather than one that is idle.
+#
+# Only the fallback needs this. A window ends the process when it closes; a tab
+# does not, and a packaged build has no console to close instead, so without
+# it the server outlives the tab and sits invisibly holding a port until the
+# next login.
+ABANDONED_AFTER = 600.0
+
+
+def _until_abandoned(server: threading.Thread, *,
+                     quiet: float = ABANDONED_AFTER, poll: float = 15.0) -> None:
+    Handler.last_seen = time.monotonic()
+    tick = threading.Event()
+    while server.is_alive():
+        tick.wait(poll)
+        if time.monotonic() - Handler.last_seen > quiet:
+            print("  nothing has asked for a while; stopping")
+            return
+
+
 def serve(folder: Path | None = None, *, port: int = 8765,
           open_browser: bool = True, host: str = "127.0.0.1",
           shell: bool = False) -> None:
@@ -2531,7 +2562,11 @@ def serve(folder: Path | None = None, *, port: int = 8765,
             # and enormously better than an application that does nothing.
             if open_browser:
                 window.open_browser(url)
-            server.join()
+                _until_abandoned(server)
+            else:
+                # Nobody was shown anything, so there is no tab to outlive:
+                # this is an ingest box, and it serves until it is stopped.
+                server.join()
         except KeyboardInterrupt:
             print("\n  stopped")
         finally:

{shuttlecheck-0.4.1 → shuttlecheck-0.4.2}/shuttlecheck/ui_assets/app.js

@@ -2829,7 +2829,18 @@ PAGES.settings = async (stage) => {
   on("signIn", signIn);
   const tg = $("#telOn"); if (tg) tg.onchange = async () => { await api("/api/settings/set", { key: "telemetry.optIn", value: tg.checked }); toast(tg.checked ? "Counts will be sent." : "Nothing will be sent, and the queue was deleted."); };
   on("telShow", async () => { const r = await api("/api/telemetry/lastBatch"); $("#telOut").textContent = r.batch ? JSON.stringify(r.batch, null, 2) : "Nothing has been sent from this machine."; });
-  on("updBtn", async () => { $("#updOut").textContent = "Asking"; try { const r = await api("/api/updates/check"); $("#updOut").textContent = r.say || r.message || (r.newer ? `ShuttleCheck ${r.latest} is out.` : "This is the newest release."); } catch (err) { $("#updOut").textContent = err.message; } });
+  // The feed answers with `state`. This used to read `r.newer`, which nothing
+  // sends, so every answer, a release that was out and a feed that could not
+  // be reached alike, came back as "This is the newest release".
+  on("updBtn", async () => {
+    const out = $("#updOut"); out.textContent = "Asking";
+    try {
+      const r = await api("/api/updates/check");
+      if (r.state === "newer") out.innerHTML = `ShuttleCheck ${esc(r.latest)} is out. ${r.url ? `<a href="${esc(r.url)}" data-act="open" data-url="${esc(r.url)}">Get it</a>` : ""}`;
+      else if (r.state === "current") out.textContent = `${r.running} is the newest release.`;
+      else out.textContent = r.detail || "Could not ask.";
+    } catch (err) { out.textContent = err.message; }
+  });
 };
 
 async function signIn() {

shuttlecheck-0.4.2/shuttlecheck/version.py

@@ -0,0 +1 @@
+__version__ = "0.4.2"

{shuttlecheck-0.4.1 → shuttlecheck-0.4.2}/shuttlecheck.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shuttlecheck
-Version: 0.4.1
+Version: 0.4.2
 Summary: Check media filenames, folder structure and deliverables against a written convention. Read-only.
 Author-email: MVRK Systems <hello@mvrk.systems>
 License: Proprietary — free to use, no redistribution

{shuttlecheck-0.4.1 → shuttlecheck-0.4.2}/tests/test_window.py

@@ -275,6 +275,47 @@ def test_asking_for_no_browser_and_no_window_still_stops_cleanly(monkeypatch):
     ui.serve(port=0, open_browser=False, shell=True)
 
 
+def test_a_browser_fallback_stops_once_the_tab_has_gone_quiet(monkeypatch):
+    """A packaged build has no console, so nothing else would ever stop it."""
+    server = threading.Thread(target=threading.Event().wait, daemon=True)
+    server.start()
+    clock = iter([100.0, 100.0, 104.0, 111.0])
+    monkeypatch.setattr(ui.time, "monotonic", lambda: next(clock))
+    ui._until_abandoned(server, quiet=10.0, poll=0.001)
+    assert server.is_alive(), "it stopped waiting; the server thread is a daemon"
+
+
+def test_a_browser_fallback_keeps_serving_while_the_page_still_asks(monkeypatch):
+    server = threading.Thread(target=threading.Event().wait, daemon=True)
+    server.start()
+    times = iter([0.0, 5.0, 9.0, 14.0, 18.0, 30.0])
+    seen = iter([None, 8.0, 12.0, 17.0, None])
+
+    def now():
+        value = next(times)
+        heard = next(seen, None)
+        if heard is not None:
+            ui.Handler.last_seen = heard
+        return value
+
+    monkeypatch.setattr(ui.time, "monotonic", now)
+    ui._until_abandoned(server, quiet=10.0, poll=0.001)
+    # It ran to the last tick, which is the only one more than ten past a request.
+    assert next(times, "spent") == "spent"
+
+
+def test_the_cli_can_open_the_window_a_build_opens(monkeypatch):
+    from shuttlecheck import cli
+    calls = {}
+    monkeypatch.setattr(cli, "serve", lambda root, **kw: calls.update(kw))
+    assert cli.main(["ui", "--window"]) == 0
+    assert calls["shell"] is True
+    assert cli.main(["ui"]) == 0
+    assert calls["shell"] is False
+    assert cli.main(["ui", "--window", "--no-browser"]) == 0
+    assert calls["shell"] is False, "--no-browser means nothing is shown at all"
+
+
 def test_serving_without_a_shell_is_unchanged(monkeypatch):
     """A checkout and an ingest box in a rack still get the old behaviour."""
     calls = []

shuttlecheck-0.4.1/shuttlecheck/version.py

@@ -1 +0,0 @@
-__version__ = "0.4.1"