From: "Fabian Grünbichler" <f.gruenbichler@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup] fix #4483: fix `task log` command interrupt handling
Date: Wed, 18 Jan 2023 14:53:42 +0100 [thread overview]
Message-ID: <20230118135342.1226289-1-f.gruenbichler@proxmox.com> (raw)
`proxmox-backup-client task log ..` and `proxmox-backup-manager task log ..`
are used to view the logs of tasks that have been started by another client, so
interrupting the task progress view should not forward the interrupt to the
running task. other call sites of the same helper(s) that spawn a task and then
print its progress should keep the old behaviour of interrupting the spawned
task on C^c.
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
---
pbs-client/src/task_log.rs | 26 +++++++++++++++++---------
proxmox-backup-client/src/task.rs | 2 +-
src/bin/proxmox-backup-manager.rs | 2 +-
3 files changed, 19 insertions(+), 11 deletions(-)
diff --git a/pbs-client/src/task_log.rs b/pbs-client/src/task_log.rs
index 960653de..372d63df 100644
--- a/pbs-client/src/task_log.rs
+++ b/pbs-client/src/task_log.rs
@@ -17,13 +17,14 @@ use super::HttpClient;
/// Display task log on console
///
/// This polls the task API and prints the log to the console. It also
-/// catches interrupt signals, and sends a abort request to the task if
-/// the user presses CTRL-C. Two interrupts cause an immediate end of
-/// the loop. The task may still run in that case.
+/// catches interrupt signals, and sends an abort request to the task if the
+/// user presses CTRL-C and `forward_interrupt` is true. Two interrupts cause an
+/// immediate end of the loop. The task may still run in that case.
pub async fn display_task_log(
client: &HttpClient,
upid_str: &str,
strip_date: bool,
+ forward_interrupt: bool,
) -> Result<(), Error> {
let mut signal_stream = signal(SignalKind::interrupt())?;
let abort_count = Arc::new(AtomicUsize::new(0));
@@ -48,11 +49,15 @@ pub async fn display_task_log(
loop {
let abort = abort_count.load(Ordering::Relaxed);
if abort > 0 {
- let path = format!(
- "api2/json/nodes/localhost/tasks/{}",
- percent_encode_component(upid_str)
- );
- let _ = client.delete(&path, None).await?;
+ if forward_interrupt {
+ let path = format!(
+ "api2/json/nodes/localhost/tasks/{}",
+ percent_encode_component(upid_str)
+ );
+ let _ = client.delete(&path, None).await?;
+ } else {
+ return Ok(());
+ }
}
let param = json!({ "start": start, "limit": limit, "test-status": true });
@@ -111,6 +116,9 @@ pub async fn display_task_log(
}
/// Display task result (upid), or view task log - depending on output format
+///
+/// In case of a task log of a running task, this will forward interrupt signals
+/// to the task and potentially abort it!
pub async fn view_task_result(
client: &HttpClient,
result: Value,
@@ -119,7 +127,7 @@ pub async fn view_task_result(
let data = &result["data"];
if output_format == "text" {
if let Some(upid) = data.as_str() {
- display_task_log(client, upid, true).await?;
+ display_task_log(client, upid, true, true).await?;
}
} else {
format_and_print_result(data, output_format);
diff --git a/proxmox-backup-client/src/task.rs b/proxmox-backup-client/src/task.rs
index 94c879a8..472db086 100644
--- a/proxmox-backup-client/src/task.rs
+++ b/proxmox-backup-client/src/task.rs
@@ -104,7 +104,7 @@ async fn task_log(param: Value) -> Result<Value, Error> {
let client = connect(&repo)?;
- display_task_log(&client, upid, true).await?;
+ display_task_log(&client, upid, true, false).await?;
Ok(Value::Null)
}
diff --git a/src/bin/proxmox-backup-manager.rs b/src/bin/proxmox-backup-manager.rs
index 06330c78..f084af31 100644
--- a/src/bin/proxmox-backup-manager.rs
+++ b/src/bin/proxmox-backup-manager.rs
@@ -189,7 +189,7 @@ async fn task_log(param: Value) -> Result<Value, Error> {
let client = connect_to_localhost()?;
- display_task_log(&client, upid, true).await?;
+ display_task_log(&client, upid, true, false).await?;
Ok(Value::Null)
}
--
2.30.2
next reply other threads:[~2023-01-18 13:53 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-18 13:53 Fabian Grünbichler [this message]
2023-01-19 9:12 ` [pbs-devel] applied: " Thomas Lamprecht
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230118135342.1226289-1-f.gruenbichler@proxmox.com \
--to=f.gruenbichler@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox