# 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.
162 lines
4.9 KiB
Rust
162 lines
4.9 KiB
Rust
use nu_protocol::{ShellError, Span, Value};
|
|
use std::cmp::Ordering;
|
|
|
|
pub enum Reduce {
|
|
Summation,
|
|
Product,
|
|
Minimum,
|
|
Maximum,
|
|
}
|
|
|
|
pub type ReducerFunction =
|
|
Box<dyn Fn(Value, Vec<Value>, Span, Span) -> Result<Value, ShellError> + Send + Sync + 'static>;
|
|
|
|
pub fn reducer_for(command: Reduce) -> ReducerFunction {
|
|
match command {
|
|
Reduce::Summation => Box::new(|_, values, span, head| sum(values, span, head)),
|
|
Reduce::Product => Box::new(|_, values, span, head| product(values, span, head)),
|
|
Reduce::Minimum => Box::new(|_, values, span, head| min(values, span, head)),
|
|
Reduce::Maximum => Box::new(|_, values, span, head| max(values, span, head)),
|
|
}
|
|
}
|
|
|
|
pub fn max(data: Vec<Value>, span: Span, head: Span) -> Result<Value, ShellError> {
|
|
let mut biggest = data
|
|
.first()
|
|
.ok_or_else(|| {
|
|
ShellError::UnsupportedInput(
|
|
"Empty input".to_string(),
|
|
"value originates from here".into(),
|
|
head,
|
|
span,
|
|
)
|
|
})?
|
|
.clone();
|
|
|
|
for value in &data {
|
|
if let Some(result) = value.partial_cmp(&biggest) {
|
|
if result == Ordering::Greater {
|
|
biggest = value.clone();
|
|
}
|
|
} else {
|
|
return Err(ShellError::OperatorMismatch {
|
|
op_span: head,
|
|
lhs_ty: biggest.get_type(),
|
|
lhs_span: biggest.span()?,
|
|
rhs_ty: value.get_type(),
|
|
rhs_span: value.span()?,
|
|
});
|
|
}
|
|
}
|
|
Ok(biggest)
|
|
}
|
|
|
|
pub fn min(data: Vec<Value>, span: Span, head: Span) -> Result<Value, ShellError> {
|
|
let mut smallest = data
|
|
.first()
|
|
.ok_or_else(|| {
|
|
ShellError::UnsupportedInput(
|
|
"Empty input".to_string(),
|
|
"value originates from here".into(),
|
|
head,
|
|
span,
|
|
)
|
|
})?
|
|
.clone();
|
|
|
|
for value in &data {
|
|
if let Some(result) = value.partial_cmp(&smallest) {
|
|
if result == Ordering::Less {
|
|
smallest = value.clone();
|
|
}
|
|
} else {
|
|
return Err(ShellError::OperatorMismatch {
|
|
op_span: head,
|
|
lhs_ty: smallest.get_type(),
|
|
lhs_span: smallest.span()?,
|
|
rhs_ty: value.get_type(),
|
|
rhs_span: value.span()?,
|
|
});
|
|
}
|
|
}
|
|
Ok(smallest)
|
|
}
|
|
|
|
pub fn sum(data: Vec<Value>, span: Span, head: Span) -> Result<Value, ShellError> {
|
|
let initial_value = data.get(0);
|
|
|
|
let mut acc = match initial_value {
|
|
Some(Value::Filesize { span, .. }) => Ok(Value::Filesize {
|
|
val: 0,
|
|
span: *span,
|
|
}),
|
|
Some(Value::Duration { span, .. }) => Ok(Value::Duration {
|
|
val: 0,
|
|
span: *span,
|
|
}),
|
|
Some(Value::Int { span, .. }) | Some(Value::Float { span, .. }) => Ok(Value::int(0, *span)),
|
|
None => Err(ShellError::UnsupportedInput(
|
|
"Empty input".to_string(),
|
|
"value originates from here".into(),
|
|
head,
|
|
span,
|
|
)),
|
|
_ => Ok(Value::nothing(head)),
|
|
}?;
|
|
|
|
for value in &data {
|
|
match value {
|
|
Value::Int { .. }
|
|
| Value::Float { .. }
|
|
| Value::Filesize { .. }
|
|
| Value::Duration { .. } => {
|
|
acc = acc.add(head, value, head)?;
|
|
}
|
|
Value::Error { error } => return Err(error.clone()),
|
|
other => {
|
|
return Err(ShellError::UnsupportedInput(
|
|
"Attempted to compute the sum of a value that cannot be summed".to_string(),
|
|
"value originates from here".into(),
|
|
head,
|
|
other.expect_span(),
|
|
));
|
|
}
|
|
}
|
|
}
|
|
Ok(acc)
|
|
}
|
|
|
|
pub fn product(data: Vec<Value>, span: Span, head: Span) -> Result<Value, ShellError> {
|
|
let initial_value = data.get(0);
|
|
|
|
let mut acc = match initial_value {
|
|
Some(Value::Int { span, .. }) | Some(Value::Float { span, .. }) => Ok(Value::int(1, *span)),
|
|
None => Err(ShellError::UnsupportedInput(
|
|
"Empty input".to_string(),
|
|
"value originates from here".into(),
|
|
head,
|
|
span,
|
|
)),
|
|
_ => Ok(Value::nothing(head)),
|
|
}?;
|
|
|
|
for value in &data {
|
|
match value {
|
|
Value::Int { .. } | Value::Float { .. } => {
|
|
acc = acc.mul(head, value, head)?;
|
|
}
|
|
Value::Error { error } => return Err(error.clone()),
|
|
other => {
|
|
return Err(ShellError::UnsupportedInput(
|
|
"Attempted to compute the product of a value that cannot be multiplied"
|
|
.to_string(),
|
|
"value originates from here".into(),
|
|
head,
|
|
other.expect_span(),
|
|
));
|
|
}
|
|
}
|
|
}
|
|
Ok(acc)
|
|
}
|