mirror of
https://github.com/nushell/nushell.git
synced 2025-02-22 21:41:26 +01:00
2f18b9c856
# Description After this pr, nushell is able to raise errors with a backtrace, which should make users easier to debug. To enable the feature, users need to set env variable via `$env.NU_BACKTRACE = 1`. But yeah it might not work perfectly, there are some corner cases which might not be handled. I think it should close #13379 in another way. ### About the change The implementation mostly contained with 2 parts: 1. introduce a new `ChainedError` struct as well as a new `ShellError::ChainedError` variant. If `eval_instruction` returned an error, it converts the error to `ShellError::ChainedError`. `ChainedError` struct is responsable to display errors properly. It needs to handle the following 2 cases: - if we run a function which runs `error make` internally, it needs to display the error itself along with caller span. - if we run a `error make` directly, or some commands directly returns an error, we just want nushell raise an error about `error make`. 2. Attach caller spans to `ListStream` and `ByteStream`, because they are lazy streams, and *only* contains the span that runs it directly(like `^false`, for example), so nushell needs to add all caller spans to the stream. For example: in `def a [] { ^false }; def b [] { a; 33 }; b`, when we run `b`, which runs `a`, which runs `^false`, the `ByteStream` only contains the span of `^false`, we need to make it contains the span of `a`, so nushell is able to get all spans if something bad happened. This behavior is happened after running `Instruction::Call`, if it returns a `ByteStream` and `ListStream`, it will call `push_caller_span` method to attach call spans. # User-Facing Changes It's better to demostrate how it works by examples, given the following definition: ```nushell > $env.NU_BACKTRACE = 1 > def a [x] { if $x == 3 { error make {msg: 'a custom error'}}} > def a_2 [x] { if $x == 3 { ^false } else { $x } } > def a_3 [x] { if $x == 3 { [1 2 3] | each {error make {msg: 'a custom error inside list stream'} } } } > def b [--list-stream --external] { if $external == true { # error with non-zero exit code, which is generated from external command. a_2 1; a_2 3; a_2 2 } else if $list_stream == true { # error generated by list-stream a_3 1; a_3 3; a_3 2 } else { # error generated by command directly a 1; a 2; a 3 } } ``` Run `b` directly shows the following error: <details> ```nushell Error: chained_error × oops ╭─[entry #27:1:1] 1 │ b · ┬ · ╰── error happened when running this ╰──── Error: chained_error × oops ╭─[entry #26:10:19] 9 │ # error generated by command directly 10 │ a 1; a 2; a 3 · ┬ · ╰── error happened when running this 11 │ } ╰──── Error: × a custom error ╭─[entry #6:1:26] 1 │ def a [x] { if $x == 3 { error make {msg: 'a custom error'}}} · ─────┬──── · ╰── originates from here ╰──── ``` </details> Run `b --list-stream` shows the following error <details> ```nushell Error: chained_error × oops ╭─[entry #28:1:1] 1 │ b --list-stream · ┬ · ╰── error happened when running this ╰──── Error: nu:🐚:eval_block_with_input × Eval block failed with pipeline input ╭─[entry #26:7:16] 6 │ # error generated by list-stream 7 │ a_3 1; a_3 3; a_3 2 · ─┬─ · ╰── source value 8 │ } else { ╰──── Error: nu:🐚:eval_block_with_input × Eval block failed with pipeline input ╭─[entry #23:1:29] 1 │ def a_3 [x] { if $x == 3 { [1 2 3] | each {error make {msg: 'a custom error inside list stream'} } } } · ┬ · ╰── source value ╰──── Error: × a custom error inside list stream ╭─[entry #23:1:44] 1 │ def a_3 [x] { if $x == 3 { [1 2 3] | each {error make {msg: 'a custom error inside list stream'} } } } · ─────┬──── · ╰── originates from here ╰──── ``` </details> Run `b --external` shows the following error: <details> ```nushell Error: chained_error × oops ╭─[entry #29:1:1] 1 │ b --external · ┬ · ╰── error happened when running this ╰──── Error: nu:🐚:eval_block_with_input × Eval block failed with pipeline input ╭─[entry #26:4:16] 3 │ # error with non-zero exit code, which is generated from external command. 4 │ a_2 1; a_2 3; a_2 2 · ─┬─ · ╰── source value 5 │ } else if $list_stream == true { ╰──── Error: nu:🐚:non_zero_exit_code × External command had a non-zero exit code ╭─[entry #7:1:29] 1 │ def a_2 [x] { if $x == 3 { ^false } else { $x } } · ──┬── · ╰── exited with code 1 ╰──── ``` </details> It also added a message to guide the usage of NU_BACKTRACE, see the last line in the following example: ```shell ls asdfasd Error: nu:🐚:io::not_found × I/O error ╰─▶ × Entity not found ╭─[entry #17:1:4] 1 │ ls asdfasd · ───┬─── · ╰── Entity not found ╰──── help: The error occurred at '/home/windsoilder/projects/nushell/asdfasd' set the `NU_BACKTRACE=1` environment variable to display a backtrace. ``` # Tests + Formatting Added some tests for the behavior. # After Submitting
109 lines
2.9 KiB
Rust
109 lines
2.9 KiB
Rust
use nu_test_support::{nu, nu_repl_code};
|
||
|
||
#[test]
|
||
fn filesize_mb() {
|
||
let code = &[
|
||
r#"$env.config = { filesize: { unit: MB } }"#,
|
||
r#"20MB | into string"#,
|
||
];
|
||
let actual = nu!(nu_repl_code(code));
|
||
assert_eq!(actual.out, "20.0 MB");
|
||
}
|
||
|
||
#[test]
|
||
fn filesize_mib() {
|
||
let code = &[
|
||
r#"$env.config = { filesize: { unit: MiB } }"#,
|
||
r#"20MiB | into string"#,
|
||
];
|
||
let actual = nu!(nu_repl_code(code));
|
||
assert_eq!(actual.out, "20.0 MiB");
|
||
}
|
||
|
||
#[test]
|
||
fn filesize_format_decimal() {
|
||
let code = &[
|
||
r#"$env.config = { filesize: { unit: metric } }"#,
|
||
r#"[2MB 2GB 2TB] | into string | to nuon"#,
|
||
];
|
||
let actual = nu!(nu_repl_code(code));
|
||
assert_eq!(actual.out, r#"["2.0 MB", "2.0 GB", "2.0 TB"]"#);
|
||
}
|
||
|
||
#[test]
|
||
fn filesize_format_binary() {
|
||
let code = &[
|
||
r#"$env.config = { filesize: { unit: binary } }"#,
|
||
r#"[2MiB 2GiB 2TiB] | into string | to nuon"#,
|
||
];
|
||
let actual = nu!(nu_repl_code(code));
|
||
assert_eq!(actual.out, r#"["2.0 MiB", "2.0 GiB", "2.0 TiB"]"#);
|
||
}
|
||
|
||
#[test]
|
||
fn fancy_default_errors() {
|
||
let code = nu_repl_code(&[
|
||
"$env.config.use_ansi_coloring = true",
|
||
r#"def force_error [x] {
|
||
error make {
|
||
msg: "oh no!"
|
||
label: {
|
||
text: "here's the error"
|
||
span: (metadata $x).span
|
||
}
|
||
}
|
||
}"#,
|
||
r#"force_error "My error""#,
|
||
]);
|
||
|
||
let actual = nu!(format!("try {{ {code} }}"));
|
||
|
||
assert_eq!(
|
||
actual.err,
|
||
"Error: \u{1b}[31m×\u{1b}[0m oh no!\n ╭─[\u{1b}[36;1;4mline2:1:13\u{1b}[0m]\n \u{1b}[2m1\u{1b}[0m │ force_error \"My error\"\n · \u{1b}[35;1m ─────┬────\u{1b}[0m\n · \u{1b}[35;1m╰── \u{1b}[35;1mhere's the error\u{1b}[0m\u{1b}[0m\n ╰────\n\nset the `NU_BACKTRACE=1` environment variable to display a backtrace.\n"
|
||
);
|
||
}
|
||
|
||
#[test]
|
||
fn narratable_errors() {
|
||
let code = nu_repl_code(&[
|
||
r#"$env.config = { error_style: "plain" }"#,
|
||
r#"def force_error [x] {
|
||
error make {
|
||
msg: "oh no!"
|
||
label: {
|
||
text: "here's the error"
|
||
span: (metadata $x).span
|
||
}
|
||
}
|
||
}"#,
|
||
r#"force_error "my error""#,
|
||
]);
|
||
|
||
let actual = nu!(format!("try {{ {code} }}"));
|
||
|
||
assert_eq!(
|
||
actual.err,
|
||
r#"Error: oh no!
|
||
Diagnostic severity: error
|
||
Begin snippet for line2 starting at line 1, column 1
|
||
|
||
snippet line 1: force_error "my error"
|
||
label at line 1, columns 13 to 22: here's the error
|
||
|
||
|
||
set the `NU_BACKTRACE=1` environment variable to display a backtrace.
|
||
"#,
|
||
);
|
||
}
|
||
|
||
#[test]
|
||
fn plugins() {
|
||
let code = &[
|
||
r#"$env.config = { plugins: { nu_plugin_config: { key: value } } }"#,
|
||
r#"$env.config.plugins"#,
|
||
];
|
||
let actual = nu!(nu_repl_code(code));
|
||
assert_eq!(actual.out, r#"{nu_plugin_config: {key: value}}"#);
|
||
}
|