Merge branch 'develop' into na/backend/disc-events-exclude-attending

Author: nabramow

app/backend/.dockerignore

@@ -9,6 +9,7 @@
 !templates
 !alembic.ini
 !pyproject.toml
+!feature-flags.dev.json
 
 # It's not included into the final image, but is still needed here
 # for "--mount=type=bind"

app/backend/proto/internal/jobs.proto

@@ -80,7 +80,11 @@ message GenerateEventCreateNotificationsPayload {
 message GenerateEventUpdateNotificationsPayload {
   int64 updating_user_id = 1;
   int64 occurrence_id = 2;
-  repeated string updated_items = 3;
+  // TODO(#9117): Remove once unused. Was not i18n-friendly. Use updated_enum_items.
+  repeated string updated_str_items = 3 [deprecated = true];
+  // EventUpdateItem is from the shared protos and cannot be referenced here.
+  // int32 has the same on-wire encoding.
+  repeated int32 updated_enum_items = 4;
 }
 
 message GenerateEventCancelNotificationsPayload {

app/backend/src/couchers/constants.py

@@ -15,7 +15,9 @@
 # Must match the frontend values in app/web/utils/validation.ts
 VALID_NAME_MIN_LENGTH = 2
 VALID_NAME_MAX_LENGTH = 100
-VALID_NAME_REGEX = r"^[\p{L}'-]+(\s+[\p{L}'-]+)*$"
+
+# Letters, diacritics, internal spaces, quotes, dashes, commas, dots, and's for two names. See tests!
+VALID_NAME_REGEX = r"""^(?!\p{Zs})[\p{L}\p{M}\p{Zs}\p{Pi}\p{Pf}\p{Pd},.'"·・&/|]+(?<!\p{Zs})$"""
 
 BANNED_USERNAME_PHRASES = [
     "admin",

app/backend/src/couchers/email/blocks.py

@@ -5,7 +5,7 @@
 
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
-from typing import Any, Self
+from typing import Self
 
 from markupsafe import Markup
 
@@ -207,18 +207,6 @@ class EmailFooter:
     copyright_year: int = now().year
     unsubscribe_info: UnsubscribeInfo | None
 
-    def to_template_args(self) -> dict[str, Any]:
-        args: dict[str, Any] = {
-            "footer_timezone_name": self.timezone_name,
-            "footer_copyright_year": self.copyright_year,
-            "footer_email_is_critical": self.unsubscribe_info is None,
-        }
-
-        if unsubscribe_info := self.unsubscribe_info:
-            args.update(unsubscribe_info.to_template_args())
-
-        return args
-
 
 @dataclass(kw_only=True)
 class UnsubscribeInfo:
@@ -227,20 +215,6 @@ class UnsubscribeInfo:
     topic_action_link: UnsubscribeLink
     topic_key_link: UnsubscribeLink | None = None
 
-    def to_template_args(self) -> dict[str, Any]:
-        args: dict[str, Any] = {
-            "footer_manage_notifications_link": self.manage_notifications_url,
-            "footer_do_not_email_link": self.do_not_email_url,
-            "footer_notification_topic_action": self.topic_action_link.text,
-            "footer_notification_topic_action_link": self.topic_action_link.url,
-        }
-
-        if topic_key_link := self.topic_key_link:
-            args["footer_notification_topic_key"] = topic_key_link.text
-            args["footer_notification_topic_key_link"] = topic_key_link.url
-
-        return args
-
 
 @dataclass(kw_only=True)
 class UnsubscribeLink:

app/backend/src/couchers/email/emails.py

@@ -733,7 +733,7 @@ class EventUpdatedEmail(EmailBase):
 
     updating_user: UserInfo
     event_info: EventInfo
-    updated_items: list[str]
+    updated_items: list[notification_data_pb2.EventUpdateItem.ValueType]
 
     @property
     def string_key_base(self) -> str:
@@ -748,9 +748,17 @@ def get_body_blocks(self, loc_context: LocalizationContext) -> list[EmailBlock]:
         builder = self._body_builder(loc_context)
         builder.para(".body")
 
-        # TODO(#8875): Localize the updated items
-        updated_items_text = ", ".join(self.updated_items)
-        builder.para(".updated_items", {"items_list": updated_items_text})
+        updated_items_string_keys = list(
+            filter(None, (type(self)._updated_item_to_string_key(i) for i in self.updated_items))
+        )
+        if updated_items_string_keys:
+            updated_items_text = loc_context.localize_list(
+                [self._localize(loc_context, key) for key in updated_items_string_keys]
+            )
+            builder.para(".updated_items", {"items_list": updated_items_text})
+        else:
+            builder.para(".updated_generic")
+
         builder.block(self.event_info.get_details_block(loc_context))
         builder.user(self.updating_user)
         builder.block(self.event_info.get_description_block())
@@ -759,22 +767,62 @@ def get_body_blocks(self, loc_context: LocalizationContext) -> list[EmailBlock]:
 
     @classmethod
     def from_notification(cls, data: notification_data_pb2.EventUpdate, *, user_name: str) -> Self:
+        updated_items: list[notification_data_pb2.EventUpdateItem.ValueType] = []
+        if data.updated_enum_items:
+            updated_items.extend(data.updated_enum_items)
+        elif data.updated_str_items:
+            for updated_str_item in data.updated_str_items:
+                if updated_enum_item := cls._updated_item_str_to_enum(updated_str_item):
+                    updated_items.append(updated_enum_item)
+
         return cls(
             user_name=user_name,
             updating_user=UserInfo.from_protobuf(data.updating_user),
             event_info=EventInfo.from_proto(data.event),
-            updated_items=list(data.updated_items),
+            updated_items=updated_items,
         )
 
+    # TODO(#9117): Backcompat. Remove update_str_items fallback once known unused.
+    @staticmethod
+    def _updated_item_str_to_enum(value: str) -> notification_data_pb2.EventUpdateItem.ValueType | None:
+        match value:
+            case "title":
+                return notification_data_pb2.EventUpdateItem.EVENT_UPDATE_ITEM_TITLE
+            case "content":
+                return notification_data_pb2.EventUpdateItem.EVENT_UPDATE_ITEM_CONTENT
+            case "location":
+                return notification_data_pb2.EventUpdateItem.EVENT_UPDATE_ITEM_LOCATION
+            case "start time":
+                return notification_data_pb2.EventUpdateItem.EVENT_UPDATE_ITEM_START_TIME
+            case "end time":
+                return notification_data_pb2.EventUpdateItem.EVENT_UPDATE_ITEM_END_TIME
+            case _:
+                return None
+
+    @staticmethod
+    def _updated_item_to_string_key(value: notification_data_pb2.EventUpdateItem.ValueType) -> str | None:
+        match value:
+            case notification_data_pb2.EventUpdateItem.EVENT_UPDATE_ITEM_TITLE:
+                return ".item_names.title"
+            case notification_data_pb2.EventUpdateItem.EVENT_UPDATE_ITEM_CONTENT:
+                return ".item_names.content"
+            case notification_data_pb2.EventUpdateItem.EVENT_UPDATE_ITEM_LOCATION:
+                return ".item_names.location"
+            case notification_data_pb2.EventUpdateItem.EVENT_UPDATE_ITEM_START_TIME:
+                return ".item_names.start_time"
+            case notification_data_pb2.EventUpdateItem.EVENT_UPDATE_ITEM_END_TIME:
+                return ".item_names.end_time"
+            case _:
+                return None
+
     @classmethod
     def test_instances(cls) -> list[Self]:
+        prototype = cls(
+            user_name="Alice", updating_user=UserInfo.dummy_bob(), event_info=EventInfo.dummy(), updated_items=[]
+        )
         return [
-            cls(
-                user_name="Alice",
-                updating_user=UserInfo.dummy_bob(),
-                event_info=EventInfo.dummy(),
-                updated_items=["time", "location"],
-            )
+            replace(prototype, updated_items=[]),
+            replace(prototype, updated_items=notification_data_pb2.EventUpdateItem.values()),
         ]
 
 

app/backend/src/couchers/email/locales/en.json

@@ -4,7 +4,20 @@
     "closing_line": "Best,<br>The Couchers.org Team",
     "founders_signature": "Aapeli and Itsi,<br>Couchers.org Founders",
     "security_warning_contact_support": "If you did not initiate this action, please contact us by emailing <a href=\"mailto:support@couchers.org\">support@couchers.org</a> so we can sort this out as soon as possible!",
-    "do_not_reply_request": "<b>Do not reply to this email.</b> Use one of the buttons above to reply to this request."
+    "do_not_reply_request": "<b>Do not reply to this email.</b> Use one of the buttons above to reply to this request.",
+    "footer": {
+      "received_because": "You're receiving this email because you signed up for Couchers.org.",
+      "contact_support": "You can reach our support team at <a href=\"mailto:support@couchers.org\">support@couchers.org</a>.",
+      "timezone_note": "All times are in {{ timezone }}, based on your profile location.",
+      "donate_link": "Donate",
+      "volunteer_link": "Volunteer",
+      "blog_link": "Blog",
+      "nonprofit_note": "Couchers.org is a project of Couchers, Inc. a U.S. 501(c)(3) non-profit, tax-exempt organization.",
+      "security_email_note": "This is a security email, you cannot unsubscribe from it.",
+      "notification_settings_link": "Manage notification preferences",
+      "do_not_email_link": "Do not email me (disables hosting)",
+      "happy_couch_icon_caption": "The happy Couchers couch hopes you have a great rest of the day."
+    }
   },
   "calendar_events": {
     "title_cancelled": "Cancelled: {{ title }}",
@@ -152,7 +165,15 @@
     "updated": {
       "subject": "{{user}} updated \"{{title}}\"",
       "body": "An event you are subscribed to was updated.",
-      "updated_items": "The following information was updated: <b>{{items_list}}</b>. Here is the updated event:"
+      "updated_items": "The following information was updated: <b>{{items_list}}</b>. Here is the updated event:",
+      "updated_generic": "Here is the updated event:",
+      "item_names": {
+        "title": "title",
+        "content": "content",
+        "location": "location",
+        "start_time": "start time",
+        "end_time": "end time"
+      }
     },
     "organizer_invited": {
       "subject": "{{user}} invited you to co-organize \"{{title}}\"",

app/backend/src/couchers/email/rendering.py

@@ -8,6 +8,7 @@
 from functools import cache
 from html import unescape
 from pathlib import Path
+from typing import Any
 
 from markdown_it import MarkdownIt
 from markupsafe import Markup
@@ -17,6 +18,7 @@
 from couchers.email.locales import get_emails_i18next
 from couchers.email.smtp import embed_html_relative_images
 from couchers.i18n import LocalizationContext
+from couchers.i18n.i18next import SubstitutionDict, full_string_key
 from couchers.proto.internal import jobs_pb2
 from couchers.templating import Jinja2Template
 
@@ -103,8 +105,10 @@ def render_plaintext_body(*, blocks: list[EmailBlock], footer: EmailFooter, loc_
     footer_template = Jinja2Template(
         source=(template_folder / "_footer.txt").read_text(encoding="utf8").strip(), html=False
     )
-    footer_template_args = footer.to_template_args()
-    return "".join(concat) + footer_template.render(footer_template_args)
+    footer_template_args = _get_footer_template_args(footer, loc_context)
+    concat.append(footer_template.render(footer_template_args))
+
+    return "".join(concat)
 
 
 def _to_plaintext(text: str | Markup) -> str:
@@ -132,6 +136,47 @@ def _to_plaintext(text: str | Markup) -> str:
     return unescape(text)
 
 
+def _get_footer_template_args(footer: EmailFooter, loc_context: LocalizationContext) -> dict[str, Any]:
+    i18n = get_emails_i18next()
+
+    def localize(key: str, substitutions: SubstitutionDict | None = None) -> Markup:
+        key = full_string_key(key, relative_base="generic.footer")
+        return i18n.localize_with_markup(key, loc_context.locale, substitutions)
+
+    args: dict[str, Any] = {
+        "received_because": localize(".received_because"),
+        "contact_support": localize(".contact_support"),
+        "timezone_note": localize(".timezone_note", {"timezone": footer.timezone_name}),
+        "copyright_year": footer.copyright_year,
+        "donate_link": localize(".donate_link"),
+        "volunteer_link": localize(".volunteer_link"),
+        "blog_link": localize(".blog_link"),
+        "nonprofit_note": localize(".nonprofit_note"),
+        "is_critical": footer.unsubscribe_info is None,
+    }
+
+    if unsubscribe_info := footer.unsubscribe_info:
+        # TODO(#7420): Localize "Turn off emails for: " text, avoiding string concatenations.
+        args.update(
+            {
+                "notification_settings_link": localize(".notification_settings_link"),
+                "manage_notifications_url": unsubscribe_info.manage_notifications_url,
+                "do_not_email_link": localize(".do_not_email_link"),
+                "do_not_email_url": unsubscribe_info.do_not_email_url,
+                "topic_action_description": unsubscribe_info.topic_action_link.text,
+                "unsubscribe_topic_action_url": unsubscribe_info.topic_action_link.url,
+            }
+        )
+
+        if topic_key_link := unsubscribe_info.topic_key_link:
+            args["topic_key_description"] = topic_key_link.text
+            args["unsubscribe_topic_key_url"] = topic_key_link.url
+    else:
+        args["security_email_note"] = localize(".security_email_note")
+
+    return args
+
+
 def render_html_body(
     *,
     subject: str,
@@ -212,6 +257,7 @@ def render(
                                 "name": block.info.name,
                                 "age": block.info.age,
                                 "city": block.info.city,
+                                "profile_url": block.info.profile_url,
                                 "avatar_url": block.info.avatar_url,
                                 "comment": block.comment,
                             },
@@ -228,7 +274,7 @@ def render(
                     raise TypeError(f"Unexpected email block type: {block.__class__}")
 
         # Render the footer
-        footer_template_args = footer.to_template_args()
+        footer_template_args = _get_footer_template_args(footer, loc_context)
         concats.append(self.footer_template.render(footer_template_args))
 
         return "\n".join(concats)

app/backend/src/couchers/i18n/context.py

@@ -1,3 +1,4 @@
+from collections.abc import Sequence
 from dataclasses import FrozenInstanceError
 from datetime import UTC, date, datetime, time, tzinfo
 from typing import Any
@@ -17,6 +18,7 @@
 from couchers.i18n.localize import (
     localize_date,
     localize_datetime,
+    localize_list,
     localize_time,
     localize_timezone,
 )
@@ -69,6 +71,9 @@ def localize_string(
         i18next = i18next or get_main_i18next()
         return i18next.localize(key, self.locale, substitutions=substitutions)
 
+    def localize_list(self, items: Sequence[str]) -> str:
+        return localize_list(items, self.babel_locale)
+
     def localize_date(
         self, value: date | datetime, *, abbrev: bool = False, with_year: bool = True, with_day_of_week: bool = False
     ) -> str:

app/backend/src/couchers/i18n/locales/de.json

@@ -229,7 +229,10 @@
     "discussion_edit_permission_denied": "Du darfst diesen Beitrag nicht bearbeiten.",
     "reply_delete_permission_denied": "Du darfst diesen Kommentar nicht löschen.",
     "reply_deleted": "Dieser Kommentar wurde gelöscht.",
-    "reply_edit_permission_denied": "Du darfst diesen Kommentar nicht bearbeiten."
+    "reply_edit_permission_denied": "Du darfst diesen Kommentar nicht bearbeiten.",
+    "cannot_combine_attending_and_exclude_attending": "Deine Filter können Events, an denen du teilnimmst, nicht gleichzeitig einschließen und ausschließen.",
+    "event_community_invite_not_found": "Die Event-Einladung für die Community konnte nicht gefunden werden.",
+    "public_trips_disabled": "Öffentliche Trips sind derzeit deaktiviert."
   },
   "quick_links": {
     "do_not_email": "Du wirst keine E-Mails mehr erhalten, die nicht sicherheitsrelevant sind, und dein Hosting-Status wurde zurückgesetzt. Der Newsletter muss separat abbestellt werden.",

app/backend/src/couchers/i18n/locales/en.json

@@ -66,7 +66,7 @@
     "event_cant_update_old_event": "You can't modify, subscribe to, or attend to an event that's more than 1 day old.",
     "event_community_invite_already_approved": "A community invite has already been sent out for this event.",
     "event_community_invite_already_requested": "You have already requested a community invite for this event.",
-    "cannot_combine_attending_and_exclude_attending": "You cannot set both attending and exclude_attending.",
+    "cannot_combine_attending_and_exclude_attending": "Your filters cannot both include and exclude events you are attending.",
     "event_community_invite_not_found": "Couldn't find that event community invite.",
     "event_edit_permission_denied": "You're not allowed to edit that event.",
     "event_ends_before_starts": "The event must end after it starts.",