extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-08-09 11:05:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix incorrect handling of boolean flags for builtin commands (#11492)

Browse Source 
# 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:

![image](https://github.com/nushell/nushell/assets/17511668/f9fbabb2-3cfd-43f9-ba9e-ece76d80043c)
After:

![image](https://github.com/nushell/nushell/assets/17511668/21867596-2075-437f-9c85-45563ac70083)

Another example:
Before:

![image](https://github.com/nushell/nushell/assets/17511668/efdbc5ca-5227-45a4-ac5b-532cdc2bbf5f)
After:

![image](https://github.com/nushell/nushell/assets/17511668/2907d5c5-aa93-404d-af1c-21cdc3d44646)


# Tests + Formatting
Added test reproducing some variants of original issue.
This commit is contained in:
Artemiy
2024-01-11 18:19:48 +03:00
committed by GitHub
parent 62272975f2
commit 1867bb1a88
149 changed files with 771 additions and 504 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
crates/nu-parser/src/parse_keywords.rs
View File

@ -280,7 +280,12 @@ pub fn parse_for(working_set: &mut StateWorkingSet, spans: &[Span]) -> Expressio
let starting_error_count = working_set.parse_errors.len();
check_call(working_set, call_span, &sig, &call);
if starting_error_count != working_set.parse_errors.len() || call.has_flag("help") {
let Ok(is_help) = has_flag_wrapped(working_set, &call, "help") else {
return garbage(spans[0]);
};
if starting_error_count != working_set.parse_errors.len() || is_help {
return Expression {
expr: Expr::Call(call),
span: call_span,
@ -464,7 +469,12 @@ pub fn parse_def(
let starting_error_count = working_set.parse_errors.len();
check_call(working_set, call_span, &sig, &call);
working_set.parse_errors.append(&mut new_errors);
if starting_error_count != working_set.parse_errors.len() || call.has_flag("help") {
let Ok(is_help) = has_flag_wrapped(working_set, &call, "help") else {
return (garbage_pipeline(spans), None);
};
if starting_error_count != working_set.parse_errors.len() || is_help {
return (
Pipeline::from_vec(vec![Expression {
expr: Expr::Call(call),
@ -480,8 +490,12 @@ pub fn parse_def(
}
};
let has_env = call.has_flag("env");
let has_wrapped = call.has_flag("wrapped");
let Ok(has_env) = has_flag_wrapped(working_set, &call, "env") else {
return (garbage_pipeline(spans), None);
};
let Ok(has_wrapped) = has_flag_wrapped(working_set, &call, "wrapped") else {
return (garbage_pipeline(spans), None);
};
// All positional arguments must be in the call positional vector by this point
let name_expr = call.positional_nth(0).expect("def call already checked");
@ -870,7 +884,9 @@ pub fn parse_alias(
.parse_errors
.truncate(original_starting_error_count);
let has_help_flag = alias_call.has_flag("help");
let Ok(has_help_flag) = has_flag_wrapped(working_set, &alias_call, "help") else {
return garbage_pipeline(spans);
};
let alias_pipeline = Pipeline::from_vec(vec![Expression {
expr: Expr::Call(alias_call.clone()),
@ -1122,7 +1138,12 @@ pub fn parse_export_in_block(
let starting_error_count = working_set.parse_errors.len();
check_call(working_set, call_span, &decl.signature(), &call);
if starting_error_count != working_set.parse_errors.len() || call.has_flag("help") {
let Ok(is_help) = has_flag_wrapped(working_set, &call, "help") else {
return garbage_pipeline(&lite_command.parts);
};
if starting_error_count != working_set.parse_errors.len() || is_help {
return Pipeline::from_vec(vec![Expression {
expr: Expr::Call(call),
span: call_span,
@ -1606,7 +1627,12 @@ pub fn parse_export_env(
let starting_error_count = working_set.parse_errors.len();
check_call(working_set, call_span, &decl.signature(), &call);
if starting_error_count != working_set.parse_errors.len() || call.has_flag("help") {
let Ok(is_help) = has_flag_wrapped(working_set, &call, "help") else {
return (garbage_pipeline(spans), None);
};
if starting_error_count != working_set.parse_errors.len() || is_help {
return (
Pipeline::from_vec(vec![Expression {
expr: Expr::Call(call),
@ -2092,7 +2118,12 @@ pub fn parse_module(
let starting_error_count = working_set.parse_errors.len();
check_call(working_set, call_span, &decl.signature(), &call);
if starting_error_count != working_set.parse_errors.len() || call.has_flag("help") {
let Ok(is_help) = has_flag_wrapped(working_set, &call, "help") else {
return (garbage_pipeline(spans), None);
};
if starting_error_count != working_set.parse_errors.len() || is_help {
return (
Pipeline::from_vec(vec![Expression {
expr: Expr::Call(call),
@ -2284,7 +2315,12 @@ pub fn parse_use(working_set: &mut StateWorkingSet, spans: &[Span]) -> (Pipeline
let starting_error_count = working_set.parse_errors.len();
check_call(working_set, call_span, &decl.signature(), &call);
if starting_error_count != working_set.parse_errors.len() || call.has_flag("help") {
let Ok(is_help) = has_flag_wrapped(working_set, &call, "help") else {
return (garbage_pipeline(spans), vec![]);
};
if starting_error_count != working_set.parse_errors.len() || is_help {
return (
Pipeline::from_vec(vec![Expression {
expr: Expr::Call(call),
@ -2466,7 +2502,12 @@ pub fn parse_hide(working_set: &mut StateWorkingSet, spans: &[Span]) -> Pipeline
let starting_error_count = working_set.parse_errors.len();
check_call(working_set, call_span, &decl.signature(), &call);
if starting_error_count != working_set.parse_errors.len() || call.has_flag("help") {
let Ok(is_help) = has_flag_wrapped(working_set, &call, "help") else {
return garbage_pipeline(spans);
};
if starting_error_count != working_set.parse_errors.len() || is_help {
return Pipeline::from_vec(vec![Expression {
expr: Expr::Call(call),
span: call_span,
@ -2724,8 +2765,12 @@ pub fn parse_overlay_use(working_set: &mut StateWorkingSet, call: Box<Call>) ->
None
};
let has_prefix = call.has_flag("prefix");
let do_reload = call.has_flag("reload");
let Ok(has_prefix) = has_flag_wrapped(working_set, &call, "prefix") else {
return garbage_pipeline(&[call_span]);
};
let Ok(do_reload) = has_flag_wrapped(working_set, &call, "reload") else {
return garbage_pipeline(&[call_span]);
};
let pipeline = Pipeline::from_vec(vec![Expression {
expr: Expr::Call(call.clone()),
@ -2911,7 +2956,9 @@ pub fn parse_overlay_hide(working_set: &mut StateWorkingSet, call: Box<Call>) ->
)
};
let keep_custom = call.has_flag("keep-custom");
let Ok(keep_custom) = has_flag_wrapped(working_set, &call, "keep-custom") else {
return garbage_pipeline(&[call_span]);
};
let pipeline = Pipeline::from_vec(vec![Expression {
expr: Expr::Call(call),
@ -3327,7 +3374,11 @@ pub fn parse_source(working_set: &mut StateWorkingSet, spans: &[Span]) -> Pipeli
let ParsedInternalCall { call, output } =
parse_internal_call(working_set, spans[0], &spans[1..], decl_id);
if call.has_flag("help") {
let Ok(is_help) = has_flag_wrapped(working_set, &call, "help") else {
return garbage_pipeline(spans);
};
if is_help {
return Pipeline::from_vec(vec![Expression {
expr: Expr::Call(call),
span: span(spans),
@ -3460,7 +3511,12 @@ pub fn parse_where_expr(working_set: &mut StateWorkingSet, spans: &[Span]) -> Ex
let starting_error_count = working_set.parse_errors.len();
check_call(working_set, call_span, &decl.signature(), &call);
if starting_error_count != working_set.parse_errors.len() || call.has_flag("help") {
let Ok(is_help) = has_flag_wrapped(working_set, &call, "help") else {
return garbage(span(spans));
};
if starting_error_count != working_set.parse_errors.len() || is_help {
return Expression {
expr: Expr::Call(call),
span: call_span,
@ -3530,7 +3586,12 @@ pub fn parse_register(working_set: &mut StateWorkingSet, spans: &[Span]) -> Pipe
let starting_error_count = working_set.parse_errors.len();
check_call(working_set, call_span, &decl.signature(), &call);
if starting_error_count != working_set.parse_errors.len() || call.has_flag("help") {
let Ok(is_help) = has_flag_wrapped(working_set, &call, "help") else {
return garbage_pipeline(spans);
};
if starting_error_count != working_set.parse_errors.len() || is_help {
return Pipeline::from_vec(vec![Expression {
expr: Expr::Call(call),
span: call_span,
@ -3852,3 +3913,14 @@ fn detect_params_in_name(
None
}
}
/// Run has_flag_const and and push possible error to working_set
fn has_flag_wrapped(
working_set: &mut StateWorkingSet,
call: &Call,
name: &str,
) -> Result<bool, ()> {
call.has_flag_const(working_set, name).map_err(|err| {
working_set.error(err.wrap(working_set, call.span()));
})
}