2021-09-21 13:05:07 +00:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Writing a module - Synapse< / title >
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
< link rel = "icon" href = "../favicon.svg" >
< link rel = "shortcut icon" href = "../favicon.png" >
< link rel = "stylesheet" href = "../css/variables.css" >
< link rel = "stylesheet" href = "../css/general.css" >
< link rel = "stylesheet" href = "../css/chrome.css" >
< link rel = "stylesheet" href = "../css/print.css" media = "print" >
<!-- Fonts -->
< link rel = "stylesheet" href = "../FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "../fonts/fonts.css" >
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "../highlight.css" >
< link rel = "stylesheet" href = "../tomorrow-night.css" >
< link rel = "stylesheet" href = "../ayu-highlight.css" >
<!-- Custom theme stylesheets -->
< link rel = "stylesheet" href = "../docs/website_files/table-of-contents.css" >
< link rel = "stylesheet" href = "../docs/website_files/remove-nav-buttons.css" >
< link rel = "stylesheet" href = "../docs/website_files/indent-section-headers.css" >
2023-12-12 17:29:11 +00:00
< link rel = "stylesheet" href = "../docs/website_files/version-picker.css" >
2021-09-21 13:05:07 +00:00
< / head >
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
var path_to_root = "../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script type = "text/javascript" >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2023-11-17 13:44:41 +00:00
< ol class = "chapter" > < li class = "chapter-item expanded affix " > < li class = "part-title" > Introduction< / li > < li class = "chapter-item expanded " > < a href = "../welcome_and_overview.html" > Welcome and Overview< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Setup< / li > < li class = "chapter-item expanded " > < a href = "../setup/installation.html" > Installation< / a > < / li > < li class = "chapter-item expanded " > < a href = "../postgres.html" > Using Postgres< / a > < / li > < li class = "chapter-item expanded " > < a href = "../reverse_proxy.html" > Configuring a Reverse Proxy< / a > < / li > < li class = "chapter-item expanded " > < a href = "../setup/forward_proxy.html" > Configuring a Forward/Outbound Proxy< / a > < / li > < li class = "chapter-item expanded " > < a href = "../turn-howto.html" > Configuring a Turn Server< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../setup/turn/coturn.html" > coturn TURN server< / a > < / li > < li class = "chapter-item expanded " > < a href = "../setup/turn/eturnal.html" > eturnal TURN server< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../delegate.html" > Delegation< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Upgrading< / li > < li class = "chapter-item expanded " > < a href = "../upgrade.html" > Upgrading between Synapse Versions< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Usage< / li > < li class = "chapter-item expanded " > < a href = "../federate.html" > Federation< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/index.html" > Configuration< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../usage/configuration/config_documentation.html" > Configuration Manual< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/homeserver_sample_config.html" > Homeserver Sample Config File< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/logging_sample_config.html" > Logging Sample Config File< / a > < / li > < li class = "chapter-item expanded " > < a href = "../structured_logging.html" > Structured Logging< / a > < / li > < li class = "chapter-item expanded " > < a href = "../templates.html" > Templates< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/index.html" > User Authentication< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/single_sign_on/index.html" > Single-Sign On< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../openid.html" > OpenID Connect< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/single_sign_on/saml.html" > SAML< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/single_sign_on/cas.html" > CAS< / a > < / li > < li class = "chapter-item expanded " > < a href = "../sso_mapping_providers.html" > SSO Mapping Providers< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../password_auth_providers.html" > Password Auth Providers< / a > < / li > < li class = "chapter-item expanded " > < a href = "../jwt.html" > JSON Web Tokens< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/refresh_tokens.html" > Refresh Tokens< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../CAPTCHA_SETUP.html" > Registration Captcha< / a > < / li > < li class = "chapter-item expanded " > < a href = "../application_services.html" > Application Services< / a > < / li > < li class = "chapter-item expanded " > < a href = "../server_notices.html" > Server Notices< / a > < / li > < li class = "chapter-item expanded " > < a href = "../consent_tracking.html" > Consent Tracking< / a > < / li > < li class = "chapter-item expanded " > < a href = "../user_directory.html" > User Directory< / a > < / li > < li class = "chapter-item expanded " > < a href = "../message_retention_policies.html" > Message Retention Policies< / a > < / li > < li class = "chapter-item expanded " > < a href = "../modules/index.html" > Pluggable Modules< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../modules/writing_a_module.html" class = "active" > Writing a module< / a > < / li > < li > < ol class = "section" > < li class = "chapter-
2021-09-21 13:05:07 +00:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light (default)< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
< i class = "fa fa-search" > < / i >
< / button >
2023-12-12 17:29:11 +00:00
< div class = "version-picker" >
< div class = "dropdown" >
< div class = "select" >
< span > < / span >
< i class = "fa fa-chevron-down" > < / i >
< / div >
< input type = "hidden" name = "version" >
< ul class = "dropdown-menu" >
<!-- Versions will be added dynamically in version - picker.js -->
< / ul >
< / div >
2024-01-16 16:12:52 +00:00
< / div >
2021-09-21 13:05:07 +00:00
< / div >
< h1 class = "menu-title" > Synapse< / h1 >
< div class = "right-buttons" >
< a href = "../print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
2024-01-16 16:12:52 +00:00
< a href = "https://github.com/element-hq/synapse" title = "Git repository" aria-label = "Git repository" >
2021-09-21 13:05:07 +00:00
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
2024-01-16 16:12:52 +00:00
< a href = "https://github.com/element-hq/synapse/edit/develop/docs/modules/writing_a_module.md" title = "Suggest an edit" aria-label = "Suggest an edit" >
2021-09-21 13:05:07 +00:00
< i id = "git-edit-button" class = "fa fa-edit" > < / i >
< / a >
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
<!-- Page table of contents -->
< div class = "sidetoc" >
< nav class = "pagetoc" > < / nav >
< / div >
< h1 id = "writing-a-module" > < a class = "header" href = "#writing-a-module" > Writing a module< / a > < / h1 >
< p > A module is a Python class that uses Synapse's module API to interact with the
homeserver. It can register callbacks that Synapse will call on specific operations, as
well as web resources to attach to Synapse's web server.< / p >
< p > When instantiated, a module is given its parsed configuration as well as an instance of
the < code > synapse.module_api.ModuleApi< / code > class. The configuration is a dictionary, and is
either the output of the module's < code > parse_config< / code > static method (see below), or the
configuration associated with the module in Synapse's configuration file.< / p >
< p > See the documentation for the < code > ModuleApi< / code > class
2024-01-16 16:12:52 +00:00
< a href = "https://github.com/element-hq/synapse/blob/master/synapse/module_api/__init__.py" > here< / a > .< / p >
2021-11-02 14:27:50 +00:00
< h2 id = "when-synapse-runs-with-several-modules-configured" > < a class = "header" href = "#when-synapse-runs-with-several-modules-configured" > When Synapse runs with several modules configured< / a > < / h2 >
< p > If Synapse is running with other modules configured, the order each module appears in
within the < code > modules< / code > section of the Synapse configuration file might restrict what it can
or cannot register. See < a href = "index.html#using-multiple-modules" > this section< / a > for more
information.< / p >
< p > On top of the rules listed in the link above, if a callback returns a value that should
cause the current operation to fail (e.g. if a callback checking an event returns with a
value that should cause the event to be denied), Synapse will fail the operation and
ignore any subsequent callbacks that should have been run after this one.< / p >
< p > The documentation for each callback mentions how Synapse behaves when
multiple modules implement it.< / p >
2021-09-21 13:05:07 +00:00
< h2 id = "handling-the-modules-configuration" > < a class = "header" href = "#handling-the-modules-configuration" > Handling the module's configuration< / a > < / h2 >
< p > A module can implement the following static method:< / p >
< pre > < code class = "language-python" > @staticmethod
2022-04-19 12:25:04 +00:00
def parse_config(config: dict) -> Any
2021-09-21 13:05:07 +00:00
< / code > < / pre >
< p > This method is given a dictionary resulting from parsing the YAML configuration for the
module. It may modify it (for example by parsing durations expressed as strings (e.g.
" 5d" ) into milliseconds, etc.), and return the modified dictionary. It may also verify
that the configuration is correct, and raise an instance of
< code > synapse.module_api.errors.ConfigError< / code > if not.< / p >
< h2 id = "registering-a-web-resource" > < a class = "header" href = "#registering-a-web-resource" > Registering a web resource< / a > < / h2 >
< p > Modules can register web resources onto Synapse's web server using the following module
API method:< / p >
< pre > < code class = "language-python" > def ModuleApi.register_web_resource(path: str, resource: IResource) -> None
< / code > < / pre >
< p > The path is the full absolute path to register the resource at. For example, if you
register a resource for the path < code > /_synapse/client/my_super_module/say_hello< / code > , Synapse
will serve it at < code > http(s)://[HS_URL]/_synapse/client/my_super_module/say_hello< / code > . Note
that Synapse does not allow registering resources for several sub-paths in the < code > /_matrix< / code >
namespace (such as anything under < code > /_matrix/client< / code > for example). It is strongly
recommended that modules register their web resources under the < code > /_synapse/client< / code >
namespace.< / p >
2023-01-17 12:46:31 +00:00
< p > The provided resource is a Python class that implements Twisted's < a href = "https://docs.twistedmatrix.com/en/stable/api/twisted.web.resource.IResource.html" > IResource< / a >
interface (such as < a href = "https://docs.twistedmatrix.com/en/stable/api/twisted.web.resource.Resource.html" > Resource< / a > ).< / p >
2021-09-21 13:05:07 +00:00
< p > Only one resource can be registered for a given path. If several modules attempt to
register a resource for the same path, the module that appears first in Synapse's
configuration file takes priority.< / p >
< p > Modules < strong > must< / strong > register their web resources in their < code > __init__< / code > method.< / p >
< h2 id = "registering-a-callback" > < a class = "header" href = "#registering-a-callback" > Registering a callback< / a > < / h2 >
< p > Modules can use Synapse's module API to register callbacks. Callbacks are functions that
2021-12-14 14:23:10 +00:00
Synapse will call when performing specific actions. Callbacks must be asynchronous (unless
specified otherwise), and are split in categories. A single module may implement callbacks
from multiple categories, and is under no obligation to implement all callbacks from the
categories it registers callbacks for.< / p >
2021-09-21 13:05:07 +00:00
< p > Modules can register callbacks using one of the module API's < code > register_[...]_callbacks< / code >
methods. The callback functions are passed to these methods as keyword arguments, with
2021-12-14 14:23:10 +00:00
the callback name as the argument name and the function as its value. A
< code > register_[...]_callbacks< / code > method exists for each category.< / p >
2021-09-21 13:05:07 +00:00
< p > Callbacks for each category can be found on their respective page of the
2024-01-16 16:12:52 +00:00
< a href = "https://element-hq.github.io/synapse" > Synapse documentation website< / a > .< / p >
2023-03-14 16:43:55 +00:00
< h2 id = "caching" > < a class = "header" href = "#caching" > Caching< / a > < / h2 >
< p > < em > Added in Synapse 1.74.0.< / em > < / p >
< p > Modules can leverage Synapse's caching tools to manage their own cached functions. This
can be helpful for modules that need to repeatedly request the same data from the database
or a remote service.< / p >
< p > Functions that need to be wrapped with a cache need to be decorated with a < code > @cached()< / code >
decorator (which can be imported from < code > synapse.module_api< / code > ) and registered with the
< a href = "https://github.com/matrix-org/synapse/blob/release-v1.77/synapse/module_api/__init__.py#L888" > < code > ModuleApi.register_cached_function< / code > < / a >
API when initialising the module. If the module needs to invalidate an entry in a cache,
it needs to use the < a href = "https://github.com/matrix-org/synapse/blob/release-v1.77/synapse/module_api/__init__.py#L904" > < code > ModuleApi.invalidate_cache< / code > < / a >
API, with the function to invalidate the cache of and the key(s) of the entry to
invalidate.< / p >
< p > Below is an example of a simple module using a cached function:< / p >
< pre > < code class = "language-python" > from typing import Any
from synapse.module_api import cached, ModuleApi
class MyModule:
def __init__(self, config: Any, api: ModuleApi):
self.api = api
2024-01-16 16:12:52 +00:00
2023-03-14 16:43:55 +00:00
# Register the cached function so Synapse knows how to correctly invalidate
# entries for it.
self.api.register_cached_function(self.get_user_from_id)
@cached()
async def get_department_for_user(self, user_id: str) -> str:
" " " A function with a cache." " "
# Request a department from an external service.
return await self.http_client.get_json(
" https://int.example.com/users" , {" user_id" : user_id)
)[" department" ]
async def do_something_with_users(self) -> None:
" " " Calls the cached function and then invalidates an entry in its cache." " "
2024-01-16 16:12:52 +00:00
2023-03-14 16:43:55 +00:00
user_id = " @alice:example.com"
2024-01-16 16:12:52 +00:00
2023-03-14 16:43:55 +00:00
# Get the user. Since get_department_for_user is wrapped with a cache,
# the return value for this user_id will be cached.
department = await self.get_department_for_user(user_id)
2024-01-16 16:12:52 +00:00
2023-03-14 16:43:55 +00:00
# Do something with `department`...
2024-01-16 16:12:52 +00:00
2023-03-14 16:43:55 +00:00
# Let's say something has changed with our user, and the entry we have for
# them in the cache is out of date, so we want to invalidate it.
await self.api.invalidate_cache(self.get_department_for_user, (user_id,))
< / code > < / pre >
< p > See the < a href = "https://github.com/matrix-org/synapse/blob/release-v1.77/synapse/module_api/__init__.py#L190" > < code > cached< / code > docstring< / a > for more details.< / p >
2021-09-21 13:05:07 +00:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "../modules/index.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "../modules/spam_checker_callbacks.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
< a rel = "prev" href = "../modules/index.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "../modules/spam_checker_callbacks.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / nav >
< / div >
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
< script src = "../elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
< script type = "text/javascript" src = "../docs/website_files/table-of-contents.js" > < / script >
2023-12-12 17:29:11 +00:00
< script type = "text/javascript" src = "../docs/website_files/version-picker.js" > < / script >
< script type = "text/javascript" src = "../docs/website_files/version.js" > < / script >
2021-09-21 13:05:07 +00:00
< / body >
2023-12-12 17:29:11 +00:00
< / html >