feat: Added the ability to use Redis as an FSM state store

Signed-off-by: rin-gil <91410075+rin-gil@users.noreply.github.com>

Author: iRingil

README.md

@@ -24,6 +24,9 @@
     <a href="https://pypi.org/project/numpy/1.25.2/">
         <img src="https://img.shields.io/badge/numpy-v1.25.2-informational" alt="numpy version">
     </a>
+    <a href="https://pypi.org/project/redis/4.6.0/">
+        <img src="https://img.shields.io/badge/redis-v4.6.0-informational" alt="redis version">
+    </a>
     <a href="https://pypi.org/project/yt-dlp/22023.7.6/">
         <img src="https://img.shields.io/badge/yt_dlp-v2023.7.6-informational" alt="yt-dlp version">
     </a>

README.ru.md

@@ -24,6 +24,9 @@
     <a href="https://pypi.org/project/numpy/1.25.2/">
         <img src="https://img.shields.io/badge/numpy-v1.25.2-informational" alt="numpy version">
     </a>
+    <a href="https://pypi.org/project/redis/4.6.0/">
+        <img src="https://img.shields.io/badge/redis-v4.6.0-informational" alt="redis version">
+    </a>
     <a href="https://pypi.org/project/yt-dlp/22023.7.6/">
         <img src="https://img.shields.io/badge/yt_dlp-v2023.7.6-informational" alt="yt-dlp version">
     </a>

README.ua.md

@@ -24,6 +24,9 @@
     <a href="https://pypi.org/project/numpy/1.25.2/">
         <img src="https://img.shields.io/badge/numpy-v1.25.2-informational" alt="numpy version">
     </a>
+    <a href="https://pypi.org/project/redis/4.6.0/">
+        <img src="https://img.shields.io/badge/redis-v4.6.0-informational" alt="redis version">
+    </a>
     <a href="https://pypi.org/project/yt-dlp/22023.7.6/">
         <img src="https://img.shields.io/badge/yt_dlp-v2023.7.6-informational" alt="yt-dlp version">
     </a>

src/.env.example

@@ -9,9 +9,15 @@ POSTGRES_DB_NAME=
 POSTGRES_DB_USER=
 POSTGRES_DB_PASSWORD=
 
+# Redis database
+REDIS_HOST=
+REDIS_PORT=
+REDIS_DB_INDEX=
+REDIS_DB_PASS=
+
 # Webhook credentials
 WEBHOOK_HOST=
 WEBHOOK_PATH=
 WEBHOOK_TOKEN=
-WEBAPP_HOST=
-WEBAPP_PORT=
+APP_HOST=
+APP_PORT=

src/bot.py

@@ -4,6 +4,7 @@
 
 from aiogram import Bot, Dispatcher
 from aiogram.contrib.fsm_storage.memory import MemoryStorage
+from aiogram.contrib.fsm_storage.redis import RedisStorage2
 from aiogram.utils.executor import start_polling, start_webhook
 from aiohttp import ClientSession
 
@@ -67,7 +68,18 @@ def start_bot() -> None:
     """Starts the bot"""
     config: Config = load_config()
     bot: Bot = Bot(token=config.tg_bot.token, parse_mode="HTML")
-    dp: Dispatcher = Dispatcher(bot=bot, storage=MemoryStorage())
+    storage: MemoryStorage | RedisStorage2 = (
+        RedisStorage2(
+            host=config.redis.host,
+            port=config.redis.port,
+            db=config.redis.database_index,
+            password=config.redis.password,
+            prefix="ymdb_fsm",
+        )
+        if config.redis
+        else MemoryStorage()
+    )
+    dp: Dispatcher = Dispatcher(bot=bot, storage=storage)
     database: Database = Database(db_config=config.db)
     bot["config"] = config
     bot["db"] = database

src/requirements.txt

@@ -5,4 +5,5 @@ environs==9.5.0
 imageio-ffmpeg==0.4.8
 matplotlib==3.7.2
 numpy==1.25.2
+redis==4.6.0
 yt-dlp==2023.7.6

src/tgbot/config.py

@@ -17,6 +17,15 @@ class DbConfig(NamedTuple):
     database: str
 
 
+class RedisConfig(NamedTuple):
+    """Redis database configuration"""
+
+    host: str
+    port: int
+    database_index: int
+    password: str
+
+
 class WebhookCredentials(NamedTuple):
     """Represents credentials to use webhook"""
 
@@ -39,12 +48,16 @@ class Config(NamedTuple):
 
     tg_bot: TgBot
     db: DbConfig
+    redis: RedisConfig | None
     webhook: WebhookCredentials | None
 
 
 # Change USE_WEBHOOK to True to use a webhook instead of long polling
 USE_WEBHOOK: bool = False
 
+# Change USE_REDIS to True to use redis storage for FSM instead of memory
+USE_REDIS: bool = False
+
 _BASE_DIR: Path = Path(__file__).resolve().parent.parent
 LOCALES_DIR: str = normpath(join(_BASE_DIR, "tgbot/locales"))
 TEMP_DIR: str = normpath(join(_BASE_DIR, "tgbot/temp"))
@@ -71,11 +84,25 @@ def load_config() -> Config:
             user=env.str("POSTGRES_DB_USER"),
             database=env.str("POSTGRES_DB_NAME"),
         ),
-        webhook=WebhookCredentials(
-            wh_host=env.str("WEBHOOK_HOST"),
-            wh_path=env.str("WEBHOOK_PATH"),
-            wh_token=env.str("WEBHOOK_TOKEN"),
-            app_host=env.str("APP_HOST"),
-            app_port=env.int("APP_PORT"),
-        ) if USE_WEBHOOK else None
+        redis=(
+            RedisConfig(
+                host=env.str("REDIS_HOST"),
+                port=env.int("REDIS_PORT"),
+                database_index=env.int("REDIS_DB_INDEX"),
+                password=env.str("REDIS_DB_PASS"),
+            )
+            if USE_REDIS
+            else None
+        ),
+        webhook=(
+            WebhookCredentials(
+                wh_host=env.str("WEBHOOK_HOST"),
+                wh_path=env.str("WEBHOOK_PATH"),
+                wh_token=env.str("WEBHOOK_TOKEN"),
+                app_host=env.str("APP_HOST"),
+                app_port=env.int("APP_PORT"),
+            )
+            if USE_WEBHOOK
+            else None
+        ),
     )