forked from extern/nushell
1be4eaeae3
In my view we should revert nushell/nushell#8395 for now
## Potentially inconsistent application of semantic change
#8395 (1d5e7b441b) was loosening the type
coercion rules significantly, to let missing data / void returns that
were either expressed by `PipelineData::Empty` or the `Value::nothing`
be accept by specifically those commands/operations that made use of
`PipelineData::into_iter_strict()`. This could apply the new rules
inconsistently.
## Turning explicit failures into silent continuations
Furthermore the effect of this breaking change to the missing data
semantics could make previous errors into silent failures.
This could either just reduce the effectiveness of teaching error
messages in interactive use:
### Contrived example before
```bash
> cd . | where blah
Error: nu:🐚:only_supports_this_input_type
× Input type not supported.
╭─[entry #13:1:1]
1 │ cd . | where blah
· ──┬──┬
· │ ╰── input type: null
· ╰── only list, binary, raw data or range input data is supported
╰────
```
### ...after, with #8395
```bash
> cd . | where blah
╭────────────╮
│ empty list │
╰────────────╯
```
In rare cases people could already try to rely on catching an error of a
downstream command to actually deal with the missing data, so it would
be a breaking change for their existing code.
## Problem with `PipelineData::into_iter_strict()`
Maybe this makes `_strict` a bit of a misnomer for this particular
iterator construction.
Further we did not actively test the `PipelineData::empty` branch before
## Parsimonious solution exists
For the motivating issue https://github.com/nushell/nushell/issues/8393
there already exists a fix that makes `ls` more consistent with the type
system by returning an empty `Value::List`
https://github.com/nushell/nushell/pull/8439
1010 lines
36 KiB
Rust
1010 lines
36 KiB
Rust
use crate::{
|
|
ast::{Call, PathMember},
|
|
engine::{EngineState, Stack, StateWorkingSet},
|
|
format_error, Config, ListStream, RawStream, ShellError, Span, Value,
|
|
};
|
|
use nu_utils::{stderr_write_all_and_flush, stdout_write_all_and_flush};
|
|
use std::sync::{atomic::AtomicBool, Arc};
|
|
use std::thread;
|
|
|
|
const LINE_ENDING_PATTERN: &[char] = &['\r', '\n'];
|
|
|
|
/// The foundational abstraction for input and output to commands
|
|
///
|
|
/// This represents either a single Value or a stream of values coming into the command or leaving a command.
|
|
///
|
|
/// A note on implementation:
|
|
///
|
|
/// We've tried a few variations of this structure. Listing these below so we have a record.
|
|
///
|
|
/// * We tried always assuming a stream in Nushell. This was a great 80% solution, but it had some rough edges.
|
|
/// Namely, how do you know the difference between a single string and a list of one string. How do you know
|
|
/// when to flatten the data given to you from a data source into the stream or to keep it as an unflattened
|
|
/// list?
|
|
///
|
|
/// * We tried putting the stream into Value. This had some interesting properties as now commands "just worked
|
|
/// on values", but lead to a few unfortunate issues.
|
|
///
|
|
/// The first is that you can't easily clone Values in a way that felt largely immutable. For example, if
|
|
/// you cloned a Value which contained a stream, and in one variable drained some part of it, then the second
|
|
/// variable would see different values based on what you did to the first.
|
|
///
|
|
/// To make this kind of mutation thread-safe, we would have had to produce a lock for the stream, which in
|
|
/// practice would have meant always locking the stream before reading from it. But more fundamentally, it
|
|
/// felt wrong in practice that observation of a value at runtime could affect other values which happen to
|
|
/// alias the same stream. By separating these, we don't have this effect. Instead, variables could get
|
|
/// concrete list values rather than streams, and be able to view them without non-local effects.
|
|
///
|
|
/// * A balance of the two approaches is what we've landed on: Values are thread-safe to pass, and we can stream
|
|
/// them into any sources. Streams are still available to model the infinite streams approach of original
|
|
/// Nushell.
|
|
#[derive(Debug)]
|
|
pub enum PipelineData {
|
|
// Note: the PipelineMetadata is boxed everywhere because the DataSource::Profiling caused
|
|
// stack overflow on Windows CI when testing virtualenv
|
|
Value(Value, Option<Box<PipelineMetadata>>),
|
|
ListStream(ListStream, Option<Box<PipelineMetadata>>),
|
|
ExternalStream {
|
|
stdout: Option<RawStream>,
|
|
stderr: Option<RawStream>,
|
|
exit_code: Option<ListStream>,
|
|
span: Span,
|
|
metadata: Option<Box<PipelineMetadata>>,
|
|
trim_end_newline: bool,
|
|
},
|
|
Empty,
|
|
}
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub struct PipelineMetadata {
|
|
pub data_source: DataSource,
|
|
}
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub enum DataSource {
|
|
Ls,
|
|
HtmlThemes,
|
|
Profiling(Vec<Value>),
|
|
}
|
|
|
|
impl PipelineData {
|
|
pub fn new_with_metadata(metadata: Option<Box<PipelineMetadata>>, span: Span) -> PipelineData {
|
|
PipelineData::Value(Value::Nothing { span }, metadata)
|
|
}
|
|
|
|
/// create a `PipelineData::ExternalStream` with proper exit_code
|
|
///
|
|
/// It's useful to break running without raising error at user level.
|
|
pub fn new_external_stream_with_only_exit_code(exit_code: i64) -> PipelineData {
|
|
PipelineData::ExternalStream {
|
|
stdout: None,
|
|
stderr: None,
|
|
exit_code: Some(ListStream::from_stream(
|
|
[Value::int(exit_code, Span::unknown())].into_iter(),
|
|
None,
|
|
)),
|
|
span: Span::unknown(),
|
|
metadata: None,
|
|
trim_end_newline: false,
|
|
}
|
|
}
|
|
|
|
pub fn empty() -> PipelineData {
|
|
PipelineData::Empty
|
|
}
|
|
|
|
pub fn metadata(&self) -> Option<Box<PipelineMetadata>> {
|
|
match self {
|
|
PipelineData::ListStream(_, x) => x.clone(),
|
|
PipelineData::ExternalStream { metadata: x, .. } => x.clone(),
|
|
PipelineData::Value(_, x) => x.clone(),
|
|
PipelineData::Empty => None,
|
|
}
|
|
}
|
|
|
|
pub fn set_metadata(mut self, metadata: Option<Box<PipelineMetadata>>) -> Self {
|
|
match &mut self {
|
|
PipelineData::ListStream(_, x) => *x = metadata,
|
|
PipelineData::ExternalStream { metadata: x, .. } => *x = metadata,
|
|
PipelineData::Value(_, x) => *x = metadata,
|
|
PipelineData::Empty => {}
|
|
}
|
|
|
|
self
|
|
}
|
|
|
|
pub fn is_nothing(&self) -> bool {
|
|
matches!(self, PipelineData::Value(Value::Nothing { .. }, ..))
|
|
|| matches!(self, PipelineData::Empty)
|
|
}
|
|
|
|
/// PipelineData doesn't always have a Span, but we can try!
|
|
pub fn span(&self) -> Option<Span> {
|
|
match self {
|
|
PipelineData::ListStream(..) => None,
|
|
PipelineData::ExternalStream { span, .. } => Some(*span),
|
|
PipelineData::Value(v, _) => v.span().ok(),
|
|
PipelineData::Empty => None,
|
|
}
|
|
}
|
|
|
|
pub fn into_value(self, span: Span) -> Value {
|
|
match self {
|
|
PipelineData::Empty => Value::nothing(span),
|
|
PipelineData::Value(Value::Nothing { .. }, ..) => Value::nothing(span),
|
|
PipelineData::Value(v, ..) => v.with_span(span),
|
|
PipelineData::ListStream(s, ..) => Value::List {
|
|
vals: s.collect(),
|
|
span, // FIXME?
|
|
},
|
|
PipelineData::ExternalStream {
|
|
stdout: None,
|
|
exit_code,
|
|
..
|
|
} => {
|
|
// Make sure everything has finished
|
|
if let Some(exit_code) = exit_code {
|
|
let _: Vec<_> = exit_code.into_iter().collect();
|
|
}
|
|
Value::Nothing { span }
|
|
}
|
|
PipelineData::ExternalStream {
|
|
stdout: Some(mut s),
|
|
exit_code,
|
|
trim_end_newline,
|
|
..
|
|
} => {
|
|
let mut items = vec![];
|
|
|
|
for val in &mut s {
|
|
match val {
|
|
Ok(val) => {
|
|
items.push(val);
|
|
}
|
|
Err(e) => {
|
|
return Value::Error { error: Box::new(e) };
|
|
}
|
|
}
|
|
}
|
|
|
|
// Make sure everything has finished
|
|
if let Some(exit_code) = exit_code {
|
|
let _: Vec<_> = exit_code.into_iter().collect();
|
|
}
|
|
|
|
// NOTE: currently trim-end-newline only handles for string output.
|
|
// For binary, user might need origin data.
|
|
if s.is_binary {
|
|
let mut output = vec![];
|
|
for item in items {
|
|
match item.as_binary() {
|
|
Ok(item) => {
|
|
output.extend(item);
|
|
}
|
|
Err(err) => {
|
|
return Value::Error {
|
|
error: Box::new(err),
|
|
};
|
|
}
|
|
}
|
|
}
|
|
|
|
Value::Binary {
|
|
val: output,
|
|
span, // FIXME?
|
|
}
|
|
} else {
|
|
let mut output = String::new();
|
|
for item in items {
|
|
match item.as_string() {
|
|
Ok(s) => output.push_str(&s),
|
|
Err(err) => {
|
|
return Value::Error {
|
|
error: Box::new(err),
|
|
};
|
|
}
|
|
}
|
|
}
|
|
if trim_end_newline {
|
|
output.truncate(output.trim_end_matches(LINE_ENDING_PATTERN).len())
|
|
}
|
|
Value::String {
|
|
val: output,
|
|
span, // FIXME?
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn drain(self) -> Result<(), ShellError> {
|
|
match self {
|
|
PipelineData::Value(Value::Error { error }, _) => Err(*error),
|
|
PipelineData::Value(_, _) => Ok(()),
|
|
PipelineData::ListStream(stream, _) => stream.drain(),
|
|
PipelineData::ExternalStream { stdout, stderr, .. } => {
|
|
if let Some(stdout) = stdout {
|
|
stdout.drain()?;
|
|
}
|
|
|
|
if let Some(stderr) = stderr {
|
|
stderr.drain()?;
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
PipelineData::Empty => Ok(()),
|
|
}
|
|
}
|
|
|
|
pub fn drain_with_exit_code(self) -> Result<i64, ShellError> {
|
|
match self {
|
|
PipelineData::Value(Value::Error { error }, _) => Err(*error),
|
|
PipelineData::Value(_, _) => Ok(0),
|
|
PipelineData::ListStream(stream, _) => {
|
|
stream.drain()?;
|
|
Ok(0)
|
|
}
|
|
PipelineData::ExternalStream {
|
|
stdout,
|
|
stderr,
|
|
exit_code,
|
|
..
|
|
} => {
|
|
if let Some(stdout) = stdout {
|
|
stdout.drain()?;
|
|
}
|
|
|
|
if let Some(stderr) = stderr {
|
|
stderr.drain()?;
|
|
}
|
|
|
|
if let Some(exit_code) = exit_code {
|
|
let result = drain_exit_code(exit_code)?;
|
|
Ok(result)
|
|
} else {
|
|
Ok(0)
|
|
}
|
|
}
|
|
PipelineData::Empty => Ok(0),
|
|
}
|
|
}
|
|
|
|
/// Try convert from self into iterator
|
|
///
|
|
/// It returns Err if the `self` cannot be converted to an iterator.
|
|
pub fn into_iter_strict(self, span: Span) -> Result<PipelineIterator, ShellError> {
|
|
match self {
|
|
PipelineData::Value(val, metadata) => match val {
|
|
Value::List { vals, .. } => Ok(PipelineIterator(PipelineData::ListStream(
|
|
ListStream {
|
|
stream: Box::new(vals.into_iter()),
|
|
ctrlc: None,
|
|
},
|
|
metadata,
|
|
))),
|
|
Value::Binary { val, span } => Ok(PipelineIterator(PipelineData::ListStream(
|
|
ListStream {
|
|
stream: Box::new(val.into_iter().map(move |x| Value::int(x as i64, span))),
|
|
ctrlc: None,
|
|
},
|
|
metadata,
|
|
))),
|
|
Value::Range { val, .. } => match val.into_range_iter(None) {
|
|
Ok(iter) => Ok(PipelineIterator(PipelineData::ListStream(
|
|
ListStream {
|
|
stream: Box::new(iter),
|
|
ctrlc: None,
|
|
},
|
|
metadata,
|
|
))),
|
|
Err(error) => Err(error),
|
|
},
|
|
// Propagate errors by explicitly matching them before the final case.
|
|
Value::Error { error } => Err(*error),
|
|
other => Err(ShellError::OnlySupportsThisInputType {
|
|
exp_input_type: "list, binary, raw data or range".into(),
|
|
wrong_type: other.get_type().to_string(),
|
|
dst_span: span,
|
|
src_span: other.expect_span(),
|
|
}),
|
|
},
|
|
PipelineData::Empty => Err(ShellError::OnlySupportsThisInputType {
|
|
exp_input_type: "list, binary, raw data or range".into(),
|
|
wrong_type: "null".into(),
|
|
dst_span: span,
|
|
src_span: span,
|
|
}),
|
|
other => Ok(PipelineIterator(other)),
|
|
}
|
|
}
|
|
|
|
pub fn into_interruptible_iter(self, ctrlc: Option<Arc<AtomicBool>>) -> PipelineIterator {
|
|
let mut iter = self.into_iter();
|
|
|
|
if let PipelineIterator(PipelineData::ListStream(s, ..)) = &mut iter {
|
|
s.ctrlc = ctrlc;
|
|
}
|
|
|
|
iter
|
|
}
|
|
|
|
pub fn collect_string(self, separator: &str, config: &Config) -> Result<String, ShellError> {
|
|
match self {
|
|
PipelineData::Empty => Ok(String::new()),
|
|
PipelineData::Value(v, ..) => Ok(v.into_string(separator, config)),
|
|
PipelineData::ListStream(s, ..) => Ok(s.into_string(separator, config)),
|
|
PipelineData::ExternalStream { stdout: None, .. } => Ok(String::new()),
|
|
PipelineData::ExternalStream {
|
|
stdout: Some(s),
|
|
trim_end_newline,
|
|
..
|
|
} => {
|
|
let mut output = String::new();
|
|
|
|
for val in s {
|
|
output.push_str(&val?.as_string()?);
|
|
}
|
|
if trim_end_newline {
|
|
output.truncate(output.trim_end_matches(LINE_ENDING_PATTERN).len());
|
|
}
|
|
Ok(output)
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Retrieves string from pipeline data.
|
|
///
|
|
/// As opposed to `collect_string` this raises error rather than converting non-string values.
|
|
/// The `span` will be used if `ListStream` is encountered since it doesn't carry a span.
|
|
pub fn collect_string_strict(
|
|
self,
|
|
span: Span,
|
|
) -> Result<(String, Span, Option<Box<PipelineMetadata>>), ShellError> {
|
|
match self {
|
|
PipelineData::Empty => Ok((String::new(), span, None)),
|
|
PipelineData::Value(Value::String { val, span }, metadata) => Ok((val, span, metadata)),
|
|
PipelineData::Value(val, _) => Err(ShellError::TypeMismatch {
|
|
err_message: "string".into(),
|
|
span: val.span()?,
|
|
}),
|
|
PipelineData::ListStream(_, _) => Err(ShellError::TypeMismatch {
|
|
err_message: "string".into(),
|
|
span,
|
|
}),
|
|
PipelineData::ExternalStream {
|
|
stdout: None,
|
|
metadata,
|
|
span,
|
|
..
|
|
} => Ok((String::new(), span, metadata)),
|
|
PipelineData::ExternalStream {
|
|
stdout: Some(stdout),
|
|
metadata,
|
|
span,
|
|
..
|
|
} => Ok((stdout.into_string()?.item, span, metadata)),
|
|
}
|
|
}
|
|
|
|
pub fn follow_cell_path(
|
|
self,
|
|
cell_path: &[PathMember],
|
|
head: Span,
|
|
insensitive: bool,
|
|
) -> Result<Value, ShellError> {
|
|
match self {
|
|
// FIXME: there are probably better ways of doing this
|
|
PipelineData::ListStream(stream, ..) => Value::List {
|
|
vals: stream.collect(),
|
|
span: head,
|
|
}
|
|
.follow_cell_path(cell_path, insensitive),
|
|
PipelineData::Value(v, ..) => v.follow_cell_path(cell_path, insensitive),
|
|
_ => Err(ShellError::IOError("can't follow stream paths".into())),
|
|
}
|
|
}
|
|
|
|
pub fn upsert_cell_path(
|
|
&mut self,
|
|
cell_path: &[PathMember],
|
|
callback: Box<dyn FnOnce(&Value) -> Value>,
|
|
head: Span,
|
|
) -> Result<(), ShellError> {
|
|
match self {
|
|
// FIXME: there are probably better ways of doing this
|
|
PipelineData::ListStream(stream, ..) => Value::List {
|
|
vals: stream.collect(),
|
|
span: head,
|
|
}
|
|
.upsert_cell_path(cell_path, callback),
|
|
PipelineData::Value(v, ..) => v.upsert_cell_path(cell_path, callback),
|
|
_ => Ok(()),
|
|
}
|
|
}
|
|
|
|
/// Simplified mapper to help with simple values also. For full iterator support use `.into_iter()` instead
|
|
pub fn map<F>(
|
|
self,
|
|
mut f: F,
|
|
ctrlc: Option<Arc<AtomicBool>>,
|
|
) -> Result<PipelineData, ShellError>
|
|
where
|
|
Self: Sized,
|
|
F: FnMut(Value) -> Value + 'static + Send,
|
|
{
|
|
match self {
|
|
PipelineData::Value(Value::List { vals, .. }, ..) => {
|
|
Ok(vals.into_iter().map(f).into_pipeline_data(ctrlc))
|
|
}
|
|
PipelineData::Empty => Ok(PipelineData::Empty),
|
|
PipelineData::ListStream(stream, ..) => Ok(stream.map(f).into_pipeline_data(ctrlc)),
|
|
PipelineData::ExternalStream { stdout: None, .. } => Ok(PipelineData::empty()),
|
|
PipelineData::ExternalStream {
|
|
stdout: Some(stream),
|
|
trim_end_newline,
|
|
..
|
|
} => {
|
|
let collected = stream.into_bytes()?;
|
|
|
|
if let Ok(mut st) = String::from_utf8(collected.clone().item) {
|
|
if trim_end_newline {
|
|
st.truncate(st.trim_end_matches(LINE_ENDING_PATTERN).len());
|
|
}
|
|
Ok(f(Value::String {
|
|
val: st,
|
|
span: collected.span,
|
|
})
|
|
.into_pipeline_data())
|
|
} else {
|
|
Ok(f(Value::Binary {
|
|
val: collected.item,
|
|
span: collected.span,
|
|
})
|
|
.into_pipeline_data())
|
|
}
|
|
}
|
|
|
|
PipelineData::Value(Value::Range { val, .. }, ..) => Ok(val
|
|
.into_range_iter(ctrlc.clone())?
|
|
.map(f)
|
|
.into_pipeline_data(ctrlc)),
|
|
PipelineData::Value(v, ..) => match f(v) {
|
|
Value::Error { error } => Err(*error),
|
|
v => Ok(v.into_pipeline_data()),
|
|
},
|
|
}
|
|
}
|
|
|
|
/// Simplified flatmapper. For full iterator support use `.into_iter()` instead
|
|
pub fn flat_map<U: 'static, F>(
|
|
self,
|
|
mut f: F,
|
|
ctrlc: Option<Arc<AtomicBool>>,
|
|
) -> Result<PipelineData, ShellError>
|
|
where
|
|
Self: Sized,
|
|
U: IntoIterator<Item = Value>,
|
|
<U as IntoIterator>::IntoIter: 'static + Send,
|
|
F: FnMut(Value) -> U + 'static + Send,
|
|
{
|
|
match self {
|
|
PipelineData::Empty => Ok(PipelineData::Empty),
|
|
PipelineData::Value(Value::List { vals, .. }, ..) => {
|
|
Ok(vals.into_iter().flat_map(f).into_pipeline_data(ctrlc))
|
|
}
|
|
PipelineData::ListStream(stream, ..) => {
|
|
Ok(stream.flat_map(f).into_pipeline_data(ctrlc))
|
|
}
|
|
PipelineData::ExternalStream { stdout: None, .. } => Ok(PipelineData::Empty),
|
|
PipelineData::ExternalStream {
|
|
stdout: Some(stream),
|
|
trim_end_newline,
|
|
..
|
|
} => {
|
|
let collected = stream.into_bytes()?;
|
|
|
|
if let Ok(mut st) = String::from_utf8(collected.clone().item) {
|
|
if trim_end_newline {
|
|
st.truncate(st.trim_end_matches(LINE_ENDING_PATTERN).len())
|
|
}
|
|
Ok(f(Value::String {
|
|
val: st,
|
|
span: collected.span,
|
|
})
|
|
.into_iter()
|
|
.into_pipeline_data(ctrlc))
|
|
} else {
|
|
Ok(f(Value::Binary {
|
|
val: collected.item,
|
|
span: collected.span,
|
|
})
|
|
.into_iter()
|
|
.into_pipeline_data(ctrlc))
|
|
}
|
|
}
|
|
PipelineData::Value(Value::Range { val, .. }, ..) => Ok(val
|
|
.into_range_iter(ctrlc.clone())?
|
|
.flat_map(f)
|
|
.into_pipeline_data(ctrlc)),
|
|
PipelineData::Value(v, ..) => Ok(f(v).into_iter().into_pipeline_data(ctrlc)),
|
|
}
|
|
}
|
|
|
|
pub fn filter<F>(
|
|
self,
|
|
mut f: F,
|
|
ctrlc: Option<Arc<AtomicBool>>,
|
|
) -> Result<PipelineData, ShellError>
|
|
where
|
|
Self: Sized,
|
|
F: FnMut(&Value) -> bool + 'static + Send,
|
|
{
|
|
match self {
|
|
PipelineData::Empty => Ok(PipelineData::Empty),
|
|
PipelineData::Value(Value::List { vals, .. }, ..) => {
|
|
Ok(vals.into_iter().filter(f).into_pipeline_data(ctrlc))
|
|
}
|
|
PipelineData::ListStream(stream, ..) => Ok(stream.filter(f).into_pipeline_data(ctrlc)),
|
|
PipelineData::ExternalStream { stdout: None, .. } => Ok(PipelineData::Empty),
|
|
PipelineData::ExternalStream {
|
|
stdout: Some(stream),
|
|
trim_end_newline,
|
|
..
|
|
} => {
|
|
let collected = stream.into_bytes()?;
|
|
|
|
if let Ok(mut st) = String::from_utf8(collected.clone().item) {
|
|
if trim_end_newline {
|
|
st.truncate(st.trim_end_matches(LINE_ENDING_PATTERN).len())
|
|
}
|
|
let v = Value::String {
|
|
val: st,
|
|
span: collected.span,
|
|
};
|
|
|
|
if f(&v) {
|
|
Ok(v.into_pipeline_data())
|
|
} else {
|
|
Ok(PipelineData::new_with_metadata(None, collected.span))
|
|
}
|
|
} else {
|
|
let v = Value::Binary {
|
|
val: collected.item,
|
|
span: collected.span,
|
|
};
|
|
|
|
if f(&v) {
|
|
Ok(v.into_pipeline_data())
|
|
} else {
|
|
Ok(PipelineData::new_with_metadata(None, collected.span))
|
|
}
|
|
}
|
|
}
|
|
PipelineData::Value(Value::Range { val, .. }, ..) => Ok(val
|
|
.into_range_iter(ctrlc.clone())?
|
|
.filter(f)
|
|
.into_pipeline_data(ctrlc)),
|
|
PipelineData::Value(v, ..) => {
|
|
if f(&v) {
|
|
Ok(v.into_pipeline_data())
|
|
} else {
|
|
Ok(Value::Nothing { span: v.span()? }.into_pipeline_data())
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Try to catch external stream exit status and detect if it runs to failed.
|
|
///
|
|
/// This is useful to commands with semicolon, we can detect errors early to avoid
|
|
/// commands after semicolon running.
|
|
///
|
|
/// Returns self and a flag indicates if the external stream runs to failed.
|
|
/// If `self` is not Pipeline::ExternalStream, the flag will be false.
|
|
pub fn is_external_failed(self) -> (Self, bool) {
|
|
let mut failed_to_run = false;
|
|
// Only need ExternalStream without redirecting output.
|
|
// It indicates we have no more commands to execute currently.
|
|
if let PipelineData::ExternalStream {
|
|
stdout: None,
|
|
stderr,
|
|
mut exit_code,
|
|
span,
|
|
metadata,
|
|
trim_end_newline,
|
|
} = self
|
|
{
|
|
let exit_code = exit_code.take();
|
|
|
|
// Note:
|
|
// In run-external's implementation detail, the result sender thread
|
|
// send out stderr message first, then stdout message, then exit_code.
|
|
//
|
|
// In this clause, we already make sure that `stdout` is None
|
|
// But not the case of `stderr`, so if `stderr` is not None
|
|
// We need to consume stderr message before reading external commands' exit code.
|
|
//
|
|
// Or we'll never have a chance to read exit_code if stderr producer produce too much stderr message.
|
|
// So we consume stderr stream and rebuild it.
|
|
let stderr = stderr.map(|stderr_stream| {
|
|
let stderr_ctrlc = stderr_stream.ctrlc.clone();
|
|
let stderr_span = stderr_stream.span;
|
|
let stderr_bytes = stderr_stream
|
|
.into_bytes()
|
|
.map(|bytes| bytes.item)
|
|
.unwrap_or_default();
|
|
RawStream::new(
|
|
Box::new(vec![Ok(stderr_bytes)].into_iter()),
|
|
stderr_ctrlc,
|
|
stderr_span,
|
|
None,
|
|
)
|
|
});
|
|
|
|
match exit_code {
|
|
Some(exit_code_stream) => {
|
|
let ctrlc = exit_code_stream.ctrlc.clone();
|
|
let exit_code: Vec<Value> = exit_code_stream.into_iter().collect();
|
|
if let Some(Value::Int { val: code, .. }) = exit_code.last() {
|
|
// if exit_code is not 0, it indicates error occurred, return back Err.
|
|
if *code != 0 {
|
|
failed_to_run = true;
|
|
}
|
|
}
|
|
(
|
|
PipelineData::ExternalStream {
|
|
stdout: None,
|
|
stderr,
|
|
exit_code: Some(ListStream::from_stream(exit_code.into_iter(), ctrlc)),
|
|
span,
|
|
metadata,
|
|
trim_end_newline,
|
|
},
|
|
failed_to_run,
|
|
)
|
|
}
|
|
None => (
|
|
PipelineData::ExternalStream {
|
|
stdout: None,
|
|
stderr,
|
|
exit_code: None,
|
|
span,
|
|
metadata,
|
|
trim_end_newline,
|
|
},
|
|
failed_to_run,
|
|
),
|
|
}
|
|
} else {
|
|
(self, false)
|
|
}
|
|
}
|
|
/// Try to convert Value from Value::Range to Value::List.
|
|
/// This is useful to expand Value::Range into array notation, specifically when
|
|
/// converting `to json` or `to nuon`.
|
|
/// `1..3 | to XX -> [1,2,3]`
|
|
pub fn try_expand_range(self) -> Result<PipelineData, ShellError> {
|
|
let input = match self {
|
|
PipelineData::Value(Value::Range { val, span }, ..) => {
|
|
match (&val.to, &val.from) {
|
|
(Value::Float { val, .. }, _) | (_, Value::Float { val, .. }) => {
|
|
if *val == f64::INFINITY || *val == f64::NEG_INFINITY {
|
|
return Err(ShellError::GenericError(
|
|
"Cannot create range".into(),
|
|
"Infinity is not allowed when converting to json".into(),
|
|
Some(span),
|
|
Some("Consider removing infinity".into()),
|
|
vec![],
|
|
));
|
|
}
|
|
}
|
|
(Value::Int { val, span }, _) => {
|
|
if *val == i64::MAX || *val == i64::MIN {
|
|
return Err(ShellError::GenericError(
|
|
"Cannot create range".into(),
|
|
"Unbounded ranges are not allowed when converting to json".into(),
|
|
Some(*span),
|
|
Some(
|
|
"Consider using ranges with valid start and end point.".into(),
|
|
),
|
|
vec![],
|
|
));
|
|
}
|
|
}
|
|
_ => (),
|
|
}
|
|
let range_values: Vec<Value> = val.into_range_iter(None)?.collect();
|
|
PipelineData::Value(
|
|
Value::List {
|
|
vals: range_values,
|
|
span,
|
|
},
|
|
None,
|
|
)
|
|
}
|
|
_ => self,
|
|
};
|
|
Ok(input)
|
|
}
|
|
|
|
/// Consume and print self data immediately.
|
|
///
|
|
/// `no_newline` controls if we need to attach newline character to output.
|
|
/// `to_stderr` controls if data is output to stderr, when the value is false, the data is output to stdout.
|
|
pub fn print(
|
|
self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
no_newline: bool,
|
|
to_stderr: bool,
|
|
) -> Result<i64, ShellError> {
|
|
// If the table function is in the declarations, then we can use it
|
|
// to create the table value that will be printed in the terminal
|
|
|
|
let config = engine_state.get_config();
|
|
|
|
if let PipelineData::ExternalStream {
|
|
stdout: stream,
|
|
stderr: stderr_stream,
|
|
exit_code,
|
|
..
|
|
} = self
|
|
{
|
|
return print_if_stream(stream, stderr_stream, to_stderr, exit_code);
|
|
}
|
|
|
|
if let Some(decl_id) = engine_state.table_decl_id {
|
|
let command = engine_state.get_decl(decl_id);
|
|
if command.get_block_id().is_some() {
|
|
return self.write_all_and_flush(engine_state, config, no_newline, to_stderr);
|
|
}
|
|
|
|
let mut call = Call::new(Span::new(0, 0));
|
|
call.redirect_stdout = false;
|
|
let table = command.run(engine_state, stack, &call, self)?;
|
|
|
|
table.write_all_and_flush(engine_state, config, no_newline, to_stderr)?;
|
|
} else {
|
|
self.write_all_and_flush(engine_state, config, no_newline, to_stderr)?;
|
|
};
|
|
|
|
Ok(0)
|
|
}
|
|
|
|
/// Consume and print self data immediately.
|
|
///
|
|
/// Unlike [print] does not call `table` to format data and just prints it
|
|
/// one element on a line
|
|
/// * `no_newline` controls if we need to attach newline character to output.
|
|
/// * `to_stderr` controls if data is output to stderr, when the value is false, the data is output to stdout.
|
|
pub fn print_not_formatted(
|
|
self,
|
|
engine_state: &EngineState,
|
|
no_newline: bool,
|
|
to_stderr: bool,
|
|
) -> Result<i64, ShellError> {
|
|
if let PipelineData::ExternalStream {
|
|
stdout: stream,
|
|
stderr: stderr_stream,
|
|
exit_code,
|
|
..
|
|
} = self
|
|
{
|
|
print_if_stream(stream, stderr_stream, to_stderr, exit_code)
|
|
} else {
|
|
let config = engine_state.get_config();
|
|
self.write_all_and_flush(engine_state, config, no_newline, to_stderr)
|
|
}
|
|
}
|
|
|
|
fn write_all_and_flush(
|
|
self,
|
|
engine_state: &EngineState,
|
|
config: &Config,
|
|
no_newline: bool,
|
|
to_stderr: bool,
|
|
) -> Result<i64, ShellError> {
|
|
for item in self {
|
|
let mut is_err = false;
|
|
let mut out = if let Value::Error { error } = item {
|
|
let working_set = StateWorkingSet::new(engine_state);
|
|
// Value::Errors must always go to stderr, not stdout.
|
|
is_err = true;
|
|
format_error(&working_set, &*error)
|
|
} else if no_newline {
|
|
item.into_string("", config)
|
|
} else {
|
|
item.into_string("\n", config)
|
|
};
|
|
|
|
if !no_newline {
|
|
out.push('\n');
|
|
}
|
|
|
|
if !to_stderr && !is_err {
|
|
stdout_write_all_and_flush(out)?
|
|
} else {
|
|
stderr_write_all_and_flush(out)?
|
|
}
|
|
}
|
|
|
|
Ok(0)
|
|
}
|
|
}
|
|
|
|
pub struct PipelineIterator(PipelineData);
|
|
|
|
impl IntoIterator for PipelineData {
|
|
type Item = Value;
|
|
|
|
type IntoIter = PipelineIterator;
|
|
|
|
fn into_iter(self) -> Self::IntoIter {
|
|
match self {
|
|
PipelineData::Value(Value::List { vals, .. }, metadata) => {
|
|
PipelineIterator(PipelineData::ListStream(
|
|
ListStream {
|
|
stream: Box::new(vals.into_iter()),
|
|
ctrlc: None,
|
|
},
|
|
metadata,
|
|
))
|
|
}
|
|
PipelineData::Value(Value::Range { val, .. }, metadata) => {
|
|
match val.into_range_iter(None) {
|
|
Ok(iter) => PipelineIterator(PipelineData::ListStream(
|
|
ListStream {
|
|
stream: Box::new(iter),
|
|
ctrlc: None,
|
|
},
|
|
metadata,
|
|
)),
|
|
Err(error) => PipelineIterator(PipelineData::ListStream(
|
|
ListStream {
|
|
stream: Box::new(std::iter::once(Value::Error {
|
|
error: Box::new(error),
|
|
})),
|
|
ctrlc: None,
|
|
},
|
|
metadata,
|
|
)),
|
|
}
|
|
}
|
|
x => PipelineIterator(x),
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn print_if_stream(
|
|
stream: Option<RawStream>,
|
|
stderr_stream: Option<RawStream>,
|
|
to_stderr: bool,
|
|
exit_code: Option<ListStream>,
|
|
) -> Result<i64, ShellError> {
|
|
// NOTE: currently we don't need anything from stderr
|
|
// so we just consume and throw away `stderr_stream` to make sure the pipe doesn't fill up
|
|
|
|
thread::Builder::new()
|
|
.name("stderr consumer".to_string())
|
|
.spawn(move || stderr_stream.map(|x| x.into_bytes()))
|
|
.expect("could not create thread");
|
|
if let Some(stream) = stream {
|
|
for s in stream {
|
|
let s_live = s?;
|
|
let bin_output = s_live.as_binary()?;
|
|
|
|
if !to_stderr {
|
|
stdout_write_all_and_flush(bin_output)?
|
|
} else {
|
|
stderr_write_all_and_flush(bin_output)?
|
|
}
|
|
}
|
|
}
|
|
|
|
// Make sure everything has finished
|
|
if let Some(exit_code) = exit_code {
|
|
return drain_exit_code(exit_code);
|
|
}
|
|
|
|
Ok(0)
|
|
}
|
|
|
|
fn drain_exit_code(exit_code: ListStream) -> Result<i64, ShellError> {
|
|
let mut exit_codes: Vec<_> = exit_code.into_iter().collect();
|
|
match exit_codes.pop() {
|
|
#[cfg(unix)]
|
|
Some(Value::Error { error }) => Err(*error),
|
|
Some(Value::Int { val, .. }) => Ok(val),
|
|
_ => Ok(0),
|
|
}
|
|
}
|
|
|
|
impl Iterator for PipelineIterator {
|
|
type Item = Value;
|
|
|
|
fn next(&mut self) -> Option<Self::Item> {
|
|
match &mut self.0 {
|
|
PipelineData::Empty => None,
|
|
PipelineData::Value(Value::Nothing { .. }, ..) => None,
|
|
PipelineData::Value(v, ..) => Some(std::mem::take(v)),
|
|
PipelineData::ListStream(stream, ..) => stream.next(),
|
|
PipelineData::ExternalStream { stdout: None, .. } => None,
|
|
PipelineData::ExternalStream {
|
|
stdout: Some(stream),
|
|
..
|
|
} => stream.next().map(|x| match x {
|
|
Ok(x) => x,
|
|
Err(err) => Value::Error {
|
|
error: Box::new(err),
|
|
},
|
|
}),
|
|
}
|
|
}
|
|
}
|
|
|
|
pub trait IntoPipelineData {
|
|
fn into_pipeline_data(self) -> PipelineData;
|
|
|
|
fn into_pipeline_data_with_metadata(
|
|
self,
|
|
metadata: impl Into<Option<Box<PipelineMetadata>>>,
|
|
) -> PipelineData;
|
|
}
|
|
|
|
impl<V> IntoPipelineData for V
|
|
where
|
|
V: Into<Value>,
|
|
{
|
|
fn into_pipeline_data(self) -> PipelineData {
|
|
PipelineData::Value(self.into(), None)
|
|
}
|
|
|
|
fn into_pipeline_data_with_metadata(
|
|
self,
|
|
metadata: impl Into<Option<Box<PipelineMetadata>>>,
|
|
) -> PipelineData {
|
|
PipelineData::Value(self.into(), metadata.into())
|
|
}
|
|
}
|
|
|
|
pub trait IntoInterruptiblePipelineData {
|
|
fn into_pipeline_data(self, ctrlc: Option<Arc<AtomicBool>>) -> PipelineData;
|
|
fn into_pipeline_data_with_metadata(
|
|
self,
|
|
metadata: impl Into<Option<Box<PipelineMetadata>>>,
|
|
ctrlc: Option<Arc<AtomicBool>>,
|
|
) -> PipelineData;
|
|
}
|
|
|
|
impl<I> IntoInterruptiblePipelineData for I
|
|
where
|
|
I: IntoIterator + Send + 'static,
|
|
I::IntoIter: Send + 'static,
|
|
<I::IntoIter as Iterator>::Item: Into<Value>,
|
|
{
|
|
fn into_pipeline_data(self, ctrlc: Option<Arc<AtomicBool>>) -> PipelineData {
|
|
PipelineData::ListStream(
|
|
ListStream {
|
|
stream: Box::new(self.into_iter().map(Into::into)),
|
|
ctrlc,
|
|
},
|
|
None,
|
|
)
|
|
}
|
|
|
|
fn into_pipeline_data_with_metadata(
|
|
self,
|
|
metadata: impl Into<Option<Box<PipelineMetadata>>>,
|
|
ctrlc: Option<Arc<AtomicBool>>,
|
|
) -> PipelineData {
|
|
PipelineData::ListStream(
|
|
ListStream {
|
|
stream: Box::new(self.into_iter().map(Into::into)),
|
|
ctrlc,
|
|
},
|
|
metadata.into(),
|
|
)
|
|
}
|
|
}
|