Merge pull request #1476 from zthompson47/improve-model-loading-messa…

…ges-wip

Improve model loading messages (long-lived background thread)

crates/fj-host/Cargo.toml

@@ -15,7 +15,10 @@ categories.workspace = true
 cargo_metadata = "0.15.2"
 crossbeam-channel = "0.5.6"
 fj.workspace = true
+fj-interop.workspace = true
+fj-operations.workspace = true
 libloading = "0.7.4"
 notify = "5.0.0"
 thiserror = "1.0.35"
 tracing = "0.1.37"
+winit = "0.27.5"

crates/fj-host/src/host.rs

@@ -1,31 +1,88 @@
-use crossbeam_channel::Receiver;
+use std::thread::JoinHandle;
 
-use crate::{Error, Evaluator, Model, ModelEvent, Watcher};
+use crossbeam_channel::Sender;
+use fj_operations::shape_processor::ShapeProcessor;
+use winit::event_loop::EventLoopProxy;
 
-/// A Fornjot model host
+use crate::{EventLoopClosed, HostThread, Model, ModelEvent};
+
+/// A host for watching models and responding to model updates
 pub struct Host {
-    evaluator: Evaluator,
-    _watcher: Watcher,
+    command_tx: Sender<HostCommand>,
+    host_thread: Option<JoinHandle<Result<(), EventLoopClosed>>>,
+    model_loaded: bool,
 }
 
 impl Host {
-    /// Create a new instance of `Host`
-    ///
-    /// This is only useful, if you want to continuously watch the model for
-    /// changes. If you don't, just keep using `Model`.
-    pub fn from_model(model: Model) -> Result<Self, Error> {
-        let watch_path = model.watch_path();
-        let evaluator = Evaluator::from_model(model);
-        let watcher = Watcher::watch_model(watch_path, &evaluator)?;
-
-        Ok(Self {
-            evaluator,
-            _watcher: watcher,
-        })
+    /// Create a host with a shape processor and a send channel to the event
+    /// loop.
+    pub fn new(
+        shape_processor: ShapeProcessor,
+        event_loop_proxy: EventLoopProxy<ModelEvent>,
+    ) -> Self {
+        let (command_tx, host_thread) =
+            HostThread::spawn(shape_processor, event_loop_proxy);
+
+        Self {
+            command_tx,
+            host_thread: Some(host_thread),
+            model_loaded: false,
+        }
     }
 
-    /// Access a channel with evaluation events
-    pub fn events(&self) -> Receiver<ModelEvent> {
-        self.evaluator.events()
+    /// Send a model to the host for evaluation and processing.
+    pub fn load_model(&mut self, model: Model) {
+        self.command_tx
+            .try_send(HostCommand::LoadModel(model))
+            .expect("Host channel disconnected unexpectedly");
+        self.model_loaded = true;
     }
+
+    /// Whether a model has been sent to the host yet
+    pub fn is_model_loaded(&self) -> bool {
+        self.model_loaded
+    }
+
+    /// Check if the host thread has exited with a panic. This method runs at
+    /// each tick of the event loop. Without an explicit check, an operation
+    /// will appear to hang forever (e.g. processing a model).  An error
+    /// will be printed to the terminal, but the gui will not notice until
+    /// a new `HostCommand` is issued on the disconnected channel.
+    ///
+    /// # Panics
+    ///
+    /// This method panics on purpose so the main thread can exit on an
+    /// unrecoverable error.
+    pub fn propagate_panic(&mut self) {
+        if self.host_thread.is_none() {
+            unreachable!("Constructor requires host thread")
+        }
+        if let Some(host_thread) = &self.host_thread {
+            // The host thread should not finish while this handle holds the
+            // `command_tx` channel open, so an exit means the thread panicked.
+            if host_thread.is_finished() {
+                let host_thread = self.host_thread.take().unwrap();
+                match host_thread.join() {
+                    Ok(_) => {
+                        unreachable!(
+                            "Host thread cannot exit until host handle disconnects"
+                        )
+                    }
+                    // The error value has already been reported by the panic
+                    // in the host thread, so just ignore it here.
+                    Err(_) => {
+                        panic!("Host thread panicked")
+                    }
+                }
+            }
+        }
+    }
+}
+
+/// Commands that can be sent to a host
+pub enum HostCommand {
+    /// Load a model to be evaluated and processed
+    LoadModel(Model),
+    /// Used by a `Watcher` to trigger evaluation when a model is edited
+    TriggerEvaluation,
 }

crates/fj-host/src/host_thread.rs

@@ -0,0 +1,141 @@
+use std::thread::{self, JoinHandle};
+
+use crossbeam_channel::{self, Receiver, Sender};
+use fj_interop::processed_shape::ProcessedShape;
+use fj_operations::shape_processor::ShapeProcessor;
+use winit::event_loop::EventLoopProxy;
+
+use crate::{Error, HostCommand, Model, Watcher};
+
+// Use a zero-sized error type to silence `#[warn(clippy::result_large_err)]`.
+// The only error from `EventLoopProxy::send_event` is `EventLoopClosed<T>`,
+// so we don't need the actual value. We just need to know there was an error.
+pub(crate) struct EventLoopClosed;
+
+pub(crate) struct HostThread {
+    shape_processor: ShapeProcessor,
+    event_loop_proxy: EventLoopProxy<ModelEvent>,
+    command_tx: Sender<HostCommand>,
+    command_rx: Receiver<HostCommand>,
+}
+
+impl HostThread {
+    // Spawn a background thread that will process models for an event loop.
+    pub(crate) fn spawn(
+        shape_processor: ShapeProcessor,
+        event_loop_proxy: EventLoopProxy<ModelEvent>,
+    ) -> (Sender<HostCommand>, JoinHandle<Result<(), EventLoopClosed>>) {
+        let (command_tx, command_rx) = crossbeam_channel::unbounded();
+        let command_tx_2 = command_tx.clone();
+
+        let host_thread = Self {
+            shape_processor,
+            event_loop_proxy,
+            command_tx,
+            command_rx,
+        };
+
+        let join_handle = host_thread.spawn_thread();
+
+        (command_tx_2, join_handle)
+    }
+
+    fn spawn_thread(mut self) -> JoinHandle<Result<(), EventLoopClosed>> {
+        thread::Builder::new()
+            .name("host".to_string())
+            .spawn(move || -> Result<(), EventLoopClosed> {
+                let mut model: Option<Model> = None;
+                let mut _watcher: Option<Watcher> = None;
+
+                while let Ok(command) = self.command_rx.recv() {
+                    match command {
+                        HostCommand::LoadModel(new_model) => {
+                            // Right now, `fj-app` will only load a new model
+                            // once. The gui does not have a feature to load a
+                            // new model after the initial load. If that were
+                            // to change, there would be a race condition here
+                            // if the prior watcher sent `TriggerEvaluation`
+                            // before it and the model were replaced.
+                            match Watcher::watch_model(
+                                new_model.watch_path(),
+                                self.command_tx.clone(),
+                            ) {
+                                Ok(watcher) => {
+                                    _watcher = Some(watcher);
+                                    self.send_event(ModelEvent::StartWatching)?;
+                                }
+
+                                Err(err) => {
+                                    self.send_event(ModelEvent::Error(err))?;
+                                    continue;
+                                }
+                            }
+                            self.process_model(&new_model)?;
+                            model = Some(new_model);
+                        }
+                        HostCommand::TriggerEvaluation => {
+                            self.send_event(ModelEvent::ChangeDetected)?;
+                            if let Some(model) = &model {
+                                self.process_model(model)?;
+                            }
+                        }
+                    }
+                }
+
+                Ok(())
+            })
+            .expect("Cannot create OS thread for host")
+    }
+
+    // Evaluate and process a model.
+    fn process_model(&mut self, model: &Model) -> Result<(), EventLoopClosed> {
+        let evaluation = match model.evaluate() {
+            Ok(evaluation) => evaluation,
+
+            Err(err) => {
+                self.send_event(ModelEvent::Error(err))?;
+                return Ok(());
+            }
+        };
+
+        self.send_event(ModelEvent::Evaluated)?;
+
+        match self.shape_processor.process(&evaluation.shape) {
+            Ok(shape) => self.send_event(ModelEvent::ProcessedShape(shape))?,
+
+            Err(err) => {
+                self.send_event(ModelEvent::Error(err.into()))?;
+            }
+        }
+
+        Ok(())
+    }
+
+    // Send a message to the event loop.
+    fn send_event(&mut self, event: ModelEvent) -> Result<(), EventLoopClosed> {
+        self.event_loop_proxy
+            .send_event(event)
+            .map_err(|_| EventLoopClosed)?;
+
+        Ok(())
+    }
+}
+
+/// An event emitted by the host thread
+#[derive(Debug)]
+pub enum ModelEvent {
+    /// A new model is being watched
+    StartWatching,
+
+    /// A change in the model has been detected
+    ChangeDetected,
+
+    /// The model has been evaluated
+    Evaluated,
+
+    /// The model has been processed
+    ProcessedShape(ProcessedShape),
+
+    /// An error
+    Error(Error),
+}

crates/fj-host/src/lib.rs

@@ -15,16 +15,18 @@
 
 #![warn(missing_docs)]
 
-mod evaluator;
 mod host;
+mod host_thread;
 mod model;
 mod parameters;
 mod platform;
 mod watcher;
 
+pub(crate) use self::host_thread::{EventLoopClosed, HostThread};
+
 pub use self::{
-    evaluator::{Evaluator, ModelEvent},
-    host::Host,
+    host::{Host, HostCommand},
+    host_thread::ModelEvent,
     model::{Error, Evaluation, Model},
     parameters::Parameters,
     watcher::Watcher,