♻️ (config): Ajustes con #[settings] al arrancar
- Nuevo atributo `#[settings]`: valores por defecto en los campos (tipos comprobados al compilar y documentados); claves desconocidas y valores no válidos rechazados. Sustituye a `include_config!`, que se elimina. - `LazySettings<T>::new()` declara los ajustes de una sección, y `Extension::settings()` los carga al arrancar, en orden; un error de configuración o una sección reclamada dos veces detiene el arranque. - Aviso de secciones que no corresponden a ninguna extensión. - Bootsier: [dev] bootsier_static_dir pasa a [bootsier] static_dir.
This commit is contained in:
parent
8a7a827259
commit
728a5c83dc
32 changed files with 918 additions and 488 deletions
|
|
@ -1,4 +1,4 @@
|
|||
//! Opciones de configuración de la extensión.
|
||||
//! Ajustes de configuración de `pagetop-seaorm`.
|
||||
//!
|
||||
//! Ejemplo:
|
||||
//!
|
||||
|
|
@ -16,10 +16,13 @@
|
|||
//! Uso:
|
||||
//!
|
||||
//! ```rust
|
||||
//! # use pagetop_seaorm::config;
|
||||
//! assert_eq!(config::SETTINGS.database.db_host, "localhost");
|
||||
//! use pagetop_seaorm::config;
|
||||
//!
|
||||
//! assert_eq!(config::SETTINGS.db_host, "localhost");
|
||||
//! ```
|
||||
//!
|
||||
//! Todas las opciones, con su valor por defecto, se documentan en [`DatabaseSettings`].
|
||||
//!
|
||||
//! Consulta [`pagetop::config`] para ver cómo PageTop lee los archivos de configuración y aplica
|
||||
//! los valores a los ajustes.
|
||||
|
||||
|
|
@ -27,25 +30,12 @@ use pagetop::prelude::*;
|
|||
|
||||
use serde::Deserialize;
|
||||
|
||||
include_config!(SETTINGS: Settings => [
|
||||
// [database]
|
||||
"database.db_type" => "",
|
||||
"database.db_name" => "",
|
||||
"database.db_user" => "",
|
||||
"database.db_pass" => "",
|
||||
"database.db_host" => "localhost",
|
||||
"database.max_pool_size" => 5,
|
||||
]);
|
||||
/// Ajustes de la sección `[database]`, cargados al arrancar la aplicación.
|
||||
pub static SETTINGS: LazySettings<DatabaseSettings> = LazySettings::new();
|
||||
|
||||
/// Ajustes para la sección [`Database`] de [`SETTINGS`].
|
||||
#[derive(Debug, Deserialize)]
|
||||
pub struct Settings {
|
||||
pub database: Database,
|
||||
}
|
||||
|
||||
/// Sección **`[database]`** de la configuración. Forma parte de [`Settings`].
|
||||
#[derive(Debug, Deserialize)]
|
||||
pub struct Database {
|
||||
/// Sección **`[database]`** de la configuración.
|
||||
#[settings(section = "database")]
|
||||
pub struct DatabaseSettings {
|
||||
/// Motor de base de datos.
|
||||
///
|
||||
/// Valores aceptados: `"mysql"` (también `"mariadb"`), `"postgres"` (también `"postgresql"`) y
|
||||
|
|
@ -58,20 +48,23 @@ pub struct Database {
|
|||
/// Contraseña para la conexión a la base de datos (para mysql/postgres).
|
||||
pub db_pass: String,
|
||||
/// Servidor de conexión a la base de datos (para mysql/postgres).
|
||||
#[default = "localhost"]
|
||||
pub db_host: String,
|
||||
/// Puerto de conexión a la base de datos (para mysql/postgres). Si se omite, se usa el puerto
|
||||
/// predeterminado para el motor: 3306 para MySQL y 5432 para PostgreSQL.
|
||||
pub db_port: Option<u16>,
|
||||
/// Número máximo de conexiones habilitadas.
|
||||
#[default = 5]
|
||||
pub max_pool_size: u32,
|
||||
}
|
||||
|
||||
/// Motor de base de datos. Usado en el campo [`Database::db_type`] de [`SETTINGS`].
|
||||
#[derive(Clone, Copy, Debug, Deserialize)]
|
||||
/// Motor de base de datos. Usado en [`DatabaseSettings::db_type`].
|
||||
#[derive(AutoDefault, Clone, Copy, Debug, Deserialize)]
|
||||
#[serde(rename_all = "lowercase")]
|
||||
pub enum DbType {
|
||||
/// Valor por defecto cuando `db_type` no está configurado. En este caso la aplicación terminará
|
||||
/// con un error al arrancar.
|
||||
#[default]
|
||||
#[serde(rename = "")]
|
||||
Unset,
|
||||
/// Usa el motor MySQL. Acepta también el alias `"mariadb"`.
|
||||
|
|
@ -83,3 +76,17 @@ pub enum DbType {
|
|||
/// Usa el motor SQLite.
|
||||
Sqlite,
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::{DatabaseSettings, config};
|
||||
|
||||
// `reference.toml` documents every option; with unknown keys rejected, loading it proves that
|
||||
// it only documents keys that exist, with values of the right type.
|
||||
const REFERENCE: &str = include_str!("../../../config/reference.toml");
|
||||
|
||||
#[test]
|
||||
fn reference_toml_documents_only_existing_keys() {
|
||||
config::load_from_str::<DatabaseSettings>(REFERENCE).unwrap();
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -202,19 +202,23 @@ impl Extension for SeaORM {
|
|||
Lc::t("extension_description", &LOCALES_SEAORM)
|
||||
}
|
||||
|
||||
fn settings(&self) -> Option<&'static dyn LoadSettings> {
|
||||
Some(&config::SETTINGS)
|
||||
}
|
||||
|
||||
async fn initialize(&self) {
|
||||
trace::info!(
|
||||
"Connecting to database \"{}\" using a pool of {} connections",
|
||||
&config::SETTINGS.database.db_name,
|
||||
&config::SETTINGS.database.max_pool_size
|
||||
&config::SETTINGS.db_name,
|
||||
&config::SETTINGS.max_pool_size
|
||||
);
|
||||
|
||||
let db_uri: String = match config::SETTINGS.database.db_type {
|
||||
let db_uri: String = match config::SETTINGS.db_type {
|
||||
config::DbType::Unset => panic!(
|
||||
"database.db_type is not configured: use \"mysql\", \"postgres\" or \"sqlite\""
|
||||
),
|
||||
config::DbType::Mysql | config::DbType::Postgres => {
|
||||
let scheme = if matches!(config::SETTINGS.database.db_type, config::DbType::Mysql) {
|
||||
let scheme = if matches!(config::SETTINGS.db_type, config::DbType::Mysql) {
|
||||
"mysql"
|
||||
} else {
|
||||
"postgres"
|
||||
|
|
@ -222,18 +226,18 @@ impl Extension for SeaORM {
|
|||
let mut tmp_uri = Url::parse(&format!(
|
||||
"{}://{}/{}",
|
||||
scheme,
|
||||
&config::SETTINGS.database.db_host,
|
||||
&config::SETTINGS.database.db_name
|
||||
&config::SETTINGS.db_host,
|
||||
&config::SETTINGS.db_name
|
||||
))
|
||||
.expect("Invalid database URL: check db_host and db_name in config");
|
||||
tmp_uri
|
||||
.set_username(config::SETTINGS.database.db_user.as_str())
|
||||
.set_username(config::SETTINGS.db_user.as_str())
|
||||
.expect("Failed to set db_user in connection URL");
|
||||
tmp_uri
|
||||
// https://github.com/launchbadge/sqlx/issues/1624
|
||||
.set_password(Some(config::SETTINGS.database.db_pass.as_str()))
|
||||
.set_password(Some(config::SETTINGS.db_pass.as_str()))
|
||||
.expect("Failed to set db_pass in connection URL");
|
||||
if let Some(port) = config::SETTINGS.database.db_port {
|
||||
if let Some(port) = config::SETTINGS.db_port {
|
||||
tmp_uri
|
||||
.set_port(Some(port))
|
||||
.expect("Failed to set db_port in connection URL");
|
||||
|
|
@ -241,13 +245,13 @@ impl Extension for SeaORM {
|
|||
tmp_uri.to_string()
|
||||
}
|
||||
config::DbType::Sqlite => {
|
||||
format!("sqlite://{}", &config::SETTINGS.database.db_name)
|
||||
format!("sqlite://{}", &config::SETTINGS.db_name)
|
||||
}
|
||||
};
|
||||
|
||||
let conn = Database::connect::<ConnectOptions>({
|
||||
let mut db_opt = ConnectOptions::new(db_uri);
|
||||
db_opt.max_connections(config::SETTINGS.database.max_pool_size);
|
||||
db_opt.max_connections(config::SETTINGS.max_pool_size);
|
||||
db_opt
|
||||
})
|
||||
.await
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue