Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: log replay output #6155

Merged
merged 1 commit into from
Oct 13, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
67 changes: 58 additions & 9 deletions crates/turborepo-ui/src/output.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ pub struct OutputClient<W> {
pub struct OutputWriter<'a, W> {
logger: &'a OutputClient<W>,
destination: Destination,
buffer: Vec<u8>,
}

/// Enum for controlling the behavior of the client
Expand Down Expand Up @@ -90,6 +91,7 @@ impl<W: Write> OutputClient<W> {
OutputWriter {
logger: self,
destination: Destination::Stdout,
buffer: Vec::new(),
}
}

Expand All @@ -99,6 +101,7 @@ impl<W: Write> OutputClient<W> {
OutputWriter {
logger: self,
destination: Destination::Stderr,
buffer: Vec::new(),
}
}

Expand Down Expand Up @@ -143,7 +146,7 @@ impl<W: Write> OutputClient<W> {
}))
}

fn handle_bytes(&self, bytes: SinkBytes) -> io::Result<usize> {
fn handle_bytes(&self, bytes: SinkBytes) -> io::Result<()> {
if matches!(
self.behavior,
OutputClientBehavior::InMemoryBuffer | OutputClientBehavior::Grouped
Expand All @@ -163,11 +166,11 @@ impl<W: Write> OutputClient<W> {
self.write_bytes(bytes)
} else {
// If we only wrote to the buffer, then we consider it a successful write
Ok(bytes.buffer.len())
Ok(())
}
}

fn write_bytes(&self, bytes: SinkBytes) -> io::Result<usize> {
fn write_bytes(&self, bytes: SinkBytes) -> io::Result<()> {
let SinkBytes {
buffer: line,
destination,
Expand All @@ -177,7 +180,7 @@ impl<W: Write> OutputClient<W> {
Destination::Stdout => &mut writers.out,
Destination::Stderr => &mut writers.err,
};
writer.write(&line)
writer.write_all(&line)
}

fn add_bytes_to_buffer(&self, bytes: SinkBytes<'static>) {
Expand All @@ -191,20 +194,35 @@ impl<W: Write> OutputClient<W> {

impl<'a, W: Write> Write for OutputWriter<'a, W> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
self.logger.handle_bytes(SinkBytes {
buffer: buf.into(),
destination: self.destination,
})
for line in buf.split_inclusive(|b| *b == b'\n') {
self.buffer.extend_from_slice(line);
// If the line doesn't end in a newline we assume it isn't finished and add it
// to the buffer
if line.ends_with(b"\n") {
self.logger.handle_bytes(SinkBytes {
buffer: self.buffer.as_slice().into(),
destination: self.destination,
})?;
self.buffer.clear();
}
}
Ok(buf.len())
}

fn flush(&mut self) -> io::Result<()> {
// No buffer held by the logger writer so flush is a noop
self.logger.handle_bytes(SinkBytes {
buffer: self.buffer.as_slice().into(),
destination: self.destination,
})?;
self.buffer.clear();
Ok(())
}
}

#[cfg(test)]
mod test {
use std::sync::Barrier;

use super::*;

#[test]
Expand Down Expand Up @@ -325,6 +343,37 @@ mod test {
Ok(())
}

#[test]
fn test_loggers_wait_for_newline() {
let b1 = Arc::new(Barrier::new(2));
let b2 = Arc::clone(&b1);

let sink = OutputSink::new(Vec::new(), Vec::new());
let logger1 = sink.logger(OutputClientBehavior::Passthrough);
let logger2 = sink.logger(OutputClientBehavior::Passthrough);
std::thread::scope(|s| {
s.spawn(move || {
let mut out = logger1.stdout();
write!(&mut out, "task 1:").unwrap();
b1.wait();
writeln!(&mut out, " echo building").unwrap();
assert!(logger1.finish().unwrap().is_none());
});
s.spawn(move || {
let mut out = logger2.stdout();
write!(&mut out, "task 2:").unwrap();
b2.wait();
writeln!(&mut out, " echo failing").unwrap();
assert!(logger2.finish().unwrap().is_none(),);
});
});
let SinkWriters { out, .. } = Arc::into_inner(sink.writers).unwrap().into_inner().unwrap();
let out = String::from_utf8(out).unwrap();
for line in out.lines() {
assert!(line.starts_with("task "));
}
}

#[test]
fn assert_output_writer_sync() {
// This is the bound required for a value to be held across an await
Expand Down