mirror of
https://github.com/nushell/nushell.git
synced 2025-06-30 14:40:06 +02:00
fix: relay Signals reset to plugins (#13510)
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:
@ -16,7 +16,7 @@ impl PluginCommand for Ctrlc {
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
"Example command that demonstrates registering a ctrl-c handler"
|
||||
"Example command that demonstrates registering an interrupt signal handler"
|
||||
}
|
||||
|
||||
fn signature(&self) -> Signature {
|
||||
@ -35,12 +35,12 @@ impl PluginCommand for Ctrlc {
|
||||
_input: PipelineData,
|
||||
) -> Result<PipelineData, LabeledError> {
|
||||
let (sender, receiver) = mpsc::channel::<()>();
|
||||
let _guard = engine.register_ctrlc_handler(Box::new(move || {
|
||||
let _guard = engine.register_signal_handler(Box::new(move |_| {
|
||||
let _ = sender.send(());
|
||||
}));
|
||||
|
||||
eprintln!("interrupt status: {:?}", engine.signals().interrupted());
|
||||
eprintln!("waiting for ctrl-c signal...");
|
||||
eprintln!("waiting for interrupt signal...");
|
||||
receiver.recv().expect("handler went away");
|
||||
eprintln!("interrupt status: {:?}", engine.signals().interrupted());
|
||||
eprintln!("peace.");
|
||||
|
Reference in New Issue
Block a user