Close the Progress Bar Container (Resource Leak)#28961
Open
VLADO2000 wants to merge 1 commit into
Open
Conversation
In ProgressBar, initialization of an mpb.New(...) container, but it returns alongside the bar without waiting for it or closing it. The mpb package leaks a goroutine if p.Wait() is never called on the returned *mpb.Progress instance by the caller. To ensure the caller knows they must wait for it, updating the comment documentation is highly recommended so they know to defer p.Wait(). Signed-off-by: WLOT <96411435+VLADO2000@users.noreply.github.com>
Honny1
added
the
No New Tests
Contributor
|
PTAL @podman-container-tools/podman-reviewers @podman-container-tools/podman-maintainers |
Contributor
|
@VLADO2000, can you please fix formatting? Thanks. |
Luap99
reviewed
Jun 18, 2026
Luap99
left a comment
Luap99
left a comment
Member
There was a problem hiding this comment.
The commit title does not match the logic?
All you do is add some doc comment but your title makes it sounds like you address a leak which is not true at all.
it should likely be more like "add doc comment to ProgressBar"
mtrmac
reviewed
Jun 18, 2026
|
|
||
| // ProgressBar initializes a progress bar container and an individual bar. | ||
| // | ||
| // CRITICAL: The caller MUST call `p.Wait()` on the returned *mpb.Progress |
Contributor
There was a problem hiding this comment.
(Given that this needs an update anyway:) “critical” is overdoing it, this is a fairly ordinary part of the function’s contract. I think that prefix can be just dropped.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
In ProgressBar, initialization of an mpb.New(...) container, but it returns alongside the bar without waiting for it or closing it. The mpb package leaks a goroutine if p.Wait() is never called on the returned *mpb.Progress instance by the caller.
To ensure the caller knows they must wait for it, updating the comment documentation is highly recommended so they know to defer p.Wait().
Checklist
Ensure you have completed the following checklist for your pull request to be reviewed:
commits. (
git commit -s). (If needed, usegit commit -s --amend). The author email must matchthe sign-off email address. See CONTRIBUTING.md
for more information.
Fixes: #00000in commit message (if applicable)make validatepr(format/lint checks)Noneif no user-facing changes)Does this PR introduce a user-facing change?