Add beeper_inbox_state endpoint for Inbox 3.1 (#19)

Author: bradtgmurray

synapse/rest/client/account_data.py

@@ -155,6 +155,56 @@ async def on_GET(
         return 200, event
 
 
+class RoomBeeperInboxStateServlet(RestServlet):
+    """
+    PUT /user/{user_id}/rooms/{room_id}/beeper_inbox_state HTTP/1.1
+    """
+
+    PATTERNS = client_patterns(
+        "/user/(?P<user_id>[^/]*)/rooms/(?P<room_id>[^/]*)/beeper_inbox_state"
+    )
+
+    def __init__(self, hs: "HomeServer"):
+        super().__init__()
+        self.auth = hs.get_auth()
+        self.clock = hs.get_clock()
+        self.store = hs.get_datastores().main
+        self.handler = hs.get_account_data_handler()
+
+    async def on_PUT(
+        self, request: SynapseRequest, user_id: str, room_id: str
+    ) -> Tuple[int, JsonDict]:
+        requester = await self.auth.get_user_by_req(request)
+        if user_id != requester.user.to_string():
+            raise AuthError(403, "Cannot add beeper inbox state for other users.")
+
+        if not RoomID.is_valid(room_id):
+            raise SynapseError(
+                400,
+                f"{room_id} is not a valid room ID",
+                Codes.INVALID_PARAM,
+            )
+
+        ts = self.clock.time_msec()
+
+        body = parse_json_object_from_request(request)
+
+        if body.get("marked_unread"):
+            marked_unread = {"unread": body["marked_unread"], "ts": ts}
+            await self.handler.add_account_data_to_room(
+                user_id, room_id, "m.marked_unread", marked_unread
+            )
+
+        if body.get("done"):
+            done = {"updated_ts": ts, "at_ts": ts + body["done"].get("at_delta", 0)}
+            await self.handler.add_account_data_to_room(
+                user_id, room_id, "com.beeper.inbox.done", done
+            )
+
+        return 200, {}
+
+
 def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
     AccountDataServlet(hs).register(http_server)
     RoomAccountDataServlet(hs).register(http_server)
+    RoomBeeperInboxStateServlet(hs).register(http_server)

tests/rest/client/test_account_data.py

@@ -73,3 +73,62 @@ def test_on_account_data_updated_callback(self) -> None:
         mocked_callback.assert_called_with(
             user_id, room_id, account_data_type, account_data_content
         )
+
+    def test_beeper_inbox_state_endpoint(self) -> None:
+        store = self.hs.get_datastores().main
+
+        user_id = self.register_user("user", "password")
+        tok = self.login("user", "password")
+
+        room_id = self.helper.create_room_as(user_id, tok=tok)
+        channel = self.make_request(
+            "PUT",
+            f"/user/{user_id}/rooms/{room_id}/beeper_inbox_state",
+            {},
+            access_token=tok,
+        )
+
+        self.assertEqual(channel.code, 200, channel.result)
+        self.assertIsNone(
+            self.get_success(
+                store.get_account_data_for_room_and_type(
+                    user_id, room_id, "com.beeper.inbox.done"
+                )
+            )
+        )
+        self.assertIsNone(
+            self.get_success(
+                store.get_account_data_for_room_and_type(
+                    user_id, room_id, "m.marked_unread"
+                )
+            )
+        )
+
+        channel = self.make_request(
+            "PUT",
+            f"/user/{user_id}/rooms/{room_id}/beeper_inbox_state",
+            {"done": {"at_delta": 1000 * 60 * 5}, "marked_unread": True},
+            access_token=tok,
+        )
+
+        self.assertEqual(channel.code, 200, channel.result)
+
+        # FIXME: I give up, I don't know how to mock time in tests
+        # ts = self.clock.time_msec()
+        ts = 500
+
+        done = self.get_success(
+            store.get_account_data_for_room_and_type(
+                user_id, room_id, "com.beeper.inbox.done"
+            )
+        )
+        self.assertEqual(done["updated_ts"], ts)
+        self.assertEqual(done["at_ts"], ts + (1000 * 60 * 5))
+
+        marked_unread = self.get_success(
+            store.get_account_data_for_room_and_type(
+                user_id, room_id, "m.marked_unread"
+            )
+        )
+        self.assertEqual(marked_unread["unread"], True)
+        self.assertEqual(marked_unread["ts"], ts)