feat: packfile parsing progress #14
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
johncoder
commented
Mar 18, 2020
johncoder
commented
Mar 18, 2020
johncoder
commented
Mar 19, 2020
| @@ -26,12 +28,30 @@ const ( | |||
|
|
|||
| // UpdateObjectStorage updates the storer with the objects in the given | |||
| // packfile. | |||
| func UpdateObjectStorage(s storer.Storer, packfile io.Reader) error { | |||
| func UpdateObjectStorage(s storer.Storer, packfile io.Reader, pr *progress.Reporter) error { | |||
Comment on lines
+282
to
+284
| if delta { | ||
| p.deltasTotal++ | ||
| } |
There was a problem hiding this comment.
🍜 We count the total of deltas in the packfile here so that we can track progress while resolving them later.
Comment on lines
+288
to
+289
| p.objectsSeen++ | ||
| p.writeObjectProgress() |
There was a problem hiding this comment.
This has proven to be an effective place to count objects we're receiving, but I'm realizing that this may be more of a quick enumeration than actually representative of receiving the objects. Might give this a bit more thought.
Comment on lines
+304
to
+307
| if obj.DiskType.IsDelta() { | ||
| p.deltasSeen++ | ||
| p.writeDeltaProgress() | ||
| } |
There was a problem hiding this comment.
🍜 The key here was that obj.DiskType will indicate that it's a delta, rather than using obj.Type (for reasons I don't really understand).
| } | ||
|
|
||
| // Start begins a background process that will send periodic progress updates | ||
| func (pc *Collector) Start(ctx context.Context) { |
|
|
||
| // AdvanceTime tracks the progress and returns the current rate of bytes being read | ||
| // SEE: https://github.com/git/git/blob/be8661a3286c67a5d4088f4226cbd7f8b76544b0/progress.c#L186-L244 | ||
| func (t *Throughput) AdvanceTime(now int64) uint64 { |
apriendeau
reviewed
Mar 19, 2020
apriendeau
approved these changes
Mar 19, 2020
added 16 commits
March 23, 2020 09:25
First pass of add the ability to provide progress updates while parsing a packfile.
For collecting the progress while enumerating objects/deltas on a packfile as it's being parsed, as well as reporting total bytes processed and the rate of throughput.
Dynamically includes bytes received and rate
This isn't my favorite, but it helps guarantee that the collector will have a progress reporter. Added some more comments for exported things
johncoder
force-pushed
the
feat/packfile-scanner-progress
branch
from
b60a0dd
to
6b34e77
Compare
Pull Request Test Coverage Report for Build 985de556f1c4ed6e96f7675fd0efc7f3ad57e080-PR-14
💛 - Coveralls |
davetakahashi-abstract
approved these changes
Mar 25, 2020
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.
This PR adds the ability for go-git to provide periodic progress updates. In particular, it includes updates for:
Objects and deltas are counted while scanning and parsing packfiles
It borrows heavily from the official git implementation. Some notable points:
The client provides a progress reporter, allowing them to specify the frequency of updates and how often to poll for rate calculations. The progress reporter also has a channel to read progress updates from. After the context is canceled, the consuming code ought to be sure to finish receiving all the updates.
There's also a progress collector that's used to track all the progress data points and is ultimately responsible for sending to the progress channel.
Progress is reported using a progress update struct, and for convenience implements stringer to provide human oriented output intended to closely resemble the output of git.