change: Allow pueue log to filter by group and --all

CHANGELOG.md

@@ -6,7 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## \[Unreleased\]
 
-### Added
+### Change
+
+- **Breaking**: Streamlined `pueue log` parameters to behave the same way was `start`, `pause` or `kill`. [#509](https://github.com/Nukesor/pueue/issues/509)
+
+### Add
+
+- Add `--all` and `--group` to `pueue log`. [#509](https://github.com/Nukesor/pueue/issues/509)
 
 ## \[3.4.1\] - 2024-06-04
 

pueue/src/client/cli.rs

@@ -389,6 +389,14 @@
         /// View the task output of these specific tasks.
         task_ids: Vec<usize>,
 
+        /// View the outputs of this specific group's tasks.
+        #[arg(short, long)]
+        group: Option<String>,
+
+        /// Show the logs of all groups' tasks.
+        #[arg(short, long)]
+        all: bool,
+
         /// Print the resulting tasks and output as json.
         /// By default only the last lines will be returned unless --full is provided.
         /// Take care, as the json cannot be streamed!

pueue/src/client/client.rs

@@ -517,13 +517,16 @@ impl Client {
             SubCommand::Log {
                 task_ids,
                 lines,
+                group,
                 full,
+                all,
                 ..
             } => {
                 let lines = determine_log_line_amount(*full, lines);
+                let selection = selection_from_params(*all, group, task_ids);
 
                 let message = LogRequestMessage {
-                    task_ids: task_ids.clone(),
+                    tasks: selection,
                     send_logs: !self.settings.client.read_local_logs,
                     lines,
                 };

pueue/src/client/display/log/mod.rs

@@ -3,12 +3,13 @@
 use comfy_table::{Attribute as ComfyAttribute, Cell, CellAlignment, Table};
 use crossterm::style::Color;
 
-use pueue_lib::network::message::TaskLogMessage;
+use pueue_lib::network::message::{TaskLogMessage, TaskSelection};
 use pueue_lib::settings::Settings;
 use pueue_lib::task::{Task, TaskResult, TaskStatus};
 
 use super::OutputStyle;
 use crate::client::cli::SubCommand;
+use crate::client::client::selection_from_params;
 
 mod json;
 mod local;
@@ -52,8 +53,10 @@
     let SubCommand::Log {
         json,
         task_ids,
+        group,
         lines,
         full,
+        all,
     } = cli_command
     else {
         panic!("Got wrong Subcommand {cli_command:?} in print_log. This shouldn't happen");
@@ -67,15 +70,22 @@
         return;
     }
 
-    // Check some early return conditions
-    if task_ids.is_empty() && task_logs.is_empty() {
-        println!("There are no finished tasks");
-        return;
-    }
-
-    if !task_ids.is_empty() && task_logs.is_empty() {
-        println!("There are no finished tasks for your specified ids");
-        return;
+    let selection = selection_from_params(*all, group, task_ids);
+    if task_logs.is_empty() {
+        match selection {
+            TaskSelection::TaskIds(_) => {
+                println!("There are no finished tasks for your specified ids");
+                return;
+            }
+            TaskSelection::Group(group) => {
+                println!("There are no finished tasks for group '{group}'");
+                return;
+            }
+            TaskSelection::All => {
+                println!("There are no finished tasks");
+                return;
+            }
+        }
     }
 
     // Iterate over each task and print the respective log.

pueue/src/daemon/network/message_handler/log.rs

@@ -9,11 +9,11 @@ use pueue_lib::state::SharedState;
 /// Return tasks and their output to the client.
 pub fn get_log(message: LogRequestMessage, state: &SharedState, settings: &Settings) -> Message {
     let state = { state.lock().unwrap().clone() };
-    // Return all logs, if no specific task id is specified.
-    let task_ids = if message.task_ids.is_empty() {
-        state.tasks.keys().cloned().collect()
-    } else {
-        message.task_ids
+
+    let task_ids = match message.tasks {
+        TaskSelection::All => state.tasks.keys().cloned().collect(),
+        TaskSelection::TaskIds(task_ids) => task_ids,
+        TaskSelection::Group(group) => state.task_ids_in_group(&group),
     };
 
     let mut tasks = BTreeMap::new();

pueue/tests/daemon/integration/log.rs

@@ -95,7 +95,7 @@ async fn test_partial_log() -> Result<()> {
 
     // Request a partial log for task 0
     let log_message = LogRequestMessage {
-        task_ids: vec![0],
+        tasks: TaskSelection::TaskIds(vec![0]),
         send_logs: true,
         lines: Some(5),
     };
@@ -132,7 +132,7 @@ async fn test_correct_log_order() -> Result<()> {
 
     // Request all log lines
     let log_message = LogRequestMessage {
-        task_ids: vec![0],
+        tasks: TaskSelection::TaskIds(vec![0]),
         send_logs: true,
         lines: None,
     };
@@ -155,3 +155,71 @@ async fn test_correct_log_order() -> Result<()> {
 
     Ok(())
 }
+
+/// Make sure that it's possible to get only logs of a specific group
+#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
+async fn logs_of_group() -> Result<()> {
+    let daemon = daemon().await?;
+    let shared = &daemon.settings.shared;
+
+    // Add one task on the default group.
+    let command = "echo 'default group'";
+    assert_success(add_task(shared, command).await?);
+
+    // Add one task on the test group.
+    let command = "echo 'testgroup'";
+    assert_success(add_task_to_group(shared, command, "test_2").await?);
+
+    // Wait for both to finish
+    wait_for_task_condition(shared, 1, |task| task.is_done()).await?;
+
+    // Request the task's logs.
+    let message = LogRequestMessage {
+        tasks: TaskSelection::Group("test_2".to_string()),
+        send_logs: true,
+        lines: None,
+    };
+    let response = send_message(shared, message).await?;
+    let logs = match response {
+        Message::LogResponse(logs) => logs,
+        _ => bail!("Didn't get log response response in get_state"),
+    };
+
+    assert_eq!(logs.len(), 1, "Sould only receive a single log entry.");
+
+    Ok(())
+}
+
+/// Make sure that it's possible to get logs across groups.
+#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
+async fn logs_for_all() -> Result<()> {
+    let daemon = daemon().await?;
+    let shared = &daemon.settings.shared;
+
+    // Add one task on the default group.
+    let command = "echo 'default group'";
+    assert_success(add_task(shared, command).await?);
+
+    // Add one task on the test group.
+    let command = "echo 'testgroup'";
+    assert_success(add_task_to_group(shared, command, "test_2").await?);
+
+    // Wait for both to finish
+    wait_for_task_condition(shared, 1, |task| task.is_done()).await?;
+
+    // Request the task's logs.
+    let message = LogRequestMessage {
+        tasks: TaskSelection::All,
+        send_logs: true,
+        lines: None,
+    };
+    let response = send_message(shared, message).await?;
+    let logs = match response {
+        Message::LogResponse(logs) => logs,
+        _ => bail!("Didn't get log response response in get_state"),
+    };
+
+    assert_eq!(logs.len(), 2, "Sould receive all log entries.");
+
+    Ok(())
+}

pueue/tests/helper/asserts.rs

@@ -49,7 +49,7 @@ pub async fn assert_worker_envs(
     let response = send_message(
         shared,
         LogRequestMessage {
-            task_ids: vec![task_id],
+            tasks: TaskSelection::TaskIds(vec![task_id]),
             send_logs: true,
             lines: None,
         },

pueue/tests/helper/log.rs

@@ -23,7 +23,7 @@ pub fn decompress_log(bytes: Vec<u8>) -> Result<String> {
 /// `lines: None` requests all log lines.
 pub async fn get_task_log(shared: &Shared, task_id: usize, lines: Option<usize>) -> Result<String> {
     let message = LogRequestMessage {
-        task_ids: vec![task_id],
+        tasks: TaskSelection::TaskIds(vec![task_id]),
         send_logs: true,
         lines,
     };

pueue_lib/src/network/message.rs

@@ -300,12 +300,12 @@ impl_into_message!(StreamRequestMessage, Message::StreamRequest);
 
 /// Request logs for specific tasks.
 ///
-/// `task_ids` specifies the requested tasks. If none are given, all tasks are selected.
+/// `tasks` specifies the requested tasks.
 /// `send_logs` Determines whether logs should be sent at all.
 /// `lines` Determines whether only a few lines of log should be returned.
 #[derive(PartialEq, Eq, Clone, Debug, Deserialize, Serialize)]
 pub struct LogRequestMessage {
-    pub task_ids: Vec<usize>,
+    pub tasks: TaskSelection,
     pub send_logs: bool,
     pub lines: Option<usize>,
 }