api_types/model/test_model: Add handling for realm_user events.

This commit contains new function called Model._handle_realm_user_events()
which makes changes to the model.initial_data every time user metadata
is changed. Partly fixes #988.

Author: mounilKshah

tests/model/test_model.py

@@ -237,6 +237,7 @@ def test_register_initial_desired_events(self, mocker, initial_data):
             "update_display_settings",
             "user_settings",
             "realm_emoji",
+            "realm_user",
         ]
         fetch_event_types = [
             "realm",

zulipterminal/api_types.py

@@ -167,6 +167,24 @@ class ReactionEvent(TypedDict):
     message_id: int
 
 
+class Person(TypedDict):
+    user_id: int
+    full_name: str
+    timezone: str
+    display_email: str
+    email: str
+    role: int
+    avatar_url: str
+    avatar_version: int
+    profile_data: Dict[str, str]
+
+
+class RealmUserEvent(TypedDict):
+    type: Literal["realm_user"]
+    op: str
+    person: Person
+
+
 class SubscriptionEvent(TypedDict):
     type: Literal["subscription"]
     op: str
@@ -249,4 +267,5 @@ class UpdateGlobalNotificationsEvent(TypedDict):
     UpdateRealmEmojiEvent,
     UpdateUserSettingsEvent,
     UpdateGlobalNotificationsEvent,
+    RealmUserEvent,
 ]

zulipterminal/model.py

@@ -8,6 +8,7 @@
 from concurrent.futures import Future, ThreadPoolExecutor, wait
 from copy import deepcopy
 from datetime import datetime
+from pprint import pprint
 from typing import (
     Any,
     Callable,
@@ -33,6 +34,7 @@
     Composition,
     EditPropagateMode,
     Event,
+    Person,
     PrivateComposition,
     RealmEmojiData,
     RealmUser,
@@ -150,6 +152,7 @@ def __init__(self, controller: Any) -> None:
                 ("update_display_settings", self._handle_update_display_settings_event),
                 ("user_settings", self._handle_user_settings_event),
                 ("realm_emoji", self._handle_update_emoji_event),
+                ("realm_user", self._handle_realm_user_event),
             ]
         )
 
@@ -1747,6 +1750,41 @@ def _handle_update_display_settings_event(self, event: Event) -> None:
                 view.message_view.log[msg_pos] = msg_w_list[0]
         self.controller.update_screen()
 
+    def update_realm_user(self, updated_details: Person) -> None:
+        """
+        This function is to update details of other realm_users
+        when a realm_user event takes place
+        """
+        for realm_user in self.initial_data["realm_users"]:
+            if realm_user["user_id"] == updated_details["user_id"]:
+                index_of_realm_user = self.initial_data["realm_users"].index(realm_user)
+                temp_realm_index = index_of_realm_user
+                self.initial_data["realm_users"][index_of_realm_user].update(
+                    updated_details
+                )
+                break
+
+    def _handle_realm_user_event(self, event: Event) -> None:
+        """
+        Handle change to user(s) metadata (Eg: full_name, timezone, etc.)
+        """
+        assert event["type"] == "realm_user"
+        if event["op"] == "update":
+            pprint(event)
+            if "person" in event:
+                updated_details = event["person"]
+                # Role is not present under self.initial_data,
+                # but exists only under self.initial_data["realm_users"]
+                if event["person"].get("role"):
+                    self.update_realm_user(updated_details)
+                else:
+                    # check if the event contains details of current user or some other user in the org
+                    if updated_details["user_id"] == self.user_id:
+                        self.initial_data.update(updated_details)
+                        self.update_realm_user(updated_details)
+                    else:
+                        self.update_realm_user(updated_details)
+
     def _register_desired_events(self, *, fetch_data: bool = False) -> str:
         fetch_types = None if not fetch_data else self.initial_data_to_fetch
         event_types = list(self.event_actions)