CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-06-27 21:01:32 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

email_notification: Change data structure build_message_list returns.

Browse Source 
All `messages` share the same recipient (and topic), so there will
be only one recipient block.

Instead of a list of dictionaries (of recipient blocks), just returning
a dictionary suffices our need.

Signed-off-by: Prakhar Pratyush <prakhar@zulip.com>
This commit is contained in:
Prakhar Pratyush 2025-11-21 19:58:24 +05:30 committed by Tim Abbott
parent 83b10f57cb
commit ba92eed287
6 changed files with 34 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
templates/zerver/emails/digest.html
View File

@ -5,7 +5,7 @@
{% if hot_conversations %}
{% for convo in hot_conversations %}
<div class='messages'>
{% for recipient_block in convo.first_few_messages %}
{% with recipient_block=convo.first_few_messages %}
<div class='hot_convo_recipient_block'>
<div class='hot_convo_recipient_header'>{{ recipient_block.header.html|safe }}</div>
<div class='hot_convo_message_content'>
@ -19,7 +19,7 @@
</div>
</div>
{% if convo.count > 0 %}<p class="digest_paragraph">+ {{ convo.count }} more message{{ convo.count|pluralize }} by {{ convo.participants|display_list(4) }}.</p>{% endif %}
{% endfor %}
{% endwith %}
</div>
{% endfor %}
{% endif %}

4
templates/zerver/emails/digest.txt
View File

@ -1,10 +1,10 @@
{% if show_message_content %}
{% if hot_conversations %}
{% for convo in hot_conversations %}{% for recipient_block in convo.first_few_messages %}{{ recipient_block.header.plain }}
{% for convo in hot_conversations %}{% with recipient_block=convo.first_few_messages %}{{ recipient_block.header.plain }}
{% for sender_block in recipient_block.senders %}
{% for message_block in sender_block.content %}{{ message_block.plain }}
{% endfor %}{% endfor %}
{% if convo.count > 0 %}+ {{ convo.count }} more message{{ convo.count|pluralize }} by {{ convo.participants|display_list(4) }}.{% endif %}{% endfor %}{% endfor %}{% endif %}
{% if convo.count > 0 %}+ {{ convo.count }} more message{{ convo.count|pluralize }} by {{ convo.participants|display_list(4) }}.{% endif %}{% endwith %}{% endfor %}{% endif %}
{% if new_channels.plain %}** {% trans %}New channels{% endtrans %} **
{{ new_channels.plain|display_list(1000) }}.

4
templates/zerver/emails/missed_message.html
View File

@ -2,7 +2,7 @@
{% block content %}
{% if show_message_content %}
{% for recipient_block in messages %}
{% with recipient_block=messages %}
{% for sender_block in recipient_block.senders %}
<div class="missed_message">
{% for message_block in sender_block.content %}
@ -10,7 +10,7 @@
{% endfor %}
</div>
{% endfor %}
{% endfor %}
{% endwith %}
{% else %}
<div class="missed_message no-content-explanation">
{% if message_content_disabled_by_realm %}

4
templates/zerver/emails/missed_message.txt
View File

@ -1,11 +1,11 @@
{% if show_message_content %}
{% for recipient_block in messages %}
{% with recipient_block=messages %}
{% for sender_block in recipient_block.senders %}
{% for message_block in sender_block.content %}
{{ message_block.plain }}
{% endfor %}
{% endfor %}
{% endfor %}
{% endwith %}
{% else %}
{% if message_content_disabled_by_realm %}
{% trans hide_content_url=realm_url + "/help/hide-message-content-in-emails" %}

66
zerver/lib/email_notifications.py
View File

@ -221,12 +221,11 @@ def build_message_list(
user: UserProfile,
messages: list[Message],
stream_id_map: dict[int, Stream] | None = None, # only needs id, name
) -> list[dict[str, Any]]:
) -> dict[str, Any]:
"""
Builds the message list object for the message notification email and
digest email template. All `messages` share the same recipient (and topic).
"""
messages_to_render: list[dict[str, Any]] = []
def sender_string(message: Message) -> str:
if message.recipient.type == Recipient.STREAM:
@ -342,54 +341,37 @@ def build_message_list(
"html": header_html,
}
# # Collapse message list to
# [
# {
# "header": {
# "plain":"header",
# "html":"htmlheader"
# }
# "senders":[
# {
# "sender":"sender_name",
# "content":[
# {
# "plain":"content",
# "html":"htmlcontent"
# }
# {
# "plain":"content",
# "html":"htmlcontent"
# }
# ]
# }
# ]
# },
# ]
# Collapse message list to:
# {
# "header": {"plain": "header", "html": "htmlheader"},
# "senders": [
# {
# "sender": "sender_name",
# "content": [
# {"plain": "content", "html": "htmlcontent"},
# {"plain": "content", "html": "htmlcontent"},
# ],
# }
# ],
# }
assert len(messages) > 0
recipients = {(message.recipient_id, message.topic_name().lower()) for message in messages}
assert len(recipients) == 1, f"Unexpectedly multiple recipients: {recipients!r}"
header = message_header(messages[0])
messages.sort(key=lambda message: message.date_sent)
for message in messages:
# If we want to collapse into the previous recipient block
if len(messages_to_render) > 0:
sender = sender_string(message)
sender_block = messages_to_render[-1]["senders"]
header = message_header(messages[0])
sender_block = [build_sender_payload(messages[0])]
messages_to_render = {"header": header, "senders": sender_block}
# Same message sender, collapse again
if sender_block[-1]["sender"] == sender:
sender_block[-1]["content"].append(build_message_payload(message))
else:
# Start a new sender block
sender_block.append(build_sender_payload(message))
for message in messages[1:]:
sender = sender_string(message)
# Same message sender, collapse again
if sender_block[-1]["sender"] == sender:
sender_block[-1]["content"].append(build_message_payload(message))
else:
# New recipient and sender block
recipient_block = {"header": header, "senders": [build_sender_payload(message)]}
messages_to_render.append(recipient_block)
# Start a new sender block
sender_block.append(build_sender_payload(message))
return messages_to_render

4
zerver/tests/test_digest.py
View File

@ -75,7 +75,7 @@ class TestDigestEmailMessages(ZulipTestCase):
self.assertEqual(set(hot_convo["participants"]), expected_participants)
self.assertEqual(hot_convo["count"], 5 - 2) # 5 messages, but 2 shown
teaser_messages = hot_convo["first_few_messages"][0]["senders"]
teaser_messages = hot_convo["first_few_messages"]["senders"]
self.assertIn("some content", teaser_messages[0]["content"][0]["plain"])
self.assertIn(teaser_messages[0]["sender"], expected_participants)
@ -276,7 +276,7 @@ class TestDigestEmailMessages(ZulipTestCase):
self.assertEqual(set(hot_convo["participants"]), expected_participants)
self.assertEqual(hot_convo["count"], 5 - 2) # 5 messages, but 2 shown
teaser_messages = hot_convo["first_few_messages"][0]["senders"]
teaser_messages = hot_convo["first_few_messages"]["senders"]
self.assertIn("some content", teaser_messages[0]["content"][0]["plain"])
self.assertIn(teaser_messages[0]["sender"], expected_participants)