Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/16640.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
More efficiently handle no-op `POSITION` over replication.
34 changes: 34 additions & 0 deletions synapse/replication/tcp/handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,21 @@ def on_POSITION(self, conn: IReplicationConnection, cmd: PositionCommand) -> Non

logger.debug("Handling '%s %s'", cmd.NAME, cmd.to_line())

# Check if we can early discard this position. We can only do so for
# connected streams.
stream = self._streams[cmd.stream_name]
if stream.can_discard_position(
cmd.instance_name, cmd.prev_token, cmd.new_token
) and self.is_stream_connected(conn, cmd.stream_name):
logger.debug(
"Discarding redundant POSITION %s/%s %s %s",
cmd.instance_name,
cmd.stream_name,
cmd.prev_token,
cmd.new_token,
)
return

self._add_command_to_stream_queue(conn, cmd)

async def _process_position(
Expand All @@ -599,6 +614,18 @@ async def _process_position(
"""
stream = self._streams[stream_name]

if stream.can_discard_position(
cmd.instance_name, cmd.prev_token, cmd.new_token
) and self.is_stream_connected(conn, cmd.stream_name):
logger.debug(
"Discarding redundant POSITION %s/%s %s %s",
cmd.instance_name,
cmd.stream_name,
cmd.prev_token,
cmd.new_token,
)
return

# We're about to go and catch up with the stream, so remove from set
# of connected streams.
for streams in self._streams_by_connection.values():
Expand Down Expand Up @@ -657,6 +684,13 @@ async def _process_position(

self._streams_by_connection.setdefault(conn, set()).add(stream_name)

def is_stream_connected(
self, conn: IReplicationConnection, stream_name: str
) -> bool:
"""Return if stream has been successfully connected and is ready to
receive updates"""
return stream_name in self._streams_by_connection.get(conn, ())

def on_REMOTE_SERVER_UP(
self, conn: IReplicationConnection, cmd: RemoteServerUpCommand
) -> None:
Expand Down
18 changes: 18 additions & 0 deletions synapse/replication/tcp/streams/_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,16 @@ def minimal_local_current_token(self) -> Token:
"""
raise NotImplementedError()

def can_discard_position(
self, instance_name: str, prev_token: int, new_token: int
) -> bool:
"""Whether or not a position command for this stream can be discarded.

Useful for streams that can never go backwards and where we already know
the stream ID for the instance has advanced.
"""
return False

def discard_updates_and_advance(self) -> None:
"""Called when the stream should advance but the updates would be discarded,
e.g. when there are no currently connected workers.
Expand Down Expand Up @@ -221,6 +231,14 @@ def current_token(self, instance_name: str) -> Token:
def minimal_local_current_token(self) -> Token:
return self._stream_id_gen.get_minimal_local_current_token()

def can_discard_position(
self, instance_name: str, prev_token: int, new_token: int
) -> bool:
# These streams can't go backwards, so we know we can ignore any
# positions where the tokens are from before the current token.

return new_token <= self.current_token(instance_name)


def current_token_without_instance(
current_token: Callable[[], int]
Expand Down