Emit progress state escape codes #11436

albertlarsan68 · 2022-11-28T18:11:51Z

Emit progress state escape codes when drawing progress bar.

rustbot · 2022-11-28T18:11:56Z

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) soon.

Please see the contribution instructions for more information.

weihanglo

Thanks for the pull request, and sorry for the long wait.

This is a UI change. Could you demonstrate demo GIFs or videos for it? It would be helpful if you could provide the result on both msvc and mingw.

In addition, do you have the official documentation at hand about this escape code? CodeEmu doc doesn't seem to be official I feel like.

src/cargo/util/progress.rs

weihanglo · 2022-12-21T11:19:23Z

src/cargo/util/progress.rs

@@ -39,6 +40,25 @@ struct Format {
    max_print: usize,
 }

+enum ProgressCode {


This is Windows-only feature, right? Is it possible to add #[cfg(windows)] for all relevant code and items?

Also, having doc comments on each new items would be fantastic. Thanks!

I do think that other terminal emulators may also implement those, but I can't verify now.
It seems like per alacritty/alacritty#5201, it won't get this support, however.

albertlarsan68 · 2022-12-21T12:10:16Z

In addition, do you have the official documentation at hand about this escape code? CodeEmu doc doesn't seem to be official I feel like.

As per microsoft/terminal#8055, the ConEmu style is the implementation reference.

Emit progress state escape codes when drawing progress bar.

albertlarsan68 · 2022-12-21T14:05:21Z

Here is a screen recording of running cargo check with b60dc0d (I recommend watching it at x2 speed):

2022-12-21.14-57-40.mp4

Notice the bar in the taskbar, and the circle getting bigger / fuller at the top left corner.

weihanglo · 2022-12-21T17:22:52Z

Thanks for the screen recording!

Unfortunately on macOS it doesn't seem to compile: https://github.com/rust-lang/cargo/actions/runs/3749845063/jobs/6368801382

I am still uncertain the adoption rate of this non-standard escape code. Does the majority of terminal emulators handle or ignore this well? Sorry being so conservative but I've seen some issue around “escape code not recognized” sometimes. That's also why I suggested adding #[cfg(windows)] at the very first, and even on Windows there are a bunch of different emulators. I'd recommend collecting the usage and support data before rolling out this feature :)

albertlarsan68 · 2022-12-21T18:14:38Z

Current testing progress:

Terminal	Support
Windows Terminal	✅
Git MinTTY	✅ (but reset only happens when progress is set to 0)
Alacritty	❌ (Feature seemingly refused)

Procedure:
run echo -e "\e]9;4;1;50\e\\" for Linux-like, or copy the line below for Powershell Core and paste it at the prompt.
Reset with echo -e "\e]9;4;0;50\e\\" or the second line. If that doesn't work replace the 50 with a 0.

"`e]9;4;1;50`e\"
"`e]9;4;0;50`e\"

weihanglo · 2023-01-09T11:13:47Z

#11436 (comment) was a good try. Thank you. I'll probably split Support to two columns:

Support the display of the progress bar or not.
If not supported, would it break things or just ignore the unrecognized escape code?

Marked this as S-blocked as it need more data to ensure it won't break the majority from different terminal on Windows.

weihanglo · 2023-05-11T14:27:43Z

Personally I love this kind of good UI enhancement with the system. We just need more data to make sure it is safe for most people. Going to close due to inactivity. We still look for people investing in surveying.

Thank you anyway!

Edited: track in #11432.

@weihanglo

### What does this PR try to resolve? A few terminal emulators support progress output to Windows taskbar. `winget` uses this to show install progress. Notably, Windows Terminal [recently (2020) added support](microsoft/terminal#8055) for ANSI codes [specified](https://conemu.github.io/en/AnsiEscapeCodes.html#ConEmu_specific_OSC) in ConEmu (another terminal emulator for Windows) documentation. Also, in "[Learn Windows](https://learn.microsoft.com/en-us/windows/terminal/tutorials/progress-bar-sequences)". 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 supported terminal emulators.** Fixes #11432 FCP: #14615 (comment) ### 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 - [x] Should all the code be `#[cfg(windows)]`? Probably no, because the feature is also usable in WSL. > Solved by introducing heuristic based on environment variable set by terminal - [ ] 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. - [x] `Enabled` is a sensible default for WSL because it works on linux builds in Windows Terminal too > Solved by introducing heuristic based on environment variable set by terminal - [x] Downloading stage may produce unpleasant blinking due to a rapid 0-100 changes > Solved by not displaying bar when downloading and using indeterminate state in other cases so amination don't reset ### TLDR * An `term.progress.taskbar` option with bool type is added * On Windows Terminal and ConEmu is enabled by default * If enabled reports build progress to taskbar icon and/or tab header ### Videos https://github.com/user-attachments/assets/48bb648a-e819-490e-b3ac-3502bc5f2f3a https://github.com/user-attachments/assets/1d7ddf7a-34dd-4db1-b654-e64d7170798e

rustbot assigned epage Nov 28, 2022

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 28, 2022

weihanglo reviewed Dec 21, 2022

View reviewed changes

albertlarsan68 added 4 commits December 21, 2022 14:38

Emit progress state escape codes

a8d7472

Emit progress state escape codes when drawing progress bar.

Reduce flicker

7ed089b

Apply review suggestions

8e76c7e

Signal end of progress when cleaning

b60dc0d

albertlarsan68 force-pushed the progress-ansi-codes branch from 888a723 to b60dc0d Compare December 21, 2022 13:47

Restrict to cfg(windows) only

6fa572e

weihanglo added S-blocked and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 9, 2023

weihanglo added S-needs-design Status: Needs someone to work further on the design for the feature or fix. NOT YET accepted. and removed S-blocked labels Apr 18, 2023

weihanglo marked this pull request as draft April 18, 2023 21:55

weihanglo mentioned this pull request May 11, 2023

Use ANSI codes to report progress #11432

Closed

weihanglo closed this May 11, 2023

Gordon01 mentioned this pull request Sep 29, 2024

Add terminal integration via ANSI OSC 9;4 sequences #14615

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Emit progress state escape codes #11436

Emit progress state escape codes #11436

albertlarsan68 commented Nov 28, 2022

rustbot commented Nov 28, 2022

weihanglo left a comment

weihanglo Dec 21, 2022

albertlarsan68 Dec 21, 2022

albertlarsan68 commented Dec 21, 2022

albertlarsan68 commented Dec 21, 2022 •

edited

Loading

weihanglo commented Dec 21, 2022

albertlarsan68 commented Dec 21, 2022 •

edited

Loading

weihanglo commented Jan 9, 2023

weihanglo commented May 11, 2023 •

edited

Loading

Emit progress state escape codes #11436

Emit progress state escape codes #11436

Conversation

albertlarsan68 commented Nov 28, 2022

rustbot commented Nov 28, 2022

weihanglo left a comment

Choose a reason for hiding this comment

weihanglo Dec 21, 2022

Choose a reason for hiding this comment

albertlarsan68 Dec 21, 2022

Choose a reason for hiding this comment

albertlarsan68 commented Dec 21, 2022

albertlarsan68 commented Dec 21, 2022 • edited Loading

weihanglo commented Dec 21, 2022

albertlarsan68 commented Dec 21, 2022 • edited Loading

weihanglo commented Jan 9, 2023

weihanglo commented May 11, 2023 • edited Loading

albertlarsan68 commented Dec 21, 2022 •

edited

Loading

albertlarsan68 commented Dec 21, 2022 •

edited

Loading

weihanglo commented May 11, 2023 •

edited

Loading