From ac2265047f633c3ffdc5da5f375a492bb3e6384f Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 14 Sep 2021 18:13:51 +0100 Subject: [PATCH] Add support to notify_interested_services_ephemeral for device list updates Additionally, do some cleanup of doc strings and comments. --- synapse/handlers/appservice.py | 61 +++++++++++++++++++++++----------- synapse/notifier.py | 4 ++- 2 files changed, 45 insertions(+), 20 deletions(-) diff --git a/synapse/handlers/appservice.py b/synapse/handlers/appservice.py index 4ab4046650b8..9d3394cba52a 100644 --- a/synapse/handlers/appservice.py +++ b/synapse/handlers/appservice.py @@ -181,33 +181,56 @@ def notify_interested_services_ephemeral( stream_key: str, new_token: Optional[int], users: Optional[Collection[Union[str, UserID]]] = None, - ): - """This is called by the notifier in the background - when a ephemeral event handled by the homeserver. - - This will determine which appservices - are interested in the event, and submit them. + ) -> None: + """ + This is called by the notifier in the background when an ephemeral event is handled by + the homeserver. - Events will only be pushed to appservices - that have opted into ephemeral events + This will determine which appservices are interested in the event, and submit them. Args: stream_key: The stream the event came from. - new_token: The latest stream token - users: The user(s) involved with the event. + + When `stream_key` is "typing_key", "receipt_key" or "presence_key", events + will only be pushed to appservices that have opted into ephemeral events. + + When `stream_key` is "device_list_key", events will always be pushed to + appservices. In all cases, appservices will only receive ephemeral events + that fall within their registered user and room namespaces. + + Any other value for `stream_key` will cause this function to return early. + + new_token: The latest stream token. + + users: The user(s) involved with the event, if any. """ if not self.notify_appservices: return - if stream_key not in ("typing_key", "receipt_key", "presence_key"): - return - - services = [ - service - for service in self.store.get_app_services() - if service.supports_ephemeral - ] - if not services: + if stream_key in ("typing_key", "receipt_key", "presence_key"): + # Check whether there are any appservices which have registered to receive + # ephemeral events. + # + # Note that whether these events are actually relevant to these appservices + # is decided later on. + services = [ + service + for service in self.store.get_app_services() + if service.supports_ephemeral + ] + if not services: + # Bail out early if none of the target appservices have explicitly registered + # to receive ephemeral events. + return + elif stream_key == "device_list_key": + # Appservices do not need to register explicit support for receiving device list + # updates. + # + # Note that whether these events are actually relevant to these appservices is + # decided later on. + services = self.store.get_app_services() + else: + # This stream_key is not supported. return # We only start a new background process if necessary rather than diff --git a/synapse/notifier.py b/synapse/notifier.py index 5192deebb09a..2121d18ffd66 100644 --- a/synapse/notifier.py +++ b/synapse/notifier.py @@ -385,12 +385,14 @@ def _notify_app_services_ephemeral( Args: stream_key: The stream the event came from. new_token: The value of the new stream token. - users: The users that should be informed of the new event. + users: The users that should be informed of the new event, if any. """ try: + # TODO: What is the point of this? stream_token = None if isinstance(new_token, int): stream_token = new_token + self.appservice_handler.notify_interested_services_ephemeral( stream_key, stream_token, users or [] )