Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Add note about extra arg to send_membership_event, remove arg in remo…
Browse files Browse the repository at this point in the history
…te_reject_invite (#6009)

Some small fixes to `room_member.py` found while doing other PRs.

1. Add requester to the base `_remote_reject_invite` method.
2. `send_membership_event`'s docstring was out of date and took in a `remote_room_hosts` arg that was not used and no calling function provided.
  • Loading branch information
anoadragon453 authored Sep 11, 2019
1 parent 6604b64 commit 9c555f3
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 10 deletions.
1 change: 1 addition & 0 deletions changelog.d/6009.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Small refactor of function arguments and docstrings in RoomMemberHandler.
12 changes: 2 additions & 10 deletions synapse/handlers/room_member.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ def _remote_join(self, requester, remote_room_hosts, room_id, user, content):
raise NotImplementedError()

@abc.abstractmethod
def _remote_reject_invite(self, remote_room_hosts, room_id, target):
def _remote_reject_invite(self, requester, remote_room_hosts, room_id, target):
"""Attempt to reject an invite for a room this server is not in. If we
fail to do so we locally mark the invite as rejected.
Expand Down Expand Up @@ -510,9 +510,7 @@ def _update_membership(
return res

@defer.inlineCallbacks
def send_membership_event(
self, requester, event, context, remote_room_hosts=None, ratelimit=True
):
def send_membership_event(self, requester, event, context, ratelimit=True):
"""
Change the membership status of a user in a room.
Expand All @@ -522,16 +520,10 @@ def send_membership_event(
act as the sender, will be skipped.
event (SynapseEvent): The membership event.
context: The context of the event.
is_guest (bool): Whether the sender is a guest.
room_hosts ([str]): Homeservers which are likely to already be in
the room, and could be danced with in order to join this
homeserver for the first time.
ratelimit (bool): Whether to rate limit this request.
Raises:
SynapseError if there was a problem changing the membership.
"""
remote_room_hosts = remote_room_hosts or []

target_user = UserID.from_string(event.state_key)
room_id = event.room_id

Expand Down

0 comments on commit 9c555f3

Please sign in to comment.