Remove unneeded ActionGenerator class. (#12691)

It simply passes through to `BulkPushRuleEvaluator`, which can be
called directly instead.
This commit is contained in:
Patrick Cloke 2022-05-11 07:15:21 -04:00 committed by GitHub
parent 84facf769e
commit a4c75918b3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 17 additions and 60 deletions

1
changelog.d/12691.misc Normal file
View file

@ -0,0 +1 @@
Remove an unneeded class in the push code.

View file

@ -103,7 +103,7 @@ class FederationEventHandler:
self._event_creation_handler = hs.get_event_creation_handler() self._event_creation_handler = hs.get_event_creation_handler()
self._event_auth_handler = hs.get_event_auth_handler() self._event_auth_handler = hs.get_event_auth_handler()
self._message_handler = hs.get_message_handler() self._message_handler = hs.get_message_handler()
self._action_generator = hs.get_action_generator() self._bulk_push_rule_evaluator = hs.get_bulk_push_rule_evaluator()
self._state_resolution_handler = hs.get_state_resolution_handler() self._state_resolution_handler = hs.get_state_resolution_handler()
# avoid a circular dependency by deferring execution here # avoid a circular dependency by deferring execution here
self._get_room_member_handler = hs.get_room_member_handler self._get_room_member_handler = hs.get_room_member_handler
@ -1913,7 +1913,7 @@ class FederationEventHandler:
min_depth, min_depth,
) )
else: else:
await self._action_generator.handle_push_actions_for_event( await self._bulk_push_rule_evaluator.action_for_event_by_user(
event, context event, context
) )

View file

@ -426,7 +426,7 @@ class EventCreationHandler:
# This is to stop us from diverging history *too* much. # This is to stop us from diverging history *too* much.
self.limiter = Linearizer(max_count=5, name="room_event_creation_limit") self.limiter = Linearizer(max_count=5, name="room_event_creation_limit")
self.action_generator = hs.get_action_generator() self._bulk_push_rule_evaluator = hs.get_bulk_push_rule_evaluator()
self.spam_checker = hs.get_spam_checker() self.spam_checker = hs.get_spam_checker()
self.third_party_event_rules: "ThirdPartyEventRules" = ( self.third_party_event_rules: "ThirdPartyEventRules" = (
@ -1249,7 +1249,9 @@ class EventCreationHandler:
# and `state_groups` because they have `prev_events` that aren't persisted yet # and `state_groups` because they have `prev_events` that aren't persisted yet
# (historical messages persisted in reverse-chronological order). # (historical messages persisted in reverse-chronological order).
if not event.internal_metadata.is_historical(): if not event.internal_metadata.is_historical():
await self.action_generator.handle_push_actions_for_event(event, context) await self._bulk_push_rule_evaluator.action_for_event_by_user(
event, context
)
try: try:
# If we're a worker we need to hit out to the master. # If we're a worker we need to hit out to the master.

View file

@ -43,11 +43,6 @@ The general interaction of the classes are:
+---------------------------------------------+ +---------------------------------------------+
| |
v v
+-----------------+
| ActionGenerator |
+-----------------+
|
v
+-----------------------+ +---------------------------+ +-----------------------+ +---------------------------+
| BulkPushRuleEvaluator |---->| PushRuleEvaluatorForEvent | | BulkPushRuleEvaluator |---->| PushRuleEvaluatorForEvent |
+-----------------------+ +---------------------------+ +-----------------------+ +---------------------------+

View file

@ -1,48 +0,0 @@
# Copyright 2015 OpenMarket 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.
import logging
from typing import TYPE_CHECKING
from synapse.events import EventBase
from synapse.events.snapshot import EventContext
from synapse.push.bulk_push_rule_evaluator import BulkPushRuleEvaluator
from synapse.util.metrics import Measure
if TYPE_CHECKING:
from synapse.server import HomeServer
logger = logging.getLogger(__name__)
class ActionGenerator:
def __init__(self, hs: "HomeServer"):
self.clock = hs.get_clock()
self.bulk_evaluator = BulkPushRuleEvaluator(hs)
# really we want to get all user ids and all profile tags too,
# since we want the actions for each profile tag for every user and
# also actions for a client with no profile tag for each user.
# Currently the event stream doesn't support profile tags on an
# event stream, so we just run the rules for a client with no profile
# tag (ie. we just need all the users).
async def handle_push_actions_for_event(
self, event: EventBase, context: EventContext
) -> None:
if event.internal_metadata.is_outlier():
# This can happen due to out of band memberships
return
with Measure(self.clock, "action_for_event_by_user"):
await self.bulk_evaluator.action_for_event_by_user(event, context)

View file

@ -29,6 +29,7 @@ from synapse.util.async_helpers import Linearizer
from synapse.util.caches import CacheMetric, register_cache from synapse.util.caches import CacheMetric, register_cache
from synapse.util.caches.descriptors import lru_cache from synapse.util.caches.descriptors import lru_cache
from synapse.util.caches.lrucache import LruCache from synapse.util.caches.lrucache import LruCache
from synapse.util.metrics import measure_func
from .push_rule_evaluator import PushRuleEvaluatorForEvent from .push_rule_evaluator import PushRuleEvaluatorForEvent
@ -105,6 +106,7 @@ class BulkPushRuleEvaluator:
def __init__(self, hs: "HomeServer"): def __init__(self, hs: "HomeServer"):
self.hs = hs self.hs = hs
self.store = hs.get_datastores().main self.store = hs.get_datastores().main
self.clock = hs.get_clock()
self._event_auth_handler = hs.get_event_auth_handler() self._event_auth_handler = hs.get_event_auth_handler()
# Used by `RulesForRoom` to ensure only one thing mutates the cache at a # Used by `RulesForRoom` to ensure only one thing mutates the cache at a
@ -185,6 +187,7 @@ class BulkPushRuleEvaluator:
return pl_event.content if pl_event else {}, sender_level return pl_event.content if pl_event else {}, sender_level
@measure_func("action_for_event_by_user")
async def action_for_event_by_user( async def action_for_event_by_user(
self, event: EventBase, context: EventContext self, event: EventBase, context: EventContext
) -> None: ) -> None:
@ -192,6 +195,10 @@ class BulkPushRuleEvaluator:
should increment the unread count, and insert the results into the should increment the unread count, and insert the results into the
event_push_actions_staging table. event_push_actions_staging table.
""" """
if event.internal_metadata.is_outlier():
# This can happen due to out of band memberships
return
count_as_unread = _should_count_as_unread(event, context) count_as_unread = _should_count_as_unread(event, context)
rules_by_user = await self._get_rules_for_event(event, context) rules_by_user = await self._get_rules_for_event(event, context)

View file

@ -119,7 +119,7 @@ from synapse.http.client import InsecureInterceptableContextFactory, SimpleHttpC
from synapse.http.matrixfederationclient import MatrixFederationHttpClient from synapse.http.matrixfederationclient import MatrixFederationHttpClient
from synapse.module_api import ModuleApi from synapse.module_api import ModuleApi
from synapse.notifier import Notifier from synapse.notifier import Notifier
from synapse.push.action_generator import ActionGenerator from synapse.push.bulk_push_rule_evaluator import BulkPushRuleEvaluator
from synapse.push.pusherpool import PusherPool from synapse.push.pusherpool import PusherPool
from synapse.replication.tcp.client import ReplicationDataHandler from synapse.replication.tcp.client import ReplicationDataHandler
from synapse.replication.tcp.external_cache import ExternalCache from synapse.replication.tcp.external_cache import ExternalCache
@ -644,8 +644,8 @@ class HomeServer(metaclass=abc.ABCMeta):
return ReplicationCommandHandler(self) return ReplicationCommandHandler(self)
@cache_in_self @cache_in_self
def get_action_generator(self) -> ActionGenerator: def get_bulk_push_rule_evaluator(self) -> BulkPushRuleEvaluator:
return ActionGenerator(self) return BulkPushRuleEvaluator(self)
@cache_in_self @cache_in_self
def get_user_directory_handler(self) -> UserDirectoryHandler: def get_user_directory_handler(self) -> UserDirectoryHandler: