mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-12-15 17:51:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Remove unused auth_event_ids argument plumbing (#12304)

Browse source 
Follow-up to https://github.com/matrix-org/synapse/pull/12083

Since we are now using the new `state_event_ids` parameter to do all of the heavy lifting.
We can remove any spots where we plumbed `auth_event_ids` just for MSC2716 things in
https://github.com/matrix-org/synapse/pull/9247/files.

Removing `auth_event_ids` from following functions:

 - `create_and_send_nonmember_event`
 - `_local_membership_update`
 - `update_membership`
 - `update_membership_locked`
This commit is contained in:
Eric Eastwood 2022-03-29 03:18:52 -05:00 committed by GitHub
parent 287a9c1e20
commit 6f2943714b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 1 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -0,0 +1 @@
Refactor `create_new_client_event` to use a new parameter, `state_event_ids`, which accurately describes the usage with [MSC2716](https://github.com/matrix-org/matrix-doc/pull/2716) instead of abusing `auth_event_ids`.

8
synapse/handlers/message.py
View file

@ -782,7 +782,6 @@ class EventCreationHandler:
event_dict: dict, event_dict: dict,
allow_no_prev_events: bool = False, allow_no_prev_events: bool = False,
prev_event_ids: Optional[List[str]] = None, prev_event_ids: Optional[List[str]] = None,
auth_event_ids: Optional[List[str]] = None,
state_event_ids: Optional[List[str]] = None, state_event_ids: Optional[List[str]] = None,
ratelimit: bool = True, ratelimit: bool = True,
txn_id: Optional[str] = None, txn_id: Optional[str] = None,
@ -807,12 +806,6 @@ class EventCreationHandler:
The event IDs to use as the prev events. The event IDs to use as the prev events.
Should normally be left as None to automatically request them Should normally be left as None to automatically request them
from the database. from the database.
auth_event_ids:
The event ids to use as the auth_events for the new event.
Should normally be left as None, which will cause them to be calculated
based on the room state at the prev_events.
If non-None, prev_event_ids must also be provided.
state_event_ids: state_event_ids:
The full state at a given event. This is used particularly by the MSC2716 The full state at a given event. This is used particularly by the MSC2716
/batch_send endpoint. One use case is with insertion events which float at /batch_send endpoint. One use case is with insertion events which float at
@ -878,7 +871,6 @@ class EventCreationHandler:
txn_id=txn_id, txn_id=txn_id,
allow_no_prev_events=allow_no_prev_events, allow_no_prev_events=allow_no_prev_events,
prev_event_ids=prev_event_ids, prev_event_ids=prev_event_ids,
auth_event_ids=auth_event_ids,
state_event_ids=state_event_ids, state_event_ids=state_event_ids,
outlier=outlier, outlier=outlier,
historical=historical, historical=historical,

19
synapse/handlers/room_member.py
View file

@ -271,7 +271,6 @@ class RoomMemberHandler(metaclass=abc.ABCMeta):
membership: str, membership: str,
allow_no_prev_events: bool = False, allow_no_prev_events: bool = False,
prev_event_ids: Optional[List[str]] = None, prev_event_ids: Optional[List[str]] = None,
auth_event_ids: Optional[List[str]] = None,
state_event_ids: Optional[List[str]] = None, state_event_ids: Optional[List[str]] = None,
txn_id: Optional[str] = None, txn_id: Optional[str] = None,
ratelimit: bool = True, ratelimit: bool = True,
@ -295,10 +294,6 @@ class RoomMemberHandler(metaclass=abc.ABCMeta):
events should have a prev_event and we should only use this in special events should have a prev_event and we should only use this in special
cases like MSC2716. cases like MSC2716.
prev_event_ids: The event IDs to use as the prev events prev_event_ids: The event IDs to use as the prev events
auth_event_ids:
The event ids to use as the auth_events for the new event.
Should normally be left as None, which will cause them to be calculated
based on the room state at the prev_events.
state_event_ids: state_event_ids:
The full state at a given event. This is used particularly by the MSC2716 The full state at a given event. This is used particularly by the MSC2716
/batch_send endpoint. One use case is the historical `state_events_at_start`; /batch_send endpoint. One use case is the historical `state_events_at_start`;
@ -361,7 +356,6 @@ class RoomMemberHandler(metaclass=abc.ABCMeta):
txn_id=txn_id, txn_id=txn_id,
allow_no_prev_events=allow_no_prev_events, allow_no_prev_events=allow_no_prev_events,
prev_event_ids=prev_event_ids, prev_event_ids=prev_event_ids,
auth_event_ids=auth_event_ids,
state_event_ids=state_event_ids, state_event_ids=state_event_ids,
require_consent=require_consent, require_consent=require_consent,
outlier=outlier, outlier=outlier,
@ -465,7 +459,6 @@ class RoomMemberHandler(metaclass=abc.ABCMeta):
historical: bool = False, historical: bool = False,
allow_no_prev_events: bool = False, allow_no_prev_events: bool = False,
prev_event_ids: Optional[List[str]] = None, prev_event_ids: Optional[List[str]] = None,
auth_event_ids: Optional[List[str]] = None,
state_event_ids: Optional[List[str]] = None, state_event_ids: Optional[List[str]] = None,
) -> Tuple[str, int]: ) -> Tuple[str, int]:
"""Update a user's membership in a room. """Update a user's membership in a room.
@ -494,10 +487,6 @@ class RoomMemberHandler(metaclass=abc.ABCMeta):
events should have a prev_event and we should only use this in special events should have a prev_event and we should only use this in special
cases like MSC2716. cases like MSC2716.
prev_event_ids: The event IDs to use as the prev events prev_event_ids: The event IDs to use as the prev events
auth_event_ids:
The event ids to use as the auth_events for the new event.
Should normally be left as None, which will cause them to be calculated
based on the room state at the prev_events.
state_event_ids: state_event_ids:
The full state at a given event. This is used particularly by the MSC2716 The full state at a given event. This is used particularly by the MSC2716
/batch_send endpoint. One use case is the historical `state_events_at_start`; /batch_send endpoint. One use case is the historical `state_events_at_start`;
@ -544,7 +533,6 @@ class RoomMemberHandler(metaclass=abc.ABCMeta):
historical=historical, historical=historical,
allow_no_prev_events=allow_no_prev_events, allow_no_prev_events=allow_no_prev_events,
prev_event_ids=prev_event_ids, prev_event_ids=prev_event_ids,
auth_event_ids=auth_event_ids,
state_event_ids=state_event_ids, state_event_ids=state_event_ids,
) )
@ -567,7 +555,6 @@ class RoomMemberHandler(metaclass=abc.ABCMeta):
historical: bool = False, historical: bool = False,
allow_no_prev_events: bool = False, allow_no_prev_events: bool = False,
prev_event_ids: Optional[List[str]] = None, prev_event_ids: Optional[List[str]] = None,
auth_event_ids: Optional[List[str]] = None,
state_event_ids: Optional[List[str]] = None, state_event_ids: Optional[List[str]] = None,
) -> Tuple[str, int]: ) -> Tuple[str, int]:
"""Helper for update_membership. """Helper for update_membership.
@ -598,10 +585,6 @@ class RoomMemberHandler(metaclass=abc.ABCMeta):
events should have a prev_event and we should only use this in special events should have a prev_event and we should only use this in special
cases like MSC2716. cases like MSC2716.
prev_event_ids: The event IDs to use as the prev events prev_event_ids: The event IDs to use as the prev events
auth_event_ids:
The event ids to use as the auth_events for the new event.
Should normally be left as None, which will cause them to be calculated
based on the room state at the prev_events.
state_event_ids: state_event_ids:
The full state at a given event. This is used particularly by the MSC2716 The full state at a given event. This is used particularly by the MSC2716
/batch_send endpoint. One use case is the historical `state_events_at_start`; /batch_send endpoint. One use case is the historical `state_events_at_start`;
@ -736,7 +719,6 @@ class RoomMemberHandler(metaclass=abc.ABCMeta):
ratelimit=ratelimit, ratelimit=ratelimit,
allow_no_prev_events=allow_no_prev_events, allow_no_prev_events=allow_no_prev_events,
prev_event_ids=prev_event_ids, prev_event_ids=prev_event_ids,
auth_event_ids=auth_event_ids,
state_event_ids=state_event_ids, state_event_ids=state_event_ids,
content=content, content=content,
require_consent=require_consent, require_consent=require_consent,
@ -961,7 +943,6 @@ class RoomMemberHandler(metaclass=abc.ABCMeta):
txn_id=txn_id, txn_id=txn_id,
ratelimit=ratelimit, ratelimit=ratelimit,
prev_event_ids=latest_event_ids, prev_event_ids=latest_event_ids,
auth_event_ids=auth_event_ids,
state_event_ids=state_event_ids, state_event_ids=state_event_ids,
content=content, content=content,
require_consent=require_consent, require_consent=require_consent,