Add progress indicator to repository check loop

[mr-raj12]

The Repository.check() method in src/borg/repository.py (line 319) has an existing TODO comment for a progress indicator, but it has not been implemented.

For large repositories, the repository check loop iterates over all data objects, loading and verifying checksums for each one. This can take many hours with no user-visible progress output - only a raw key checkpoint is logged every 5 minutes (line 390-392).

ProgressIndicatorPercent is already used in several other places in the codebase (compact_cmd.py, archive.py, analyze_cmd.py), so the pattern is well established.

Proposed change

Add a ProgressIndicatorPercent to the check() loop in Repository, showing the user a percentage/count as objects are verified. The total object count could be obtained via store.list() or a pre-count step.

Related

• # TODO: progress indicator, ... at src/borg/repository.py:319
• Unable to distinguish if borg is working as intended or has frozen #8996 - user unable to distinguish a working check from a frozen process
• Progress of Remote: checking segment file /whatever/data/17/17078... #8009 - similar request for segment check progress (borg 1.x)

[ThomasWaldmann]

As we have lots of small objects in the store, a full store.list() operation can take a very long time, especially for slow repos, like cloud repos.

So, if we want to fix that now (and not after packs are implemented), maybe rather a progress indication that just shows progress (but not a percentage or ETA or n/N).

[sagar-h007]

Hi @ThomasWaldmann , I’d like to work on this.

Instead of doing a full store.list() to compute a percentage (which could be slow for large or remote repositories), I plan to add a simple progress indicator in the Repository.check() loop that shows ongoing progress, such as the number of objects processed.

I’ll follow the existing progress indicator patterns used in compact_cmd.py, archive.py, and analyze_cmd.py.

[ThomasWaldmann]

Sounds good. If you are quick, it might still get into beta 21 (see milestones).

[mr-raj12]

@sagar-h007, Thanks to tackle this so quickly! Please feel free to raise the PR once it's up by this week or else i'll would love to complete this out!