refactor: update get_logs implementation to return logs as a vector and remove LogOutputStream (#53)

* refactor: update get_logs implementation to return logs as a vector and remove LogOutputStream

- Changed `get_logs` method to return a `Result<Vec<LogOutput>, GetLogsError>` instead of a stream.
- Updated example usage in `get_logs.rs` to reflect the new return type.
- Removed the `LogOutputStream` struct and its associated tests as it is no longer needed.
- Adjusted `LogsOptions` to disable the follow option by default and updated related tests accordingly.

* chore: ran formatting

* chore: removed unused dependency

Author: jeroenvervaeke

Cargo.lock

@@ -36,7 +36,6 @@ bytes = "1.10"
 chrono = "0.4.42"
 futures-util = "0.3.31"
 maplit = "1.0.2"
-pin-project = "1.1.10"
 rand = "0.9.2"
 semver = "1.0.27"
 serde = { version = "1.0.228", features = ["derive"], optional = true }

Cargo.toml

@@ -4,7 +4,7 @@ THIRD PARTY LICENSES
 This file lists the licenses of the projects used in atlas-local-lib.
 
 OVERVIEW OF LICENSES:
-- Apache License 2.0 (119 dependencies)
+- Apache License 2.0 (117 dependencies)
 - MIT License (21 dependencies)
 - Unicode License v3 (19 dependencies)
 
@@ -3631,9 +3631,7 @@ limitations under the License.
         - bollard-stubs 1.49.1-rc.28.4.0 (https://crates.io/crates/bollard-stubs)
         - itoa 1.0.15 (https://github.com/dtolnay/itoa)
         - libc 0.2.175 (https://github.com/rust-lang/libc)
-        - pin-project-internal 1.1.10 (https://github.com/taiki-e/pin-project)
         - pin-project-lite 0.2.16 (https://github.com/taiki-e/pin-project-lite)
-        - pin-project 1.1.10 (https://github.com/taiki-e/pin-project)
         - proc-macro2 1.0.101 (https://github.com/dtolnay/proc-macro2)
         - quote 1.0.40 (https://github.com/dtolnay/quote)
         - r-efi 5.3.0 (https://github.com/r-efi/r-efi)

LICENSE-3RD-PARTY.txt

@@ -4,7 +4,6 @@ use atlas_local::{
     models::{CreateDeploymentOptions, LogsOptions, Tail},
 };
 use bollard::Docker;
-use futures_util::StreamExt;
 
 #[tokio::main]
 async fn main() -> Result<()> {
@@ -26,15 +25,15 @@ async fn main() -> Result<()> {
         .build();
 
     // Get logs from the deployment
-    let mut logs = client.get_logs(&deployment.container_id, Some(log_options));
+    let logs = client
+        .get_logs(&deployment.container_id, Some(log_options))
+        .await
+        .context("getting logs")?;
 
     println!("Container logs:");
-    while let Some(log_result) = logs.next().await {
-        match log_result {
-            // Use print! instead of println! because logs contain new line characters
-            Ok(log) => print!("{}", log),
-            Err(e) => eprintln!("Error reading log: {}", e),
-        }
+    for log in logs {
+        // Use print! instead of println! because logs contain new line characters
+        print!("{}", log);
     }
 
     Ok(())

examples/get_logs.rs

@@ -1,8 +1,9 @@
 use crate::{
     client::Client,
     docker::DockerLogContainer,
-    models::{LogOutputStream, LogsOptions},
+    models::{LogOutput, LogsOptions},
 };
+use futures_util::{StreamExt, pin_mut};
 
 #[derive(Debug, thiserror::Error)]
 pub enum GetLogsError {
@@ -16,11 +17,11 @@ impl<D: DockerLogContainer> Client<D> {
     /// # Arguments
     ///
     /// * `container_id_or_name` - The ID or name of the container to get logs from.
-    /// * `options` - Optional logging options (e.g., follow, tail, timestamps, etc.)
+    /// * `options` - Optional logging options (e.g., tail, timestamps, etc.)
     ///
     /// # Returns
     ///
-    /// A [`LogOutputStream`] that yields log entries from the container.
+    /// A `Result` containing a vector of log entries from the container, or an error if the logs could not be retrieved.
     ///
     /// # Examples
     ///
@@ -34,13 +35,22 @@ impl<D: DockerLogContainer> Client<D> {
     #[doc = "```rust,no_run"]
     #[doc = include_str!("../../examples/get_logs.rs")]
     #[doc = "```"]
-    pub fn get_logs<'a>(
-        &'a self,
-        container_id_or_name: &'a str,
+    pub async fn get_logs(
+        &self,
+        container_id_or_name: &str,
         options: Option<LogsOptions>,
-    ) -> LogOutputStream<'a> {
+    ) -> Result<Vec<LogOutput>, GetLogsError> {
         let bollard_options = options.map(bollard::query_parameters::LogsOptions::from);
-        LogOutputStream::new(self.docker.logs(container_id_or_name, bollard_options))
+        let stream = self.docker.logs(container_id_or_name, bollard_options);
+        pin_mut!(stream);
+
+        let mut logs = Vec::new();
+        while let Some(result) = stream.next().await {
+            let log_output = result.map_err(GetLogsError::ContainerLogs)?;
+            logs.push(LogOutput::from(log_output));
+        }
+
+        Ok(logs)
     }
 }
 
@@ -89,15 +99,15 @@ mod tests {
         let options = LogsOptions::builder().stdout(true).stderr(true).build();
 
         // Act
-        let logs: Vec<_> = client
+        let logs = client
             .get_logs("test-container", Some(options))
-            .collect()
-            .await;
+            .await
+            .expect("get_logs should succeed");
 
         // Assert
         assert_eq!(logs.len(), 2);
-        assert!(logs[0].is_ok());
-        assert!(logs[1].is_ok());
+        assert!(logs[0].is_stdout());
+        assert!(logs[1].is_stdout());
     }
 
     #[tokio::test]
@@ -124,16 +134,12 @@ mod tests {
         let client = Client::new(mock_docker);
 
         // Act
-        let logs: Vec<_> = client
-            .get_logs("nonexistent-container", None)
-            .collect()
-            .await;
+        let result = client.get_logs("nonexistent-container", None).await;
 
         // Assert
-        assert_eq!(logs.len(), 1);
-        assert!(logs[0].is_err());
+        assert!(result.is_err());
         assert!(matches!(
-            logs[0].as_ref().unwrap_err(),
+            result.as_ref().unwrap_err(),
             GetLogsError::ContainerLogs(_)
         ));
     }
@@ -166,34 +172,21 @@ mod tests {
         let options = LogsOptions::builder().stdout(true).stderr(true).build();
 
         // Act
-        let logs: Vec<_> = client
+        let logs = client
             .get_logs("test-container", Some(options))
-            .collect()
-            .await;
+            .await
+            .expect("get_logs should succeed");
 
         // Assert
         assert_eq!(logs.len(), 3);
-        assert!(logs.iter().all(|log| log.is_ok()));
 
         // Verify first is stdout
-        if let Ok(log) = &logs[0] {
-            assert!(log.is_stdout());
-        } else {
-            panic!("Expected stdout log");
-        }
+        assert!(logs[0].is_stdout());
 
         // Verify second is stderr
-        if let Ok(log) = &logs[1] {
-            assert!(log.is_stderr());
-        } else {
-            panic!("Expected stderr log");
-        }
+        assert!(logs[1].is_stderr());
 
         // Verify third is stdout
-        if let Ok(log) = &logs[2] {
-            assert!(log.is_stdout());
-        } else {
-            panic!("Expected stdout log");
-        }
+        assert!(logs[2].is_stdout());
     }
 }

src/client/get_logs.rs

@@ -58,7 +58,7 @@ impl std::fmt::Display for Tail {
 ///
 /// This struct provides configuration options for fetching container logs,
 /// including filtering by stream type (stdout/stderr), limiting the number
-/// of lines, adding timestamps, and following the log stream in real-time.
+/// of lines, and adding timestamps.
 ///
 /// # Examples
 ///
@@ -90,9 +90,6 @@ pub struct LogsOptions {
     /// Add timestamps to every log line
     #[builder(default = false)]
     pub timestamps: bool,
-    /// Follow the log stream (keep connection open for new logs)
-    #[builder(default = false)]
-    pub follow: bool,
     /// Return this number of lines at the tail of the logs
     #[builder(default, setter(strip_option, into))]
     pub tail: Option<Tail>,
@@ -101,7 +98,7 @@ pub struct LogsOptions {
 impl From<LogsOptions> for bollard::query_parameters::LogsOptions {
     fn from(options: LogsOptions) -> Self {
         bollard::query_parameters::LogsOptions {
-            follow: options.follow,
+            follow: false,
             stdout: options.stdout,
             stderr: options.stderr,
             since: options.since.map(|t| t.timestamp() as i32).unwrap_or(0),
@@ -124,7 +121,6 @@ mod tests {
             .since(DateTime::from_timestamp(1234567890, 0).unwrap())
             .until(DateTime::from_timestamp(1234567900, 0).unwrap())
             .timestamps(true)
-            .follow(false)
             .tail(Tail::Number(100))
             .build();
 
@@ -201,7 +197,6 @@ mod tests {
             since: None,
             until: None,
             timestamps: false,
-            follow: false,
             tail: Some(Tail::All),
         };
 

src/models/log_output_stream.rs

@@ -4,7 +4,6 @@ mod deployment;
 mod environment_variables;
 mod labels;
 mod log_output;
-mod log_output_stream;
 mod logs_options;
 mod mongodb_type;
 mod port_binding;
@@ -16,7 +15,6 @@ pub use deployment::*;
 pub use environment_variables::*;
 pub use labels::*;
 pub use log_output::*;
-pub use log_output_stream::*;
 pub use logs_options::*;
 pub use mongodb_type::*;
 pub use port_binding::*;