From 3dbce6f4a59fde2a67e563ce338f510feda2dd1a Mon Sep 17 00:00:00 2001
From: Mark Haines <mark.haines@matrix.org>
Date: Thu, 29 Jan 2015 03:33:51 +0000
Subject: [PATCH] Add typing notifications to sync

---
 synapse/handlers/sync.py             | 32 +++++++++++++++++++---------
 synapse/rest/client/v2_alpha/sync.py | 18 +++++++---------
 2 files changed, 30 insertions(+), 20 deletions(-)

diff --git a/synapse/handlers/sync.py b/synapse/handlers/sync.py
index 82a2c6986a..b86e783e14 100644
--- a/synapse/handlers/sync.py
+++ b/synapse/handlers/sync.py
@@ -44,11 +44,12 @@ class RoomSyncResult(collections.namedtuple("RoomSyncResult", [
     "events",
     "state",
     "prev_batch",
+    "typing",
 ])):
     __slots__ = []
 
     def __nonzero__(self):
-        return bool(self.events or self.state)
+        return bool(self.events or self.state or self.typing)
 
 
 class SyncResult(collections.namedtuple("SyncResult", [
@@ -196,15 +197,25 @@ class SyncHandler(BaseHandler):
 
         now_token = yield self.event_sources.get_current_token()
 
-        presence_stream = self.event_sources.sources["presence"]
-        pagination_config = PaginationConfig(
-            from_token=since_token, to_token=now_token
-        )
-        presence, _ = yield presence_stream.get_pagination_rows(
+        presence_source = self.event_sources.sources["presence"]
+        presence, presence_key = yield presence_source.get_new_events_for_user(
             user=sync_config.user,
-            pagination_config=pagination_config.get_source_config("presence"),
-            key=None
+            from_key=since_token.presence_key,
+            limit=sync_config.limit,
         )
+        now_token = now_token.copy_and_replace("presence_key", presence_key)
+
+        typing_source = self.event_sources.sources["typing"]
+        typing, typing_key = yield typing_source.get_new_events_for_user(
+            user=sync_config.user,
+            from_key=since_token.typing_key,
+            limit=sync_config.limit,
+        )
+        now_token = now_token.copy_and_replace("typing_key", typing_key)
+
+        typing_by_room = {event["room_id"]: event for event in typing}
+        logger.debug("Typing %r", typing_by_room)
+
         room_list = yield self.store.get_rooms_for_user_where_membership_is(
             user_id=sync_config.user.to_string(),
             membership_list=[Membership.INVITE, Membership.JOIN]
@@ -218,7 +229,7 @@ class SyncHandler(BaseHandler):
         for event in room_list:
             room_sync = yield self.incremental_sync_with_gap_for_room(
                 event.room_id, sync_config, since_token, now_token,
-                published_room_ids
+                published_room_ids, typing_by_room
             )
             if room_sync:
                 rooms.append(room_sync)
@@ -233,7 +244,7 @@ class SyncHandler(BaseHandler):
     @defer.inlineCallbacks
     def incremental_sync_with_gap_for_room(self, room_id, sync_config,
                                            since_token, now_token,
-                                           published_room_ids):
+                                           published_room_ids, typing_by_room):
         """ Get the incremental delta needed to bring the client up to date for
         the room. Gives the client the most recent events and the changes to
         state.
@@ -285,6 +296,7 @@ class SyncHandler(BaseHandler):
             prev_batch=prev_batch_token,
             state=state_events_delta,
             limited=limited,
+            typing=typing_by_room.get(room_id, None)
         )
 
         logging.debug("Room sync: %r", room_sync)
diff --git a/synapse/rest/client/v2_alpha/sync.py b/synapse/rest/client/v2_alpha/sync.py
index 4d950f9956..76489e27c8 100644
--- a/synapse/rest/client/v2_alpha/sync.py
+++ b/synapse/rest/client/v2_alpha/sync.py
@@ -135,10 +135,10 @@ class SyncRestServlet(RestServlet):
         time_now = self.clock.time_msec()
 
         response_content = {
-            "public_user_data": self.encode_events(
+            "public_user_data": self.encode_user_data(
                 sync_result.public_user_data, filter, time_now
             ),
-            "private_user_data": self.encode_events(
+            "private_user_data": self.encode_user_data(
                 sync_result.private_user_data, filter, time_now
             ),
             "rooms": self.encode_rooms(
@@ -149,13 +149,8 @@ class SyncRestServlet(RestServlet):
 
         defer.returnValue((200, response_content))
 
-    def encode_events(self, events, filter, time_now):
-        return [self.encode_event(event, filter, time_now) for event in events]
-
-    @staticmethod
-    def encode_event(event, filter, time_now):
-        # TODO(mjark): Respect formatting requirements in the filter.
-        return serialize_event(event, time_now)
+    def encode_user_data(self, events, filter, time_now):
+        return events
 
     def encode_rooms(self, rooms, filter, time_now, token_id):
         return [
@@ -183,7 +178,7 @@ class SyncRestServlet(RestServlet):
                 event_format=format_event_for_client_v2_without_event_id,
             )
             recent_event_ids.append(event.event_id)
-        return {
+        result = {
             "room_id": room.room_id,
             "event_map": event_map,
             "events": {
@@ -194,6 +189,9 @@ class SyncRestServlet(RestServlet):
             "limited": room.limited,
             "published": room.published,
         }
+        if room.typing is not None:
+            result["typing"] = room.typing
+        return result
 
 
 def register_servlets(hs, http_server):