From 5c16c3302125f2a5d8a006ad42792f22b320c737 Mon Sep 17 00:00:00 2001
From: Brendan Abolivier <babolivier@matrix.org>
Date: Tue, 1 Feb 2022 16:23:55 +0100
Subject: [PATCH] Allow modules to retrieve server and worker names (#11868)
Fixes #10701
---
changelog.d/11868.feature | 1 +
synapse/module_api/__init__.py | 26 ++++++++++++++++++++++++++
2 files changed, 27 insertions(+)
create mode 100644 changelog.d/11868.feature
diff --git a/changelog.d/11868.feature b/changelog.d/11868.feature
new file mode 100644
index 0000000000..3723dac4ea
--- /dev/null
+++ b/changelog.d/11868.feature
@@ -0,0 +1 @@
+Allow modules to retrieve the current instance's server name and worker name.
diff --git a/synapse/module_api/__init__.py b/synapse/module_api/__init__.py
index 788b2e47d5..29fbc73c97 100644
--- a/synapse/module_api/__init__.py
+++ b/synapse/module_api/__init__.py
@@ -401,6 +401,32 @@ class ModuleApi:
"""
return self._hs.config.email.email_app_name
+ @property
+ def server_name(self) -> str:
+ """The server name for the local homeserver.
+
+ Added in Synapse v1.53.0.
+ """
+ return self._server_name
+
+ @property
+ def worker_name(self) -> Optional[str]:
+ """The name of the worker this specific instance is running as per the
+ "worker_name" configuration setting, or None if it's the main process.
+
+ Added in Synapse v1.53.0.
+ """
+ return self._hs.config.worker.worker_name
+
+ @property
+ def worker_app(self) -> Optional[str]:
+ """The name of the worker app this specific instance is running as per the
+ "worker_app" configuration setting, or None if it's the main process.
+
+ Added in Synapse v1.53.0.
+ """
+ return self._hs.config.worker.worker_app
+
async def get_userinfo_by_id(self, user_id: str) -> Optional[UserInfo]:
"""Get user info by user_id
--
GitLab