mirror of
https://github.com/nushell/nushell
synced 2024-12-27 13:33:16 +00:00
b6c7656194
# Description The PR overhauls how IO redirection is handled, allowing more explicit and fine-grain control over `stdout` and `stderr` output as well as more efficient IO and piping. To summarize the changes in this PR: - Added a new `IoStream` type to indicate the intended destination for a pipeline element's `stdout` and `stderr`. - The `stdout` and `stderr` `IoStream`s are stored in the `Stack` and to avoid adding 6 additional arguments to every eval function and `Command::run`. The `stdout` and `stderr` streams can be temporarily overwritten through functions on `Stack` and these functions will return a guard that restores the original `stdout` and `stderr` when dropped. - In the AST, redirections are now directly part of a `PipelineElement` as a `Option<Redirection>` field instead of having multiple different `PipelineElement` enum variants for each kind of redirection. This required changes to the parser, mainly in `lite_parser.rs`. - `Command`s can also set a `IoStream` override/redirection which will apply to the previous command in the pipeline. This is used, for example, in `ignore` to allow the previous external command to have its stdout redirected to `Stdio::null()` at spawn time. In contrast, the current implementation has to create an os pipe and manually consume the output on nushell's side. File and pipe redirections (`o>`, `e>`, `e>|`, etc.) have precedence over overrides from commands. This PR improves piping and IO speed, partially addressing #10763. Using the `throughput` command from that issue, this PR gives the following speedup on my setup for the commands below: | Command | Before (MB/s) | After (MB/s) | Bash (MB/s) | | --------------------------- | -------------:| ------------:| -----------:| | `throughput o> /dev/null` | 1169 | 52938 | 54305 | | `throughput \| ignore` | 840 | 55438 | N/A | | `throughput \| null` | Error | 53617 | N/A | | `throughput \| rg 'x'` | 1165 | 3049 | 3736 | | `(throughput) \| rg 'x'` | 810 | 3085 | 3815 | (Numbers above are the median samples for throughput) This PR also paves the way to refactor our `ExternalStream` handling in the various commands. For example, this PR already fixes the following code: ```nushell ^sh -c 'echo -n "hello "; sleep 0; echo "world"' | find "hello world" ``` This returns an empty list on 0.90.1 and returns a highlighted "hello world" on this PR. Since the `stdout` and `stderr` `IoStream`s are available to commands when they are run, then this unlocks the potential for more convenient behavior. E.g., the `find` command can disable its ansi highlighting if it detects that the output `IoStream` is not the terminal. Knowing the output streams will also allow background job output to be redirected more easily and efficiently. # User-Facing Changes - External commands returned from closures will be collected (in most cases): ```nushell 1..2 | each {|_| nu -c "print a" } ``` This gives `["a", "a"]` on this PR, whereas this used to print "a\na\n" and then return an empty list. ```nushell 1..2 | each {|_| nu -c "print -e a" } ``` This gives `["", ""]` and prints "a\na\n" to stderr, whereas this used to return an empty list and print "a\na\n" to stderr. - Trailing new lines are always trimmed for external commands when piping into internal commands or collecting it as a value. (Failure to decode the output as utf-8 will keep the trailing newline for the last binary value.) In the current nushell version, the following three code snippets differ only in parenthesis placement, but they all also have different outputs: 1. `1..2 | each { ^echo a }` ``` a a ╭────────────╮ │ empty list │ ╰────────────╯ ``` 2. `1..2 | each { (^echo a) }` ``` ╭───┬───╮ │ 0 │ a │ │ 1 │ a │ ╰───┴───╯ ``` 3. `1..2 | (each { ^echo a })` ``` ╭───┬───╮ │ 0 │ a │ │ │ │ │ 1 │ a │ │ │ │ ╰───┴───╯ ``` But in this PR, the above snippets will all have the same output: ``` ╭───┬───╮ │ 0 │ a │ │ 1 │ a │ ╰───┴───╯ ``` - All existing flags on `run-external` are now deprecated. - File redirections now apply to all commands inside a code block: ```nushell (nu -c "print -e a"; nu -c "print -e b") e> test.out ``` This gives "a\nb\n" in `test.out` and prints nothing. The same result would happen when printing to stdout and using a `o>` file redirection. - External command output will (almost) never be ignored, and ignoring output must be explicit now: ```nushell (^echo a; ^echo b) ``` This prints "a\nb\n", whereas this used to print only "b\n". This only applies to external commands; values and internal commands not in return position will not print anything (e.g., `(echo a; echo b)` still only prints "b"). - `complete` now always captures stderr (`do` is not necessary). # After Submitting The language guide and other documentation will need to be updated.
379 lines
11 KiB
Rust
379 lines
11 KiB
Rust
use nu_cmd_base::hook::{eval_env_change_hook, eval_hook};
|
|
use nu_engine::eval_block;
|
|
use nu_parser::parse;
|
|
use nu_protocol::debugger::WithoutDebug;
|
|
use nu_protocol::engine::{EngineState, Stack, StateWorkingSet};
|
|
use nu_protocol::{cli_error::CliError, PipelineData, Value};
|
|
use nu_std::load_standard_library;
|
|
use std::io::{self, BufRead, Read, Write};
|
|
|
|
/// Echo's value of env keys from args
|
|
/// Example: nu --testbin env_echo FOO BAR
|
|
/// If it it's not present echo's nothing
|
|
pub fn echo_env(to_stdout: bool) {
|
|
let args = args();
|
|
for arg in args {
|
|
echo_one_env(&arg, to_stdout)
|
|
}
|
|
}
|
|
|
|
pub fn echo_env_and_fail(to_stdout: bool) {
|
|
echo_env(to_stdout);
|
|
fail();
|
|
}
|
|
|
|
fn echo_one_env(arg: &str, to_stdout: bool) {
|
|
if let Ok(v) = std::env::var(arg) {
|
|
if to_stdout {
|
|
println!("{v}");
|
|
} else {
|
|
eprintln!("{v}");
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Mix echo of env keys from input
|
|
/// Example:
|
|
/// * nu --testbin echo_env_mixed out-err FOO BAR
|
|
/// * nu --testbin echo_env_mixed err-out FOO BAR
|
|
/// If it's not present, panic instead
|
|
pub fn echo_env_mixed() {
|
|
let args = args();
|
|
let args = &args[1..];
|
|
|
|
if args.len() != 3 {
|
|
panic!(
|
|
r#"Usage examples:
|
|
* nu --testbin echo_env_mixed out-err FOO BAR
|
|
* nu --testbin echo_env_mixed err-out FOO BAR"#
|
|
)
|
|
}
|
|
match args[0].as_str() {
|
|
"out-err" => {
|
|
let (out_arg, err_arg) = (&args[1], &args[2]);
|
|
echo_one_env(out_arg, true);
|
|
echo_one_env(err_arg, false);
|
|
}
|
|
"err-out" => {
|
|
let (err_arg, out_arg) = (&args[1], &args[2]);
|
|
echo_one_env(err_arg, false);
|
|
echo_one_env(out_arg, true);
|
|
}
|
|
_ => panic!("The mixed type must be `out_err`, `err_out`"),
|
|
}
|
|
}
|
|
|
|
/// Cross platform echo using println!()
|
|
/// Example: nu --testbin echo a b c
|
|
/// a b c
|
|
pub fn cococo() {
|
|
let args: Vec<String> = args();
|
|
|
|
if args.len() > 1 {
|
|
// Write back out all the arguments passed
|
|
// if given at least 1 instead of chickens
|
|
// speaking co co co.
|
|
println!("{}", &args[1..].join(" "));
|
|
} else {
|
|
println!("cococo");
|
|
}
|
|
}
|
|
|
|
/// Cross platform cat (open a file, print the contents) using read_to_string and println!()
|
|
pub fn meow() {
|
|
let args: Vec<String> = args();
|
|
|
|
for arg in args.iter().skip(1) {
|
|
let contents = std::fs::read_to_string(arg).expect("Expected a filepath");
|
|
println!("{contents}");
|
|
}
|
|
}
|
|
|
|
/// Cross platform cat (open a file, print the contents) using read() and write_all() / binary
|
|
pub fn meowb() {
|
|
let args: Vec<String> = args();
|
|
|
|
let stdout = io::stdout();
|
|
let mut handle = stdout.lock();
|
|
|
|
for arg in args.iter().skip(1) {
|
|
let buf = std::fs::read(arg).expect("Expected a filepath");
|
|
handle.write_all(&buf).expect("failed to write to stdout");
|
|
}
|
|
}
|
|
|
|
// Relays anything received on stdin to stdout
|
|
pub fn relay() {
|
|
io::copy(&mut io::stdin().lock(), &mut io::stdout().lock())
|
|
.expect("failed to copy stdin to stdout");
|
|
}
|
|
|
|
/// Cross platform echo but concats arguments without space and NO newline
|
|
/// nu --testbin nonu a b c
|
|
/// abc
|
|
pub fn nonu() {
|
|
args().iter().skip(1).for_each(|arg| print!("{arg}"));
|
|
}
|
|
|
|
/// Repeat a string or char N times
|
|
/// nu --testbin repeater a 5
|
|
/// aaaaa
|
|
/// nu --testbin repeater test 5
|
|
/// testtesttesttesttest
|
|
pub fn repeater() {
|
|
let mut stdout = io::stdout();
|
|
let args = args();
|
|
let mut args = args.iter().skip(1);
|
|
let letter = args.next().expect("needs a character to iterate");
|
|
let count = args.next().expect("need the number of times to iterate");
|
|
|
|
let count: u64 = count.parse().expect("can't convert count to number");
|
|
|
|
for _ in 0..count {
|
|
let _ = write!(stdout, "{letter}");
|
|
}
|
|
let _ = stdout.flush();
|
|
}
|
|
|
|
/// A version of repeater that can output binary data, even null bytes
|
|
pub fn repeat_bytes() {
|
|
let mut stdout = io::stdout();
|
|
let args = args();
|
|
let mut args = args.iter().skip(1);
|
|
|
|
while let (Some(binary), Some(count)) = (args.next(), args.next()) {
|
|
let bytes: Vec<u8> = (0..binary.len())
|
|
.step_by(2)
|
|
.map(|i| {
|
|
u8::from_str_radix(&binary[i..i + 2], 16)
|
|
.expect("binary string is valid hexadecimal")
|
|
})
|
|
.collect();
|
|
let count: u64 = count.parse().expect("repeat count must be a number");
|
|
|
|
for _ in 0..count {
|
|
stdout
|
|
.write_all(&bytes)
|
|
.expect("writing to stdout must not fail");
|
|
}
|
|
}
|
|
|
|
let _ = stdout.flush();
|
|
}
|
|
|
|
/// Another type of echo that outputs a parameter per line, looping infinitely
|
|
pub fn iecho() {
|
|
// println! panics if stdout gets closed, whereas writeln gives us an error
|
|
let mut stdout = io::stdout();
|
|
let _ = args()
|
|
.iter()
|
|
.skip(1)
|
|
.cycle()
|
|
.try_for_each(|v| writeln!(stdout, "{v}"));
|
|
}
|
|
|
|
pub fn fail() {
|
|
std::process::exit(1);
|
|
}
|
|
|
|
/// With no parameters, will chop a character off the end of each line
|
|
pub fn chop() {
|
|
if did_chop_arguments() {
|
|
// we are done and don't care about standard input.
|
|
std::process::exit(0);
|
|
}
|
|
|
|
// if no arguments given, chop from standard input and exit.
|
|
let stdin = io::stdin();
|
|
let mut stdout = io::stdout();
|
|
|
|
for given in stdin.lock().lines().map_while(Result::ok) {
|
|
let chopped = if given.is_empty() {
|
|
&given
|
|
} else {
|
|
let to = given.len() - 1;
|
|
&given[..to]
|
|
};
|
|
|
|
if let Err(_e) = writeln!(stdout, "{chopped}") {
|
|
break;
|
|
}
|
|
}
|
|
|
|
std::process::exit(0);
|
|
}
|
|
|
|
fn outcome_err(
|
|
engine_state: &EngineState,
|
|
error: &(dyn miette::Diagnostic + Send + Sync + 'static),
|
|
) -> ! {
|
|
let working_set = StateWorkingSet::new(engine_state);
|
|
|
|
eprintln!("Error: {:?}", CliError(error, &working_set));
|
|
|
|
std::process::exit(1);
|
|
}
|
|
|
|
fn outcome_ok(msg: String) -> ! {
|
|
println!("{msg}");
|
|
|
|
std::process::exit(0);
|
|
}
|
|
|
|
/// Generate a minimal engine state with just `nu-cmd-lang`, `nu-command`, and `nu-cli` commands.
|
|
fn get_engine_state() -> EngineState {
|
|
let engine_state = nu_cmd_lang::create_default_context();
|
|
let engine_state = nu_command::add_shell_command_context(engine_state);
|
|
nu_cli::add_cli_context(engine_state)
|
|
}
|
|
|
|
pub fn nu_repl() {
|
|
//cwd: &str, source_lines: &[&str]) {
|
|
let cwd = std::env::current_dir().expect("Could not get current working directory.");
|
|
let source_lines = args();
|
|
|
|
let mut engine_state = get_engine_state();
|
|
let mut stack = Stack::new();
|
|
|
|
engine_state.add_env_var("PWD".into(), Value::test_string(cwd.to_string_lossy()));
|
|
|
|
let mut last_output = String::new();
|
|
|
|
load_standard_library(&mut engine_state).expect("Could not load the standard library.");
|
|
|
|
for (i, line) in source_lines.iter().enumerate() {
|
|
let cwd = nu_engine::env::current_dir(&engine_state, &stack)
|
|
.unwrap_or_else(|err| outcome_err(&engine_state, &err));
|
|
|
|
// Before doing anything, merge the environment from the previous REPL iteration into the
|
|
// permanent state.
|
|
if let Err(err) = engine_state.merge_env(&mut stack, &cwd) {
|
|
outcome_err(&engine_state, &err);
|
|
}
|
|
|
|
// Check for pre_prompt hook
|
|
let config = engine_state.get_config();
|
|
if let Some(hook) = config.hooks.pre_prompt.clone() {
|
|
if let Err(err) = eval_hook(
|
|
&mut engine_state,
|
|
&mut stack,
|
|
None,
|
|
vec![],
|
|
&hook,
|
|
"pre_prompt",
|
|
) {
|
|
outcome_err(&engine_state, &err);
|
|
}
|
|
}
|
|
|
|
// Check for env change hook
|
|
let config = engine_state.get_config();
|
|
if let Err(err) = eval_env_change_hook(
|
|
config.hooks.env_change.clone(),
|
|
&mut engine_state,
|
|
&mut stack,
|
|
) {
|
|
outcome_err(&engine_state, &err);
|
|
}
|
|
|
|
// Check for pre_execution hook
|
|
let config = engine_state.get_config();
|
|
|
|
engine_state
|
|
.repl_state
|
|
.lock()
|
|
.expect("repl state mutex")
|
|
.buffer = line.to_string();
|
|
|
|
if let Some(hook) = config.hooks.pre_execution.clone() {
|
|
if let Err(err) = eval_hook(
|
|
&mut engine_state,
|
|
&mut stack,
|
|
None,
|
|
vec![],
|
|
&hook,
|
|
"pre_execution",
|
|
) {
|
|
outcome_err(&engine_state, &err);
|
|
}
|
|
}
|
|
|
|
// Eval the REPL line
|
|
let (block, delta) = {
|
|
let mut working_set = StateWorkingSet::new(&engine_state);
|
|
let block = parse(
|
|
&mut working_set,
|
|
Some(&format!("line{i}")),
|
|
line.as_bytes(),
|
|
false,
|
|
);
|
|
|
|
if let Some(err) = working_set.parse_errors.first() {
|
|
outcome_err(&engine_state, err);
|
|
}
|
|
(block, working_set.render())
|
|
};
|
|
|
|
if let Err(err) = engine_state.merge_delta(delta) {
|
|
outcome_err(&engine_state, &err);
|
|
}
|
|
|
|
let input = PipelineData::empty();
|
|
let config = engine_state.get_config();
|
|
|
|
let stack = &mut stack.start_capture();
|
|
match eval_block::<WithoutDebug>(&engine_state, stack, &block, input) {
|
|
Ok(pipeline_data) => match pipeline_data.collect_string("", config) {
|
|
Ok(s) => last_output = s,
|
|
Err(err) => outcome_err(&engine_state, &err),
|
|
},
|
|
Err(err) => outcome_err(&engine_state, &err),
|
|
}
|
|
|
|
if let Some(cwd) = stack.get_env_var(&engine_state, "PWD") {
|
|
let path = cwd
|
|
.coerce_str()
|
|
.unwrap_or_else(|err| outcome_err(&engine_state, &err));
|
|
let _ = std::env::set_current_dir(path.as_ref());
|
|
engine_state.add_env_var("PWD".into(), cwd);
|
|
}
|
|
}
|
|
|
|
outcome_ok(last_output)
|
|
}
|
|
|
|
fn did_chop_arguments() -> bool {
|
|
let args: Vec<String> = args();
|
|
|
|
if args.len() > 1 {
|
|
let mut arguments = args.iter();
|
|
arguments.next();
|
|
|
|
for arg in arguments {
|
|
let chopped = if arg.is_empty() {
|
|
arg
|
|
} else {
|
|
let to = arg.len() - 1;
|
|
&arg[..to]
|
|
};
|
|
|
|
println!("{chopped}");
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
false
|
|
}
|
|
|
|
pub fn input_bytes_length() {
|
|
let stdin = io::stdin();
|
|
let count = stdin.lock().bytes().count();
|
|
|
|
println!("{}", count);
|
|
}
|
|
|
|
fn args() -> Vec<String> {
|
|
// skip (--testbin bin_name args)
|
|
std::env::args().skip(2).collect()
|
|
}
|