synapse-product/synapse/push/httppusher.py

477 lines
18 KiB
Python
Raw Normal View History

2016-01-06 23:26:29 -05:00
# Copyright 2015, 2016 OpenMarket Ltd
# Copyright 2017 New Vector Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
2018-01-22 13:14:10 -05:00
import logging
import urllib.parse
from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Union
2018-07-09 02:09:20 -04:00
from prometheus_client import Counter
from twisted.internet.error import AlreadyCalled, AlreadyCancelled
from twisted.internet.interfaces import IDelayedCall
from synapse.api.constants import EventTypes
from synapse.events import EventBase
2019-09-09 05:13:14 -04:00
from synapse.logging import opentracing
from synapse.metrics.background_process_metrics import run_as_background_process
from synapse.push import Pusher, PusherConfig, PusherConfigException
from synapse.storage.databases.main.event_push_actions import HttpPushAction
2016-04-07 12:12:29 -04:00
from . import push_tools
if TYPE_CHECKING:
from synapse.server import HomeServer
2018-05-21 20:47:37 -04:00
logger = logging.getLogger(__name__)
2018-01-22 13:14:10 -05:00
http_push_processed_counter = Counter(
"synapse_http_httppusher_http_pushes_processed",
"Number of push notifications successfully sent",
)
2018-01-22 13:14:10 -05:00
http_push_failed_counter = Counter(
"synapse_http_httppusher_http_pushes_failed",
"Number of push notifications which failed",
)
http_badges_processed_counter = Counter(
"synapse_http_httppusher_badge_updates_processed",
"Number of badge updates successfully sent",
)
http_badges_failed_counter = Counter(
"synapse_http_httppusher_badge_updates_failed",
"Number of badge updates which failed",
)
2018-01-22 13:14:10 -05:00
def tweaks_for_actions(actions: List[Union[str, Dict]]) -> Dict[str, Any]:
"""
Converts a list of actions into a `tweaks` dict (which can then be passed to
the push gateway).
This function ignores all actions other than `set_tweak` actions, and treats
absent `value`s as `True`, which agrees with the only spec-defined treatment
of absent `value`s (namely, for `highlight` tweaks).
Args:
actions: list of actions
e.g. [
{"set_tweak": "a", "value": "AAA"},
{"set_tweak": "b", "value": "BBB"},
{"set_tweak": "highlight"},
"notify"
]
Returns:
dictionary of tweaks for those actions
e.g. {"a": "AAA", "b": "BBB", "highlight": True}
"""
tweaks = {}
for a in actions:
if not isinstance(a, dict):
continue
if "set_tweak" in a:
# value is allowed to be absent in which case the value assumed
# should be True.
tweaks[a["set_tweak"]] = a.get("value", True)
return tweaks
class HttpPusher(Pusher):
INITIAL_BACKOFF_SEC = 1 # in seconds because that's what Twisted takes
MAX_BACKOFF_SEC = 60 * 60
# This one's in ms because we compare it against the clock
GIVE_UP_AFTER_MS = 24 * 60 * 60 * 1000
def __init__(self, hs: "HomeServer", pusher_config: PusherConfig):
super().__init__(hs, pusher_config)
2022-05-31 08:17:50 -04:00
self._storage_controllers = self.hs.get_storage_controllers()
self.app_display_name = pusher_config.app_display_name
self.device_display_name = pusher_config.device_display_name
self.pushkey_ts = pusher_config.ts
self.data = pusher_config.data
self.backoff_delay = HttpPusher.INITIAL_BACKOFF_SEC
self.failing_since = pusher_config.failing_since
self.timed_call: Optional[IDelayedCall] = None
self._is_processing = False
self._group_unread_count_by_room = (
hs.config.push.push_group_unread_count_by_room
)
self._pusherpool = hs.get_pusherpool()
self.data = pusher_config.data
if self.data is None:
raise PusherConfigException("'data' key can not be null for HTTP pusher")
self.name = "%s/%s/%s" % (
pusher_config.user_name,
pusher_config.app_id,
pusher_config.pushkey,
)
# Validate that there's a URL and it is of the proper form.
2019-06-20 05:32:02 -04:00
if "url" not in self.data:
raise PusherConfigException("'url' required in data for HTTP pusher")
url = self.data["url"]
if not isinstance(url, str):
raise PusherConfigException("'url' must be a string")
url_parts = urllib.parse.urlparse(url)
# Note that the specification also says the scheme must be HTTPS, but
# it isn't up to the homeserver to verify that.
if url_parts.path != "/_matrix/push/v1/notify":
raise PusherConfigException(
"'url' must have a path of '/_matrix/push/v1/notify'"
)
self.url = url
self.http_client = hs.get_proxied_blacklisted_http_client()
self.data_minus_url = {}
self.data_minus_url.update(self.data)
2019-06-20 05:32:02 -04:00
del self.data_minus_url["url"]
self.badge_count_last_call: Optional[int] = None
def on_started(self, should_check_for_notifs: bool) -> None:
"""Called when this pusher has been started.
Args:
should_check_for_notifs: Whether we should immediately
check for push to send. Set to False only if it's known there
is nothing to send
"""
if should_check_for_notifs:
self._start_processing()
def on_new_receipts(self, min_stream_id: int, max_stream_id: int) -> None:
# Note that the min here shouldn't be relied upon to be accurate.
# We could check the receipts are actually m.read receipts here,
# but currently that's the only type of receipt anyway...
run_as_background_process("http_pusher.on_new_receipts", self._update_badge)
async def _update_badge(self) -> None:
2020-06-18 05:47:06 -04:00
# XXX as per https://github.com/matrix-org/matrix-doc/issues/2627, this seems
# to be largely redundant. perhaps we can remove it.
badge = await push_tools.get_badge_count(
self.hs.get_datastores().main,
self.user_id,
group_by_room=self._group_unread_count_by_room,
)
if self.badge_count_last_call is None or self.badge_count_last_call != badge:
self.badge_count_last_call = badge
await self._send_badge(badge)
def on_timer(self) -> None:
self._start_processing()
def on_stop(self) -> None:
if self.timed_call:
try:
self.timed_call.cancel()
except (AlreadyCalled, AlreadyCancelled):
pass
self.timed_call = None
def _start_processing(self) -> None:
if self._is_processing:
2016-04-08 11:49:39 -04:00
return
2016-04-14 06:26:15 -04:00
run_as_background_process("httppush.process", self._process)
async def _process(self) -> None:
# we should never get here if we are already processing
assert not self._is_processing
try:
self._is_processing = True
# if the max ordering changes while we're running _unsafe_process,
# call it again, and so on until we've caught up.
while True:
starting_max_ordering = self.max_stream_ordering
2016-04-14 06:33:50 -04:00
try:
2020-07-27 12:21:34 -04:00
await self._unsafe_process()
except Exception:
logger.exception("Exception processing notifs")
if self.max_stream_ordering == starting_max_ordering:
break
finally:
self._is_processing = False
async def _unsafe_process(self) -> None:
2016-04-08 09:02:38 -04:00
"""
Looks for unset notifications and dispatch them, in order
Never call this directly: use _process which will only allow this to
run once per pusher.
"""
unprocessed = (
await self.store.get_unread_push_actions_for_user_in_range_for_http(
self.user_id, self.last_stream_ordering, self.max_stream_ordering
)
)
2018-01-22 13:14:10 -05:00
logger.info(
2018-01-22 15:15:42 -05:00
"Processing %i unprocessed push actions for %s starting at "
"stream_ordering %s",
2019-06-20 05:32:02 -04:00
len(unprocessed),
self.name,
self.last_stream_ordering,
2018-01-22 13:14:10 -05:00
)
for push_action in unprocessed:
2019-09-09 05:13:14 -04:00
with opentracing.start_active_span(
"http-push",
tags={
"authenticated_entity": self.user_id,
"event_id": push_action.event_id,
2019-09-09 05:13:14 -04:00
"app_id": self.app_id,
"app_display_name": self.app_display_name,
},
):
2020-07-27 12:21:34 -04:00
processed = await self._process_one(push_action)
2019-09-09 05:13:14 -04:00
if processed:
2018-01-22 13:14:10 -05:00
http_push_processed_counter.inc()
self.backoff_delay = HttpPusher.INITIAL_BACKOFF_SEC
self.last_stream_ordering = push_action.stream_ordering
pusher_still_exists = (
await self.store.update_pusher_last_stream_ordering_and_success(
self.app_id,
self.pushkey,
self.user_id,
self.last_stream_ordering,
self.clock.time_msec(),
)
)
if not pusher_still_exists:
# The pusher has been deleted while we were processing, so
# lets just stop and return.
self.on_stop()
return
if self.failing_since:
self.failing_since = None
2020-07-27 12:21:34 -04:00
await self.store.update_pusher_failing_since(
2019-06-20 05:32:02 -04:00
self.app_id, self.pushkey, self.user_id, self.failing_since
)
else:
2018-01-22 13:14:10 -05:00
http_push_failed_counter.inc()
if not self.failing_since:
self.failing_since = self.clock.time_msec()
2020-07-27 12:21:34 -04:00
await self.store.update_pusher_failing_since(
2019-06-20 05:32:02 -04:00
self.app_id, self.pushkey, self.user_id, self.failing_since
)
if (
2019-06-20 05:32:02 -04:00
self.failing_since
and self.failing_since
< self.clock.time_msec() - HttpPusher.GIVE_UP_AFTER_MS
):
# we really only give up so that if the URL gets
# fixed, we don't suddenly deliver a load
# of old notifications.
logger.warning(
"Giving up on a notification to user %s, pushkey %s",
2019-06-20 05:32:02 -04:00
self.user_id,
self.pushkey,
)
self.backoff_delay = HttpPusher.INITIAL_BACKOFF_SEC
self.last_stream_ordering = push_action.stream_ordering
await self.store.update_pusher_last_stream_ordering(
self.app_id,
self.pushkey,
self.user_id,
2019-06-20 05:32:02 -04:00
self.last_stream_ordering,
)
self.failing_since = None
2020-07-27 12:21:34 -04:00
await self.store.update_pusher_failing_since(
2019-06-20 05:32:02 -04:00
self.app_id, self.pushkey, self.user_id, self.failing_since
)
else:
logger.info("Push failed: delaying for %ds", self.backoff_delay)
self.timed_call = self.hs.get_reactor().callLater(
self.backoff_delay, self.on_timer
)
2019-06-20 05:32:02 -04:00
self.backoff_delay = min(
self.backoff_delay * 2, self.MAX_BACKOFF_SEC
)
break
async def _process_one(self, push_action: HttpPushAction) -> bool:
if "notify" not in push_action.actions:
return True
tweaks = tweaks_for_actions(push_action.actions)
badge = await push_tools.get_badge_count(
self.hs.get_datastores().main,
self.user_id,
group_by_room=self._group_unread_count_by_room,
)
event = await self.store.get_event(push_action.event_id, allow_none=True)
if event is None:
return True # It's been redacted
2020-07-27 12:21:34 -04:00
rejected = await self.dispatch_push(event, tweaks, badge)
if rejected is False:
return False
if isinstance(rejected, (list, tuple)):
for pk in rejected:
if pk != self.pushkey:
# for sanity, we only remove the pushkey if it
# was the one we actually sent...
logger.warning(
("Ignoring rejected pushkey %s because we didn't send it"),
pk,
)
else:
2019-06-20 05:32:02 -04:00
logger.info("Pushkey %s was rejected: removing", pk)
await self._pusherpool.remove_pusher(self.app_id, pk, self.user_id)
return True
async def _build_notification_dict(
self, event: EventBase, tweaks: Dict[str, bool], badge: int
) -> Dict[str, Any]:
priority = "low"
if (
event.type == EventTypes.Encrypted
or tweaks.get("highlight")
or tweaks.get("sound")
):
# HACK send our push as high priority only if it generates a sound, highlight
# or may do so (i.e. is encrypted so has unknown effects).
priority = "high"
# This was checked in the __init__, but mypy doesn't seem to know that.
assert self.data is not None
2019-06-20 05:32:02 -04:00
if self.data.get("format") == "event_id_only":
d: Dict[str, Any] = {
2019-06-20 05:32:02 -04:00
"notification": {
"event_id": event.event_id,
"room_id": event.room_id,
"counts": {"unread": badge},
"prio": priority,
2019-06-20 05:32:02 -04:00
"devices": [
{
2019-06-20 05:32:02 -04:00
"app_id": self.app_id,
"pushkey": self.pushkey,
2020-05-15 14:17:06 -04:00
"pushkey_ts": int(self.pushkey_ts / 1000),
2019-06-20 05:32:02 -04:00
"data": self.data_minus_url,
}
2019-06-20 05:32:02 -04:00
],
}
}
return d
2022-05-31 08:17:50 -04:00
ctx = await push_tools.get_context_for_event(
self._storage_controllers, event, self.user_id
)
d = {
2019-06-20 05:32:02 -04:00
"notification": {
"id": event.event_id, # deprecated: remove soon
"event_id": event.event_id,
"room_id": event.room_id,
"type": event.type,
"sender": event.user_id,
"prio": priority,
"counts": {
2019-06-20 05:32:02 -04:00
"unread": badge,
2015-01-29 11:10:35 -05:00
# 'missed_calls': 2
},
2019-06-20 05:32:02 -04:00
"devices": [
{
2019-06-20 05:32:02 -04:00
"app_id": self.app_id,
"pushkey": self.pushkey,
2020-05-15 14:17:06 -04:00
"pushkey_ts": int(self.pushkey_ts / 1000),
2019-06-20 05:32:02 -04:00
"data": self.data_minus_url,
"tweaks": tweaks,
}
2019-06-20 05:32:02 -04:00
],
}
}
2019-06-20 05:32:02 -04:00
if event.type == "m.room.member" and event.is_state():
d["notification"]["membership"] = event.content["membership"]
d["notification"]["user_is_target"] = event.state_key == self.user_id
if self.hs.config.push.push_include_content and event.content:
2019-06-20 05:32:02 -04:00
d["notification"]["content"] = event.content
# We no longer send aliases separately, instead, we send the human
# readable name of the room, which may be an alias.
2019-06-20 05:32:02 -04:00
if "sender_display_name" in ctx and len(ctx["sender_display_name"]) > 0:
d["notification"]["sender_display_name"] = ctx["sender_display_name"]
if "name" in ctx and len(ctx["name"]) > 0:
d["notification"]["room_name"] = ctx["name"]
return d
async def dispatch_push(
self, event: EventBase, tweaks: Dict[str, bool], badge: int
) -> Union[bool, Iterable[str]]:
2020-07-27 12:21:34 -04:00
notification_dict = await self._build_notification_dict(event, tweaks, badge)
if not notification_dict:
return []
try:
2020-07-27 12:21:34 -04:00
resp = await self.http_client.post_json_get_json(
2019-06-20 05:32:02 -04:00
self.url, notification_dict
)
except Exception as e:
logger.warning(
"Failed to push event %s to %s: %s %s",
2019-06-20 05:32:02 -04:00
event.event_id,
self.name,
type(e),
e,
2018-01-29 10:49:06 -05:00
)
return False
rejected = []
2019-06-20 05:32:02 -04:00
if "rejected" in resp:
rejected = resp["rejected"]
if not rejected:
self.badge_count_last_call = badge
return rejected
async def _send_badge(self, badge: int) -> None:
"""
Args:
badge: number of unread messages
"""
logger.debug("Sending updated badge count %d to %s", badge, self.name)
d = {
2019-06-20 05:32:02 -04:00
"notification": {
"id": "",
"type": None,
"sender": "",
"counts": {"unread": badge},
"devices": [
{
2019-06-20 05:32:02 -04:00
"app_id": self.app_id,
"pushkey": self.pushkey,
2020-05-15 14:17:06 -04:00
"pushkey_ts": int(self.pushkey_ts / 1000),
2019-06-20 05:32:02 -04:00
"data": self.data_minus_url,
}
2019-06-20 05:32:02 -04:00
],
}
}
try:
2020-07-27 12:21:34 -04:00
await self.http_client.post_json_get_json(self.url, d)
http_badges_processed_counter.inc()
except Exception as e:
logger.warning(
2019-06-20 05:32:02 -04:00
"Failed to send badge count to %s: %s %s", self.name, type(e), e
2018-01-29 10:49:06 -05:00
)
http_badges_failed_counter.inc()