Clientcore: add base exception type, use unchecked exceptions on BinaryData and high-level APIs (Azure#44892)

* Add base CoreException

Author: Liudmila Molkova

sdk/clientcore/annotation-processor-test/src/test/java/io/clientcore/annotation/processor/test/LocalHttpClient.java

@@ -34,7 +34,7 @@ public Response<BinaryData> send(HttpRequest request) {
 
         return new Response<BinaryData>(request, success ? 200 : 400, new HttpHeaders(), BinaryData.empty()) {
             @Override
-            public void close() throws IOException {
+            public void close() {
                 closeCalledOnResponse = true;
 
                 super.close();

sdk/clientcore/annotation-processor-test/src/test/java/io/clientcore/annotation/processor/test/http/TestInterfaceGenerationTests.java

@@ -181,7 +181,7 @@ public Response<BinaryData> send(HttpRequest request) {
 
             return new Response<BinaryData>(request, success ? 200 : 400, new HttpHeaders(), BinaryData.empty()) {
                 @Override
-                public void close() throws IOException {
+                public void close() {
                     closeCalledOnResponse = true;
 
                     super.close();

sdk/clientcore/annotation-processor/README.md

@@ -120,12 +120,7 @@ The client-core annotation processor for introducing compile-time code generatio
               throw new RuntimeException("Unexpected response code: " + responseCode);
           }
 
-          try {
-              networkResponse.close();
-          } catch (IOException e) {
-              throw LOGGER.logThrowableAsError(new UncheckedIOException(e));
-          }
-
+          networkResponse.close();
           return networkResponse;
       }
    }

sdk/clientcore/annotation-processor/src/main/java/io/clientcore/annotation/processor/templating/JavaParserTemplateProcessor.java

@@ -34,7 +34,6 @@
 import io.clientcore.core.serialization.json.JsonSerializer;
 import io.clientcore.core.serialization.xml.XmlSerializer;
 import java.io.IOException;
-import java.io.UncheckedIOException;
 import java.io.Writer;
 import java.lang.reflect.Field;
 import java.lang.reflect.ParameterizedType;
@@ -194,15 +193,14 @@ private void addDeserializeHelperMethod(MethodDeclaration deserializeHelperMetho
             .addParameter(ObjectSerializer.class, "serializer")
             .addParameter("ParameterizedType", "returnType");
         deserializeHelperMethod.tryAddImportToParentCompilationUnit(IOException.class);
-        deserializeHelperMethod.tryAddImportToParentCompilationUnit(UncheckedIOException.class);
         deserializeHelperMethod.tryAddImportToParentCompilationUnit(ParameterizedType.class);
         deserializeHelperMethod.tryAddImportToParentCompilationUnit(Type.class);
         deserializeHelperMethod.tryAddImportToParentCompilationUnit(List.class);
         deserializeHelperMethod
             .setJavadocComment("Decodes the body of an {@link Response} into the type returned by the called API.\n"
                 + "@param data The BinaryData to decode.\n" + "@param serializer The serializer to use.\n"
                 + "@param returnType The type of the ParameterizedType return value.\n" + "@return The decoded value.\n"
-                + "@throws IOException If the deserialization fails.");
+                + "@throws CoreException If the deserialization fails.");
 
         deserializeHelperMethod.setBody(new BlockStmt()
             .addStatement(StaticJavaParser.parseStatement("if (data == null) { return null; }"))
@@ -212,7 +210,7 @@ private void addDeserializeHelperMethod(MethodDeclaration deserializeHelperMetho
                     + "Type token = returnType.getRawType(); if (Response.class.isAssignableFrom((Class<?>) token)) { "
                     + " token = returnType.getActualTypeArguments()[0]; } "
                     + "return serializer.deserializeFromBytes(data.toBytes(), token); } catch (IOException e) { "
-                    + "    throw LOGGER.logThrowableAsError(new UncheckedIOException(e)); }")));
+                    + "    throw LOGGER.logThrowableAsError(CoreException.from(e)); }")));
 
     }
 

sdk/clientcore/annotation-processor/src/main/java/io/clientcore/annotation/processor/utils/ResponseHandler.java

@@ -11,6 +11,7 @@
 import io.clientcore.annotation.processor.models.HttpRequestContext;
 import io.clientcore.core.http.models.HttpMethod;
 import io.clientcore.core.implementation.TypeUtil;
+import io.clientcore.core.models.CoreException;
 import io.clientcore.core.models.binarydata.BinaryData;
 import io.clientcore.core.serialization.SerializationFormat;
 import io.clientcore.core.utils.CoreUtils;
@@ -21,7 +22,6 @@
 import javax.lang.model.type.TypeMirror;
 import java.io.IOException;
 import java.io.InputStream;
-import java.io.UncheckedIOException;
 import java.util.List;
 import java.util.stream.Collectors;
 
@@ -262,9 +262,8 @@ private static void handleInputStreamResponse(BlockStmt body) {
 
     private static void closeResponse(BlockStmt body) {
         body.tryAddImportToParentCompilationUnit(IOException.class);
-        body.tryAddImportToParentCompilationUnit(UncheckedIOException.class);
-        body.addStatement(StaticJavaParser.parseStatement("try { networkResponse.close(); } catch (IOException e) { "
-            + "throw LOGGER.logThrowableAsError(new UncheckedIOException(e)); }"));
+        body.tryAddImportToParentCompilationUnit(CoreException.class);
+        body.addStatement(StaticJavaParser.parseStatement("networkResponse.close();"));
     }
 
     /**

sdk/clientcore/core/spotbugs-exclude.xml

@@ -31,6 +31,7 @@
       <Class name="io.clientcore.core.implementation.utils.SliceInputStream" />
       <Class name="io.clientcore.core.implementation.utils.StreamUtil" />
       <Class name="io.clientcore.core.models.CloudEvent" />
+      <Class name="io.clientcore.core.models.binarydata.BinaryData" />
       <Class name="io.clientcore.core.models.binarydata.FileBinaryData" />
       <Class name="io.clientcore.core.models.binarydata.InputStreamBinaryData" />
       <Class name="io.clientcore.core.models.binarydata.ListByteBufferBinaryData" />

sdk/clientcore/core/src/main/java/io/clientcore/core/http/client/HttpClient.java

@@ -6,10 +6,9 @@
 import io.clientcore.core.http.models.HttpRequest;
 import io.clientcore.core.http.models.Response;
 import io.clientcore.core.implementation.http.client.GlobalJdkHttpClient;
+import io.clientcore.core.models.CoreException;
 import io.clientcore.core.models.binarydata.BinaryData;
 
-import java.io.IOException;
-
 /**
  * A generic interface for sending HTTP requests and getting responses.
  */
@@ -19,9 +18,9 @@ public interface HttpClient {
      *
      * @param request The HTTP request to send.
      * @return The response.
-     * @throws IOException If an I/O error occurs during sending the request or receiving the response.
+     * @throws CoreException If any error occurs during sending the request or receiving the response.
      */
-    Response<BinaryData> send(HttpRequest request) throws IOException;
+    Response<BinaryData> send(HttpRequest request);
 
     /**
      * Get a new instance of the {@link HttpClient} that the {@link HttpClientProvider} loaded from the classpath is

sdk/clientcore/core/src/main/java/io/clientcore/core/http/models/HttpResponseException.java

@@ -5,14 +5,16 @@
 
 import io.clientcore.core.annotations.Metadata;
 import io.clientcore.core.annotations.MetadataProperties;
+import io.clientcore.core.implementation.http.RetryUtils;
+import io.clientcore.core.models.CoreException;
 import io.clientcore.core.models.binarydata.BinaryData;
 
 /**
  * The exception thrown when an unsuccessful response is received with http status code (e.g. {@code 3XX}, {@code 4XX},
  * {@code 5XX}) from the service request.
  */
 @Metadata(properties = MetadataProperties.IMMUTABLE)
-public class HttpResponseException extends RuntimeException {
+public class HttpResponseException extends CoreException {
     /**
      * The HTTP response value.
      */
@@ -23,6 +25,11 @@ public class HttpResponseException extends RuntimeException {
      */
     private final Response<BinaryData> response;
 
+    /**
+     * Indicates whether the exception is retryable.
+     */
+    private final boolean isRetryable;
+
     /**
      * Initializes a new instance of the HttpResponseException class.
      *
@@ -31,10 +38,11 @@ public class HttpResponseException extends RuntimeException {
      * @param value The deserialized response value.
      */
     public HttpResponseException(final String message, final Response<BinaryData> response, final Object value) {
-        super(message);
+        super(message, null);
 
         this.value = value;
         this.response = response;
+        this.isRetryable = response == null || RetryUtils.isRetryable(response.getStatusCode());
     }
 
     /**
@@ -49,6 +57,8 @@ public HttpResponseException(final String message, final Response<BinaryData> re
 
         this.value = null;
         this.response = response;
+        this.isRetryable
+            = response != null ? RetryUtils.isRetryable(response.getStatusCode()) : RetryUtils.isRetryable(cause);
     }
 
     /**
@@ -68,4 +78,9 @@ public Response<BinaryData> getResponse() {
     public Object getValue() {
         return value;
     }
+
+    @Override
+    public boolean isRetryable() {
+        return isRetryable;
+    }
 }

sdk/clientcore/core/src/main/java/io/clientcore/core/http/models/Response.java

@@ -3,6 +3,9 @@
 
 package io.clientcore.core.http.models;
 
+import io.clientcore.core.instrumentation.logging.ClientLogger;
+import io.clientcore.core.models.CoreException;
+
 import java.io.Closeable;
 import java.io.IOException;
 
@@ -12,6 +15,7 @@
  * @param <T> The deserialized type of the response content, available from {@link #getValue()}.
  */
 public class Response<T> implements Closeable {
+    private static final ClientLogger LOGGER = new ClientLogger(Response.class);
     private final HttpHeaders headers;
     private final HttpRequest request;
     private final int statusCode;
@@ -71,12 +75,16 @@ public T getValue() {
     /**
      * If {@link #getValue()} is a {@link Closeable} type, this method will close it.
      *
-     * @throws IOException If an error occurs while closing the response.
+     * @throws CoreException If an error occurs while closing the response.
      */
     @Override
-    public void close() throws IOException {
+    public void close() {
         if (value instanceof Closeable) {
-            ((Closeable) value).close();
+            try {
+                ((Closeable) value).close();
+            } catch (IOException e) {
+                throw LOGGER.logThrowableAsError(CoreException.from(e, false));
+            }
         }
     }
 }

sdk/clientcore/core/src/main/java/io/clientcore/core/http/pipeline/HttpInstrumentationPolicy.java

@@ -521,8 +521,7 @@ private double getDurationMs(long startNs, long endNs) {
      * @return A flag indicating if the request or response body should be logged.
      */
     private static boolean canLogBody(BinaryData data) {
-        // TODO (limolkova) we might want to filter out binary data, but
-        // if somebody enabled logging it - why not log it?
+        // TODO (limolkova) we might want to filter out binary data, but if somebody enabled logging it - why not log it?
         return data != null && data.getLength() != null && data.getLength() > 0 && data.getLength() < MAX_BODY_LOG_SIZE;
     }
 
@@ -619,7 +618,7 @@ public BinaryData getValue() {
         }
 
         @Override
-        public void close() throws IOException {
+        public void close() {
             if (bufferedBody == null) {
                 getValue();
             }