Skip to content

Commit

Permalink
Redirect: support redirect stderr with piping stdout to next commands. (
Browse files Browse the repository at this point in the history
nushell#10851)

# Description
Fixes: nushell#10271

Given the following script:
```shell
# test.sh
echo aaaaa
echo bbbbb 1>&2
echo cc
```

This pr makes the following command possible:
```nushell
bash test.sh err> /dev/null | lines | each {|line| $line | str length}
```


## General idea behind the change:
When nushell redirect stderr message to external file
1. it take stdout of external stream, and pass this stream to next
command, so it won't block next pipeline command from running.
2. relative stderr stream are handled by `save` command

These two streams are handled separately, so we need to delegate a
thread to `save` command, or else we'll have a chance to hang nushell,
we have meet a similar before: nushell#5625.

### One case to consider
What if we're failed to save to an external stream? (Like we don't have
a permission to save to a file)?
In this case nushell will just print a waning message, and don't stop
the following scripts from running.

# User-Facing Changes
## Before
```nushell
❯ bash test2.sh err> /dev/null | lines | each {|line| $line | str length}
aaaaa
cc
```

## After
```nushell
❯ bash test2.sh err> /dev/null | lines | each {|line| $line | str length}
╭───┬───╮
│ 0 │ 5 │
│ 1 │ 2 │
╰───┴───╯
```

BTY, after this pr, the following commands are impossible either, it's
important to make sure that the implementation doesn't introduce too
much costs:
```nushell
❯ echo a e> a.txt e> a.txt
Error:   × Can't make stderr redirection twice
   ╭─[entry nushell#1:1:1]
 1 │ echo a e> a.txt e> a.txt
   ·                 ─┬
   ·                  ╰── try to remove one
   ╰────

❯ echo a o> a.txt o> a.txt
Error:   × Can't make stdout redirection twice
   ╭─[entry nushell#2:1:1]
 1 │ echo a o> a.txt o> a.txt
   ·                 ─┬
   ·                  ╰── try to remove one
   ╰────
```
  • Loading branch information
WindSoilder committed Nov 23, 2023
1 parent 6cfe35e commit 57808ca
Show file tree
Hide file tree
Showing 4 changed files with 270 additions and 84 deletions.
50 changes: 50 additions & 0 deletions crates/nu-command/tests/commands/redirection.rs
Original file line number Diff line number Diff line change
Expand Up @@ -288,3 +288,53 @@ fn redirection_should_have_a_target() {
);
}
}

#[test]
#[cfg(not(windows))]
fn redirection_with_pipe() {
use nu_test_support::fs::Stub::FileWithContent;
use nu_test_support::playground::Playground;
Playground::setup(
"external with many stdout and stderr messages",
|dirs, sandbox| {
let script_body = r#"
x=$(printf '=%.0s' {1..40})
echo -n $x
echo -n $x 1>&2
"#;
let mut expect_body = String::new();
for _ in 0..40 {
expect_body.push('=');
}

sandbox.with_files(vec![FileWithContent("test.sh", script_body)]);

// check for stdout
let actual = nu!(
cwd: dirs.test(),
"bash test.sh err> tmp_file | str length",
);

assert_eq!(actual.out, "40");
// check for stderr redirection file.
let expected_out_file = dirs.test().join("tmp_file");
let actual_len = file_contents(expected_out_file).len();
assert_eq!(actual_len, 40);

// check it inside a function
let actual = nu!(
cwd: dirs.test(),
"bash test.sh err> tmp_file; print aa"
);
assert!(actual.out.contains(&format!("{}aa", expect_body)));
},
)
}

#[test]
fn no_duplicate_redirection() {
let actual = nu!("echo 3 o> a.txt o> a.txt");
assert!(actual.err.contains("Redirection can be set only once"));
let actual = nu!("echo 3 e> a.txt e> a.txt");
assert!(actual.err.contains("Redirection can be set only once"));
}
Loading

0 comments on commit 57808ca

Please sign in to comment.