Provide feedback on containerization progress.

[coollog]

This issue tracks the tasks needed to implement the progress feedback system intended to address issues #1251 and #806.

(# represents the estimated amount of work)

Design:

• (5) Proposal Proposal: Provide feedback on push progress. #1262

Core system:

• (2) Add Progress.Allocation class to represent the decentralized allocation tree Adds progress Allocation to represent Decentralized Allocation Tree node. #1298
• (1) Add Progress.Event class to represent a JibEvent indicating progress on some Progress.Allocation Adds ProgressEvent. #1305
• (5) Add ProgressEventHandler for handling Progress.Events and managing an overall progress amount Adds ProgressEventHandler. #1309

Integration:

• (1) Change StepsRunner to be more of a builder to prepare for assigning Allocations Change StepsRunner to be more of a builder to prepare for assigning Allocations. #1312
• (4) Assign Progress.Allocation to each builder step Assigns Allocation to each builder step. #1321
• (4) Change RegistryClient push and pull to take callback to listen on the progress of the push/pull Change RegistryClient push/pull to take callback to listen on progress. #1323
  • (3) Add ListenableCountingOutputStream to count sent/received bytes Adds ListenableCountingOutputStream. #1300
• (3) Add ProgressEventDispatcher to dispatch ProgressEvents efficiently Adds ProgressEventDispatcher to replace manual Allocation management. #1330
• (2) Emit progress of push/pull as ProgressEvents Emits progress of push/pull as ProgressEvents. #1334
• (3) Add integration test(s) to make sure progress reaches 100% after each of the builds Checks progress is 1.0 in build integration tests. #1339

Display:

• (3) Add AnsiLoggerWithFooter to be able to keep a footer for where progress indication will go Adds SingleThreadedLogger to be able to keep a footer for where progress indication will go. #1326
• (3) Add ProgressDisplayGenerator to generate the displayed text for progress feedback Adds ProgressDisplayGenerator. #1333
• (2) Add AnsiLoggerWithFooter to Maven/Gradle Adds AnsiLoggerWithFooter to Maven/Gradle plugins. #1341
• (2) Change LogEventHandler to use AnsiLoggerWithFooter Adds AnsiLoggerWithFooter to Maven/Gradle plugins. #1341
• (3) Add ability to switch on/off the old logging and the footer Disables progress footer by default or if console is null. #1344
• (2) Change ProgressEventHandler to provide the callback with updates Changes ProgressEventHandler to provide the callback with updates. #1343
• (1) Attach ProgressEventHandler as an event handler via the plugins Attachs ProgressEventHandler as an event handler via the plugins. #1350
• (1) Change jib.showProgress to true by default Adds 'jib.console' system property to disable progress bar if set to 'plain'. #1354

Cleanup:

• Refactor progress callbacks in RegistryClient classes Emits progress of push/pull as ProgressEvents. #1334
• (2) Improve AnsiLoggerWithFooter logic Improves the logic of AnsiLoggerWithFooter. #1340
• Have AllocationCompletionTracker only give back unfinished leaf allocations - Progress feedback cleanup: unfinished allocation management #1356
• See if it's cleaner to have ProgressLogger track the unfinished allocations - Progress feedback cleanup: unfinished allocation management #1356
• Reword the task descriptions Rewords task progress descriptions. #1351
• Refactor out ProjectProperties#waitForLoggingThread and ProjectProperties#getEventHandlers- Progress feedback cleanup: Refactor out ProjectProperties#waitForLoggingThread and ProjectProperties#getEventHandlers #1358

POC code is in https://github.com/GoogleContainerTools/jib/tree/progress-monitor-poc.

Integrations to check (please assign yourself by adding your name after the item):

• Skaffold output
• IntelliJ console
• Eclipse console
• Windows

[loosebazooka]

Can we add some items to check how this works with skaffold/ides (you can assign them to people) and to have a default non-tty progress option (or NoOp)