Error on non-zero exit statuses (#13515)

# Description
This PR makes it so that non-zero exit codes and termination by signal
are treated as a normal `ShellError`. Currently, these are silent
errors. That is, if an external command fails, then it's code block is
aborted, but the parent block can sometimes continue execution. E.g.,
see #8569 and this example:
```nushell
[1 2] | each { ^false }
```

Before this would give:
```
╭───┬──╮
│ 0 │  │
│ 1 │  │
╰───┴──╯
```

Now, this shows an error:
```
Error: nu:🐚:eval_block_with_input

  × Eval block failed with pipeline input
   ╭─[entry #1:1:2]
 1 │ [1 2] | each { ^false }
   ·  ┬
   ·  ╰── source value
   ╰────

Error: nu:🐚:non_zero_exit_code

  × External command had a non-zero exit code
   ╭─[entry #1:1:17]
 1 │ [1 2] | each { ^false }
   ·                 ──┬──
   ·                   ╰── exited with code 1
   ╰────
```

This PR fixes #12874, fixes #5960, fixes #10856, and fixes #5347. This
PR also partially addresses #10633 and #10624 (only the last command of
a pipeline is currently checked). It looks like #8569 is already fixed,
but this PR will make sure it is definitely fixed (fixes #8569).

# User-Facing Changes
- Non-zero exit codes and termination by signal now cause an error to be
thrown.
- The error record value passed to a `catch` block may now have an
`exit_code` column containing the integer exit code if the error was due
to an external command.
- Adds new config values, `display_errors.exit_code` and
`display_errors.termination_signal`, which determine whether an error
message should be printed in the respective error cases. For
non-interactive sessions, these are set to `true`, and for interactive
sessions `display_errors.exit_code` is false (via the default config).

# Tests
Added a few tests.

# After Submitting
- Update docs and book.
- Future work:
- Error if other external commands besides the last in a pipeline exit
with a non-zero exit code. Then, deprecate `do -c` since this will be
the default behavior everywhere.
- Add a better mechanism for exit codes and deprecate
`$env.LAST_EXIT_CODE` (it's buggy).
This commit is contained in:
Ian Manske
2024-09-06 23:44:26 -07:00
committed by GitHub
parent 6c1c7f9509
commit 3d008e2c4e
54 changed files with 566 additions and 650 deletions

View File

@ -59,7 +59,7 @@ impl Command for TimeIt {
} else {
let eval_expression_with_input = get_eval_expression_with_input(engine_state);
let expression = &command_to_run.clone();
eval_expression_with_input(engine_state, stack, expression, input)?.0
eval_expression_with_input(engine_state, stack, expression, input)?
}
} else {
PipelineData::empty()

View File

@ -3,7 +3,7 @@ use super::util::{get_rest_for_glob_pattern, try_interaction};
use nu_engine::{command_prelude::*, env::current_dir};
use nu_glob::MatchOptions;
use nu_path::expand_path_with;
use nu_protocol::{report_error_new, NuGlob};
use nu_protocol::{report_shell_error, NuGlob};
#[cfg(unix)]
use std::os::unix::prelude::FileTypeExt;
use std::{
@ -452,7 +452,7 @@ fn rm(
match result {
Ok(None) => {}
Ok(Some(msg)) => eprintln!("{msg}"),
Err(err) => report_error_new(engine_state, &err),
Err(err) => report_shell_error(engine_state, &err),
}
}

View File

@ -8,7 +8,7 @@ use notify_debouncer_full::{
use nu_engine::{command_prelude::*, ClosureEval};
use nu_protocol::{
engine::{Closure, StateWorkingSet},
format_error,
format_shell_error,
};
use std::{
path::PathBuf,
@ -198,7 +198,7 @@ impl Command for Watch {
}
Err(err) => {
let working_set = StateWorkingSet::new(engine_state);
eprintln!("{}", format_error(&working_set, &err));
eprintln!("{}", format_shell_error(&working_set, &err));
}
}
}

View File

@ -1,5 +1,5 @@
use nu_engine::command_prelude::*;
use nu_protocol::{report_warning_new, ParseWarning, ValueIterator};
use nu_protocol::{report_shell_warning, ValueIterator};
#[derive(Clone)]
pub struct Group;
@ -55,9 +55,9 @@ impl Command for Group {
) -> Result<PipelineData, ShellError> {
let head = call.head;
report_warning_new(
report_shell_warning(
engine_state,
&ParseWarning::DeprecatedWarning {
&ShellError::Deprecated {
old_command: "group".into(),
new_suggestion: "the new `chunks` command".into(),
span: head,

View File

@ -1,6 +1,6 @@
use nu_engine::{command_prelude::*, get_eval_block_with_early_return};
use nu_protocol::{
byte_stream::copy_with_signals, engine::Closure, process::ChildPipe, report_error_new,
byte_stream::copy_with_signals, engine::Closure, process::ChildPipe, report_shell_error,
ByteStream, ByteStreamSource, OutDest, PipelineMetadata, Signals,
};
use std::{
@ -353,7 +353,7 @@ fn tee_once(
) -> Result<JoinHandle<()>, std::io::Error> {
thread::Builder::new().name("tee".into()).spawn(move || {
if let Err(err) = on_thread() {
report_error_new(&engine_state, &err);
report_shell_error(&engine_state, &err);
}
})
}

View File

@ -279,7 +279,7 @@ impl UrlComponents {
..self
}),
_ => {
nu_protocol::report_error_new(
nu_protocol::report_shell_error(
engine_state,
&ShellError::GenericError {
error: format!("'{key}' is not a valid URL field"),

View File

@ -1,6 +1,6 @@
use super::base64::{operate, ActionType, Base64CommandArguments, CHARACTER_SET_DESC};
use nu_engine::command_prelude::*;
use nu_protocol::{report_warning_new, ParseWarning};
use nu_protocol::report_shell_warning;
#[derive(Clone)]
pub struct DecodeBase64Old;
@ -78,9 +78,9 @@ impl Command for DecodeBase64Old {
call: &Call,
input: PipelineData,
) -> Result<PipelineData, ShellError> {
report_warning_new(
report_shell_warning(
engine_state,
&ParseWarning::DeprecatedWarning {
&ShellError::Deprecated {
old_command: "decode base64".into(),
new_suggestion: "the new `decode new-base64` version".into(),
span: call.head,

View File

@ -1,6 +1,6 @@
use super::base64::{operate, ActionType, Base64CommandArguments, CHARACTER_SET_DESC};
use nu_engine::command_prelude::*;
use nu_protocol::{report_warning_new, ParseWarning};
use nu_protocol::report_shell_warning;
#[derive(Clone)]
pub struct EncodeBase64Old;
@ -82,9 +82,9 @@ impl Command for EncodeBase64Old {
call: &Call,
input: PipelineData,
) -> Result<PipelineData, ShellError> {
report_warning_new(
report_shell_warning(
engine_state,
&ParseWarning::DeprecatedWarning {
&ShellError::Deprecated {
old_command: "encode base64".into(),
new_suggestion: "the new `encode new-base64` version".into(),
span: call.head,

View File

@ -78,7 +78,7 @@ impl Command for SubCommand {
input: PipelineData,
) -> Result<PipelineData, ShellError> {
if call.has_flag_const(working_set, "not")? {
nu_protocol::report_error_new(
nu_protocol::report_shell_error(
working_set.permanent(),
&ShellError::GenericError {
error: "Deprecated option".into(),