Add subscribed and automatic to get_updated_thread_subscriptions_for_user

Author: reivilibre

synapse/storage/databases/main/thread_subscriptions.py

@@ -352,7 +352,7 @@ def get_updated_thread_subscriptions_txn(
 
     async def get_updated_thread_subscriptions_for_user(
         self, user_id: str, from_id: int, to_id: int, limit: int
-    ) -> List[Tuple[int, str, str]]:
+    ) -> List[Tuple[int, str, str, bool, Optional[bool]]]:
         """Get updates to thread subscriptions for a specific user.
 
         Args:
@@ -362,22 +362,32 @@ async def get_updated_thread_subscriptions_for_user(
             limit: The maximum number of rows to return
 
         Returns:
-            A list of (stream_id, room_id, thread_root_event_id) tuples.
+            A list of (stream_id, room_id, thread_root_event_id, subscribed, automatic) tuples.
         """
 
         def get_updated_thread_subscriptions_for_user_txn(
             txn: LoggingTransaction,
-        ) -> List[Tuple[int, str, str]]:
+        ) -> List[Tuple[int, str, str, bool, Optional[bool]]]:
             sql = """
-                SELECT stream_id, room_id, event_id
+                SELECT stream_id, room_id, event_id, subscribed, automatic
                 FROM thread_subscriptions
                 WHERE user_id = ? AND ? < stream_id AND stream_id <= ?
                 ORDER BY stream_id ASC
                 LIMIT ?
             """
 
             txn.execute(sql, (user_id, from_id, to_id, limit))
-            return [(row[0], row[1], row[2]) for row in txn]
+            return [
+                (
+                    stream_id,
+                    room_id,
+                    event_id,
+                    # SQLite integer to boolean conversions
+                    bool(subscribed),
+                    bool(automatic) if subscribed else None,
+                )
+                for (stream_id, room_id, event_id, subscribed, automatic) in txn
+            ]
 
         return await self.db_pool.runInteraction(
             "get_updated_thread_subscriptions_for_user",

tests/storage/test_thread_subscriptions.py

@@ -189,12 +189,12 @@ def test_purge_thread_subscriptions_for_user(self) -> None:
                 limit=50,
             )
         )
-        min_id = min(id for (id, _, _) in subscriptions)
+        min_id = min(id for (id, _, _, _, _) in subscriptions)
         self.assertEqual(
             subscriptions,
             [
-                (min_id, self.room_id, self.thread_root_id),
-                (min_id + 1, self.room_id, self.other_thread_root_id),
+                (min_id, self.room_id, self.thread_root_id, True, True),
+                (min_id + 1, self.room_id, self.other_thread_root_id, True, False),
             ],
         )
 
@@ -259,7 +259,9 @@ def test_get_updated_thread_subscriptions_for_user(self) -> None:
                 self.user_id, 0, stream_id2, 10
             )
         )
-        self.assertEqual(updates, [(stream_id1, self.room_id, self.thread_root_id)])
+        self.assertEqual(
+            updates, [(stream_id1, self.room_id, self.thread_root_id, True, True)]
+        )
 
         # Get updates for other user
         updates = self.get_success(
@@ -268,5 +270,5 @@ def test_get_updated_thread_subscriptions_for_user(self) -> None:
             )
         )
         self.assertEqual(
-            updates, [(stream_id2, self.room_id, self.other_thread_root_id)]
+            updates, [(stream_id2, self.room_id, self.other_thread_root_id, True, True)]
         )