Fix cache call signature to accept on_invalidate. (#8684)

Cached functions accept an `on_invalidate` function, which we failed to add to the type signature. It's rarely used in the files that we have typed, which is why we haven't noticed it before.
This commit is contained in:
Erik Johnston 2020-10-29 15:18:17 +00:00 committed by GitHub
parent 0073fe914a
commit 22eeb6bc54
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 35 additions and 16 deletions

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

@ -0,0 +1 @@
Fix typing info on cache call signature to accept `on_invalidate`.

View file

@ -19,9 +19,10 @@ can crop up, e.g the cache descriptors.
from typing import Callable, Optional from typing import Callable, Optional
from mypy.nodes import ARG_NAMED_OPT
from mypy.plugin import MethodSigContext, Plugin from mypy.plugin import MethodSigContext, Plugin
from mypy.typeops import bind_self from mypy.typeops import bind_self
from mypy.types import CallableType from mypy.types import CallableType, NoneType
class SynapsePlugin(Plugin): class SynapsePlugin(Plugin):
@ -40,8 +41,9 @@ def cached_function_method_signature(ctx: MethodSigContext) -> CallableType:
It already has *almost* the correct signature, except: It already has *almost* the correct signature, except:
1. the `self` argument needs to be marked as "bound"; and 1. the `self` argument needs to be marked as "bound";
2. any `cache_context` argument should be removed. 2. any `cache_context` argument should be removed;
3. an optional keyword argument `on_invalidated` should be added.
""" """
# First we mark this as a bound function signature. # First we mark this as a bound function signature.
@ -58,19 +60,33 @@ def cached_function_method_signature(ctx: MethodSigContext) -> CallableType:
context_arg_index = idx context_arg_index = idx
break break
arg_types = list(signature.arg_types)
arg_names = list(signature.arg_names)
arg_kinds = list(signature.arg_kinds)
if context_arg_index: if context_arg_index:
arg_types = list(signature.arg_types)
arg_types.pop(context_arg_index) arg_types.pop(context_arg_index)
arg_names = list(signature.arg_names)
arg_names.pop(context_arg_index) arg_names.pop(context_arg_index)
arg_kinds = list(signature.arg_kinds)
arg_kinds.pop(context_arg_index) arg_kinds.pop(context_arg_index)
signature = signature.copy_modified( # Third, we add an optional "on_invalidate" argument.
arg_types=arg_types, arg_names=arg_names, arg_kinds=arg_kinds, #
) # This is a callable which accepts no input and returns nothing.
calltyp = CallableType(
arg_types=[],
arg_kinds=[],
arg_names=[],
ret_type=NoneType(),
fallback=ctx.api.named_generic_type("builtins.function", []),
)
arg_types.append(calltyp)
arg_names.append("on_invalidate")
arg_kinds.append(ARG_NAMED_OPT) # Arg is an optional kwarg.
signature = signature.copy_modified(
arg_types=arg_types, arg_names=arg_names, arg_kinds=arg_kinds,
)
return signature return signature

View file

@ -48,7 +48,7 @@ from synapse.util.wheel_timer import WheelTimer
MYPY = False MYPY = False
if MYPY: if MYPY:
import synapse.server from synapse.server import HomeServer
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
@ -101,7 +101,7 @@ assert LAST_ACTIVE_GRANULARITY < IDLE_TIMER
class BasePresenceHandler(abc.ABC): class BasePresenceHandler(abc.ABC):
"""Parts of the PresenceHandler that are shared between workers and master""" """Parts of the PresenceHandler that are shared between workers and master"""
def __init__(self, hs: "synapse.server.HomeServer"): def __init__(self, hs: "HomeServer"):
self.clock = hs.get_clock() self.clock = hs.get_clock()
self.store = hs.get_datastore() self.store = hs.get_datastore()
@ -199,7 +199,7 @@ class BasePresenceHandler(abc.ABC):
class PresenceHandler(BasePresenceHandler): class PresenceHandler(BasePresenceHandler):
def __init__(self, hs: "synapse.server.HomeServer"): def __init__(self, hs: "HomeServer"):
super().__init__(hs) super().__init__(hs)
self.hs = hs self.hs = hs
self.is_mine_id = hs.is_mine_id self.is_mine_id = hs.is_mine_id
@ -1011,7 +1011,7 @@ def format_user_presence_state(state, now, include_user_id=True):
class PresenceEventSource: class PresenceEventSource:
def __init__(self, hs): def __init__(self, hs: "HomeServer"):
# We can't call get_presence_handler here because there's a cycle: # We can't call get_presence_handler here because there's a cycle:
# #
# Presence -> Notifier -> PresenceEventSource -> Presence # Presence -> Notifier -> PresenceEventSource -> Presence
@ -1071,12 +1071,14 @@ class PresenceEventSource:
users_interested_in = await self._get_interested_in(user, explicit_room_id) users_interested_in = await self._get_interested_in(user, explicit_room_id)
user_ids_changed = set() user_ids_changed = set() # type: Collection[str]
changed = None changed = None
if from_key: if from_key:
changed = stream_change_cache.get_all_entities_changed(from_key) changed = stream_change_cache.get_all_entities_changed(from_key)
if changed is not None and len(changed) < 500: if changed is not None and len(changed) < 500:
assert isinstance(user_ids_changed, set)
# For small deltas, its quicker to get all changes and then # For small deltas, its quicker to get all changes and then
# work out if we share a room or they're in our presence list # work out if we share a room or they're in our presence list
get_updates_counter.labels("stream").inc() get_updates_counter.labels("stream").inc()