mirror of
https://github.com/nushell/nushell
synced 2025-01-08 19:29:08 +00:00
6fd854ed9f
# Description
This PR introduces a `ByteStream` type which is a `Read`-able stream of
bytes. Internally, it has an enum over three different byte stream
sources:
```rust
pub enum ByteStreamSource {
Read(Box<dyn Read + Send + 'static>),
File(File),
Child(ChildProcess),
}
```
This is in comparison to the current `RawStream` type, which is an
`Iterator<Item = Vec<u8>>` and has to allocate for each read chunk.
Currently, `PipelineData::ExternalStream` serves a weird dual role where
it is either external command output or a wrapper around `RawStream`.
`ByteStream` makes this distinction more clear (via `ByteStreamSource`)
and replaces `PipelineData::ExternalStream` in this PR:
```rust
pub enum PipelineData {
Empty,
Value(Value, Option<PipelineMetadata>),
ListStream(ListStream, Option<PipelineMetadata>),
ByteStream(ByteStream, Option<PipelineMetadata>),
}
```
The PR is relatively large, but a decent amount of it is just repetitive
changes.
This PR fixes #7017, fixes #10763, and fixes #12369.
This PR also improves performance when piping external commands. Nushell
should, in most cases, have competitive pipeline throughput compared to,
e.g., bash.
| Command | Before (MB/s) | After (MB/s) | Bash (MB/s) |
| -------------------------------------------------- | -------------:|
------------:| -----------:|
| `throughput \| rg 'x'` | 3059 | 3744 | 3739 |
| `throughput \| nu --testbin relay o> /dev/null` | 3508 | 8087 | 8136 |
# User-Facing Changes
- This is a breaking change for the plugin communication protocol,
because the `ExternalStreamInfo` was replaced with `ByteStreamInfo`.
Plugins now only have to deal with a single input stream, as opposed to
the previous three streams: stdout, stderr, and exit code.
- The output of `describe` has been changed for external/byte streams.
- Temporary breaking change: `bytes starts-with` no longer works with
byte streams. This is to keep the PR smaller, and `bytes ends-with`
already does not work on byte streams.
- If a process core dumped, then instead of having a `Value::Error` in
the `exit_code` column of the output returned from `complete`, it now is
a `Value::Int` with the negation of the signal number.
# After Submitting
- Update docs and book as necessary
- Release notes (e.g., plugin protocol changes)
- Adapt/convert commands to work with byte streams (high priority is
`str length`, `bytes starts-with`, and maybe `bytes ends-with`).
- Refactor the `tee` code, Devyn has already done some work on this.
---------
Co-authored-by: Devyn Cairns <devyn.cairns@gmail.com>
120 lines
3.6 KiB
Rust
120 lines
3.6 KiB
Rust
use nu_test_support::nu;
|
|
|
|
#[test]
|
|
fn basic_binary_starts_with() {
|
|
let actual = nu!(r#"
|
|
"hello world" | into binary | bytes starts-with 0x[68 65 6c 6c 6f]
|
|
"#);
|
|
|
|
assert_eq!(actual.out, "true");
|
|
}
|
|
|
|
#[test]
|
|
fn basic_string_fails() {
|
|
let actual = nu!(r#"
|
|
"hello world" | bytes starts-with 0x[68 65 6c 6c 6f]
|
|
"#);
|
|
|
|
assert!(actual.err.contains("command doesn't support"));
|
|
assert_eq!(actual.out, "");
|
|
}
|
|
|
|
// #[test]
|
|
// fn short_stream_binary() {
|
|
// let actual = nu!(r#"
|
|
// nu --testbin repeater (0x[01]) 5 | bytes starts-with 0x[010101]
|
|
// "#);
|
|
|
|
// assert_eq!(actual.out, "true");
|
|
// }
|
|
|
|
// #[test]
|
|
// fn short_stream_mismatch() {
|
|
// let actual = nu!(r#"
|
|
// nu --testbin repeater (0x[010203]) 5 | bytes starts-with 0x[010204]
|
|
// "#);
|
|
|
|
// assert_eq!(actual.out, "false");
|
|
// }
|
|
|
|
// #[test]
|
|
// fn short_stream_binary_overflow() {
|
|
// let actual = nu!(r#"
|
|
// nu --testbin repeater (0x[01]) 5 | bytes starts-with 0x[010101010101]
|
|
// "#);
|
|
|
|
// assert_eq!(actual.out, "false");
|
|
// }
|
|
|
|
// #[test]
|
|
// fn long_stream_binary() {
|
|
// let actual = nu!(r#"
|
|
// nu --testbin repeater (0x[01]) 32768 | bytes starts-with 0x[010101]
|
|
// "#);
|
|
|
|
// assert_eq!(actual.out, "true");
|
|
// }
|
|
|
|
// #[test]
|
|
// fn long_stream_binary_overflow() {
|
|
// // .. ranges are inclusive..inclusive, so we don't need to +1 to check for an overflow
|
|
// let actual = nu!(r#"
|
|
// nu --testbin repeater (0x[01]) 32768 | bytes starts-with (0..32768 | each {|| 0x[01] } | bytes collect)
|
|
// "#);
|
|
|
|
// assert_eq!(actual.out, "false");
|
|
// }
|
|
|
|
// #[test]
|
|
// fn long_stream_binary_exact() {
|
|
// // ranges are inclusive..inclusive, so we don't need to +1 to check for an overflow
|
|
// let actual = nu!(r#"
|
|
// nu --testbin repeater (0x[01020304]) 8192 | bytes starts-with (0..<8192 | each {|| 0x[01020304] } | bytes collect)
|
|
// "#);
|
|
|
|
// assert_eq!(actual.out, "true");
|
|
// }
|
|
|
|
// #[test]
|
|
// fn long_stream_string_exact() {
|
|
// // ranges are inclusive..inclusive, so we don't need to +1 to check for an overflow
|
|
// let actual = nu!(r#"
|
|
// nu --testbin repeater hell 8192 | bytes starts-with (0..<8192 | each {|| "hell" | into binary } | bytes collect)
|
|
// "#);
|
|
|
|
// assert_eq!(actual.out, "true");
|
|
// }
|
|
|
|
// #[test]
|
|
// fn long_stream_mixed_exact() {
|
|
// // ranges are inclusive..inclusive, so we don't need to +1 to check for an overflow
|
|
// let actual = nu!(r#"
|
|
// let binseg = (0..<2048 | each {|| 0x[003d9fbf] } | bytes collect)
|
|
// let strseg = (0..<2048 | each {|| "hell" | into binary } | bytes collect)
|
|
|
|
// nu --testbin repeat_bytes 003d9fbf 2048 68656c6c 2048 | bytes starts-with (bytes build $binseg $strseg)
|
|
// "#);
|
|
|
|
// assert_eq!(
|
|
// actual.err, "",
|
|
// "invocation failed. command line limit likely reached"
|
|
// );
|
|
// assert_eq!(actual.out, "true");
|
|
// }
|
|
|
|
// #[test]
|
|
// fn long_stream_mixed_overflow() {
|
|
// // ranges are inclusive..inclusive, so we don't need to +1 to check for an overflow
|
|
// let actual = nu!(r#"
|
|
// let binseg = (0..<2048 | each {|| 0x[003d9fbf] } | bytes collect)
|
|
// let strseg = (0..<2048 | each {|| "hell" | into binary } | bytes collect)
|
|
|
|
// nu --testbin repeat_bytes 003d9fbf 2048 68656c6c 2048 | bytes starts-with (bytes build $binseg $strseg 0x[01])
|
|
// "#);
|
|
|
|
// assert_eq!(
|
|
// actual.err, "",
|
|
// "invocation failed. command line limit likely reached"
|
|
// );
|
|
// assert_eq!(actual.out, "false");
|
|
// }
|