Skip to content

fix(process): Ensure stdout/stderr lock is held across calls #4514

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+54 −21
Open

fix(process): Ensure stdout/stderr lock is held across calls #4514

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2d39a8
refactor(process): Centralize Write bookkeeping
epage Oct 3, 2025
ebb7d1a
fix(process): Ensure stdout/stderr lock is held across calls
epage Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 27 additions & 21 deletions src/process/terminalsource.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ use std::{
pub(crate) use termcolor::{Color, ColorChoice};
use termcolor::{ColorSpec, StandardStream, StandardStreamLock, WriteColor};

use super::Process;
#[cfg(feature = "test")]
use super::filesource::{TestWriter, TestWriterLock};
use super::Process;

/// Select what stream to make a terminal on
pub(super) enum StreamSelector {
Expand Down Expand Up @@ -194,6 +194,26 @@ impl ColorableTerminal {
}
}

impl TerminalInner {
Copy link
Contributor

@djc djc Oct 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: ordering in this module is a bit of a mess, but please keep impls directly below their respective type's definitions.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was trying to be consistent with the file which seemed to be types before impls (mostly). But fine with changing this.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think that would be nice. I'll clean up the other items after this is merged.

(Note that CI is failing on a formatting issue.)

fn as_write(&mut self) -> &mut dyn io::Write {
match self {
TerminalInner::StandardStream(s, _) => s,
#[cfg(feature = "test")]
TerminalInner::TestWriter(w, _) => w,
}
}
}

impl TerminalInnerLocked {
fn as_write(&mut self) -> &mut dyn io::Write {
match self {
TerminalInnerLocked::StandardStream(s) => s,
#[cfg(feature = "test")]
TerminalInnerLocked::TestWriter(w) => w,
}
}
}

#[derive(Copy, Clone, Debug)]
pub enum Attr {
Bold,
Expand All @@ -202,37 +222,23 @@ pub enum Attr {

impl io::Write for ColorableTerminal {
fn write(&mut self, buf: &[u8]) -> std::result::Result<usize, io::Error> {
match self.inner.lock().unwrap().deref_mut() {
TerminalInner::StandardStream(s, _) => s.write(buf),
#[cfg(feature = "test")]
TerminalInner::TestWriter(w, _) => w.write(buf),
}
let mut locked = self.inner.lock().unwrap();
locked.deref_mut().as_write().write(buf)
}

fn flush(&mut self) -> std::result::Result<(), io::Error> {
match self.inner.lock().unwrap().deref_mut() {
TerminalInner::StandardStream(s, _) => s.flush(),
#[cfg(feature = "test")]
TerminalInner::TestWriter(w, _) => w.flush(),
}
let mut locked = self.inner.lock().unwrap();
locked.deref_mut().as_write().flush()
}
}

impl io::Write for ColorableTerminalLocked {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
match &mut self.locked {
TerminalInnerLocked::StandardStream(s) => s.write(buf),
#[cfg(feature = "test")]
TerminalInnerLocked::TestWriter(w) => w.write(buf),
}
self.locked.as_write().write(buf)
}

fn flush(&mut self) -> io::Result<()> {
match &mut self.locked {
TerminalInnerLocked::StandardStream(s) => s.flush(),
#[cfg(feature = "test")]
TerminalInnerLocked::TestWriter(w) => w.flush(),
}
self.locked.as_write().flush()
}
}

Expand Down