[adapters] Properly handle error return from CircuitThread::step(). #5505
Conversation
CircuitThread::step() returns an error if something happens during a step (for example, if a step cannot be read or parsed in the journal), and CircuitThread::run() propagated that error to its caller with `?`, but nothing reported the error to the circuit thread's error callback, and this also skipped the code at the end of CircuitThread::run() that is supposed to mark the circuit as terminated. This meant that the HTTP server still thought that the controller was continuing even though it was dead. This commit fixes the problem by having CircuitThread::run()'s caller pass the error to the callback and calling the cleanup code. Issue: #5504 Signed-off-by: Ben Pfaff <[email protected]>
There was a problem hiding this comment.
Pull request overview
This PR adjusts CircuitThread lifecycle handling so that errors from step() no longer short‑circuit cleanup and are reported through the controller’s error callback, ensuring the pipeline is marked terminated even when a step fails.
Changes:
- Change
CircuitThread::runto take&mut self, return from its loop viabreak Ok(()), and move termination/cleanup logic into a newfinish(self)method. - Update the controller thread startup path to call
run, forward any error to the controller’s error callback, and then always callfinishfor cleanup. - Generalize
ControllerInner::errorto accept any type convertible intoArc<ControllerError>.
| Ok(mut circuit_thread) => { | ||
| if let Err(error) = circuit_thread.run(init_status_sender) { | ||
| circuit_thread.controller.error(error, None); | ||
| } | ||
| circuit_thread.finish().inspect_err(|error| { | ||
| // Log the error before returning it from the | ||
| // thread: otherwise, only [Controller::stop] | ||
| // will join the thread and report the error. |
There was a problem hiding this comment.
The error returned from circuit_thread.run is now consumed by error() and never propagated as the thread’s Result, so callers joining the thread will only see errors from finish() (if any), which differs from the prior behavior and contradicts the nearby comment about “returning it from the thread.” Consider preserving the original contract by also reflecting the run error in the returned Result (for example, by returning that error when run fails, or by combining run/finish errors in a way that ensures joiners still observe the failure).
CircuitThread::step() returns an error if something happens during a step (for example, if a step cannot be read or parsed in the journal), and CircuitThread::run() propagated that error to its caller with
?, but nothing reported the error to the circuit thread's error callback, and this also skipped the code at the end of CircuitThread::run() that is supposed to mark the circuit as terminated. This meant that the HTTP server still thought that the controller was continuing even though it was dead.This commit fixes the problem by having CircuitThread::run()'s caller pass the error to the callback and calling the cleanup code.
Issue: #5504