chore: use string user_id in Restrictions object

Author: itsoyou

synapse/media/media_repository.py

@@ -319,11 +319,7 @@ async def is_media_visible(
         Verify that media requested for download should be visible to the user making
         the request
         """
-        # Handle both string and UserID types for requester.user
-        if isinstance(requester.user, UserID):
-            requester_user_id_str = requester.user.to_string()
-        else:
-            requester_user_id_str = str(requester.user)  # type: ignore
+        requester_user_id_str = requester.user.to_string()
         if not self.enable_media_restriction:
             return
 
@@ -349,12 +345,8 @@ async def is_media_visible(
                 f"Media requested ('{media_info_object.media_id}') is restricted"
             )
 
-        attachments = media_info_object.attachments.to_dict().get(
-            "org.matrix.msc3911.restrictions", {}
-        )
-        # Safely extract values from the nested structure, handling missing keys
-        attached_event_id = attachments.get("event_id")
-        attached_profile_user_id = attachments.get("profile_user_id")
+        attached_event_id = media_info_object.attachments.event_id
+        attached_profile_user_id = media_info_object.attachments.profile_user_id
 
         if attached_event_id:
             # Check if event is redacted or not. If it is redacted, normal user no

synapse/storage/databases/main/media_repository.py

@@ -74,15 +74,15 @@ class MediaRestrictions:
     """
 
     event_id: Optional[str] = None
-    profile_user_id: Optional[UserID] = None
+    profile_user_id: Optional[str] = None
 
     def to_dict(self) -> dict:
         if self.event_id:
-            return {"org.matrix.msc3911.restrictions": {"event_id": str(self.event_id)}}
+            return {"org.matrix.msc3911.restrictions": {"event_id": self.event_id}}
         if self.profile_user_id:
             return {
                 "org.matrix.msc3911.restrictions": {
-                    "profile_user_id": self.profile_user_id.to_string()
+                    "profile_user_id": self.profile_user_id
                 }
             }
         return {}
@@ -1172,7 +1172,7 @@ async def get_media_restrictions(
         if row:
             event_id = row[0][0]
             # Because the UserID object can be None, the 'to_string()' method may not exist
-            profile_user_id = UserID.from_string(row[0][1]) if row[0][1] else None
+            profile_user_id = row[0][1] if row[0][1] else None
             return MediaRestrictions(event_id=event_id, profile_user_id=profile_user_id)
 
         return None

tests/rest/client/test_media.py

@@ -4594,7 +4594,7 @@ def test_downloading_remote_media_with_restrictions_is_in_database(self) -> None
         )
         assert isinstance(restrictions, MediaRestrictions)
         assert restrictions.profile_user_id is not None
-        assert restrictions.profile_user_id.to_string() == "@bob:example.com"
+        assert restrictions.profile_user_id == "@bob:example.com"
 
     def test_downloading_remote_media_with_no_restrictions_does_not_save_to_db(
         self,

tests/rest/client/test_profile.py

@@ -1013,7 +1013,7 @@ def test_can_attach_media_to_profile_update(self) -> None:
         )
         assert restrictions is not None, str(restrictions)
         assert restrictions.event_id is None
-        assert restrictions.profile_user_id == UserID.from_string(self.user)
+        assert restrictions.profile_user_id == self.user
 
     def test_attaching_nonexistent_local_media_to_profile_fails(self) -> None:
         """
@@ -1274,7 +1274,7 @@ def test_profile_update_with_media_is_copied_and_attached_to_member_events(
         media_info = self.get_success(self.store.get_local_media(mxc_uri.media_id))
         assert media_info is not None
         assert media_info.attachments is not None
-        assert media_info.attachments.profile_user_id == UserID.from_string(self.user)
+        assert media_info.attachments.profile_user_id == self.user
 
         # Check the media was copied and attached to a member event
         events = self.get_success(
@@ -1457,7 +1457,7 @@ def test_profile_update_with_media_is_copied_and_attached_to_member_events(
         media_info = self.get_success(self.store.get_local_media(mxc_uri.media_id))
         assert media_info is not None
         assert media_info.attachments is not None
-        assert media_info.attachments.profile_user_id == UserID.from_string(self.user)
+        assert media_info.attachments.profile_user_id == self.user
 
         # Check the media was copied and attached to a member event
         events = self.get_success(

tests/storage/test_media.py

@@ -45,11 +45,11 @@ def test_store_and_retrieve_media_restrictions_by_event_id(self) -> None:
         assert retrieved_restrictions.profile_user_id is None
 
     def test_store_and_retrieve_media_restrictions_by_profile_user_id(self) -> None:
-        user_id = UserID.from_string("@frank:test")
+        user_id = "@frank:test"
         media_id = random_string(24)
         self.get_success_or_raise(
             self.store.set_media_restricted_to_user_profile(
-                self.server_name, media_id, user_id.to_string()
+                self.server_name, media_id, user_id
             )
         )