Exit runserver when Daphne startup aborts

Author: lin-hongkuan

.pre-commit-config.yaml

@@ -1,23 +1,23 @@
-repos:
+repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.20.0
-    hooks:
-      - id: pyupgrade
-        args: [--py39-plus]
-  - repo: https://github.com/psf/black
-    rev: 25.1.0
-    hooks:
-      - id: black
-        language_version: python3
-  - repo: https://github.com/pycqa/isort
-    rev: 6.0.1
-    hooks:
-      - id: isort
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.3.0
-    hooks:
-      - id: flake8
-        additional_dependencies:
-          - flake8-bugbear
-ci:
-  autoupdate_schedule: quarterly
+    rev: v3.21.2
+    hooks:
+      - id: pyupgrade
+        args: [--py39-plus]
+  - repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+      - id: black
+        language_version: python3
+  - repo: https://github.com/pycqa/isort
+    rev: 6.0.1
+    hooks:
+      - id: isort
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.3.0
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - flake8-bugbear
+ci:
+  autoupdate_schedule: quarterly

daphne/management/commands/runserver.py

@@ -136,16 +136,27 @@ def inner_run(self, *args, **options):
 
         # build the endpoint description string from host/port options
         endpoints = build_endpoint_description_strings(host=self.addr, port=self.port)
+        self.run_daphne(
+            application=self.get_application(options),
+            endpoints=endpoints,
+            options=options,
+            root_path=getattr(settings, "FORCE_SCRIPT_NAME", "") or "",
+        )
+
+    def run_daphne(self, application, endpoints, options, root_path):
         try:
-            self.server_cls(
-                application=self.get_application(options),
+            self.server = self.server_cls(
+                application=application,
                 endpoints=endpoints,
                 signal_handlers=not options["use_reloader"],
                 action_logger=self.log_action,
                 http_timeout=self.http_timeout,
-                root_path=getattr(settings, "FORCE_SCRIPT_NAME", "") or "",
+                root_path=root_path,
                 websocket_handshake_timeout=self.websocket_handshake_timeout,
-            ).run()
+            )
+            self.server.run()
+            if self.server.abort_start:
+                raise CommandError("Daphne failed to start.")
             logger.debug("Daphne exited")
         except KeyboardInterrupt:
             shutdown_message = options.get("shutdown_message", "")

tests/test_runserver.py

@@ -0,0 +1,34 @@
+from unittest import TestCase
+
+from django.core.management import CommandError
+
+from daphne.management.commands.runserver import Command
+
+
+class TestRunserverCommand(TestCase):
+    class AbortedServer:
+        abort_start = True
+
+        def __init__(self, **kwargs):
+            self.init_kwargs = kwargs
+            self.ran = False
+
+        def run(self):
+            self.ran = True
+
+    def test_run_daphne_raises_command_error_when_start_aborts(self):
+        command = Command()
+        command.server_cls = self.AbortedServer
+        command.http_timeout = None
+        command.websocket_handshake_timeout = 5
+
+        with self.assertRaisesRegex(CommandError, "Daphne failed to start."):
+            command.run_daphne(
+                application=object(),
+                endpoints=["tcp:port=8000:interface=127.0.0.1"],
+                options={"use_reloader": False},
+                root_path="",
+            )
+
+        self.assertTrue(command.server.ran)
+        self.assertTrue(command.server.init_kwargs["signal_handlers"])