tokio-process-tools 0.9.0

use super::ProcessHandle;
use crate::output_stream::OutputStream;
use crate::output_stream::backend::broadcast::BroadcastOutputStream;
use crate::output_stream::backend::single_subscriber::SingleSubscriberOutputStream;
use crate::output_stream::policy::{Delivery, ReplayEnabled};

/// Generates `seal_stdout_replay` for any `ProcessHandle` whose stdout is the named replay-enabled
/// backend. The stderr slot stays free in the type parameters so each backend has one impl block
/// regardless of what the caller paired it with on stderr.
macro_rules! impl_seal_stdout_replay {
    ($stdout:ident) => {
        impl<StdoutD, Stderr> ProcessHandle<$stdout<StdoutD, ReplayEnabled>, Stderr>
        where
            StdoutD: Delivery,
            Stderr: OutputStream,
        {
            /// Seals stdout replay history for future subscribers.
            pub fn seal_stdout_replay(&self) {
                self.std_out_stream.seal_replay();
            }
        }
    };
}

/// Mirror of [`impl_seal_stdout_replay`] for the stderr slot.
macro_rules! impl_seal_stderr_replay {
    ($stderr:ident) => {
        impl<Stdout, StderrD> ProcessHandle<Stdout, $stderr<StderrD, ReplayEnabled>>
        where
            Stdout: OutputStream,
            StderrD: Delivery,
        {
            /// Seals stderr replay history for future subscribers.
            pub fn seal_stderr_replay(&self) {
                self.std_err_stream.seal_replay();
            }
        }
    };
}

/// Generates `seal_output_replay` for the cartesian product of replay-enabled backends across
/// stdout and stderr. Delegates to the per-stream methods so the actual sealing logic stays in
/// one place.
macro_rules! impl_seal_output_replay {
    ($stdout:ident, $stderr:ident) => {
        impl<StdoutD, StderrD>
            ProcessHandle<$stdout<StdoutD, ReplayEnabled>, $stderr<StderrD, ReplayEnabled>>
        where
            StdoutD: Delivery,
            StderrD: Delivery,
        {
            /// Seals stdout and stderr replay history for replay-enabled streams.
            pub fn seal_output_replay(&self) {
                self.seal_stdout_replay();
                self.seal_stderr_replay();
            }
        }
    };
}

impl_seal_stdout_replay!(BroadcastOutputStream);
impl_seal_stdout_replay!(SingleSubscriberOutputStream);
impl_seal_stderr_replay!(BroadcastOutputStream);
impl_seal_stderr_replay!(SingleSubscriberOutputStream);
impl_seal_output_replay!(BroadcastOutputStream, BroadcastOutputStream);
impl_seal_output_replay!(BroadcastOutputStream, SingleSubscriberOutputStream);
impl_seal_output_replay!(SingleSubscriberOutputStream, BroadcastOutputStream);
impl_seal_output_replay!(SingleSubscriberOutputStream, SingleSubscriberOutputStream);

#[cfg(test)]
mod tests {
    use crate::test_support::long_running_command;
    use crate::{
        AutoName, DEFAULT_MAX_BUFFERED_CHUNKS, DEFAULT_READ_CHUNK_SIZE, NumBytesExt, Process,
    };
    use assertr::prelude::*;
    use std::time::Duration;

    #[tokio::test]
    async fn process_handle_seal_output_replay_seals_stdout_and_stderr() {
        let process = Process::new(long_running_command(Duration::from_millis(100)))
            .name(AutoName::program_only())
            .stdout_and_stderr(|stream| {
                stream
                    .broadcast()
                    .reliable_for_active_subscribers()
                    .replay_last_bytes(1.megabytes())
                    .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                    .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
            })
            .spawn()
            .expect("Failed to spawn");

        assert_that!(process.stdout().is_replay_sealed()).is_false();
        assert_that!(process.stderr().is_replay_sealed()).is_false();

        process.seal_output_replay();

        assert_that!(process.stdout().is_replay_sealed()).is_true();
        assert_that!(process.stderr().is_replay_sealed()).is_true();

        let mut process = process;
        let _ = process
            .wait_for_completion(Duration::from_secs(2))
            .await
            .unwrap();
    }

    #[tokio::test]
    async fn seal_output_replay_seals_broadcast_stdout_and_single_subscriber_stderr() {
        let process = Process::new(long_running_command(Duration::from_millis(100)))
            .name(AutoName::program_only())
            .stdout(|stdout| {
                stdout
                    .broadcast()
                    .reliable_for_active_subscribers()
                    .replay_last_bytes(1.megabytes())
                    .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                    .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
            })
            .stderr(|stderr| {
                stderr
                    .single_subscriber()
                    .reliable_for_active_subscribers()
                    .replay_last_bytes(1.megabytes())
                    .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                    .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
            })
            .spawn()
            .expect("Failed to spawn");

        assert_that!(process.stdout().is_replay_sealed()).is_false();
        assert_that!(process.stderr().is_replay_sealed()).is_false();

        process.seal_output_replay();

        assert_that!(process.stdout().is_replay_sealed()).is_true();
        assert_that!(process.stderr().is_replay_sealed()).is_true();

        let mut process = process;
        let _ = process
            .wait_for_completion(Duration::from_secs(2))
            .await
            .unwrap();
    }

    #[tokio::test]
    async fn seal_output_replay_seals_single_subscriber_stdout_and_broadcast_stderr() {
        let process = Process::new(long_running_command(Duration::from_millis(100)))
            .name(AutoName::program_only())
            .stdout(|stdout| {
                stdout
                    .single_subscriber()
                    .reliable_for_active_subscribers()
                    .replay_last_bytes(1.megabytes())
                    .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                    .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
            })
            .stderr(|stderr| {
                stderr
                    .broadcast()
                    .reliable_for_active_subscribers()
                    .replay_last_bytes(1.megabytes())
                    .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                    .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
            })
            .spawn()
            .expect("Failed to spawn");

        assert_that!(process.stdout().is_replay_sealed()).is_false();
        assert_that!(process.stderr().is_replay_sealed()).is_false();

        process.seal_output_replay();

        assert_that!(process.stdout().is_replay_sealed()).is_true();
        assert_that!(process.stderr().is_replay_sealed()).is_true();

        let mut process = process;
        let _ = process
            .wait_for_completion(Duration::from_secs(2))
            .await
            .unwrap();
    }
}