Add back RestProxy for vnext generator tests (Azure#45149)

* Add back RestProxy

* Delete qq

* checkstyle

Author: samvaity

sdk/clientcore/core/checkstyle-suppressions.xml

@@ -5,18 +5,25 @@
 <suppressions>
   <suppress files="io.clientcore.core.implementation.utils.InternalContext.java" checks="JavadocMethodCheck" />
   <suppress files="io.clientcore.core.http.models.RequestContext.java" checks="MethodNameCheck" />
+  <suppress files="io.clientcore.core.implementation.http.rest.RequestDataConfiguration.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="io.clientcore.core.implementation.http.rest.SwaggerMethodParser.java" checks="MissingJavadocMethodCheck" />
   <suppress files="io.clientcore.core.implementation.instrumentation.DefaultLogger.java" checks="MissingJavadocMethodCheck" />
   <suppress files="io.clientcore.core.implementation.instrumentation.Slf4jLoggerShim.java" checks="MissingJavadocMethodCheck" />
   <suppress files="io.clientcore.core.implementation.utils.ImplUtils.java" checks="MissingJavadocMethodCheck" />
   <suppress files="io.clientcore.core.implementation.utils.IterableOfByteBuffersInputStream.java" checks="MissingJavadocMethodCheck" />
   <suppress files="io.clientcore.core.implementation.utils.ServerSentEventHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="io.clientcore.core.implementation.http.rest.HeaderSubstitution.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="io.clientcore.core.implementation.http.rest.RequestDataConfiguration.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="io.clientcore.core.implementation.http.rest.RestProxyImpl.java" checks="MissingJavadocTypeCheck" />
   <suppress files="io.clientcore.core.implementation.instrumentation.Slf4jLoggerShim.java" checks="MissingJavadocTypeCheck" />
   <suppress files="io.clientcore.core.implementation.utils.ImplUtils.java" checks="MissingJavadocTypeCheck" />
   <suppress files="io.clientcore.core.implementation.instrumentation.Slf4jLoggerShim.java" checks="com.azure.tools.checkstyle.checks.EnforceFinalFieldsCheck" />
   <suppress files="io.clientcore.core.implementation.ReflectionSerializable.java" checks="com.azure.tools.checkstyle.checks.JavadocThrowsChecks" />
+  <suppress files="io.clientcore.core.implementation.http.serializer.HttpResponseBodyDecoder.java" checks="com.azure.tools.checkstyle.checks.JavadocThrowsChecks" />
   <suppress files="io.clientcore.core.http.client.JdkHttpClientBuilder.java" checks="com.azure.tools.checkstyle.checks.ServiceClientBuilderCheck" />
   <suppress files="io.clientcore.core.http.pipeline.HttpInstrumentationPolicy.java" checks="com.azure.tools.checkstyle.checks.ThrowFromClientLoggerCheck" />
   <suppress files="io.clientcore.core.implementation.MethodHandleReflectiveInvoker.java" checks="com.azure.tools.checkstyle.checks.ThrowFromClientLoggerCheck" />
+  <suppress files="io.clientcore.core.implementation.http.rest.LengthValidatingInputStream.java" checks="com.azure.tools.checkstyle.checks.ThrowFromClientLoggerCheck" />
   <suppress files="io.clientcore.core.implementation.instrumentation.fallback.FallbackInstrumentation.java" checks="com.azure.tools.checkstyle.checks.ThrowFromClientLoggerCheck" />
   <suppress files="io.clientcore.core.implementation.instrumentation.otel.OTelInstrumentation.java" checks="com.azure.tools.checkstyle.checks.ThrowFromClientLoggerCheck" />
   <suppress files="io.clientcore.core.instrumentation.logging.LoggingEvent.java" checks="com.azure.tools.checkstyle.checks.ThrowFromClientLoggerCheck" />

sdk/clientcore/core/pom.xml

@@ -46,6 +46,7 @@
       --add-opens io.clientcore.core/io.clientcore.core.http=ALL-UNNAMED
       --add-opens io.clientcore.core/io.clientcore.core.http.annotations=ALL-UNNAMED
       --add-opens io.clientcore.core/io.clientcore.core.http.client=ALL-UNNAMED
+      --add-opens io.clientcore.core/io.clientcore.core.implementation.http.rest=ALL-UNNAMED
       --add-opens io.clientcore.core/io.clientcore.core.http.models=ALL-UNNAMED
       --add-opens io.clientcore.core/io.clientcore.core.http.pipeline=ALL-UNNAMED
       --add-opens io.clientcore.core/io.clientcore.core.implementation=ALL-UNNAMED

sdk/clientcore/core/spotbugs-exclude.xml

@@ -23,6 +23,7 @@
       <Class name="io.clientcore.core.implementation.GenericParameterizedType" />
       <Class name="io.clientcore.core.implementation.ReflectionUtilsMethodHandle" />
       <Class name="io.clientcore.core.implementation.http.HttpPipelineCallState" />
+      <Class name="io.clientcore.core.implementation.http.rest.RestProxyImpl" />
       <Class name="io.clientcore.core.implementation.utils.AuthenticateChallengeParser" />
       <Class name="io.clientcore.core.implementation.utils.InternalContext" />
       <Class name="io.clientcore.core.implementation.utils.PercentEscaper" />
@@ -64,6 +65,7 @@
       <Class name="io.clientcore.core.http.client.JdkHttpClientBuilder" />
       <Class name="io.clientcore.core.http.pipeline.KeyCredentialPolicy" />
       <Class name="io.clientcore.core.http.pipeline.UserAgentPolicy" />
+      <Class name="io.clientcore.core.implementation.http.rest.SwaggerMethodParser" />
       <Class name="io.clientcore.core.implementation.instrumentation.otel.OTelInstrumentation" />
       <Class name="io.clientcore.core.instrumentation.logging.ClientLogger" />
       <Class name="io.clientcore.core.serialization.json.implementation.jackson.core.util.RequestPayload" />
@@ -81,6 +83,7 @@
       <Class name="io.clientcore.core.http.pipeline.AddHeadersPolicyJavadocCodeSnippets" />
       <Class name="io.clientcore.core.http.pipeline.SetRequestIdPolicyJavadocCodeSnippets" />
       <Class name="io.clientcore.core.http.pipeline.UserAgentPolicyJavadocCodeSnippets" />
+      <Class name="io.clientcore.core.implementation.http.serializer.HttpResponseDecodeData" />
       <Class name="io.clientcore.core.instrumentation.TelemetryForLibraryDevelopersJavaDocCodeSnippets" />
       <Class name="io.clientcore.core.models.CloudEventJavaDocCodeSnippet" />
       <Class name="io.clientcore.core.serialization.xml.implementation.aalto.in.ReaderScanner" />
@@ -107,6 +110,7 @@
     <Or>
       <Class name="io.clientcore.core.http.client.SimpleBasicAuthHttpProxyServer" />
       <Class name="io.clientcore.core.implementation.http.client.JdkHttpClientIT" />
+      <Class name="io.clientcore.core.implementation.http.rest.RestProxyImplTests" />
       <Class name="io.clientcore.core.implementation.serializer.AdditionalPropertiesSerializerTests" />
       <Class name="io.clientcore.core.implementation.serializer.BinaryDataSerializationTests" />
       <Class name="io.clientcore.core.implementation.serializer.BinaryDataSerializationTests$ListProperty" />
@@ -241,6 +245,7 @@
   <Match>
     <Bug pattern="NP_NULL_PARAM_DEREF_NONVIRTUAL" />
     <Or>
+      <Class name="io.clientcore.core.implementation.http.rest.LengthValidatingInputStreamTests" />
       <Class name="io.clientcore.core.implementation.instrumentation.fallback.FallbackInstrumentationTests" />
       <Class name="io.clientcore.core.models.binarydata.BinaryDataTest" />
       <Class name="io.clientcore.core.models.geo.GeoCollectionTests" />
@@ -298,6 +303,7 @@
   <Match>
     <Bug pattern="RR_NOT_CHECKED" />
     <Or>
+      <Class name="io.clientcore.core.implementation.http.rest.LengthValidatingInputStreamTests" />
       <Class name="io.clientcore.core.models.CloudEventTests" />
       <Class name="io.clientcore.core.models.binarydata.BinaryDataJavaDocCodeSnippet" />
     </Or>
@@ -367,6 +373,10 @@
       <Class name="io.clientcore.core.shared.LocalTestServer" />
     </Or>
   </Match>
+  <Match>
+    <Bug pattern="SR_NOT_CHECKED" />
+    <Class name="io.clientcore.core.implementation.http.rest.LengthValidatingInputStreamTests" />
+  </Match>
   <Match>
     <Bug pattern="SS_SHOULD_BE_STATIC" />
     <Or>

sdk/clientcore/core/src/main/java/io/clientcore/core/http/RestProxy.java

@@ -0,0 +1,100 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package io.clientcore.core.http;
+
+import io.clientcore.core.http.models.RequestContext;
+import io.clientcore.core.http.pipeline.HttpPipeline;
+import io.clientcore.core.implementation.http.rest.RestProxyImpl;
+import io.clientcore.core.implementation.http.rest.SwaggerInterfaceParser;
+import io.clientcore.core.implementation.http.rest.SwaggerMethodParser;
+import io.clientcore.core.serialization.json.JsonSerializer;
+import io.clientcore.core.serialization.ObjectSerializer;
+import io.clientcore.core.serialization.xml.XmlSerializer;
+
+import java.lang.reflect.InvocationHandler;
+import java.lang.reflect.Method;
+import java.lang.reflect.Proxy;
+
+/**
+ * Type to create a proxy implementation for an interface describing REST API methods.
+ * <p>
+ * RestProxy can create proxy implementations for interfaces with methods that return deserialized Java objects.
+ */
+public final class RestProxy implements InvocationHandler {
+    private final SwaggerInterfaceParser interfaceParser;
+    private final RestProxyImpl restProxyImpl;
+
+    /**
+     * Create a RestProxy.
+     *
+     * @param httpPipeline the HttpPipelinePolicy and HttpClient httpPipeline that will be used to send HTTP requests.
+     * @param interfaceParser the parser that contains information about the interface describing REST API methods that
+     * this RestProxy "implements".
+     * @param serializers the serializers that will be used to convert response bodies to POJOs.
+     */
+    private RestProxy(HttpPipeline httpPipeline, SwaggerInterfaceParser interfaceParser,
+        ObjectSerializer... serializers) {
+        this.interfaceParser = interfaceParser;
+        this.restProxyImpl = new RestProxyImpl(httpPipeline, interfaceParser, serializers);
+    }
+
+    /**
+     * Get the SwaggerMethodParser for the provided method. The Method must exist on the Swagger interface that this
+     * RestProxy was created to "implement".
+     *
+     * @param method the method to get a SwaggerMethodParser for
+     *
+     * @return the SwaggerMethodParser for the provided method
+     */
+    private SwaggerMethodParser getMethodParser(Method method) {
+        return interfaceParser.getMethodParser(method);
+    }
+
+    @Override
+    public Object invoke(Object proxy, final Method method, Object[] args) {
+        // Note: RequestContext need to be evaluated here, as it is a public class with package private methods.
+        // Evaluating here allows the package private methods to be invoked here for downstream use.
+        final SwaggerMethodParser methodParser = getMethodParser(method);
+        RequestContext options = methodParser.setRequestContext(args);
+
+        return restProxyImpl.invoke(proxy, options, methodParser, args);
+    }
+
+    /**
+     * Create a proxy implementation of the provided Swagger interface.
+     *
+     * @param swaggerInterface the Swagger interface to provide a proxy implementation for
+     * @param httpPipeline the HttpPipelinePolicy and HttpClient pipeline that will be used to send Http requests
+     * @param <A> the type of the Swagger interface
+     * @return a proxy implementation of the provided Swagger interface
+     */
+    @SuppressWarnings("unchecked")
+    public static <A> A create(Class<A> swaggerInterface, HttpPipeline httpPipeline) {
+        final SwaggerInterfaceParser interfaceParser = SwaggerInterfaceParser.getInstance(swaggerInterface);
+        final RestProxy restProxy
+            = new RestProxy(httpPipeline, interfaceParser, new JsonSerializer(), new XmlSerializer());
+
+        return (A) Proxy.newProxyInstance(swaggerInterface.getClassLoader(), new Class<?>[] { swaggerInterface },
+            restProxy);
+    }
+
+    /**
+     * Create a proxy implementation of the provided Swagger interface.
+     *
+     * @param swaggerInterface the Swagger interface to provide a proxy implementation for
+     * @param httpPipeline the HttpPipelinePolicy and HttpClient pipeline that will be used to send Http requests
+     * @param serializers the serializers that will be used to convert POJOs to and from request and response bodies
+     * @param <A> the type of the Swagger interface.
+     * @return a proxy implementation of the provided Swagger interface
+     * @throws IllegalArgumentException If {@code serializers} is null or empty.
+     */
+    @SuppressWarnings("unchecked")
+    public static <A> A create(Class<A> swaggerInterface, HttpPipeline httpPipeline, ObjectSerializer... serializers) {
+        final SwaggerInterfaceParser interfaceParser = SwaggerInterfaceParser.getInstance(swaggerInterface);
+        final RestProxy restProxy = new RestProxy(httpPipeline, interfaceParser, serializers);
+
+        return (A) Proxy.newProxyInstance(swaggerInterface.getClassLoader(), new Class<?>[] { swaggerInterface },
+            restProxy);
+    }
+}

sdk/clientcore/core/src/main/java/io/clientcore/core/implementation/http/rest/HeaderSubstitution.java

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package io.clientcore.core.implementation.http.rest;
+
+import io.clientcore.core.http.models.HttpHeaderName;
+
+public final class HeaderSubstitution extends Substitution {
+    private final HttpHeaderName headerName;
+
+    /**
+     * Create a new Substitution.
+     *
+     * @param uriParameterName The name that is used between curly quotes as a placeholder in the target URI.
+     * @param methodParameterIndex The index of the parameter in the original interface method where the value for the
+     * placeholder is.
+     * @param shouldEncode Whether the value from the method's argument should be encoded when the substitution is
+     * taking place.
+     */
+    public HeaderSubstitution(String uriParameterName, int methodParameterIndex, boolean shouldEncode) {
+        super(uriParameterName, methodParameterIndex, shouldEncode);
+        this.headerName = (uriParameterName == null) ? null : HttpHeaderName.fromString(uriParameterName);
+    }
+
+    /**
+     * Gets the header name.
+     * <p>
+     * header name.
+     *
+     * @return The header name.
+     */
+    public HttpHeaderName getHeaderName() {
+        return headerName;
+    }
+}

sdk/clientcore/core/src/main/java/io/clientcore/core/implementation/http/rest/LengthValidatingInputStream.java

@@ -0,0 +1,120 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+package io.clientcore.core.implementation.http.rest;
+
+import io.clientcore.core.instrumentation.logging.ClientLogger;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Objects;
+
+/**
+ * An {@link InputStream} decorator that tracks the number of bytes read from an inner {@link InputStream} and throws
+ * an exception if the number of bytes read doesn't match what was expected.
+ * <p>
+ * This implementation assumes that reader is going to read until EOF.
+ */
+final class LengthValidatingInputStream extends InputStream {
+
+    private static final ClientLogger LOGGER = new ClientLogger(LengthValidatingInputStream.class);
+
+    private final InputStream inner;
+    private final long expectedReadSize;
+
+    private long position;
+    private long mark = -1;
+
+    /**
+     * Creates a new {@link LengthValidatingInputStream}.
+     *
+     * @param inputStream The {@link InputStream} being decorated.
+     * @param expectedReadSize The expected number of bytes to be read from the inner {@code inputStream}.
+     */
+    LengthValidatingInputStream(InputStream inputStream, long expectedReadSize) {
+        this.inner = Objects.requireNonNull(inputStream, "'inputStream' cannot be null.");
+
+        if (expectedReadSize < 0) {
+            throw LOGGER.logThrowableAsError(new IllegalArgumentException("'expectedReadSize' cannot be less than 0."));
+        }
+
+        this.expectedReadSize = expectedReadSize;
+    }
+
+    @Override
+    public synchronized int read(byte[] b, int off, int len) throws IOException {
+        int totalRead = 0;
+        int readSize;
+        do {
+            // Attempt to read until the byte array is filled or the inner stream ends.
+            // This results in finishing validation faster and prevents scenarios such as with JDK HttpClient where
+            // a large buffer will be requested and it validates read length before we can finish validation.
+            readSize = inner.read(b, off + totalRead, len - totalRead);
+            validateLength(readSize);
+
+            if (readSize != -1) {
+                totalRead += readSize;
+            } else if (totalRead == 0) {
+                // If the inner stream was already read to completion the first read will return -1, need to set
+                // total read to -1 to prevent any infinite read loops by returning 0.
+                totalRead = -1;
+            }
+        } while (readSize != -1 && totalRead != len);
+
+        return totalRead;
+    }
+
+    @Override
+    public synchronized long skip(long n) throws IOException {
+        long skipped = inner.skip(n);
+        position += skipped;
+        return skipped;
+    }
+
+    @Override
+    public int available() throws IOException {
+        return inner.available();
+    }
+
+    @Override
+    public void close() throws IOException {
+        inner.close();
+    }
+
+    @Override
+    public synchronized void mark(int readlimit) {
+        inner.mark(readlimit);
+        mark = position;
+    }
+
+    @Override
+    public synchronized void reset() throws IOException {
+        inner.reset();
+        position = mark;
+    }
+
+    @Override
+    public boolean markSupported() {
+        return inner.markSupported();
+    }
+
+    @Override
+    public synchronized int read() throws IOException {
+        int read = inner.read();
+        validateLength(read == -1 ? -1 : 1);
+
+        return read;
+    }
+
+    private void validateLength(int readSize) {
+        if (readSize == -1) {
+            // If the inner InputStream has reached termination validate that the read bytes matches what was expected.
+            if (position > expectedReadSize) {
+                throw new IllegalStateException(RestProxyImpl.bodyTooLarge(position, expectedReadSize));
+            } else if (position < expectedReadSize) {
+                throw new IllegalStateException(RestProxyImpl.bodyTooSmall(position, expectedReadSize));
+            }
+        } else {
+            position += readSize;
+        }
+    }
+}