fix: progress bar image name flashes on push

[AustinAbro321]

Description

This PR fixes the CLI flashing when pushing images. This can be seen in the linked gif in the issue #2651

Related Issue

Fixes #2651

Checklist before merging

• Test, docs, adr added or updated as needed
• Contributor Guide Steps followed

[netlify]

✅ Deploy Preview for zarf-docs canceled.

Name	Link
🔨 Latest commit	f057f8f
🔍 Latest deploy log	https://app.netlify.com/sites/zarf-docs/deploys/66d9bbfe9c2428000888b601

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/internal/packager/images/push.go	0.00%	3 Missing ⚠️

Files with missing lines	Coverage Δ
src/internal/packager/images/push.go	0.00% <0.00%> (ø)

[phillebaba]

Does the total progress even matter? We set it when we define the progress bar but we never update it as far as I can see? I want to make sure that reusing the progress bar wont result in starting at the progress state where we ended.

[AustinAbro321]

Great question @phillebaba. The total progress does matter. We send crane a custom implementation of the http.RoundTripper. This can be found in the helpers pkg package. This implementation updates the progress bar based on the amount of bytes received from the request.

The current code creates a new progress bar before the program starts and on each retry without closing the old one. This always results in at least two progress bars active at the same time which causes the flashing.

[phillebaba]

Are you sure the issue is not that we are not deffering stopping the progress bar before a retry is run? Looking at the current code if the retry is run the old progress bar is never stopped.

[AustinAbro321]

Not stopping the progress bar is part of the issue with the current code, but either way the flashing will happen because we have two progress bars going at the same time. IMO we should just have one progress bar at top level. If there is an error in the request the progress bar won't get updated on that attempt, but will get updated on subsequent attempts.

Here is a video from the current state of this branch where I artificially make an error happen. When an error happens the progress bar still completes. It leaves behind a progress bar on error but that happens no matter what.
Screencast from 09-05-2024 09:10:29 AM.webm

Here is a video from the latest release where I artificially make an error happen. Yes it leaves behind progress bars, but it's also flashing from the start.
Screencast from 09-05-2024 09:06:00 AM.webm

[AustinAbro321]

Ending up changing it to use the progress bar in the inner loop. This is similar to the original change, but should make for a more accurate progress bar when an image push fails and we have to retry

[phillebaba]

LGTM