♻️ (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:
Manuel Cillero 2026-10-12 21:41:01 +02:00
parent 8a7a827259
commit 728a5c83dc
32 changed files with 918 additions and 488 deletions

View file

@ -1,4 +1,4 @@
//! Opciones de configuración del tema.
//! Ajustes de configuración de `pagetop-bootsier`.
//!
//! Ejemplo:
//!
@ -13,46 +13,46 @@
//! # use pagetop::prelude::*;
//! use pagetop_bootsier::config;
//!
//! assert_eq!(config::SETTINGS.bootsier.max_width, UnitValue::Px(1440));
//! assert_eq!(config::SETTINGS.max_width, UnitValue::RelRem(90.0));
//! ```
//!
//! Todas las opciones, con su valor por defecto, se documentan en [`BootsierSettings`].
//!
//! Consulta [`pagetop::config`] para ver cómo PageTop lee los archivos de configuración y aplica
//! los valores a los ajustes.
use pagetop::prelude::*;
use serde::Deserialize;
/// Ajustes de la sección `[bootsier]`, cargados al arrancar la aplicación.
pub static SETTINGS: LazySettings<BootsierSettings> = LazySettings::new();
include_config!(SETTINGS: Settings => [
// [bootsier]
"bootsier.max_width" => "1440px",
// [dev]
"dev.bootsier_static_dir" => "",
]);
/// Ajustes para la sección [`Bootsier`] de [`SETTINGS`].
#[derive(Debug, Deserialize)]
pub struct Settings {
pub bootsier: Bootsier,
pub dev: Dev,
}
/// Sección **`[bootsier]`** de la configuración. Forma parte de [`Settings`].
#[derive(Debug, Deserialize)]
pub struct Bootsier {
/// Sección **`[bootsier]`** de la configuración.
#[settings(section = "bootsier")]
pub struct BootsierSettings {
/// Ancho máximo predeterminado para la página, por ejemplo "100%" o "90rem".
#[default(UnitValue::Px(1440))]
pub max_width: UnitValue,
}
/// Sección **`[dev]`** de la configuración. Forma parte de [`Settings`].
#[derive(Debug, Deserialize)]
pub struct Dev {
/// Directorio raíz de `static/` para servir los archivos estáticos propios de Bootsier.
///
/// Si se indica una ruta válida, absoluta o relativa al directorio del proyecto o del binario
/// en ejecución, los archivos estáticos se servirán desde disco. Útil para poder modificar los
/// archivos estáticos mientras la aplicación está en ejecución, sin necesidad de recompilar.
/// Si se indica una ruta válida, absoluta o relativa al directorio del proyecto (o, al ejecutar
/// el binario, al directorio de trabajo actual), los archivos estáticos se servirán desde
/// disco. Útil durante el desarrollo para poder modificar los archivos estáticos mientras la
/// aplicación está en ejecución, sin necesidad de recompilar.
///
/// Si la cadena está vacía, se ignora este ajuste.
pub bootsier_static_dir: String,
pub static_dir: String,
}
#[cfg(test)]
mod tests {
use super::{BootsierSettings, 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::<BootsierSettings>(REFERENCE).unwrap();
}
}

View file

@ -106,8 +106,12 @@ impl Extension for Bootsier {
Some(&Self)
}
fn settings(&self) -> Option<&'static dyn LoadSettings> {
Some(&config::SETTINGS)
}
fn configure_static_files(&self, router: Router) -> Router {
let base = &config::SETTINGS.dev.bootsier_static_dir;
let base = &config::SETTINGS.static_dir;
let subdir = |s: &str| {
if base.is_empty() {
String::new()

View file

@ -29,9 +29,7 @@ pub(crate) async fn render(
async fn render_standard(cx: &mut Context) -> Markup {
bs::Container::new()
.with_prop(PropsOp::add_classes("container-wrapper"))
.with_width(bs::container::Width::FluidMax(
config::SETTINGS.bootsier.max_width,
))
.with_width(bs::container::Width::FluidMax(config::SETTINGS.max_width))
.with_child(layout::Region::header())
.with_child(layout::Region::aside())
.with_child(layout::Region::default())

View file

@ -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();
}
}

View file

@ -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

View file

@ -1,111 +1,94 @@
//! Configuración de `pagetop-user`.
//! Ajustes de configuración de `pagetop-user`.
//!
//! Todos los valores pueden sobreescribirse en los ficheros TOML de la aplicación:
//! Ejemplo:
//!
//! ```toml
//! [user]
//! allow_registration = false
//!
//! [user.session]
//! secure_cookie = true
//!
//! [user.password]
//! min_length = 10
//! ```
//!
//! Uso:
//!
//! ```rust,no_run
//! use pagetop_user::config;
//!
//! assert_eq!(config::SETTINGS.password.min_length, 10);
//! ```
//!
//! Todas las opciones, con su valor por defecto, se documentan en [`UserSettings`] y sus
//! subsecciones ([`SessionSettings`], [`PasswordSettings`], [`SeedSettings`] y [`AdminSettings`]).
//!
//! Consulta [`pagetop::config`] para ver cómo PageTop lee los archivos de configuración y aplica
//! los valores a los ajustes.
use pagetop::prelude::*;
use serde::Deserialize;
use std::sync::LazyLock;
/// Ajustes de la sección `[user]`, cargados al arrancar la aplicación.
pub static SETTINGS: LazySettings<UserSettings> = LazySettings::new();
// **< CONFIG_USER >********************************************************************************
include_config!(CONFIG_USER: UserTopConfig => [
// Política de registro y verificación.
"user.allow_registration" => true,
"user.require_email_verification" => false,
// Sesiones.
"user.session.cookie_name" => "pagetop",
"user.session.secure_cookie" => false,
"user.session.idle_secs" => 7_200_i64, // 2 horas
"user.session.remember_idle_secs" => 1_209_600_i64, // 14 días
"user.session.write_interval_secs" => 60_i64, // 1 minuto
// Anti-fuerza-bruta.
"user.max_failed_logins" => 5_i32,
"user.failed_login_window_secs" => 900_i64, // 15 min
"user.locked_for_secs" => 600_i64, // 10 min
// Contraseñas (Argon2id).
"user.password.argon2_m_cost" => 19456_u32,
"user.password.argon2_t_cost" => 2_u32,
"user.password.argon2_p_cost" => 1_u32,
"user.password.min_length" => 8_u64,
// Semilla del primer administrador.
"user.seed.admin_username" => "admin",
"user.seed.admin_email" => "admin@example.com",
// Listados de administración (usuarios, roles...).
"user.admin.list_page_size" => 20_u64,
// Modo de login.
"user.login_strict" => false,
]);
// **< UserTopConfig >******************************************************************************
/// Estructura raíz para la sección `[user]` del fichero de configuración.
#[derive(Clone, Debug, Deserialize)]
pub struct UserTopConfig {
pub user: Settings,
}
// **< SETTINGS >***********************************************************************************
/// Acceso directo a los ajustes de `pagetop-user` (alias de `CONFIG_USER.user`).
pub static SETTINGS: LazyLock<Settings> = LazyLock::new(|| CONFIG_USER.user.clone());
// **< Settings >***********************************************************************************
/// Ajustes de la extensión `pagetop-user`, accesibles en la sección `[user]` del TOML.
#[derive(Clone, Debug, Deserialize)]
pub struct Settings {
// Política de registro y verificación.
/// Sección **`[user]`** de la configuración.
#[settings(section = "user")]
pub struct UserSettings {
/// Permite que los visitantes creen su propia cuenta.
#[default = true]
pub allow_registration: bool,
/// Las cuentas nuevas quedan pendientes (*"Pending"*) en lugar de activas hasta verificar el
/// correo.
#[default = false]
pub require_email_verification: bool,
// Anti-fuerza-bruta.
/// Intentos fallidos de acceso antes de bloquear la cuenta.
#[default = 5]
pub max_failed_logins: i32,
/// Ventana de recuento de intentos fallidos, en segundos. Reservada: todavía no tiene efecto.
#[default = 900]
pub failed_login_window_secs: i64,
/// Duración del bloqueo de la cuenta, en segundos.
#[default = 600]
pub locked_for_secs: i64,
// Sesiones.
pub session: SessionConfig,
/// Sesiones, en la subsección `[user.session]`.
pub session: SessionSettings,
// Contraseñas.
pub password: PasswordConfig,
/// Contraseñas, en la subsección `[user.password]`.
pub password: PasswordSettings,
// Semilla del primer administrador.
pub seed: SeedConfig,
/// Primer administrador, en la subsección `[user.seed]`.
pub seed: SeedSettings,
// Listados de administración.
pub admin: AdminConfig,
/// Listados de administración, en la subsección `[user.admin]`.
pub admin: AdminSettings,
/// Activa las medidas para dificultar que el navegador recuerde o autorrellene las
/// credenciales en la pantalla de login (gestor de contraseñas, autocompletado agresivo...).
#[default = false]
pub login_strict: bool,
}
/// Ajustes de la sección `[user.session]`.
#[derive(Clone, Debug, Deserialize)]
pub struct SessionConfig {
/// Subsección **`[user.session]`** de la configuración.
#[settings]
pub struct SessionSettings {
/// Nombre de la cookie de sesión.
#[default = "pagetop"]
pub cookie_name: String,
/// Marca la cookie de sesión como `Secure` (sólo HTTPS). Debe activarse en producción.
#[default = false]
pub secure_cookie: bool,
/// Segundos sin uso tras los que caduca una sesión iniciada sin "recordarme". El tiempo se
/// cuenta desde la última petición, con la precisión que fija
/// [`write_interval_secs`](Self::write_interval_secs).
#[default = 7_200]
pub idle_secs: i64,
/// Segundos sin uso tras los que caduca una sesión iniciada con "recordarme". El tiempo se
/// cuenta desde la última petición, con la precisión que fija
/// [`write_interval_secs`](Self::write_interval_secs).
#[default = 1_209_600]
pub remember_idle_secs: i64,
/// Segundos mínimos entre dos actualizaciones de la misma sesión en la base de datos.
///
@ -115,7 +98,7 @@ pub struct SessionConfig {
/// en [`idle_secs`](Self::idle_secs) y [`remember_idle_secs`](Self::remember_idle_secs). Con
/// `0` se escribe en cada petición.
///
/// El valor por defecto (60) sirve para la mayoría de aplicaciones. Conviene cambiarlo:
/// El valor por defecto sirve para la mayoría de aplicaciones. Conviene cambiarlo:
///
/// - **Al alza** (p. ej. 180, como Drupal) si hay muchos usuarios simultáneos o la base de
/// datos es remota o lenta, para reducir las escrituras.
@ -123,30 +106,51 @@ pub struct SessionConfig {
/// adelanto no es aceptable.
///
/// Debe ser siempre muy inferior a `idle_secs`.
#[default = 60]
pub write_interval_secs: i64,
}
/// Ajustes de la sección `[user.password]`.
#[derive(Clone, Debug, Deserialize)]
pub struct PasswordConfig {
/// Subsección **`[user.password]`** de la configuración.
///
/// Las contraseñas se cifran con Argon2id.
#[settings]
pub struct PasswordSettings {
/// Coste de memoria de Argon2id, en KiB. Si cambia, las contraseñas se vuelven a cifrar en el
/// siguiente acceso de cada usuario.
#[default = 19_456]
pub argon2_m_cost: u32,
/// Coste de tiempo de Argon2id (número de iteraciones).
#[default = 2]
pub argon2_t_cost: u32,
/// Grado de paralelismo de Argon2id (número de hilos).
#[default = 1]
pub argon2_p_cost: u32,
/// Longitud mínima de las contraseñas.
#[default = 8]
pub min_length: usize,
}
/// Ajustes de la sección `[user.seed]`.
#[derive(Clone, Debug, Deserialize)]
pub struct SeedConfig {
/// Subsección **`[user.seed]`** de la configuración.
///
/// El primer administrador, que se crea si no existe ningún usuario.
#[settings]
pub struct SeedSettings {
/// Nombre de usuario del primer administrador.
#[default = "admin"]
pub admin_username: String,
/// Correo electrónico del primer administrador.
#[default = "admin@example.com"]
pub admin_email: String,
/// Contraseña del primer administrador. Sin valor, se genera una aleatoria y se muestra una
/// sola vez por la salida estándar al crearlo.
pub admin_password: Option<String>,
}
/// Ajustes de la sección `[user.admin]`.
#[derive(Clone, Debug, Deserialize)]
pub struct AdminConfig {
/// Subsección **`[user.admin]`** de la configuración.
#[settings]
pub struct AdminSettings {
/// Número de filas por página en los listados de administración (usuarios, roles...).
#[default = 20]
pub list_page_size: u64,
}
@ -163,3 +167,17 @@ pub(crate) fn user_language_applies() -> bool {
pub(crate) fn user_timezone_applies() -> bool {
global::SETTINGS.app.timezone_per_user
}
#[cfg(test)]
mod tests {
use super::{UserSettings, 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::<UserSettings>(REFERENCE).unwrap();
}
}

View file

@ -216,6 +216,10 @@ impl Extension for User {
Lc::t("extension_description", &LOCALES_USER)
}
fn settings(&self) -> Option<&'static dyn LoadSettings> {
Some(&config::SETTINGS)
}
fn dependencies(&self) -> Vec<ExtensionRef> {
vec![
&pagetop_admin::Admin,