plain.dev 0.26.1__py3-none-any.whl → 0.27.1__py3-none-any.whl

plain/dev/cli.py

@@ -2,8 +2,10 @@ import importlib
 import json
 import os
 import platform
+import signal
 import subprocess
 import sys
+import threading
 import time
 import tomllib
 from importlib.metadata import entry_points
@@ -21,7 +23,7 @@ from plain.runtime import APP_PATH, settings
 from .mkcert import MkcertManager
 from .poncho.manager import Manager as PonchoManager
 from .poncho.printer import Printer
-from .services import Services
+from .services import Services, ServicesPid
 from .utils import has_pyproject_toml
 
 ENTRYPOINT_GROUP = "plain.dev"
@@ -153,30 +155,6 @@ class Dev:
             "PLAIN_DEV_URL": self.url,
         }
 
-        self.console = Console(markup=False, highlight=False)
-        self.poncho = PonchoManager(printer=Printer(lambda s: self.console.out(s)))
-
-    def run(self):
-        mkcert_manager = MkcertManager()
-        mkcert_manager.setup_mkcert(install_path=Path.home() / ".plain" / "dev")
-        self.ssl_cert_path, self.ssl_key_path = mkcert_manager.generate_certs(
-            domain=self.hostname,
-            storage_path=Path(settings.PLAIN_TEMP_PATH) / "dev" / "certs",
-        )
-
-        self.symlink_plain_src()
-        self.modify_hosts_file()
-        self.set_csrf_and_allowed_hosts()
-        self.run_preflight()
-
-        # Processes for poncho to run simultaneously
-        self.add_gunicorn()
-        self.add_entrypoints()
-        self.add_pyproject_run()
-        self.add_services()
-
-        click.secho("\nStarting dev...", italic=True, dim=True)
-
         if self.tunnel_url:
             status_bar = Columns(
                 [
@@ -205,12 +183,91 @@ class Dev:
                 ],
                 expand=True,
             )
+        self.console = Console(markup=False, highlight=False)
+        self.console_status = self.console.status(status_bar)
+
+        self.poncho = PonchoManager(printer=Printer(lambda s: self.console.out(s)))
+
+    def run(self):
+        mkcert_manager = MkcertManager()
+        mkcert_manager.setup_mkcert(install_path=Path.home() / ".plain" / "dev")
+        self.ssl_cert_path, self.ssl_key_path = mkcert_manager.generate_certs(
+            domain=self.hostname,
+            storage_path=Path(settings.PLAIN_TEMP_PATH) / "dev" / "certs",
+        )
 
-        with self.console.status(status_bar):
+        self.symlink_plain_src()
+        self.modify_hosts_file()
+        self.set_csrf_and_allowed_hosts()
+        self.run_preflight()
+
+        # If we start services ourselves, we should manage the pidfile
+        services_pid = None
+
+        # Services start first (or are already running from a separate command)
+        if Services.are_running():
+            click.secho("Services already running", fg="yellow")
+        elif services := Services.get_services(APP_PATH.parent):
+            click.secho("\nStarting services...", italic=True, dim=True)
+            services_pid = ServicesPid()
+            services_pid.write()
+
+            for name, data in services.items():
+                env = {
+                    **os.environ,
+                    "PYTHONUNBUFFERED": "true",
+                    **data.get("env", {}),
+                }
+                self.poncho.add_process(name, data["cmd"], env=env)
+
+        # If plain.models is installed (common) then we
+        # will do a couple extra things before starting all of the app-related
+        # processes (this way they don't all have to db-wait or anything)
+        if find_spec("plain.models") is not None:
+            # Use a custom signal to tell the main thread to add
+            # the app processes once the db is ready
+            signal.signal(signal.SIGUSR1, self.start_app)
+
+            def _thread(env):
+                subprocess.run(["plain", "models", "db-wait"], env=env, check=True)
+                subprocess.run(["plain", "migrate", "--backup"], env=env, check=True)
+                # preflight with db?
+                os.kill(os.getpid(), signal.SIGUSR1)
+
+            thread = threading.Thread(
+                target=_thread, daemon=True, args=(self.plain_env,)
+            )
+            thread.start()
+        else:
+            # Start the app processes immediately
+            self.start_app(None, None)
+
+        try:
+            # Start processes we know about and block the main thread
             self.poncho.loop()
 
+            # Remove the status bar
+            self.console_status.stop()
+        finally:
+            # Make sure the services pid gets removed if we set it
+            if services_pid:
+                services_pid.rm()
+
         return self.poncho.returncode
 
+    def start_app(self, signum, frame):
+        # This runs in the main thread when SIGUSR1 is received
+        # (or called directly if no thread).
+        click.secho("\nStarting app...", italic=True, dim=True)
+
+        # Manually start the status bar now so it isn't bungled by
+        # another thread checking db stuff...
+        self.console_status.start()
+
+        self.add_gunicorn()
+        self.add_entrypoints()
+        self.add_pyproject_run()
+
     def symlink_plain_src(self):
         """Symlink the plain package into .plain so we can look at it easily"""
         plain_path = Path(
@@ -318,13 +375,13 @@ class Dev:
             sys.exit(1)
 
     def add_gunicorn(self):
-        plain_db_installed = find_spec("plain.models") is not None
-
         # Watch .env files for reload
         extra_watch_files = []
         for f in os.listdir(APP_PATH.parent):
             if f.startswith(".env"):
-                extra_watch_files.append(f)
+                # Needs to be absolute or "./" for inotify to work on Linux...
+                # https://github.com/dropseed/plain/issues/26
+                extra_watch_files.append(str(Path(APP_PATH.parent) / f))
 
         reload_extra = " ".join(f"--reload-extra-file {f}" for f in extra_watch_files)
         gunicorn_cmd = [
@@ -355,14 +412,7 @@ class Dev:
         ]
         gunicorn = " ".join(gunicorn_cmd)
 
-        if plain_db_installed:
-            runserver_cmd = (
-                f"plain models db-wait && plain migrate --backup && {gunicorn}"
-            )
-        else:
-            runserver_cmd = gunicorn
-
-        self.poncho.add_process("plain", runserver_cmd, env=self.plain_env)
+        self.poncho.add_process("plain", gunicorn, env=self.plain_env)
 
     def add_entrypoints(self):
         for entry_point in entry_points().select(group=ENTRYPOINT_GROUP):
@@ -389,22 +439,3 @@ class Dev:
                 **data.get("env", {}),
             }
             self.poncho.add_process(name, data["cmd"], env=env)
-
-    def add_services(self):
-        """Services are things that also run during tests (like a database), and are critical for the app to function."""
-
-        if Services.are_running():
-            click.secho("Services already running", fg="yellow")
-            return
-
-        # TODO need to set services pid here somehow...
-
-        # Split each service into a separate process
-        services = Services.get_services(APP_PATH.parent)
-        for name, data in services.items():
-            env = {
-                **os.environ,
-                "PYTHONUNBUFFERED": "true",
-                **data.get("env", {}),
-            }
-            self.poncho.add_process(name, data["cmd"], env=env)

plain/dev/poncho/manager.py

@@ -76,6 +76,10 @@ class Manager:
         # Update printer width to accommodate this process name
         self._printer.width = max(self._printer.width, len(name))
 
+        # If the loop is already running, we need to start the process now.
+        if self._is_running():
+            self._start_process(name)
+
         return proc
 
     def loop(self):
@@ -97,7 +101,8 @@ class Manager:
         signal.signal(signal.SIGTERM, _terminate)
         signal.signal(signal.SIGINT, _terminate)
 
-        self._start()
+        for name in self._processes.keys():
+            self._start_process(name)
 
         exit = False
         exit_start = None
@@ -172,12 +177,15 @@ class Manager:
             else:
                 self._procmgr.terminate(p["pid"])
 
-    def _start(self):
-        for name, p in self._processes.items():
-            p["process"] = multiprocessing.Process(
-                name=name, target=p["obj"].run, args=(self.events, True)
-            )
-            p["process"].start()
+    def _start_process(self, name):
+        p = self._processes[name]
+        p["process"] = multiprocessing.Process(
+            name=name, target=p["obj"].run, args=(self.events, True)
+        )
+        p["process"].start()
+
+    def _is_running(self):
+        return any(p.get("pid") is not None for _, p in self._processes.items())
 
     def _all_started(self):
         return all(p.get("pid") is not None for _, p in self._processes.items())

{plain_dev-0.26.1.dist-info → plain_dev-0.27.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.dev
-Version: 0.26.1
+Version: 0.27.1
 Summary: Local development tools for Plain.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause

{plain_dev-0.26.1.dist-info → plain_dev-0.27.1.dist-info}/RECORD

@@ -1,6 +1,6 @@
 plain/dev/README.md,sha256=EQJ9lF-JQ9KQWJZ_j6CD3jbRquOLgDRlIPbgT7A2gG4,3658
 plain/dev/__init__.py,sha256=nRX1B0Br8gmqhJLqo5Z9PqzReDahBtbmwH6C-7hzuls,103
-plain/dev/cli.py,sha256=akKprg7UV6JHweCt2dhXxEE6OgIt0bDI4CKj8B1J-68,13308
+plain/dev/cli.py,sha256=z6xDeU1hcu3dTI55H7MllKZBQz4fnAO_Y-VoIKPLO7M,14843
 plain/dev/debug.py,sha256=Ka84K8zUdF0kMYNyqiLYDrdzU1jU8LSOkts3hcw_Gok,1005
 plain/dev/default_settings.py,sha256=uXWYORWP_aRDwXIFXdu5kHyiBFUZzARIJdhPeFaX35c,75
 plain/dev/entrypoints.py,sha256=diqNwA6eydUMtoO7p_rH-DtSYsw5-GBmjFe1Z5bHagc,579
@@ -18,14 +18,14 @@ plain/dev/contribute/cli.py,sha256=jSfocR754VGMzcnb62zJA2lxxjry1Bdzupbsm3McgdY,3
 plain/dev/poncho/__init__.py,sha256=MDOk2rhhoR3V-I-rg6tMHFeX60vTGJuQ14RI-_N6tQY,97
 plain/dev/poncho/color.py,sha256=Dk77inPR9qNc9vCaZOGk8W9skXfRgoUlxp_E6mhPNns,610
 plain/dev/poncho/compat.py,sha256=l66WZLR7kRpO8P8DI5-aUsbNlohPaXEurQ5xXESQYDs,1276
-plain/dev/poncho/manager.py,sha256=xT8ur72ZaVrWYWtg5FnBSiZsENWKUHP7eG_A_ZUP-40,6363
+plain/dev/poncho/manager.py,sha256=wxurOpqhAgLQgC9DK-Pd6rukuwNgjxHu2Jyc2dkZknI,6662
 plain/dev/poncho/printer.py,sha256=wt1ioaGcPnVyrPy-UjvdsR9zfcr4DTTycmapW1MIdSU,1785
 plain/dev/poncho/process.py,sha256=JJOKy-C6vMCg7-6JMCtu6C649h7HmOBSJqDP_hnX49I,2637
 plain/dev/precommit/__init__.py,sha256=9ByBOIdM8DebChjNz-RH2atdz4vWe8somlwNEsbhwh4,40
 plain/dev/precommit/cli.py,sha256=KVHcG3Y_JZJNu3_MLIrO5s6yMYQfAArIU5L0hNWZUjg,3441
 plain/dev/templates/dev/requests.html,sha256=kQKJZq5L77juuL_t8UjcAehEU61U4RXNnKaAET-wAm8,7627
-plain_dev-0.26.1.dist-info/METADATA,sha256=HaZlzBK_kha_IyXGIPhvPai7uAuyK5DEMbwe6SFMH7g,4163
-plain_dev-0.26.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plain_dev-0.26.1.dist-info/entry_points.txt,sha256=zrcTOiFk_MLKsnYVlwVP7aMm1XLEqq7w4EBkJ-3ge-g,114
-plain_dev-0.26.1.dist-info/licenses/LICENSE,sha256=Cx4Dq9yR2fLHthf8Ke36B8QJvE1bZFXVzDIGE8wGzsY,4132
-plain_dev-0.26.1.dist-info/RECORD,,
+plain_dev-0.27.1.dist-info/METADATA,sha256=CgZpO23_EYRFL2OX0AC8glbya4WORC1kPaduysWuq-c,4163
+plain_dev-0.27.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plain_dev-0.27.1.dist-info/entry_points.txt,sha256=zrcTOiFk_MLKsnYVlwVP7aMm1XLEqq7w4EBkJ-3ge-g,114
+plain_dev-0.27.1.dist-info/licenses/LICENSE,sha256=Cx4Dq9yR2fLHthf8Ke36B8QJvE1bZFXVzDIGE8wGzsY,4132
+plain_dev-0.27.1.dist-info/RECORD,,