apollo-router 2.14.0-rc.2

//! Archive utility functions for diagnostics plugin
//!
//! This module provides utilities for creating tar archives with consistent
//! headers, timestamps, and error handling.

use std::time::SystemTime;
use std::time::UNIX_EPOCH;

use super::DiagnosticsError;
use super::DiagnosticsResult;

/// Builder for creating tar archive headers with consistent settings
pub(super) struct ArchiveHeaderBuilder {
    path: String,
    mode: u32,
    timestamp: Option<u64>,
}

impl ArchiveHeaderBuilder {
    /// Create a new archive header builder for the given path
    pub(super) fn new<P: AsRef<str>>(path: P) -> Self {
        Self {
            path: path.as_ref().to_string(),
            mode: 0o644, // Default file permissions
            timestamp: None,
        }
    }

    /// Build a tar header for the given content
    pub(super) fn build_for_content(self, content: &[u8]) -> DiagnosticsResult<tokio_tar::Header> {
        let mut header = tokio_tar::Header::new_gnu();

        // Set path with error handling
        header.set_path(&self.path).map_err(|e| {
            DiagnosticsError::Internal(format!("Failed to set path '{}': {}", self.path, e))
        })?;

        // Set content size
        header.set_size(content.len() as u64);

        // Set file permissions
        header.set_mode(self.mode);

        // Set timestamp (current time if not specified)
        let timestamp = self.timestamp.unwrap_or_else(|| {
            SystemTime::now()
                .duration_since(UNIX_EPOCH)
                .map(|d| d.as_secs())
                .unwrap_or(0)
        });
        header.set_mtime(timestamp);

        // Set checksum
        header.set_cksum();

        Ok(header)
    }
}

/// Utility functions for adding content to tar archives
pub(super) struct ArchiveUtils;

impl ArchiveUtils {
    /// Add text content to a tar archive with standard header settings
    pub(super) async fn add_text_file<W: tokio::io::AsyncWrite + Unpin + Send + Sync>(
        tar: &mut tokio_tar::Builder<W>,
        path: &str,
        content: &str,
    ) -> DiagnosticsResult<()> {
        let content_bytes = content.as_bytes();
        let header = ArchiveHeaderBuilder::new(path).build_for_content(content_bytes)?;

        tar.append(&header, content_bytes).await.map_err(|e| {
            DiagnosticsError::Internal(format!("Failed to add '{}' to archive: {}", path, e))
        })
    }
}

#[cfg(test)]
mod tests {
    use std::io::Cursor;

    use futures::StreamExt;

    use super::*;

    #[tokio::test]
    async fn test_add_text_file() {
        let buffer = Vec::new();
        let cursor = Cursor::new(buffer);
        let mut tar = tokio_tar::Builder::new(cursor);

        ArchiveUtils::add_text_file(&mut tar, "test.txt", "Hello, World!")
            .await
            .unwrap();

        // Get archive bytes before finishing
        let archive_bytes = tar.get_ref().get_ref().clone();
        tar.finish().await.unwrap();

        // Parse the tar archive to verify the file was added correctly
        let cursor = Cursor::new(&archive_bytes);
        let mut archive = tokio_tar::Archive::new(cursor);
        let mut entries = archive.entries().unwrap();

        let entry = entries.next().await.unwrap().unwrap();
        assert_eq!(entry.path().unwrap().to_str().unwrap(), "test.txt");
        assert_eq!(entry.header().size().unwrap(), 13); // "Hello, World!" is 13 bytes
    }
}