mirror of
https://github.com/nushell/nushell.git
synced 2025-08-09 01:54:57 +02:00
Standardise the use of ShellError::UnsupportedInput and ShellError::TypeMismatch and add spans to every instance of the former (#7217)
# Description * I was dismayed to discover recently that UnsupportedInput and TypeMismatch are used *extremely* inconsistently across the codebase. UnsupportedInput is sometimes used for input type-checks (as per the name!!), but *also* used for argument type-checks. TypeMismatch is also used for both. I thus devised the following standard: input type-checking *only* uses UnsupportedInput, and argument type-checking *only* uses TypeMismatch. Moreover, to differentiate them, UnsupportedInput now has *two* error arrows (spans), one pointing at the command and the other at the input origin, while TypeMismatch only has the one (because the command should always be nearby) * In order to apply that standard, a very large number of UnsupportedInput uses were changed so that the input's span could be retrieved and delivered to it. * Additionally, I noticed many places where **errors are not propagated correctly**: there are lots of `match` sites which take a Value::Error, then throw it away and replace it with a new Value::Error with less/misleading information (such as reporting the error as an "incorrect type"). I believe that the earliest errors are the most important, and should always be propagated where possible. * Also, to standardise one broad subset of UnsupportedInput error messages, who all used slightly different wordings of "expected `<type>`, got `<type>`", I created OnlySupportsThisInputType as a variant of it. * Finally, a bunch of error sites that had "repeated spans" - i.e. where an error expected two spans, but `call.head` was given for both - were fixed to use different spans. # Example BEFORE ``` 〉20b | str starts-with 'a' Error: nu:🐚:unsupported_input (link) × Unsupported input ╭─[entry #31:1:1] 1 │ 20b | str starts-with 'a' · ┬ · ╰── Input's type is filesize. This command only works with strings. ╰──── 〉'a' | math cos Error: nu:🐚:unsupported_input (link) × Unsupported input ╭─[entry #33:1:1] 1 │ 'a' | math cos · ─┬─ · ╰── Only numerical values are supported, input type: String ╰──── 〉0x[12] | encode utf8 Error: nu:🐚:unsupported_input (link) × Unsupported input ╭─[entry #38:1:1] 1 │ 0x[12] | encode utf8 · ───┬── · ╰── non-string input ╰──── ``` AFTER ``` 〉20b | str starts-with 'a' Error: nu:🐚:pipeline_mismatch (link) × Pipeline mismatch. ╭─[entry #1:1:1] 1 │ 20b | str starts-with 'a' · ┬ ───────┬─────── · │ ╰── only string input data is supported · ╰── input type: filesize ╰──── 〉'a' | math cos Error: nu:🐚:pipeline_mismatch (link) × Pipeline mismatch. ╭─[entry #2:1:1] 1 │ 'a' | math cos · ─┬─ ────┬─── · │ ╰── only numeric input data is supported · ╰── input type: string ╰──── 〉0x[12] | encode utf8 Error: nu:🐚:pipeline_mismatch (link) × Pipeline mismatch. ╭─[entry #3:1:1] 1 │ 0x[12] | encode utf8 · ───┬── ───┬── · │ ╰── only string input data is supported · ╰── input type: binary ╰──── ``` # User-Facing Changes Various error messages suddenly make more sense (i.e. have two arrows instead of one). # Tests + Formatting Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass # After Submitting If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date.
This commit is contained in:
Leon
GitHub
@ -243,10 +243,10 @@ impl PipelineData {
|
||||
pub fn collect_string_strict(
|
||||
self,
|
||||
span: Span,
|
||||
) -> Result<(String, Option<PipelineMetadata>), ShellError> {
|
||||
) -> Result<(String, Span, Option<PipelineMetadata>), ShellError> {
|
||||
match self {
|
||||
PipelineData::Empty => Ok((String::new(), None)),
|
||||
PipelineData::Value(Value::String { val, .. }, metadata) => Ok((val, metadata)),
|
||||
PipelineData::Empty => Ok((String::new(), span, None)),
|
||||
PipelineData::Value(Value::String { val, span }, metadata) => Ok((val, span, metadata)),
|
||||
PipelineData::Value(val, _) => {
|
||||
Err(ShellError::TypeMismatch("string".into(), val.span()?))
|
||||
}
|
||||
@ -254,13 +254,15 @@ impl PipelineData {
|
||||
PipelineData::ExternalStream {
|
||||
stdout: None,
|
||||
metadata,
|
||||
span,
|
||||
..
|
||||
} => Ok((String::new(), metadata)),
|
||||
} => Ok((String::new(), span, metadata)),
|
||||
PipelineData::ExternalStream {
|
||||
stdout: Some(stdout),
|
||||
metadata,
|
||||
span,
|
||||
..
|
||||
} => Ok((stdout.into_string()?.item, metadata)),
|
||||
} => Ok((stdout.into_string()?.item, span, metadata)),
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ -51,21 +51,39 @@ pub enum ShellError {
|
||||
#[label("value originates from here")] Span,
|
||||
),
|
||||
|
||||
/// A command received an argument of the wrong type.
|
||||
#[error("Pipeline mismatch.")]
|
||||
#[diagnostic(code(nu::shell::pipeline_mismatch), url(docsrs))]
|
||||
OnlySupportsThisInputType(
|
||||
String,
|
||||
String,
|
||||
#[label("only {0} input data is supported")] Span,
|
||||
#[label("input type: {1}")] Span,
|
||||
),
|
||||
|
||||
/// No input value was piped into the command.
|
||||
///
|
||||
/// ## Resolution
|
||||
///
|
||||
/// Convert the argument type before passing it in, or change the command to accept the type.
|
||||
#[error("Type mismatch")]
|
||||
#[diagnostic(code(nu::shell::type_mismatch), url(docsrs))]
|
||||
TypeMismatch(String, #[label = "needs {0}"] Span),
|
||||
/// Only use this command to process values from a previous expression.
|
||||
#[error("Pipeline empty.")]
|
||||
#[diagnostic(code(nu::shell::pipeline_mismatch), url(docsrs))]
|
||||
PipelineEmpty(#[label("no input value was piped in")] Span),
|
||||
|
||||
/// A command received an argument of the wrong type.
|
||||
///
|
||||
/// ## Resolution
|
||||
///
|
||||
/// Convert the argument type before passing it in, or change the command to accept the type.
|
||||
#[error("Type mismatch")]
|
||||
#[error("Type mismatch.")]
|
||||
#[diagnostic(code(nu::shell::type_mismatch), url(docsrs))]
|
||||
TypeMismatch(String, #[label = "{0}"] Span),
|
||||
|
||||
/// A command received an argument of the wrong type.
|
||||
///
|
||||
/// ## Resolution
|
||||
///
|
||||
/// Convert the argument type before passing it in, or change the command to accept the type.
|
||||
#[error("Type mismatch.")]
|
||||
#[diagnostic(code(nu::shell::type_mismatch), url(docsrs))]
|
||||
TypeMismatchGenericMessage {
|
||||
err_message: String,
|
||||
@ -469,7 +487,12 @@ Either make sure {0} is a string, or add a 'to_string' entry for it in ENV_CONVE
|
||||
/// This error is fairly generic. Refer to the specific error message for further details.
|
||||
#[error("Unsupported input")]
|
||||
#[diagnostic(code(nu::shell::unsupported_input), url(docsrs))]
|
||||
UnsupportedInput(String, #[label("{0}")] Span),
|
||||
UnsupportedInput(
|
||||
String,
|
||||
String,
|
||||
#[label("{0}")] Span, // call head (the name of the command itself)
|
||||
#[label("input type: {1}")] Span,
|
||||
),
|
||||
|
||||
/// Failed to parse an input into a datetime value.
|
||||
///
|
||||
@ -785,7 +808,7 @@ Either make sure {0} is a string, or add a 'to_string' entry for it in ENV_CONVE
|
||||
#[diagnostic(code(nu::shell::missing_config_value), url(docsrs))]
|
||||
MissingConfigValue(String, #[label = "missing {0}"] Span),
|
||||
|
||||
/// Negative value passed when positive ons is required.
|
||||
/// Negative value passed when positive one is required.
|
||||
///
|
||||
/// ## Resolution
|
||||
///
|
||||
|
||||
@ -352,6 +352,13 @@ impl Value {
|
||||
}
|
||||
}
|
||||
|
||||
/// Special variant of the above designed to be called only in
|
||||
/// situations where the value not being a Value::Error has been guaranteed
|
||||
/// by match arms.
|
||||
pub fn expect_span(&self) -> Span {
|
||||
self.span().expect("non-Error Value had no span")
|
||||
}
|
||||
|
||||
/// Update the value with a new span
|
||||
pub fn with_span(mut self, new_span: Span) -> Value {
|
||||
match &mut self {
|
||||
@ -1180,6 +1187,7 @@ impl Value {
|
||||
&mut self,
|
||||
cell_path: &[PathMember],
|
||||
new_val: Value,
|
||||
head_span: Span,
|
||||
) -> Result<(), ShellError> {
|
||||
match cell_path.first() {
|
||||
Some(path_member) => match path_member {
|
||||
@ -1207,6 +1215,7 @@ impl Value {
|
||||
return col.1.insert_data_at_cell_path(
|
||||
&cell_path[1..],
|
||||
new_val,
|
||||
head_span,
|
||||
);
|
||||
}
|
||||
}
|
||||
@ -1215,9 +1224,13 @@ impl Value {
|
||||
cols.push(col_name.clone());
|
||||
vals.push(new_val.clone());
|
||||
}
|
||||
// SIGH...
|
||||
Value::Error { error } => return Err(error.clone()),
|
||||
_ => {
|
||||
return Err(ShellError::UnsupportedInput(
|
||||
"table or record".into(),
|
||||
"expected table or record".into(),
|
||||
format!("input type: {:?}", val.get_type()),
|
||||
head_span,
|
||||
*span,
|
||||
))
|
||||
}
|
||||
@ -1238,9 +1251,11 @@ impl Value {
|
||||
*v_span,
|
||||
));
|
||||
} else {
|
||||
return col
|
||||
.1
|
||||
.insert_data_at_cell_path(&cell_path[1..], new_val);
|
||||
return col.1.insert_data_at_cell_path(
|
||||
&cell_path[1..],
|
||||
new_val,
|
||||
head_span,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1248,9 +1263,11 @@ impl Value {
|
||||
cols.push(col_name.clone());
|
||||
vals.push(new_val);
|
||||
}
|
||||
_ => {
|
||||
other => {
|
||||
return Err(ShellError::UnsupportedInput(
|
||||
"table or record".into(),
|
||||
format!("input type: {:?}", other.get_type()),
|
||||
head_span,
|
||||
*span,
|
||||
))
|
||||
}
|
||||
@ -1258,7 +1275,7 @@ impl Value {
|
||||
PathMember::Int { val: row_num, span } => match self {
|
||||
Value::List { vals, .. } => {
|
||||
if let Some(v) = vals.get_mut(*row_num) {
|
||||
v.insert_data_at_cell_path(&cell_path[1..], new_val)?
|
||||
v.insert_data_at_cell_path(&cell_path[1..], new_val, head_span)?
|
||||
} else if vals.len() == *row_num && cell_path.len() == 1 {
|
||||
// If the insert is at 1 + the end of the list, it's OK.
|
||||
// Otherwise, it's prohibited.
|
||||
@ -2626,8 +2643,14 @@ impl Value {
|
||||
// We are leaving some performance on the table by compiling the regex every time.
|
||||
// Small regexes compile in microseconds, and the simplicity of this approach currently
|
||||
// outweighs the performance costs. Revisit this if it ever becomes a bottleneck.
|
||||
let regex = Regex::new(rhs)
|
||||
.map_err(|e| ShellError::UnsupportedInput(format!("{e}"), *rhs_span))?;
|
||||
let regex = Regex::new(rhs).map_err(|e| {
|
||||
ShellError::UnsupportedInput(
|
||||
format!("{e}"),
|
||||
"value originated from here".into(),
|
||||
span,
|
||||
*rhs_span,
|
||||
)
|
||||
})?;
|
||||
let is_match = regex.is_match(lhs);
|
||||
Ok(Value::Bool {
|
||||
val: if invert {
|
||||
|
||||
Reference in New Issue
Block a user