clarify comments

This commit is contained in:
Erik Johnston 2019-03-05 09:16:35 +00:00
parent 0d2d046709
commit aa06d26ae0
3 changed files with 13 additions and 10 deletions

View File

@ -1 +1 @@
Fix attempting to paginate in rooms where server cannot see any events. Fix attempting to paginate in rooms where server cannot see any events, to avoid unnecessarily pulling in lots of redacted events.

View File

@ -862,9 +862,9 @@ class FederationHandler(BaseHandler):
# as otherwise we'll just spend a lot of resources to get redacted # as otherwise we'll just spend a lot of resources to get redacted
# events. # events.
# #
# We do this by filtering all the extremities and seeing if any remain. # We do this by filtering all the backwards extremities and seeing if
# Given we don't have the extremity events themselves, we need to # any remain. Given we don't have the extremity events themselves, we
# actually check the events that reference them. # need to actually check the events that reference them.
# #
# *Note*: the spec wants us to keep backfilling until we reach the start # *Note*: the spec wants us to keep backfilling until we reach the start
# of the room in case we are allowed to see some of the history. However # of the room in case we are allowed to see some of the history. However
@ -873,13 +873,16 @@ class FederationHandler(BaseHandler):
# there is its often sufficiently long ago that clients would stop # there is its often sufficiently long ago that clients would stop
# attempting to paginate before backfill reached the visible history. # attempting to paginate before backfill reached the visible history.
# #
# TODO: If we do do a backfill the we should filter the extremities to # TODO: If we do do a backfill then we should filter the backwards
# only include those that point to visible portions of history. # extremities to only include those that point to visible portions of
# history.
# #
# TODO: Correctly handle the case where we are allowed to see the # TODO: Correctly handle the case where we are allowed to see the
# forward event but not the extremity, e.g. in the case of initial # forward event but not the backward extremity, e.g. in the case of
# join of the server where we are allowed to see the join event but # initial join of the server where we are allowed to see the join
# not anything before it. # event but not anything before it. This would require looking at the
# state *before* the event, ignoring the special casing certain event
# types have.
forward_events = yield self.store.get_successor_events( forward_events = yield self.store.get_successor_events(
list(extremities), list(extremities),

View File

@ -277,7 +277,7 @@ def filter_events_for_server(store, server_name, events, redact=True,
return True return True
# Next lets check to see if all the events have a history visibility # Lets check to see if all the events have a history visibility
# of "shared" or "world_readable". If thats the case then we don't # of "shared" or "world_readable". If thats the case then we don't
# need to check membership (as we know the server is in the room). # need to check membership (as we know the server is in the room).
event_to_state_ids = yield store.get_state_ids_for_events( event_to_state_ids = yield store.get_state_ids_for_events(