message_send: Convert RecipientInfoResult from TypedDict to dataclass.

Signed-off-by: Anders Kaseorg <anders@zulip.com>

zerver/actions/message_edit.py

@@ -446,19 +446,17 @@ def do_update_message(
             possible_wildcard_mention=mention_data.message_has_wildcards(),
         )
 
-        event["online_push_user_ids"] = list(info["online_push_user_ids"])
-        event["pm_mention_push_disabled_user_ids"] = list(info["pm_mention_push_disabled_user_ids"])
-        event["pm_mention_email_disabled_user_ids"] = list(
-            info["pm_mention_email_disabled_user_ids"]
-        )
-        event["stream_push_user_ids"] = list(info["stream_push_user_ids"])
-        event["stream_email_user_ids"] = list(info["stream_email_user_ids"])
-        event["muted_sender_user_ids"] = list(info["muted_sender_user_ids"])
+        event["online_push_user_ids"] = list(info.online_push_user_ids)
+        event["pm_mention_push_disabled_user_ids"] = list(info.pm_mention_push_disabled_user_ids)
+        event["pm_mention_email_disabled_user_ids"] = list(info.pm_mention_email_disabled_user_ids)
+        event["stream_push_user_ids"] = list(info.stream_push_user_ids)
+        event["stream_email_user_ids"] = list(info.stream_email_user_ids)
+        event["muted_sender_user_ids"] = list(info.muted_sender_user_ids)
         event["prior_mention_user_ids"] = list(prior_mention_user_ids)
-        event["presence_idle_user_ids"] = filter_presence_idle_user_ids(info["active_user_ids"])
-        event["all_bot_user_ids"] = list(info["all_bot_user_ids"])
+        event["presence_idle_user_ids"] = filter_presence_idle_user_ids(info.active_user_ids)
+        event["all_bot_user_ids"] = list(info.all_bot_user_ids)
         if rendering_result.mentions_wildcard:
-            event["wildcard_mention_user_ids"] = list(info["wildcard_mention_user_ids"])
+            event["wildcard_mention_user_ids"] = list(info.wildcard_mention_user_ids)
         else:
             event["wildcard_mention_user_ids"] = []
 
@@ -466,7 +464,7 @@ def do_update_message(
             target_message,
             prior_mention_user_ids,
             rendering_result.mentions_user_ids,
-            info["stream_push_user_ids"],
+            info.stream_push_user_ids,
         )
 
     if topic_name is not None or new_stream is not None:

zerver/actions/message_send.py

@@ -1,6 +1,7 @@
 import datetime
 import logging
 from collections import defaultdict
+from dataclasses import dataclass
 from email.headerregistry import Address
 from typing import (
     AbstractSet,
@@ -153,7 +154,8 @@ def render_incoming_message(
     return rendering_result
 
 
-class RecipientInfoResult(TypedDict):
+@dataclass
+class RecipientInfoResult:
     active_user_ids: Set[int]
     online_push_user_ids: Set[int]
     pm_mention_email_disabled_user_ids: Set[int]
@@ -382,7 +384,7 @@ def get_recipient_info(
     # where we determine notifiability of the message for users.
     all_bot_user_ids = {row["id"] for row in rows if row["is_bot"]}
 
-    info: RecipientInfoResult = dict(
+    return RecipientInfoResult(
         active_user_ids=active_user_ids,
         online_push_user_ids=online_push_user_ids,
         pm_mention_email_disabled_user_ids=pm_mention_email_disabled_user_ids,
@@ -397,7 +399,6 @@ def get_recipient_info(
         service_bot_tuples=service_bot_tuples,
         all_bot_user_ids=all_bot_user_ids,
     )
-    return info
 
 
 def get_service_bot_events(
@@ -570,7 +571,7 @@ def build_message_send_dict(
     # mention in it (and not e.g. wildcard mention syntax inside a
     # code block).
     if rendering_result.mentions_wildcard:
-        wildcard_mention_user_ids = info["wildcard_mention_user_ids"]
+        wildcard_mention_user_ids = info.wildcard_mention_user_ids
     else:
         wildcard_mention_user_ids = set()
 
@@ -581,9 +582,9 @@ def build_message_send_dict(
     get UserMessage rows.
     """
     mentioned_user_ids = rendering_result.mentions_user_ids
-    default_bot_user_ids = info["default_bot_user_ids"]
+    default_bot_user_ids = info.default_bot_user_ids
     mentioned_bot_user_ids = default_bot_user_ids & mentioned_user_ids
-    info["um_eligible_user_ids"] |= mentioned_bot_user_ids
+    info.um_eligible_user_ids |= mentioned_bot_user_ids
 
     message_send_dict = SendMessageRequest(
         stream=stream,
@@ -594,18 +595,18 @@ def build_message_send_dict(
         mentioned_user_groups_map=mentioned_user_groups_map,
         message=message,
         rendering_result=rendering_result,
-        active_user_ids=info["active_user_ids"],
-        online_push_user_ids=info["online_push_user_ids"],
-        pm_mention_email_disabled_user_ids=info["pm_mention_email_disabled_user_ids"],
-        pm_mention_push_disabled_user_ids=info["pm_mention_push_disabled_user_ids"],
-        stream_push_user_ids=info["stream_push_user_ids"],
-        stream_email_user_ids=info["stream_email_user_ids"],
-        muted_sender_user_ids=info["muted_sender_user_ids"],
-        um_eligible_user_ids=info["um_eligible_user_ids"],
-        long_term_idle_user_ids=info["long_term_idle_user_ids"],
-        default_bot_user_ids=info["default_bot_user_ids"],
-        service_bot_tuples=info["service_bot_tuples"],
-        all_bot_user_ids=info["all_bot_user_ids"],
+        active_user_ids=info.active_user_ids,
+        online_push_user_ids=info.online_push_user_ids,
+        pm_mention_email_disabled_user_ids=info.pm_mention_email_disabled_user_ids,
+        pm_mention_push_disabled_user_ids=info.pm_mention_push_disabled_user_ids,
+        stream_push_user_ids=info.stream_push_user_ids,
+        stream_email_user_ids=info.stream_email_user_ids,
+        muted_sender_user_ids=info.muted_sender_user_ids,
+        um_eligible_user_ids=info.um_eligible_user_ids,
+        long_term_idle_user_ids=info.long_term_idle_user_ids,
+        default_bot_user_ids=info.default_bot_user_ids,
+        service_bot_tuples=info.service_bot_tuples,
+        all_bot_user_ids=info.all_bot_user_ids,
         wildcard_mention_user_ids=wildcard_mention_user_ids,
         links_for_embed=links_for_embed,
         widget_content=widget_content_dict,

zerver/tests/test_users.py

@@ -14,7 +14,7 @@ from django.utils.timezone import now as timezone_now
 from confirmation.models import Confirmation
 from zerver.actions.create_user import do_create_user, do_reactivate_user
 from zerver.actions.invites import do_create_multiuse_invite_link, do_invite_users
-from zerver.actions.message_send import get_recipient_info
+from zerver.actions.message_send import RecipientInfoResult, get_recipient_info
 from zerver.actions.muted_users import do_mute_user
 from zerver.actions.realm_settings import do_set_realm_property
 from zerver.actions.user_settings import bulk_regenerate_api_keys
@@ -1769,7 +1769,7 @@ class RecipientInfoTest(ZulipTestCase):
 
         all_user_ids = {hamlet.id, cordelia.id, othello.id}
 
-        expected_info = dict(
+        expected_info = RecipientInfoResult(
             active_user_ids=all_user_ids,
             online_push_user_ids=set(),
             pm_mention_email_disabled_user_ids=set(),
@@ -1797,8 +1797,8 @@ class RecipientInfoTest(ZulipTestCase):
             stream_topic=stream_topic,
             possible_wildcard_mention=False,
         )
-        self.assertEqual(info["pm_mention_email_disabled_user_ids"], {hamlet.id})
-        self.assertEqual(info["pm_mention_push_disabled_user_ids"], {hamlet.id})
+        self.assertEqual(info.pm_mention_email_disabled_user_ids, {hamlet.id})
+        self.assertEqual(info.pm_mention_push_disabled_user_ids, {hamlet.id})
         hamlet.enable_offline_email_notifications = True
         hamlet.enable_offline_push_notifications = True
         hamlet.save()
@@ -1814,8 +1814,8 @@ class RecipientInfoTest(ZulipTestCase):
             stream_topic=stream_topic,
             possible_wildcard_mention=False,
         )
-        self.assertEqual(info["stream_push_user_ids"], {hamlet.id})
-        self.assertEqual(info["wildcard_mention_user_ids"], set())
+        self.assertEqual(info.stream_push_user_ids, {hamlet.id})
+        self.assertEqual(info.wildcard_mention_user_ids, set())
 
         info = get_recipient_info(
             realm_id=realm.id,
@@ -1824,7 +1824,7 @@ class RecipientInfoTest(ZulipTestCase):
             stream_topic=stream_topic,
             possible_wildcard_mention=True,
         )
-        self.assertEqual(info["wildcard_mention_user_ids"], {hamlet.id, othello.id})
+        self.assertEqual(info.wildcard_mention_user_ids, {hamlet.id, othello.id})
 
         sub = get_subscription(stream_name, hamlet)
         sub.push_notifications = False
@@ -1835,7 +1835,7 @@ class RecipientInfoTest(ZulipTestCase):
             sender_id=hamlet.id,
             stream_topic=stream_topic,
         )
-        self.assertEqual(info["stream_push_user_ids"], set())
+        self.assertEqual(info.stream_push_user_ids, set())
 
         hamlet.enable_stream_push_notifications = False
         hamlet.save()
@@ -1848,7 +1848,7 @@ class RecipientInfoTest(ZulipTestCase):
             sender_id=hamlet.id,
             stream_topic=stream_topic,
         )
-        self.assertEqual(info["stream_push_user_ids"], {hamlet.id})
+        self.assertEqual(info.stream_push_user_ids, {hamlet.id})
 
         # Now have Hamlet mute the topic to omit him from stream_push_user_ids.
         add_topic_mute(
@@ -1865,8 +1865,8 @@ class RecipientInfoTest(ZulipTestCase):
             stream_topic=stream_topic,
             possible_wildcard_mention=False,
         )
-        self.assertEqual(info["stream_push_user_ids"], set())
-        self.assertEqual(info["wildcard_mention_user_ids"], set())
+        self.assertEqual(info.stream_push_user_ids, set())
+        self.assertEqual(info.wildcard_mention_user_ids, set())
 
         info = get_recipient_info(
             realm_id=realm.id,
@@ -1875,10 +1875,10 @@ class RecipientInfoTest(ZulipTestCase):
             stream_topic=stream_topic,
             possible_wildcard_mention=True,
         )
-        self.assertEqual(info["stream_push_user_ids"], set())
+        self.assertEqual(info.stream_push_user_ids, set())
         # Since Hamlet has muted the stream and Cordelia has disabled
         # wildcard notifications, it should just be Othello here.
-        self.assertEqual(info["wildcard_mention_user_ids"], {othello.id})
+        self.assertEqual(info.wildcard_mention_user_ids, {othello.id})
 
         # If Hamlet mutes Cordelia, he should be in `muted_sender_user_ids` for a message
         # sent by Cordelia.
@@ -1890,7 +1890,7 @@ class RecipientInfoTest(ZulipTestCase):
             stream_topic=stream_topic,
             possible_wildcard_mention=True,
         )
-        self.assertTrue(hamlet.id in info["muted_sender_user_ids"])
+        self.assertTrue(hamlet.id in info.muted_sender_user_ids)
 
         sub = get_subscription(stream_name, othello)
         sub.wildcard_mentions_notify = False
@@ -1903,9 +1903,9 @@ class RecipientInfoTest(ZulipTestCase):
             stream_topic=stream_topic,
             possible_wildcard_mention=True,
         )
-        self.assertEqual(info["stream_push_user_ids"], set())
+        self.assertEqual(info.stream_push_user_ids, set())
         # Verify that stream-level wildcard_mentions_notify=False works correctly.
-        self.assertEqual(info["wildcard_mention_user_ids"], set())
+        self.assertEqual(info.wildcard_mention_user_ids, set())
 
         # Verify that True works as expected as well
         sub = get_subscription(stream_name, othello)
@@ -1919,8 +1919,8 @@ class RecipientInfoTest(ZulipTestCase):
             stream_topic=stream_topic,
             possible_wildcard_mention=True,
         )
-        self.assertEqual(info["stream_push_user_ids"], set())
-        self.assertEqual(info["wildcard_mention_user_ids"], {othello.id})
+        self.assertEqual(info.stream_push_user_ids, set())
+        self.assertEqual(info.wildcard_mention_user_ids, {othello.id})
 
         # Add a service bot.
         service_bot = do_create_user(
@@ -1940,7 +1940,7 @@ class RecipientInfoTest(ZulipTestCase):
             possibly_mentioned_user_ids={service_bot.id},
         )
         self.assertEqual(
-            info["service_bot_tuples"],
+            info.service_bot_tuples,
             [
                 (service_bot.id, UserProfile.EMBEDDED_BOT),
             ],
@@ -1963,8 +1963,8 @@ class RecipientInfoTest(ZulipTestCase):
             stream_topic=stream_topic,
             possibly_mentioned_user_ids={service_bot.id, normal_bot.id},
         )
-        self.assertEqual(info["default_bot_user_ids"], {normal_bot.id})
-        self.assertEqual(info["all_bot_user_ids"], {normal_bot.id, service_bot.id})
+        self.assertEqual(info.default_bot_user_ids, {normal_bot.id})
+        self.assertEqual(info.all_bot_user_ids, {normal_bot.id, service_bot.id})
 
     def test_get_recipient_info_invalid_recipient_type(self) -> None:
         hamlet = self.example_user("hamlet")