Improve rate-limiting experience

Author: NMertsch

prod-config.toml

@@ -66,4 +66,4 @@ required_role = "Organisers"
 
 [animals]
 channel_name = "animal-appreciation"
-cooldown_seconds = 10
+cooldown_seconds = 30

src/europython_discord/animals/cog.py

@@ -53,7 +53,11 @@ async def post_animal_picture(self, animal: str, ctx: commands.Context) -> None:
             await ctx.send(f"This command can only be used in {channel.mention}.")
             return
         if self._rate_limiter.is_rate_limited(ctx.author.id):
-            await ctx.send("You are being rate limited. Please try again later.")
+            seconds_to_cooldown = self._rate_limiter.get_seconds_until_cooldown(ctx.author.id)
+            await ctx.send(
+                f"Sorry, you are being rate-limited. "
+                f"Try again in {seconds_to_cooldown:.0f} seconds."
+            )
             return
 
         provider = random.choice(self._providers[animal])  # noqa: S311 suspicious-non-cryptographic-random-usage
@@ -71,7 +75,6 @@ async def post_animal_picture(self, animal: str, ctx: commands.Context) -> None:
                     f"Failed to fetch {animal} picture. "
                     f"If this happens repeatedly, please report it."
                 ),
-                ephemeral=True,
             )
             return
 

src/europython_discord/animals/rate_limiter.py

@@ -15,6 +15,11 @@ def is_rate_limited(self, user_id: int) -> bool:
         timeout_end = last_usage + self._cooldown_seconds
         return self.get_current_timestamp() < timeout_end
 
+    def get_seconds_until_cooldown(self, user_id: int) -> float:
+        last_usage = self._last_usage_by_user_id.get(user_id, 0)
+        timeout_end = last_usage + self._cooldown_seconds
+        return max(0, timeout_end - self.get_current_timestamp())
+
     def register_usage(self, user_id: int) -> None:
         self._last_usage_by_user_id[user_id] = self.get_current_timestamp()
 

tests/animals/test_cog.py

@@ -94,12 +94,12 @@ async def test_rate_limiting() -> None:
     ctx_1.send.assert_awaited_once()
     assert "embed" in ctx_1.send.call_args.kwargs
 
-    # second call with same user - rate limited, ephemeral error message
+    # second call with same user
     ctx_2 = create_fake_context()
     await cog.post_animal_picture(DEFAULT_ANIMAL, ctx=ctx_2)
     ctx_2.send.assert_awaited_once()
     (message,) = ctx_2.send.call_args.args
-    assert message == "You are being rate limited. Please try again later."
+    assert message == "Sorry, you are being rate-limited. Try again in 10 seconds."
 
 
 async def test_rate_limiting_different_user() -> None:
@@ -163,4 +163,3 @@ async def generate_image(self) -> AnimalImage | None:
     assert message == (
         f"Failed to fetch {DEFAULT_ANIMAL} picture. If this happens repeatedly, please report it."
     )
-    assert ctx.send.call_args.kwargs.get("ephemeral") is True