Making UnmodifiableMapOfLists serializable since it's a component of serializable classes such as AwsErrorDetails (#2768)

Author: cenedhryn

.changes/next-release/bugfix-AWSSDKforJavav2-b04c802.json

@@ -0,0 +1,6 @@
+{
+    "category": "AWS SDK for Java v2", 
+    "contributor": "", 
+    "type": "bugfix", 
+    "description": "Allow AwsErrorDetails to be serialized using Java serialization"
+}

core/aws-core/src/main/java/software/amazon/awssdk/awscore/exception/AwsErrorDetails.java

@@ -16,6 +16,7 @@
 package software.amazon.awssdk.awscore.exception;
 
 import java.io.Serializable;
+import java.util.Objects;
 import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.core.SdkBytes;
 import software.amazon.awssdk.http.SdkHttpResponse;
@@ -102,6 +103,32 @@ public static Class<? extends Builder> serializableBuilderClass() {
         return BuilderImpl.class;
     }
 
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        AwsErrorDetails that = (AwsErrorDetails) o;
+        return Objects.equals(errorMessage, that.errorMessage) &&
+               Objects.equals(errorCode, that.errorCode) &&
+               Objects.equals(serviceName, that.serviceName) &&
+               Objects.equals(sdkHttpResponse, that.sdkHttpResponse) &&
+               Objects.equals(rawResponse, that.rawResponse);
+    }
+
+    @Override
+    public int hashCode() {
+        int result = Objects.hashCode(errorMessage);
+        result = 31 * result + Objects.hashCode(errorCode);
+        result = 31 * result + Objects.hashCode(serviceName);
+        result = 31 * result + Objects.hashCode(sdkHttpResponse);
+        result = 31 * result + Objects.hashCode(rawResponse);
+        return result;
+    }
+
     @Override
     public String toString() {
         return ToString.builder("AwsErrorDetails")

core/aws-core/src/test/java/software/amazon/awssdk/awscore/exception/AwsErrorDetailsTest.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.awscore.exception;
+
+import java.io.IOException;
+import nl.jqno.equalsverifier.EqualsVerifier;
+import org.junit.Test;
+
+public class AwsErrorDetailsTest {
+
+    @Test
+    public void equals_hashcode() throws IOException, ClassNotFoundException {
+        EqualsVerifier.forClass(AwsErrorDetails.class)
+                      .usingGetClass()
+                      .verify();
+    }
+
+}

core/aws-core/src/test/java/software/amazon/awssdk/awscore/exception/AwsServiceExceptionSerializationTest.java

@@ -0,0 +1,89 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.awscore.exception;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
+import java.time.Duration;
+import java.util.Collections;
+import org.junit.Test;
+import software.amazon.awssdk.http.AbortableInputStream;
+import software.amazon.awssdk.http.SdkHttpFullResponse;
+import software.amazon.awssdk.http.SdkHttpResponse;
+import software.amazon.awssdk.testutils.InputStreamUtils;
+import software.amazon.awssdk.utils.IoUtils;
+import software.amazon.awssdk.utils.StringInputStream;
+
+public class AwsServiceExceptionSerializationTest {
+
+    @Test
+    public void serializeServiceException() throws IOException, ClassNotFoundException {
+        AwsServiceException expectedException = createException();
+
+        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+        ObjectOutputStream objectOutputStream = new ObjectOutputStream(outputStream);
+        objectOutputStream.writeObject(expectedException);
+        objectOutputStream.flush();
+        objectOutputStream.close();
+
+        ObjectInputStream ois = new ObjectInputStream(new ByteArrayInputStream(outputStream.toByteArray()));
+        AwsServiceException resultException = (AwsServiceException) ois.readObject();
+
+        assertSameValues(resultException, expectedException);
+    }
+
+    private void assertSameValues(AwsServiceException resultException, AwsServiceException expectedException) {
+        assertThat(resultException.getMessage()).isEqualTo(expectedException.getMessage());
+        assertThat(resultException.requestId()).isEqualTo(expectedException.requestId());
+        assertThat(resultException.extendedRequestId()).isEqualTo(expectedException.extendedRequestId());
+        assertThat(resultException.toBuilder().clockSkew()).isEqualTo(expectedException.toBuilder().clockSkew());
+        assertThat(resultException.toBuilder().cause().getMessage()).isEqualTo(expectedException.toBuilder().cause().getMessage());
+        assertThat(resultException.awsErrorDetails()).isEqualTo(expectedException.awsErrorDetails());
+    }
+
+
+    private AwsServiceException createException() {
+        AbortableInputStream contentStream = AbortableInputStream.create(new StringInputStream("some content"));
+        SdkHttpResponse httpResponse = SdkHttpFullResponse.builder()
+                                                          .statusCode(403)
+                                                          .statusText("SomeText")
+                                                          .putHeader("sample", "value")
+                                                          .content(contentStream)
+                                                          .build();
+
+        AwsErrorDetails errorDetails = AwsErrorDetails.builder()
+                                                      .errorCode("someCode")
+                                                      .errorMessage("message")
+                                                      .serviceName("someService")
+                                                      .sdkHttpResponse(httpResponse)
+                                                      .build();
+
+        return AwsServiceException.builder()
+                                  .awsErrorDetails(errorDetails)
+                                  .statusCode(403)
+                                  .cause(new RuntimeException("someThrowable"))
+                                  .clockSkew(Duration.ofSeconds(2))
+                                  .requestId("requestId")
+                                  .extendedRequestId("extendedRequestId")
+                                  .message("message")
+                                  .build();
+    }
+}

http-client-spi/src/main/java/software/amazon/awssdk/http/DefaultSdkHttpFullResponse.java

@@ -18,11 +18,13 @@
 import static software.amazon.awssdk.utils.CollectionUtils.deepCopyMap;
 import static software.amazon.awssdk.utils.CollectionUtils.deepUnmodifiableMap;
 
+import java.beans.Transient;
 import java.io.Serializable;
 import java.util.ArrayList;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
 import java.util.Optional;
 import java.util.TreeMap;
 import software.amazon.awssdk.annotations.Immutable;
@@ -59,6 +61,7 @@ public Map<String, List<String>> headers() {
         return headers;
     }
 
+    @Transient
     @Override
     public Optional<AbortableInputStream> content() {
         return Optional.ofNullable(content);
@@ -79,6 +82,28 @@ public SdkHttpFullResponse.Builder toBuilder() {
         return new Builder(this);
     }
 
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        DefaultSdkHttpFullResponse that = (DefaultSdkHttpFullResponse) o;
+        return Objects.equals(statusCode, that.statusCode) &&
+               Objects.equals(statusText, that.statusText) &&
+               Objects.equals(headers, that.headers);
+    }
+
+    @Override
+    public int hashCode() {
+        int result = statusText != null ? statusText.hashCode() : 0;
+        result = 31 * result + statusCode;
+        result = 31 * result + Objects.hashCode(headers);
+        return result;
+    }
+
     /**
      * Builder for a {@link DefaultSdkHttpFullResponse}.
      */

utils/src/main/java/software/amazon/awssdk/utils/UnmodifiableMapOfLists.java

@@ -15,6 +15,7 @@
 
 package software.amazon.awssdk.utils;
 
+import java.io.Serializable;
 import java.util.AbstractMap.SimpleImmutableEntry;
 import java.util.Collection;
 import java.util.Collections;
@@ -32,7 +33,10 @@
  * An unmodifiable view of a {@code Map<T, List<U>>}. Created using {@link CollectionUtils#unmodifiableMapOfLists(Map)}.
  */
 @SdkInternalApi
-class UnmodifiableMapOfLists<T, U> implements Map<T, List<U>> {
+class UnmodifiableMapOfLists<T, U> implements Map<T, List<U>>, Serializable {
+
+    private static final long serialVersionUID = 1L;
+
     private final Map<T, List<U>> delegate;
 
     UnmodifiableMapOfLists(Map<T, List<U>> delegate) {