model: Add get_user_id_from_reaction for messages and reaction events.

In preparation for deprecation of `user` field from reactions.

Tests added.

Author: Niloth-p

tests/model/test_model.py

@@ -790,6 +790,75 @@ def test_has_user_reacted_to_message(
 
         assert has_reacted == expected_has_user_reacted
 
+    @pytest.mark.parametrize(
+        "user_data, expected_user_id",
+        [
+            case({"user_id": 456}, 456, id="reaction_event_user_id"),
+            case(
+                {"user": {"user_id": 123}},
+                123,
+                id="reaction_event_user",
+            ),
+            case(
+                {"user_id": 101},
+                101,
+                id="reaction_user_id",
+            ),
+            case(
+                {"user": {"id": 202}},
+                202,
+                id="reaction_user",
+            ),
+        ],
+    )
+    def test_get_user_id_from_reaction_success(
+        self,
+        model: Model,
+        user_data: Dict[str, Any],
+        expected_user_id: int,
+    ):
+        reaction = {
+            "type": "reaction",
+            "op": "add",
+            "reaction_type": "unicode_emoji",
+            "emoji_code": "1f44d",
+            "emoji_name": "thumbs_up",
+            "message_id": "24757",
+            **user_data,
+        }
+        assert model.get_user_id_from_reaction(reaction) == expected_user_id
+
+    @pytest.mark.parametrize(
+        "user_data",
+        [
+            case({}, id="reaction_event_missing_user_id_user"),
+            case(
+                {"user": {"id": "not_an_int"}},
+                id="invalid_user",
+            ),
+            case(
+                {"user_id": "not_an_int"},
+                id="invalid_user_id",
+            ),
+        ],
+    )
+    def test_get_user_id_from_reaction_failure(
+        self,
+        model: Model,
+        user_data: Dict[str, Any],
+    ):
+        reaction = {
+            "type": "reaction",
+            "op": "add",
+            "reaction_type": "unicode_emoji",
+            "emoji_code": "1f44d",
+            "emoji_name": "thumbs_up",
+            "message_id": "24757",
+            **user_data,
+        }
+        with pytest.raises((AssertionError, AttributeError)):
+            model.get_user_id_from_reaction(reaction)
+
     @pytest.mark.parametrize("recipient_user_ids", [[5140], [5140, 5179]])
     @pytest.mark.parametrize("status", ["start", "stop"])
     def test_send_typing_status_by_user_ids(

zulipterminal/model.py

@@ -48,6 +48,7 @@
     MessagesFlagChange,
     PrivateComposition,
     PrivateMessageUpdateRequest,
+    ReactionEvent,
     RealmEmojiData,
     RealmUser,
     StreamComposition,
@@ -479,18 +480,22 @@ def has_user_reacted_to_message(self, message: Message, *, emoji_code: str) -> b
         for reaction in message["reactions"]:
             if reaction["emoji_code"] != emoji_code:
                 continue
-            # The reaction.user_id field was added in Zulip v3.0, ZFL 2 so we need to
-            # check both the reaction.user.{user_id/id} fields too for pre v3 support.
-            user = reaction.get("user", {})
-            has_user_reacted = (
-                user.get("user_id", None) == self.user_id
-                or user.get("id", None) == self.user_id
-                or reaction.get("user_id", None) == self.user_id
-            )
-            if has_user_reacted:
+            user_id = self.get_user_id_from_reaction(reaction)
+            if user_id == self.user_id:
                 return True
         return False
 
+    def get_user_id_from_reaction(
+        self, reaction: Union[Dict[str, Any], ReactionEvent]
+    ) -> int:
+        # The reaction.user_id field was added in Zulip v3.0, ZFL 2 so we need to
+        # check both the reaction.user.{user_id/id} fields too for pre v3 support.
+        user = reaction.get("user", {})
+        assert isinstance(user, dict)
+        user_id = user.get("id") or user.get("user_id") or reaction.get("user_id")
+        assert isinstance(user_id, int)
+        return user_id
+
     def session_draft_message(self) -> Optional[Composition]:
         return deepcopy(self._draft)
 
@@ -1859,16 +1864,8 @@ def _handle_reaction_event(self, event: Event) -> None:
                 message["reactions"].append(reactions_entry)
             else:
                 for reaction in message["reactions"]:
-                    reaction_user_id = (
-                        reaction["user"]["id"]
-                        if "user" in reaction
-                        else reaction["user_id"]
-                    )
-                    event_user_id = (
-                        event["user"]["user_id"]
-                        if event.get("user") and isinstance(event["user"], dict)
-                        else event["user_id"]
-                    )
+                    reaction_user_id = self.get_user_id_from_reaction(reaction)
+                    event_user_id = self.get_user_id_from_reaction(event)
                     if (
                         reaction["emoji_code"] == event["emoji_code"]
                         and reaction_user_id == event_user_id