Add get_media_upload_limits_for_user and on_media_upload_limit_exceeded callbacks to module API

synapse/module_api/callbacks/media_repository_callbacks.py

@@ -118,6 +118,10 @@ async def is_user_allowed_to_upload_media_of_size(
     async def get_media_upload_limits_for_user(
         self, user_id: str
     ) -> Optional[List[MediaUploadLimit]]:
+        """
+        Get the the first non-None list of MediaUploadLimits for the user from the registered callbacks.
+        If a list is returned it will be sorted in descending order of duration.
+        """
         for callback in self._get_media_upload_limits_for_user_callbacks:
             with Measure(
                 self.clock,
@@ -128,6 +132,8 @@ async def get_media_upload_limits_for_user(
                     callback(user_id)
                 )
             if res is not None:  # to allow [] to be returned meaning no limit
+                # We sort them in descending order of time period
+                res.sort(key=lambda limit: limit.time_period_ms, reverse=True)
                 return res
 
         return None

tests/rest/client/test_media.py

@@ -3015,6 +3015,7 @@ async def _get_media_upload_limits_for_user(
     ) -> Optional[List[MediaUploadLimit]]:
         # user1 has custom limits
         if user_id == self.user1:
+            # n.b. we return these in increasing duration order and Synapse will need to sort them correctly
             return [
                 MediaUploadLimit(
                     time_period_ms=Config.parse_duration("1d"), max_bytes=5000
@@ -3114,6 +3115,23 @@ def test_uses_custom_limit(self) -> None:
         self.assertEqual(self.last_media_upload_limit_exceeded["sent_bytes"], 3000)
         self.assertEqual(self.last_media_upload_limit_exceeded["attempted_bytes"], 4000)
 
+        # User 1 attempts to upload 20000 bytes which is over the weekly limit
+        # This tests that the limits have been sorted as expected
+        channel = self.upload_media(20000, self.tok1)
+        self.assertEqual(channel.code, 400)
+        assert self.last_media_upload_limit_exceeded is not None
+        self.assertEqual(self.last_media_upload_limit_exceeded["user_id"], self.user1)
+        self.assertEqual(
+            self.last_media_upload_limit_exceeded["limit"],
+            MediaUploadLimit(
+                max_bytes=15000, time_period_ms=Config.parse_duration("1w")
+            ),
+        )
+        self.assertEqual(self.last_media_upload_limit_exceeded["sent_bytes"], 3000)
+        self.assertEqual(
+            self.last_media_upload_limit_exceeded["attempted_bytes"], 20000
+        )
+
     def test_uses_unlimited(self) -> None:
         """Test that unlimited user is not limited when module returns []."""
         # User 2 uploads 10000 bytes which is over the default limit