mirror of
https://github.com/nushell/nushell.git
synced 2025-04-03 14:10:41 +02:00
ad2fd520ca
# Description `rmp_serde` has two kinds of errors that contain I/O errors, and an EOF can occur inside either of them, but we were only treating an EOF inside an `InvalidMarkerRead` as an EOF, which would make sense for the beginning of a message. However, we should also treat an incomplete message + EOF as an EOF. There isn't really any point in reporting that an EOF was received mid-message. This should fix the issue where the `seq_describe_no_collect_succeeds_without_error` test would sometimes fail, as doing a `describe --no-collect` followed by nushell exiting could (but was not guaranteed to) cause this exact scenario. # User-Facing Changes Will probably remove useless `read error` messages from plugins after exit of `nu` # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` # After Submitting
110 lines
3.0 KiB
Rust
110 lines
3.0 KiB
Rust
use std::io::ErrorKind;
|
|
|
|
use crate::{
|
|
plugin::{Encoder, PluginEncoder},
|
|
protocol::{PluginInput, PluginOutput},
|
|
};
|
|
use nu_protocol::ShellError;
|
|
use serde::Deserialize;
|
|
|
|
/// A `PluginEncoder` that enables the plugin to communicate with Nushell with MsgPack
|
|
/// serialized data.
|
|
///
|
|
/// Each message is written as a MessagePack object. There is no message envelope or separator.
|
|
#[derive(Clone, Copy, Debug)]
|
|
pub struct MsgPackSerializer;
|
|
|
|
impl PluginEncoder for MsgPackSerializer {
|
|
fn name(&self) -> &str {
|
|
"msgpack"
|
|
}
|
|
}
|
|
|
|
impl Encoder<PluginInput> for MsgPackSerializer {
|
|
fn encode(
|
|
&self,
|
|
plugin_input: &PluginInput,
|
|
writer: &mut impl std::io::Write,
|
|
) -> Result<(), nu_protocol::ShellError> {
|
|
rmp_serde::encode::write(writer, plugin_input).map_err(rmp_encode_err)
|
|
}
|
|
|
|
fn decode(
|
|
&self,
|
|
reader: &mut impl std::io::BufRead,
|
|
) -> Result<Option<PluginInput>, ShellError> {
|
|
let mut de = rmp_serde::Deserializer::new(reader);
|
|
PluginInput::deserialize(&mut de)
|
|
.map(Some)
|
|
.or_else(rmp_decode_err)
|
|
}
|
|
}
|
|
|
|
impl Encoder<PluginOutput> for MsgPackSerializer {
|
|
fn encode(
|
|
&self,
|
|
plugin_output: &PluginOutput,
|
|
writer: &mut impl std::io::Write,
|
|
) -> Result<(), ShellError> {
|
|
rmp_serde::encode::write(writer, plugin_output).map_err(rmp_encode_err)
|
|
}
|
|
|
|
fn decode(
|
|
&self,
|
|
reader: &mut impl std::io::BufRead,
|
|
) -> Result<Option<PluginOutput>, ShellError> {
|
|
let mut de = rmp_serde::Deserializer::new(reader);
|
|
PluginOutput::deserialize(&mut de)
|
|
.map(Some)
|
|
.or_else(rmp_decode_err)
|
|
}
|
|
}
|
|
|
|
/// Handle a msgpack encode error
|
|
fn rmp_encode_err(err: rmp_serde::encode::Error) -> ShellError {
|
|
match err {
|
|
rmp_serde::encode::Error::InvalidValueWrite(_) => {
|
|
// I/O error
|
|
ShellError::IOError {
|
|
msg: err.to_string(),
|
|
}
|
|
}
|
|
_ => {
|
|
// Something else
|
|
ShellError::PluginFailedToEncode {
|
|
msg: err.to_string(),
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Handle a msgpack decode error. Returns `Ok(None)` on eof
|
|
fn rmp_decode_err<T>(err: rmp_serde::decode::Error) -> Result<Option<T>, ShellError> {
|
|
match err {
|
|
rmp_serde::decode::Error::InvalidMarkerRead(err)
|
|
| rmp_serde::decode::Error::InvalidDataRead(err) => {
|
|
if matches!(err.kind(), ErrorKind::UnexpectedEof) {
|
|
// EOF
|
|
Ok(None)
|
|
} else {
|
|
// I/O error
|
|
Err(ShellError::IOError {
|
|
msg: err.to_string(),
|
|
})
|
|
}
|
|
}
|
|
_ => {
|
|
// Something else
|
|
Err(ShellError::PluginFailedToDecode {
|
|
msg: err.to_string(),
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
crate::serializers::tests::generate_tests!(MsgPackSerializer {});
|
|
}
|