forked from extern/nushell
# Description
Possible fix of #11456
This PR fixes a bug where builtin commands did not respect the logic of
dynamically passed boolean flags. The reason is
[has_flag](6f59abaf43/crates/nu-protocol/src/ast/call.rs (L204C5-L212C6)
)
method did not evaluate and take into consideration expression used with
flag.
To address this issue a solution is proposed:
1. `has_flag` method is moved to `CallExt` and new logic to evaluate
expression and check if it is a boolean value is added
2. `has_flag_const` method is added to `CallExt` which is a constant
version of `has_flag`
3. `has_named` method is added to `Call` which is basically the old
logic of `has_flag`
4. All usages of `has_flag` in code are updated, mostly to pass
`engine_state` and `stack` to new `has_flag`. In `run_const` commands it
is replaced with `has_flag_const`. And in a few select places: parser,
`to nuon` and `into string` old logic via `has_named` is used.
# User-Facing Changes
Explicit values of boolean flags are now respected in builtin commands.
Before:

After:

Another example:
Before:

After:

# Tests + Formatting
Added test reproducing some variants of original issue.
167 lines
4.6 KiB
Rust
167 lines
4.6 KiB
Rust
use nu_protocol::{
|
|
ast::Call,
|
|
engine::{EngineState, Stack},
|
|
FromValue, ShellError, Value,
|
|
};
|
|
|
|
use crate::eval_expression;
|
|
|
|
pub trait CallExt {
|
|
/// Check if a boolean flag is set (i.e. `--bool` or `--bool=true`)
|
|
fn has_flag(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
flag_name: &str,
|
|
) -> Result<bool, ShellError>;
|
|
|
|
fn get_flag<T: FromValue>(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
name: &str,
|
|
) -> Result<Option<T>, ShellError>;
|
|
|
|
fn rest<T: FromValue>(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
starting_pos: usize,
|
|
) -> Result<Vec<T>, ShellError>;
|
|
|
|
fn opt<T: FromValue>(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
pos: usize,
|
|
) -> Result<Option<T>, ShellError>;
|
|
|
|
fn req<T: FromValue>(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
pos: usize,
|
|
) -> Result<T, ShellError>;
|
|
|
|
fn req_parser_info<T: FromValue>(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
name: &str,
|
|
) -> Result<T, ShellError>;
|
|
}
|
|
|
|
impl CallExt for Call {
|
|
fn has_flag(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
flag_name: &str,
|
|
) -> Result<bool, ShellError> {
|
|
for name in self.named_iter() {
|
|
if flag_name == name.0.item {
|
|
return if let Some(expr) = &name.2 {
|
|
// Check --flag=false
|
|
let result = eval_expression(engine_state, stack, expr)?;
|
|
match result {
|
|
Value::Bool { val, .. } => Ok(val),
|
|
_ => Err(ShellError::CantConvert {
|
|
to_type: "bool".into(),
|
|
from_type: result.get_type().to_string(),
|
|
span: result.span(),
|
|
help: Some("".into()),
|
|
}),
|
|
}
|
|
} else {
|
|
Ok(true)
|
|
};
|
|
}
|
|
}
|
|
|
|
Ok(false)
|
|
}
|
|
|
|
fn get_flag<T: FromValue>(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
name: &str,
|
|
) -> Result<Option<T>, ShellError> {
|
|
if let Some(expr) = self.get_flag_expr(name) {
|
|
let result = eval_expression(engine_state, stack, expr)?;
|
|
FromValue::from_value(result).map(Some)
|
|
} else {
|
|
Ok(None)
|
|
}
|
|
}
|
|
|
|
fn rest<T: FromValue>(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
starting_pos: usize,
|
|
) -> Result<Vec<T>, ShellError> {
|
|
let mut output = vec![];
|
|
|
|
for result in self.rest_iter_flattened(starting_pos, |expr| {
|
|
eval_expression(engine_state, stack, expr)
|
|
})? {
|
|
output.push(FromValue::from_value(result)?);
|
|
}
|
|
|
|
Ok(output)
|
|
}
|
|
|
|
fn opt<T: FromValue>(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
pos: usize,
|
|
) -> Result<Option<T>, ShellError> {
|
|
if let Some(expr) = self.positional_nth(pos) {
|
|
let result = eval_expression(engine_state, stack, expr)?;
|
|
FromValue::from_value(result).map(Some)
|
|
} else {
|
|
Ok(None)
|
|
}
|
|
}
|
|
|
|
fn req<T: FromValue>(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
pos: usize,
|
|
) -> Result<T, ShellError> {
|
|
if let Some(expr) = self.positional_nth(pos) {
|
|
let result = eval_expression(engine_state, stack, expr)?;
|
|
FromValue::from_value(result)
|
|
} else if self.positional_len() == 0 {
|
|
Err(ShellError::AccessEmptyContent { span: self.head })
|
|
} else {
|
|
Err(ShellError::AccessBeyondEnd {
|
|
max_idx: self.positional_len() - 1,
|
|
span: self.head,
|
|
})
|
|
}
|
|
}
|
|
|
|
fn req_parser_info<T: FromValue>(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
name: &str,
|
|
) -> Result<T, ShellError> {
|
|
if let Some(expr) = self.get_parser_info(name) {
|
|
let result = eval_expression(engine_state, stack, expr)?;
|
|
FromValue::from_value(result)
|
|
} else if self.parser_info.is_empty() {
|
|
Err(ShellError::AccessEmptyContent { span: self.head })
|
|
} else {
|
|
Err(ShellError::AccessBeyondEnd {
|
|
max_idx: self.parser_info.len() - 1,
|
|
span: self.head,
|
|
})
|
|
}
|
|
}
|
|
}
|