Merge pull request #9306 from Couchers-org/na/backend/split-shared-convo-types-proto

Backend: Split shared conversation types into a leaf proto file

Author: nabramow

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

@@ -51,7 +51,7 @@
 from couchers.i18n.localize import format_phone_number
 from couchers.markup import html_link, html_mailto_link, markdown_to_plaintext
 from couchers.notifications.quick_links import generate_quick_decline_link
-from couchers.proto import conversations_pb2, events_pb2, notification_data_pb2
+from couchers.proto import events_pb2, messages_pb2, notification_data_pb2
 from couchers.utils import now, to_aware_datetime
 
 # Common string keys
@@ -1445,20 +1445,20 @@ class HostRequestStatusChangedEmail(EmailBase):
     other_user: UserInfo
     from_date: date
     to_date: date
-    new_status: conversations_pb2.HostRequestStatus.ValueType
+    new_status: messages_pb2.HostRequestStatus.ValueType
     view_link: str
 
     @property
     def string_key_base(self) -> str:
         base_key = "host_requests.status_changed"
         match self.new_status:
-            case conversations_pb2.HOST_REQUEST_STATUS_ACCEPTED:
+            case messages_pb2.HOST_REQUEST_STATUS_ACCEPTED:
                 return f"{base_key}.accepted_by_host"
-            case conversations_pb2.HOST_REQUEST_STATUS_REJECTED:
+            case messages_pb2.HOST_REQUEST_STATUS_REJECTED:
                 return f"{base_key}.declined_by_host"
-            case conversations_pb2.HOST_REQUEST_STATUS_CONFIRMED:
+            case messages_pb2.HOST_REQUEST_STATUS_CONFIRMED:
                 return f"{base_key}.confirmed_by_surfer"
-            case conversations_pb2.HOST_REQUEST_STATUS_CANCELLED:
+            case messages_pb2.HOST_REQUEST_STATUS_CANCELLED:
                 return f"{base_key}.cancelled_by_surfer"
             case _:
                 raise ValueError(f"Unexpected host request status: {self.new_status}")
@@ -1492,20 +1492,20 @@ def from_notification(
         user_name: str,
     ) -> Self:
         other_user: UserInfo
-        new_status: conversations_pb2.HostRequestStatus.ValueType
+        new_status: messages_pb2.HostRequestStatus.ValueType
         match data:
             case notification_data_pb2.HostRequestAccept():
                 other_user = UserInfo.from_protobuf(data.host)
-                new_status = conversations_pb2.HostRequestStatus.HOST_REQUEST_STATUS_ACCEPTED
+                new_status = messages_pb2.HostRequestStatus.HOST_REQUEST_STATUS_ACCEPTED
             case notification_data_pb2.HostRequestReject():
                 other_user = UserInfo.from_protobuf(data.host)
-                new_status = conversations_pb2.HostRequestStatus.HOST_REQUEST_STATUS_REJECTED
+                new_status = messages_pb2.HostRequestStatus.HOST_REQUEST_STATUS_REJECTED
             case notification_data_pb2.HostRequestConfirm():
                 other_user = UserInfo.from_protobuf(data.surfer)
-                new_status = conversations_pb2.HostRequestStatus.HOST_REQUEST_STATUS_CONFIRMED
+                new_status = messages_pb2.HostRequestStatus.HOST_REQUEST_STATUS_CONFIRMED
             case notification_data_pb2.HostRequestCancel():
                 other_user = UserInfo.from_protobuf(data.surfer)
-                new_status = conversations_pb2.HostRequestStatus.HOST_REQUEST_STATUS_CANCELLED
+                new_status = messages_pb2.HostRequestStatus.HOST_REQUEST_STATUS_CANCELLED
             case _:
                 # Enable mypy's exhaustiveness checking
                 assert_never("Unexpected host request status changed notification data type.")
@@ -1526,14 +1526,14 @@ def test_instances(cls) -> list[Self]:
             other_user=UserInfo.dummy_bob(),
             from_date=date(2025, 6, 1),
             to_date=date(2025, 6, 7),
-            new_status=conversations_pb2.HOST_REQUEST_STATUS_ACCEPTED,
+            new_status=messages_pb2.HOST_REQUEST_STATUS_ACCEPTED,
             view_link="https://couchers.org/requests/123",
         )
         return [
-            replace(prototype, new_status=conversations_pb2.HOST_REQUEST_STATUS_ACCEPTED),
-            replace(prototype, new_status=conversations_pb2.HOST_REQUEST_STATUS_REJECTED),
-            replace(prototype, new_status=conversations_pb2.HOST_REQUEST_STATUS_CONFIRMED),
-            replace(prototype, new_status=conversations_pb2.HOST_REQUEST_STATUS_CANCELLED),
+            replace(prototype, new_status=messages_pb2.HOST_REQUEST_STATUS_ACCEPTED),
+            replace(prototype, new_status=messages_pb2.HOST_REQUEST_STATUS_REJECTED),
+            replace(prototype, new_status=messages_pb2.HOST_REQUEST_STATUS_CONFIRMED),
+            replace(prototype, new_status=messages_pb2.HOST_REQUEST_STATUS_CANCELLED),
         ]
 
 

app/backend/src/couchers/servicers/auth_unsubscribe.py

@@ -20,7 +20,7 @@
 )
 from couchers.notifications import settings
 from couchers.notifications.utils import enum_from_topic_action
-from couchers.proto import conversations_pb2, requests_pb2
+from couchers.proto import messages_pb2, requests_pb2
 from couchers.proto.internal import unsubscribe_pb2
 from couchers.servicers.requests import Requests
 from couchers.sql import where_moderated_content_visible
@@ -83,7 +83,7 @@ def handle_unsubscribe(payload: unsubscribe_pb2.UnsubscribePayload, context: Cou
         Requests().RespondHostRequest(
             request=requests_pb2.RespondHostRequestReq(
                 host_request_id=payload.host_request_quick_decline.host_request_id,
-                status=conversations_pb2.HOST_REQUEST_STATUS_REJECTED,
+                status=messages_pb2.HOST_REQUEST_STATUS_REJECTED,
             ),
             context=make_one_off_interactive_user_context(couchers_context=context, user_id=payload.user_id),
             session=session,

app/backend/src/couchers/servicers/conversations.py

@@ -30,7 +30,7 @@
 from couchers.models.notifications import NotificationTopicAction
 from couchers.moderation.utils import create_moderation
 from couchers.notifications.notify import mark_notifications_seen, notify
-from couchers.proto import conversations_pb2, conversations_pb2_grpc, notification_data_pb2
+from couchers.proto import conversations_pb2, conversations_pb2_grpc, messages_pb2, notification_data_pb2
 from couchers.proto.internal import jobs_pb2
 from couchers.rate_limits.check import process_rate_limits_and_check_abort
 from couchers.rate_limits.definitions import RATE_LIMIT_HOURS
@@ -45,52 +45,48 @@
 MAX_PAGE_SIZE = 50
 
 
-def _message_to_pb(message: Message) -> conversations_pb2.Message:
+def _message_to_pb(message: Message) -> messages_pb2.Message:
     """
     Turns the given message to a protocol buffer
     """
     if message.is_normal_message:
-        return conversations_pb2.Message(
+        return messages_pb2.Message(
             message_id=message.id,
             author_user_id=message.author_id,
             time=Timestamp_from_datetime(message.time),
-            text=conversations_pb2.MessageContentText(text=message.text),
+            text=messages_pb2.MessageContentText(text=message.text),
         )
     else:
-        return conversations_pb2.Message(
+        return messages_pb2.Message(
             message_id=message.id,
             author_user_id=message.author_id,
             time=Timestamp_from_datetime(message.time),
             chat_created=(
-                conversations_pb2.MessageContentChatCreated()
-                if message.message_type == MessageType.chat_created
-                else None
+                messages_pb2.MessageContentChatCreated() if message.message_type == MessageType.chat_created else None
             ),
             chat_edited=(
-                conversations_pb2.MessageContentChatEdited()
-                if message.message_type == MessageType.chat_edited
-                else None
+                messages_pb2.MessageContentChatEdited() if message.message_type == MessageType.chat_edited else None
             ),
             user_invited=(
-                conversations_pb2.MessageContentUserInvited(target_user_id=message.target_id)
+                messages_pb2.MessageContentUserInvited(target_user_id=message.target_id)
                 if message.message_type == MessageType.user_invited
                 else None
             ),
             user_left=(
-                conversations_pb2.MessageContentUserLeft() if message.message_type == MessageType.user_left else None
+                messages_pb2.MessageContentUserLeft() if message.message_type == MessageType.user_left else None
             ),
             user_made_admin=(
-                conversations_pb2.MessageContentUserMadeAdmin(target_user_id=message.target_id)
+                messages_pb2.MessageContentUserMadeAdmin(target_user_id=message.target_id)
                 if message.message_type == MessageType.user_made_admin
                 else None
             ),
             user_removed_admin=(
-                conversations_pb2.MessageContentUserRemovedAdmin(target_user_id=message.target_id)
+                messages_pb2.MessageContentUserRemovedAdmin(target_user_id=message.target_id)
                 if message.message_type == MessageType.user_removed_admin
                 else None
             ),
             group_chat_user_removed=(
-                conversations_pb2.MessageContentUserRemoved(target_user_id=message.target_id)
+                messages_pb2.MessageContentUserRemoved(target_user_id=message.target_id)
                 if message.message_type == MessageType.user_removed
                 else None
             ),

app/backend/src/couchers/servicers/requests.py

@@ -36,7 +36,12 @@
 from couchers.models.public_trips import PublicTrip, PublicTripStatus
 from couchers.moderation.utils import create_moderation
 from couchers.notifications.notify import mark_notifications_seen, notify
-from couchers.proto import conversations_pb2, notification_data_pb2, requests_pb2, requests_pb2_grpc
+from couchers.proto import (
+    messages_pb2,
+    notification_data_pb2,
+    requests_pb2,
+    requests_pb2_grpc,
+)
 from couchers.rate_limits.check import process_rate_limits_and_check_abort
 from couchers.rate_limits.definitions import RATE_LIMIT_HOURS
 from couchers.servicers.api import response_rate_to_pb, user_model_to_pb
@@ -57,19 +62,19 @@
 
 
 hostrequeststatus2api = {
-    HostRequestStatus.pending: conversations_pb2.HOST_REQUEST_STATUS_PENDING,
-    HostRequestStatus.accepted: conversations_pb2.HOST_REQUEST_STATUS_ACCEPTED,
-    HostRequestStatus.rejected: conversations_pb2.HOST_REQUEST_STATUS_REJECTED,
-    HostRequestStatus.confirmed: conversations_pb2.HOST_REQUEST_STATUS_CONFIRMED,
-    HostRequestStatus.cancelled: conversations_pb2.HOST_REQUEST_STATUS_CANCELLED,
+    HostRequestStatus.pending: messages_pb2.HOST_REQUEST_STATUS_PENDING,
+    HostRequestStatus.accepted: messages_pb2.HOST_REQUEST_STATUS_ACCEPTED,
+    HostRequestStatus.rejected: messages_pb2.HOST_REQUEST_STATUS_REJECTED,
+    HostRequestStatus.confirmed: messages_pb2.HOST_REQUEST_STATUS_CONFIRMED,
+    HostRequestStatus.cancelled: messages_pb2.HOST_REQUEST_STATUS_CANCELLED,
 }
 
 api2hostrequeststatus = {
-    conversations_pb2.HOST_REQUEST_STATUS_PENDING: HostRequestStatus.pending,
-    conversations_pb2.HOST_REQUEST_STATUS_ACCEPTED: HostRequestStatus.accepted,
-    conversations_pb2.HOST_REQUEST_STATUS_REJECTED: HostRequestStatus.rejected,
-    conversations_pb2.HOST_REQUEST_STATUS_CONFIRMED: HostRequestStatus.confirmed,
-    conversations_pb2.HOST_REQUEST_STATUS_CANCELLED: HostRequestStatus.cancelled,
+    messages_pb2.HOST_REQUEST_STATUS_PENDING: HostRequestStatus.pending,
+    messages_pb2.HOST_REQUEST_STATUS_ACCEPTED: HostRequestStatus.accepted,
+    messages_pb2.HOST_REQUEST_STATUS_REJECTED: HostRequestStatus.rejected,
+    messages_pb2.HOST_REQUEST_STATUS_CONFIRMED: HostRequestStatus.confirmed,
+    messages_pb2.HOST_REQUEST_STATUS_CANCELLED: HostRequestStatus.cancelled,
 }
 
 hostrequestquality2sql = {
@@ -79,29 +84,27 @@
 }
 
 
-def message_to_pb(message: Message) -> conversations_pb2.Message:
+def message_to_pb(message: Message) -> messages_pb2.Message:
     """
     Turns the given message to a protocol buffer
     """
     if message.is_normal_message:
-        return conversations_pb2.Message(
+        return messages_pb2.Message(
             message_id=message.id,
             author_user_id=message.author_id,
             time=Timestamp_from_datetime(message.time),
-            text=conversations_pb2.MessageContentText(text=message.text),
+            text=messages_pb2.MessageContentText(text=message.text),
         )
     else:
-        return conversations_pb2.Message(
+        return messages_pb2.Message(
             message_id=message.id,
             author_user_id=message.author_id,
             time=Timestamp_from_datetime(message.time),
             chat_created=(
-                conversations_pb2.MessageContentChatCreated()
-                if message.message_type == MessageType.chat_created
-                else None
+                messages_pb2.MessageContentChatCreated() if message.message_type == MessageType.chat_created else None
             ),
             host_request_status_changed=(
-                conversations_pb2.MessageContentHostRequestStatusChanged(
+                messages_pb2.MessageContentHostRequestStatusChanged(
                     status=hostrequeststatus2api[message.host_request_status_target]  # type: ignore[index]
                 )
                 if message.message_type == MessageType.host_request_status_changed
@@ -575,7 +578,7 @@ def count_host_response(other_user_id: int, response_type: str) -> None:
         if host_request.initiator_user_id != context.user_id and host_request.recipient_user_id != context.user_id:
             context.abort_with_error_code(grpc.StatusCode.NOT_FOUND, "host_request_not_found")
 
-        if request.status == conversations_pb2.HOST_REQUEST_STATUS_PENDING:
+        if request.status == messages_pb2.HOST_REQUEST_STATUS_PENDING:
             context.abort_with_error_code(grpc.StatusCode.PERMISSION_DENIED, "invalid_host_request_status")
 
         if host_request.end_time < now():
@@ -587,7 +590,7 @@ def count_host_response(other_user_id: int, response_type: str) -> None:
             author_id=context.user_id,
         )
 
-        if request.status == conversations_pb2.HOST_REQUEST_STATUS_ACCEPTED:
+        if request.status == messages_pb2.HOST_REQUEST_STATUS_ACCEPTED:
             # only host can accept
             if context.user_id != host_request.recipient_user_id:
                 context.abort_with_error_code(grpc.StatusCode.PERMISSION_DENIED, "not_the_host")
@@ -633,7 +636,7 @@ def count_host_response(other_user_id: int, response_type: str) -> None:
                 },
             )
 
-        if request.status == conversations_pb2.HOST_REQUEST_STATUS_REJECTED:
+        if request.status == messages_pb2.HOST_REQUEST_STATUS_REJECTED:
             # only host can reject
             if context.user_id != host_request.recipient_user_id:
                 context.abort_with_error_code(grpc.StatusCode.PERMISSION_DENIED, "invalid_host_request_status")
@@ -676,7 +679,7 @@ def count_host_response(other_user_id: int, response_type: str) -> None:
                 },
             )
 
-        if request.status == conversations_pb2.HOST_REQUEST_STATUS_CONFIRMED:
+        if request.status == messages_pb2.HOST_REQUEST_STATUS_CONFIRMED:
             # only surfer can confirm
             if context.user_id != host_request.initiator_user_id:
                 context.abort_with_error_code(grpc.StatusCode.PERMISSION_DENIED, "invalid_host_request_status")
@@ -717,7 +720,7 @@ def count_host_response(other_user_id: int, response_type: str) -> None:
                 },
             )
 
-        if request.status == conversations_pb2.HOST_REQUEST_STATUS_CANCELLED:
+        if request.status == messages_pb2.HOST_REQUEST_STATUS_CANCELLED:
             # only surfer can cancel
             if context.user_id != host_request.initiator_user_id:
                 context.abort_with_error_code(grpc.StatusCode.PERMISSION_DENIED, "invalid_host_request_status")

app/backend/src/tests/test_account.py

@@ -22,7 +22,7 @@
     Upload,
     User,
 )
-from couchers.proto import account_pb2, api_pb2, auth_pb2, conversations_pb2, requests_pb2
+from couchers.proto import account_pb2, api_pb2, auth_pb2, messages_pb2, requests_pb2
 from couchers.utils import now, today
 from tests.fixtures.db import generate_user, make_volunteer
 from tests.fixtures.misc import EmailCollector, PushCollector, process_jobs
@@ -1075,7 +1075,7 @@ def test_reminders(db, moderator):
     with requests_session(token) as api:
         api.RespondHostRequest(
             requests_pb2.RespondHostRequestReq(
-                host_request_id=host_request1_id, status=conversations_pb2.HOST_REQUEST_STATUS_ACCEPTED
+                host_request_id=host_request1_id, status=messages_pb2.HOST_REQUEST_STATUS_ACCEPTED
             )
         )
 
@@ -1150,7 +1150,7 @@ def test_confirm_host_request_reminder(db, moderator):
     with requests_session(host_token) as api:
         api.RespondHostRequest(
             requests_pb2.RespondHostRequestReq(
-                host_request_id=host_request_id, status=conversations_pb2.HOST_REQUEST_STATUS_ACCEPTED
+                host_request_id=host_request_id, status=messages_pb2.HOST_REQUEST_STATUS_ACCEPTED
             )
         )
 
@@ -1165,7 +1165,7 @@ def test_confirm_host_request_reminder(db, moderator):
     with requests_session(surfer_token) as api:
         api.RespondHostRequest(
             requests_pb2.RespondHostRequestReq(
-                host_request_id=host_request_id, status=conversations_pb2.HOST_REQUEST_STATUS_CONFIRMED
+                host_request_id=host_request_id, status=messages_pb2.HOST_REQUEST_STATUS_CONFIRMED
             )
         )
 

app/backend/src/tests/test_bg_jobs.py

@@ -53,7 +53,7 @@
     UserBlock,
     Volunteer,
 )
-from couchers.proto import conversations_pb2, requests_pb2
+from couchers.proto import conversations_pb2, messages_pb2, requests_pb2
 from couchers.proto.internal import jobs_pb2
 from couchers.utils import now, today
 from tests.fixtures.db import generate_user, make_friends, make_user_block, make_volunteer
@@ -703,7 +703,7 @@ def test_send_request_notifications_host_request(db, moderator):
         requests.RespondHostRequest(
             requests_pb2.RespondHostRequestReq(
                 host_request_id=host_request_id,
-                status=conversations_pb2.HOST_REQUEST_STATUS_ACCEPTED,
+                status=messages_pb2.HOST_REQUEST_STATUS_ACCEPTED,
                 text="Test request",
             )
         )
@@ -1438,7 +1438,7 @@ def test_send_request_notifications_blocked_users_no_notification(db, moderator)
         requests.RespondHostRequest(
             requests_pb2.RespondHostRequestReq(
                 host_request_id=host_request_id,
-                status=conversations_pb2.HOST_REQUEST_STATUS_ACCEPTED,
+                status=messages_pb2.HOST_REQUEST_STATUS_ACCEPTED,
                 text="Accepting your request",
             )
         )