feat: buffer tracing logs before console init

This commit is contained in:
Ryan Walters
2025-09-01 17:22:22 -05:00
parent b1b03b0e9c
commit c79ba0d824
6 changed files with 184 additions and 14 deletions

View File

@@ -0,0 +1,55 @@
//! Buffered writer for tracing logs that can store logs before console attachment.
use parking_lot::Mutex;
use std::io::{self, Write};
use std::sync::Arc;
/// A thread-safe buffered writer that stores logs in memory until flushed.
#[derive(Clone)]
pub struct BufferedWriter {
buffer: Arc<Mutex<Vec<u8>>>,
}
impl BufferedWriter {
/// Creates a new buffered writer.
pub fn new() -> Self {
Self {
buffer: Arc::new(Mutex::new(Vec::new())),
}
}
/// Flushes all buffered content to the provided writer and clears the buffer.
pub fn flush_to<W: Write>(&self, mut writer: W) -> io::Result<()> {
let mut buffer = self.buffer.lock();
if !buffer.is_empty() {
writer.write_all(&buffer)?;
writer.flush()?;
buffer.clear();
}
Ok(())
}
/// Returns the current buffer size in bytes.
pub fn buffer_size(&self) -> usize {
self.buffer.lock().len()
}
}
impl Write for BufferedWriter {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
let mut buffer = self.buffer.lock();
buffer.extend_from_slice(buf);
Ok(buf.len())
}
fn flush(&mut self) -> io::Result<()> {
// For buffered writer, flush is a no-op since we're storing in memory
Ok(())
}
}
impl Default for BufferedWriter {
fn default() -> Self {
Self::new()
}
}

View File

@@ -10,6 +10,8 @@ mod desktop;
#[cfg(target_os = "emscripten")]
mod emscripten;
pub mod buffered_writer;
pub mod tracing_buffer;
/// Cross-platform abstraction layer providing unified APIs for platform-specific operations.
pub trait CommonPlatform {
/// Platform-specific sleep function (required due to Emscripten's non-standard sleep requirements).

View File

@@ -0,0 +1,91 @@
//! Buffered tracing setup for handling logs before console attachment.
use crate::platform::buffered_writer::BufferedWriter;
use std::io;
use tracing::Level;
use tracing_error::ErrorLayer;
use tracing_subscriber::fmt::MakeWriter;
use tracing_subscriber::layer::SubscriberExt;
/// A writer that can switch between buffering and direct output.
#[derive(Clone, Default)]
pub struct SwitchableWriter {
buffered_writer: BufferedWriter,
direct_mode: std::sync::Arc<parking_lot::Mutex<bool>>,
}
impl SwitchableWriter {
pub fn switch_to_direct_mode(&self) -> io::Result<()> {
// Get buffer size before flushing for debug logging
let buffer_size = self.buffered_writer.buffer_size();
// First flush any buffered content
self.buffered_writer.flush_to(io::stdout())?;
// Switch to direct mode
*self.direct_mode.lock() = true;
// Log how much was buffered (this will now go directly to stdout)
tracing::debug!("Flushed {} bytes of buffered logs to console", buffer_size);
Ok(())
}
}
impl io::Write for SwitchableWriter {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
if *self.direct_mode.lock() {
io::stdout().write(buf)
} else {
self.buffered_writer.clone().write(buf)
}
}
fn flush(&mut self) -> io::Result<()> {
if *self.direct_mode.lock() {
io::stdout().flush()
} else {
// For buffered mode, flush is a no-op
Ok(())
}
}
}
/// A make writer that uses the switchable writer.
#[derive(Clone)]
pub struct SwitchableMakeWriter {
writer: SwitchableWriter,
}
impl SwitchableMakeWriter {
pub fn new(writer: SwitchableWriter) -> Self {
Self { writer }
}
}
impl<'a> MakeWriter<'a> for SwitchableMakeWriter {
type Writer = SwitchableWriter;
fn make_writer(&'a self) -> Self::Writer {
self.writer.clone()
}
}
/// Sets up a switchable tracing subscriber that can transition from buffered to direct output.
///
/// Returns the switchable writer that can be used to control the behavior.
pub fn setup_switchable_subscriber() -> SwitchableWriter {
let switchable_writer = SwitchableWriter::default();
let make_writer = SwitchableMakeWriter::new(switchable_writer.clone());
let _subscriber = tracing_subscriber::fmt()
.with_ansi(cfg!(not(target_os = "emscripten")))
.with_max_level(Level::DEBUG)
.with_writer(make_writer)
.finish()
.with(ErrorLayer::default());
tracing::subscriber::set_global_default(_subscriber).expect("Could not set global default switchable subscriber");
switchable_writer
}