Skip to content

Populate TransferUtilityDownloadDirectoryResponse with total objects downloaded #4109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: feature/transfermanager
Choose a base branch
from
+20 −1
Open

Populate TransferUtilityDownloadDirectoryResponse with total objects downloaded #4109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions generator/.DevConfigs/c49077d9-90b3-437f-b316-6d8d8833ae73.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"services": [
{
"serviceName": "S3",
"type": "patch",
Copy link

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The dev config specifies this as a "patch" change, but this introduces a new public property (ObjectsDownloaded) on TransferUtilityDownloadDirectoryResponse, which is a new feature. According to CONTRIBUTING.md guidelines, new features should be marked as "minor" rather than "patch".

Additionally, if the public API signatures are updated to return the response object (which would be necessary to make this property accessible), that would also constitute a minor version change as it's a backward-compatible API enhancement.

Copilot generated this review using guidance from repository custom instructions.
"changeLogMessages": [
"Populate TransferUtilityDownloadDirectoryResponse with total objects downloaded"
]
}
]
}
6 changes: 5 additions & 1 deletion sdk/src/Services/S3/Custom/Transfer/Internal/_bcl+netstandard/DownloadDirectoryCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,16 @@ await asyncThrottler.WaitAsync(cancellationToken)
var command = new DownloadCommand(this._s3Client, downloadRequest);

var task = ExecuteCommandAsync(command, internalCts, asyncThrottler);

pendingTasks.Add(task);
}
await WhenAllOrFirstExceptionAsync(pendingTasks, cancellationToken)
.ConfigureAwait(continueOnCapturedContext: false);

return new TransferUtilityDownloadDirectoryResponse();
return new TransferUtilityDownloadDirectoryResponse
{
ObjectsDownloaded = _numberOfFilesDownloaded
Copy link
Contributor Author

@GarrettBeatty GarrettBeatty Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

_numberOfFilesDownloaded is an existing value that gets updated in the download progress callback

aws-sdk-net/sdk/src/Services/S3/Custom/Transfer/Internal/DownloadDirectoryCommand.cs

Line 61 in 7d4200a

int numberOfFilesDownloaded = _numberOfFilesDownloaded;

};
}
finally
{
Expand Down
4 changes: 4 additions & 0 deletions sdk/src/Services/S3/Custom/Transfer/TransferUtilityDownloadDirectoryResponse.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,9 @@ namespace Amazon.S3.Transfer
/// </summary>
public class TransferUtilityDownloadDirectoryResponse
{
/// <summary>
/// The number of objects that have been downloaded
/// </summary>
public long ObjectsDownloaded { get; set; }
Comment on lines +25 to +28
Copy link

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ObjectsDownloaded property is not accessible to API consumers because the public DownloadDirectoryAsync and DownloadDirectory methods do not return the response object. The internal command returns TransferUtilityDownloadDirectoryResponse, but the public API methods have return type Task (async) or void (sync), discarding the response.

To make this property useful, the public API signatures should be updated to return Task<TransferUtilityDownloadDirectoryResponse> and TransferUtilityDownloadDirectoryResponse respectively. If this is planned for a future change, consider documenting this as work-in-progress. If the API signature cannot be changed due to backward compatibility, consider an alternative mechanism to expose this information.

Copilot generated this review using guidance from repository custom instructions.
Copy link
Contributor Author

@GarrettBeatty GarrettBeatty Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will be done in future pr

}
}