Skip to content

🔄 Redis

⬅️ Back | 🏠 Docs Root

The redis module provides robust integration with Redis Streams for background processing and event-driven architecture in the codex-bot framework.

🧠 The Why

Event-Driven Architecture

In a large bot, some actions (e.g., sending notifications, processing payments) should happen in the background without blocking the main Telegram polling loop. Redis Streams provide a reliable way to decouple these actions from the bot's UI logic.

Reliability (Consumer Groups)

The RedisStreamProcessor uses Redis Consumer Groups to ensure that every message is processed at least once. It supports automatic acknowledgment (ACK) and retry scheduling (via RetrySchedulerProtocol), making the system resilient to crashes and network issues.

🔄 The Flow

  1. Production: An external service or another bot feature adds a message to a Redis Stream (e.g., bot_events).
  2. Consumption: RedisStreamProcessor polls the stream using a Consumer Group and reads a batch of messages.
  3. Dispatching: BotRedisDispatcher receives the message and finds the appropriate handler based on the type field in the payload.
  4. Execution: The handler (e.g., on_booking_confirmed) is called with the project's DI-container.
  5. Acknowledgment: If the handler succeeds, the processor sends an XACK to Redis. If it fails, the message is rescheduled for retry.

🗺️ Module Map

Component Description
📄 API Reference Technical details for RedisRouter and BotRedisDispatcher.
📄 Stream Processor Redis Stream polling loop (Consumer Group).
📄 Dispatcher Redis Stream message dispatcher for the bot.
📄 Protocols RetrySchedulerProtocol and StreamStorageProtocol.

Last Updated: 2025-02-07