cache content length

Author: GarrettBeatty

sdk/src/Services/S3/Custom/Transfer/Internal/SimpleUploadCommand.cs

@@ -42,12 +42,17 @@ internal partial class SimpleUploadCommand : BaseCommand
         TransferUtilityConfig _config;
         TransferUtilityUploadRequest _fileTransporterRequest;
         long _totalTransferredBytes;
+        private readonly long _cachedContentLength;
 
         internal SimpleUploadCommand(IAmazonS3 s3Client, TransferUtilityConfig config, TransferUtilityUploadRequest fileTransporterRequest)
         {
             this._s3Client = s3Client;
             this._config = config;
             this._fileTransporterRequest = fileTransporterRequest;
+            
+            // Cache content length immediately while stream is accessible to avoid ObjectDisposedException in failure scenarios
+            this._cachedContentLength = this._fileTransporterRequest.ContentLength;
+            
             var fileName = fileTransporterRequest.FilePath;
         }
 
@@ -107,7 +112,7 @@ private void PutObjectProgressEventCallback(object sender, UploadProgressArgs e)
             // Keep track of the total transferred bytes so that we can also return this value in case of failure
             long transferredBytes = Interlocked.Add(ref _totalTransferredBytes, e.IncrementTransferred - e.CompensationForRetry);
 
-            var progressArgs = new UploadProgressArgs(e.IncrementTransferred, transferredBytes, e.TotalBytes, 
+            var progressArgs = new UploadProgressArgs(e.IncrementTransferred, transferredBytes, _cachedContentLength, 
                 e.CompensationForRetry, _fileTransporterRequest.FilePath, _fileTransporterRequest);
             this._fileTransporterRequest.OnRaiseProgressEvent(progressArgs);
         }
@@ -117,7 +122,7 @@ private void FireTransferInitiatedEvent()
             var initiatedArgs = new UploadInitiatedEventArgs(
                 request: _fileTransporterRequest,
                 filePath: _fileTransporterRequest.FilePath,
-                totalBytes: _fileTransporterRequest.ContentLength
+                totalBytes: _cachedContentLength
             );
 
             _fileTransporterRequest.OnRaiseTransferInitiatedEvent(initiatedArgs);
@@ -130,7 +135,7 @@ private void FireTransferCompletedEvent(TransferUtilityUploadResponse response)
                 response: response,
                 filePath: _fileTransporterRequest.FilePath,
                 transferredBytes: Interlocked.Read(ref _totalTransferredBytes),
-                totalBytes: _fileTransporterRequest.ContentLength
+                totalBytes: _cachedContentLength
             );
 
             _fileTransporterRequest.OnRaiseTransferCompletedEvent(completedArgs);
@@ -142,7 +147,7 @@ private void FireTransferFailedEvent()
                 request: _fileTransporterRequest,
                 filePath: _fileTransporterRequest.FilePath,
                 transferredBytes: Interlocked.Read(ref _totalTransferredBytes),
-                totalBytes: _fileTransporterRequest.ContentLength
+                totalBytes: _cachedContentLength
             );
 
             _fileTransporterRequest.OnRaiseTransferFailedEvent(failedArgs);

sdk/test/Services/S3/IntegrationTests/TransferUtilityTests.cs

@@ -30,6 +30,8 @@ public class TransferUtilityTests : TestBase<AmazonS3Client>
         private static string fullPath;
         private const string testContent = "This is the content body!";
         private const string testFile = "PutObjectFile.txt";
+        private static string testFilePath;
+        private const string testKey = "SimpleUploadProgressTotalBytesTestFile.txt";
 
         [ClassInitialize()]
         public static void ClassInitialize(TestContext a)
@@ -66,6 +68,7 @@ public static void ClassInitialize(TestContext a)
 
             fullPath = Path.GetFullPath(testFile);
             File.WriteAllText(fullPath, testContent);
+            testFilePath = fullPath; // Use the same file for the TotalBytes test
         }
 
         [ClassCleanup]
@@ -444,41 +447,36 @@ public void UploadUnSeekableStreamFileSizeEqualToPartBufferSize()
         }
 
         [TestMethod]
-        [TestCategory("S3")]
-        public void UploadUnseekableStreamFileSizeBetweenMinPartSizeAndPartBufferSize()
+        public void SimpleUploadProgressTotalBytesTest()
         {
-            var client = Client;
-            var fileName = UtilityMethods.GenerateName(@"SimpleUploadTest\BetweenMinPartSizeAndPartBufferSize");
-            var path = Path.Combine(BasePath, fileName);
-            // there was a bug where the transfer utility was uploading 13MB file
-            // when the file size was between 5MB and (5MB + 8192). 8192 is the s3Client.Config.BufferSize
-            var fileSize = 5 * MEG_SIZE + 1;
-
-            UtilityMethods.GenerateFile(path, fileSize);
-            //take the generated file and turn it into an unseekable stream
-
-            var stream = GenerateUnseekableStreamFromFile(path);
-            using (var tu = new Amazon.S3.Transfer.TransferUtility(client))
+            var transferConfig = new TransferUtilityConfig()
             {
-                tu.Upload(stream, bucketName, fileName);
+                MinSizeBeforePartUpload = 20 * MEG_SIZE,
+            };
 
-                var metadata = Client.GetObjectMetadata(new GetObjectMetadataRequest
+            var progressValidator = new TransferProgressValidator<UploadProgressArgs>
+            {
+                Validate = (progress) =>
                 {
-                    BucketName = bucketName,
-                    Key = fileName
-                });
-                Assert.AreEqual(fileSize, metadata.ContentLength);
+                    Assert.IsTrue(progress.TotalBytes > 0, "TotalBytes should be greater than 0");
+                    Assert.AreEqual(testContent.Length, progress.TotalBytes, "TotalBytes should equal file length");
+                }
+            };
 
-                //Download the file and validate content of downloaded file is equal.
-                var downloadPath = path + ".download";
-                var downloadRequest = new TransferUtilityDownloadRequest
+            using (var fileTransferUtility = new TransferUtility(Client, transferConfig))
+            {
+                var request = new TransferUtilityUploadRequest()
                 {
                     BucketName = bucketName,
-                    Key = fileName,
-                    FilePath = downloadPath
+                    FilePath = testFilePath,
+                    Key = testKey
                 };
-                tu.Download(downloadRequest);
-                UtilityMethods.CompareFiles(path, downloadPath);
+
+                request.UploadProgressEvent += progressValidator.OnProgressEvent;
+
+                fileTransferUtility.Upload(request);
+
+                progressValidator.AssertOnCompletion();
             }
         }