shellphone 0.0.1__tar.gz → 0.0.2__tar.gz

{shellphone-0.0.1 → shellphone-0.0.2}/.gitignore

@@ -6,3 +6,4 @@ __pycache__/
 .access.env
 .venv/
 uv.lock
+out/

{shellphone-0.0.1 → shellphone-0.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: shellphone
-Version: 0.0.1
+Version: 0.0.2
 Summary: A chat room for you and your coding agents, on your own computer.
 Project-URL: Homepage, https://github.com/woltspace/shellphone
 Project-URL: Issues, https://github.com/woltspace/shellphone/issues

{shellphone-0.0.1 → shellphone-0.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "shellphone"
-version = "0.0.1"
+version = "0.0.2"
 description = "A chat room for you and your coding agents, on your own computer."
 readme = "shellphone/README.md"
 requires-python = ">=3.10"

{shellphone-0.0.1 → shellphone-0.0.2}/room.py

@@ -793,7 +793,10 @@ def code_ref():
     """The commit this room runs, so strangers' agents fetch exactly this version (not a branch that can move)."""
     if os.environ.get("SHELLPHONE_REF"):
         return os.environ["SHELLPHONE_REF"]
-    got = subprocess.run(["git", "-C", str(HERE), "rev-parse", "HEAD"], capture_output=True, text=True)
+    try:
+        got = subprocess.run(["git", "-C", str(HERE), "rev-parse", "HEAD"], capture_output=True, text=True)
+    except OSError:  # no git on this computer
+        return "main"
     return got.stdout.strip() if got.returncode == 0 else "main"
 
 

{shellphone-0.0.1 → shellphone-0.0.2}/shellphone/cli.py

@@ -11,6 +11,7 @@ from pathlib import Path
 
 HERE = Path(__file__).resolve().parent
 PREFIX = "shellphone-room-"
+THROWAWAY = "throwaway.pid"  # only in a room made to be deleted: the pid of the command that owns it
 HOST_EMAIL = "host@shellphone.local"  # the room keys people by email; a local room has one person, the host
 CONNECTOR = ("wait", "post", "history", "working", "run", "voice", "version")
 
@@ -48,10 +49,12 @@ def alive(pid):
 
 
 def sweep():
-    """A room that crashed couldn't delete itself: remove what such rooms left behind. Rooms still open are left alone."""
+    """A throwaway room that crashed couldn't delete itself: remove what such rooms left behind. Only folders this
+    command made as throwaway carry the marker; a kept room never does, wherever it is and whatever it's called.
+    Rooms still open are left alone."""
     for d in Path(tempfile.gettempdir()).glob(PREFIX + "*"):
         try:
-            pid = int((d / "host.pid").read_text())
+            pid = int((d / THROWAWAY).read_text())
         except (OSError, ValueError):
             continue  # not clearly ours to delete
         if not alive(pid):
@@ -77,10 +80,12 @@ def room(a):
         os.chmod(data, 0o700)
     else:
         data = Path(tempfile.mkdtemp(prefix=PREFIX))  # mode 700
-    (data / "host.pid").write_text(str(os.getpid()))
+        (data / THROWAWAY).write_text(str(os.getpid()))
     port = free_port(a.port)
     url = f"http://127.0.0.1:{port}"
     os.environ.update(SHELLPHONE_DATA=str(data), SHELLPHONE_URL=url)  # read by room.py when it loads
+    if (HERE / "room.py").is_file():  # installed as a package: there's no checkout to ask git about (and maybe no git)
+        os.environ.setdefault("SHELLPHONE_REF", "main")
     r = part("room")
     with contextlib.redirect_stdout(io.StringIO()):
         r.add_person(HOST_EMAIL, a.name)
@@ -92,9 +97,15 @@ def room(a):
     server = r.http.server.ThreadingHTTPServer(("127.0.0.1", port), r.Handler)
     server.daemon_threads = True
 
-    def stop(*_):
-        raise KeyboardInterrupt
+    closing = []
+
+    def stop(*_):  # the first stop signal closes the room; any that follow do nothing, so closing always finishes
+        if not closing:
+            closing.append(True)
+            raise KeyboardInterrupt
     signal.signal(signal.SIGTERM, stop)
+    if signal.getsignal(signal.SIGINT) is not signal.SIG_IGN:  # started in the background, Ctrl-C isn't ours to take
+        signal.signal(signal.SIGINT, stop)
     print(f"""Shell Phone room is open, on this computer only.
 
   Open the chat:    {url}/?k={token}
@@ -111,7 +122,6 @@ Press Ctrl-C to close the room. """ + (f"It's kept in {data}." if a.keep else "E
         if r.CON is not None:
             r.CON.close()
         if a.keep:
-            (data / "host.pid").unlink(missing_ok=True)
             print(f"\nRoom closed. It's kept in {data}.")
         else:
             shutil.rmtree(data, ignore_errors=True)

{shellphone-0.0.1 → shellphone-0.0.2}/tests/test_cli.py

@@ -1,25 +1,26 @@
 """The front door, end to end on one computer: open a room, log in with the link, bring an agent, talk, close.
 
-    python3 -m unittest discover tests
+    python3 -m unittest discover tests                                  # the code in this folder
+    SHELLPHONE_CLI=/some/venv/bin/shellphone python3 -m unittest discover tests   # an installed package, e.g. a built wheel
 """
-import http.cookiejar, json, os, re, signal, subprocess, sys, tempfile, time, unittest, urllib.error, urllib.request
+import http.cookiejar, json, os, re, shlex, signal, subprocess, sys, tempfile, time, unittest, urllib.error, urllib.request
 from pathlib import Path
 
 REPO = Path(__file__).resolve().parent.parent
 sys.path.insert(0, str(REPO))
-CLI = [sys.executable, "-m", "shellphone.cli"]
+INSTALLED = os.environ.get("SHELLPHONE_CLI")  # test this command (an installed package) instead of the code in this folder
+CLI = shlex.split(INSTALLED) if INSTALLED else [sys.executable, "-m", "shellphone.cli"]
+ENV = {**os.environ, "PYTHONUNBUFFERED": "1", **({} if INSTALLED else {"PYTHONPATH": str(REPO)})}
 
 
 def run(*args, cwd, stdin=None):
-    return subprocess.run([*CLI, *args], cwd=cwd, input=stdin, capture_output=True, text=True, timeout=30,
-                          env={**os.environ, "PYTHONPATH": str(REPO)})
+    return subprocess.run([*CLI, *args], cwd=cwd, input=stdin, capture_output=True, text=True, timeout=30, env=ENV)
 
 
 class Room:
     """A room in its own process, as `shellphone room` starts it."""
-    def __init__(self, *args):
-        self.proc = subprocess.Popen([*CLI, "room", "--port", "0", *args], stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True,
-                                     env={**os.environ, "PYTHONPATH": str(REPO), "PYTHONUNBUFFERED": "1"})
+    def __init__(self, *args, env=None):
+        self.proc = subprocess.Popen([*CLI, "room", "--port", "0", *args], stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True, env=env or ENV)
         self.banner = ""
         while "Press Ctrl-C" not in self.banner:
             line = self.proc.stdout.readline()
@@ -59,14 +60,14 @@ class FrontDoor(unittest.TestCase):
                 r.proc.communicate()
         self.tmp.cleanup()
 
-    def room(self, *args):
-        self.rooms.append(Room(*args))
+    def room(self, *args, **kw):
+        self.rooms.append(Room(*args, **kw))
         return self.rooms[-1]
 
     def data_dir(self, room):
         """Where the room keeps its data, found from outside: the temp folder holding this room's pid."""
         for d in Path(tempfile.gettempdir()).glob("shellphone-room-*"):
-            if (d / "host.pid").is_file() and (d / "host.pid").read_text() == str(room.proc.pid):
+            if (d / "throwaway.pid").is_file() and (d / "throwaway.pid").read_text() == str(room.proc.pid):
                 return d
 
     def test_the_link_logs_the_host_in_and_nothing_else_does(self):
@@ -142,6 +143,11 @@ class FrontDoor(unittest.TestCase):
             self.assertNotEqual(got.returncode, 0, link)
             self.assertFalse((work / "shellphone").exists(), link)
 
+    def test_a_room_opens_on_a_computer_with_no_git(self):
+        r = self.room(env={**ENV, "PATH": self.tmp.name})  # nothing on the path at all
+        self.assertEqual(r.browser.open(r.open).status, 200)
+        self.assertIn("Room closed and deleted.", r.close())
+
     def test_closing_deletes_the_room(self):
         for sig in (signal.SIGINT, signal.SIGTERM):
             r = self.room()
@@ -151,6 +157,18 @@ class FrontDoor(unittest.TestCase):
             self.assertIn("Room closed and deleted.", r.close(sig))
             self.assertFalse(data.exists())
 
+    def test_a_second_stop_signal_cant_interrupt_the_closing(self):
+        for burst in ([signal.SIGINT] * 6, [signal.SIGTERM] * 6, [signal.SIGTERM, signal.SIGINT] * 3):
+            r = self.room()
+            r.browser.open(r.open)
+            data = self.data_dir(r)
+            for sig in burst:  # a double Ctrl-C, or a stop sent to a whole process group
+                r.proc.send_signal(sig)
+            out = r.proc.communicate(timeout=10)[0]
+            self.assertIn("Room closed and deleted.", out)
+            self.assertNotIn("Traceback", out)
+            self.assertFalse(data.exists())
+
     def test_keep_keeps_the_room_and_changes_the_links(self):
         kept = Path(self.tmp.name) / "kept"
         r = self.room("--keep", str(kept))
@@ -166,6 +184,21 @@ class FrontDoor(unittest.TestCase):
         stale = again.url + "/#" + old.split("#")[1]  # last run's agent link no longer opens the room
         self.assertNotEqual(run("join", stale, "--name", "helper", cwd=Path(self.tmp.name)).returncode, 0)
 
+    def test_a_kept_room_is_never_swept_even_when_it_looks_like_a_throwaway_one(self):
+        kept = Path(tempfile.mkdtemp(prefix="shellphone-room-saved-"))  # the worst place and name to keep a room
+        self.addCleanup(__import__("shutil").rmtree, kept, True)
+        r = self.room("--keep", str(kept))
+        r.browser.open(r.open)
+        r.browser.open(urllib.request.Request(r.url + "/api/messages", data=json.dumps({"text": "keep me"}).encode(),
+                                              headers={"Content-Type": "application/json"}))
+        r.proc.kill()  # a crash: nothing gets tidied
+        r.proc.communicate()
+        self.room()  # another room starts and sweeps
+        self.assertTrue((kept / "room.db").is_file())
+        again = self.room("--keep", str(kept))  # and the kept room opens again with what was said
+        again.browser.open(again.open)
+        self.assertIn("keep me", [m.get("text") for m in again.state()["messages"]])
+
     def test_a_crashed_rooms_leftovers_are_swept_and_an_open_room_is_left_alone(self):
         open_room = self.room()
         crashed = self.room()