OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Use SyncExtras

erikj/paginate_sync
Erik Johnston 2016-06-23 17:26:27 +01:00
parent 6c8c061c2f
commit a7e6ad9f3e
2 changed files with 21 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
synapse/handlers/sync.py
View File

@ -72,10 +72,12 @@ SYNC_PAGINATION_VALID_ORDERS = (SYNC_PAGINATION_ORDER_TS,)
SyncExtras = collections.namedtuple("SyncExtras", [ SyncExtras = collections.namedtuple("SyncExtras", [
"paginate", "paginate", # dict with "limit" key
"rooms", "peek", # dict of room_id -> dict
]) ])
DEFAULT_SYNC_EXTRAS = SyncExtras(paginate={}, peek={})
class TimelineBatch(collections.namedtuple("TimelineBatch", [ class TimelineBatch(collections.namedtuple("TimelineBatch", [
"prev_batch", "prev_batch",
@ -195,7 +197,7 @@ class SyncHandler(object):
self.response_cache = ResponseCache() self.response_cache = ResponseCache()
def wait_for_sync_for_user(self, sync_config, batch_token=None, timeout=0, def wait_for_sync_for_user(self, sync_config, batch_token=None, timeout=0,
full_state=False, extras=None): full_state=False, extras=DEFAULT_SYNC_EXTRAS):
"""Get the sync for a client if we have new data for it now. Otherwise """Get the sync for a client if we have new data for it now. Otherwise
wait for new data to arrive on the server. If the timeout expires, then wait for new data to arrive on the server. If the timeout expires, then
return an empty sync result. return an empty sync result.
@ -214,7 +216,7 @@ class SyncHandler(object):
@defer.inlineCallbacks @defer.inlineCallbacks
def _wait_for_sync_for_user(self, sync_config, batch_token, timeout, def _wait_for_sync_for_user(self, sync_config, batch_token, timeout,
full_state, extras=None): full_state, extras=DEFAULT_SYNC_EXTRAS):
context = LoggingContext.current_context() context = LoggingContext.current_context()
if context: if context:
if batch_token is None: if batch_token is None:
@ -539,13 +541,14 @@ class SyncHandler(object):
@defer.inlineCallbacks @defer.inlineCallbacks
def generate_sync_result(self, sync_config, batch_token=None, full_state=False, def generate_sync_result(self, sync_config, batch_token=None, full_state=False,
extras=None): extras=DEFAULT_SYNC_EXTRAS):
"""Generates a sync result. """Generates a sync result.
Args: Args:
sync_config (SyncConfig) sync_config (SyncConfig)
since_token (StreamToken) since_token (StreamToken)
full_state (bool) full_state (bool)
extras (SyncExtras)
Returns: Returns:
Deferred(SyncResult) Deferred(SyncResult)
@ -790,7 +793,7 @@ class SyncHandler(object):
Args: Args:
sync_result_builder (SyncResultBuilder) sync_result_builder (SyncResultBuilder)
room_entries (list(RoomSyncResultBuilder)) room_entries (list(RoomSyncResultBuilder))
extras (dict) extras (SyncExtras)
""" """
user_id = sync_result_builder.sync_config.user.to_string() user_id = sync_result_builder.sync_config.user.to_string()
sync_config = sync_result_builder.sync_config sync_config = sync_result_builder.sync_config
@ -812,8 +815,6 @@ class SyncHandler(object):
old_pagination_value = 0 old_pagination_value = 0
include_all_tags = False include_all_tags = False
include_map = extras.get("peek", {}) if extras else {}
if sync_result_builder.pagination_state: if sync_result_builder.pagination_state:
missing_state = yield self._get_rooms_that_need_full_state( missing_state = yield self._get_rooms_that_need_full_state(
room_ids=[r.room_id for r in room_entries], room_ids=[r.room_id for r in room_entries],
@ -848,8 +849,8 @@ class SyncHandler(object):
r.always_include = True r.always_include = True
continue continue
if r.room_id in include_map: if r.room_id in extras.peek:
since = include_map[r.room_id].get("since", None) since = extras.peek[r.room_id].get("since", None)
if since: if since:
tok = SyncNextBatchToken.from_string(since) tok = SyncNextBatchToken.from_string(since)
r.since_token = tok.stream_token r.since_token = tok.stream_token
@ -867,7 +868,7 @@ class SyncHandler(object):
if r.room_id in all_tags: if r.room_id in all_tags:
r.always_include = True r.always_include = True
for room_id in set(include_map.keys()) - {r.room_id for r in room_entries}: for room_id in set(extras.peek.keys()) - {r.room_id for r in room_entries}:
sync_result_builder.errors.append(ErrorSyncResult( sync_result_builder.errors.append(ErrorSyncResult(
room_id=room_id, room_id=room_id,
errcode=Codes.CANNOT_PEEK, errcode=Codes.CANNOT_PEEK,
@ -878,7 +879,7 @@ class SyncHandler(object):
room_ids = [r.room_id for r in room_entries] room_ids = [r.room_id for r in room_entries]
pagination_limit = pagination_config.limit pagination_limit = pagination_config.limit
extra_limit = extras.get("paginate", {}).get("limit", 0) if extras else 0 extra_limit = extras.paginate.get("limit", 0)
room_map = yield self._get_room_timestamps_at_token( room_map = yield self._get_room_timestamps_at_token(
room_ids, sync_result_builder.now_token, sync_config, room_ids, sync_result_builder.now_token, sync_config,

11
synapse/rest/client/v2_alpha/sync.py
View File

@ -20,7 +20,8 @@ from synapse.http.servlet import (
parse_json_object_from_request, parse_json_object_from_request,
) )
from synapse.handlers.sync import ( from synapse.handlers.sync import (
SyncConfig, SyncPaginationConfig, SYNC_PAGINATION_TAGS_IGNORE, SyncConfig, SyncPaginationConfig, SYNC_PAGINATION_TAGS_IGNORE, SyncExtras,
DEFAULT_SYNC_EXTRAS,
) )
from synapse.types import SyncNextBatchToken from synapse.types import SyncNextBatchToken
from synapse.events.utils import ( from synapse.events.utils import (
@ -100,7 +101,11 @@ class SyncRestServlet(RestServlet):
since = body.get("since", None) since = body.get("since", None)
extras = body.get("extras", None) extras = body.get("extras", {})
extras = SyncExtras(
paginate=extras.get("paginate", {}),
peek=extras.get("peek", {}),
)
if "from" in body: if "from" in body:
# /events used to use 'from', but /sync uses 'since'. # /events used to use 'from', but /sync uses 'since'.
@ -245,7 +250,7 @@ class SyncRestServlet(RestServlet):
@defer.inlineCallbacks @defer.inlineCallbacks
def _handle_sync(self, requester, sync_config, batch_token, set_presence, def _handle_sync(self, requester, sync_config, batch_token, set_presence,
full_state, timeout, extras=None): full_state, timeout, extras=DEFAULT_SYNC_EXTRAS):
affect_presence = set_presence != PresenceState.OFFLINE affect_presence = set_presence != PresenceState.OFFLINE
user = sync_config.user user = sync_config.user