feat: s3 transfer manager v2 #3079
Open
Conversation
This file contains hidden or 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
This is an initial phase for the s3 transfer manager v2, which includes: - Progress Tracker with a default Console Progres Bar. - Dedicated Multipart Download Listener for listen to events specificly to multipart download. - Generic Transfer Listener that will be used in either a multipart upload or a multipart download. The progress tracker is dependant on the Generic Transfer Listener, and when enabled it uses the same parameter to be provided as the progress tracker. This is important because if there is a need for listening to transfer specific events and also track the progress then, a custom implementation must be done that incorporate those two needs together, otherwise one of each other must be used. - Single Object Download - Multipart Objet Download This initial implementation misses the test cases.
- Refactor set a single argument, even when not exists, in the console progress bar. - Add a specific parameter for showing the progress rendering defaulted to STDOUT. - Add test cases for ConsoleProgressBar. - Add test cases for DefaultProgressTracker. - Add test cases for ObjectProgressTracker. - Add test cases for TransferListener.
- Add test cases for multipart download listener.
- Add a trait to the MultipartDownloader implementation to keep the main implementatio cleaner. - Add test cases for multipart downloader, in specific testing part and range get multipart downloader.
stobrien89
requested changes
Feb 13, 2025
Member
stobrien89
left a comment
stobrien89
left a comment
There was a problem hiding this comment.
Looking good on the first pass- there are some nits like function braces needing newlines, new files needing newlines, naming conventions, etc. also had some questions about design
Refactor: - Moves opening braces into a new line. - Make requestArgs an optional argument. - Remove unnecessary traits. - Use traditional declarations. Adds: - Download directory feature.
Refactor: - Add a message placeholder for progress status. For example in case of errors. Adds: - Upload feature, missing multipart functionality.
- Add upload directory feature
- Add a dedicated multipart upload implementation - Add transfer progress to multipart upload - Add upload directory with the required options. - Create specific response models for upload, and upload directory. - Add multipart upload test cases. - Fix transfer listener completation eval.
Short namespace from `Aws\S3\Features\S3Transfer` to `Aws\S3\S3Transfer`.
stobrien89
requested changes
Feb 19, 2025
Member
stobrien89
left a comment
stobrien89
left a comment
There was a problem hiding this comment.
A few more comments- I think a few from the last round were left addressed also. I'd do another check for function opening braces (needing to be moved to a new line) and new files that are missing a newline at the end. More test classes needed as well but I'm assuming those are on the way
- Implement progress tracker based on SEP spec. - Add a default progress bar implementation. - Add different progress tracker formats: -- Plain progress format: [|progress_bar|] |percent|% -- Transfer progress format: [|progress_bar|] |percent|% |transferred|/|tobe_transferred| |unit| -- Colored progress format: |object_name|:\n\033|color_code|[|progress_bar|] |percent|% |transferred|/|tobe_transferred| |unit| |message|\033[0m - Add a default single progress tracker implementation. - Add a default multi progress tracker implementation for tracking directory transfers. - Include tests unit just for console progress bar.
- Fixes current test cases for: - MultipartUploader - MultipartDownloader - ProgressTracker
- Remove progress bar color enum since the colors were moved into the specific format that requires them.
TransferListener must be tested from the implementations that extends and use this abstract class.
Add nullable type to listenerNotifier property in the MultipartUploader implementation.
- Tests for MultiProgressTracker - Tests for SingleProgressTracker - Tests for ProgressBarFormat - Tests for TransferProgressSnapshot - Tests for TransferListenerNotifier
stobrien89
requested changes
Feb 27, 2025
Member
stobrien89
left a comment
stobrien89
left a comment
There was a problem hiding this comment.
Looking better- still needing some more unit tests, along with integ tests. Left some comments and nits on formatting. It seems each new file is missing a newline so I'd check those as well
- Refactor code to address some styling related feedback. - Add upload and uploadDirectory unit tests.
- Fix MultipartUpload tests by increasing the part size from 1024 to 10240000 so it gets between the allowed part size range 5MB-5GBs. - Rename tobe to to_be in the progress formatting.
- Add download tests - Add download directory tests - Minor naming refactor
stobrien89
requested changes
Apr 1, 2025
Member
stobrien89
left a comment
stobrien89
left a comment
There was a problem hiding this comment.
Looking good. Just a few nits this time around. Still needing integ tests- will do another round of reviews once those are up.
src/S3/S3Transfer/Progress/ColoredTransferProgressBarFormat.php
Outdated
Show resolved
Hide resolved
src/S3/S3Transfer/Progress/ColoredTransferProgressBarFormat.php
Outdated
Show resolved
Hide resolved
- Add upload integ tests for: - Single uploads - Multipart uploads - Checksum in single uploads - Checksum in multipart uploads - Add download integ tests for: - Single downloads - Multipart downloads
- Add integ tests for directory uploads - Add integ tests for directory downloads
stobrien89
requested changes
May 21, 2025
Member
stobrien89
left a comment
stobrien89
left a comment
There was a problem hiding this comment.
Mostly nits, but the most important requests are: adding upload() and download() methods on the uploader and downloader classes that call promise() (similar to the old implementation)and testing the resolvesOutsideTargetDirectory logic.
I would do an audit of hard-coded values that can be moved to classes, line length (max 85 char) and all new files that do not end with a newline.
- Move some fixed values out of the methods into consts. - Address a line exceeded 80 chars. - Declare keys used across different implementations as consts.
- Fix keys declaration in TransferListener.php - Make use of DIRECTORY_SEPARATOR const instead of hardcoding `/`
- Some implementations using TransferListener were missing the import statement.
- Remove full object checksum calculate since it is not recommended. - Address some styling issues.
- Make some statements multilines. - Add comments describing functionality.
- Fixes exceptions must be returned and not thrown from upload and download directory. - Returns how many objects were transferred and failed from upload or download directory operations when there are failures. - Handles circular folder traversal when following symbolic links. - Add max_concurrency config for upload and download directory APIs. - Remove s3_delimiter config parameter from download directory API. - Add modeled test cases runner for upload and download directory operations.
stobrien89
requested changes
Oct 4, 2025
- Avoid allocating memory for each part to be uploaded, instead its read from the file by creating a new file handle that reads from that specific offset from the file. - Improves config validation in S3TransferManager - Renamed MultipartDownloader to AbstractMultipartDownloader
- Add integ tests for multipart upload along with custom checksum algorithm - Add integ tests for multipart upload along with custom checksum - Propagate the request arguments for the part request command instead of the general request args. - Remove custom assertion method for cases where messages are not in order equally, and instead modified the fixtures so it match what is thrown.
stobrien89
requested changes
Oct 20, 2025
stobrien89
requested changes
Nov 3, 2025
- Move checksum validation off of AbstractMultipartUploader. - Make createMultipartOperation and completeMultipartOperation abstract methods since MultipartUploader requires some checksum validations that are not necessarily usefull in the abstract class. Also, there is not need to leave a default implementation that will be only used for MultipartCopy implementation. Abstract class should be used just for shared code. - Move abstract method declarations to the top.
stobrien89
requested changes
Nov 11, 2025
Member
stobrien89
left a comment
stobrien89
left a comment
There was a problem hiding this comment.
Looking solid, just some file naming conventions and making classes final where possible
- Fix integration testing - Full object checksum just support crc family algos. - When objects are uploaded using full object checksum then if we need to validate that checksum we could use getObjectAttributes and get the checksum information. Otherwise we are not able to validate by passing ChecksumMode ENABLED in a getObject operation. - Make implementation final.
- Add Abstract prefix to abstract classes.
Contributor
Author
|
- Add a rewind condition in the download handlers in case other processes consumed the stream previous to writing to its final destination.
stobrien89
requested changes
Nov 17, 2025
Member
stobrien89
left a comment
stobrien89
left a comment
There was a problem hiding this comment.
Two small things: one we've already discussed
| ); | ||
|
|
||
| if (!empty($this->uploadId)) { | ||
| error_log( |
Member
There was a problem hiding this comment.
We discussed already, but better idea to change this to trigger_error(), standard practice for us and avoids dealing with stuff like this in test runs:
...................................................................... 70
...................................................................... 140
...................................................................... 210
...................................................................... 280
.......................Multipart Upload with id: K.YJRjtJpTvucA1GdmHgGShwQe5mSeDzBOIKWAAnhBVAZQGhzHoZwK4xgtbaoSV6cZWafSzCLA25EKUpgctr9sY1XEOjKI9LyrYZpyRlWWgLz7Dpq20BJF3ZsIdKwuHSrW9WSlMlSr85VchGHh.QDw-- failed
...Multipart Upload with id: 09eT7_7spxNHSEp8lDBmlr2fHM3PQhhAQQDu1w9EihCV.HaCFT3MLDuBEVwusniVvyeB3oTqHf9Eckzq4FzvNNuFQFFI82MJug26opNgwL_.Ergqg91JdL3VPHavJDwOApsN5yM8o9J9wslelj4cNQ-- failed
............................................ 350
..........................................
Will just need to suppress calls in tests where that might interfere with test expectations
- Supress warning when running integ tests for aborting multipart uploads - Added return type as bool for bytesTransfer in AbstractTransferListener. This is needed for when we integrate the resume uploads/downloads feature. - Remove white spaces in AbstractMultipartDownloder constructor
stobrien89
requested changes
Nov 17, 2025
Member
stobrien89
left a comment
stobrien89
left a comment
There was a problem hiding this comment.
Just one comment, but seeing some unit test failures and some consistent integ test failures. Not sure if the latter is just something in my environment or not
Comment on lines
+669
to
+671
| // Disable warning from error_log | ||
| $currentLogIni = ini_get('error_log'); | ||
| ini_set('error_log', '0'); |
Member
There was a problem hiding this comment.
Modifying global ini settings in tests is an anti-pattern - we should try to avoid this. See previous comment about using trigger_error() to avoid this entirely
stobrien89
reviewed
Nov 18, 2025
- Add return statement to listeners used in tests for byteTransferred event.
- Avoid using a default region when using the default S3 Client in S3 Transfer Manager. When a region is not provided and the default client is tried to be used then an exception will be thrown.
Pass the default region if provided in the config, otherwise default it to null.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description of changes:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.