Matrix/synapse
Matrix/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse synced 2024-07-04 12:13:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Allow modules to retrieve server and worker names (#11868)

Browse source 
Fixes #10701
This commit is contained in:
Brendan Abolivier 2022-02-01 16:23:55 +01:00 committed by GitHub
parent 64ec45fc1b
commit 5c16c33021
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/11868.feature Normal file
View file

@ -0,0 +1 @@
Allow modules to retrieve the current instance's server name and worker name.

26
synapse/module_api/__init__.py
View file

@ -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