Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove origin parameter from add_display_name_to_third_party_invite and add params to docstring (#6010) 

Another small fixup noticed during work on a larger PR. The `origin` field of `add_display_name_to_third_party_invite` is not used and likely was just carried over from the `on_PUT` method of `FederationThirdPartyInviteExchangeServlet` which, like all other servlets, provides an `origin` argument.

Since it's not used anywhere in the handler function though, we should remove it from the function arguments.
This commit is contained in:
Andrew Morgan 2019-09-11 10:37:17 +01:00 committed by GitHub
parent 5e9b05d7da
commit cd17a2085e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/6010.misc Normal file
View File

@ -0,0 +1 @@
Remove unused `origin` argument on FederationHandler.add_display_name_to_third_party_invite.

4
synapse/federation/federation_server.py
View File

@ -669,9 +669,9 @@ class FederationServer(FederationBase):
return ret return ret
@defer.inlineCallbacks @defer.inlineCallbacks
def on_exchange_third_party_invite_request(self, origin, room_id, event_dict): def on_exchange_third_party_invite_request(self, room_id, event_dict):
ret = yield self.handler.on_exchange_third_party_invite_request( ret = yield self.handler.on_exchange_third_party_invite_request(
origin, room_id, event_dict room_id, event_dict
) )
return ret return ret

2
synapse/federation/transport/server.py
View File

@ -575,7 +575,7 @@ class FederationThirdPartyInviteExchangeServlet(BaseFederationServlet):
async def on_PUT(self, origin, content, query, room_id): async def on_PUT(self, origin, content, query, room_id):
content = await self.handler.on_exchange_third_party_invite_request( content = await self.handler.on_exchange_third_party_invite_request(
origin, room_id, content room_id, content
) )
return 200, content return 200, content

7
synapse/handlers/federation.py
View File

@ -2530,12 +2530,17 @@ class FederationHandler(BaseHandler):
@defer.inlineCallbacks @defer.inlineCallbacks
@log_function @log_function
def on_exchange_third_party_invite_request(self, origin, room_id, event_dict): def on_exchange_third_party_invite_request(self, room_id, event_dict):
"""Handle an exchange_third_party_invite request from a remote server """Handle an exchange_third_party_invite request from a remote server
The remote server will call this when it wants to turn a 3pid invite The remote server will call this when it wants to turn a 3pid invite
into a normal m.room.member invite. into a normal m.room.member invite.
Args:
room_id (str): The ID of the room.
event_dict (dict[str, Any]): Dictionary containing the event body.
Returns: Returns:
Deferred: resolves (to None) Deferred: resolves (to None)
""" """