Skip to content

Commit

Permalink
Fix panic on too few arguments for custom function (#10395)
Browse files Browse the repository at this point in the history
# Description
Old code was comparing remaining positional arguments with total number
of arguments, where it should've compared remaining positional with
with remaining arguments of any kind. This means that if a function was
given too few arguments, `calculate_end_span` would believe that it
actually had too many arguments, since after parsing the first few
arguments, the number of remaining arguments needed were fewer than the
*total* number of arguments, of which we had used several.

Fixes #9072
Fixes: nushell/nushell#13930
Fixes: nushell/nushell#12069
Fixes: nushell/nushell#8385

Extracted from #10381

## Bonus

It also improves the error handling on missing positional arguments
before keywords (no longer crashing since #9851). Instead of just giving
the keyword to the parser for the missing positional, we give an
explicit error about a missing positional argument. I would like better
descriptions than "missing var_name" though, but I'm not sure if that's
available without

Old error
```
Error: nu::parser::parse_mismatch

  × Parse mismatch during operation.
   ╭─[entry #1:1:1]
 1 │ let = if foo
   ·     ┬
   ·     ╰── expected valid variable name
   ╰────
```

New error
```
Error: nu::parser::missing_positional

  × Missing required positional argument.
   ╭─[entry #18:1:1]
 1 │ let = foo
   ·    ┬
   ·    ╰── missing var_name
   ╰────
  help: Usage: let <var_name> = <initial_value>
```

# User-Facing Changes
The program `alias = = =` is no longer accepted by the parser
  • Loading branch information
anka-213 authored Sep 27, 2024
1 parent 497954d commit 8200831
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 37 deletions.
44 changes: 29 additions & 15 deletions crates/nu-parser/src/parser.rs
Original file line number Diff line number Diff line change
Expand Up @@ -734,22 +734,23 @@ fn calculate_end_span(
// keywords, they get to set this by being present

let positionals_between = kw_pos - positional_idx - 1;
if positionals_between > (kw_idx - spans_idx) {
if positionals_between >= (kw_idx - spans_idx) {
kw_idx
} else {
kw_idx - positionals_between
}
} else {
// Make space for the remaining require positionals, if we can
if signature.num_positionals_after(positional_idx) == 0 {
spans.len()
} else if positional_idx < signature.required_positional.len()
&& spans.len() > (signature.required_positional.len() - positional_idx)
{
spans.len() - (signature.required_positional.len() - positional_idx - 1)
} else {
spans_idx + 1
}
// spans_idx < spans.len() is an invariant
let remaining_spans = spans.len() - (spans_idx + 1);
// positional_idx can be larger than required_positional.len() if we have optional args
let remaining_positional = signature
.required_positional
.len()
.saturating_sub(positional_idx + 1);
// Saturates to 0 when we have too few args
let extra_spans = remaining_spans.saturating_sub(remaining_positional);
spans_idx + 1 + extra_spans
}
}
}
Expand Down Expand Up @@ -1164,11 +1165,24 @@ pub fn parse_internal_call(
if let Some(positional) = signature.get_positional(positional_idx) {
let end = calculate_end_span(working_set, &signature, spans, spans_idx, positional_idx);

let end = if spans.len() > spans_idx && end == spans_idx {
end + 1
} else {
end
};
// Missing arguments before next keyword
if end == spans_idx {
let prev_span = if spans_idx == 0 {
command_span
} else {
spans[spans_idx - 1]
};
let whitespace_span = Span::new(prev_span.end, spans[spans_idx].start);
working_set.error(ParseError::MissingPositional(
positional.name.clone(),
whitespace_span,
signature.call_signature(),
));
call.add_positional(Expression::garbage(working_set, whitespace_span));
positional_idx += 1;
continue;
}
debug_assert!(end <= spans.len());

if spans[..end].is_empty() || spans_idx == end {
working_set.error(ParseError::MissingPositional(
Expand Down
21 changes: 0 additions & 21 deletions crates/nu-protocol/src/signature.rs
Original file line number Diff line number Diff line change
Expand Up @@ -522,27 +522,6 @@ impl Signature {
total
}

pub fn num_positionals_after(&self, idx: usize) -> usize {
let mut total = 0;

for (curr, positional) in self.required_positional.iter().enumerate() {
match positional.shape {
SyntaxShape::Keyword(..) => {
// Keywords have a required argument, so account for that
if curr > idx {
total += 2;
}
}
_ => {
if curr > idx {
total += 1;
}
}
}
}
total
}

/// Find the matching long flag
pub fn get_long_flag(&self, name: &str) -> Option<Flag> {
for flag in &self.named {
Expand Down
26 changes: 25 additions & 1 deletion tests/repl/test_parser.rs
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,31 @@ fn assignment_with_no_var() -> TestResult {
"mut = 'foo' | $in; $x | describe",
];

let expected = "valid variable";
let expecteds = [
"missing var_name",
"missing var_name",
"missing const_name",
"missing var_name",
"missing var_name",
];

for (case, expected) in std::iter::zip(cases, expecteds) {
fail_test(case, expected)?;
}

Ok(())
}

#[test]
fn too_few_arguments() -> TestResult {
// Test for https://github.com/nushell/nushell/issues/9072
let cases = [
"def a [b: bool, c: bool, d: float, e: float, f: float] {}; a true true 1 1",
"def a [b: bool, c: bool, d: float, e: float, f: float, g: float] {}; a true true 1 1",
"def a [b: bool, c: bool, d: float, e: float, f: float, g: float, h: float] {}; a true true 1 1",
];

let expected = "missing f";

for case in cases {
fail_test(case, expected)?;
Expand Down

0 comments on commit 8200831

Please sign in to comment.