extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-08-09 05:24:56 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix: relay Signals reset to plugins (#13510)

Browse Source 
This PR will close #13501

# Description

This PR expands on [the relay of signals to running plugin
processes](https://github.com/nushell/nushell/pull/13181). The Ctrlc
relay has been generalized to SignalAction::Interrupt and when
reset_signal is called on the main EngineState, a SignalAction::Reset is
now relayed to running plugins.

# User-Facing Changes

The signal handler closure now takes a `signals::SignalAction`, while
previously it took no arguments. The handler will now be called on both
interrupt and reset. The method to register a handler on the plugin side
is now called `register_signal_handler` instead of
`register_ctrlc_handler`
[example](https://github.com/nushell/nushell/pull/13510/files#diff-3e04dff88fd0780a49778a3d1eede092ec729a1264b4ef07ca0d2baa859dad05L38).
This will only affect plugin authors who have started making use of
https://github.com/nushell/nushell/pull/13181, which isn't currently
part of an official release.

The change will also require all of user's plugins to be recompiled in
order that they don't error when a signal is received on the
PluginInterface.

# Testing

```
: example ctrlc
interrupt status: false
waiting for interrupt signal...
^Cinterrupt status: true
peace.
Error:   × Operation interrupted
   ╭─[display_output hook:1:1]
 1 │ if (term size).columns >= 100 { table -e } else { table }
   · ─┬
   ·  ╰── This operation was interrupted
   ╰────

: example ctrlc
interrupt status: false   <-- NOTE status is false
waiting for interrupt signal...
^Cinterrupt status: true
peace.
Error:   × Operation interrupted
   ╭─[display_output hook:1:1]
 1 │ if (term size).columns >= 100 { table -e } else { table }
   · ─┬
   ·  ╰── This operation was interrupted
   ╰────
   ```
This commit is contained in:
Andy Gayton
2024-08-06 06:35:40 -04:00
committed by GitHub
parent 73e8de9753
commit 1cd0544a3f
12 changed files with 86 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/signals.rs
View File

@ -1,7 +1,4 @@
use nu_protocol::{
engine::{ctrlc::Handlers, EngineState},
Signals,
};
use nu_protocol::{engine::EngineState, Handlers, SignalAction, Signals};
use std::sync::{
atomic::{AtomicBool, Ordering},
Arc,
@ -11,12 +8,12 @@ pub(crate) fn ctrlc_protection(engine_state: &mut EngineState) {
let interrupt = Arc::new(AtomicBool::new(false));
engine_state.set_signals(Signals::new(interrupt.clone()));
let ctrlc_handlers = Handlers::new();
engine_state.ctrlc_handlers = Some(ctrlc_handlers.clone());
let signal_handlers = Handlers::new();
engine_state.signal_handlers = Some(signal_handlers.clone());
ctrlc::set_handler(move || {
interrupt.store(true, Ordering::Relaxed);
ctrlc_handlers.run();
signal_handlers.run(SignalAction::Interrupt);
})
.expect("Error setting Ctrl-C handler");
}