Add support for Base64Uri Response handling (#45491)

Author: samvaity

sdk/clientcore/annotation-processor-test/src/main/java/io/clientcore/annotation/processor/test/SpecialReturnBodiesServiceImpl.java

@@ -19,6 +19,7 @@
 import io.clientcore.core.utils.CoreUtils;
 import java.lang.reflect.ParameterizedType;
 import io.clientcore.core.serialization.SerializationFormat;
+import io.clientcore.core.utils.Base64Uri;
 
 /**
  * Initializes a new instance of the SpecialReturnBodiesServiceImpl type.
@@ -179,4 +180,22 @@ public Response<List<BinaryData>> getListOfBinaryData(String endpoint) {
         networkResponse.close();
         return new Response<>(networkResponse.getRequest(), responseCode, networkResponse.getHeaders(), deserializedResult);
     }
+
+    @SuppressWarnings("cast")
+    @Override
+    public Response<byte[]> base64url(String endpoint) {
+        // Create the HttpRequest.
+        HttpRequest httpRequest = new HttpRequest().setMethod(HttpMethod.GET).setUri(endpoint + "/encode/bytes/body/response/base64url");
+        // Send the request through the httpPipeline
+        try (Response<BinaryData> networkResponse = this.httpPipeline.send(httpRequest)) {
+            int responseCode = networkResponse.getStatusCode();
+            boolean expectedResponse = responseCode == 200;
+            if (!expectedResponse) {
+                // Handle unexpected response
+                GeneratedCodeUtils.handleUnexpectedResponse(responseCode, networkResponse, jsonSerializer, xmlSerializer, null, null);
+            }
+            BinaryData responseBody = networkResponse.getValue();
+            return new Response<>(networkResponse.getRequest(), responseCode, networkResponse.getHeaders(), responseBody != null ? new Base64Uri(responseBody.toBytes()).decodedBytes() : null);
+        }
+    }
 }

sdk/clientcore/annotation-processor-test/src/main/java/io/clientcore/annotation/processor/test/implementation/SpecialReturnBodiesService.java

@@ -3,13 +3,16 @@
 package io.clientcore.annotation.processor.test.implementation;
 
 import io.clientcore.core.annotations.ServiceInterface;
+import io.clientcore.core.http.annotations.HeaderParam;
 import io.clientcore.core.http.annotations.HostParam;
 import io.clientcore.core.http.annotations.HttpRequestInformation;
 import io.clientcore.core.http.annotations.UnexpectedResponseExceptionDetail;
 import io.clientcore.core.http.models.HttpMethod;
+import io.clientcore.core.http.models.RequestContext;
 import io.clientcore.core.http.models.Response;
 import io.clientcore.core.http.pipeline.HttpPipeline;
 import io.clientcore.core.models.binarydata.BinaryData;
+import io.clientcore.core.utils.Base64Uri;
 import java.io.InputStream;
 import java.lang.reflect.InvocationTargetException;
 import java.util.List;
@@ -111,4 +114,18 @@ static SpecialReturnBodiesService getNewInstance(HttpPipeline pipeline) {
     @HttpRequestInformation(method = HttpMethod.GET, path = "/type/array/unknown", expectedStatusCodes = { 200 })
     @UnexpectedResponseExceptionDetail
     Response<List<BinaryData>> getListOfBinaryData(@HostParam("url") String endpoint);
+
+
+    /**
+     * Gets Base64 encoded binary data from the specified URL.
+     * @param endpoint The URL.
+     * @return A response containing the Base64 encoded binary data.
+     */
+    @HttpRequestInformation(
+        method = HttpMethod.GET,
+        path = "/encode/bytes/body/response/base64url",
+        expectedStatusCodes = { 200 },
+        returnValueWireType = Base64Uri.class)
+    @UnexpectedResponseExceptionDetail
+    Response<byte[]> base64url(@HostParam("url") String endpoint);
 }

sdk/clientcore/annotation-processor/src/main/java/io/clientcore/annotation/processor/AnnotationProcessor.java

@@ -168,6 +168,17 @@ private HttpRequestContext createHttpRequestContext(ExecutableElement requestMet
         method.setExpectedStatusCodes(httpRequestInfo.expectedStatusCodes());
         method.addStaticHeaders(httpRequestInfo.headers());
         method.addStaticQueryParams(httpRequestInfo.queryParams());
+        TypeMirror returnValueWireType = null;
+        try {
+            // This will throw MirroredTypeException at compile time
+            // The assignment to clazz is only there to trigger the exception and use the TypeMirror from the exception.
+            Class<?> clazz = httpRequestInfo.returnValueWireType();
+        } catch (MirroredTypeException mte) {
+            TypeMirror typeMirror = mte.getTypeMirror();
+            returnValueWireType = typeMirror;
+
+        }
+        method.setReturnValueWireType(returnValueWireType);
         templateInput.addImport(requestMethod.getReturnType());
         method.setMethodReturnType(requestMethod.getReturnType());
         List<UnexpectedResponseExceptionDetail> details = getUnexpectedResponseExceptionDetails(requestMethod);

sdk/clientcore/annotation-processor/src/main/java/io/clientcore/annotation/processor/models/HttpRequestContext.java

@@ -56,6 +56,7 @@ public final class HttpRequestContext {
     private int[] expectedStatusCodes;
     private TypeMirror defaultExceptionBodyType;
     private boolean isUriNextLink;
+    private TypeMirror returnValueWireType;
 
     /**
      * Constructs a new HttpRequestContext with default values.
@@ -440,6 +441,24 @@ public boolean isUriNextLink() {
         return isUriNextLink;
     }
 
+    /**
+     * Sets the return value wire type.
+     *
+     * @param returnValueWireType the return value wire type to set.
+     */
+    public void setReturnValueWireType(TypeMirror returnValueWireType) {
+        this.returnValueWireType = returnValueWireType;
+    }
+
+    /**
+     * Gets the return value wire type.
+     *
+     * @return the return value wire type.
+     */
+    public TypeMirror getReturnValueWireType() {
+        return returnValueWireType;
+    }
+
     /**
      * Represents a method parameter.
      */

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

@@ -15,6 +15,7 @@
 import io.clientcore.core.implementation.TypeUtil;
 import io.clientcore.core.models.binarydata.BinaryData;
 import io.clientcore.core.serialization.SerializationFormat;
+import io.clientcore.core.utils.Base64Uri;
 import io.clientcore.core.utils.CoreUtils;
 import io.clientcore.core.utils.GeneratedCodeUtils;
 import java.io.InputStream;
@@ -178,11 +179,26 @@ private static void handleRequestReturn(BlockStmt body, TypeMirror returnType, j
         } else if (TypeUtil.isTypeOrSubTypeOf(entityType, byte[].class)) {
             // Return is a byte[]. Convert the network response body into a byte[].
             body.addStatement(StaticJavaParser.parseStatement("BinaryData responseBody = networkResponse.getValue();"));
+            // If the wire type is Base64Uri, decode it accordingly.
+            boolean isBase64Uri = false;
+            TypeMirror wireType = method.getReturnValueWireType();
+            if (wireType != null && wireType.getKind() == TypeKind.DECLARED) {
+                DeclaredType declaredWireType = (DeclaredType) wireType;
+                TypeElement wireTypeElement = (TypeElement) declaredWireType.asElement();
+                isBase64Uri = Base64Uri.class.getCanonicalName().equals(wireTypeElement.getQualifiedName().toString());
+            }
+            String returnExpr;
+            if (isBase64Uri) {
+                body.tryAddImportToParentCompilationUnit(Base64Uri.class);
+                returnExpr = "responseBody != null ? new Base64Uri(responseBody.toBytes()).decodedBytes() : null";
+            } else {
+                returnExpr = "responseBody != null ? responseBody.toBytes() : null";
+            }
 
             // Return responseBody.toBytes(), or null if it was null, as-is which will have the behavior of
             // null -> null, empty -> empty, and data -> data, which offers three unique states for knowing information
             // about the network response shape, as nullness != emptiness.
-            addReturnStatement(body, returnIsResponse, "responseBody != null ? responseBody.toBytes() : null");
+            addReturnStatement(body, returnIsResponse, returnExpr);
         } else if (TypeUtil.isTypeOrSubTypeOf(entityType, InputStream.class)) {
             // Return type is an InputStream. Return the network response body as an InputStream.
             // DO NOT close the network response for this return as it will result in the InputStream either being