royalty 0.1.1

Ecosystem of libraries and tools designed to bring both performance and productivity to backend development, AI systems, data engineering, and distributed systems in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

//! Server execution module.
//!
//! Provides functions to run an Axum server with database connectivity
//! and optional automatic migrations.
//!
//! ## Functions
//!
//! - [`run`] - Run server without migrations
//! - [`run_with_migrator`] - Run server with optional migrations
//!
//! ## Example
//!
//! ```rust,ignore
//! use royalty::server::run_with_migrator;
//! use axum::Router;
//!
//! run_with_migrator::<Migrator, _>(|ctx| {
//!     Router::new().with_state(ctx.clone())
//! }, true).await?;
//! ```

use crate::config::AppConfig;
use crate::db;
use axum::Router;
use sea_orm::DatabaseConnection;
use sea_orm_migration::MigratorTrait;

/// Shared context available to all route handlers.
///
/// Contains the application configuration and database connection.
/// Clone this to pass it as Axum state.
#[derive(Clone)]
pub struct FrameworkContext {
    /// Application configuration.
    pub config: AppConfig,
    /// Database connection pool.
    pub db: DatabaseConnection,
}

/// Runs the Axum server without database migrations.
///
/// # Arguments
///
/// * `build_router` - A function that receives a [`FrameworkContext`] and returns a configured [`Router`].
///
/// # Example
///
/// ```rust,ignore
/// use royalty::server::run;
/// use axum::{Router, routing::get};
///
/// run(|ctx| {
///     Router::new()
///         .route("/health", get(|| async { "OK" }))
///         .with_state(ctx.clone())
/// }).await?;
/// ```
pub async fn run<F>(build_router: F) -> anyhow::Result<()>
where
    F: FnOnce(&FrameworkContext) -> Router,
{
    let config = AppConfig::from_env()?;
    let db = db::connect_db(&config).await?;

    let ctx = FrameworkContext {
        config: config.clone(),
        db,
    };

    let app = build_router(&ctx);

    let bind_addr = config.bind_address();
    tracing::info!("Starting server on {}", bind_addr);

    let listener = tokio::net::TcpListener::bind(&bind_addr).await?;
    axum::serve(listener, app).await?;

    Ok(())
}

/// Runs the Axum server with optional database migrations.
///
/// # Arguments
///
/// * `build_router` - A function that receives a [`FrameworkContext`] and returns a configured [`Router`].
/// * `run_migrations` - If `true`, runs pending migrations before starting the server.
///
/// # Type Parameters
///
/// * `M` - A type implementing [`MigratorTrait`] from SeaORM.
///
/// # Example
///
/// ```rust,ignore
/// use royalty::server::run_with_migrator;
/// use axum::{Router, routing::get};
///
/// run_with_migrator::<Migrator, _>(|ctx| {
///     Router::new()
///         .route("/health", get(|| async { "OK" }))
///         .with_state(ctx.clone())
/// }, true).await?;
/// ```
pub async fn run_with_migrator<M, F>(build_router: F, run_migrations: bool) -> anyhow::Result<()>
where
    M: MigratorTrait,
    F: FnOnce(&FrameworkContext) -> Router,
{
    let config = AppConfig::from_env()?;
    let db = db::connect_db(&config).await?;

    if run_migrations {
        tracing::info!("Running database migrations...");
        M::up(&db, None).await?;
        tracing::info!("Migrations completed successfully");
    }

    let ctx = FrameworkContext {
        config: config.clone(),
        db,
    };

    let app = build_router(&ctx);

    let bind_addr = config.bind_address();
    tracing::info!("Starting server on {}", bind_addr);

    let listener = tokio::net::TcpListener::bind(&bind_addr).await?;
    axum::serve(listener, app).await?;

    Ok(())
}