Add progress bars to long-running operations #153
Merged
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
Wrap oras.Target in a struct that shows progress bars for the Push operation. The wrap function can be used on any target to show a progress bar when we push data to it (note, the oras Copy operation uses the Pusher interface internally) This adds a new dependency to go.mod, for github.com/vbauerster/mpb/v8. The mpb package automatically suppresses logging progress bars when output is not a TTY.
Add progress bar for unpacking. For this case, as kit potentially prints info lines while unpacking, logs are printed above a progress bar, and the progress bar is removed on completion to avoid cluttering the display.
Rework progress bar wrappers to return an output struct that should be used instead of the default output functions. This allows printing information above a progress bar without the bar overwriting output.
This was
linked to
issues
Mar 22, 2024
|
Probably needs a test update |
|
Yup, I missed a couple edge cases in porting the tests over to the output package. I dropped the padding on byte quantities since I think it's no longer necessary |
gorkem
approved these changes
Mar 22, 2024
|
Yeah, agreed. I'm not thrilled with it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add progress bars for kit push, pull, and unpack:
Unpack
Pull (Push is the same)
Progress bars can be disabled via
--progress=falseand are disabled when the output is not a TTY. For push/pull, one progress bar is shown per blob downloaded; for unpack a progress bar is shown for the current step, below the regular output, which allows for regular logging (e.g. debug logs) without interfering with the bar.