Troubleshoot dysfunctional presenters (#3371)

Author: luisa-beerboom

Makefile

@@ -75,6 +75,16 @@ check-initial-data-json:
 check-example-data-json:
 	python cli/check_json.py data/example-data.json
 
+# The commands below can be called in the container to open the gunicorn control socket interfaces
+# for the action and presenter services respectively.
+# Environment setting OPENSLIDES_BACKEND_ENABLE_CONTROL_SOCKET needs to be true for this to be possible.
+
+open-gunicornc-action:
+	gunicornc -s "openslides-action.ctl"
+
+open-gunicornc-presenter:
+	gunicornc -s "openslides-presenter.ctl"
+
 
 
 ########################## Deprecation List ##########################

README.md

@@ -116,6 +116,10 @@ The action component listens to port 9002. The presenter component listens to po
 
   If `OPENSLIDES_BACKEND_CREATE_INITIAL_DATA` is true, use the password in the given file as the password for the user with id `1`. Only applicable in productive mode. Default: `/run/secrets/superadmin`
 
+* `OPENSLIDES_BACKEND_ENABLE_CONTROL_SOCKET`
+
+  If `OPENSLIDES_BACKEND_ENABLE_CONTROL_SOCKET` is true, the backend will generate a gunicorn control interface server for both actions (`openslides-action.ctl`) and presenters (`openslides-presenter.ctl`). This will make it possible to observe how many web workers there are and some other actions by calling `gunicornc -s <control interface name>`, `make open-gunicornc-action`, or `make open-gunicornc-presenter` in the backend container, see [the gunicorn guides](https://gunicorn.org/guides/gunicornc/) for usage information.
+
 ### Development
 
 * `OPENSLIDES_DEVELOPMENT`

openslides_backend/main.py

@@ -12,7 +12,7 @@
 from openslides_backend.shared.interfaces.env import Env
 
 from .action.action_worker import gunicorn_post_request, gunicorn_worker_abort
-from .shared.env import Environment
+from .shared.env import Environment, is_truthy
 from .shared.interfaces.wsgi import WSGIApplication
 
 # register_services()
@@ -60,10 +60,21 @@ def load_config(self) -> None:
             ),  # Threads per Worker(process)
             "post_request": gunicorn_post_request,
             "worker_abort": gunicorn_worker_abort,
+            "control_socket_disable": not is_truthy(
+                self.env.OPENSLIDES_BACKEND_ENABLE_CONTROL_SOCKET
+            ),
+            "control_socket": self.get_control_socket_name(),
         }
         for key, value in options.items():
             self.cfg.set(key, value)
 
+    def get_control_socket_name(self) -> str:
+        if self.view_name == "ActionView":
+            return "openslides-action.ctl"
+        elif self.view_name == "PresenterView":
+            return "openslides-presenter.ctl"
+        raise ValueError(f"Invalid view {self.view_name}")
+
     def get_address(self) -> str:
         if self.view_name == "ActionView":
             return f"0.0.0.0:{self.env.ACTION_PORT}"

openslides_backend/shared/env.py

@@ -39,6 +39,7 @@ class Environment(Env):
         "OPENSLIDES_BACKEND_WORKER_TIMEOUT": "30",
         "OPENSLIDES_BACKEND_THREAD_WATCH_TIMEOUT": "1",
         "OPENSLIDES_BACKEND_CREATE_INITIAL_DATA": "false",
+        "OPENSLIDES_BACKEND_ENABLE_CONTROL_SOCKET": "false",
         "SUPERADMIN_PASSWORD_FILE": "/run/secrets/superadmin",
         "OPENSLIDES_DEVELOPMENT": "false",
         "OPENSLIDES_LOGLEVEL": Loglevel.NOTSET.name,

tests/system/presenter/test_get_user_related_models.py

@@ -55,6 +55,14 @@ def test_get_user_related_models_simple(self) -> None:
             }
         }
 
+    def test_get_user_related_models_no_info(self) -> None:
+        bob_id = self.create_user("bob")
+        status_code, data = self.request(
+            "get_user_related_models", {"user_ids": [bob_id]}
+        )
+        self.assertEqual(status_code, 200)
+        assert data == {"2": {}}
+
     def test_get_user_related_models_committee(self) -> None:
         self.set_models(
             {