Skip to content

⚙️ Engine

⬅️ Back | 🏠 Docs Root

The engine module provides the core infrastructure for building and running an aiogram bot with codex-bot.

🧠 The Why

Parametric Assembly

In a large bot, the main router and dispatcher can become cluttered with imports. The engine module solves this by using Parametric Assembly (via RouterBuilder and BotBuilder). This allows you to explicitly control the order of middleware and features without hardcoding them in a single file.

Feature Discovery

The FeatureDiscoveryService automates the registration of features (routers, orchestrators, menu configs, and garbage states). This follows the Django INSTALLED_APPS pattern, making it easy to add or remove features by simply updating a list in your settings.

🔄 The Flow

  1. Discovery: FeatureDiscoveryService scans the installed_features list and imports their handlers.py and feature_setting.py.
  2. Assembly: RouterBuilder collects all Router objects from the discovered features and includes them in the main router.
  3. Configuration: BotBuilder creates the Bot and Dispatcher instances, injecting the discovered features and middlewares in the specified order.
  4. Startup: The bot starts polling, with all features and infrastructure (i18n, throttling, container) ready to handle requests.

🗺️ Module Map

Component Description
📄 Router Builder build_main_router and collect_feature_routers.
📄 Discovery FeatureDiscoveryService for auto-discovery and registration.
📄 Factory BotBuilder for creating Bot and Dispatcher.
📄 Middlewares UserValidation, Throttling, Container, and I18n middlewares.
📄 HTTP Client BaseApiClient with connection pooling.
📄 I18n Compiler compile_locales for Fluent (.ftl) files.

Last Updated: 2025-02-07