Merge pull request #27 from Marvel-Discord/feat/migrate-newschannelping-to-redis

Stage 1: migrate newschannelsping from Postgres to Redis

Author: Rocked03

.env.example

@@ -11,6 +11,9 @@ POSTGRES_PORT=5432
 GLOBAL_SLASHIES=True
 DATABASE_LISTENER_LOGS=True
 
+# Redis
+REDIS_URL=redis://redis:6379/0
+
 # Server and Channel IDs
 HOMESERVER=
 NEWSCHANNELS=1028517433637605406

.gitignore

@@ -4,3 +4,6 @@ betatesting.py
 __pycache__/
 .idea/*
 .env
+.venv/
+.pytest_cache/
+.superpowers/

Pipfile

@@ -12,8 +12,12 @@ aiohttp = "~=3.14.3"
 natsort = "~=8.3.1"
 beautifulsoup4 = "~=4.12.3"
 tmdbsimple = "~=2.9.1"
+redis = ">=5.0.0"
 
 [dev-packages]
+pytest = ">=8.0.0"
+pytest-asyncio = ">=0.23.0"
+fakeredis = ">=2.20.0"
 
 [requires]
 python_version = "3.12"

cogs/news.py

@@ -187,50 +187,55 @@ async def send_news_ping(self, message):
                 f"*{t}*" for t in titles
             )
 
-            channelinfo = await self.bot.db.fetchrow(
-                "SELECT * FROM newschannelsping WHERE channel_id = $1", channel.id
-            )
-            if channelinfo:
-                if channelinfo["latest_message_id"]:
-                    try:
-                        oldmsg = await channel.fetch_message(
-                            channelinfo["latest_message_id"]
-                        )
-                    except NotFound:
-                        pass
+            key = f"jocasta:bot:newschannelsping:{channel.id}"
+            latest_message_id = None
+            if self.bot.redis:
+                try:
+                    latest_message_id = await self.bot.redis.get(key)
+                except Exception as e:
+                    print(f"[News] Failed to read from Redis: {e}")
+
+            if latest_message_id:
+                try:
+                    oldmsg = await channel.fetch_message(int(latest_message_id))
+                except NotFound:
+                    pass
+                except ValueError:
+                    print(
+                        f"[News] Invalid message_id in Redis for channel "
+                        f"{channel.id}: {latest_message_id!r}"
+                    )
+                except Exception as e:
+                    print(f"[News] Failed to fetch old message: {e}")
+                else:
+                    if (
+                        discord.utils.utcnow() - oldmsg.created_at
+                    ).total_seconds() >= newspingbuffertime:
+                        await oldmsg.delete()
                     else:
-                        if (
-                            discord.utils.utcnow() - oldmsg.created_at
-                        ).total_seconds() >= newspingbuffertime:
-                            await oldmsg.delete()
-                        else:
-                            current = [
-                                i.strip("*")
-                                for i in oldmsg.content.replace(
-                                    f"{self.newsrole.mention} ", ""
-                                ).split("\n")
-                            ]
-                            for t in titles:
-                                if t not in current:
-                                    current.append(t)
-                            new = formatmsg(self.newsrole.mention, current)
-                            await oldmsg.edit(content=new)
-                            return
-            else:
-                await self.bot.db.execute(
-                    "INSERT INTO newschannelsping (channel_id) VALUES ($1)", channel.id
-                )
+                        current = [
+                            i.strip("*")
+                            for i in oldmsg.content.replace(
+                                f"{self.newsrole.mention} ", ""
+                            ).split("\n")
+                        ]
+                        for t in titles:
+                            if t not in current:
+                                current.append(t)
+                        new = formatmsg(self.newsrole.mention, current)
+                        await oldmsg.edit(content=new)
+                        return
 
             msg = await channel.send(
                 formatmsg(self.newsrole.mention, titles),
                 view=self.PingRoleView(self.newsrole, "Add/Remove Ping Role"),
             )
 
-            await self.bot.db.execute(
-                "UPDATE newschannelsping SET latest_message_id = $2 WHERE channel_id = $1",
-                channel.id,
-                msg.id,
-            )
+            if self.bot.redis:
+                try:
+                    await self.bot.redis.set(key, str(msg.id))
+                except Exception as e:
+                    print(f"[News] Failed to write to Redis: {e}")
 
     @commands.Cog.listener()
     async def on_member_join(self, member):

config.py

@@ -13,6 +13,7 @@
     "host": os.getenv("POSTGRES_HOST"),
     "port": int(os.getenv("POSTGRES_PORT", 5432)),
 }
+redis_url = os.getenv("REDIS_URL", "redis://localhost:6379/0")
 global_slashies = os.getenv("GLOBAL_SLASHIES", "False").lower() == "true"
 database_listener_logs = os.getenv("DATABASE_LISTENER_LOGS", "True").lower() == "true"
 

docker-compose.yml

@@ -8,3 +8,12 @@ services:
     volumes:
       - .:/app
     command: python main.py
+    depends_on:
+      - redis
+  redis:
+    image: redis:7-alpine
+    restart: unless-stopped
+    volumes:
+      - redis-data:/data
+volumes:
+  redis-data:

funcs/redis.py

@@ -0,0 +1,32 @@
+import redis.asyncio as redis
+from discord.ext import commands
+
+from config import *
+
+
+class RedisCog(commands.Cog, name="Redis"):
+    """Manages the bot's Redis connection and exposes it as `bot.redis`.
+
+    On failure to connect, `bot.redis` is set to None — cogs that use it
+    must handle this case (graceful degradation).
+    """
+
+    def __init__(self, bot):
+        self.bot = bot
+
+    async def cog_load(self):
+        self.bot.redis = redis.from_url(redis_url, decode_responses=True)
+        try:
+            await self.bot.redis.ping()
+            print("Connected to Redis")
+        except Exception as e:
+            print(f"Failed to connect to Redis: {e}")
+            self.bot.redis = None
+
+    async def cog_unload(self):
+        if self.bot.redis:
+            await self.bot.redis.aclose()
+
+
+async def setup(bot):
+    await bot.add_cog(RedisCog(bot))

main.py

@@ -8,6 +8,7 @@ class Jocasta(commands.Bot):
     async def setup_hook(self):
         initial_extensions = [
             "funcs.postgresql",
+            "funcs.redis",
             "cogs.owner",
             "cogs.polls",
             "cogs.time",

pytest.ini

@@ -0,0 +1,6 @@
+[pytest]
+asyncio_mode = auto
+testpaths = tests
+python_files = test_*.py
+python_classes = Test*
+python_functions = test_*

requirements.txt

@@ -6,3 +6,7 @@ aiohttp>=3.13.3
 natsort~=8.3.1
 beautifulsoup4~=4.12.3
 tmdbsimple~=2.9.1
+redis>=5.0.0
+pytest>=8.0.0
+pytest-asyncio>=0.23.0
+fakeredis>=2.20.0