mirror of
https://github.com/nushell/nushell.git
synced 2024-11-26 02:13:47 +01: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>
89 lines
2.4 KiB
Rust
89 lines
2.4 KiB
Rust
//! Extended from `nu-plugin` examples.
|
|
|
|
use nu_plugin::*;
|
|
use nu_plugin_test_support::PluginTest;
|
|
use nu_protocol::{Example, LabeledError, ShellError, Signature, Type, Value};
|
|
|
|
struct HelloPlugin;
|
|
struct Hello;
|
|
|
|
impl Plugin for HelloPlugin {
|
|
fn commands(&self) -> Vec<Box<dyn PluginCommand<Plugin = Self>>> {
|
|
vec![Box::new(Hello)]
|
|
}
|
|
}
|
|
|
|
impl SimplePluginCommand for Hello {
|
|
type Plugin = HelloPlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"hello"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Print a friendly greeting"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(PluginCommand::name(self)).input_output_type(Type::Nothing, Type::String)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
example: "hello",
|
|
description: "Print a friendly greeting",
|
|
result: Some(Value::test_string("Hello, World!")),
|
|
}]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &HelloPlugin,
|
|
_engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
_input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
Ok(Value::string("Hello, World!".to_owned(), call.head))
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_specified_examples() -> Result<(), ShellError> {
|
|
PluginTest::new("hello", HelloPlugin.into())?.test_command_examples(&Hello)
|
|
}
|
|
|
|
#[test]
|
|
fn test_an_error_causing_example() -> Result<(), ShellError> {
|
|
let result = PluginTest::new("hello", HelloPlugin.into())?.test_examples(&[Example {
|
|
example: "hello --unknown-flag",
|
|
description: "Run hello with an unknown flag",
|
|
result: Some(Value::test_string("Hello, World!")),
|
|
}]);
|
|
assert!(result.is_err());
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn test_an_example_with_the_wrong_result() -> Result<(), ShellError> {
|
|
let result = PluginTest::new("hello", HelloPlugin.into())?.test_examples(&[Example {
|
|
example: "hello",
|
|
description: "Run hello but the example result is wrong",
|
|
result: Some(Value::test_string("Goodbye, World!")),
|
|
}]);
|
|
assert!(result.is_err());
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn test_requiring_nu_cmd_lang_commands() -> Result<(), ShellError> {
|
|
use nu_protocol::Span;
|
|
|
|
let result = PluginTest::new("hello", HelloPlugin.into())?
|
|
.eval("do { let greeting = hello; $greeting }")?
|
|
.into_value(Span::test_data())?;
|
|
|
|
assert_eq!(Value::test_string("Hello, World!"), result);
|
|
|
|
Ok(())
|
|
}
|