Skip to content

Tweak docstrings and signatures of auth_types_for_event and get_catchup_room_event_ids. #19320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
reivilibre wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Tweak docstrings and signatures of auth_types_for_event and get_catchup_room_event_ids. #19320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7169940
drive-by: auth_types_for_event: use `StateKey` in return type for cla…
reivilibre Dec 22, 2025
f426bd9
drive-by docstring fix on get_catchup_room_event_ids: oldest -> newest
reivilibre Dec 22, 2025
44937d6
Newsfile
reivilibre Dec 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/19320.misc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Tweak docstrings and signatures of `auth_types_for_event` and `get_catchup_room_event_ids`.
5 changes: 3 additions & 2 deletions synapse/event_auth.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
from synapse.storage.databases.main.events_worker import EventRedactBehaviour
from synapse.types import (
MutableStateMap,
StateKey,
StateMap,
StrCollection,
UserID,
Expand Down Expand Up @@ -1200,8 +1201,8 @@ def get_public_keys(invite_event: "EventBase") -> list[dict[str, Any]]:

def auth_types_for_event(
room_version: RoomVersion, event: Union["EventBase", "EventBuilder"]
) -> set[tuple[str, str]]:
"""Given an event, return a list of (EventType, StateKey) that may be
) -> set[StateKey]:
"""Given an event, return a list of (state event type, state key) that may be
needed to auth the event. The returned list may be a superset of what
would actually be required depending on the full state of the room.

Expand Down
2 changes: 1 addition & 1 deletion synapse/storage/databases/main/transactions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ async def get_catch_up_room_event_ids(
) -> list[str]:
"""
Returns at most 50 event IDs and their corresponding stream_orderings
that correspond to the oldest events that have not yet been sent to
that correspond to the newest events that have not yet been sent to
the destination.

Args:
Expand Down