Progress Tracker for MultipartUploader & MultipartCopy #2699
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
The strings in the return statement were over the 80 char limit
(1) Set progressThresholds[0] so that I could use array_combine on equal sized arrays (2) I redefined progressBar in setProgressThresholds after the threshold bar is created. progressBar includes the thresholds as keys and the bar as values (3) Removed the array_shift in the construct and now that logic is done by displayProgress (4) Changed assertCount to check for 9 elements instead of 8
(1) testFailedUploadPrintsPartialProgressBar - upload fails at 25% then throws exception (2) testSetProgressThresholdsThrowsException - checks non-ints (3) testDisplayProgressThrowsException - checks non-ints
- If config option is true, the total size is sent to upload state and a threshold array is created. DisplayProgress now relies on there being a threshold array, if there is no threshold array (if config = no), nothing prints. - the progress bar for multipart copy prints halfway for some reason, but the item is still copied (i'll fix this in the next commit)
progressBar and progressThresholds are no longer combined, so that array_key_first could be removed. progressThresholds[0] and array_shift are now used instead.
SamRemis
approved these changes
Jun 7, 2023
stobrien89
approved these changes
Jun 7, 2023
SamRemis
reviewed
Jun 7, 2023
stobrien89
reviewed
Jun 9, 2023
src/Multipart/UploadState.php
Outdated
| public function getDisplayProgress($totalUploaded) | ||
| { | ||
| if (!is_numeric($totalUploaded)) { | ||
| throw new \InvalidArgumentException('The size of the bytes being uploaded must be a number.'); |
There was a problem hiding this comment.
Let's do a line-wrap on this like:
throw new \InvalidArgumentException(
'The size of the bytes being uploaded must be a number.'
);
stobrien89
requested changes
Jun 9, 2023
Codecov Report
@@ Coverage Diff @@
## master #2699 +/- ##
============================================
- Coverage 92.42% 90.16% -2.26%
- Complexity 4453 4605 +152
============================================
Files 234 252 +18
Lines 11729 14167 +2438
============================================
+ Hits 10840 12774 +1934
- Misses 889 1393 +504
|
stobrien89
requested changes
Jun 23, 2023
SamRemis
reviewed
Jun 26, 2023
src/Multipart/UploadState.php
Outdated
| public function setDisplayProgress($totalSize) | ||
| { | ||
| $this->setProgressThresholds($totalSize); | ||
| $this->displayProgress = true; |
There was a problem hiding this comment.
Why is this set here? If we have made it to this function, shouldn't it already be set?
stobrien89
force-pushed
the
new-feature
branch
2 times, most recently
from
3cf2918 to
f866568
Compare
stobrien89
force-pushed
the
new-feature
branch
2 times, most recently
from
fbec615 to
66c0f96
Compare
stobrien89
force-pushed
the
new-feature
branch
from
66c0f96 to
362ae07
Compare
yenfryherrerafeliz
requested changes
Nov 22, 2024
| ); | ||
| } | ||
|
|
||
| if ($this->displayProgress) { |
There was a problem hiding this comment.
Maybe this condition should be the first one in this method by using the early return approach. For example:
public function getDisplayProgress($totalUploaded): void
{
if (!$this->displayProgress) {
return;
}
...
}There was a problem hiding this comment.
I think we should reject invalid input before returning early, which leaves us in a position where I don't think changing this benefits us.
stobrien89
force-pushed
the
new-feature
branch
from
362ae07 to
332e6be
Compare
stobrien89
approved these changes
Jan 8, 2025
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.
Issue #, if available:
Description of changes:
'track_upload' config option added to MultipartUploader and MultipartCopy, which allows for tracking the progress of uploads in 1/8th increments.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.