# 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.
120 lines
4.2 KiB
Rust
120 lines
4.2 KiB
Rust
use indexmap::map::IndexMap;
|
|
use nu_protocol::ast::Call;
|
|
use nu_protocol::{IntoPipelineData, PipelineData, ShellError, Span, Spanned, Value};
|
|
|
|
pub fn run_with_function(
|
|
call: &Call,
|
|
input: PipelineData,
|
|
mf: impl Fn(&[Value], Span, &Span) -> Result<Value, ShellError>,
|
|
) -> Result<nu_protocol::PipelineData, nu_protocol::ShellError> {
|
|
let name = call.head;
|
|
let res = calculate(input, name, mf);
|
|
match res {
|
|
Ok(v) => Ok(v.into_pipeline_data()),
|
|
Err(e) => Err(e),
|
|
}
|
|
}
|
|
|
|
fn helper_for_tables(
|
|
values: &[Value],
|
|
val_span: Span,
|
|
name: Span,
|
|
mf: impl Fn(&[Value], Span, &Span) -> Result<Value, ShellError>,
|
|
) -> Result<Value, ShellError> {
|
|
// If we are not dealing with Primitives, then perhaps we are dealing with a table
|
|
// Create a key for each column name
|
|
let mut column_values = IndexMap::new();
|
|
for val in values {
|
|
match val {
|
|
Value::Record { cols, vals, .. } => {
|
|
for (key, value) in cols.iter().zip(vals.iter()) {
|
|
column_values
|
|
.entry(key.clone())
|
|
.and_modify(|v: &mut Vec<Value>| v.push(value.clone()))
|
|
.or_insert_with(|| vec![value.clone()]);
|
|
}
|
|
}
|
|
Value::Error { error } => return Err(error.clone()),
|
|
_ => {
|
|
//Turns out we are not dealing with a table
|
|
return mf(values, val.expect_span(), &name);
|
|
}
|
|
}
|
|
}
|
|
// The mathematical function operates over the columns of the table
|
|
let mut column_totals = IndexMap::new();
|
|
for (col_name, col_vals) in column_values {
|
|
if let Ok(out) = mf(&col_vals, val_span, &name) {
|
|
column_totals.insert(col_name, out);
|
|
}
|
|
}
|
|
if column_totals.keys().len() == 0 {
|
|
return Err(ShellError::UnsupportedInput(
|
|
"Unable to give a result with this input".to_string(),
|
|
"value originates from here".into(),
|
|
name,
|
|
val_span,
|
|
));
|
|
}
|
|
|
|
Ok(Value::from(Spanned {
|
|
item: column_totals,
|
|
span: name,
|
|
}))
|
|
}
|
|
|
|
pub fn calculate(
|
|
values: PipelineData,
|
|
name: Span,
|
|
mf: impl Fn(&[Value], Span, &Span) -> Result<Value, ShellError>,
|
|
) -> Result<Value, ShellError> {
|
|
// TODO implement spans for ListStream, thus negating the need for unwrap_or().
|
|
let span = values.span().unwrap_or(name);
|
|
match values {
|
|
PipelineData::ListStream(s, ..) => {
|
|
helper_for_tables(&s.collect::<Vec<Value>>(), span, name, mf)
|
|
}
|
|
PipelineData::Value(Value::List { ref vals, span }, ..) => match &vals[..] {
|
|
[Value::Record { .. }, _end @ ..] => helper_for_tables(
|
|
vals,
|
|
values.span().expect("PipelineData::Value had no span"),
|
|
name,
|
|
mf,
|
|
),
|
|
_ => mf(vals, span, &name),
|
|
},
|
|
PipelineData::Value(Value::Record { vals, cols, span }, ..) => {
|
|
let new_vals: Result<Vec<Value>, ShellError> = vals
|
|
.into_iter()
|
|
.map(|val| mf(&[val], span, &name))
|
|
.collect();
|
|
match new_vals {
|
|
Ok(vec) => Ok(Value::Record {
|
|
cols,
|
|
vals: vec,
|
|
span,
|
|
}),
|
|
Err(err) => Err(err),
|
|
}
|
|
}
|
|
PipelineData::Value(Value::Range { val, span, .. }, ..) => {
|
|
let new_vals: Result<Vec<Value>, ShellError> = val
|
|
.into_range_iter(None)?
|
|
.map(|val| mf(&[val], span, &name))
|
|
.collect();
|
|
|
|
mf(&new_vals?, span, &name)
|
|
}
|
|
PipelineData::Value(val, ..) => mf(&[val], span, &name),
|
|
PipelineData::Empty { .. } => Err(ShellError::PipelineEmpty(name)),
|
|
val => Err(ShellError::UnsupportedInput(
|
|
"Only integers, floats, lists, records or ranges are supported".into(),
|
|
"value originates from here".into(),
|
|
name,
|
|
// This requires both the ListStream and Empty match arms to be above it.
|
|
val.span()
|
|
.expect("non-Empty non-ListStream PipelineData had no span"),
|
|
)),
|
|
}
|
|
}
|