refactor: Remove obsolete code in ChecksumUtils and update S3 marshallers

Author: dscpinheiro

sdk/src/Core/Amazon.Runtime/Internal/Util/ChecksumUtils.cs

@@ -63,31 +63,6 @@ internal static string GetChecksumHeaderKey(CoreChecksumAlgorithm checksumAlgori
             return $"{_checksumHeaderPrefix}{checksumAlgorithm.ToString().ToLower()}";
         }
 
-        /// <remarks> 
-        /// Note, this was called directly from service packages prior to compression support
-        /// being added shortly after 3.7.200. It's important to preserve the signature and functionality
-        /// until the next minor version for those older 3.7.* service packages.
-        /// </remarks>
-        /// <summary>
-        /// Attempts to select and then calculate the checksum for a request
-        /// </summary>
-        /// <param name="request">Request to calculate the checksum for</param>
-        /// <param name="checksumAlgorithm">Checksum algorithm to use, specified on the request using a service-specific enum</param>
-        /// <param name="fallbackToMD5">If checksumAlgorithm is <see cref="CoreChecksumAlgorithm.NONE"/>, this flag controls whether or not to fallback to using a MD5 to generate a checksum</param>
-        [Obsolete("This method is deprecated in favor of SetRequestChecksumV2")]
-        public static void SetRequestChecksum(IRequest request, string checksumAlgorithm, bool fallbackToMD5 = true)
-        {
-            // TODO: As mentioned in the remarks section, this method used to be called from the marshallers in older service packages.
-            // It's not used anymore from Core (which uses "SetRequestChecksumV2" instead), and should be removed in V4.
-            if (request.ChecksumData == null)
-            {
-                SetChecksumData(request, checksumAlgorithm, fallbackToMD5);
-                return;
-            }
-
-            SetRequestChecksumV2(request, clientConfig: null);
-        }
-
         /// <summary>
         /// Attempts to select and then calculate the checksum for a request.
         /// </summary>
@@ -314,40 +289,6 @@ private static CoreChecksumAlgorithm ConvertToCoreChecksumAlgorithm(string selec
             return selectedCoreChecksumAlgorithm;
         }
 
-        /// <summary>
-        /// Set checksum data in marshaller after compressing request payload.
-        /// </summary>
-        /// <param name="request">Request to calculate the checksum for</param>
-        /// <param name="checksumAlgorithm">Checksum algorithm to use, specified on the request using a service-specific enum</param>
-        /// <param name="fallbackToMD5">This flag controls whether or not to fallback to using a MD5 to generate a checksum</param>
-        [Obsolete("This overload is deprecated in favor of the options that accept whether the checksum is required for the given request")]
-        public static void SetChecksumData(IRequest request, string checksumAlgorithm, bool fallbackToMD5 = true)
-        {
-            // This overload will only be invoked from older service packages (i.e. not updated for the latest flexible checksums specification).
-            // We need to maintain the previous behavior (of only setting a checksum if provided) to account for edge cases in multipart uploads (S3 was
-            // the only service using the checksum trait in the initial revision of the specification).
-
-            // The specific scenario we're concerned about is:
-            // - Customer is using multiple SDK packages
-            // - Customer updates one of their dependencies (let's say SQS), which brings the latest version of Core as well
-            // - Previous version of S3 will still compile successfully since it specifies "AWSSDK.Core(>= 3.7.x && < 4.0.0)" as a dependency
-            // - Large object is uploaded using the TransferUtility, and setting the checksum automatically for the individual parts will
-            // cause the CompleteMPU call to fail (as our SDK will add the part checksums via CompleteMultipartUploadRequest.AddPartETags - which
-            // S3 does not support).
-
-            // TODO: Similar to "SetRequestChecksum", this method should be removed in V4.
-            if (!string.IsNullOrEmpty(checksumAlgorithm))
-            {
-                SetChecksumData(request, checksumAlgorithm, fallbackToMD5, isRequestChecksumRequired: true);
-            }
-            else
-            {
-                // Important: We can't set ChecksumData to null as previous versions of the S3 package assume it'll be present.
-                // The SkipChecksum flag is then used in the pipeline handler to determine whether the calculation should be performed.
-                request.ChecksumData = new ChecksumData { SkipChecksum = true };
-            }
-        }
-
         /// <summary>
         /// Set checksum data in marshaller after compressing request payload.
         /// </summary>
@@ -414,14 +355,6 @@ public class ChecksumData
         /// </summary>
         public string HeaderName { get; set; }
 
-        /// <summary>
-        /// TODO: This property is only used to handle the mismatch of older service packages and newer Core.
-        /// It should also be removed in V4 (same comment applies to the internal parameterless constructor) .
-        /// </summary>
-        internal bool SkipChecksum { get; set; }
-
-        internal ChecksumData() { }
-
         public ChecksumData(string selectedChecksum, bool MD5Checksum, bool? fallbackToMD5, bool isRequestChecksumRequired, string headerName)
         {
             this.SelectedChecksum = selectedChecksum;

sdk/src/Core/Amazon.Runtime/Pipeline/Handlers/ChecksumHandler.cs

@@ -73,46 +73,13 @@ protected virtual void PreInvoke(IExecutionContext executionContext)
                 return;
             }
 
-            if (ShouldSkipChecksum(request, clientConfig))
-            {
-                return;
-            }
-
-            ChecksumUtils.SetRequestChecksumV2(request, clientConfig);
-        }
-
-        private bool ShouldSkipChecksum(IRequest request, IClientConfig clientConfig)
-        {
-            if (request.ChecksumData.SkipChecksum)
-            {
-                return true;
-            }
-
             // Do not attempt to set checksum when using SigV2 (only applicable to S3).
             if (clientConfig.SignatureVersion == "2")
             {
-                return true;
-            }
-
-            // This is a workaround for mismatches between older S3 packages and newer Core (and more specifically for S3 Express and multi-part
-            // uploads). The service package would attempt to override the checksum for directory buckets, but the approach used would cause Core (which
-            // is following the flexible checksum specification) to calculate a checksum for the InitiateMPU / CreateMPU operations.
-            // TODO: This should be removed in V4 (the only component of this method that should remain is the signature version check)
-            if (clientConfig.ServiceId.Equals("S3", StringComparison.OrdinalIgnoreCase))
-            {
-                var isMPURequest =
-                    request.RequestName.Equals("InitiateMultipartUploadRequest", StringComparison.OrdinalIgnoreCase) ||
-                    request.RequestName.Equals("CompleteMultipartUploadRequest", StringComparison.OrdinalIgnoreCase);
-                var isS3ExpressRequest =
-                    request.EndpointAttributes["backend"] != null && (string)request.EndpointAttributes["backend"] == "S3Express";
-
-                if (isMPURequest && isS3ExpressRequest)
-                {
-                    return true;
-                }
+                return;
             }
 
-            return false;
+            ChecksumUtils.SetRequestChecksumV2(request, clientConfig);
         }
     }
 }

sdk/src/Services/S3/Custom/Model/GetObjectMetadataResponse.cs

@@ -60,12 +60,6 @@ public class GetObjectMetadataResponse : AmazonWebServiceResponse
         private string _checksumSHA256;
         private ChecksumType _checksumType;
 
-        /// <summary>
-        /// Flag which returns true if the Expires property has been unmarshalled
-        /// from the raw value or set by user code.
-        /// </summary>
-        private bool isExpiresUnmarshalled;
-
         /// <summary>
         /// The date and time at which the object is no longer cacheable.
         /// </summary>

sdk/src/Services/S3/Custom/Model/Internal/MarshallTransformations/PutBucketACLRequestMarshaller.cs

@@ -169,9 +169,14 @@ public IRequest Marshall(PutBucketAclRequest publicRequest)
                 string content = stringWriter.ToString();
                 request.Content = Encoding.UTF8.GetBytes(content);
                 request.Headers[HeaderKeys.ContentTypeHeader] = "application/xml";
-                if (publicRequest.IsSetContentMD5())
-                    request.Headers[Amazon.Util.HeaderKeys.ContentMD5Header] = publicRequest.ContentMD5;
-                ChecksumUtils.SetChecksumData(request, publicRequest.ChecksumAlgorithm);
+
+                ChecksumUtils.SetChecksumData(
+                    request,
+                    publicRequest.ChecksumAlgorithm,
+                    fallbackToMD5: false,
+                    isRequestChecksumRequired: true,
+                    headerName: S3Constants.AmzHeaderSdkChecksumAlgorithm
+                );
             }
             catch (EncoderFallbackException e)
             {

sdk/src/Services/S3/Custom/Model/Internal/MarshallTransformations/PutObjectACLRequestMarshaller.cs

@@ -177,10 +177,14 @@ public IRequest Marshall(PutObjectAclRequest publicRequest)
                 string content = stringWriter.ToString();
                 request.Content = System.Text.Encoding.UTF8.GetBytes(content);
                 request.Headers["Content-Type"] = "application/xml";
-                if (publicRequest.IsSetContentMD5())
-                    request.Headers[Amazon.Util.HeaderKeys.ContentMD5Header] = publicRequest.ContentMD5;
-                ChecksumUtils.SetChecksumData(request, publicRequest.ChecksumAlgorithm, fallbackToMD5: true);
-                request.Headers[Amazon.Util.HeaderKeys.XAmzApiVersion] = "2006-03-01";
+
+                ChecksumUtils.SetChecksumData(
+                    request,
+                    publicRequest.ChecksumAlgorithm,
+                    fallbackToMD5: false,
+                    isRequestChecksumRequired: true,
+                    headerName: S3Constants.AmzHeaderSdkChecksumAlgorithm
+                );
             }
             catch (EncoderFallbackException e)
             {