This repository has been archived by the owner on Jun 28, 2023. It is now read-only.
Introduce terminal-width aware animated logging for unmanaged-cluster
#2929
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joshrosso
suggested changes
Jan 25, 2022
Inspects the terminal width using the attached terminal's file descriptor. Then, checks if the generated message will be larger than the terminal's width. If so, we rebuild a truncated string that will fit in the terminal width Signed-off-by: John McBride <[email protected]>
jpmcb
force-pushed
the
unmanaged-term-size
branch
from
6a7c336 to
13945c2
Compare
|
Hmmmm @joshrosso maybe an old binary? I just pushed again to 13945c2 Here's what I'm seeing on a small terminal:
|
|
Works right for me on iTerm2. I did need to make sure to
Will try on my Linux machine to see if it matches what @joshrosso is seeing. |
|
Here's on my linux desktop, PopOS, zsh, using Alacrity terminal: Normal width
Small width
|
|
Worked as expected for me with default Ubuntu terminal and Sakura terminal. |
stmcginnis
approved these changes
Jan 25, 2022
joshrosso
approved these changes
Jan 25, 2022
stmcginnis
approved these changes
Jan 25, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it
Introduces "terminal-width" aware progress logging.
Using the file descriptor of the attached terminal, we can determine the width of the terminal using Go's standard library. There is a bug (described in depth here) that keeps long lines in small terminals from being replaced.
So, if the progress line is too long, we rebuild a truncated version of it. While this does cut off some information, the next "success" log line is still full length giving the user all the necessary details.
Shout out to @stmcginnis for finding a solution to this in the go std library!!
Details for the Release Notes (PLEASE PROVIDE)
Which issue(s) this PR fixes
Fixes: #2852
Describe testing done for PR
Normal terminal size still works great:
Small terminal now won't have the wrapping issue. Lines get replaced as expected:
note: even though the full path here is getting truncated, the "success" line is still full length and replaces that line successfully giving all the necessary details to the user. Example:
Special notes for your reviewer
N/a