Añade ComponentError con HTML alternativo

`prepare_component()` ahora devuelve `Result<Markup, ComponentError>` en
lugar de `Markup`, para que los componentes señalen fallos durante el
renderizado de forma explícita.

`ComponentError` encapsula un mensaje de error y un marcado HTML
alternativo opcional (`fallback`). Si se produce un error, el ciclo de
renderizado registra la traza y muestra el `fallback` en lugar del
componente fallido, sin interrumpir el resto de la página.

Lo mismo aplica a los errores devueltos por la acción `PrepareRender` de
los temas, que siguen el mismo mecanismo.
This commit is contained in:
Manuel Cillero 2026-03-21 13:15:39 +01:00
parent a0b14aec36
commit 34aeeab2d7
26 changed files with 232 additions and 100 deletions

View file

@ -6,7 +6,7 @@ use crate::prelude::*;
/// los componentes.
///
/// Recibe una referencia al componente `component` y una referencia mutable al contexto `cx`.
pub type FnPrepareRender<C> = fn(component: &C, cx: &mut Context) -> Markup;
pub type FnPrepareRender<C> = fn(component: &C, cx: &mut Context) -> Result<Markup, ComponentError>;
/// Ejecuta [`FnPrepareRender`] para preparar el renderizado de un componente.
///
@ -41,23 +41,25 @@ impl<C: Component> PrepareRender<C> {
}
}
/// Despacha las acciones. Se detiene en cuanto una renderiza.
/// Despacha las acciones. Se detiene en cuanto una renderiza o produce un error.
#[inline]
pub(crate) fn dispatch(component: &C, cx: &mut Context) -> Markup {
let mut render_component = html! {};
dispatch_actions(
pub(crate) fn dispatch(component: &C, cx: &mut Context) -> Result<Markup, ComponentError> {
let mut render_result: Result<Markup, ComponentError> = Ok(html! {});
dispatch_actions_until(
&ActionKey::new(
UniqueId::of::<Self>(),
Some(cx.theme().type_id()),
Some(UniqueId::of::<C>()),
None,
),
|action: &Self| {
if render_component.is_empty() {
render_component = (action.f)(component, cx);
|action: &Self| match &render_result {
Ok(markup) if markup.is_empty() => {
render_result = (action.f)(component, cx);
std::ops::ControlFlow::Continue(())
}
_ => std::ops::ControlFlow::Break(()),
},
);
render_component
render_result
}
}

View file

@ -29,23 +29,23 @@ impl Component for Block {
self.alter_classes(ClassesOp::Prepend, "block");
}
fn prepare_component(&self, cx: &mut Context) -> Markup {
fn prepare_component(&self, cx: &mut Context) -> Result<Markup, ComponentError> {
let block_body = self.children().render(cx);
if block_body.is_empty() {
return html! {};
return Ok(html! {});
}
let id = cx.required_id::<Block>(self.id());
html! {
Ok(html! {
div id=(id) class=[self.classes().get()] {
@if let Some(title) = self.title().lookup(cx) {
h2 class="block__title" { span { (title) } }
}
div class="block__body" { (block_body) }
}
}
})
}
}

View file

@ -52,8 +52,8 @@ impl Component for Html {
Self::default()
}
fn prepare_component(&self, cx: &mut Context) -> Markup {
self.html(cx)
fn prepare_component(&self, cx: &mut Context) -> Result<Markup, ComponentError> {
Ok(self.html(cx))
}
}

View file

@ -115,7 +115,7 @@ impl Component for Intro {
));
}
fn prepare_component(&self, cx: &mut Context) -> Markup {
fn prepare_component(&self, cx: &mut Context) -> Result<Markup, ComponentError> {
if *self.opening() == IntroOpening::PageTop {
cx.alter_assets(AssetsOp::AddJavaScript(JavaScript::on_load_async("intro-js", |cx|
util::indoc!(r#"
@ -135,7 +135,7 @@ impl Component for Intro {
)));
}
html! {
Ok(html! {
div class="intro" {
div class="intro-header" {
section class="intro-header__body" {
@ -206,7 +206,7 @@ impl Component for Intro {
}
}
}
}
})
}
}

View file

@ -25,8 +25,8 @@ impl Component for PoweredBy {
PoweredBy { copyright: Some(c) }
}
fn prepare_component(&self, cx: &mut Context) -> Markup {
html! {
fn prepare_component(&self, cx: &mut Context) -> Result<Markup, ComponentError> {
Ok(html! {
div id=[self.id()] class="poweredby" {
@if let Some(c) = self.copyright() {
span class="poweredby__copyright" { (c) "." } " "
@ -35,7 +35,7 @@ impl Component for PoweredBy {
(L10n::l("poweredby_pagetop").with_arg("pagetop_link", LINK).using(cx))
}
}
}
})
}
}

View file

@ -12,7 +12,7 @@ use list::ActionsList;
mod all;
pub(crate) use all::add_action;
pub use all::dispatch_actions;
pub use all::{dispatch_actions, dispatch_actions_until};
/// Facilita la implementación del método [`actions()`](crate::core::extension::Extension::actions).
///

View file

@ -72,3 +72,18 @@ where
list.iter_map(f);
}
}
/// Despacha las funciones asociadas a una [`ActionKey`] con posible salida anticipada.
///
/// Funciona igual que [`dispatch_actions`], pero el *closure* puede devolver
/// [`std::ops::ControlFlow::Continue`] para continuar ejecutando la siguiente acción; o
/// [`std::ops::ControlFlow::Break`] para detener la iteración inmediatamente.
pub fn dispatch_actions_until<A, F>(key: &ActionKey, f: F)
where
A: ActionDispatcher,
F: FnMut(&A) -> std::ops::ControlFlow<()>,
{
if let Some(list) = ACTIONS.read().get(key) {
list.iter_try_map(f);
}
}

View file

@ -39,4 +39,21 @@ impl ActionsList {
})
.collect();
}
pub fn iter_try_map<A, F>(&self, mut f: F)
where
A: ActionDispatcher,
F: FnMut(&A) -> std::ops::ControlFlow<()>,
{
let list = self.0.read();
for a in list.iter().rev() {
if let Some(action) = (**a).downcast_ref::<A>() {
if f(action).is_break() {
break;
}
} else {
trace::error!("Failed to downcast action of type {}", (**a).type_name());
}
}
}
}

View file

@ -2,6 +2,9 @@
use crate::html::RoutePath;
mod error;
pub use error::ComponentError;
mod definition;
pub use definition::{Component, ComponentRender};
@ -38,8 +41,8 @@ pub use context::{AssetsOp, Context, ContextError, Contextual};
/// self.renderable.map_or(true, |f| f(cx))
/// }
///
/// fn prepare_component(&self, _cx: &mut Context) -> Markup {
/// html! { "Visible component" }
/// fn prepare_component(&self, _cx: &mut Context) -> Result<Markup, ComponentError> {
/// Ok(html! { "Visible component" })
/// }
/// }
///

View file

@ -1,5 +1,5 @@
use crate::base::action;
use crate::core::component::Context;
use crate::core::component::{ComponentError, Context, Contextual};
use crate::core::{AnyInfo, TypeInfo};
use crate::html::{html, Markup};
@ -14,11 +14,15 @@ pub trait ComponentRender {
/// Interfaz común que debe implementar un componente renderizable en PageTop.
///
/// Se recomienda que los componentes deriven [`AutoDefault`](crate::AutoDefault). También deben
/// implementar explícitamente el método [`new()`](Self::new) y pueden sobrescribir los otros
/// métodos para personalizar su comportamiento.
/// Se recomienda que los componentes declaren sus campos como privados, que deriven
/// [`AutoDefault`](crate::AutoDefault) o implementen [`Default`] para inicializarlos por defecto, y
/// [`Getters`](crate::Getters) para acceder a sus datos. Deberán implementar explícitamente el
/// método [`new()`](Self::new) y podrán sobrescribir los demás métodos para personalizar su
/// comportamiento.
pub trait Component: AnyInfo + ComponentRender + Send + Sync {
/// Crea una nueva instancia del componente.
///
/// Por convención suele devolver `Self::default()`.
fn new() -> Self
where
Self: Sized;
@ -51,9 +55,9 @@ pub trait Component: AnyInfo + ComponentRender + Send + Sync {
/// puede sobrescribirse para decidir dinámicamente si los componentes de este tipo se
/// renderizan o no en función del contexto de renderizado.
///
/// También puede usarse junto con un alias de función como
/// ([`FnIsRenderable`](crate::core::component::FnIsRenderable)) para permitir que instancias
/// concretas del componente decidan si se renderizan o no.
/// También puede asignarse una función [`FnIsRenderable`](super::FnIsRenderable) a un campo del
/// componente para permitir que instancias concretas del mismo puedan decidir dinámicamente si
/// se renderizan o no.
#[allow(unused_variables)]
fn is_renderable(&self, cx: &mut Context) -> bool {
true
@ -62,25 +66,28 @@ pub trait Component: AnyInfo + ComponentRender + Send + Sync {
/// Configura el componente justo antes de preparar el renderizado.
///
/// Este método puede sobrescribirse para modificar la estructura interna del componente o el
/// contexto antes de preparar la renderización del componente. Por defecto no hace nada.
/// contexto antes de renderizarlo. Por defecto no hace nada.
#[allow(unused_variables)]
fn setup_before_prepare(&mut self, cx: &mut Context) {}
/// Devuelve una representación renderizada del componente.
/// Devuelve el marcado HTML del componente usando el contexto proporcionado.
///
/// Este método forma parte del ciclo de vida de los componentes y se invoca automáticamente
/// durante el proceso de construcción del documento. Puede sobrescribirse para generar
/// dinámicamente el contenido HTML con acceso al contexto de renderizado.
/// durante el proceso de construcción del documento. Cada componente lo implementa para generar
/// su propio contenido HTML. Los temas hijo pueden sobrescribir opcionalmente su resultado
/// mediante la acción [`PrepareRender`](crate::base::action::theme::PrepareRender).
///
/// Este método debe ser capaz de preparar el renderizado del componente con los métodos del
/// propio componente y el contexto proporcionado, no debería hacerlo accediendo directamente a
/// los campos de la estructura del componente. Es una forma de garantizar que los programadores
/// podrán sobrescribir este método sin preocuparse por los detalles internos del componente.
/// Se recomienda obtener los datos del componente a través de sus propios métodos para que los
/// temas hijo que implementen dicha acción puedan generar el nuevo HTML sin depender de los
/// detalles internos del componente.
///
/// Por defecto, devuelve un [`Markup`] vacío (`html! {}`).
/// Por defecto, devuelve un [`Markup`] vacío (`Ok(html! {})`).
///
/// En caso de error, devuelve un [`ComponentError`] que puede incluir un marcado alternativo
/// (*fallback*) para sustituir al componente fallido.
#[allow(unused_variables)]
fn prepare_component(&self, cx: &mut Context) -> Markup {
html! {}
fn prepare_component(&self, cx: &mut Context) -> Result<Markup, ComponentError> {
Ok(html! {})
}
}
@ -123,11 +130,33 @@ impl<C: Component> ComponentRender for C {
action::component::BeforeRender::dispatch(self, cx);
// Prepara el renderizado del componente.
let prepare = action::theme::PrepareRender::dispatch(self, cx);
let prepare = if prepare.is_empty() {
self.prepare_component(cx)
} else {
prepare
let prepare = match action::theme::PrepareRender::dispatch(self, cx) {
Ok(markup) if !markup.is_empty() => markup,
Ok(_) => match self.prepare_component(cx) {
Ok(markup) => markup,
Err(error) => {
crate::trace::error!(
path = cx.request().map(|r| r.path()).unwrap_or("<unknown>"),
component = self.name(),
id = self.id().as_deref().unwrap_or("<not set>"),
source = "prepare_component",
"render failed, using fallback: {}",
error.message()
);
error.into_fallback()
}
},
Err(error) => {
crate::trace::error!(
path = cx.request().map(|r| r.path()).unwrap_or("<unknown>"),
component = self.name(),
id = self.id().as_deref().unwrap_or("<not set>"),
source = "PrepareRender",
"render failed, using fallback: {}",
error.message()
);
error.into_fallback()
}
};
// Acciones específicas del tema después de renderizar el componente.

View file

@ -0,0 +1,66 @@
use crate::html::{html, Markup};
use crate::{AutoDefault, Getters};
/// Error producido durante el renderizado de un componente.
///
/// Se usa en [`Component::prepare_component()`](super::Component::prepare_component) para devolver
/// un [`Err`]. Puede incluir un marcado HTML alternativo para renderizar el componente de manera
/// diferente en caso de error.
///
/// # Ejemplo
///
/// ```rust
/// # use pagetop::prelude::*;
/// # struct MyComponent;
/// # impl Component for MyComponent {
/// # fn new() -> Self { MyComponent }
/// fn prepare_component(&self, _cx: &mut Context) -> Result<Markup, ComponentError> {
/// Err(ComponentError::new("Database connection failed")
/// .with_fallback(html! { p class="error" { "Content temporarily unavailable." } }))
/// }
/// # }
/// ```
#[derive(AutoDefault, Debug, Getters)]
pub struct ComponentError {
/// Mensaje descriptivo del error.
message: String,
/// Marcado HTML alternativo para mostrar si el componente falla.
fallback: Markup,
}
impl ComponentError {
/// Crea un nuevo error para un componente con un marcado alternativo vacío.
pub fn new(message: impl Into<String>) -> Self {
ComponentError {
message: message.into(),
fallback: html! {},
}
}
// **< ComponentError BUILDER >*****************************************************************
/// Asigna el marcado HTML alternativo (*fallback*) que se mostrará si el componente falla.
///
/// Si no se proporciona, no se renderizará nada del componente.
pub fn with_fallback(mut self, fallback: Markup) -> Self {
self.fallback = fallback;
self
}
// **< ComponentError GETTERS >*****************************************************************
/// Consume el error y devuelve su marcado alternativo.
///
/// Se invoca internamente en [`ComponentRender`](crate::core::component::ComponentRender).
pub(crate) fn into_fallback(self) -> Markup {
self.fallback
}
}
impl std::fmt::Display for ComponentError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.message)
}
}
impl std::error::Error for ComponentError {}