Taskbar progress reporting via ANSI codes #14615

Gordon01 · 2024-09-29T20:23:37Z

What does this PR try to resolve?

A few traminal emulators support progress output to Windows taskbar. winget uses this to show install progress.

Notably, Windows Terminal recently (2020) added support for ANSI codes specified in ConEmu (another terminal emulator for Windows) documentation. Also, in "Learn Windows".

I've found the previous attempt to add this feature: #11436

As per @weihanglo's request, I've added the config option to enable/disable this feature. It's enabled on Windows by default.

Fixes #11432

How should we test and review this PR?

Run cargo build in Windows Terminal with configuration option term.progress.taskbar set to true.

Not sure

Should all the code be #[cfg(windows)]? Probably no, because feature is also usable in WSL.
If Ctrl+C is pressed, a progressbar will stay in a last state forever (shown in the ConEmu video). winget is also behaves like alike. I've experimented with ctrl_c handler and it's totally fixable.
Enabled is a sensible default for WSL because it works on linux builds in Windows Terminal too
Downloading stage may produce unpleasant blinking due to a rapid 0-100 changes

TLDR

An term.progress.taskbar option with bool type is added
On Windows it is set to true when unspecified
If enabled together with cargo progress bar feature, emits ANSI escape codes to draw a progress bar on taskbar on supported terminal

Videos

Windows.PowerShell.2024-09-29.23-21-21.mp4

cmd.2024-09-29.23-36-25.mp4

rustbot · 2024-09-29T20:23:43Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @epage (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

@rustbot author: the review is finished, PR author should check the comments and take action accordingly
@rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

src/doc/src/reference/config.md

epage · 2024-09-30T14:27:15Z

src/cargo/util/context/mod.rs

Could you clean up the commits to represent how you want this reviewed and merged?

epage · 2024-09-30T14:28:00Z

src/cargo/util/progress.rs

+    fn from_config(config: Option<bool>) -> Self {
+        let show = match config {
+            Some(v) => v,
+            None => cfg!(target_os = "windows"),


I don't think target_os is sufficient. We should be checking the terminal as well.

epage · 2024-09-30T14:38:05Z

src/cargo/util/progress.rs

+        // When st is 0: remove progress.
+        // When st is 1: set progress value to pr (number, 0-100).
+        // When st is 2: set error state in taskbar, pr is optional.
+        // When st is 3: set indeterminate state.


Should we respect ProgressStyle::Indeterminate and have a way of outputting this?

epage · 2024-09-30T14:38:43Z

src/cargo/util/progress.rs

@@ -280,6 +353,7 @@ impl<'gctx> State<'gctx> {
        // return back to the beginning of the line for the next print.
        self.try_update_max_width();
        if let Some(pbar) = self.format.progress(cur, max) {
+            self.taskbar.percent = ((cur as f32) / (max as f32) * 100.0) as u8;


Format has a progress function to abstract things like this. I feel like self.taskbar should as well.

epage · 2024-09-30T14:42:39Z

src/cargo/util/progress.rs

+        // ESC ] 9 ; 4 ; st ; pr ST
+        // When st is 0: remove progress.
+        // When st is 1: set progress value to pr (number, 0-100).
+        // When st is 2: set error state in taskbar, pr is optional.


Only slightly related to this PR: Any details on the error state? Wondering how we could use that.

Gordon01 added 4 commits September 29, 2024 20:13

First try

852bcad

Always clear

e75899b

Fix blinking

2e3c45a

Add a configuration option

798c777

rustbot assigned epage Sep 29, 2024

rustbot added A-configuration Area: cargo config files and env vars A-console-output Area: Terminal output, colors, progress bar, etc. A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 29, 2024

Fix formatting

46d1178