Improve propagation of HPS error messages

Author: HactarCE

crates/hyperpuzzle_impl_nd_euclid/src/hps/puzzle_engine.rs

@@ -64,7 +64,7 @@ impl hyperpuzzlescript::EngineCallback<Puzzle> for HpsNdEuclid {
                         .build_blocking(
                             &CatalogId::from_str(color_system_id).map_err(|e| eyre!("{e}"))?,
                         )
-                        .map_err(|e| eyre!("{e:#}")) // cursed reformatting of eyre::Report
+                        .map_err(|e| clone_eyre(&e))
                         .wrap_err("error building color system")?;
                     builder.shape().lock().colors = ColorSystemBuilder::unbuild(&colors)?;
                 }
@@ -77,7 +77,7 @@ impl hyperpuzzlescript::EngineCallback<Puzzle> for HpsNdEuclid {
                         .build_blocking(
                             &CatalogId::from_str(twist_system_id).map_err(|e| eyre!("{e}"))?,
                         )
-                        .map_err(|e| eyre!("{e:#}")) // cursed reformatting of eyre::Report
+                        .map_err(|e| clone_eyre(&e))
                         .wrap_err("error building twist system")?;
                     *builder.twists().lock() = TwistSystemBuilder::unbuild(&twists)?;
                 }
@@ -113,8 +113,9 @@ impl hyperpuzzlescript::EngineCallback<Puzzle> for HpsNdEuclid {
                     build_fn
                         .call(build_span, &mut ctx, vec![], Map::new())
                         .map_err(|e| {
-                            ctx.runtime.report_diagnostic(e);
-                            eyre!("unable to build puzzle `{id}`; see HPS logs")
+                            ctx.runtime
+                                .report_and_convert_to_eyre(e)
+                                .wrap_err("error building puzzle")
                         })?;
 
                     let b = builder.lock();
@@ -128,3 +129,12 @@ impl hyperpuzzlescript::EngineCallback<Puzzle> for HpsNdEuclid {
         })
     }
 }
+
+#[track_caller]
+fn clone_eyre(e: &eyre::Report) -> eyre::Report {
+    if let Some(e) = e.downcast_ref::<FormattedFullDiagnostic>().cloned() {
+        eyre!(e)
+    } else {
+        eyre!("{e}") // cursed reformatting of eyre::Report
+    }
+}

crates/hyperpuzzle_impl_nd_euclid/src/hps/twist_system_engine.rs

@@ -1,6 +1,5 @@
 use std::sync::Arc;
 
-use eyre::eyre;
 use hyperpuzzle_core::prelude::*;
 use hyperpuzzlescript::*;
 
@@ -55,8 +54,9 @@ impl hyperpuzzlescript::EngineCallback<TwistSystem> for HpsNdEuclid {
                     let exports = build_fn
                         .call(build_span, &mut ctx, vec![], Map::new())
                         .map_err(|e| {
-                            ctx.runtime.report_diagnostic(e);
-                            eyre!("unable to build twist system `{id}`; see HPS logs")
+                            ctx.runtime
+                                .report_and_convert_to_eyre(e)
+                                .wrap_err("error building twist system")
                         })?;
 
                     let mut b = builder.lock();

crates/hyperpuzzlescript/src/builtins/catalog/generators.rs

@@ -88,7 +88,7 @@ impl HpsGenerator {
         map_fn: impl 'static + Send + Sync + FnOnce(&mut EvalCtx<'_>, Map) -> Result<T>,
     ) -> eyre::Result<Redirectable<T>> {
         // IIFE to mimic try_block
-        let result = (|| {
+        (|| {
             let mut scope = Scope::default();
             scope.special.id = Some(self.generated_id(param_values.clone())?);
             let scope = Arc::new(scope);
@@ -142,8 +142,8 @@ impl HpsGenerator {
                           redirect), list (ID redirect to generator), or map"
                     .at(ctx.caller_span)),
             }
-        })();
-        runtime.report_and_convert_to_eyre(result)
+        })()
+        .map_err(|e| runtime.report_and_convert_to_eyre(e))
     }
 }
 

crates/hyperpuzzlescript/src/diagnostic/full.rs

@@ -107,7 +107,7 @@ impl FullDiagnostic {
 /// When displayed using [`std::fmt::Display`], only `msg` is shown. Use
 /// `.ansi_string` to get the full error with source code snippets and
 /// traceback, using ANSI escape codes for coloring.
-#[derive(thiserror::Error, Debug)]
+#[derive(thiserror::Error, Debug, Clone)]
 #[error("{msg}")]
 pub struct FormattedFullDiagnostic {
     /// Short message describing the error.

crates/hyperpuzzlescript/src/runtime/mod.rs

@@ -191,12 +191,10 @@ impl Runtime {
 
     /// Reports a diagnostic in the case of an error, and converts the error to
     /// [`eyre::Report`].
-    pub fn report_and_convert_to_eyre<T>(&mut self, result: Result<T>) -> eyre::Result<T> {
-        result.map_err(|e| {
-            let s = e.formatted(&*self);
-            self.report_diagnostic(e);
-            eyre::eyre!("{s}")
-        })
+    pub fn report_and_convert_to_eyre(&mut self, e: FullDiagnostic) -> eyre::Report {
+        let formatted = e.formatted(&*self);
+        self.report_diagnostic(e);
+        eyre::eyre!(formatted)
     }
 
     /// Locks the map of built-ins and executes a closure with it.

crates/hyperspeedcube/src/gui/tabs/puzzle.rs

@@ -16,6 +16,7 @@ use hyperpuzzle_log::Solve;
 use hyperpuzzle_view::{
     DragState, HoverMode, NdEuclidViewState, PuzzleSimulation, PuzzleView, PuzzleViewInput,
 };
+use hyperpuzzlescript::FormattedFullDiagnostic;
 use parking_lot::Mutex;
 
 use crate::L;